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 which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
307 * @brief Elementary's API
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 /* Standard headers for standard system calls etc. */
329 #include <sys/types.h>
330 #include <sys/stat.h>
331 #include <sys/time.h>
332 #include <sys/param.h>
345 # ifdef ELM_LIBINTL_H
346 # include <libintl.h>
357 #if defined (ELM_WIN32) || defined (ELM_WINCE)
360 # define alloca _alloca
371 #include <Ecore_Evas.h>
372 #include <Ecore_File.h>
373 #include <Ecore_IMF.h>
374 @ELEMENTARY_ECORE_CON_INC@
383 # include <Efreet_Mime.h>
384 # include <Efreet_Trash.h>
388 # include <Ethumb_Client.h>
400 # ifdef ELEMENTARY_BUILD
402 # define EAPI __declspec(dllexport)
405 # endif /* ! DLL_EXPORT */
407 # define EAPI __declspec(dllimport)
408 # endif /* ! EFL_EVAS_BUILD */
412 # define EAPI __attribute__ ((visibility("default")))
419 #endif /* ! _WIN32 */
424 # define EAPI_MAIN EAPI
427 #define WILL_DEPRECATE /* API is deprecated in upstream EFL, will be deprecated in SLP soon */
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;
575 ELM_AUTOCAPITAL_TYPE_NONE,
576 ELM_AUTOCAPITAL_TYPE_WORD,
577 ELM_AUTOCAPITAL_TYPE_SENTENCE,
578 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
579 } Elm_Autocapital_Type;
582 * @typedef Elm_Object_Item
583 * An Elementary Object item handle.
586 typedef struct _Elm_Object_Item Elm_Object_Item;
590 * Called back when a widget's 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!)
595 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
598 * Called back when a widget's item tooltip is activated and needs content.
599 * @param data user-data given to elm_object_tooltip_content_cb_set()
600 * @param obj owner widget.
601 * @param tooltip The tooltip object (affix content to this!)
602 * @param item context dependent item. As an example, if tooltip was
603 * set on Elm_List_Item, then it is of this type.
605 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
607 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. */
609 #ifndef ELM_LIB_QUICKLAUNCH
610 #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 */
612 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
615 /**************************************************************************/
619 * Initialize Elementary
621 * @param[in] argc System's argument count value
622 * @param[in] argv System's pointer to array of argument strings
623 * @return The init counter value.
625 * This function initializes Elementary and increments a counter of
626 * the number of calls to it. It returns the new counter's value.
628 * @warning This call is exported only for use by the @c ELM_MAIN()
629 * macro. There is no need to use this if you use this macro (which
630 * is highly advisable). An elm_main() should contain the entry
631 * point code for your application, having the same prototype as
632 * elm_init(), and @b not being static (putting the @c EAPI symbol
633 * in front of its type declaration is advisable). The @c
634 * ELM_MAIN() call should be placed just after it.
637 * @dontinclude bg_example_01.c
641 * See the full @ref bg_example_01_c "example".
643 * @see elm_shutdown().
646 EAPI int elm_init(int argc, char **argv);
649 * Shut down Elementary
651 * @return The init counter value.
653 * This should be called at the end of your application, just
654 * before it ceases to do any more processing. This will clean up
655 * any permanent resources your application may have allocated via
656 * Elementary that would otherwise persist.
658 * @see elm_init() for an example
662 EAPI int elm_shutdown(void);
665 * Run Elementary's main loop
667 * This call should be issued just after all initialization is
668 * completed. This function will not return until elm_exit() is
669 * called. It will keep looping, running the main
670 * (event/processing) loop for Elementary.
672 * @see elm_init() for an example
676 EAPI void elm_run(void);
679 * Exit Elementary's main loop
681 * If this call is issued, it will flag the main loop to cease
682 * processing and return back to its parent function (usually your
683 * elm_main() function).
685 * @see elm_init() for an example. There, just after a request to
686 * close the window comes, the main loop will be left.
688 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
689 * applications, you'll be able to get this function called automatically for you.
693 EAPI void elm_exit(void);
696 * Provide information in order to make Elementary determine the @b
697 * run time location of the software in question, so other data files
698 * such as images, sound files, executable utilities, libraries,
699 * modules and locale files can be found.
701 * @param mainfunc This is your application's main function name,
702 * whose binary's location is to be found. Providing @c NULL
703 * will make Elementary not to use it
704 * @param dom This will be used as the application's "domain", in the
705 * form of a prefix to any environment variables that may
706 * override prefix detection and the directory name, inside the
707 * standard share or data directories, where the software's
708 * data files will be looked for.
709 * @param checkfile This is an (optional) magic file's path to check
710 * for existence (and it must be located in the data directory,
711 * under the share directory provided above). Its presence will
712 * help determine the prefix found was correct. Pass @c NULL if
713 * the check is not to be done.
715 * This function allows one to re-locate the application somewhere
716 * else after compilation, if the developer wishes for easier
717 * distribution of pre-compiled binaries.
719 * The prefix system is designed to locate where the given software is
720 * installed (under a common path prefix) at run time and then report
721 * specific locations of this prefix and common directories inside
722 * this prefix like the binary, library, data and locale directories,
723 * through the @c elm_app_*_get() family of functions.
725 * Call elm_app_info_set() early on before you change working
726 * directory or anything about @c argv[0], so it gets accurate
729 * It will then try and trace back which file @p mainfunc comes from,
730 * if provided, to determine the application's prefix directory.
732 * The @p dom parameter provides a string prefix to prepend before
733 * environment variables, allowing a fallback to @b specific
734 * environment variables to locate the software. You would most
735 * probably provide a lowercase string there, because it will also
736 * serve as directory domain, explained next. For environment
737 * variables purposes, this string is made uppercase. For example if
738 * @c "myapp" is provided as the prefix, then the program would expect
739 * @c "MYAPP_PREFIX" as a master environment variable to specify the
740 * exact install prefix for the software, or more specific environment
741 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
742 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
743 * the user or scripts before launching. If not provided (@c NULL),
744 * environment variables will not be used to override compiled-in
745 * defaults or auto detections.
747 * The @p dom string also provides a subdirectory inside the system
748 * shared data directory for data files. For example, if the system
749 * directory is @c /usr/local/share, then this directory name is
750 * appended, creating @c /usr/local/share/myapp, if it @p was @c
751 * "myapp". It is expected that the application installs data files in
754 * The @p checkfile is a file name or path of something inside the
755 * share or data directory to be used to test that the prefix
756 * detection worked. For example, your app will install a wallpaper
757 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
758 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
761 * @see elm_app_compile_bin_dir_set()
762 * @see elm_app_compile_lib_dir_set()
763 * @see elm_app_compile_data_dir_set()
764 * @see elm_app_compile_locale_set()
765 * @see elm_app_prefix_dir_get()
766 * @see elm_app_bin_dir_get()
767 * @see elm_app_lib_dir_get()
768 * @see elm_app_data_dir_get()
769 * @see elm_app_locale_dir_get()
771 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
774 * Provide information on the @b fallback application's binaries
775 * directory, in scenarios where they get overriden by
776 * elm_app_info_set().
778 * @param dir The path to the default binaries directory (compile time
781 * @note Elementary will as well use this path to determine actual
782 * names of binaries' directory paths, maybe changing it to be @c
783 * something/local/bin instead of @c something/bin, only, for
786 * @warning You should call this function @b before
787 * elm_app_info_set().
789 EAPI void elm_app_compile_bin_dir_set(const char *dir);
792 * Provide information on the @b fallback application's libraries
793 * directory, on scenarios where they get overriden by
794 * elm_app_info_set().
796 * @param dir The path to the default libraries directory (compile
799 * @note Elementary will as well use this path to determine actual
800 * names of libraries' directory paths, maybe changing it to be @c
801 * something/lib32 or @c something/lib64 instead of @c something/lib,
804 * @warning You should call this function @b before
805 * elm_app_info_set().
807 EAPI void elm_app_compile_lib_dir_set(const char *dir);
810 * Provide information on the @b fallback application's data
811 * directory, on scenarios where they get overriden by
812 * elm_app_info_set().
814 * @param dir The path to the default data directory (compile time
817 * @note Elementary will as well use this path to determine actual
818 * names of data directory paths, maybe changing it to be @c
819 * something/local/share instead of @c something/share, only, for
822 * @warning You should call this function @b before
823 * elm_app_info_set().
825 EAPI void elm_app_compile_data_dir_set(const char *dir);
828 * Provide information on the @b fallback application's locale
829 * directory, on scenarios where they get overriden by
830 * elm_app_info_set().
832 * @param dir The path to the default locale directory (compile time
835 * @warning You should call this function @b before
836 * elm_app_info_set().
838 EAPI void elm_app_compile_locale_set(const char *dir);
841 * Retrieve the application's run time prefix directory, as set by
842 * elm_app_info_set() and the way (environment) the application was
845 * @return The directory prefix the application is actually using.
847 EAPI const char *elm_app_prefix_dir_get(void);
850 * Retrieve the application's run time binaries prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The binaries directory prefix the application is actually
857 EAPI const char *elm_app_bin_dir_get(void);
860 * Retrieve the application's run time libraries prefix directory, as
861 * set by elm_app_info_set() and the way (environment) the application
864 * @return The libraries directory prefix the application is actually
867 EAPI const char *elm_app_lib_dir_get(void);
870 * Retrieve the application's run time data prefix directory, as
871 * set by elm_app_info_set() and the way (environment) the application
874 * @return The data directory prefix the application is actually
877 EAPI const char *elm_app_data_dir_get(void);
880 * Retrieve the application's run time locale prefix directory, as
881 * set by elm_app_info_set() and the way (environment) the application
884 * @return The locale directory prefix the application is actually
887 EAPI const char *elm_app_locale_dir_get(void);
889 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
890 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
891 EAPI int elm_quicklaunch_init(int argc, char **argv);
892 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
893 EAPI int elm_quicklaunch_sub_shutdown(void);
894 EAPI int elm_quicklaunch_shutdown(void);
895 EAPI void elm_quicklaunch_seed(void);
896 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
897 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
898 EAPI void elm_quicklaunch_cleanup(void);
899 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
900 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
902 EAPI Eina_Bool elm_need_efreet(void);
903 EAPI Eina_Bool elm_need_e_dbus(void);
906 * This must be called before any other function that deals with
907 * elm_thumb objects or ethumb_client instances.
911 EAPI Eina_Bool elm_need_ethumb(void);
914 * This must be called before any other function that deals with
915 * elm_web objects or ewk_view instances.
919 EAPI Eina_Bool elm_need_web(void);
922 * Set a new policy's value (for a given policy group/identifier).
924 * @param policy policy identifier, as in @ref Elm_Policy.
925 * @param value policy value, which depends on the identifier
927 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
929 * Elementary policies define applications' behavior,
930 * somehow. These behaviors are divided in policy groups (see
931 * #Elm_Policy enumeration). This call will emit the Ecore event
932 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
933 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
936 * @note Currently, we have only one policy identifier/group
937 * (#ELM_POLICY_QUIT), which has two possible values.
941 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
944 * Gets the policy value for given policy identifier.
946 * @param policy policy identifier, as in #Elm_Policy.
947 * @return The currently set policy value, for that
948 * identifier. Will be @c 0 if @p policy passed is invalid.
952 EAPI int elm_policy_get(unsigned int policy);
955 * Change the language of the current application
957 * The @p lang passed must be the full name of the locale to use, for
958 * example "en_US.utf8" or "es_ES@euro".
960 * Changing language with this function will make Elementary run through
961 * all its widgets, translating strings set with
962 * elm_object_domain_translatable_text_part_set(). This way, an entire
963 * UI can have its language changed without having to restart the program.
965 * For more complex cases, like having formatted strings that need
966 * translation, widgets will also emit a "language,changed" signal that
967 * the user can listen to to manually translate the text.
969 * @param lang Language to set, must be the full name of the locale
973 EAPI void elm_language_set(const char *lang);
976 * Set a label of an object
978 * @param obj The Elementary object
979 * @param part The text part name to set (NULL for the default label)
980 * @param label The new text of the label
982 * @note Elementary objects may have many labels (e.g. Action Slider)
983 * @deprecated Use elm_object_part_text_set() instead.
986 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
989 * Set a label of an object
991 * @param obj The Elementary object
992 * @param part The text part name to set (NULL for the default label)
993 * @param label The new text of the label
995 * @note Elementary objects may have many labels (e.g. Action Slider)
999 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1001 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1004 * Get a label of an object
1006 * @param obj The Elementary object
1007 * @param part The text part name to get (NULL for the default label)
1008 * @return text of the label or NULL for any error
1010 * @note Elementary objects may have many labels (e.g. Action Slider)
1011 * @deprecated Use elm_object_part_text_get() instead.
1014 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1017 * Get a label of an object
1019 * @param obj The Elementary object
1020 * @param part The text part name to get (NULL for the default label)
1021 * @return text of the label or NULL for any error
1023 * @note Elementary objects may have many labels (e.g. Action Slider)
1027 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1029 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1032 * Set the text for an objects' part, marking it as translatable.
1034 * The string to set as @p text must be the original one. Do not pass the
1035 * return of @c gettext() here. Elementary will translate the string
1036 * internally and set it on the object using elm_object_part_text_set(),
1037 * also storing the original string so that it can be automatically
1038 * translated when the language is changed with elm_language_set().
1040 * The @p domain will be stored along to find the translation in the
1041 * correct catalog. It can be NULL, in which case it will use whatever
1042 * domain was set by the application with @c textdomain(). This is useful
1043 * in case you are building a library on top of Elementary that will have
1044 * its own translatable strings, that should not be mixed with those of
1045 * programs using the library.
1047 * @param obj The object containing the text part
1048 * @param part The name of the part to set
1049 * @param domain The translation domain to use
1050 * @param text The original, non-translated text to set
1054 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1056 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1058 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1061 * Gets the original string set as translatable for an object
1063 * When setting translated strings, the function elm_object_part_text_get()
1064 * will return the translation returned by @c gettext(). To get the
1065 * original string use this function.
1067 * @param obj The object
1068 * @param part The name of the part that was set
1070 * @return The original, untranslated string
1074 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1076 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1079 * Set a content of an object
1081 * @param obj The Elementary object
1082 * @param part The content part name to set (NULL for the default content)
1083 * @param content The new content of the object
1085 * @note Elementary objects may have many contents
1086 * @deprecated Use elm_object_part_content_set instead.
1089 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1092 * Set a content of an object
1094 * @param obj The Elementary object
1095 * @param part The content part name to set (NULL for the default content)
1096 * @param content The new content of the object
1098 * @note Elementary objects may have many contents
1102 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1104 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1107 * Get a content of an object
1109 * @param obj The Elementary object
1110 * @param item The content part name to get (NULL for the default content)
1111 * @return content of the object or NULL for any error
1113 * @note Elementary objects may have many contents
1114 * @deprecated Use elm_object_part_content_get instead.
1117 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1120 * Get a content of an object
1122 * @param obj The Elementary object
1123 * @param item The content part name to get (NULL for the default content)
1124 * @return content of the object or NULL for any error
1126 * @note Elementary objects may have many contents
1130 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1132 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1135 * Unset a content of an object
1137 * @param obj The Elementary object
1138 * @param item The content part name to unset (NULL for the default content)
1140 * @note Elementary objects may have many contents
1141 * @deprecated Use elm_object_part_content_unset instead.
1144 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1147 * Unset a content of an object
1149 * @param obj The Elementary object
1150 * @param item The content part name to unset (NULL for the default content)
1152 * @note Elementary objects may have many contents
1156 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1158 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1161 * Set the text to read out when in accessibility mode
1163 * @param obj The object which is to be described
1164 * @param txt The text that describes the widget to people with poor or no vision
1168 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1171 * Get the widget object's handle which contains a given item
1173 * @param item The Elementary object item
1174 * @return The widget object
1176 * @note This returns the widget object itself that an item belongs to.
1180 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1183 * Set a content of an object item
1185 * @param it The Elementary object item
1186 * @param part The content part name to set (NULL for the default content)
1187 * @param content The new content of the object item
1189 * @note Elementary object items may have many contents
1190 * @deprecated Use elm_object_item_part_content_set instead.
1193 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1196 * Set a content of an object item
1198 * @param it The Elementary object item
1199 * @param part The content part name to set (NULL for the default content)
1200 * @param content The new content of the object item
1202 * @note Elementary object items may have many contents
1206 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1208 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1211 * Get a content of an object item
1213 * @param it The Elementary object item
1214 * @param part The content part name to unset (NULL for the default content)
1215 * @return content of the object item or NULL for any error
1217 * @note Elementary object items may have many contents
1218 * @deprecated Use elm_object_item_part_content_get instead.
1221 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1224 * Get a content of an object item
1226 * @param it The Elementary object item
1227 * @param part The content part name to unset (NULL for the default content)
1228 * @return content of the object item or NULL for any error
1230 * @note Elementary object items may have many contents
1234 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1236 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1239 * Unset a content of an object item
1241 * @param it The Elementary object item
1242 * @param part The content part name to unset (NULL for the default content)
1244 * @note Elementary object items may have many contents
1245 * @deprecated Use elm_object_item_part_content_unset instead.
1248 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1251 * Unset a content of an object item
1253 * @param it The Elementary object item
1254 * @param part The content part name to unset (NULL for the default content)
1256 * @note Elementary object items may have many contents
1260 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1262 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1265 * Set a label of an object item
1267 * @param it The Elementary object item
1268 * @param part The text part name to set (NULL for the default label)
1269 * @param label The new text of the label
1271 * @note Elementary object items may have many labels
1272 * @deprecated Use elm_object_item_part_text_set instead.
1275 WILL_DEPRECATE EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1278 * Set a label of an object item
1280 * @param it The Elementary object item
1281 * @param part The text part name to set (NULL for the default label)
1282 * @param label The new text of the label
1284 * @note Elementary object items may have many labels
1288 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1290 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1293 * Get a label of an object item
1295 * @param it The Elementary object item
1296 * @param part The text part name to get (NULL for the default label)
1297 * @return text of the label or NULL for any error
1299 * @note Elementary object items may have many labels
1300 * @deprecated Use elm_object_item_part_text_get instead.
1303 WILL_DEPRECATE EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1305 * Get a label of an object item
1307 * @param it The Elementary object item
1308 * @param part The text part name to get (NULL for the default label)
1309 * @return text of the label or NULL for any error
1311 * @note Elementary object items may have many labels
1315 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1318 * Set the text to read out when in accessibility mode
1320 * @param obj The object which is to be described
1321 * @param txt The text that describes the widget to people with poor or no vision
1325 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1328 * Set the text to read out when in accessibility mode
1330 * @param it The object item which is to be described
1331 * @param txt The text that describes the widget to people with poor or no vision
1335 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1337 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1340 * Set the text to read out when in accessibility mode
1342 * @param it The object item which is to be described
1343 * @param txt The text that describes the widget to people with poor or no vision
1347 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1350 * Get the data associated with an object item
1351 * @param it The Elementary object item
1352 * @return The data associated with @p it
1356 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1359 * Set the data associated with an object item
1360 * @param it The Elementary object item
1361 * @param data The data to be associated with @p it
1365 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1368 * Send a signal to the edje object of the widget item.
1370 * This function sends a signal to the edje object of the obj item. An
1371 * edje program can respond to a signal by specifying matching
1372 * 'signal' and 'source' fields.
1374 * @param it The Elementary object item
1375 * @param emission The signal's name.
1376 * @param source The signal's source.
1379 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1382 * Set the disabled state of an widget item.
1384 * @param obj The Elementary object item
1385 * @param disabled The state to put in in: @c EINA_TRUE for
1386 * disabled, @c EINA_FALSE for enabled
1388 * Elementary object item can be @b disabled, in which state they won't
1389 * receive input and, in general, will be themed differently from
1390 * their normal state, usually greyed out. Useful for contexts
1391 * where you don't want your users to interact with some of the
1392 * parts of you interface.
1394 * This sets the state for the widget item, either disabling it or
1399 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1402 * Get the disabled state of an widget item.
1404 * @param obj The Elementary object
1405 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1406 * if it's enabled (or on errors)
1408 * This gets the state of the widget, which might be enabled or disabled.
1412 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1419 * @defgroup Caches Caches
1421 * These are functions which let one fine-tune some cache values for
1422 * Elementary applications, thus allowing for performance adjustments.
1428 * @brief Flush all caches.
1430 * Frees all data that was in cache and is not currently being used to reduce
1431 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1432 * to calling all of the following functions:
1433 * @li edje_file_cache_flush()
1434 * @li edje_collection_cache_flush()
1435 * @li eet_clearcache()
1436 * @li evas_image_cache_flush()
1437 * @li evas_font_cache_flush()
1438 * @li evas_render_dump()
1439 * @note Evas caches are flushed for every canvas associated with a window.
1443 EAPI void elm_all_flush(void);
1446 * Get the configured cache flush interval time
1448 * This gets the globally configured cache flush interval time, in
1451 * @return The cache flush interval time
1454 * @see elm_all_flush()
1456 EAPI int elm_cache_flush_interval_get(void);
1459 * Set the configured cache flush interval time
1461 * This sets the globally configured cache flush interval time, in ticks
1463 * @param size The cache flush interval time
1466 * @see elm_all_flush()
1468 EAPI void elm_cache_flush_interval_set(int size);
1471 * Set the configured cache flush interval time for all applications on the
1474 * This sets the globally configured cache flush interval time -- in ticks
1475 * -- for all applications on the display.
1477 * @param size The cache flush interval time
1480 EAPI void elm_cache_flush_interval_all_set(int size);
1483 * Get the configured cache flush enabled state
1485 * This gets the globally configured cache flush state - if it is enabled
1486 * or not. When cache flushing is enabled, elementary will regularly
1487 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1488 * memory and allow usage to re-seed caches and data in memory where it
1489 * can do so. An idle application will thus minimise its memory usage as
1490 * data will be freed from memory and not be re-loaded as it is idle and
1491 * not rendering or doing anything graphically right now.
1493 * @return The cache flush state
1496 * @see elm_all_flush()
1498 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1501 * Set the configured cache flush enabled state
1503 * This sets the globally configured cache flush enabled state.
1505 * @param size The cache flush enabled state
1508 * @see elm_all_flush()
1510 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1513 * Set the configured cache flush enabled state for all applications on the
1516 * This sets the globally configured cache flush enabled state for all
1517 * applications on the display.
1519 * @param size The cache flush enabled state
1522 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1525 * Get the configured font cache size
1527 * This gets the globally configured font cache size, in bytes.
1529 * @return The font cache size
1532 EAPI int elm_font_cache_get(void);
1535 * Set the configured font cache size
1537 * This sets the globally configured font cache size, in bytes
1539 * @param size The font cache size
1542 EAPI void elm_font_cache_set(int size);
1545 * Set the configured font cache size for all applications on the
1548 * This sets the globally configured font cache size -- in bytes
1549 * -- for all applications on the display.
1551 * @param size The font cache size
1554 EAPI void elm_font_cache_all_set(int size);
1557 * Get the configured image cache size
1559 * This gets the globally configured image cache size, in bytes
1561 * @return The image cache size
1564 EAPI int elm_image_cache_get(void);
1567 * Set the configured image cache size
1569 * This sets the globally configured image cache size, in bytes
1571 * @param size The image cache size
1574 EAPI void elm_image_cache_set(int size);
1577 * Set the configured image cache size for all applications on the
1580 * This sets the globally configured image cache size -- in bytes
1581 * -- for all applications on the display.
1583 * @param size The image cache size
1586 EAPI void elm_image_cache_all_set(int size);
1589 * Get the configured edje file cache size.
1591 * This gets the globally configured edje file cache size, in number
1594 * @return The edje file cache size
1597 EAPI int elm_edje_file_cache_get(void);
1600 * Set the configured edje file cache size
1602 * This sets the globally configured edje file cache size, in number
1605 * @param size The edje file cache size
1608 EAPI void elm_edje_file_cache_set(int size);
1611 * Set the configured edje file cache size for all applications on the
1614 * This sets the globally configured edje file cache size -- in number
1615 * of files -- for all applications on the display.
1617 * @param size The edje file cache size
1620 EAPI void elm_edje_file_cache_all_set(int size);
1623 * Get the configured edje collections (groups) cache size.
1625 * This gets the globally configured edje collections cache size, in
1626 * number of collections.
1628 * @return The edje collections cache size
1631 EAPI int elm_edje_collection_cache_get(void);
1634 * Set the configured edje collections (groups) cache size
1636 * This sets the globally configured edje collections cache size, in
1637 * number of collections.
1639 * @param size The edje collections cache size
1642 EAPI void elm_edje_collection_cache_set(int size);
1645 * Set the configured edje collections (groups) cache size for all
1646 * applications on the display
1648 * This sets the globally configured edje collections cache size -- in
1649 * number of collections -- for all applications on the display.
1651 * @param size The edje collections cache size
1654 EAPI void elm_edje_collection_cache_all_set(int size);
1661 * @defgroup Scaling Widget Scaling
1663 * Different widgets can be scaled independently. These functions
1664 * allow you to manipulate this scaling on a per-widget basis. The
1665 * object and all its children get their scaling factors multiplied
1666 * by the scale factor set. This is multiplicative, in that if a
1667 * child also has a scale size set it is in turn multiplied by its
1668 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1669 * double size, @c 0.5 is half, etc.
1671 * @ref general_functions_example_page "This" example contemplates
1672 * some of these functions.
1676 * Get the global scaling factor
1678 * This gets the globally configured scaling factor that is applied to all
1681 * @return The scaling factor
1684 EAPI double elm_scale_get(void);
1687 * Set the global scaling factor
1689 * This sets the globally configured scaling factor that is applied to all
1692 * @param scale The scaling factor to set
1695 EAPI void elm_scale_set(double scale);
1698 * Set the global scaling factor for all applications on the display
1700 * This sets the globally configured scaling factor that is applied to all
1701 * objects for all applications.
1702 * @param scale The scaling factor to set
1705 EAPI void elm_scale_all_set(double scale);
1708 * Set the scaling factor for a given Elementary object
1710 * @param obj The Elementary to operate on
1711 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1716 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1719 * Get the scaling factor for a given Elementary object
1721 * @param obj The object
1722 * @return The scaling factor set by elm_object_scale_set()
1726 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1729 * @defgroup Password_last_show Password last input show
1731 * Last show feature of password mode enables user to view
1732 * the last input entered for few seconds before masking it.
1733 * These functions allow to set this feature in password mode
1734 * of entry widget and also allow to manipulate the duration
1735 * for which the input has to be visible.
1741 * Get show last setting of password mode.
1743 * This gets the show last input setting of password mode which might be
1744 * enabled or disabled.
1746 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1748 * @ingroup Password_last_show
1750 EAPI Eina_Bool elm_password_show_last_get(void);
1753 * Set show last setting in password mode.
1755 * This enables or disables show last setting of password mode.
1757 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1758 * @see elm_password_show_last_timeout_set()
1759 * @ingroup Password_last_show
1761 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1764 * Get's the timeout value in last show password mode.
1766 * This gets the time out value for which the last input entered in password
1767 * mode will be visible.
1769 * @return The timeout value of last show password mode.
1770 * @ingroup Password_last_show
1772 EAPI double elm_password_show_last_timeout_get(void);
1775 * Set's the timeout value in last show password mode.
1777 * This sets the time out value for which the last input entered in password
1778 * mode will be visible.
1780 * @param password_show_last_timeout The timeout value.
1781 * @see elm_password_show_last_set()
1782 * @ingroup Password_last_show
1784 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1791 * @defgroup UI-Mirroring Selective Widget mirroring
1793 * These functions allow you to set ui-mirroring on specific
1794 * widgets or the whole interface. Widgets can be in one of two
1795 * modes, automatic and manual. Automatic means they'll be changed
1796 * according to the system mirroring mode and manual means only
1797 * explicit changes will matter. You are not supposed to change
1798 * mirroring state of a widget set to automatic, will mostly work,
1799 * but the behavior is not really defined.
1804 EAPI Eina_Bool elm_mirrored_get(void);
1805 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1808 * Get the system mirrored mode. This determines the default mirrored mode
1811 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1813 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1816 * Set the system mirrored mode. This determines the default mirrored mode
1819 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1821 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1824 * Returns the widget's mirrored mode setting.
1826 * @param obj The widget.
1827 * @return mirrored mode setting of the object.
1830 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1833 * Sets the widget's mirrored mode setting.
1834 * When widget in automatic mode, it follows the system mirrored mode set by
1835 * elm_mirrored_set().
1836 * @param obj The widget.
1837 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1839 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1846 * Set the style to use by a widget
1848 * Sets the style name that will define the appearance of a widget. Styles
1849 * vary from widget to widget and may also be defined by other themes
1850 * by means of extensions and overlays.
1852 * @param obj The Elementary widget to style
1853 * @param style The style name to use
1855 * @see elm_theme_extension_add()
1856 * @see elm_theme_extension_del()
1857 * @see elm_theme_overlay_add()
1858 * @see elm_theme_overlay_del()
1862 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1864 * Get the style used by the widget
1866 * This gets the style being used for that widget. Note that the string
1867 * pointer is only valid as longas the object is valid and the style doesn't
1870 * @param obj The Elementary widget to query for its style
1871 * @return The style name used
1873 * @see elm_object_style_set()
1877 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1880 * @defgroup Styles Styles
1882 * Widgets can have different styles of look. These generic API's
1883 * set styles of widgets, if they support them (and if the theme(s)
1886 * @ref general_functions_example_page "This" example contemplates
1887 * some of these functions.
1891 * Set the disabled state of an Elementary object.
1893 * @param obj The Elementary object to operate on
1894 * @param disabled The state to put in in: @c EINA_TRUE for
1895 * disabled, @c EINA_FALSE for enabled
1897 * Elementary objects can be @b disabled, in which state they won't
1898 * receive input and, in general, will be themed differently from
1899 * their normal state, usually greyed out. Useful for contexts
1900 * where you don't want your users to interact with some of the
1901 * parts of you interface.
1903 * This sets the state for the widget, either disabling it or
1908 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1911 * Get the disabled state of an Elementary object.
1913 * @param obj The Elementary object to operate on
1914 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1915 * if it's enabled (or on errors)
1917 * This gets the state of the widget, which might be enabled or disabled.
1921 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1924 * @defgroup WidgetNavigation Widget Tree Navigation.
1926 * How to check if an Evas Object is an Elementary widget? How to
1927 * get the first elementary widget that is parent of the given
1928 * object? These are all covered in widget tree navigation.
1930 * @ref general_functions_example_page "This" example contemplates
1931 * some of these functions.
1935 * Check if the given Evas Object is an Elementary widget.
1937 * @param obj the object to query.
1938 * @return @c EINA_TRUE if it is an elementary widget variant,
1939 * @c EINA_FALSE otherwise
1940 * @ingroup WidgetNavigation
1942 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1945 * Get the first parent of the given object that is an Elementary
1948 * @param obj the Elementary object to query parent from.
1949 * @return the parent object that is an Elementary widget, or @c
1950 * NULL, if it was not found.
1952 * Use this to query for an object's parent widget.
1954 * @note Most of Elementary users wouldn't be mixing non-Elementary
1955 * smart objects in the objects tree of an application, as this is
1956 * an advanced usage of Elementary with Evas. So, except for the
1957 * application's window, which is the root of that tree, all other
1958 * objects would have valid Elementary widget parents.
1960 * @ingroup WidgetNavigation
1962 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1965 * Get the top level parent of an Elementary widget.
1967 * @param obj The object to query.
1968 * @return The top level Elementary widget, or @c NULL if parent cannot be
1970 * @ingroup WidgetNavigation
1972 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1975 * Get the string that represents this Elementary widget.
1977 * @note Elementary is weird and exposes itself as a single
1978 * Evas_Object_Smart_Class of type "elm_widget", so
1979 * evas_object_type_get() always return that, making debug and
1980 * language bindings hard. This function tries to mitigate this
1981 * problem, but the solution is to change Elementary to use
1982 * proper inheritance.
1984 * @param obj the object to query.
1985 * @return Elementary widget name, or @c NULL if not a valid widget.
1986 * @ingroup WidgetNavigation
1988 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1991 * @defgroup Config Elementary Config
1993 * Elementary configuration is formed by a set options bounded to a
1994 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1995 * "finger size", etc. These are functions with which one syncronizes
1996 * changes made to those values to the configuration storing files, de
1997 * facto. You most probably don't want to use the functions in this
1998 * group unlees you're writing an elementary configuration manager.
2004 * Save back Elementary's configuration, so that it will persist on
2007 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2010 * This function will take effect -- thus, do I/O -- immediately. Use
2011 * it when you want to apply all configuration changes at once. The
2012 * current configuration set will get saved onto the current profile
2013 * configuration file.
2016 EAPI Eina_Bool elm_config_save(void);
2019 * Reload Elementary's configuration, bounded to current selected
2022 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2025 * Useful when you want to force reloading of configuration values for
2026 * a profile. If one removes user custom configuration directories,
2027 * for example, it will force a reload with system values instead.
2030 EAPI void elm_config_reload(void);
2037 * @defgroup Profile Elementary Profile
2039 * Profiles are pre-set options that affect the whole look-and-feel of
2040 * Elementary-based applications. There are, for example, profiles
2041 * aimed at desktop computer applications and others aimed at mobile,
2042 * touchscreen-based ones. You most probably don't want to use the
2043 * functions in this group unlees you're writing an elementary
2044 * configuration manager.
2050 * Get Elementary's profile in use.
2052 * This gets the global profile that is applied to all Elementary
2055 * @return The profile's name
2058 EAPI const char *elm_profile_current_get(void);
2061 * Get an Elementary's profile directory path in the filesystem. One
2062 * may want to fetch a system profile's dir or an user one (fetched
2065 * @param profile The profile's name
2066 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2067 * or a system one (@c EINA_FALSE)
2068 * @return The profile's directory path.
2071 * @note You must free it with elm_profile_dir_free().
2073 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2076 * Free an Elementary's profile directory path, as returned by
2077 * elm_profile_dir_get().
2079 * @param p_dir The profile's path
2083 EAPI void elm_profile_dir_free(const char *p_dir);
2086 * Get Elementary's list of available profiles.
2088 * @return The profiles list. List node data are the profile name
2092 * @note One must free this list, after usage, with the function
2093 * elm_profile_list_free().
2095 EAPI Eina_List *elm_profile_list_get(void);
2098 * Free Elementary's list of available profiles.
2100 * @param l The profiles list, as returned by elm_profile_list_get().
2104 EAPI void elm_profile_list_free(Eina_List *l);
2107 * Set Elementary's profile.
2109 * This sets the global profile that is applied to Elementary
2110 * applications. Just the process the call comes from will be
2113 * @param profile The profile's name
2117 EAPI void elm_profile_set(const char *profile);
2120 * Set Elementary's profile.
2122 * This sets the global profile that is applied to all Elementary
2123 * applications. All running Elementary windows will be affected.
2125 * @param profile The profile's name
2129 EAPI void elm_profile_all_set(const char *profile);
2136 * @defgroup Engine Elementary Engine
2138 * These are functions setting and querying which rendering engine
2139 * Elementary will use for drawing its windows' pixels.
2141 * The following are the available engines:
2142 * @li "software_x11"
2145 * @li "software_16_x11"
2146 * @li "software_8_x11"
2149 * @li "software_gdi"
2150 * @li "software_16_wince_gdi"
2152 * @li "software_16_sdl"
2156 * @li "opengl_cocoa"
2163 * @brief Get Elementary's rendering engine in use.
2165 * @return The rendering engine's name
2166 * @note there's no need to free the returned string, here.
2168 * This gets the global rendering engine that is applied to all Elementary
2171 * @see elm_engine_set()
2173 EAPI const char *elm_engine_current_get(void);
2176 * @brief Set Elementary's rendering engine for use.
2178 * @param engine The rendering engine's name
2180 * This sets global rendering engine that is applied to all Elementary
2181 * applications. Note that it will take effect only to Elementary windows
2182 * created after this is called.
2184 * @see elm_win_add()
2186 EAPI void elm_engine_set(const char *engine);
2193 * @defgroup Fonts Elementary Fonts
2195 * These are functions dealing with font rendering, selection and the
2196 * like for Elementary applications. One might fetch which system
2197 * fonts are there to use and set custom fonts for individual classes
2198 * of UI items containing text (text classes).
2203 typedef struct _Elm_Text_Class
2209 typedef struct _Elm_Font_Overlay
2211 const char *text_class;
2213 Evas_Font_Size size;
2216 typedef struct _Elm_Font_Properties
2220 } Elm_Font_Properties;
2223 * Get Elementary's list of supported text classes.
2225 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2228 * Release the list with elm_text_classes_list_free().
2230 EAPI const Eina_List *elm_text_classes_list_get(void);
2233 * Free Elementary's list of supported text classes.
2237 * @see elm_text_classes_list_get().
2239 EAPI void elm_text_classes_list_free(const Eina_List *list);
2242 * Get Elementary's list of font overlays, set with
2243 * elm_font_overlay_set().
2245 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2250 * For each text class, one can set a <b>font overlay</b> for it,
2251 * overriding the default font properties for that class coming from
2252 * the theme in use. There is no need to free this list.
2254 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2256 EAPI const Eina_List *elm_font_overlay_list_get(void);
2259 * Set a font overlay for a given Elementary text class.
2261 * @param text_class Text class name
2262 * @param font Font name and style string
2263 * @param size Font size
2267 * @p font has to be in the format returned by
2268 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2269 * and elm_font_overlay_unset().
2271 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2274 * Unset a font overlay for a given Elementary text class.
2276 * @param text_class Text class name
2280 * This will bring back text elements belonging to text class
2281 * @p text_class back to their default font settings.
2283 EAPI void elm_font_overlay_unset(const char *text_class);
2286 * Apply the changes made with elm_font_overlay_set() and
2287 * elm_font_overlay_unset() on the current Elementary window.
2291 * This applies all font overlays set to all objects in the UI.
2293 EAPI void elm_font_overlay_apply(void);
2296 * Apply the changes made with elm_font_overlay_set() and
2297 * elm_font_overlay_unset() on all Elementary application windows.
2301 * This applies all font overlays set to all objects in the UI.
2303 EAPI void elm_font_overlay_all_apply(void);
2306 * Translate a font (family) name string in fontconfig's font names
2307 * syntax into an @c Elm_Font_Properties struct.
2309 * @param font The font name and styles string
2310 * @return the font properties struct
2314 * @note The reverse translation can be achived with
2315 * elm_font_fontconfig_name_get(), for one style only (single font
2316 * instance, not family).
2318 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2321 * Free font properties return by elm_font_properties_get().
2323 * @param efp the font properties struct
2327 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2330 * Translate a font name, bound to a style, into fontconfig's font names
2333 * @param name The font (family) name
2334 * @param style The given style (may be @c NULL)
2336 * @return the font name and style string
2340 * @note The reverse translation can be achived with
2341 * elm_font_properties_get(), for one style only (single font
2342 * instance, not family).
2344 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2347 * Free the font string return by elm_font_fontconfig_name_get().
2349 * @param efp the font properties struct
2353 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2356 * Create a font hash table of available system fonts.
2358 * One must call it with @p list being the return value of
2359 * evas_font_available_list(). The hash will be indexed by font
2360 * (family) names, being its values @c Elm_Font_Properties blobs.
2362 * @param list The list of available system fonts, as returned by
2363 * evas_font_available_list().
2364 * @return the font hash.
2368 * @note The user is supposed to get it populated at least with 3
2369 * default font families (Sans, Serif, Monospace), which should be
2370 * present on most systems.
2372 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2375 * Free the hash return by elm_font_available_hash_add().
2377 * @param hash the hash to be freed.
2381 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2388 * @defgroup Fingers Fingers
2390 * Elementary is designed to be finger-friendly for touchscreens,
2391 * and so in addition to scaling for display resolution, it can
2392 * also scale based on finger "resolution" (or size). You can then
2393 * customize the granularity of the areas meant to receive clicks
2396 * Different profiles may have pre-set values for finger sizes.
2398 * @ref general_functions_example_page "This" example contemplates
2399 * some of these functions.
2405 * Get the configured "finger size"
2407 * @return The finger size
2409 * This gets the globally configured finger size, <b>in pixels</b>
2413 EAPI Evas_Coord elm_finger_size_get(void);
2416 * Set the configured finger size
2418 * This sets the globally configured finger size in pixels
2420 * @param size The finger size
2423 EAPI void elm_finger_size_set(Evas_Coord size);
2426 * Set the configured finger size for all applications on the display
2428 * This sets the globally configured finger size in pixels for all
2429 * applications on the display
2431 * @param size The finger size
2434 EAPI void elm_finger_size_all_set(Evas_Coord size);
2441 * @defgroup Focus Focus
2443 * An Elementary application has, at all times, one (and only one)
2444 * @b focused object. This is what determines where the input
2445 * events go to within the application's window. Also, focused
2446 * objects can be decorated differently, in order to signal to the
2447 * user where the input is, at a given moment.
2449 * Elementary applications also have the concept of <b>focus
2450 * chain</b>: one can cycle through all the windows' focusable
2451 * objects by input (tab key) or programmatically. The default
2452 * focus chain for an application is the one define by the order in
2453 * which the widgets where added in code. One will cycle through
2454 * top level widgets, and, for each one containg sub-objects, cycle
2455 * through them all, before returning to the level
2456 * above. Elementary also allows one to set @b custom focus chains
2457 * for their applications.
2459 * Besides the focused decoration a widget may exhibit, when it
2460 * gets focus, Elementary has a @b global focus highlight object
2461 * that can be enabled for a window. If one chooses to do so, this
2462 * extra highlight effect will surround the current focused object,
2465 * @note Some Elementary widgets are @b unfocusable, after
2466 * creation, by their very nature: they are not meant to be
2467 * interacted with input events, but are there just for visual
2470 * @ref general_functions_example_page "This" example contemplates
2471 * some of these functions.
2475 * Get the enable status of the focus highlight
2477 * This gets whether the highlight on focused objects is enabled or not
2480 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2483 * Set the enable status of the focus highlight
2485 * Set whether to show or not the highlight on focused objects
2486 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2489 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2492 * Get the enable status of the highlight animation
2494 * Get whether the focus highlight, if enabled, will animate its switch from
2495 * one object to the next
2498 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2501 * Set the enable status of the highlight animation
2503 * Set whether the focus highlight, if enabled, will animate its switch from
2504 * one object to the next
2505 * @param animate Enable animation if EINA_TRUE, disable otherwise
2508 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2511 * Get the whether an Elementary object has the focus or not.
2513 * @param obj The Elementary object to get the information from
2514 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2515 * not (and on errors).
2517 * @see elm_object_focus_set()
2521 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2524 * Set/unset focus to a given Elementary object.
2526 * @param obj The Elementary object to operate on.
2527 * @param enable @c EINA_TRUE Set focus to a given object,
2528 * @c EINA_FALSE Unset focus to a given object.
2530 * @note When you set focus to this object, if it can handle focus, will
2531 * take the focus away from the one who had it previously and will, for
2532 * now on, be the one receiving input events. Unsetting focus will remove
2533 * the focus from @p obj, passing it back to the previous element in the
2536 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2540 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2543 * Make a given Elementary object the focused one.
2545 * @param obj The Elementary object to make focused.
2547 * @note This object, if it can handle focus, will take the focus
2548 * away from the one who had it previously and will, for now on, be
2549 * the one receiving input events.
2551 * @see elm_object_focus_get()
2552 * @deprecated use elm_object_focus_set() instead.
2556 WILL_DEPRECATE EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2559 * Remove the focus from an Elementary object
2561 * @param obj The Elementary to take focus from
2563 * This removes the focus from @p obj, passing it back to the
2564 * previous element in the focus chain list.
2566 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2567 * @deprecated use elm_object_focus_set() instead.
2571 WILL_DEPRECATE EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2574 * Set the ability for an Element object to be focused
2576 * @param obj The Elementary object to operate on
2577 * @param enable @c EINA_TRUE if the object can be focused, @c
2578 * EINA_FALSE if not (and on errors)
2580 * This sets whether the object @p obj is able to take focus or
2581 * not. Unfocusable objects do nothing when programmatically
2582 * focused, being the nearest focusable parent object the one
2583 * really getting focus. Also, when they receive mouse input, they
2584 * will get the event, but not take away the focus from where it
2589 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2592 * Get whether an Elementary object is focusable or not
2594 * @param obj The Elementary object to operate on
2595 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2596 * EINA_FALSE if not (and on errors)
2598 * @note Objects which are meant to be interacted with by input
2599 * events are created able to be focused, by default. All the
2604 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2607 * Set custom focus chain.
2609 * This function overwrites any previous custom focus chain within
2610 * the list of objects. The previous list will be deleted and this list
2611 * will be managed by elementary. After it is set, don't modify it.
2613 * @note On focus cycle, only will be evaluated children of this container.
2615 * @param obj The container object
2616 * @param objs Chain of objects to pass focus
2619 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2622 * Unset a custom focus chain on a given Elementary widget
2624 * @param obj The container object to remove focus chain from
2626 * Any focus chain previously set on @p obj (for its child objects)
2627 * is removed entirely after this call.
2631 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2634 * Get custom focus chain
2636 * @param obj The container object
2639 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2642 * Append object to custom focus chain.
2644 * @note If relative_child equal to NULL or not in custom chain, the object
2645 * will be added in end.
2647 * @note On focus cycle, only will be evaluated children of this container.
2649 * @param obj The container object
2650 * @param child The child to be added in custom chain
2651 * @param relative_child The relative object to position the child
2654 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2657 * Prepend object to custom focus chain.
2659 * @note If relative_child equal to NULL or not in custom chain, the object
2660 * will be added in begin.
2662 * @note On focus cycle, only will be evaluated children of this container.
2664 * @param obj The container object
2665 * @param child The child to be added in custom chain
2666 * @param relative_child The relative object to position the child
2669 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2672 * Give focus to next object in object tree.
2674 * Give focus to next object in focus chain of one object sub-tree.
2675 * If the last object of chain already have focus, the focus will go to the
2676 * first object of chain.
2678 * @param obj The object root of sub-tree
2679 * @param dir Direction to cycle the focus
2683 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2686 * Give focus to near object in one direction.
2688 * Give focus to near object in direction of one object.
2689 * If none focusable object in given direction, the focus will not change.
2691 * @param obj The reference object
2692 * @param x Horizontal component of direction to focus
2693 * @param y Vertical component of direction to focus
2697 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2700 * Make the elementary object and its children to be unfocusable
2703 * @param obj The Elementary object to operate on
2704 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2705 * @c EINA_FALSE for focusable.
2707 * This sets whether the object @p obj and its children objects
2708 * are able to take focus or not. If the tree is set as unfocusable,
2709 * newest focused object which is not in this tree will get focus.
2710 * This API can be helpful for an object to be deleted.
2711 * When an object will be deleted soon, it and its children may not
2712 * want to get focus (by focus reverting or by other focus controls).
2713 * Then, just use this API before deleting.
2715 * @see elm_object_tree_unfocusable_get()
2719 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2722 * Get whether an Elementary object and its children are unfocusable or not.
2724 * @param obj The Elementary object to get the information from
2725 * @return @c EINA_TRUE, if the tree is unfocussable,
2726 * @c EINA_FALSE if not (and on errors).
2728 * @see elm_object_tree_unfocusable_set()
2732 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2735 * @defgroup Scrolling Scrolling
2737 * These are functions setting how scrollable views in Elementary
2738 * widgets should behave on user interaction.
2744 * Get whether scrollers should bounce when they reach their
2745 * viewport's edge during a scroll.
2747 * @return the thumb scroll bouncing state
2749 * This is the default behavior for touch screens, in general.
2750 * @ingroup Scrolling
2752 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2755 * Set whether scrollers should bounce when they reach their
2756 * viewport's edge during a scroll.
2758 * @param enabled the thumb scroll bouncing state
2760 * @see elm_thumbscroll_bounce_enabled_get()
2761 * @ingroup Scrolling
2763 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2766 * Set whether scrollers should bounce when they reach their
2767 * viewport's edge during a scroll, for all Elementary application
2770 * @param enabled the thumb scroll bouncing state
2772 * @see elm_thumbscroll_bounce_enabled_get()
2773 * @ingroup Scrolling
2775 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2778 * Get the amount of inertia a scroller will impose at bounce
2781 * @return the thumb scroll bounce friction
2783 * @ingroup Scrolling
2785 EAPI double elm_scroll_bounce_friction_get(void);
2788 * Set the amount of inertia a scroller will impose at bounce
2791 * @param friction the thumb scroll bounce friction
2793 * @see elm_thumbscroll_bounce_friction_get()
2794 * @ingroup Scrolling
2796 EAPI void elm_scroll_bounce_friction_set(double friction);
2799 * Set the amount of inertia a scroller will impose at bounce
2800 * animations, for all Elementary application windows.
2802 * @param friction the thumb scroll bounce friction
2804 * @see elm_thumbscroll_bounce_friction_get()
2805 * @ingroup Scrolling
2807 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2810 * Get the amount of inertia a <b>paged</b> scroller will impose at
2811 * page fitting animations.
2813 * @return the page scroll friction
2815 * @ingroup Scrolling
2817 EAPI double elm_scroll_page_scroll_friction_get(void);
2820 * Set the amount of inertia a <b>paged</b> scroller will impose at
2821 * page fitting animations.
2823 * @param friction the page scroll friction
2825 * @see elm_thumbscroll_page_scroll_friction_get()
2826 * @ingroup Scrolling
2828 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2831 * Set the amount of inertia a <b>paged</b> scroller will impose at
2832 * page fitting animations, for all Elementary application windows.
2834 * @param friction the page scroll friction
2836 * @see elm_thumbscroll_page_scroll_friction_get()
2837 * @ingroup Scrolling
2839 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2842 * Get the amount of inertia a scroller will impose at region bring
2845 * @return the bring in scroll friction
2847 * @ingroup Scrolling
2849 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2852 * Set the amount of inertia a scroller will impose at region bring
2855 * @param friction the bring in scroll friction
2857 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2858 * @ingroup Scrolling
2860 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2863 * Set the amount of inertia a scroller will impose at region bring
2864 * animations, for all Elementary application windows.
2866 * @param friction the bring in scroll friction
2868 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2869 * @ingroup Scrolling
2871 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2874 * Get the amount of inertia scrollers will impose at animations
2875 * triggered by Elementary widgets' zooming API.
2877 * @return the zoom friction
2879 * @ingroup Scrolling
2881 EAPI double elm_scroll_zoom_friction_get(void);
2884 * Set the amount of inertia scrollers will impose at animations
2885 * triggered by Elementary widgets' zooming API.
2887 * @param friction the zoom friction
2889 * @see elm_thumbscroll_zoom_friction_get()
2890 * @ingroup Scrolling
2892 EAPI void elm_scroll_zoom_friction_set(double friction);
2895 * Set the amount of inertia scrollers will impose at animations
2896 * triggered by Elementary widgets' zooming API, for all Elementary
2897 * application windows.
2899 * @param friction the zoom friction
2901 * @see elm_thumbscroll_zoom_friction_get()
2902 * @ingroup Scrolling
2904 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2907 * Get whether scrollers should be draggable from any point in their
2910 * @return the thumb scroll state
2912 * @note This is the default behavior for touch screens, in general.
2913 * @note All other functions namespaced with "thumbscroll" will only
2914 * have effect if this mode is enabled.
2916 * @ingroup Scrolling
2918 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2921 * Set whether scrollers should be draggable from any point in their
2924 * @param enabled the thumb scroll state
2926 * @see elm_thumbscroll_enabled_get()
2927 * @ingroup Scrolling
2929 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2932 * Set whether scrollers should be draggable from any point in their
2933 * views, for all Elementary application windows.
2935 * @param enabled the thumb scroll state
2937 * @see elm_thumbscroll_enabled_get()
2938 * @ingroup Scrolling
2940 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2943 * Get the number of pixels one should travel while dragging a
2944 * scroller's view to actually trigger scrolling.
2946 * @return the thumb scroll threshould
2948 * One would use higher values for touch screens, in general, because
2949 * of their inherent imprecision.
2950 * @ingroup Scrolling
2952 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2955 * Set the number of pixels one should travel while dragging a
2956 * scroller's view to actually trigger scrolling.
2958 * @param threshold the thumb scroll threshould
2960 * @see elm_thumbscroll_threshould_get()
2961 * @ingroup Scrolling
2963 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2966 * Set the number of pixels one should travel while dragging a
2967 * scroller's view to actually trigger scrolling, for all Elementary
2968 * application windows.
2970 * @param threshold the thumb scroll threshould
2972 * @see elm_thumbscroll_threshould_get()
2973 * @ingroup Scrolling
2975 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2978 * Get the minimum speed of mouse cursor movement which will trigger
2979 * list self scrolling animation after a mouse up event
2982 * @return the thumb scroll momentum threshould
2984 * @ingroup Scrolling
2986 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2989 * Set the minimum speed of mouse cursor movement which will trigger
2990 * list self scrolling animation after a mouse up event
2993 * @param threshold the thumb scroll momentum threshould
2995 * @see elm_thumbscroll_momentum_threshould_get()
2996 * @ingroup Scrolling
2998 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3001 * Set the minimum speed of mouse cursor movement which will trigger
3002 * list self scrolling animation after a mouse up event
3003 * (pixels/second), for all Elementary application windows.
3005 * @param threshold the thumb scroll momentum threshould
3007 * @see elm_thumbscroll_momentum_threshould_get()
3008 * @ingroup Scrolling
3010 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3013 * Get the amount of inertia a scroller will impose at self scrolling
3016 * @return the thumb scroll friction
3018 * @ingroup Scrolling
3020 EAPI double elm_scroll_thumbscroll_friction_get(void);
3023 * Set the amount of inertia a scroller will impose at self scrolling
3026 * @param friction the thumb scroll friction
3028 * @see elm_thumbscroll_friction_get()
3029 * @ingroup Scrolling
3031 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3034 * Set the amount of inertia a scroller will impose at self scrolling
3035 * animations, for all Elementary application windows.
3037 * @param friction the thumb scroll friction
3039 * @see elm_thumbscroll_friction_get()
3040 * @ingroup Scrolling
3042 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3045 * Get the amount of lag between your actual mouse cursor dragging
3046 * movement and a scroller's view movement itself, while pushing it
3047 * into bounce state manually.
3049 * @return the thumb scroll border friction
3051 * @ingroup Scrolling
3053 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3056 * Set the amount of lag between your actual mouse cursor dragging
3057 * movement and a scroller's view movement itself, while pushing it
3058 * into bounce state manually.
3060 * @param friction the thumb scroll border friction. @c 0.0 for
3061 * perfect synchrony between two movements, @c 1.0 for maximum
3064 * @see elm_thumbscroll_border_friction_get()
3065 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3067 * @ingroup Scrolling
3069 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3072 * Set the amount of lag between your actual mouse cursor dragging
3073 * movement and a scroller's view movement itself, while pushing it
3074 * into bounce state manually, for all Elementary application windows.
3076 * @param friction the thumb scroll border friction. @c 0.0 for
3077 * perfect synchrony between two movements, @c 1.0 for maximum
3080 * @see elm_thumbscroll_border_friction_get()
3081 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3083 * @ingroup Scrolling
3085 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3088 * Get the sensitivity amount which is be multiplied by the length of
3091 * @return the thumb scroll sensitivity friction
3093 * @ingroup Scrolling
3095 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3098 * Set the sensitivity amount which is be multiplied by the length of
3101 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3102 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3105 * @see elm_thumbscroll_sensitivity_friction_get()
3106 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3108 * @ingroup Scrolling
3110 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3113 * Set the sensitivity amount which is be multiplied by the length of
3114 * mouse dragging, for all Elementary application windows.
3116 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3117 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3120 * @see elm_thumbscroll_sensitivity_friction_get()
3121 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3123 * @ingroup Scrolling
3125 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3132 * @defgroup Scrollhints Scrollhints
3134 * Objects when inside a scroller can scroll, but this may not always be
3135 * desirable in certain situations. This allows an object to hint to itself
3136 * and parents to "not scroll" in one of 2 ways. If any child object of a
3137 * scroller has pushed a scroll freeze or hold then it affects all parent
3138 * scrollers until all children have released them.
3140 * 1. To hold on scrolling. This means just flicking and dragging may no
3141 * longer scroll, but pressing/dragging near an edge of the scroller will
3142 * still scroll. This is automatically used by the entry object when
3145 * 2. To totally freeze scrolling. This means it stops. until
3152 * Push the scroll hold by 1
3154 * This increments the scroll hold count by one. If it is more than 0 it will
3155 * take effect on the parents of the indicated object.
3157 * @param obj The object
3158 * @ingroup Scrollhints
3160 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3163 * Pop the scroll hold by 1
3165 * This decrements the scroll hold count by one. If it is more than 0 it will
3166 * take effect on the parents of the indicated object.
3168 * @param obj The object
3169 * @ingroup Scrollhints
3171 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3174 * Push the scroll freeze by 1
3176 * This increments the scroll freeze count by one. If it is more
3177 * than 0 it will take effect on the parents of the indicated
3180 * @param obj The object
3181 * @ingroup Scrollhints
3183 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3186 * Pop the scroll freeze by 1
3188 * This decrements the scroll freeze count by one. If it is more
3189 * than 0 it will take effect on the parents of the indicated
3192 * @param obj The object
3193 * @ingroup Scrollhints
3195 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3198 * Lock the scrolling of the given widget (and thus all parents)
3200 * This locks the given object from scrolling in the X axis (and implicitly
3201 * also locks all parent scrollers too from doing the same).
3203 * @param obj The object
3204 * @param lock The lock state (1 == locked, 0 == unlocked)
3205 * @ingroup Scrollhints
3207 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3210 * Lock the scrolling of the given widget (and thus all parents)
3212 * This locks the given object from scrolling in the Y axis (and implicitly
3213 * also locks all parent scrollers too from doing the same).
3215 * @param obj The object
3216 * @param lock The lock state (1 == locked, 0 == unlocked)
3217 * @ingroup Scrollhints
3219 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3222 * Get the scrolling lock of the given widget
3224 * This gets the lock for X axis scrolling.
3226 * @param obj The object
3227 * @ingroup Scrollhints
3229 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3232 * Get the scrolling lock of the given widget
3234 * This gets the lock for X axis scrolling.
3236 * @param obj The object
3237 * @ingroup Scrollhints
3239 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3246 * Send a signal to the widget edje object.
3248 * This function sends a signal to the edje object of the obj. An
3249 * edje program can respond to a signal by specifying matching
3250 * 'signal' and 'source' fields.
3252 * @param obj The object
3253 * @param emission The signal's name.
3254 * @param source The signal's source.
3257 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3260 * Add a callback for a signal emitted by widget edje object.
3262 * This function connects a callback function to a signal emitted by the
3263 * edje object of the obj.
3264 * Globs can occur in either the emission or source name.
3266 * @param obj The object
3267 * @param emission The signal's name.
3268 * @param source The signal's source.
3269 * @param func The callback function to be executed when the signal is
3271 * @param data A pointer to data to pass in to the callback function.
3274 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);
3277 * Remove a signal-triggered callback from a widget edje object.
3279 * This function removes a callback, previoulsy attached to a
3280 * signal emitted by the edje object of the obj. The parameters
3281 * emission, source and func must match exactly those passed to a
3282 * previous call to elm_object_signal_callback_add(). The data
3283 * pointer that was passed to this call will be returned.
3285 * @param obj The object
3286 * @param emission The signal's name.
3287 * @param source The signal's source.
3288 * @param func The callback function to be executed when the signal is
3290 * @return The data pointer
3293 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);
3296 * Add a callback for input events (key up, key down, mouse wheel)
3297 * on a given Elementary widget
3299 * @param obj The widget to add an event callback on
3300 * @param func The callback function to be executed when the event
3302 * @param data Data to pass in to @p func
3304 * Every widget in an Elementary interface set to receive focus,
3305 * with elm_object_focus_allow_set(), will propagate @b all of its
3306 * key up, key down and mouse wheel input events up to its parent
3307 * object, and so on. All of the focusable ones in this chain which
3308 * had an event callback set, with this call, will be able to treat
3309 * those events. There are two ways of making the propagation of
3310 * these event upwards in the tree of widgets to @b cease:
3311 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3312 * the event was @b not processed, so the propagation will go on.
3313 * - The @c event_info pointer passed to @p func will contain the
3314 * event's structure and, if you OR its @c event_flags inner
3315 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3316 * one has already handled it, thus killing the event's
3319 * @note Your event callback will be issued on those events taking
3320 * place only if no other child widget of @obj has consumed the
3323 * @note Not to be confused with @c
3324 * evas_object_event_callback_add(), which will add event callbacks
3325 * per type on general Evas objects (no event propagation
3326 * infrastructure taken in account).
3328 * @note Not to be confused with @c
3329 * elm_object_signal_callback_add(), which will add callbacks to @b
3330 * signals coming from a widget's theme, not input events.
3332 * @note Not to be confused with @c
3333 * edje_object_signal_callback_add(), which does the same as
3334 * elm_object_signal_callback_add(), but directly on an Edje
3337 * @note Not to be confused with @c
3338 * evas_object_smart_callback_add(), which adds callbacks to smart
3339 * objects' <b>smart events</b>, and not input events.
3341 * @see elm_object_event_callback_del()
3345 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3348 * Remove an event callback from a widget.
3350 * This function removes a callback, previoulsy attached to event emission
3352 * The parameters func and data must match exactly those passed to
3353 * a previous call to elm_object_event_callback_add(). The data pointer that
3354 * was passed to this call will be returned.
3356 * @param obj The object
3357 * @param func The callback function to be executed when the event is
3359 * @param data Data to pass in to the callback function.
3360 * @return The data pointer
3363 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3366 * Adjust size of an element for finger usage.
3368 * @param times_w How many fingers should fit horizontally
3369 * @param w Pointer to the width size to adjust
3370 * @param times_h How many fingers should fit vertically
3371 * @param h Pointer to the height size to adjust
3373 * This takes width and height sizes (in pixels) as input and a
3374 * size multiple (which is how many fingers you want to place
3375 * within the area, being "finger" the size set by
3376 * elm_finger_size_set()), and adjusts the size to be large enough
3377 * to accommodate the resulting size -- if it doesn't already
3378 * accommodate it. On return the @p w and @p h sizes pointed to by
3379 * these parameters will be modified, on those conditions.
3381 * @note This is kind of a low level Elementary call, most useful
3382 * on size evaluation times for widgets. An external user wouldn't
3383 * be calling, most of the time.
3387 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3390 * Get the duration for occuring long press event.
3392 * @return Timeout for long press event
3393 * @ingroup Longpress
3395 EAPI double elm_longpress_timeout_get(void);
3398 * Set the duration for occuring long press event.
3400 * @param lonpress_timeout Timeout for long press event
3401 * @ingroup Longpress
3403 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3406 * @defgroup Debug Debug
3407 * don't use it unless you are sure
3413 * Print Tree object hierarchy in stdout
3415 * @param obj The root object
3418 EAPI void elm_object_tree_dump(const Evas_Object *top);
3419 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3421 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3422 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3424 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3426 * @param obj The root object
3427 * @param file The path of output file
3430 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3437 * @defgroup Theme Theme
3439 * Elementary uses Edje to theme its widgets, naturally. But for the most
3440 * part this is hidden behind a simpler interface that lets the user set
3441 * extensions and choose the style of widgets in a much easier way.
3443 * Instead of thinking in terms of paths to Edje files and their groups
3444 * each time you want to change the appearance of a widget, Elementary
3445 * works so you can add any theme file with extensions or replace the
3446 * main theme at one point in the application, and then just set the style
3447 * of widgets with elm_object_style_set() and related functions. Elementary
3448 * will then look in its list of themes for a matching group and apply it,
3449 * and when the theme changes midway through the application, all widgets
3450 * will be updated accordingly.
3452 * There are three concepts you need to know to understand how Elementary
3453 * theming works: default theme, extensions and overlays.
3455 * Default theme, obviously enough, is the one that provides the default
3456 * look of all widgets. End users can change the theme used by Elementary
3457 * by setting the @c ELM_THEME environment variable before running an
3458 * application, or globally for all programs using the @c elementary_config
3459 * utility. Applications can change the default theme using elm_theme_set(),
3460 * but this can go against the user wishes, so it's not an adviced practice.
3462 * Ideally, applications should find everything they need in the already
3463 * provided theme, but there may be occasions when that's not enough and
3464 * custom styles are required to correctly express the idea. For this
3465 * cases, Elementary has extensions.
3467 * Extensions allow the application developer to write styles of its own
3468 * to apply to some widgets. This requires knowledge of how each widget
3469 * is themed, as extensions will always replace the entire group used by
3470 * the widget, so important signals and parts need to be there for the
3471 * object to behave properly (see documentation of Edje for details).
3472 * Once the theme for the extension is done, the application needs to add
3473 * it to the list of themes Elementary will look into, using
3474 * elm_theme_extension_add(), and set the style of the desired widgets as
3475 * he would normally with elm_object_style_set().
3477 * Overlays, on the other hand, can replace the look of all widgets by
3478 * overriding the default style. Like extensions, it's up to the application
3479 * developer to write the theme for the widgets it wants, the difference
3480 * being that when looking for the theme, Elementary will check first the
3481 * list of overlays, then the set theme and lastly the list of extensions,
3482 * so with overlays it's possible to replace the default view and every
3483 * widget will be affected. This is very much alike to setting the whole
3484 * theme for the application and will probably clash with the end user
3485 * options, not to mention the risk of ending up with not matching styles
3486 * across the program. Unless there's a very special reason to use them,
3487 * overlays should be avoided for the resons exposed before.
3489 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3490 * keeps one default internally and every function that receives one of
3491 * these can be called with NULL to refer to this default (except for
3492 * elm_theme_free()). It's possible to create a new instance of a
3493 * ::Elm_Theme to set other theme for a specific widget (and all of its
3494 * children), but this is as discouraged, if not even more so, than using
3495 * overlays. Don't use this unless you really know what you are doing.
3497 * But to be less negative about things, you can look at the following
3499 * @li @ref theme_example_01 "Using extensions"
3500 * @li @ref theme_example_02 "Using overlays"
3505 * @typedef Elm_Theme
3507 * Opaque handler for the list of themes Elementary looks for when
3508 * rendering widgets.
3510 * Stay out of this unless you really know what you are doing. For most
3511 * cases, sticking to the default is all a developer needs.
3513 typedef struct _Elm_Theme Elm_Theme;
3516 * Create a new specific theme
3518 * This creates an empty specific theme that only uses the default theme. A
3519 * specific theme has its own private set of extensions and overlays too
3520 * (which are empty by default). Specific themes do not fall back to themes
3521 * of parent objects. They are not intended for this use. Use styles, overlays
3522 * and extensions when needed, but avoid specific themes unless there is no
3523 * other way (example: you want to have a preview of a new theme you are
3524 * selecting in a "theme selector" window. The preview is inside a scroller
3525 * and should display what the theme you selected will look like, but not
3526 * actually apply it yet. The child of the scroller will have a specific
3527 * theme set to show this preview before the user decides to apply it to all
3530 EAPI Elm_Theme *elm_theme_new(void);
3532 * Free a specific theme
3534 * @param th The theme to free
3536 * This frees a theme created with elm_theme_new().
3538 EAPI void elm_theme_free(Elm_Theme *th);
3540 * Copy the theme fom the source to the destination theme
3542 * @param th The source theme to copy from
3543 * @param thdst The destination theme to copy data to
3545 * This makes a one-time static copy of all the theme config, extensions
3546 * and overlays from @p th to @p thdst. If @p th references a theme, then
3547 * @p thdst is also set to reference it, with all the theme settings,
3548 * overlays and extensions that @p th had.
3550 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3552 * Tell the source theme to reference the ref theme
3554 * @param th The theme that will do the referencing
3555 * @param thref The theme that is the reference source
3557 * This clears @p th to be empty and then sets it to refer to @p thref
3558 * so @p th acts as an override to @p thref, but where its overrides
3559 * don't apply, it will fall through to @p thref for configuration.
3561 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3563 * Return the theme referred to
3565 * @param th The theme to get the reference from
3566 * @return The referenced theme handle
3568 * This gets the theme set as the reference theme by elm_theme_ref_set().
3569 * If no theme is set as a reference, NULL is returned.
3571 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3573 * Return the default theme
3575 * @return The default theme handle
3577 * This returns the internal default theme setup handle that all widgets
3578 * use implicitly unless a specific theme is set. This is also often use
3579 * as a shorthand of NULL.
3581 EAPI Elm_Theme *elm_theme_default_get(void);
3583 * Prepends a theme overlay to the list of overlays
3585 * @param th The theme to add to, or if NULL, the default theme
3586 * @param item The Edje file path to be used
3588 * Use this if your application needs to provide some custom overlay theme
3589 * (An Edje file that replaces some default styles of widgets) where adding
3590 * new styles, or changing system theme configuration is not possible. Do
3591 * NOT use this instead of a proper system theme configuration. Use proper
3592 * configuration files, profiles, environment variables etc. to set a theme
3593 * so that the theme can be altered by simple confiugration by a user. Using
3594 * this call to achieve that effect is abusing the API and will create lots
3597 * @see elm_theme_extension_add()
3599 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3601 * Delete a theme overlay from the list of overlays
3603 * @param th The theme to delete from, or if NULL, the default theme
3604 * @param item The name of the theme overlay
3606 * @see elm_theme_overlay_add()
3608 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3610 * Appends a theme extension to the list of extensions.
3612 * @param th The theme to add to, or if NULL, the default theme
3613 * @param item The Edje file path to be used
3615 * This is intended when an application needs more styles of widgets or new
3616 * widget themes that the default does not provide (or may not provide). The
3617 * application has "extended" usage by coming up with new custom style names
3618 * for widgets for specific uses, but as these are not "standard", they are
3619 * not guaranteed to be provided by a default theme. This means the
3620 * application is required to provide these extra elements itself in specific
3621 * Edje files. This call adds one of those Edje files to the theme search
3622 * path to be search after the default theme. The use of this call is
3623 * encouraged when default styles do not meet the needs of the application.
3624 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3626 * @see elm_object_style_set()
3628 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3630 * Deletes a theme extension from the list of extensions.
3632 * @param th The theme to delete from, or if NULL, the default theme
3633 * @param item The name of the theme extension
3635 * @see elm_theme_extension_add()
3637 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3639 * Set the theme search order for the given theme
3641 * @param th The theme to set the search order, or if NULL, the default theme
3642 * @param theme Theme search string
3644 * This sets the search string for the theme in path-notation from first
3645 * theme to search, to last, delimited by the : character. Example:
3647 * "shiny:/path/to/file.edj:default"
3649 * See the ELM_THEME environment variable for more information.
3651 * @see elm_theme_get()
3652 * @see elm_theme_list_get()
3654 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3656 * Return the theme search order
3658 * @param th The theme to get the search order, or if NULL, the default theme
3659 * @return The internal search order path
3661 * This function returns a colon separated string of theme elements as
3662 * returned by elm_theme_list_get().
3664 * @see elm_theme_set()
3665 * @see elm_theme_list_get()
3667 EAPI const char *elm_theme_get(Elm_Theme *th);
3669 * Return a list of theme elements to be used in a theme.
3671 * @param th Theme to get the list of theme elements from.
3672 * @return The internal list of theme elements
3674 * This returns the internal list of theme elements (will only be valid as
3675 * long as the theme is not modified by elm_theme_set() or theme is not
3676 * freed by elm_theme_free(). This is a list of strings which must not be
3677 * altered as they are also internal. If @p th is NULL, then the default
3678 * theme element list is returned.
3680 * A theme element can consist of a full or relative path to a .edj file,
3681 * or a name, without extension, for a theme to be searched in the known
3682 * theme paths for Elemementary.
3684 * @see elm_theme_set()
3685 * @see elm_theme_get()
3687 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3689 * Return the full patrh for a theme element
3691 * @param f The theme element name
3692 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3693 * @return The full path to the file found.
3695 * This returns a string you should free with free() on success, NULL on
3696 * failure. This will search for the given theme element, and if it is a
3697 * full or relative path element or a simple searchable name. The returned
3698 * path is the full path to the file, if searched, and the file exists, or it
3699 * is simply the full path given in the element or a resolved path if
3700 * relative to home. The @p in_search_path boolean pointed to is set to
3701 * EINA_TRUE if the file was a searchable file andis in the search path,
3702 * and EINA_FALSE otherwise.
3704 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3706 * Flush the current theme.
3708 * @param th Theme to flush
3710 * This flushes caches that let elementary know where to find theme elements
3711 * in the given theme. If @p th is NULL, then the default theme is flushed.
3712 * Call this function if source theme data has changed in such a way as to
3713 * make any caches Elementary kept invalid.
3715 EAPI void elm_theme_flush(Elm_Theme *th);
3717 * This flushes all themes (default and specific ones).
3719 * This will flush all themes in the current application context, by calling
3720 * elm_theme_flush() on each of them.
3722 EAPI void elm_theme_full_flush(void);
3724 * Set the theme for all elementary using applications on the current display
3726 * @param theme The name of the theme to use. Format same as the ELM_THEME
3727 * environment variable.
3729 EAPI void elm_theme_all_set(const char *theme);
3731 * Return a list of theme elements in the theme search path
3733 * @return A list of strings that are the theme element names.
3735 * This lists all available theme files in the standard Elementary search path
3736 * for theme elements, and returns them in alphabetical order as theme
3737 * element names in a list of strings. Free this with
3738 * elm_theme_name_available_list_free() when you are done with the list.
3740 EAPI Eina_List *elm_theme_name_available_list_new(void);
3742 * Free the list returned by elm_theme_name_available_list_new()
3744 * This frees the list of themes returned by
3745 * elm_theme_name_available_list_new(). Once freed the list should no longer
3746 * be used. a new list mys be created.
3748 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3750 * Set a specific theme to be used for this object and its children
3752 * @param obj The object to set the theme on
3753 * @param th The theme to set
3755 * This sets a specific theme that will be used for the given object and any
3756 * child objects it has. If @p th is NULL then the theme to be used is
3757 * cleared and the object will inherit its theme from its parent (which
3758 * ultimately will use the default theme if no specific themes are set).
3760 * Use special themes with great care as this will annoy users and make
3761 * configuration difficult. Avoid any custom themes at all if it can be
3764 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3766 * Get the specific theme to be used
3768 * @param obj The object to get the specific theme from
3769 * @return The specifc theme set.
3771 * This will return a specific theme set, or NULL if no specific theme is
3772 * set on that object. It will not return inherited themes from parents, only
3773 * the specific theme set for that specific object. See elm_object_theme_set()
3774 * for more information.
3776 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3779 * Get a data item from a theme
3781 * @param th The theme, or NULL for default theme
3782 * @param key The data key to search with
3783 * @return The data value, or NULL on failure
3785 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3786 * It works the same way as edje_file_data_get() except that the return is stringshared.
3788 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3794 /** @defgroup Win Win
3796 * @image html img/widget/win/preview-00.png
3797 * @image latex img/widget/win/preview-00.eps
3799 * The window class of Elementary. Contains functions to manipulate
3800 * windows. The Evas engine used to render the window contents is specified
3801 * in the system or user elementary config files (whichever is found last),
3802 * and can be overridden with the ELM_ENGINE environment variable for
3803 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3804 * compilation setup and modules actually installed at runtime) are (listed
3805 * in order of best supported and most likely to be complete and work to
3808 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3809 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3811 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3813 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3815 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3817 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3818 * rendering using SDL as the buffer)
3819 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3820 * GDI with software)
3821 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3822 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3823 * grayscale using dedicated 8bit software engine in X11)
3824 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3825 * X11 using 16bit software engine)
3826 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3827 * (Windows CE rendering via GDI with 16bit software renderer)
3828 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3829 * buffer with 16bit software renderer)
3830 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3831 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3832 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3834 * All engines use a simple string to select the engine to render, EXCEPT
3835 * the "shot" engine. This actually encodes the output of the virtual
3836 * screenshot and how long to delay in the engine string. The engine string
3837 * is encoded in the following way:
3839 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3841 * Where options are separated by a ":" char if more than one option is
3842 * given, with delay, if provided being the first option and file the last
3843 * (order is important). The delay specifies how long to wait after the
3844 * window is shown before doing the virtual "in memory" rendering and then
3845 * save the output to the file specified by the file option (and then exit).
3846 * If no delay is given, the default is 0.5 seconds. If no file is given the
3847 * default output file is "out.png". Repeat option is for continous
3848 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3849 * fixed to "out001.png" Some examples of using the shot engine:
3851 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3852 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3853 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3854 * ELM_ENGINE="shot:delay=2.0" elementary_test
3855 * ELM_ENGINE="shot:" elementary_test
3857 * Signals that you can add callbacks for are:
3859 * @li "delete,request": the user requested to close the window. See
3860 * elm_win_autodel_set().
3861 * @li "focus,in": window got focus
3862 * @li "focus,out": window lost focus
3863 * @li "moved": window that holds the canvas was moved
3866 * @li @ref win_example_01
3871 * Defines the types of window that can be created
3873 * These are hints set on the window so that a running Window Manager knows
3874 * how the window should be handled and/or what kind of decorations it
3877 * Currently, only the X11 backed engines use them.
3879 typedef enum _Elm_Win_Type
3881 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3882 window. Almost every window will be created with this
3884 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3885 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3886 window holding desktop icons. */
3887 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3888 be kept on top of any other window by the Window
3890 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3892 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3893 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3895 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3896 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3897 entry in a menubar is clicked. Typically used
3898 with elm_win_override_set(). This hint exists
3899 for completion only, as the EFL way of
3900 implementing a menu would not normally use a
3901 separate window for its contents. */
3902 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3903 triggered by right-clicking an object. */
3904 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3905 explanatory text that typically appear after the
3906 mouse cursor hovers over an object for a while.
3907 Typically used with elm_win_override_set() and also
3908 not very commonly used in the EFL. */
3909 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3910 battery life or a new E-Mail received. */
3911 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3912 usually used in the EFL. */
3913 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3914 object being dragged across different windows, or even
3915 applications. Typically used with
3916 elm_win_override_set(). */
3917 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3918 buffer. No actual window is created for this
3919 type, instead the window and all of its
3920 contents will be rendered to an image buffer.
3921 This allows to have children window inside a
3922 parent one just like any other object would
3923 be, and do other things like applying @c
3924 Evas_Map effects to it. This is the only type
3925 of window that requires the @c parent
3926 parameter of elm_win_add() to be a valid @c
3931 * The differents layouts that can be requested for the virtual keyboard.
3933 * When the application window is being managed by Illume, it may request
3934 * any of the following layouts for the virtual keyboard.
3936 typedef enum _Elm_Win_Keyboard_Mode
3938 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3939 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3940 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3941 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3942 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3943 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3944 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3945 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3946 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3947 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3948 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3949 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3950 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3951 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3952 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3953 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3954 } Elm_Win_Keyboard_Mode;
3957 * Available commands that can be sent to the Illume manager.
3959 * When running under an Illume session, a window may send commands to the
3960 * Illume manager to perform different actions.
3962 typedef enum _Elm_Illume_Command
3964 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3966 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3968 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3970 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3971 } Elm_Illume_Command;
3974 * Adds a window object. If this is the first window created, pass NULL as
3977 * @param parent Parent object to add the window to, or NULL
3978 * @param name The name of the window
3979 * @param type The window type, one of #Elm_Win_Type.
3981 * The @p parent paramter can be @c NULL for every window @p type except
3982 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3983 * which the image object will be created.
3985 * @return The created object, or NULL on failure
3987 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3989 * Adds a window object with standard setup
3991 * @param name The name of the window
3992 * @param title The title for the window
3994 * This creates a window like elm_win_add() but also puts in a standard
3995 * background with elm_bg_add(), as well as setting the window title to
3996 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3997 * as the parent widget.
3999 * @return The created object, or NULL on failure
4001 * @see elm_win_add()
4003 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4005 * Add @p subobj as a resize object of window @p obj.
4008 * Setting an object as a resize object of the window means that the
4009 * @p subobj child's size and position will be controlled by the window
4010 * directly. That is, the object will be resized to match the window size
4011 * and should never be moved or resized manually by the developer.
4013 * In addition, resize objects of the window control what the minimum size
4014 * of it will be, as well as whether it can or not be resized by the user.
4016 * For the end user to be able to resize a window by dragging the handles
4017 * or borders provided by the Window Manager, or using any other similar
4018 * mechanism, all of the resize objects in the window should have their
4019 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4021 * @param obj The window object
4022 * @param subobj The resize object to add
4024 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4026 * Delete @p subobj as a resize object of window @p obj.
4028 * This function removes the object @p subobj from the resize objects of
4029 * the window @p obj. It will not delete the object itself, which will be
4030 * left unmanaged and should be deleted by the developer, manually handled
4031 * or set as child of some other container.
4033 * @param obj The window object
4034 * @param subobj The resize object to add
4036 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4038 * Set the title of the window
4040 * @param obj The window object
4041 * @param title The title to set
4043 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4045 * Get the title of the window
4047 * The returned string is an internal one and should not be freed or
4048 * modified. It will also be rendered invalid if a new title is set or if
4049 * the window is destroyed.
4051 * @param obj The window object
4054 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4056 * Set the window's autodel state.
4058 * When closing the window in any way outside of the program control, like
4059 * pressing the X button in the titlebar or using a command from the
4060 * Window Manager, a "delete,request" signal is emitted to indicate that
4061 * this event occurred and the developer can take any action, which may
4062 * include, or not, destroying the window object.
4064 * When the @p autodel parameter is set, the window will be automatically
4065 * destroyed when this event occurs, after the signal is emitted.
4066 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4067 * and is up to the program to do so when it's required.
4069 * @param obj The window object
4070 * @param autodel If true, the window will automatically delete itself when
4073 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4075 * Get the window's autodel state.
4077 * @param obj The window object
4078 * @return If the window will automatically delete itself when closed
4080 * @see elm_win_autodel_set()
4082 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4084 * Activate a window object.
4086 * This function sends a request to the Window Manager to activate the
4087 * window pointed by @p obj. If honored by the WM, the window will receive
4088 * the keyboard focus.
4090 * @note This is just a request that a Window Manager may ignore, so calling
4091 * this function does not ensure in any way that the window will be the
4092 * active one after it.
4094 * @param obj The window object
4096 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4098 * Lower a window object.
4100 * Places the window pointed by @p obj at the bottom of the stack, so that
4101 * no other window is covered by it.
4103 * If elm_win_override_set() is not set, the Window Manager may ignore this
4106 * @param obj The window object
4108 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 * Raise a window object.
4112 * Places the window pointed by @p obj at the top of the stack, so that it's
4113 * not covered by any other window.
4115 * If elm_win_override_set() is not set, the Window Manager may ignore this
4118 * @param obj The window object
4120 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4122 * Set the borderless state of a window.
4124 * This function requests the Window Manager to not draw any decoration
4125 * around the window.
4127 * @param obj The window object
4128 * @param borderless If true, the window is borderless
4130 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4132 * Get the borderless state of a window.
4134 * @param obj The window object
4135 * @return If true, the window is borderless
4137 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4139 * Set the shaped state of a window.
4141 * Shaped windows, when supported, will render the parts of the window that
4142 * has no content, transparent.
4144 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4145 * background object or cover the entire window in any other way, or the
4146 * parts of the canvas that have no data will show framebuffer artifacts.
4148 * @param obj The window object
4149 * @param shaped If true, the window is shaped
4151 * @see elm_win_alpha_set()
4153 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4155 * Get the shaped state of a window.
4157 * @param obj The window object
4158 * @return If true, the window is shaped
4160 * @see elm_win_shaped_set()
4162 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4164 * Set the alpha channel state of a window.
4166 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4167 * possibly making parts of the window completely or partially transparent.
4168 * This is also subject to the underlying system supporting it, like for
4169 * example, running under a compositing manager. If no compositing is
4170 * available, enabling this option will instead fallback to using shaped
4171 * windows, with elm_win_shaped_set().
4173 * @param obj The window object
4174 * @param alpha If true, the window has an alpha channel
4176 * @see elm_win_alpha_set()
4178 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4180 * Get the transparency state of a window.
4182 * @param obj The window object
4183 * @return If true, the window is transparent
4185 * @see elm_win_transparent_set()
4187 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4189 * Set the transparency state of a window.
4191 * Use elm_win_alpha_set() instead.
4193 * @param obj The window object
4194 * @param transparent If true, the window is transparent
4196 * @see elm_win_alpha_set()
4198 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4200 * Get the alpha channel state of a window.
4202 * @param obj The window object
4203 * @return If true, the window has an alpha channel
4205 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4207 * Set the override state of a window.
4209 * A window with @p override set to EINA_TRUE will not be managed by the
4210 * Window Manager. This means that no decorations of any kind will be shown
4211 * for it, moving and resizing must be handled by the application, as well
4212 * as the window visibility.
4214 * This should not be used for normal windows, and even for not so normal
4215 * ones, it should only be used when there's a good reason and with a lot
4216 * of care. Mishandling override windows may result situations that
4217 * disrupt the normal workflow of the end user.
4219 * @param obj The window object
4220 * @param override If true, the window is overridden
4222 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4224 * Get the override state of a window.
4226 * @param obj The window object
4227 * @return If true, the window is overridden
4229 * @see elm_win_override_set()
4231 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4233 * Set the fullscreen state of a window.
4235 * @param obj The window object
4236 * @param fullscreen If true, the window is fullscreen
4238 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4240 * Get the fullscreen state of a window.
4242 * @param obj The window object
4243 * @return If true, the window is fullscreen
4245 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4247 * Set the maximized state of a window.
4249 * @param obj The window object
4250 * @param maximized If true, the window is maximized
4252 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4254 * Get the maximized state of a window.
4256 * @param obj The window object
4257 * @return If true, the window is maximized
4259 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4261 * Set the iconified state of a window.
4263 * @param obj The window object
4264 * @param iconified If true, the window is iconified
4266 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4268 * Get the iconified state of a window.
4270 * @param obj The window object
4271 * @return If true, the window is iconified
4273 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * Set the layer of the window.
4277 * What this means exactly will depend on the underlying engine used.
4279 * In the case of X11 backed engines, the value in @p layer has the
4280 * following meanings:
4281 * @li < 3: The window will be placed below all others.
4282 * @li > 5: The window will be placed above all others.
4283 * @li other: The window will be placed in the default layer.
4285 * @param obj The window object
4286 * @param layer The layer of the window
4288 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4290 * Get the layer of the window.
4292 * @param obj The window object
4293 * @return The layer of the window
4295 * @see elm_win_layer_set()
4297 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299 * Set the rotation of the window.
4301 * Most engines only work with multiples of 90.
4303 * This function is used to set the orientation of the window @p obj to
4304 * match that of the screen. The window itself will be resized to adjust
4305 * to the new geometry of its contents. If you want to keep the window size,
4306 * see elm_win_rotation_with_resize_set().
4308 * @param obj The window object
4309 * @param rotation The rotation of the window, in degrees (0-360),
4310 * counter-clockwise.
4312 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4314 * Rotates the window and resizes it.
4316 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4317 * that they fit inside the current window geometry.
4319 * @param obj The window object
4320 * @param layer The rotation of the window in degrees (0-360),
4321 * counter-clockwise.
4323 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4325 * Get the rotation of the window.
4327 * @param obj The window object
4328 * @return The rotation of the window in degrees (0-360)
4330 * @see elm_win_rotation_set()
4331 * @see elm_win_rotation_with_resize_set()
4333 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4335 * Set the sticky state of the window.
4337 * Hints the Window Manager that the window in @p obj should be left fixed
4338 * at its position even when the virtual desktop it's on moves or changes.
4340 * @param obj The window object
4341 * @param sticky If true, the window's sticky state is enabled
4343 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4345 * Get the sticky state of the window.
4347 * @param obj The window object
4348 * @return If true, the window's sticky state is enabled
4350 * @see elm_win_sticky_set()
4352 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354 * Set if this window is an illume conformant window
4356 * @param obj The window object
4357 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4359 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4361 * Get if this window is an illume conformant window
4363 * @param obj The window object
4364 * @return A boolean if this window is illume conformant or not
4366 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 * Set a window to be an illume quickpanel window
4370 * By default window objects are not quickpanel windows.
4372 * @param obj The window object
4373 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4375 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4377 * Get if this window is a quickpanel or not
4379 * @param obj The window object
4380 * @return A boolean if this window is a quickpanel or not
4382 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4384 * Set the major priority of a quickpanel window
4386 * @param obj The window object
4387 * @param priority The major priority for this quickpanel
4389 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4391 * Get the major priority of a quickpanel window
4393 * @param obj The window object
4394 * @return The major priority of this quickpanel
4396 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4398 * Set the minor priority of a quickpanel window
4400 * @param obj The window object
4401 * @param priority The minor priority for this quickpanel
4403 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4405 * Get the minor priority of a quickpanel window
4407 * @param obj The window object
4408 * @return The minor priority of this quickpanel
4410 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4412 * Set which zone this quickpanel should appear in
4414 * @param obj The window object
4415 * @param zone The requested zone for this quickpanel
4417 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4419 * Get which zone this quickpanel should appear in
4421 * @param obj The window object
4422 * @return The requested zone for this quickpanel
4424 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4426 * Set the window to be skipped by keyboard focus
4428 * This sets the window to be skipped by normal keyboard input. This means
4429 * a window manager will be asked to not focus this window as well as omit
4430 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4432 * Call this and enable it on a window BEFORE you show it for the first time,
4433 * otherwise it may have no effect.
4435 * Use this for windows that have only output information or might only be
4436 * interacted with by the mouse or fingers, and never for typing input.
4437 * Be careful that this may have side-effects like making the window
4438 * non-accessible in some cases unless the window is specially handled. Use
4441 * @param obj The window object
4442 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4444 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4446 * Send a command to the windowing environment
4448 * This is intended to work in touchscreen or small screen device
4449 * environments where there is a more simplistic window management policy in
4450 * place. This uses the window object indicated to select which part of the
4451 * environment to control (the part that this window lives in), and provides
4452 * a command and an optional parameter structure (use NULL for this if not
4455 * @param obj The window object that lives in the environment to control
4456 * @param command The command to send
4457 * @param params Optional parameters for the command
4459 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4461 * Get the inlined image object handle
4463 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4464 * then the window is in fact an evas image object inlined in the parent
4465 * canvas. You can get this object (be careful to not manipulate it as it
4466 * is under control of elementary), and use it to do things like get pixel
4467 * data, save the image to a file, etc.
4469 * @param obj The window object to get the inlined image from
4470 * @return The inlined image object, or NULL if none exists
4472 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4474 * Determine whether a window has focus
4475 * @param obj The window to query
4476 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4478 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4480 * Get screen geometry details for the screen that a window is on
4481 * @param obj The window to query
4482 * @param x where to return the horizontal offset value. May be NULL.
4483 * @param y where to return the vertical offset value. May be NULL.
4484 * @param w where to return the width value. May be NULL.
4485 * @param h where to return the height value. May be NULL.
4487 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4489 * Set the enabled status for the focus highlight in a window
4491 * This function will enable or disable the focus highlight only for the
4492 * given window, regardless of the global setting for it
4494 * @param obj The window where to enable the highlight
4495 * @param enabled The enabled value for the highlight
4497 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4499 * Get the enabled value of the focus highlight for this window
4501 * @param obj The window in which to check if the focus highlight is enabled
4503 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4505 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4507 * Set the style for the focus highlight on this window
4509 * Sets the style to use for theming the highlight of focused objects on
4510 * the given window. If @p style is NULL, the default will be used.
4512 * @param obj The window where to set the style
4513 * @param style The style to set
4515 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4517 * Get the style set for the focus highlight object
4519 * Gets the style set for this windows highilght object, or NULL if none
4522 * @param obj The window to retrieve the highlights style from
4524 * @return The style set or NULL if none was. Default is used in that case.
4526 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4527 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4528 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4530 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4531 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4532 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4533 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4534 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4535 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4536 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4538 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4539 * (blank mouse, private mouse obj, defaultmouse)
4543 * Sets the keyboard mode of the window.
4545 * @param obj The window object
4546 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4548 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4550 * Gets the keyboard mode of the window.
4552 * @param obj The window object
4553 * @return The mode, one of #Elm_Win_Keyboard_Mode
4555 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4557 * Sets whether the window is a keyboard.
4559 * @param obj The window object
4560 * @param is_keyboard If true, the window is a virtual keyboard
4562 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4564 * Gets whether the window is a keyboard.
4566 * @param obj The window object
4567 * @return If the window is a virtual keyboard
4569 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4572 * Get the screen position of a window.
4574 * @param obj The window object
4575 * @param x The int to store the x coordinate to
4576 * @param y The int to store the y coordinate to
4578 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4584 * @defgroup Inwin Inwin
4586 * @image html img/widget/inwin/preview-00.png
4587 * @image latex img/widget/inwin/preview-00.eps
4588 * @image html img/widget/inwin/preview-01.png
4589 * @image latex img/widget/inwin/preview-01.eps
4590 * @image html img/widget/inwin/preview-02.png
4591 * @image latex img/widget/inwin/preview-02.eps
4593 * An inwin is a window inside a window that is useful for a quick popup.
4594 * It does not hover.
4596 * It works by creating an object that will occupy the entire window, so it
4597 * must be created using an @ref Win "elm_win" as parent only. The inwin
4598 * object can be hidden or restacked below every other object if it's
4599 * needed to show what's behind it without destroying it. If this is done,
4600 * the elm_win_inwin_activate() function can be used to bring it back to
4601 * full visibility again.
4603 * There are three styles available in the default theme. These are:
4604 * @li default: The inwin is sized to take over most of the window it's
4606 * @li minimal: The size of the inwin will be the minimum necessary to show
4608 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4609 * possible, but it's sized vertically the most it needs to fit its\
4612 * Some examples of Inwin can be found in the following:
4613 * @li @ref inwin_example_01
4618 * Adds an inwin to the current window
4620 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4621 * Never call this function with anything other than the top-most window
4622 * as its parameter, unless you are fond of undefined behavior.
4624 * After creating the object, the widget will set itself as resize object
4625 * for the window with elm_win_resize_object_add(), so when shown it will
4626 * appear to cover almost the entire window (how much of it depends on its
4627 * content and the style used). It must not be added into other container
4628 * objects and it needs not be moved or resized manually.
4630 * @param parent The parent object
4631 * @return The new object or NULL if it cannot be created
4633 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4635 * Activates an inwin object, ensuring its visibility
4637 * This function will make sure that the inwin @p obj is completely visible
4638 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4639 * to the front. It also sets the keyboard focus to it, which will be passed
4642 * The object's theme will also receive the signal "elm,action,show" with
4645 * @param obj The inwin to activate
4647 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4649 * Set the content of an inwin object.
4651 * Once the content object is set, a previously set one will be deleted.
4652 * If you want to keep that old content object, use the
4653 * elm_win_inwin_content_unset() function.
4655 * @param obj The inwin object
4656 * @param content The object to set as content
4658 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4660 * Get the content of an inwin object.
4662 * Return the content object which is set for this widget.
4664 * The returned object is valid as long as the inwin is still alive and no
4665 * other content is set on it. Deleting the object will notify the inwin
4666 * about it and this one will be left empty.
4668 * If you need to remove an inwin's content to be reused somewhere else,
4669 * see elm_win_inwin_content_unset().
4671 * @param obj The inwin object
4672 * @return The content that is being used
4674 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4676 * Unset the content of an inwin object.
4678 * Unparent and return the content object which was set for this widget.
4680 * @param obj The inwin object
4681 * @return The content that was being used
4683 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4687 /* X specific calls - won't work on non-x engines (return 0) */
4690 * Get the Ecore_X_Window of an Evas_Object
4692 * @param obj The object
4694 * @return The Ecore_X_Window of @p obj
4698 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4700 /* smart callbacks called:
4701 * "delete,request" - the user requested to delete the window
4702 * "focus,in" - window got focus
4703 * "focus,out" - window lost focus
4704 * "moved" - window that holds the canvas was moved
4710 * @image html img/widget/bg/preview-00.png
4711 * @image latex img/widget/bg/preview-00.eps
4713 * @brief Background object, used for setting a solid color, image or Edje
4714 * group as background to a window or any container object.
4716 * The bg object is used for setting a solid background to a window or
4717 * packing into any container object. It works just like an image, but has
4718 * some properties useful to a background, like setting it to tiled,
4719 * centered, scaled or stretched.
4721 * Default contents parts of the bg widget that you can use for are:
4722 * @li "overlay" - overlay of the bg
4724 * Here is some sample code using it:
4725 * @li @ref bg_01_example_page
4726 * @li @ref bg_02_example_page
4727 * @li @ref bg_03_example_page
4731 typedef enum _Elm_Bg_Option
4733 ELM_BG_OPTION_CENTER, /**< center the background */
4734 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4735 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4736 ELM_BG_OPTION_TILE /**< tile background at its original size */
4740 * Add a new background to the parent
4742 * @param parent The parent object
4743 * @return The new object or NULL if it cannot be created
4747 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4750 * Set the file (image or edje) used for the background
4752 * @param obj The bg object
4753 * @param file The file path
4754 * @param group Optional key (group in Edje) within the file
4756 * This sets the image file used in the background object. The image (or edje)
4757 * will be stretched (retaining aspect if its an image file) to completely fill
4758 * the bg object. This may mean some parts are not visible.
4760 * @note Once the image of @p obj is set, a previously set one will be deleted,
4761 * even if @p file is NULL.
4765 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4768 * Get the file (image or edje) used for the background
4770 * @param obj The bg object
4771 * @param file The file path
4772 * @param group Optional key (group in Edje) within the file
4776 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4779 * Set the option used for the background image
4781 * @param obj The bg object
4782 * @param option The desired background option (TILE, SCALE)
4784 * This sets the option used for manipulating the display of the background
4785 * image. The image can be tiled or scaled.
4789 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4792 * Get the option used for the background image
4794 * @param obj The bg object
4795 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4799 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4801 * Set the option used for the background color
4803 * @param obj The bg object
4808 * This sets the color used for the background rectangle. Its range goes
4813 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4815 * Get the option used for the background color
4817 * @param obj The bg object
4824 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4827 * Set the overlay object used for the background object.
4829 * @param obj The bg object
4830 * @param overlay The overlay object
4832 * This provides a way for elm_bg to have an 'overlay' that will be on top
4833 * of the bg. Once the over object is set, a previously set one will be
4834 * deleted, even if you set the new one to NULL. If you want to keep that
4835 * old content object, use the elm_bg_overlay_unset() function.
4837 * @deprecated use elm_object_part_content_set() instead
4842 WILL_DEPRECATE EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4845 * Get the overlay object used for the background object.
4847 * @param obj The bg object
4848 * @return The content that is being used
4850 * Return the content object which is set for this widget
4852 * @deprecated use elm_object_part_content_get() instead
4856 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4859 * Get the overlay object used for the background object.
4861 * @param obj The bg object
4862 * @return The content that was being used
4864 * Unparent and return the overlay object which was set for this widget
4866 * @deprecated use elm_object_part_content_unset() instead
4870 WILL_DEPRECATE EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4873 * Set the size of the pixmap representation of the image.
4875 * This option just makes sense if an image is going to be set in the bg.
4877 * @param obj The bg object
4878 * @param w The new width of the image pixmap representation.
4879 * @param h The new height of the image pixmap representation.
4881 * This function sets a new size for pixmap representation of the given bg
4882 * image. It allows the image to be loaded already in the specified size,
4883 * reducing the memory usage and load time when loading a big image with load
4884 * size set to a smaller size.
4886 * NOTE: this is just a hint, the real size of the pixmap may differ
4887 * depending on the type of image being loaded, being bigger than requested.
4891 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4892 /* smart callbacks called:
4896 * @defgroup Icon Icon
4898 * @image html img/widget/icon/preview-00.png
4899 * @image latex img/widget/icon/preview-00.eps
4901 * An object that provides standard icon images (delete, edit, arrows, etc.)
4902 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4904 * The icon image requested can be in the elementary theme, or in the
4905 * freedesktop.org paths. It's possible to set the order of preference from
4906 * where the image will be used.
4908 * This API is very similar to @ref Image, but with ready to use images.
4910 * Default images provided by the theme are described below.
4912 * The first list contains icons that were first intended to be used in
4913 * toolbars, but can be used in many other places too:
4929 * Now some icons that were designed to be used in menus (but again, you can
4930 * use them anywhere else):
4935 * @li menu/arrow_down
4936 * @li menu/arrow_left
4937 * @li menu/arrow_right
4946 * And here we have some media player specific icons:
4947 * @li media_player/forward
4948 * @li media_player/info
4949 * @li media_player/next
4950 * @li media_player/pause
4951 * @li media_player/play
4952 * @li media_player/prev
4953 * @li media_player/rewind
4954 * @li media_player/stop
4956 * Signals that you can add callbacks for are:
4958 * "clicked" - This is called when a user has clicked the icon
4960 * An example of usage for this API follows:
4961 * @li @ref tutorial_icon
4969 typedef enum _Elm_Icon_Type
4976 * @enum _Elm_Icon_Lookup_Order
4977 * @typedef Elm_Icon_Lookup_Order
4979 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4980 * theme, FDO paths, or both?
4984 typedef enum _Elm_Icon_Lookup_Order
4986 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4987 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4988 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4989 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4990 } Elm_Icon_Lookup_Order;
4993 * Add a new icon object to the parent.
4995 * @param parent The parent object
4996 * @return The new object or NULL if it cannot be created
4998 * @see elm_icon_file_set()
5002 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5004 * Set the file that will be used as icon.
5006 * @param obj The icon object
5007 * @param file The path to file that will be used as icon image
5008 * @param group The group that the icon belongs to an edje file
5010 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5012 * @note The icon image set by this function can be changed by
5013 * elm_icon_standard_set().
5015 * @see elm_icon_file_get()
5019 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5021 * Set a location in memory to be used as an icon
5023 * @param obj The icon object
5024 * @param img The binary data that will be used as an image
5025 * @param size The size of binary data @p img
5026 * @param format Optional format of @p img to pass to the image loader
5027 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5029 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5031 * @note The icon image set by this function can be changed by
5032 * elm_icon_standard_set().
5036 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);
5038 * Get the file that will be used as icon.
5040 * @param obj The icon object
5041 * @param file The path to file that will be used as the icon image
5042 * @param group The group that the icon belongs to, in edje file
5044 * @see elm_icon_file_set()
5048 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5049 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5051 * Set the icon by icon standards names.
5053 * @param obj The icon object
5054 * @param name The icon name
5056 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5058 * For example, freedesktop.org defines standard icon names such as "home",
5059 * "network", etc. There can be different icon sets to match those icon
5060 * keys. The @p name given as parameter is one of these "keys", and will be
5061 * used to look in the freedesktop.org paths and elementary theme. One can
5062 * change the lookup order with elm_icon_order_lookup_set().
5064 * If name is not found in any of the expected locations and it is the
5065 * absolute path of an image file, this image will be used.
5067 * @note The icon image set by this function can be changed by
5068 * elm_icon_file_set().
5070 * @see elm_icon_standard_get()
5071 * @see elm_icon_file_set()
5075 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5077 * Get the icon name set by icon standard names.
5079 * @param obj The icon object
5080 * @return The icon name
5082 * If the icon image was set using elm_icon_file_set() instead of
5083 * elm_icon_standard_set(), then this function will return @c NULL.
5085 * @see elm_icon_standard_set()
5089 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5091 * Set the smooth scaling for an icon object.
5093 * @param obj The icon object
5094 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5095 * otherwise. Default is @c EINA_TRUE.
5097 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5098 * scaling provides a better resulting image, but is slower.
5100 * The smooth scaling should be disabled when making animations that change
5101 * the icon size, since they will be faster. Animations that don't require
5102 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5103 * is already scaled, since the scaled icon image will be cached).
5105 * @see elm_icon_smooth_get()
5109 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5111 * Get whether smooth scaling is enabled for an icon object.
5113 * @param obj The icon object
5114 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5116 * @see elm_icon_smooth_set()
5120 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5122 * Disable scaling of this object.
5124 * @param obj The icon object.
5125 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5126 * otherwise. Default is @c EINA_FALSE.
5128 * This function disables scaling of the icon object through the function
5129 * elm_object_scale_set(). However, this does not affect the object
5130 * size/resize in any way. For that effect, take a look at
5131 * elm_icon_scale_set().
5133 * @see elm_icon_no_scale_get()
5134 * @see elm_icon_scale_set()
5135 * @see elm_object_scale_set()
5139 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5141 * Get whether scaling is disabled on the object.
5143 * @param obj The icon object
5144 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5146 * @see elm_icon_no_scale_set()
5150 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5152 * Set if the object is (up/down) resizable.
5154 * @param obj The icon object
5155 * @param scale_up A bool to set if the object is resizable up. Default is
5157 * @param scale_down A bool to set if the object is resizable down. Default
5160 * This function limits the icon object resize ability. If @p scale_up is set to
5161 * @c EINA_FALSE, the object can't have its height or width resized to a value
5162 * higher than the original icon size. Same is valid for @p scale_down.
5164 * @see elm_icon_scale_get()
5168 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5170 * Get if the object is (up/down) resizable.
5172 * @param obj The icon object
5173 * @param scale_up A bool to set if the object is resizable up
5174 * @param scale_down A bool to set if the object is resizable down
5176 * @see elm_icon_scale_set()
5180 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5182 * Get the object's image size
5184 * @param obj The icon object
5185 * @param w A pointer to store the width in
5186 * @param h A pointer to store the height in
5190 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5192 * Set if the icon fill the entire object area.
5194 * @param obj The icon object
5195 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5196 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5198 * When the icon object is resized to a different aspect ratio from the
5199 * original icon image, the icon image will still keep its aspect. This flag
5200 * tells how the image should fill the object's area. They are: keep the
5201 * entire icon inside the limits of height and width of the object (@p
5202 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5203 * of the object, and the icon will fill the entire object (@p fill_outside
5206 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5207 * retain property to false. Thus, the icon image will always keep its
5208 * original aspect ratio.
5210 * @see elm_icon_fill_outside_get()
5211 * @see elm_image_fill_outside_set()
5215 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5217 * Get if the object is filled outside.
5219 * @param obj The icon object
5220 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5222 * @see elm_icon_fill_outside_set()
5226 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5228 * Set the prescale size for the icon.
5230 * @param obj The icon object
5231 * @param size The prescale size. This value is used for both width and
5234 * This function sets a new size for pixmap representation of the given
5235 * icon. It allows the icon to be loaded already in the specified size,
5236 * reducing the memory usage and load time when loading a big icon with load
5237 * size set to a smaller size.
5239 * It's equivalent to the elm_bg_load_size_set() function for bg.
5241 * @note this is just a hint, the real size of the pixmap may differ
5242 * depending on the type of icon being loaded, being bigger than requested.
5244 * @see elm_icon_prescale_get()
5245 * @see elm_bg_load_size_set()
5249 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5251 * Get the prescale size for the icon.
5253 * @param obj The icon object
5254 * @return The prescale size
5256 * @see elm_icon_prescale_set()
5260 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5262 * Gets the image object of the icon. DO NOT MODIFY THIS.
5264 * @param obj The icon object
5265 * @return The internal icon object
5269 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5271 * Sets the icon lookup order used by elm_icon_standard_set().
5273 * @param obj The icon object
5274 * @param order The icon lookup order (can be one of
5275 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5276 * or ELM_ICON_LOOKUP_THEME)
5278 * @see elm_icon_order_lookup_get()
5279 * @see Elm_Icon_Lookup_Order
5283 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5285 * Gets the icon lookup order.
5287 * @param obj The icon object
5288 * @return The icon lookup order
5290 * @see elm_icon_order_lookup_set()
5291 * @see Elm_Icon_Lookup_Order
5295 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5297 * Enable or disable preloading of the icon
5299 * @param obj The icon object
5300 * @param disable If EINA_TRUE, preloading will be disabled
5303 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5305 * Get if the icon supports animation or not.
5307 * @param obj The icon object
5308 * @return @c EINA_TRUE if the icon supports animation,
5309 * @c EINA_FALSE otherwise.
5311 * Return if this elm icon's image can be animated. Currently Evas only
5312 * supports gif animation. If the return value is EINA_FALSE, other
5313 * elm_icon_animated_XXX APIs won't work.
5316 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5318 * Set animation mode of the icon.
5320 * @param obj The icon object
5321 * @param anim @c EINA_TRUE if the object do animation job,
5322 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5324 * Since the default animation mode is set to EINA_FALSE,
5325 * the icon is shown without animation.
5326 * This might be desirable when the application developer wants to show
5327 * a snapshot of the animated icon.
5328 * Set it to EINA_TRUE when the icon needs to be animated.
5331 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5333 * Get animation mode of the icon.
5335 * @param obj The icon object
5336 * @return The animation mode of the icon object
5337 * @see elm_icon_animated_set
5340 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5342 * Set animation play mode of the icon.
5344 * @param obj The icon object
5345 * @param play @c EINA_TRUE the object play animation images,
5346 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5348 * To play elm icon's animation, set play to EINA_TURE.
5349 * For example, you make gif player using this set/get API and click event.
5351 * 1. Click event occurs
5352 * 2. Check play flag using elm_icon_animaged_play_get
5353 * 3. If elm icon was playing, set play to EINA_FALSE.
5354 * Then animation will be stopped and vice versa
5357 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5359 * Get animation play mode of the icon.
5361 * @param obj The icon object
5362 * @return The play mode of the icon object
5364 * @see elm_icon_animated_play_get
5367 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5369 /* compatibility code to avoid API and ABI breaks */
5370 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5372 elm_icon_animated_set(obj, animated);
5375 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5377 return elm_icon_animated_get(obj);
5380 EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5382 elm_icon_animated_play_set(obj, play);
5385 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5387 return elm_icon_animated_play_get(obj);
5395 * @defgroup Image Image
5397 * @image html img/widget/image/preview-00.png
5398 * @image latex img/widget/image/preview-00.eps
5401 * An object that allows one to load an image file to it. It can be used
5402 * anywhere like any other elementary widget.
5404 * This widget provides most of the functionality provided from @ref Bg or @ref
5405 * Icon, but with a slightly different API (use the one that fits better your
5408 * The features not provided by those two other image widgets are:
5409 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5410 * @li change the object orientation with elm_image_orient_set();
5411 * @li and turning the image editable with elm_image_editable_set().
5413 * Signals that you can add callbacks for are:
5415 * @li @c "clicked" - This is called when a user has clicked the image
5417 * An example of usage for this API follows:
5418 * @li @ref tutorial_image
5427 * @enum _Elm_Image_Orient
5428 * @typedef Elm_Image_Orient
5430 * Possible orientation options for elm_image_orient_set().
5432 * @image html elm_image_orient_set.png
5433 * @image latex elm_image_orient_set.eps width=\textwidth
5437 typedef enum _Elm_Image_Orient
5439 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5440 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5441 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5442 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5443 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5444 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5445 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5446 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5450 * Add a new image to the parent.
5452 * @param parent The parent object
5453 * @return The new object or NULL if it cannot be created
5455 * @see elm_image_file_set()
5459 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5461 * Set the file that will be used as image.
5463 * @param obj The image object
5464 * @param file The path to file that will be used as image
5465 * @param group The group that the image belongs in edje file (if it's an
5468 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5470 * @see elm_image_file_get()
5474 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5476 * Get the file that will be used as image.
5478 * @param obj The image object
5479 * @param file The path to file
5480 * @param group The group that the image belongs in edje file
5482 * @see elm_image_file_set()
5486 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5488 * Set the smooth effect for an image.
5490 * @param obj The image object
5491 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5492 * otherwise. Default is @c EINA_TRUE.
5494 * Set the scaling algorithm to be used when scaling the image. Smooth
5495 * scaling provides a better resulting image, but is slower.
5497 * The smooth scaling should be disabled when making animations that change
5498 * the image size, since it will be faster. Animations that don't require
5499 * resizing of the image can keep the smooth scaling enabled (even if the
5500 * image is already scaled, since the scaled image will be cached).
5502 * @see elm_image_smooth_get()
5506 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5508 * Get the smooth effect for an image.
5510 * @param obj The image object
5511 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5513 * @see elm_image_smooth_get()
5517 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5520 * Gets the current size of the image.
5522 * @param obj The image object.
5523 * @param w Pointer to store width, or NULL.
5524 * @param h Pointer to store height, or NULL.
5526 * This is the real size of the image, not the size of the object.
5528 * On error, neither w or h will be written.
5532 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5534 * Disable scaling of this object.
5536 * @param obj The image object.
5537 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5538 * otherwise. Default is @c EINA_FALSE.
5540 * This function disables scaling of the elm_image widget through the
5541 * function elm_object_scale_set(). However, this does not affect the widget
5542 * size/resize in any way. For that effect, take a look at
5543 * elm_image_scale_set().
5545 * @see elm_image_no_scale_get()
5546 * @see elm_image_scale_set()
5547 * @see elm_object_scale_set()
5551 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5553 * Get whether scaling is disabled on the object.
5555 * @param obj The image object
5556 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5558 * @see elm_image_no_scale_set()
5562 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5564 * Set if the object is (up/down) resizable.
5566 * @param obj The image object
5567 * @param scale_up A bool to set if the object is resizable up. Default is
5569 * @param scale_down A bool to set if the object is resizable down. Default
5572 * This function limits the image resize ability. If @p scale_up is set to
5573 * @c EINA_FALSE, the object can't have its height or width resized to a value
5574 * higher than the original image size. Same is valid for @p scale_down.
5576 * @see elm_image_scale_get()
5580 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5582 * Get if the object is (up/down) resizable.
5584 * @param obj The image object
5585 * @param scale_up A bool to set if the object is resizable up
5586 * @param scale_down A bool to set if the object is resizable down
5588 * @see elm_image_scale_set()
5592 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5594 * Set if the image fills the entire object area, when keeping the aspect ratio.
5596 * @param obj The image object
5597 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5598 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5600 * When the image should keep its aspect ratio even if resized to another
5601 * aspect ratio, there are two possibilities to resize it: keep the entire
5602 * image inside the limits of height and width of the object (@p fill_outside
5603 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5604 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5606 * @note This option will have no effect if
5607 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5609 * @see elm_image_fill_outside_get()
5610 * @see elm_image_aspect_ratio_retained_set()
5614 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5616 * Get if the object is filled outside
5618 * @param obj The image object
5619 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5621 * @see elm_image_fill_outside_set()
5625 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5627 * Set the prescale size for the image
5629 * @param obj The image object
5630 * @param size The prescale size. This value is used for both width and
5633 * This function sets a new size for pixmap representation of the given
5634 * image. It allows the image to be loaded already in the specified size,
5635 * reducing the memory usage and load time when loading a big image with load
5636 * size set to a smaller size.
5638 * It's equivalent to the elm_bg_load_size_set() function for bg.
5640 * @note this is just a hint, the real size of the pixmap may differ
5641 * depending on the type of image being loaded, being bigger than requested.
5643 * @see elm_image_prescale_get()
5644 * @see elm_bg_load_size_set()
5648 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5650 * Get the prescale size for the image
5652 * @param obj The image object
5653 * @return The prescale size
5655 * @see elm_image_prescale_set()
5659 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5661 * Set the image orientation.
5663 * @param obj The image object
5664 * @param orient The image orientation @ref Elm_Image_Orient
5665 * Default is #ELM_IMAGE_ORIENT_NONE.
5667 * This function allows to rotate or flip the given image.
5669 * @see elm_image_orient_get()
5670 * @see @ref Elm_Image_Orient
5674 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5676 * Get the image orientation.
5678 * @param obj The image object
5679 * @return The image orientation @ref Elm_Image_Orient
5681 * @see elm_image_orient_set()
5682 * @see @ref Elm_Image_Orient
5686 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5688 * Make the image 'editable'.
5690 * @param obj Image object.
5691 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5693 * This means the image is a valid drag target for drag and drop, and can be
5694 * cut or pasted too.
5698 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5700 * Check if the image 'editable'.
5702 * @param obj Image object.
5703 * @return Editability.
5705 * A return value of EINA_TRUE means the image is a valid drag target
5706 * for drag and drop, and can be cut or pasted too.
5710 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5712 * Get the basic Evas_Image object from this object (widget).
5714 * @param obj The image object to get the inlined image from
5715 * @return The inlined image object, or NULL if none exists
5717 * This function allows one to get the underlying @c Evas_Object of type
5718 * Image from this elementary widget. It can be useful to do things like get
5719 * the pixel data, save the image to a file, etc.
5721 * @note Be careful to not manipulate it, as it is under control of
5726 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5728 * Set whether the original aspect ratio of the image should be kept on resize.
5730 * @param obj The image object.
5731 * @param retained @c EINA_TRUE if the image should retain the aspect,
5732 * @c EINA_FALSE otherwise.
5734 * The original aspect ratio (width / height) of the image is usually
5735 * distorted to match the object's size. Enabling this option will retain
5736 * this original aspect, and the way that the image is fit into the object's
5737 * area depends on the option set by elm_image_fill_outside_set().
5739 * @see elm_image_aspect_ratio_retained_get()
5740 * @see elm_image_fill_outside_set()
5744 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5746 * Get if the object retains the original aspect ratio.
5748 * @param obj The image object.
5749 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5754 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5761 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5763 /* old API compatibility */
5764 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5766 typedef enum _Elm_GLView_Mode
5768 ELM_GLVIEW_ALPHA = 1,
5769 ELM_GLVIEW_DEPTH = 2,
5770 ELM_GLVIEW_STENCIL = 4
5774 * Defines a policy for the glview resizing.
5776 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5778 typedef enum _Elm_GLView_Resize_Policy
5780 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5781 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5782 } Elm_GLView_Resize_Policy;
5784 typedef enum _Elm_GLView_Render_Policy
5786 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5787 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5788 } Elm_GLView_Render_Policy;
5793 * A simple GLView widget that allows GL rendering.
5795 * Signals that you can add callbacks for are:
5801 * Add a new glview to the parent
5803 * @param parent The parent object
5804 * @return The new object or NULL if it cannot be created
5808 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5811 * Sets the size of the glview
5813 * @param obj The glview object
5814 * @param width width of the glview object
5815 * @param height height of the glview object
5819 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5822 * Gets the size of the glview.
5824 * @param obj The glview object
5825 * @param width width of the glview object
5826 * @param height height of the glview object
5828 * Note that this function returns the actual image size of the
5829 * glview. This means that when the scale policy is set to
5830 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5835 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5838 * Gets the gl api struct for gl rendering
5840 * @param obj The glview object
5841 * @return The api object or NULL if it cannot be created
5845 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5848 * Set the mode of the GLView. Supports Three simple modes.
5850 * @param obj The glview object
5851 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5852 * @return True if set properly.
5856 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5859 * Set the resize policy for the glview object.
5861 * @param obj The glview object.
5862 * @param policy The scaling policy.
5864 * By default, the resize policy is set to
5865 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5866 * destroys the previous surface and recreates the newly specified
5867 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5868 * however, glview only scales the image object and not the underlying
5873 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5876 * Set the render policy for the glview object.
5878 * @param obj The glview object.
5879 * @param policy The render policy.
5881 * By default, the render policy is set to
5882 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5883 * that during the render loop, glview is only redrawn if it needs
5884 * to be redrawn. (i.e. When it is visible) If the policy is set to
5885 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5886 * whether it is visible/need redrawing or not.
5890 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5893 * Set the init function that runs once in the main loop.
5895 * @param obj The glview object.
5896 * @param func The init function to be registered.
5898 * The registered init function gets called once during the render loop.
5902 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5905 * Set the render function that runs in the main loop.
5907 * @param obj The glview object.
5908 * @param func The delete function to be registered.
5910 * The registered del function gets called when GLView object is deleted.
5914 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5917 * Set the resize function that gets called when resize happens.
5919 * @param obj The glview object.
5920 * @param func The resize function to be registered.
5924 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5927 * Set the render function that runs in the main loop.
5929 * @param obj The glview object.
5930 * @param func The render function to be registered.
5934 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5937 * Notifies that there has been changes in the GLView.
5939 * @param obj The glview object.
5943 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5953 * @image html img/widget/box/preview-00.png
5954 * @image latex img/widget/box/preview-00.eps width=\textwidth
5956 * @image html img/box.png
5957 * @image latex img/box.eps width=\textwidth
5959 * A box arranges objects in a linear fashion, governed by a layout function
5960 * that defines the details of this arrangement.
5962 * By default, the box will use an internal function to set the layout to
5963 * a single row, either vertical or horizontal. This layout is affected
5964 * by a number of parameters, such as the homogeneous flag set by
5965 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5966 * elm_box_align_set() and the hints set to each object in the box.
5968 * For this default layout, it's possible to change the orientation with
5969 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5970 * placing its elements ordered from top to bottom. When horizontal is set,
5971 * the order will go from left to right. If the box is set to be
5972 * homogeneous, every object in it will be assigned the same space, that
5973 * of the largest object. Padding can be used to set some spacing between
5974 * the cell given to each object. The alignment of the box, set with
5975 * elm_box_align_set(), determines how the bounding box of all the elements
5976 * will be placed within the space given to the box widget itself.
5978 * The size hints of each object also affect how they are placed and sized
5979 * within the box. evas_object_size_hint_min_set() will give the minimum
5980 * size the object can have, and the box will use it as the basis for all
5981 * latter calculations. Elementary widgets set their own minimum size as
5982 * needed, so there's rarely any need to use it manually.
5984 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5985 * used to tell whether the object will be allocated the minimum size it
5986 * needs or if the space given to it should be expanded. It's important
5987 * to realize that expanding the size given to the object is not the same
5988 * thing as resizing the object. It could very well end being a small
5989 * widget floating in a much larger empty space. If not set, the weight
5990 * for objects will normally be 0.0 for both axis, meaning the widget will
5991 * not be expanded. To take as much space possible, set the weight to
5992 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5994 * Besides how much space each object is allocated, it's possible to control
5995 * how the widget will be placed within that space using
5996 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5997 * for both axis, meaning the object will be centered, but any value from
5998 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5999 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6000 * is -1.0, means the object will be resized to fill the entire space it
6003 * In addition, customized functions to define the layout can be set, which
6004 * allow the application developer to organize the objects within the box
6005 * in any number of ways.
6007 * The special elm_box_layout_transition() function can be used
6008 * to switch from one layout to another, animating the motion of the
6009 * children of the box.
6011 * @note Objects should not be added to box objects using _add() calls.
6013 * Some examples on how to use boxes follow:
6014 * @li @ref box_example_01
6015 * @li @ref box_example_02
6020 * @typedef Elm_Box_Transition
6022 * Opaque handler containing the parameters to perform an animated
6023 * transition of the layout the box uses.
6025 * @see elm_box_transition_new()
6026 * @see elm_box_layout_set()
6027 * @see elm_box_layout_transition()
6029 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6032 * Add a new box to the parent
6034 * By default, the box will be in vertical mode and non-homogeneous.
6036 * @param parent The parent object
6037 * @return The new object or NULL if it cannot be created
6039 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6041 * Set the horizontal orientation
6043 * By default, box object arranges their contents vertically from top to
6045 * By calling this function with @p horizontal as EINA_TRUE, the box will
6046 * become horizontal, arranging contents from left to right.
6048 * @note This flag is ignored if a custom layout function is set.
6050 * @param obj The box object
6051 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6052 * EINA_FALSE = vertical)
6054 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6056 * Get the horizontal orientation
6058 * @param obj The box object
6059 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6061 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6063 * Set the box to arrange its children homogeneously
6065 * If enabled, homogeneous layout makes all items the same size, according
6066 * to the size of the largest of its children.
6068 * @note This flag is ignored if a custom layout function is set.
6070 * @param obj The box object
6071 * @param homogeneous The homogeneous flag
6073 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6075 * Get whether the box is using homogeneous mode or not
6077 * @param obj The box object
6078 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6080 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6081 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6082 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6084 * Add an object to the beginning of the pack list
6086 * Pack @p subobj into the box @p obj, placing it first in the list of
6087 * children objects. The actual position the object will get on screen
6088 * depends on the layout used. If no custom layout is set, it will be at
6089 * the top or left, depending if the box is vertical or horizontal,
6092 * @param obj The box object
6093 * @param subobj The object to add to the box
6095 * @see elm_box_pack_end()
6096 * @see elm_box_pack_before()
6097 * @see elm_box_pack_after()
6098 * @see elm_box_unpack()
6099 * @see elm_box_unpack_all()
6100 * @see elm_box_clear()
6102 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6104 * Add an object at the end of the pack list
6106 * Pack @p subobj into the box @p obj, placing it last in the list of
6107 * children objects. The actual position the object will get on screen
6108 * depends on the layout used. If no custom layout is set, it will be at
6109 * the bottom or right, depending if the box is vertical or horizontal,
6112 * @param obj The box object
6113 * @param subobj The object to add to the box
6115 * @see elm_box_pack_start()
6116 * @see elm_box_pack_before()
6117 * @see elm_box_pack_after()
6118 * @see elm_box_unpack()
6119 * @see elm_box_unpack_all()
6120 * @see elm_box_clear()
6122 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6124 * Adds an object to the box before the indicated object
6126 * This will add the @p subobj to the box indicated before the object
6127 * indicated with @p before. If @p before is not already in the box, results
6128 * are undefined. Before means either to the left of the indicated object or
6129 * above it depending on orientation.
6131 * @param obj The box object
6132 * @param subobj The object to add to the box
6133 * @param before The object before which to add it
6135 * @see elm_box_pack_start()
6136 * @see elm_box_pack_end()
6137 * @see elm_box_pack_after()
6138 * @see elm_box_unpack()
6139 * @see elm_box_unpack_all()
6140 * @see elm_box_clear()
6142 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6144 * Adds an object to the box after the indicated object
6146 * This will add the @p subobj to the box indicated after the object
6147 * indicated with @p after. If @p after is not already in the box, results
6148 * are undefined. After means either to the right of the indicated object or
6149 * below it depending on orientation.
6151 * @param obj The box object
6152 * @param subobj The object to add to the box
6153 * @param after The object after which to add it
6155 * @see elm_box_pack_start()
6156 * @see elm_box_pack_end()
6157 * @see elm_box_pack_before()
6158 * @see elm_box_unpack()
6159 * @see elm_box_unpack_all()
6160 * @see elm_box_clear()
6162 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6164 * Clear the box of all children
6166 * Remove all the elements contained by the box, deleting the respective
6169 * @param obj The box object
6171 * @see elm_box_unpack()
6172 * @see elm_box_unpack_all()
6174 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6178 * Remove the object given by @p subobj from the box @p obj without
6181 * @param obj The box object
6183 * @see elm_box_unpack_all()
6184 * @see elm_box_clear()
6186 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6188 * Remove all items from the box, without deleting them
6190 * Clear the box from all children, but don't delete the respective objects.
6191 * If no other references of the box children exist, the objects will never
6192 * be deleted, and thus the application will leak the memory. Make sure
6193 * when using this function that you hold a reference to all the objects
6194 * in the box @p obj.
6196 * @param obj The box object
6198 * @see elm_box_clear()
6199 * @see elm_box_unpack()
6201 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6203 * Retrieve a list of the objects packed into the box
6205 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6206 * The order of the list corresponds to the packing order the box uses.
6208 * You must free this list with eina_list_free() once you are done with it.
6210 * @param obj The box object
6212 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6214 * Set the space (padding) between the box's elements.
6216 * Extra space in pixels that will be added between a box child and its
6217 * neighbors after its containing cell has been calculated. This padding
6218 * is set for all elements in the box, besides any possible padding that
6219 * individual elements may have through their size hints.
6221 * @param obj The box object
6222 * @param horizontal The horizontal space between elements
6223 * @param vertical The vertical space between elements
6225 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6227 * Get the space (padding) between the box's elements.
6229 * @param obj The box object
6230 * @param horizontal The horizontal space between elements
6231 * @param vertical The vertical space between elements
6233 * @see elm_box_padding_set()
6235 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6237 * Set the alignment of the whole bouding box of contents.
6239 * Sets how the bounding box containing all the elements of the box, after
6240 * their sizes and position has been calculated, will be aligned within
6241 * the space given for the whole box widget.
6243 * @param obj The box object
6244 * @param horizontal The horizontal alignment of elements
6245 * @param vertical The vertical alignment of elements
6247 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6249 * Get the alignment of the whole bouding box of contents.
6251 * @param obj The box object
6252 * @param horizontal The horizontal alignment of elements
6253 * @param vertical The vertical alignment of elements
6255 * @see elm_box_align_set()
6257 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6260 * Force the box to recalculate its children packing.
6262 * If any children was added or removed, box will not calculate the
6263 * values immediately rather leaving it to the next main loop
6264 * iteration. While this is great as it would save lots of
6265 * recalculation, whenever you need to get the position of a just
6266 * added item you must force recalculate before doing so.
6268 * @param obj The box object.
6270 EAPI void elm_box_recalculate(Evas_Object *obj);
6273 * Set the layout defining function to be used by the box
6275 * Whenever anything changes that requires the box in @p obj to recalculate
6276 * the size and position of its elements, the function @p cb will be called
6277 * to determine what the layout of the children will be.
6279 * Once a custom function is set, everything about the children layout
6280 * is defined by it. The flags set by elm_box_horizontal_set() and
6281 * elm_box_homogeneous_set() no longer have any meaning, and the values
6282 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6283 * layout function to decide if they are used and how. These last two
6284 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6285 * passed to @p cb. The @c Evas_Object the function receives is not the
6286 * Elementary widget, but the internal Evas Box it uses, so none of the
6287 * functions described here can be used on it.
6289 * Any of the layout functions in @c Evas can be used here, as well as the
6290 * special elm_box_layout_transition().
6292 * The final @p data argument received by @p cb is the same @p data passed
6293 * here, and the @p free_data function will be called to free it
6294 * whenever the box is destroyed or another layout function is set.
6296 * Setting @p cb to NULL will revert back to the default layout function.
6298 * @param obj The box object
6299 * @param cb The callback function used for layout
6300 * @param data Data that will be passed to layout function
6301 * @param free_data Function called to free @p data
6303 * @see elm_box_layout_transition()
6305 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);
6307 * Special layout function that animates the transition from one layout to another
6309 * Normally, when switching the layout function for a box, this will be
6310 * reflected immediately on screen on the next render, but it's also
6311 * possible to do this through an animated transition.
6313 * This is done by creating an ::Elm_Box_Transition and setting the box
6314 * layout to this function.
6318 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6319 * evas_object_box_layout_vertical, // start
6320 * NULL, // data for initial layout
6321 * NULL, // free function for initial data
6322 * evas_object_box_layout_horizontal, // end
6323 * NULL, // data for final layout
6324 * NULL, // free function for final data
6325 * anim_end, // will be called when animation ends
6326 * NULL); // data for anim_end function\
6327 * elm_box_layout_set(box, elm_box_layout_transition, t,
6328 * elm_box_transition_free);
6331 * @note This function can only be used with elm_box_layout_set(). Calling
6332 * it directly will not have the expected results.
6334 * @see elm_box_transition_new
6335 * @see elm_box_transition_free
6336 * @see elm_box_layout_set
6338 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6340 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6342 * If you want to animate the change from one layout to another, you need
6343 * to set the layout function of the box to elm_box_layout_transition(),
6344 * passing as user data to it an instance of ::Elm_Box_Transition with the
6345 * necessary information to perform this animation. The free function to
6346 * set for the layout is elm_box_transition_free().
6348 * The parameters to create an ::Elm_Box_Transition sum up to how long
6349 * will it be, in seconds, a layout function to describe the initial point,
6350 * another for the final position of the children and one function to be
6351 * called when the whole animation ends. This last function is useful to
6352 * set the definitive layout for the box, usually the same as the end
6353 * layout for the animation, but could be used to start another transition.
6355 * @param start_layout The layout function that will be used to start the animation
6356 * @param start_layout_data The data to be passed the @p start_layout function
6357 * @param start_layout_free_data Function to free @p start_layout_data
6358 * @param end_layout The layout function that will be used to end the animation
6359 * @param end_layout_free_data The data to be passed the @p end_layout function
6360 * @param end_layout_free_data Function to free @p end_layout_data
6361 * @param transition_end_cb Callback function called when animation ends
6362 * @param transition_end_data Data to be passed to @p transition_end_cb
6363 * @return An instance of ::Elm_Box_Transition
6365 * @see elm_box_transition_new
6366 * @see elm_box_layout_transition
6368 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);
6370 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6372 * This function is mostly useful as the @c free_data parameter in
6373 * elm_box_layout_set() when elm_box_layout_transition().
6375 * @param data The Elm_Box_Transition instance to be freed.
6377 * @see elm_box_transition_new
6378 * @see elm_box_layout_transition
6380 EAPI void elm_box_transition_free(void *data);
6387 * @defgroup Button Button
6389 * @image html img/widget/button/preview-00.png
6390 * @image latex img/widget/button/preview-00.eps
6391 * @image html img/widget/button/preview-01.png
6392 * @image latex img/widget/button/preview-01.eps
6393 * @image html img/widget/button/preview-02.png
6394 * @image latex img/widget/button/preview-02.eps
6396 * This is a push-button. Press it and run some function. It can contain
6397 * a simple label and icon object and it also has an autorepeat feature.
6399 * This widgets emits the following signals:
6400 * @li "clicked": the user clicked the button (press/release).
6401 * @li "repeated": the user pressed the button without releasing it.
6402 * @li "pressed": button was pressed.
6403 * @li "unpressed": button was released after being pressed.
6404 * In all three cases, the @c event parameter of the callback will be
6407 * Also, defined in the default theme, the button has the following styles
6409 * @li default: a normal button.
6410 * @li anchor: Like default, but the button fades away when the mouse is not
6411 * over it, leaving only the text or icon.
6412 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6413 * continuous look across its options.
6414 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6416 * Default contents parts of the button widget that you can use for are:
6417 * @li "icon" - A icon of the button
6419 * Default text parts of the button widget that you can use for are:
6420 * @li "default" - Label of the button
6422 * Follow through a complete example @ref button_example_01 "here".
6428 UIControlStateDefault,
6429 UIControlStateHighlighted,
6430 UIControlStateDisabled,
6431 UIControlStateFocused,
6432 UIControlStateReserved
6436 * Add a new button to the parent's canvas
6438 * @param parent The parent object
6439 * @return The new object or NULL if it cannot be created
6441 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6443 * Set the label used in the button
6445 * The passed @p label can be NULL to clean any existing text in it and
6446 * leave the button as an icon only object.
6448 * @param obj The button object
6449 * @param label The text will be written on the button
6450 * @deprecated use elm_object_text_set() instead.
6452 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6454 * Get the label set for the button
6456 * The string returned is an internal pointer and should not be freed or
6457 * altered. It will also become invalid when the button is destroyed.
6458 * The string returned, if not NULL, is a stringshare, so if you need to
6459 * keep it around even after the button is destroyed, you can use
6460 * eina_stringshare_ref().
6462 * @param obj The button object
6463 * @return The text set to the label, or NULL if nothing is set
6464 * @deprecated use elm_object_text_set() instead.
6466 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6468 * Set the label for each state of button
6470 * The passed @p label can be NULL to clean any existing text in it and
6471 * leave the button as an icon only object for the state.
6473 * @param obj The button object
6474 * @param label The text will be written on the button
6475 * @param state The state of button
6479 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6481 * Get the label of button for each state
6483 * The string returned is an internal pointer and should not be freed or
6484 * altered. It will also become invalid when the button is destroyed.
6485 * The string returned, if not NULL, is a stringshare, so if you need to
6486 * keep it around even after the button is destroyed, you can use
6487 * eina_stringshare_ref().
6489 * @param obj The button object
6490 * @param state The state of button
6491 * @return The title of button for state
6495 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6497 * Set the icon used for the button
6499 * Setting a new icon will delete any other that was previously set, making
6500 * any reference to them invalid. If you need to maintain the previous
6501 * object alive, unset it first with elm_button_icon_unset().
6503 * @param obj The button object
6504 * @param icon The icon object for the button
6505 * @deprecated use elm_object_part_content_set() instead.
6507 WILL_DEPRECATE EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6509 * Get the icon used for the button
6511 * Return the icon object which is set for this widget. If the button is
6512 * destroyed or another icon is set, the returned object will be deleted
6513 * and any reference to it will be invalid.
6515 * @param obj The button object
6516 * @return The icon object that is being used
6518 * @deprecated use elm_object_part_content_get() instead
6520 WILL_DEPRECATE EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6522 * Remove the icon set without deleting it and return the object
6524 * This function drops the reference the button holds of the icon object
6525 * and returns this last object. It is used in case you want to remove any
6526 * icon, or set another one, without deleting the actual object. The button
6527 * will be left without an icon set.
6529 * @param obj The button object
6530 * @return The icon object that was being used
6531 * @deprecated use elm_object_part_content_unset() instead.
6533 WILL_DEPRECATE EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6535 * Turn on/off the autorepeat event generated when the button is kept pressed
6537 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6538 * signal when they are clicked.
6540 * When on, keeping a button pressed will continuously emit a @c repeated
6541 * signal until the button is released. The time it takes until it starts
6542 * emitting the signal is given by
6543 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6544 * new emission by elm_button_autorepeat_gap_timeout_set().
6546 * @param obj The button object
6547 * @param on A bool to turn on/off the event
6549 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6551 * Get whether the autorepeat feature is enabled
6553 * @param obj The button object
6554 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6556 * @see elm_button_autorepeat_set()
6558 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6560 * Set the initial timeout before the autorepeat event is generated
6562 * Sets the timeout, in seconds, since the button is pressed until the
6563 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6564 * won't be any delay and the even will be fired the moment the button is
6567 * @param obj The button object
6568 * @param t Timeout in seconds
6570 * @see elm_button_autorepeat_set()
6571 * @see elm_button_autorepeat_gap_timeout_set()
6573 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6575 * Get the initial timeout before the autorepeat event is generated
6577 * @param obj The button object
6578 * @return Timeout in seconds
6580 * @see elm_button_autorepeat_initial_timeout_set()
6582 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6584 * Set the interval between each generated autorepeat event
6586 * After the first @c repeated event is fired, all subsequent ones will
6587 * follow after a delay of @p t seconds for each.
6589 * @param obj The button object
6590 * @param t Interval in seconds
6592 * @see elm_button_autorepeat_initial_timeout_set()
6594 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6596 * Get the interval between each generated autorepeat event
6598 * @param obj The button object
6599 * @return Interval in seconds
6601 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6607 * @defgroup File_Selector_Button File Selector Button
6609 * @image html img/widget/fileselector_button/preview-00.png
6610 * @image latex img/widget/fileselector_button/preview-00.eps
6611 * @image html img/widget/fileselector_button/preview-01.png
6612 * @image latex img/widget/fileselector_button/preview-01.eps
6613 * @image html img/widget/fileselector_button/preview-02.png
6614 * @image latex img/widget/fileselector_button/preview-02.eps
6616 * This is a button that, when clicked, creates an Elementary
6617 * window (or inner window) <b> with a @ref Fileselector "file
6618 * selector widget" within</b>. When a file is chosen, the (inner)
6619 * window is closed and the button emits a signal having the
6620 * selected file as it's @c event_info.
6622 * This widget encapsulates operations on its internal file
6623 * selector on its own API. There is less control over its file
6624 * selector than that one would have instatiating one directly.
6626 * The following styles are available for this button:
6629 * @li @c "hoversel_vertical"
6630 * @li @c "hoversel_vertical_entry"
6632 * Smart callbacks one can register to:
6633 * - @c "file,chosen" - the user has selected a path, whose string
6634 * pointer comes as the @c event_info data (a stringshared
6637 * Here is an example on its usage:
6638 * @li @ref fileselector_button_example
6640 * @see @ref File_Selector_Entry for a similar widget.
6645 * Add a new file selector button widget to the given parent
6646 * Elementary (container) object
6648 * @param parent The parent object
6649 * @return a new file selector button widget handle or @c NULL, on
6652 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6655 * Set the label for a given file selector button widget
6657 * @param obj The file selector button widget
6658 * @param label The text label to be displayed on @p obj
6660 * @deprecated use elm_object_text_set() instead.
6662 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6665 * Get the label set for a given file selector button widget
6667 * @param obj The file selector button widget
6668 * @return The button label
6670 * @deprecated use elm_object_text_set() instead.
6672 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6675 * Set the icon on a given file selector button widget
6677 * @param obj The file selector button widget
6678 * @param icon The icon object for the button
6680 * Once the icon object is set, a previously set one will be
6681 * deleted. If you want to keep the latter, use the
6682 * elm_fileselector_button_icon_unset() function.
6684 * @see elm_fileselector_button_icon_get()
6686 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6689 * Get the icon set for a given file selector button widget
6691 * @param obj The file selector button widget
6692 * @return The icon object currently set on @p obj or @c NULL, if
6695 * @see elm_fileselector_button_icon_set()
6697 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6700 * Unset the icon used in a given file selector button widget
6702 * @param obj The file selector button widget
6703 * @return The icon object that was being used on @p obj or @c
6706 * Unparent and return the icon object which was set for this
6709 * @see elm_fileselector_button_icon_set()
6711 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6714 * Set the title for a given file selector button widget's window
6716 * @param obj The file selector button widget
6717 * @param title The title string
6719 * This will change the window's title, when the file selector pops
6720 * out after a click on the button. Those windows have the default
6721 * (unlocalized) value of @c "Select a file" as titles.
6723 * @note It will only take any effect if the file selector
6724 * button widget is @b not under "inwin mode".
6726 * @see elm_fileselector_button_window_title_get()
6728 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6731 * Get the title set for a given file selector button widget's
6734 * @param obj The file selector button widget
6735 * @return Title of the file selector button's window
6737 * @see elm_fileselector_button_window_title_get() for more details
6739 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6742 * Set the size of a given file selector button widget's window,
6743 * holding the file selector itself.
6745 * @param obj The file selector button widget
6746 * @param width The window's width
6747 * @param height The window's height
6749 * @note it will only take any effect if the file selector button
6750 * widget is @b not under "inwin mode". The default size for the
6751 * window (when applicable) is 400x400 pixels.
6753 * @see elm_fileselector_button_window_size_get()
6755 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6758 * Get the size of a given file selector button widget's window,
6759 * holding the file selector itself.
6761 * @param obj The file selector button widget
6762 * @param width Pointer into which to store the width value
6763 * @param height Pointer into which to store the height value
6765 * @note Use @c NULL pointers on the size values you're not
6766 * interested in: they'll be ignored by the function.
6768 * @see elm_fileselector_button_window_size_set(), for more details
6770 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6773 * Set the initial file system path for a given file selector
6776 * @param obj The file selector button widget
6777 * @param path The path string
6779 * It must be a <b>directory</b> path, which will have the contents
6780 * displayed initially in the file selector's view, when invoked
6781 * from @p obj. The default initial path is the @c "HOME"
6782 * environment variable's value.
6784 * @see elm_fileselector_button_path_get()
6786 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6789 * Get the initial file system path set for a given file selector
6792 * @param obj The file selector button widget
6793 * @return path The path string
6795 * @see elm_fileselector_button_path_set() for more details
6797 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6800 * Enable/disable a tree view in the given file selector button
6801 * widget's internal file selector
6803 * @param obj The file selector button widget
6804 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6807 * This has the same effect as elm_fileselector_expandable_set(),
6808 * but now applied to a file selector button's internal file
6811 * @note There's no way to put a file selector button's internal
6812 * file selector in "grid mode", as one may do with "pure" file
6815 * @see elm_fileselector_expandable_get()
6817 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6820 * Get whether tree view is enabled for the given file selector
6821 * button widget's internal file selector
6823 * @param obj The file selector button widget
6824 * @return @c EINA_TRUE if @p obj widget's internal file selector
6825 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6827 * @see elm_fileselector_expandable_set() for more details
6829 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6832 * Set whether a given file selector button widget's internal file
6833 * selector is to display folders only or the directory contents,
6836 * @param obj The file selector button widget
6837 * @param only @c EINA_TRUE to make @p obj widget's internal file
6838 * selector only display directories, @c EINA_FALSE to make files
6839 * to be displayed in it too
6841 * This has the same effect as elm_fileselector_folder_only_set(),
6842 * but now applied to a file selector button's internal file
6845 * @see elm_fileselector_folder_only_get()
6847 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6850 * Get whether a given file selector button widget's internal file
6851 * selector is displaying folders only or the directory contents,
6854 * @param obj The file selector button widget
6855 * @return @c EINA_TRUE if @p obj widget's internal file
6856 * selector is only displaying directories, @c EINA_FALSE if files
6857 * are being displayed in it too (and on errors)
6859 * @see elm_fileselector_button_folder_only_set() for more details
6861 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6864 * Enable/disable the file name entry box where the user can type
6865 * in a name for a file, in a given file selector button widget's
6866 * internal file selector.
6868 * @param obj The file selector button widget
6869 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6870 * file selector a "saving dialog", @c EINA_FALSE otherwise
6872 * This has the same effect as elm_fileselector_is_save_set(),
6873 * but now applied to a file selector button's internal file
6876 * @see elm_fileselector_is_save_get()
6878 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6881 * Get whether the given file selector button widget's internal
6882 * file selector is in "saving dialog" mode
6884 * @param obj The file selector button widget
6885 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6886 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6889 * @see elm_fileselector_button_is_save_set() for more details
6891 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6894 * Set whether a given file selector button widget's internal file
6895 * selector will raise an Elementary "inner window", instead of a
6896 * dedicated Elementary window. By default, it won't.
6898 * @param obj The file selector button widget
6899 * @param value @c EINA_TRUE to make it use an inner window, @c
6900 * EINA_TRUE to make it use a dedicated window
6902 * @see elm_win_inwin_add() for more information on inner windows
6903 * @see elm_fileselector_button_inwin_mode_get()
6905 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6908 * Get whether a given file selector button widget's internal file
6909 * selector will raise an Elementary "inner window", instead of a
6910 * dedicated Elementary window.
6912 * @param obj The file selector button widget
6913 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6914 * if it will use a dedicated window
6916 * @see elm_fileselector_button_inwin_mode_set() for more details
6918 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6925 * @defgroup File_Selector_Entry File Selector Entry
6927 * @image html img/widget/fileselector_entry/preview-00.png
6928 * @image latex img/widget/fileselector_entry/preview-00.eps
6930 * This is an entry made to be filled with or display a <b>file
6931 * system path string</b>. Besides the entry itself, the widget has
6932 * a @ref File_Selector_Button "file selector button" on its side,
6933 * which will raise an internal @ref Fileselector "file selector widget",
6934 * when clicked, for path selection aided by file system
6937 * This file selector may appear in an Elementary window or in an
6938 * inner window. When a file is chosen from it, the (inner) window
6939 * is closed and the selected file's path string is exposed both as
6940 * an smart event and as the new text on the entry.
6942 * This widget encapsulates operations on its internal file
6943 * selector on its own API. There is less control over its file
6944 * selector than that one would have instatiating one directly.
6946 * Smart callbacks one can register to:
6947 * - @c "changed" - The text within the entry was changed
6948 * - @c "activated" - The entry has had editing finished and
6949 * changes are to be "committed"
6950 * - @c "press" - The entry has been clicked
6951 * - @c "longpressed" - The entry has been clicked (and held) for a
6953 * - @c "clicked" - The entry has been clicked
6954 * - @c "clicked,double" - The entry has been double clicked
6955 * - @c "focused" - The entry has received focus
6956 * - @c "unfocused" - The entry has lost focus
6957 * - @c "selection,paste" - A paste action has occurred on the
6959 * - @c "selection,copy" - A copy action has occurred on the entry
6960 * - @c "selection,cut" - A cut action has occurred on the entry
6961 * - @c "unpressed" - The file selector entry's button was released
6962 * after being pressed.
6963 * - @c "file,chosen" - The user has selected a path via the file
6964 * selector entry's internal file selector, whose string pointer
6965 * comes as the @c event_info data (a stringshared string)
6967 * Here is an example on its usage:
6968 * @li @ref fileselector_entry_example
6970 * @see @ref File_Selector_Button for a similar widget.
6975 * Add a new file selector entry widget to the given parent
6976 * Elementary (container) object
6978 * @param parent The parent object
6979 * @return a new file selector entry widget handle or @c NULL, on
6982 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6985 * Set the label for a given file selector entry widget's button
6987 * @param obj The file selector entry widget
6988 * @param label The text label to be displayed on @p obj widget's
6991 * @deprecated use elm_object_text_set() instead.
6993 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6996 * Get the label set for a given file selector entry widget's button
6998 * @param obj The file selector entry widget
6999 * @return The widget button's label
7001 * @deprecated use elm_object_text_set() instead.
7003 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7006 * Set the icon on a given file selector entry widget's button
7008 * @param obj The file selector entry widget
7009 * @param icon The icon object for the entry's button
7011 * Once the icon object is set, a previously set one will be
7012 * deleted. If you want to keep the latter, use the
7013 * elm_fileselector_entry_button_icon_unset() function.
7015 * @see elm_fileselector_entry_button_icon_get()
7017 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7020 * Get the icon set for a given file selector entry widget's button
7022 * @param obj The file selector entry widget
7023 * @return The icon object currently set on @p obj widget's button
7024 * or @c NULL, if none is
7026 * @see elm_fileselector_entry_button_icon_set()
7028 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7031 * Unset the icon used in a given file selector entry widget's
7034 * @param obj The file selector entry widget
7035 * @return The icon object that was being used on @p obj widget's
7036 * button or @c NULL, on errors
7038 * Unparent and return the icon object which was set for this
7041 * @see elm_fileselector_entry_button_icon_set()
7043 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7046 * Set the title for a given file selector entry widget's window
7048 * @param obj The file selector entry widget
7049 * @param title The title string
7051 * This will change the window's title, when the file selector pops
7052 * out after a click on the entry's button. Those windows have the
7053 * default (unlocalized) value of @c "Select a file" as titles.
7055 * @note It will only take any effect if the file selector
7056 * entry widget is @b not under "inwin mode".
7058 * @see elm_fileselector_entry_window_title_get()
7060 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7063 * Get the title set for a given file selector entry widget's
7066 * @param obj The file selector entry widget
7067 * @return Title of the file selector entry's window
7069 * @see elm_fileselector_entry_window_title_get() for more details
7071 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7074 * Set the size of a given file selector entry widget's window,
7075 * holding the file selector itself.
7077 * @param obj The file selector entry widget
7078 * @param width The window's width
7079 * @param height The window's height
7081 * @note it will only take any effect if the file selector entry
7082 * widget is @b not under "inwin mode". The default size for the
7083 * window (when applicable) is 400x400 pixels.
7085 * @see elm_fileselector_entry_window_size_get()
7087 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7090 * Get the size of a given file selector entry widget's window,
7091 * holding the file selector itself.
7093 * @param obj The file selector entry widget
7094 * @param width Pointer into which to store the width value
7095 * @param height Pointer into which to store the height value
7097 * @note Use @c NULL pointers on the size values you're not
7098 * interested in: they'll be ignored by the function.
7100 * @see elm_fileselector_entry_window_size_set(), for more details
7102 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7105 * Set the initial file system path and the entry's path string for
7106 * a given file selector entry widget
7108 * @param obj The file selector entry widget
7109 * @param path The path string
7111 * It must be a <b>directory</b> path, which will have the contents
7112 * displayed initially in the file selector's view, when invoked
7113 * from @p obj. The default initial path is the @c "HOME"
7114 * environment variable's value.
7116 * @see elm_fileselector_entry_path_get()
7118 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7121 * Get the entry's path string for a given file selector entry
7124 * @param obj The file selector entry widget
7125 * @return path The path string
7127 * @see elm_fileselector_entry_path_set() for more details
7129 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7132 * Enable/disable a tree view in the given file selector entry
7133 * widget's internal file selector
7135 * @param obj The file selector entry widget
7136 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7139 * This has the same effect as elm_fileselector_expandable_set(),
7140 * but now applied to a file selector entry's internal file
7143 * @note There's no way to put a file selector entry's internal
7144 * file selector in "grid mode", as one may do with "pure" file
7147 * @see elm_fileselector_expandable_get()
7149 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7152 * Get whether tree view is enabled for the given file selector
7153 * entry widget's internal file selector
7155 * @param obj The file selector entry widget
7156 * @return @c EINA_TRUE if @p obj widget's internal file selector
7157 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7159 * @see elm_fileselector_expandable_set() for more details
7161 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7164 * Set whether a given file selector entry widget's internal file
7165 * selector is to display folders only or the directory contents,
7168 * @param obj The file selector entry widget
7169 * @param only @c EINA_TRUE to make @p obj widget's internal file
7170 * selector only display directories, @c EINA_FALSE to make files
7171 * to be displayed in it too
7173 * This has the same effect as elm_fileselector_folder_only_set(),
7174 * but now applied to a file selector entry's internal file
7177 * @see elm_fileselector_folder_only_get()
7179 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7182 * Get whether a given file selector entry widget's internal file
7183 * selector is displaying folders only or the directory contents,
7186 * @param obj The file selector entry widget
7187 * @return @c EINA_TRUE if @p obj widget's internal file
7188 * selector is only displaying directories, @c EINA_FALSE if files
7189 * are being displayed in it too (and on errors)
7191 * @see elm_fileselector_entry_folder_only_set() for more details
7193 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7196 * Enable/disable the file name entry box where the user can type
7197 * in a name for a file, in a given file selector entry widget's
7198 * internal file selector.
7200 * @param obj The file selector entry widget
7201 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7202 * file selector a "saving dialog", @c EINA_FALSE otherwise
7204 * This has the same effect as elm_fileselector_is_save_set(),
7205 * but now applied to a file selector entry's internal file
7208 * @see elm_fileselector_is_save_get()
7210 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7213 * Get whether the given file selector entry widget's internal
7214 * file selector is in "saving dialog" mode
7216 * @param obj The file selector entry widget
7217 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7218 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7221 * @see elm_fileselector_entry_is_save_set() for more details
7223 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7226 * Set whether a given file selector entry widget's internal file
7227 * selector will raise an Elementary "inner window", instead of a
7228 * dedicated Elementary window. By default, it won't.
7230 * @param obj The file selector entry widget
7231 * @param value @c EINA_TRUE to make it use an inner window, @c
7232 * EINA_TRUE to make it use a dedicated window
7234 * @see elm_win_inwin_add() for more information on inner windows
7235 * @see elm_fileselector_entry_inwin_mode_get()
7237 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7240 * Get whether a given file selector entry widget's internal file
7241 * selector will raise an Elementary "inner window", instead of a
7242 * dedicated Elementary window.
7244 * @param obj The file selector entry widget
7245 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7246 * if it will use a dedicated window
7248 * @see elm_fileselector_entry_inwin_mode_set() for more details
7250 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7253 * Set the initial file system path for a given file selector entry
7256 * @param obj The file selector entry widget
7257 * @param path The path string
7259 * It must be a <b>directory</b> path, which will have the contents
7260 * displayed initially in the file selector's view, when invoked
7261 * from @p obj. The default initial path is the @c "HOME"
7262 * environment variable's value.
7264 * @see elm_fileselector_entry_path_get()
7266 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7269 * Get the parent directory's path to the latest file selection on
7270 * a given filer selector entry widget
7272 * @param obj The file selector object
7273 * @return The (full) path of the directory of the last selection
7274 * on @p obj widget, a @b stringshared string
7276 * @see elm_fileselector_entry_path_set()
7278 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7285 * @defgroup Scroller Scroller
7287 * A scroller holds a single object and "scrolls it around". This means that
7288 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7289 * region around, allowing to move through a much larger object that is
7290 * contained in the scroller. The scroller will always have a small minimum
7291 * size by default as it won't be limited by the contents of the scroller.
7293 * Signals that you can add callbacks for are:
7294 * @li "edge,left" - the left edge of the content has been reached
7295 * @li "edge,right" - the right edge of the content has been reached
7296 * @li "edge,top" - the top edge of the content has been reached
7297 * @li "edge,bottom" - the bottom edge of the content has been reached
7298 * @li "scroll" - the content has been scrolled (moved)
7299 * @li "scroll,anim,start" - scrolling animation has started
7300 * @li "scroll,anim,stop" - scrolling animation has stopped
7301 * @li "scroll,drag,start" - dragging the contents around has started
7302 * @li "scroll,drag,stop" - dragging the contents around has stopped
7303 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7306 * @note When Elemementary is in embedded mode the scrollbars will not be
7307 * dragable, they appear merely as indicators of how much has been scrolled.
7308 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7309 * fingerscroll) won't work.
7311 * Default contents parts of the scroller widget that you can use for are:
7312 * @li "default" - A content of the scroller
7314 * In @ref tutorial_scroller you'll find an example of how to use most of
7319 * @brief Type that controls when scrollbars should appear.
7321 * @see elm_scroller_policy_set()
7323 typedef enum _Elm_Scroller_Policy
7325 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7326 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7327 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7328 ELM_SCROLLER_POLICY_LAST
7329 } Elm_Scroller_Policy;
7331 * @brief Add a new scroller to the parent
7333 * @param parent The parent object
7334 * @return The new object or NULL if it cannot be created
7336 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7338 * @brief Set the content of the scroller widget (the object to be scrolled around).
7340 * @param obj The scroller object
7341 * @param content The new content object
7343 * Once the content object is set, a previously set one will be deleted.
7344 * If you want to keep that old content object, use the
7345 * elm_scroller_content_unset() function.
7346 * @deprecated use elm_object_content_set() instead
7348 WILL_DEPRECATE EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7350 * @brief Get the content of the scroller widget
7352 * @param obj The slider object
7353 * @return The content that is being used
7355 * Return the content object which is set for this widget
7357 * @see elm_scroller_content_set()
7358 * @deprecated use elm_object_content_get() instead.
7360 WILL_DEPRECATE EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7362 * @brief Unset the content of the scroller widget
7364 * @param obj The slider object
7365 * @return The content that was being used
7367 * Unparent and return the content object which was set for this widget
7369 * @see elm_scroller_content_set()
7370 * @deprecated use elm_object_content_unset() instead.
7372 WILL_DEPRECATE EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7374 * @brief Set custom theme elements for the scroller
7376 * @param obj The scroller object
7377 * @param widget The widget name to use (default is "scroller")
7378 * @param base The base name to use (default is "base")
7380 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7382 * @brief Make the scroller minimum size limited to the minimum size of the content
7384 * @param obj The scroller object
7385 * @param w Enable limiting minimum size horizontally
7386 * @param h Enable limiting minimum size vertically
7388 * By default the scroller will be as small as its design allows,
7389 * irrespective of its content. This will make the scroller minimum size the
7390 * right size horizontally and/or vertically to perfectly fit its content in
7393 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7395 * @brief Show a specific virtual region within the scroller content object
7397 * @param obj The scroller object
7398 * @param x X coordinate of the region
7399 * @param y Y coordinate of the region
7400 * @param w Width of the region
7401 * @param h Height of the region
7403 * This will ensure all (or part if it does not fit) of the designated
7404 * region in the virtual content object (0, 0 starting at the top-left of the
7405 * virtual content object) is shown within the scroller.
7407 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);
7409 * @brief Set the scrollbar visibility policy
7411 * @param obj The scroller object
7412 * @param policy_h Horizontal scrollbar policy
7413 * @param policy_v Vertical scrollbar policy
7415 * This sets the scrollbar visibility policy for the given scroller.
7416 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7417 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7418 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7419 * respectively for the horizontal and vertical scrollbars.
7421 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7423 * @brief Gets scrollbar visibility policy
7425 * @param obj The scroller object
7426 * @param policy_h Horizontal scrollbar policy
7427 * @param policy_v Vertical scrollbar policy
7429 * @see elm_scroller_policy_set()
7431 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7433 * @brief Get the currently visible content region
7435 * @param obj The scroller object
7436 * @param x X coordinate of the region
7437 * @param y Y coordinate of the region
7438 * @param w Width of the region
7439 * @param h Height of the region
7441 * This gets the current region in the content object that is visible through
7442 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7443 * w, @p h values pointed to.
7445 * @note All coordinates are relative to the content.
7447 * @see elm_scroller_region_show()
7449 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);
7451 * @brief Get the size of the content object
7453 * @param obj The scroller object
7454 * @param w Width of the content object.
7455 * @param h Height of the content object.
7457 * This gets the size of the content object of the scroller.
7459 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7461 * @brief Set bouncing behavior
7463 * @param obj The scroller object
7464 * @param h_bounce Allow bounce horizontally
7465 * @param v_bounce Allow bounce vertically
7467 * When scrolling, the scroller may "bounce" when reaching an edge of the
7468 * content object. This is a visual way to indicate the end has been reached.
7469 * This is enabled by default for both axis. This API will set if it is enabled
7470 * for the given axis with the boolean parameters for each axis.
7472 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7474 * @brief Get the bounce behaviour
7476 * @param obj The Scroller object
7477 * @param h_bounce Will the scroller bounce horizontally or not
7478 * @param v_bounce Will the scroller bounce vertically or not
7480 * @see elm_scroller_bounce_set()
7482 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7484 * @brief Set scroll page size relative to viewport size.
7486 * @param obj The scroller object
7487 * @param h_pagerel The horizontal page relative size
7488 * @param v_pagerel The vertical page relative size
7490 * The scroller is capable of limiting scrolling by the user to "pages". That
7491 * is to jump by and only show a "whole page" at a time as if the continuous
7492 * area of the scroller content is split into page sized pieces. This sets
7493 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7494 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7495 * axis. This is mutually exclusive with page size
7496 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7497 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7498 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7501 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7503 * @brief Set scroll page size.
7505 * @param obj The scroller object
7506 * @param h_pagesize The horizontal page size
7507 * @param v_pagesize The vertical page size
7509 * This sets the page size to an absolute fixed value, with 0 turning it off
7512 * @see elm_scroller_page_relative_set()
7514 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7516 * @brief Get scroll current page number.
7518 * @param obj The scroller object
7519 * @param h_pagenumber The horizontal page number
7520 * @param v_pagenumber The vertical page number
7522 * The page number starts from 0. 0 is the first page.
7523 * Current page means the page which meets the top-left of the viewport.
7524 * If there are two or more pages in the viewport, it returns the number of the page
7525 * which meets the top-left of the viewport.
7527 * @see elm_scroller_last_page_get()
7528 * @see elm_scroller_page_show()
7529 * @see elm_scroller_page_brint_in()
7531 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7533 * @brief Get scroll last page number.
7535 * @param obj The scroller object
7536 * @param h_pagenumber The horizontal page number
7537 * @param v_pagenumber The vertical page number
7539 * The page number starts from 0. 0 is the first page.
7540 * This returns the last page number among the pages.
7542 * @see elm_scroller_current_page_get()
7543 * @see elm_scroller_page_show()
7544 * @see elm_scroller_page_brint_in()
7546 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7548 * Show a specific virtual region within the scroller content object by page number.
7550 * @param obj The scroller object
7551 * @param h_pagenumber The horizontal page number
7552 * @param v_pagenumber The vertical page number
7554 * 0, 0 of the indicated page is located at the top-left of the viewport.
7555 * This will jump to the page directly without animation.
7560 * sc = elm_scroller_add(win);
7561 * elm_scroller_content_set(sc, content);
7562 * elm_scroller_page_relative_set(sc, 1, 0);
7563 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7564 * elm_scroller_page_show(sc, h_page + 1, v_page);
7567 * @see elm_scroller_page_bring_in()
7569 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7571 * Show a specific virtual region within the scroller content object by page number.
7573 * @param obj The scroller object
7574 * @param h_pagenumber The horizontal page number
7575 * @param v_pagenumber The vertical page number
7577 * 0, 0 of the indicated page is located at the top-left of the viewport.
7578 * This will slide to the page with animation.
7583 * sc = elm_scroller_add(win);
7584 * elm_scroller_content_set(sc, content);
7585 * elm_scroller_page_relative_set(sc, 1, 0);
7586 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7587 * elm_scroller_page_bring_in(sc, h_page, v_page);
7590 * @see elm_scroller_page_show()
7592 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7594 * @brief Show a specific virtual region within the scroller content object.
7596 * @param obj The scroller object
7597 * @param x X coordinate of the region
7598 * @param y Y coordinate of the region
7599 * @param w Width of the region
7600 * @param h Height of the region
7602 * This will ensure all (or part if it does not fit) of the designated
7603 * region in the virtual content object (0, 0 starting at the top-left of the
7604 * virtual content object) is shown within the scroller. Unlike
7605 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7606 * to this location (if configuration in general calls for transitions). It
7607 * may not jump immediately to the new location and make take a while and
7608 * show other content along the way.
7610 * @see elm_scroller_region_show()
7612 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);
7614 * @brief Set event propagation on a scroller
7616 * @param obj The scroller object
7617 * @param propagation If propagation is enabled or not
7619 * This enables or disabled event propagation from the scroller content to
7620 * the scroller and its parent. By default event propagation is disabled.
7622 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7624 * @brief Get event propagation for a scroller
7626 * @param obj The scroller object
7627 * @return The propagation state
7629 * This gets the event propagation for a scroller.
7631 * @see elm_scroller_propagate_events_set()
7633 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7635 * @brief Set scrolling gravity on a scroller
7637 * @param obj The scroller object
7638 * @param x The scrolling horizontal gravity
7639 * @param y The scrolling vertical gravity
7641 * The gravity, defines how the scroller will adjust its view
7642 * when the size of the scroller contents increase.
7644 * The scroller will adjust the view to glue itself as follows.
7646 * x=0.0, for showing the left most region of the content.
7647 * x=1.0, for showing the right most region of the content.
7648 * y=0.0, for showing the bottom most region of the content.
7649 * y=1.0, for showing the top most region of the content.
7651 * Default values for x and y are 0.0
7653 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7655 * @brief Get scrolling gravity values for a scroller
7657 * @param obj The scroller object
7658 * @param x The scrolling horizontal gravity
7659 * @param y The scrolling vertical gravity
7661 * This gets gravity values for a scroller.
7663 * @see elm_scroller_gravity_set()
7666 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7672 * @defgroup Label Label
7674 * @image html img/widget/label/preview-00.png
7675 * @image latex img/widget/label/preview-00.eps
7677 * @brief Widget to display text, with simple html-like markup.
7679 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7680 * text doesn't fit the geometry of the label it will be ellipsized or be
7681 * cut. Elementary provides several styles for this widget:
7682 * @li default - No animation
7683 * @li marker - Centers the text in the label and make it bold by default
7684 * @li slide_long - The entire text appears from the right of the screen and
7685 * slides until it disappears in the left of the screen(reappering on the
7687 * @li slide_short - The text appears in the left of the label and slides to
7688 * the right to show the overflow. When all of the text has been shown the
7689 * position is reset.
7690 * @li slide_bounce - The text appears in the left of the label and slides to
7691 * the right to show the overflow. When all of the text has been shown the
7692 * animation reverses, moving the text to the left.
7694 * Custom themes can of course invent new markup tags and style them any way
7697 * The following signals may be emitted by the label widget:
7698 * @li "language,changed": The program's language changed.
7700 * See @ref tutorial_label for a demonstration of how to use a label widget.
7704 * @brief Add a new label to the parent
7706 * @param parent The parent object
7707 * @return The new object or NULL if it cannot be created
7709 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7711 * @brief Set the label on the label object
7713 * @param obj The label object
7714 * @param label The label will be used on the label object
7715 * @deprecated See elm_object_text_set()
7717 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 */
7719 * @brief Get the label used on the label object
7721 * @param obj The label object
7722 * @return The string inside the label
7723 * @deprecated See elm_object_text_get()
7725 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7727 * @brief Set the wrapping behavior of the label
7729 * @param obj The label object
7730 * @param wrap To wrap text or not
7732 * By default no wrapping is done. Possible values for @p wrap are:
7733 * @li ELM_WRAP_NONE - No wrapping
7734 * @li ELM_WRAP_CHAR - wrap between characters
7735 * @li ELM_WRAP_WORD - wrap between words
7736 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7738 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7740 * @brief Get the wrapping behavior of the label
7742 * @param obj The label object
7745 * @see elm_label_line_wrap_set()
7747 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7749 * @brief Set wrap width of the label
7751 * @param obj The label object
7752 * @param w The wrap width in pixels at a minimum where words need to wrap
7754 * This function sets the maximum width size hint of the label.
7756 * @warning This is only relevant if the label is inside a container.
7758 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7760 * @brief Get wrap width of the label
7762 * @param obj The label object
7763 * @return The wrap width in pixels at a minimum where words need to wrap
7765 * @see elm_label_wrap_width_set()
7767 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7769 * @brief Set wrap height of the label
7771 * @param obj The label object
7772 * @param h The wrap height in pixels at a minimum where words need to wrap
7774 * This function sets the maximum height size hint of the label.
7776 * @warning This is only relevant if the label is inside a container.
7778 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7780 * @brief get wrap width of the label
7782 * @param obj The label object
7783 * @return The wrap height in pixels at a minimum where words need to wrap
7785 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7787 * @brief Set the font size on the label object.
7789 * @param obj The label object
7790 * @param size font size
7792 * @warning NEVER use this. It is for hyper-special cases only. use styles
7793 * instead. e.g. "default", "marker", "slide_long" etc.
7795 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7797 * @brief Set the text color on the label object
7799 * @param obj The label object
7800 * @param r Red property background color of The label object
7801 * @param g Green property background color of The label object
7802 * @param b Blue property background color of The label object
7803 * @param a Alpha property background color of The label object
7805 * @warning NEVER use this. It is for hyper-special cases only. use styles
7806 * instead. e.g. "default", "marker", "slide_long" etc.
7808 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);
7810 * @brief Set the text align on the label object
7812 * @param obj The label object
7813 * @param align align mode ("left", "center", "right")
7815 * @warning NEVER use this. It is for hyper-special cases only. use styles
7816 * instead. e.g. "default", "marker", "slide_long" etc.
7818 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7820 * @brief Set background color of the label
7822 * @param obj The label object
7823 * @param r Red property background color of The label object
7824 * @param g Green property background color of The label object
7825 * @param b Blue property background color of The label object
7826 * @param a Alpha property background alpha of The label object
7828 * @warning NEVER use this. It is for hyper-special cases only. use styles
7829 * instead. e.g. "default", "marker", "slide_long" etc.
7831 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);
7833 * @brief Set the ellipsis behavior of the label
7835 * @param obj The label object
7836 * @param ellipsis To ellipsis text or not
7838 * If set to true and the text doesn't fit in the label an ellipsis("...")
7839 * will be shown at the end of the widget.
7841 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7842 * choosen wrap method was ELM_WRAP_WORD.
7844 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7845 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7847 * @brief Set the text slide of the label
7849 * @param obj The label object
7850 * @param slide To start slide or stop
7852 * If set to true, the text of the label will slide/scroll through the length of
7855 * @warning This only works with the themes "slide_short", "slide_long" and
7858 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7860 * @brief Get the text slide mode of the label
7862 * @param obj The label object
7863 * @return slide slide mode value
7865 * @see elm_label_slide_set()
7867 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7869 * @brief Set the slide duration(speed) of the label
7871 * @param obj The label object
7872 * @return The duration in seconds in moving text from slide begin position
7873 * to slide end position
7875 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7877 * @brief Get the slide duration(speed) of the label
7879 * @param obj The label object
7880 * @return The duration time in moving text from slide begin position to slide end position
7882 * @see elm_label_slide_duration_set()
7884 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7890 * @defgroup Frame Frame
7892 * @image html img/widget/frame/preview-00.png
7893 * @image latex img/widget/frame/preview-00.eps
7895 * @brief Frame is a widget that holds some content and has a title.
7897 * The default look is a frame with a title, but Frame supports multple
7905 * @li outdent_bottom
7907 * Of all this styles only default shows the title. Frame emits no signals.
7909 * Default contents parts of the frame widget that you can use for are:
7910 * @li "default" - A content of the frame
7912 * Default text parts of the frame widget that you can use for are:
7913 * @li "elm.text" - Label of the frame
7915 * For a detailed example see the @ref tutorial_frame.
7920 * @brief Add a new frame to the parent
7922 * @param parent The parent object
7923 * @return The new object or NULL if it cannot be created
7925 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7927 * @brief Set the frame label
7929 * @param obj The frame object
7930 * @param label The label of this frame object
7932 * @deprecated use elm_object_text_set() instead.
7934 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7936 * @brief Get the frame label
7938 * @param obj The frame object
7940 * @return The label of this frame objet or NULL if unable to get frame
7942 * @deprecated use elm_object_text_get() instead.
7944 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7946 * @brief Set the content of the frame widget
7948 * Once the content object is set, a previously set one will be deleted.
7949 * If you want to keep that old content object, use the
7950 * elm_frame_content_unset() function.
7952 * @param obj The frame object
7953 * @param content The content will be filled in this frame object
7955 * @deprecated use elm_object_content_set() instead.
7957 WILL_DEPRECATE EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7959 * @brief Get the content of the frame widget
7961 * Return the content object which is set for this widget
7963 * @param obj The frame object
7964 * @return The content that is being used
7966 * @deprecated use elm_object_content_get() instead.
7968 WILL_DEPRECATE EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7970 * @brief Unset the content of the frame widget
7972 * Unparent and return the content object which was set for this widget
7974 * @param obj The frame object
7975 * @return The content that was being used
7977 * @deprecated use elm_object_content_unset() instead.
7979 WILL_DEPRECATE EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7985 * @defgroup Table Table
7987 * A container widget to arrange other widgets in a table where items can
7988 * also span multiple columns or rows - even overlap (and then be raised or
7989 * lowered accordingly to adjust stacking if they do overlap).
7991 * For a Table widget the row/column count is not fixed.
7992 * The table widget adjusts itself when subobjects are added to it dynamically.
7994 * The followin are examples of how to use a table:
7995 * @li @ref tutorial_table_01
7996 * @li @ref tutorial_table_02
8001 * @brief Add a new table to the parent
8003 * @param parent The parent object
8004 * @return The new object or NULL if it cannot be created
8006 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8008 * @brief Set the homogeneous layout in the table
8010 * @param obj The layout object
8011 * @param homogeneous A boolean to set if the layout is homogeneous in the
8012 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8014 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8016 * @brief Get the current table homogeneous mode.
8018 * @param obj The table object
8019 * @return A boolean to indicating if the layout is homogeneous in the table
8020 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8022 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8024 * @warning <b>Use elm_table_homogeneous_set() instead</b>
8026 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
8028 * @warning <b>Use elm_table_homogeneous_get() instead</b>
8030 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8032 * @brief Set padding between cells.
8034 * @param obj The layout object.
8035 * @param horizontal set the horizontal padding.
8036 * @param vertical set the vertical padding.
8038 * Default value is 0.
8040 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8042 * @brief Get padding between cells.
8044 * @param obj The layout object.
8045 * @param horizontal set the horizontal padding.
8046 * @param vertical set the vertical padding.
8048 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8050 * @brief Add a subobject on the table with the coordinates passed
8052 * @param obj The table object
8053 * @param subobj The subobject to be added to the table
8054 * @param x Row number
8055 * @param y Column number
8059 * @note All positioning inside the table is relative to rows and columns, so
8060 * a value of 0 for x and y, means the top left cell of the table, and a
8061 * value of 1 for w and h means @p subobj only takes that 1 cell.
8063 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8065 * @brief Remove child from table.
8067 * @param obj The table object
8068 * @param subobj The subobject
8070 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8072 * @brief Faster way to remove all child objects from a table object.
8074 * @param obj The table object
8075 * @param clear If true, will delete children, else just remove from table.
8077 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8079 * @brief Set the packing location of an existing child of the table
8081 * @param subobj The subobject to be modified in the table
8082 * @param x Row number
8083 * @param y Column number
8087 * Modifies the position of an object already in the table.
8089 * @note All positioning inside the table is relative to rows and columns, so
8090 * a value of 0 for x and y, means the top left cell of the table, and a
8091 * value of 1 for w and h means @p subobj only takes that 1 cell.
8093 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8095 * @brief Get the packing location of an existing child of the table
8097 * @param subobj The subobject to be modified in the table
8098 * @param x Row number
8099 * @param y Column number
8103 * @see elm_table_pack_set()
8105 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8111 * @defgroup Gengrid Gengrid (Generic grid)
8113 * This widget aims to position objects in a grid layout while
8114 * actually creating and rendering only the visible ones, using the
8115 * same idea as the @ref Genlist "genlist": the user defines a @b
8116 * class for each item, specifying functions that will be called at
8117 * object creation, deletion, etc. When those items are selected by
8118 * the user, a callback function is issued. Users may interact with
8119 * a gengrid via the mouse (by clicking on items to select them and
8120 * clicking on the grid's viewport and swiping to pan the whole
8121 * view) or via the keyboard, navigating through item with the
8124 * @section Gengrid_Layouts Gengrid layouts
8126 * Gengrid may layout its items in one of two possible layouts:
8130 * When in "horizontal mode", items will be placed in @b columns,
8131 * from top to bottom and, when the space for a column is filled,
8132 * another one is started on the right, thus expanding the grid
8133 * horizontally, making for horizontal scrolling. When in "vertical
8134 * mode" , though, items will be placed in @b rows, from left to
8135 * right and, when the space for a row is filled, another one is
8136 * started below, thus expanding the grid vertically (and making
8137 * for vertical scrolling).
8139 * @section Gengrid_Items Gengrid items
8141 * An item in a gengrid can have 0 or more text labels (they can be
8142 * regular text or textblock Evas objects - that's up to the style
8143 * to determine), 0 or more icons (which are simply objects
8144 * swallowed into the gengrid item's theming Edje object) and 0 or
8145 * more <b>boolean states</b>, which have the behavior left to the
8146 * user to define. The Edje part names for each of these properties
8147 * will be looked up, in the theme file for the gengrid, under the
8148 * Edje (string) data items named @c "labels", @c "icons" and @c
8149 * "states", respectively. For each of those properties, if more
8150 * than one part is provided, they must have names listed separated
8151 * by spaces in the data fields. For the default gengrid item
8152 * theme, we have @b one label part (@c "elm.text"), @b two icon
8153 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8156 * A gengrid item may be at one of several styles. Elementary
8157 * provides one by default - "default", but this can be extended by
8158 * system or application custom themes/overlays/extensions (see
8159 * @ref Theme "themes" for more details).
8161 * @section Gengrid_Item_Class Gengrid item classes
8163 * In order to have the ability to add and delete items on the fly,
8164 * gengrid implements a class (callback) system where the
8165 * application provides a structure with information about that
8166 * type of item (gengrid may contain multiple different items with
8167 * different classes, states and styles). Gengrid will call the
8168 * functions in this struct (methods) when an item is "realized"
8169 * (i.e., created dynamically, while the user is scrolling the
8170 * grid). All objects will simply be deleted when no longer needed
8171 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8172 * contains the following members:
8173 * - @c item_style - This is a constant string and simply defines
8174 * the name of the item style. It @b must be specified and the
8175 * default should be @c "default".
8176 * - @c func.label_get - This function is called when an item
8177 * object is actually created. The @c data parameter will point to
8178 * the same data passed to elm_gengrid_item_append() and related
8179 * item creation functions. The @c obj parameter is the gengrid
8180 * object itself, while the @c part one is the name string of one
8181 * of the existing text parts in the Edje group implementing the
8182 * item's theme. This function @b must return a strdup'()ed string,
8183 * as the caller will free() it when done. See
8184 * #Elm_Gengrid_Item_Label_Get_Cb.
8185 * - @c func.content_get - This function is called when an item object
8186 * is actually created. The @c data parameter will point to the
8187 * same data passed to elm_gengrid_item_append() and related item
8188 * creation functions. The @c obj parameter is the gengrid object
8189 * itself, while the @c part one is the name string of one of the
8190 * existing (content) swallow parts in the Edje group implementing the
8191 * item's theme. It must return @c NULL, when no content is desired,
8192 * or a valid object handle, otherwise. The object will be deleted
8193 * by the gengrid on its deletion or when the item is "unrealized".
8194 * See #Elm_Gengrid_Item_Content_Get_Cb.
8195 * - @c func.state_get - This function is called when an item
8196 * object is actually created. The @c data parameter will point to
8197 * the same data passed to elm_gengrid_item_append() and related
8198 * item creation functions. The @c obj parameter is the gengrid
8199 * object itself, while the @c part one is the name string of one
8200 * of the state parts in the Edje group implementing the item's
8201 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8202 * true/on. Gengrids will emit a signal to its theming Edje object
8203 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8204 * "source" arguments, respectively, when the state is true (the
8205 * default is false), where @c XXX is the name of the (state) part.
8206 * See #Elm_Gengrid_Item_State_Get_Cb.
8207 * - @c func.del - This is called when elm_gengrid_item_del() is
8208 * called on an item or elm_gengrid_clear() is called on the
8209 * gengrid. This is intended for use when gengrid items are
8210 * deleted, so any data attached to the item (e.g. its data
8211 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8213 * @section Gengrid_Usage_Hints Usage hints
8215 * If the user wants to have multiple items selected at the same
8216 * time, elm_gengrid_multi_select_set() will permit it. If the
8217 * gengrid is single-selection only (the default), then
8218 * elm_gengrid_select_item_get() will return the selected item or
8219 * @c NULL, if none is selected. If the gengrid is under
8220 * multi-selection, then elm_gengrid_selected_items_get() will
8221 * return a list (that is only valid as long as no items are
8222 * modified (added, deleted, selected or unselected) of child items
8225 * If an item changes (internal (boolean) state, label or content
8226 * changes), then use elm_gengrid_item_update() to have gengrid
8227 * update the item with the new state. A gengrid will re-"realize"
8228 * the item, thus calling the functions in the
8229 * #Elm_Gengrid_Item_Class set for that item.
8231 * To programmatically (un)select an item, use
8232 * elm_gengrid_item_selected_set(). To get its selected state use
8233 * elm_gengrid_item_selected_get(). To make an item disabled
8234 * (unable to be selected and appear differently) use
8235 * elm_gengrid_item_disabled_set() to set this and
8236 * elm_gengrid_item_disabled_get() to get the disabled state.
8238 * Grid cells will only have their selection smart callbacks called
8239 * when firstly getting selected. Any further clicks will do
8240 * nothing, unless you enable the "always select mode", with
8241 * elm_gengrid_always_select_mode_set(), thus making every click to
8242 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8243 * turn off the ability to select items entirely in the widget and
8244 * they will neither appear selected nor call the selection smart
8247 * Remember that you can create new styles and add your own theme
8248 * augmentation per application with elm_theme_extension_add(). If
8249 * you absolutely must have a specific style that overrides any
8250 * theme the user or system sets up you can use
8251 * elm_theme_overlay_add() to add such a file.
8253 * @section Gengrid_Smart_Events Gengrid smart events
8255 * Smart events that you can add callbacks for are:
8256 * - @c "activated" - The user has double-clicked or pressed
8257 * (enter|return|spacebar) on an item. The @c event_info parameter
8258 * is the gengrid item that was activated.
8259 * - @c "clicked,double" - The user has double-clicked an item.
8260 * The @c event_info parameter is the gengrid item that was double-clicked.
8261 * - @c "longpressed" - This is called when the item is pressed for a certain
8262 * amount of time. By default it's 1 second.
8263 * - @c "selected" - The user has made an item selected. The
8264 * @c event_info parameter is the gengrid item that was selected.
8265 * - @c "unselected" - The user has made an item unselected. The
8266 * @c event_info parameter is the gengrid item that was unselected.
8267 * - @c "realized" - This is called when the item in the gengrid
8268 * has its implementing Evas object instantiated, de facto. @c
8269 * event_info is the gengrid item that was created. The object
8270 * may be deleted at any time, so it is highly advised to the
8271 * caller @b not to use the object pointer returned from
8272 * elm_gengrid_item_object_get(), because it may point to freed
8274 * - @c "unrealized" - This is called when the implementing Evas
8275 * object for this item is deleted. @c event_info is the gengrid
8276 * item that was deleted.
8277 * - @c "changed" - Called when an item is added, removed, resized
8278 * or moved and when the gengrid is resized or gets "horizontal"
8280 * - @c "scroll,anim,start" - This is called when scrolling animation has
8282 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8284 * - @c "drag,start,up" - Called when the item in the gengrid has
8285 * been dragged (not scrolled) up.
8286 * - @c "drag,start,down" - Called when the item in the gengrid has
8287 * been dragged (not scrolled) down.
8288 * - @c "drag,start,left" - Called when the item in the gengrid has
8289 * been dragged (not scrolled) left.
8290 * - @c "drag,start,right" - Called when the item in the gengrid has
8291 * been dragged (not scrolled) right.
8292 * - @c "drag,stop" - Called when the item in the gengrid has
8293 * stopped being dragged.
8294 * - @c "drag" - Called when the item in the gengrid is being
8296 * - @c "scroll" - called when the content has been scrolled
8298 * - @c "scroll,drag,start" - called when dragging the content has
8300 * - @c "scroll,drag,stop" - called when dragging the content has
8302 * - @c "edge,top" - This is called when the gengrid is scrolled until
8304 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8305 * until the bottom edge.
8306 * - @c "edge,left" - This is called when the gengrid is scrolled
8307 * until the left edge.
8308 * - @c "edge,right" - This is called when the gengrid is scrolled
8309 * until the right edge.
8311 * List of gengrid examples:
8312 * @li @ref gengrid_example
8316 * @addtogroup Gengrid
8320 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8321 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8322 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8324 * Label fetching class function for Elm_Gen_Item_Class.
8325 * @param data The data passed in the item creation function
8326 * @param obj The base widget object
8327 * @param part The part name of the swallow
8328 * @return The allocated (NOT stringshared) string to set as the label
8330 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8332 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8333 * @param data The data passed in the item creation function
8334 * @param obj The base widget object
8335 * @param part The part name of the swallow
8336 * @return The content object to swallow
8338 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8340 * State fetching class function for Elm_Gen_Item_Class.
8341 * @param data The data passed in the item creation function
8342 * @param obj The base widget object
8343 * @param part The part name of the swallow
8344 * @return The hell if I know
8346 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8348 * Deletion class function for Elm_Gen_Item_Class.
8349 * @param data The data passed in the item creation function
8350 * @param obj The base widget object
8352 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8354 /* temporary compatibility code */
8355 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8356 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8357 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8358 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8361 * @struct _Elm_Gengrid_Item_Class
8363 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8366 struct _Elm_Gengrid_Item_Class
8368 const char *item_style;
8369 struct _Elm_Gengrid_Item_Class_Func
8371 Elm_Gengrid_Item_Label_Get_Cb label_get;
8372 union { /* temporary compatibility code */
8373 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8374 Elm_Gengrid_Item_Content_Get_Cb content_get;
8376 Elm_Gengrid_Item_State_Get_Cb state_get;
8377 Elm_Gengrid_Item_Del_Cb del;
8379 }; /**< #Elm_Gengrid_Item_Class member definitions */
8381 * Add a new gengrid widget to the given parent Elementary
8382 * (container) object
8384 * @param parent The parent object
8385 * @return a new gengrid widget handle or @c NULL, on errors
8387 * This function inserts a new gengrid widget on the canvas.
8389 * @see elm_gengrid_item_size_set()
8390 * @see elm_gengrid_group_item_size_set()
8391 * @see elm_gengrid_horizontal_set()
8392 * @see elm_gengrid_item_append()
8393 * @see elm_gengrid_item_del()
8394 * @see elm_gengrid_clear()
8398 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8401 * Set the size for the items of a given gengrid widget
8403 * @param obj The gengrid object.
8404 * @param w The items' width.
8405 * @param h The items' height;
8407 * A gengrid, after creation, has still no information on the size
8408 * to give to each of its cells. So, you most probably will end up
8409 * with squares one @ref Fingers "finger" wide, the default
8410 * size. Use this function to force a custom size for you items,
8411 * making them as big as you wish.
8413 * @see elm_gengrid_item_size_get()
8417 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8420 * Get the size set for the items of a given gengrid widget
8422 * @param obj The gengrid object.
8423 * @param w Pointer to a variable where to store the items' width.
8424 * @param h Pointer to a variable where to store the items' height.
8426 * @note Use @c NULL pointers on the size values you're not
8427 * interested in: they'll be ignored by the function.
8429 * @see elm_gengrid_item_size_get() for more details
8433 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8436 * Set the items grid's alignment within a given gengrid widget
8438 * @param obj The gengrid object.
8439 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8440 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8442 * This sets the alignment of the whole grid of items of a gengrid
8443 * within its given viewport. By default, those values are both
8444 * 0.5, meaning that the gengrid will have its items grid placed
8445 * exactly in the middle of its viewport.
8447 * @note If given alignment values are out of the cited ranges,
8448 * they'll be changed to the nearest boundary values on the valid
8451 * @see elm_gengrid_align_get()
8455 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8458 * Get the items grid's alignment values within a given gengrid
8461 * @param obj The gengrid object.
8462 * @param align_x Pointer to a variable where to store the
8463 * horizontal alignment.
8464 * @param align_y Pointer to a variable where to store the vertical
8467 * @note Use @c NULL pointers on the alignment values you're not
8468 * interested in: they'll be ignored by the function.
8470 * @see elm_gengrid_align_set() for more details
8474 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8477 * Set whether a given gengrid widget is or not able have items
8480 * @param obj The gengrid object
8481 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8482 * @c EINA_FALSE to turn it off
8484 * If a gengrid is set to allow reordering, a click held for more
8485 * than 0.5 over a given item will highlight it specially,
8486 * signalling the gengrid has entered the reordering state. From
8487 * that time on, the user will be able to, while still holding the
8488 * mouse button down, move the item freely in the gengrid's
8489 * viewport, replacing to said item to the locations it goes to.
8490 * The replacements will be animated and, whenever the user
8491 * releases the mouse button, the item being replaced gets a new
8492 * definitive place in the grid.
8494 * @see elm_gengrid_reorder_mode_get()
8498 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8501 * Get whether a given gengrid widget is or not able have items
8504 * @param obj The gengrid object
8505 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8508 * @see elm_gengrid_reorder_mode_set() for more details
8512 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8515 * Append a new item in a given gengrid widget.
8517 * @param obj The gengrid object.
8518 * @param gic The item class for the item.
8519 * @param data The item data.
8520 * @param func Convenience function called when the item is
8522 * @param func_data Data to be passed to @p func.
8523 * @return A handle to the item added or @c NULL, on errors.
8525 * This adds an item to the beginning of the gengrid.
8527 * @see elm_gengrid_item_prepend()
8528 * @see elm_gengrid_item_insert_before()
8529 * @see elm_gengrid_item_insert_after()
8530 * @see elm_gengrid_item_del()
8534 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);
8537 * Prepend a new item in a given gengrid widget.
8539 * @param obj The gengrid object.
8540 * @param gic The item class for the item.
8541 * @param data The item data.
8542 * @param func Convenience function called when the item is
8544 * @param func_data Data to be passed to @p func.
8545 * @return A handle to the item added or @c NULL, on errors.
8547 * This adds an item to the end of the gengrid.
8549 * @see elm_gengrid_item_append()
8550 * @see elm_gengrid_item_insert_before()
8551 * @see elm_gengrid_item_insert_after()
8552 * @see elm_gengrid_item_del()
8556 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);
8559 * Insert an item before another in a gengrid widget
8561 * @param obj The gengrid object.
8562 * @param gic The item class for the item.
8563 * @param data The item data.
8564 * @param relative The item to place this new one before.
8565 * @param func Convenience function called when the item is
8567 * @param func_data Data to be passed to @p func.
8568 * @return A handle to the item added or @c NULL, on errors.
8570 * This inserts an item before another in the gengrid.
8572 * @see elm_gengrid_item_append()
8573 * @see elm_gengrid_item_prepend()
8574 * @see elm_gengrid_item_insert_after()
8575 * @see elm_gengrid_item_del()
8579 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);
8582 * Insert an item after another in a gengrid widget
8584 * @param obj The gengrid object.
8585 * @param gic The item class for the item.
8586 * @param data The item data.
8587 * @param relative The item to place this new one after.
8588 * @param func Convenience function called when the item is
8590 * @param func_data Data to be passed to @p func.
8591 * @return A handle to the item added or @c NULL, on errors.
8593 * This inserts an item after another in the gengrid.
8595 * @see elm_gengrid_item_append()
8596 * @see elm_gengrid_item_prepend()
8597 * @see elm_gengrid_item_insert_after()
8598 * @see elm_gengrid_item_del()
8602 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);
8605 * Insert an item in a gengrid widget using a user-defined sort function.
8607 * @param obj The gengrid object.
8608 * @param gic The item class for the item.
8609 * @param data The item data.
8610 * @param comp User defined comparison function that defines the sort order based on
8611 * Elm_Gen_Item and its data param.
8612 * @param func Convenience function called when the item is selected.
8613 * @param func_data Data to be passed to @p func.
8614 * @return A handle to the item added or @c NULL, on errors.
8616 * This inserts an item in the gengrid based on user defined comparison function.
8618 * @see elm_gengrid_item_append()
8619 * @see elm_gengrid_item_prepend()
8620 * @see elm_gengrid_item_insert_after()
8621 * @see elm_gengrid_item_del()
8622 * @see elm_gengrid_item_direct_sorted_insert()
8626 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);
8629 * Insert an item in a gengrid widget using a user-defined sort function.
8631 * @param obj The gengrid object.
8632 * @param gic The item class for the item.
8633 * @param data The item data.
8634 * @param comp User defined comparison function that defines the sort order based on
8636 * @param func Convenience function called when the item is selected.
8637 * @param func_data Data to be passed to @p func.
8638 * @return A handle to the item added or @c NULL, on errors.
8640 * This inserts an item in the gengrid based on user defined comparison function.
8642 * @see elm_gengrid_item_append()
8643 * @see elm_gengrid_item_prepend()
8644 * @see elm_gengrid_item_insert_after()
8645 * @see elm_gengrid_item_del()
8646 * @see elm_gengrid_item_sorted_insert()
8650 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);
8653 * Set whether items on a given gengrid widget are to get their
8654 * selection callbacks issued for @b every subsequent selection
8655 * click on them or just for the first click.
8657 * @param obj The gengrid object
8658 * @param always_select @c EINA_TRUE to make items "always
8659 * selected", @c EINA_FALSE, otherwise
8661 * By default, grid items will only call their selection callback
8662 * function when firstly getting selected, any subsequent further
8663 * clicks will do nothing. With this call, you make those
8664 * subsequent clicks also to issue the selection callbacks.
8666 * @note <b>Double clicks</b> will @b always be reported on items.
8668 * @see elm_gengrid_always_select_mode_get()
8672 WILL_DEPRECATE EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8675 * Get whether items on a given gengrid widget have their selection
8676 * callbacks issued for @b every subsequent selection click on them
8677 * or just for the first click.
8679 * @param obj The gengrid object.
8680 * @return @c EINA_TRUE if the gengrid items are "always selected",
8681 * @c EINA_FALSE, otherwise
8683 * @see elm_gengrid_always_select_mode_set() for more details
8687 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8690 * Set whether items on a given gengrid widget can be selected or not.
8692 * @param obj The gengrid object
8693 * @param no_select @c EINA_TRUE to make items selectable,
8694 * @c EINA_FALSE otherwise
8696 * This will make items in @p obj selectable or not. In the latter
8697 * case, any user interaction on the gengrid items will neither make
8698 * them appear selected nor them call their selection callback
8701 * @see elm_gengrid_no_select_mode_get()
8705 WILL_DEPRECATE EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8708 * Get whether items on a given gengrid widget can be selected or
8711 * @param obj The gengrid object
8712 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8715 * @see elm_gengrid_no_select_mode_set() for more details
8719 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8722 * Enable or disable multi-selection in a given gengrid widget
8724 * @param obj The gengrid object.
8725 * @param multi @c EINA_TRUE, to enable multi-selection,
8726 * @c EINA_FALSE to disable it.
8728 * Multi-selection is the ability to have @b more than one
8729 * item selected, on a given gengrid, simultaneously. When it is
8730 * enabled, a sequence of clicks on different items will make them
8731 * all selected, progressively. A click on an already selected item
8732 * will unselect it. If interacting via the keyboard,
8733 * multi-selection is enabled while holding the "Shift" key.
8735 * @note By default, multi-selection is @b disabled on gengrids
8737 * @see elm_gengrid_multi_select_get()
8741 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8744 * Get whether multi-selection is enabled or disabled for a given
8747 * @param obj The gengrid object.
8748 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8749 * EINA_FALSE otherwise
8751 * @see elm_gengrid_multi_select_set() for more details
8755 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8758 * Enable or disable bouncing effect for a given gengrid widget
8760 * @param obj The gengrid object
8761 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8762 * @c EINA_FALSE to disable it
8763 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8764 * @c EINA_FALSE to disable it
8766 * The bouncing effect occurs whenever one reaches the gengrid's
8767 * edge's while panning it -- it will scroll past its limits a
8768 * little bit and return to the edge again, in a animated for,
8771 * @note By default, gengrids have bouncing enabled on both axis
8773 * @see elm_gengrid_bounce_get()
8777 WILL_DEPRECATE EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8780 * Get whether bouncing effects are enabled or disabled, for a
8781 * given gengrid widget, on each axis
8783 * @param obj The gengrid object
8784 * @param h_bounce Pointer to a variable where to store the
8785 * horizontal bouncing flag.
8786 * @param v_bounce Pointer to a variable where to store the
8787 * vertical bouncing flag.
8789 * @see elm_gengrid_bounce_set() for more details
8793 WILL_DEPRECATE EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8796 * Set a given gengrid widget's scrolling page size, relative to
8797 * its viewport size.
8799 * @param obj The gengrid object
8800 * @param h_pagerel The horizontal page (relative) size
8801 * @param v_pagerel The vertical page (relative) size
8803 * The gengrid's scroller is capable of binding scrolling by the
8804 * user to "pages". It means that, while scrolling and, specially
8805 * after releasing the mouse button, the grid will @b snap to the
8806 * nearest displaying page's area. When page sizes are set, the
8807 * grid's continuous content area is split into (equal) page sized
8810 * This function sets the size of a page <b>relatively to the
8811 * viewport dimensions</b> of the gengrid, for each axis. A value
8812 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8813 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8814 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8815 * 1.0. Values beyond those will make it behave behave
8816 * inconsistently. If you only want one axis to snap to pages, use
8817 * the value @c 0.0 for the other one.
8819 * There is a function setting page size values in @b absolute
8820 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8821 * is mutually exclusive to this one.
8823 * @see elm_gengrid_page_relative_get()
8827 WILL_DEPRECATE EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8830 * Get a given gengrid widget's scrolling page size, relative to
8831 * its viewport size.
8833 * @param obj The gengrid object
8834 * @param h_pagerel Pointer to a variable where to store the
8835 * horizontal page (relative) size
8836 * @param v_pagerel Pointer to a variable where to store the
8837 * vertical page (relative) size
8839 * @see elm_gengrid_page_relative_set() for more details
8843 WILL_DEPRECATE EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8846 * Set a given gengrid widget's scrolling page size
8848 * @param obj The gengrid object
8849 * @param h_pagerel The horizontal page size, in pixels
8850 * @param v_pagerel The vertical page size, in pixels
8852 * The gengrid's scroller is capable of binding scrolling by the
8853 * user to "pages". It means that, while scrolling and, specially
8854 * after releasing the mouse button, the grid will @b snap to the
8855 * nearest displaying page's area. When page sizes are set, the
8856 * grid's continuous content area is split into (equal) page sized
8859 * This function sets the size of a page of the gengrid, in pixels,
8860 * for each axis. Sane usable values are, between @c 0 and the
8861 * dimensions of @p obj, for each axis. Values beyond those will
8862 * make it behave behave inconsistently. If you only want one axis
8863 * to snap to pages, use the value @c 0 for the other one.
8865 * There is a function setting page size values in @b relative
8866 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8867 * use is mutually exclusive to this one.
8871 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8874 * Set the direction in which a given gengrid widget will expand while
8875 * placing its items.
8877 * @param obj The gengrid object.
8878 * @param setting @c EINA_TRUE to make the gengrid expand
8879 * horizontally, @c EINA_FALSE to expand vertically.
8881 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8882 * in @b columns, from top to bottom and, when the space for a
8883 * column is filled, another one is started on the right, thus
8884 * expanding the grid horizontally. When in "vertical mode"
8885 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8886 * to right and, when the space for a row is filled, another one is
8887 * started below, thus expanding the grid vertically.
8889 * @see elm_gengrid_horizontal_get()
8893 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8896 * Get for what direction a given gengrid widget will expand while
8897 * placing its items.
8899 * @param obj The gengrid object.
8900 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8901 * @c EINA_FALSE if it's set to expand vertically.
8903 * @see elm_gengrid_horizontal_set() for more detais
8907 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8910 * Get the first item in a given gengrid widget
8912 * @param obj The gengrid object
8913 * @return The first item's handle or @c NULL, if there are no
8914 * items in @p obj (and on errors)
8916 * This returns the first item in the @p obj's internal list of
8919 * @see elm_gengrid_last_item_get()
8923 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8926 * Get the last item in a given gengrid widget
8928 * @param obj The gengrid object
8929 * @return The last item's handle or @c NULL, if there are no
8930 * items in @p obj (and on errors)
8932 * This returns the last item in the @p obj's internal list of
8935 * @see elm_gengrid_first_item_get()
8939 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8942 * Get the @b next item in a gengrid widget's internal list of items,
8943 * given a handle to one of those items.
8945 * @param item The gengrid item to fetch next from
8946 * @return The item after @p item, or @c NULL if there's none (and
8949 * This returns the item placed after the @p item, on the container
8952 * @see elm_gengrid_item_prev_get()
8956 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8959 * Get the @b previous item in a gengrid widget's internal list of items,
8960 * given a handle to one of those items.
8962 * @param item The gengrid item to fetch previous from
8963 * @return The item before @p item, or @c NULL if there's none (and
8966 * This returns the item placed before the @p item, on the container
8969 * @see elm_gengrid_item_next_get()
8973 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8976 * Get the gengrid object's handle which contains a given gengrid
8979 * @param item The item to fetch the container from
8980 * @return The gengrid (parent) object
8982 * This returns the gengrid object itself that an item belongs to.
8986 WILL_DEPRECATE EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8989 * Remove a gengrid item from its parent, deleting it.
8991 * @param item The item to be removed.
8992 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8994 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8999 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9002 * Update the contents of a given gengrid item
9004 * @param item The gengrid item
9006 * This updates an item by calling all the item class functions
9007 * again to get the contents, labels and states. Use this when the
9008 * original item data has changed and you want the changes to be
9013 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9016 * Get the Gengrid Item class for the given Gengrid Item.
9018 * @param item The gengrid item
9020 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9021 * the function pointers and item_style.
9025 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9028 * Get the Gengrid Item class for the given Gengrid Item.
9030 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9031 * the function pointers and item_style.
9033 * @param item The gengrid item
9034 * @param gic The gengrid item class describing the function pointers and the item style.
9038 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9041 * Return the data associated to a given gengrid item
9043 * @param item The gengrid item.
9044 * @return the data associated with this item.
9046 * This returns the @c data value passed on the
9047 * elm_gengrid_item_append() and related item addition calls.
9049 * @see elm_gengrid_item_append()
9050 * @see elm_gengrid_item_data_set()
9054 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9057 * Set the data associated with a given gengrid item
9059 * @param item The gengrid item
9060 * @param data The data pointer to set on it
9062 * This @b overrides the @c data value passed on the
9063 * elm_gengrid_item_append() and related item addition calls. This
9064 * function @b won't call elm_gengrid_item_update() automatically,
9065 * so you'd issue it afterwards if you want to have the item
9066 * updated to reflect the new data.
9068 * @see elm_gengrid_item_data_get()
9069 * @see elm_gengrid_item_update()
9073 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9076 * Get a given gengrid item's position, relative to the whole
9077 * gengrid's grid area.
9079 * @param item The Gengrid item.
9080 * @param x Pointer to variable to store the item's <b>row number</b>.
9081 * @param y Pointer to variable to store the item's <b>column number</b>.
9083 * This returns the "logical" position of the item within the
9084 * gengrid. For example, @c (0, 1) would stand for first row,
9089 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9092 * Set whether a given gengrid item is selected or not
9094 * @param item The gengrid item
9095 * @param selected Use @c EINA_TRUE, to make it selected, @c
9096 * EINA_FALSE to make it unselected
9098 * This sets the selected state of an item. If multi-selection is
9099 * not enabled on the containing gengrid and @p selected is @c
9100 * EINA_TRUE, any other previously selected items will get
9101 * unselected in favor of this new one.
9103 * @see elm_gengrid_item_selected_get()
9107 WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9110 * Get whether a given gengrid item is selected or not
9112 * @param item The gengrid item
9113 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9115 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9117 * @see elm_gengrid_item_selected_set() for more details
9121 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9124 * Get the real Evas object created to implement the view of a
9125 * given gengrid item
9127 * @param item The gengrid item.
9128 * @return the Evas object implementing this item's view.
9130 * This returns the actual Evas object used to implement the
9131 * specified gengrid item's view. This may be @c NULL, as it may
9132 * not have been created or may have been deleted, at any time, by
9133 * the gengrid. <b>Do not modify this object</b> (move, resize,
9134 * show, hide, etc.), as the gengrid is controlling it. This
9135 * function is for querying, emitting custom signals or hooking
9136 * lower level callbacks for events on that object. Do not delete
9137 * this object under any circumstances.
9139 * @see elm_gengrid_item_data_get()
9143 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9146 * Show the portion of a gengrid's internal grid containing a given
9147 * item, @b immediately.
9149 * @param item The item to display
9151 * This causes gengrid to @b redraw its viewport's contents to the
9152 * region contining the given @p item item, if it is not fully
9155 * @see elm_gengrid_item_bring_in()
9159 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9162 * Animatedly bring in, to the visible area of a gengrid, a given
9165 * @param item The gengrid item to display
9167 * This causes gengrid to jump to the given @p item and show
9168 * it (by scrolling), if it is not fully visible. This will use
9169 * animation to do so and take a period of time to complete.
9171 * @see elm_gengrid_item_show()
9175 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9178 * Set whether a given gengrid item is disabled or not.
9180 * @param item The gengrid item
9181 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9182 * to enable it back.
9184 * A disabled item cannot be selected or unselected. It will also
9185 * change its appearance, to signal the user it's disabled.
9187 * @see elm_gengrid_item_disabled_get()
9191 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9194 * Get whether a given gengrid item is disabled or not.
9196 * @param item The gengrid item
9197 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9200 * @see elm_gengrid_item_disabled_set() for more details
9204 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9207 * Set the text to be shown in a given gengrid item's tooltips.
9209 * @param item The gengrid item
9210 * @param text The text to set in the content
9212 * This call will setup the text to be used as tooltip to that item
9213 * (analogous to elm_object_tooltip_text_set(), but being item
9214 * tooltips with higher precedence than object tooltips). It can
9215 * have only one tooltip at a time, so any previous tooltip data
9220 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9223 * Set the content to be shown in a given gengrid item's tooltip
9225 * @param item The gengrid item.
9226 * @param func The function returning the tooltip contents.
9227 * @param data What to provide to @a func as callback data/context.
9228 * @param del_cb Called when data is not needed anymore, either when
9229 * another callback replaces @p func, the tooltip is unset with
9230 * elm_gengrid_item_tooltip_unset() or the owner @p item
9231 * dies. This callback receives as its first parameter the
9232 * given @p data, being @c event_info the item handle.
9234 * This call will setup the tooltip's contents to @p item
9235 * (analogous to elm_object_tooltip_content_cb_set(), but being
9236 * item tooltips with higher precedence than object tooltips). It
9237 * can have only one tooltip at a time, so any previous tooltip
9238 * content will get removed. @p func (with @p data) will be called
9239 * every time Elementary needs to show the tooltip and it should
9240 * return a valid Evas object, which will be fully managed by the
9241 * tooltip system, getting deleted when the tooltip is gone.
9245 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);
9248 * Unset a tooltip from a given gengrid item
9250 * @param item gengrid item to remove a previously set tooltip from.
9252 * This call removes any tooltip set on @p item. The callback
9253 * provided as @c del_cb to
9254 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9255 * notify it is not used anymore (and have resources cleaned, if
9258 * @see elm_gengrid_item_tooltip_content_cb_set()
9262 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9265 * Set a different @b style for a given gengrid item's tooltip.
9267 * @param item gengrid item with tooltip set
9268 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9269 * "default", @c "transparent", etc)
9271 * Tooltips can have <b>alternate styles</b> to be displayed on,
9272 * which are defined by the theme set on Elementary. This function
9273 * works analogously as elm_object_tooltip_style_set(), but here
9274 * applied only to gengrid item objects. The default style for
9275 * tooltips is @c "default".
9277 * @note before you set a style you should define a tooltip with
9278 * elm_gengrid_item_tooltip_content_cb_set() or
9279 * elm_gengrid_item_tooltip_text_set()
9281 * @see elm_gengrid_item_tooltip_style_get()
9285 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9288 * Get the style set a given gengrid item's tooltip.
9290 * @param item gengrid item with tooltip already set on.
9291 * @return style the theme style in use, which defaults to
9292 * "default". If the object does not have a tooltip set,
9293 * then @c NULL is returned.
9295 * @see elm_gengrid_item_tooltip_style_set() for more details
9299 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9301 * @brief Disable size restrictions on an object's tooltip
9302 * @param item The tooltip's anchor object
9303 * @param disable If EINA_TRUE, size restrictions are disabled
9304 * @return EINA_FALSE on failure, EINA_TRUE on success
9306 * This function allows a tooltip to expand beyond its parant window's canvas.
9307 * It will instead be limited only by the size of the display.
9309 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9311 * @brief Retrieve size restriction state of an object's tooltip
9312 * @param item The tooltip's anchor object
9313 * @return If EINA_TRUE, size restrictions are disabled
9315 * This function returns whether a tooltip is allowed to expand beyond
9316 * its parant window's canvas.
9317 * It will instead be limited only by the size of the display.
9319 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9321 * Set the type of mouse pointer/cursor decoration to be shown,
9322 * when the mouse pointer is over the given gengrid widget item
9324 * @param item gengrid item to customize cursor on
9325 * @param cursor the cursor type's name
9327 * This function works analogously as elm_object_cursor_set(), but
9328 * here the cursor's changing area is restricted to the item's
9329 * area, and not the whole widget's. Note that that item cursors
9330 * have precedence over widget cursors, so that a mouse over @p
9331 * item will always show cursor @p type.
9333 * If this function is called twice for an object, a previously set
9334 * cursor will be unset on the second call.
9336 * @see elm_object_cursor_set()
9337 * @see elm_gengrid_item_cursor_get()
9338 * @see elm_gengrid_item_cursor_unset()
9342 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9345 * Get the type of mouse pointer/cursor decoration set to be shown,
9346 * when the mouse pointer is over the given gengrid widget item
9348 * @param item gengrid item with custom cursor set
9349 * @return the cursor type's name or @c NULL, if no custom cursors
9350 * were set to @p item (and on errors)
9352 * @see elm_object_cursor_get()
9353 * @see elm_gengrid_item_cursor_set() for more details
9354 * @see elm_gengrid_item_cursor_unset()
9358 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9361 * Unset any custom mouse pointer/cursor decoration set to be
9362 * shown, when the mouse pointer is over the given gengrid widget
9363 * item, thus making it show the @b default cursor again.
9365 * @param item a gengrid item
9367 * Use this call to undo any custom settings on this item's cursor
9368 * decoration, bringing it back to defaults (no custom style set).
9370 * @see elm_object_cursor_unset()
9371 * @see elm_gengrid_item_cursor_set() for more details
9375 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9378 * Set a different @b style for a given custom cursor set for a
9381 * @param item gengrid item with custom cursor set
9382 * @param style the <b>theme style</b> to use (e.g. @c "default",
9383 * @c "transparent", etc)
9385 * This function only makes sense when one is using custom mouse
9386 * cursor decorations <b>defined in a theme file</b> , which can
9387 * have, given a cursor name/type, <b>alternate styles</b> on
9388 * it. It works analogously as elm_object_cursor_style_set(), but
9389 * here applied only to gengrid item objects.
9391 * @warning Before you set a cursor style you should have defined a
9392 * custom cursor previously on the item, with
9393 * elm_gengrid_item_cursor_set()
9395 * @see elm_gengrid_item_cursor_engine_only_set()
9396 * @see elm_gengrid_item_cursor_style_get()
9400 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9403 * Get the current @b style set for a given gengrid item's custom
9406 * @param item gengrid item with custom cursor set.
9407 * @return style the cursor style in use. If the object does not
9408 * have a cursor set, then @c NULL is returned.
9410 * @see elm_gengrid_item_cursor_style_set() for more details
9414 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9417 * Set if the (custom) cursor for a given gengrid item should be
9418 * searched in its theme, also, or should only rely on the
9421 * @param item item with custom (custom) cursor already set on
9422 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9423 * only on those provided by the rendering engine, @c EINA_FALSE to
9424 * have them searched on the widget's theme, as well.
9426 * @note This call is of use only if you've set a custom cursor
9427 * for gengrid items, with elm_gengrid_item_cursor_set().
9429 * @note By default, cursors will only be looked for between those
9430 * provided by the rendering engine.
9434 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9437 * Get if the (custom) cursor for a given gengrid item is being
9438 * searched in its theme, also, or is only relying on the rendering
9441 * @param item a gengrid item
9442 * @return @c EINA_TRUE, if cursors are being looked for only on
9443 * those provided by the rendering engine, @c EINA_FALSE if they
9444 * are being searched on the widget's theme, as well.
9446 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9450 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9453 * Remove all items from a given gengrid widget
9455 * @param obj The gengrid object.
9457 * This removes (and deletes) all items in @p obj, leaving it
9460 * @see elm_gengrid_item_del(), to remove just one item.
9464 WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9467 * Get the selected item in a given gengrid widget
9469 * @param obj The gengrid object.
9470 * @return The selected item's handleor @c NULL, if none is
9471 * selected at the moment (and on errors)
9473 * This returns the selected item in @p obj. If multi selection is
9474 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9475 * the first item in the list is selected, which might not be very
9476 * useful. For that case, see elm_gengrid_selected_items_get().
9480 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9483 * Get <b>a list</b> of selected items in a given gengrid
9485 * @param obj The gengrid object.
9486 * @return The list of selected items or @c NULL, if none is
9487 * selected at the moment (and on errors)
9489 * This returns a list of the selected items, in the order that
9490 * they appear in the grid. This list is only valid as long as no
9491 * more items are selected or unselected (or unselected implictly
9492 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9495 * @see elm_gengrid_selected_item_get()
9499 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9506 * @defgroup Clock Clock
9508 * @image html img/widget/clock/preview-00.png
9509 * @image latex img/widget/clock/preview-00.eps
9511 * This is a @b digital clock widget. In its default theme, it has a
9512 * vintage "flipping numbers clock" appearance, which will animate
9513 * sheets of individual algarisms individually as time goes by.
9515 * A newly created clock will fetch system's time (already
9516 * considering local time adjustments) to start with, and will tick
9517 * accondingly. It may or may not show seconds.
9519 * Clocks have an @b edition mode. When in it, the sheets will
9520 * display extra arrow indications on the top and bottom and the
9521 * user may click on them to raise or lower the time values. After
9522 * it's told to exit edition mode, it will keep ticking with that
9523 * new time set (it keeps the difference from local time).
9525 * Also, when under edition mode, user clicks on the cited arrows
9526 * which are @b held for some time will make the clock to flip the
9527 * sheet, thus editing the time, continuosly and automatically for
9528 * the user. The interval between sheet flips will keep growing in
9529 * time, so that it helps the user to reach a time which is distant
9532 * The time display is, by default, in military mode (24h), but an
9533 * am/pm indicator may be optionally shown, too, when it will
9536 * Smart callbacks one can register to:
9537 * - "changed" - the clock's user changed the time
9539 * Here is an example on its usage:
9540 * @li @ref clock_example
9549 * Identifiers for which clock digits should be editable, when a
9550 * clock widget is in edition mode. Values may be ORed together to
9551 * make a mask, naturally.
9553 * @see elm_clock_edit_set()
9554 * @see elm_clock_digit_edit_set()
9556 typedef enum _Elm_Clock_Digedit
9558 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9559 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9560 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9561 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9562 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9563 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9564 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9565 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9566 } Elm_Clock_Digedit;
9569 * Add a new clock widget to the given parent Elementary
9570 * (container) object
9572 * @param parent The parent object
9573 * @return a new clock widget handle or @c NULL, on errors
9575 * This function inserts a new clock widget on the canvas.
9579 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9582 * Set a clock widget's time, programmatically
9584 * @param obj The clock widget object
9585 * @param hrs The hours to set
9586 * @param min The minutes to set
9587 * @param sec The secondes to set
9589 * This function updates the time that is showed by the clock
9592 * Values @b must be set within the following ranges:
9593 * - 0 - 23, for hours
9594 * - 0 - 59, for minutes
9595 * - 0 - 59, for seconds,
9597 * even if the clock is not in "military" mode.
9599 * @warning The behavior for values set out of those ranges is @b
9604 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9607 * Get a clock widget's time values
9609 * @param obj The clock object
9610 * @param[out] hrs Pointer to the variable to get the hours value
9611 * @param[out] min Pointer to the variable to get the minutes value
9612 * @param[out] sec Pointer to the variable to get the seconds value
9614 * This function gets the time set for @p obj, returning
9615 * it on the variables passed as the arguments to function
9617 * @note Use @c NULL pointers on the time values you're not
9618 * interested in: they'll be ignored by the function.
9622 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9625 * Set whether a given clock widget is under <b>edition mode</b> or
9626 * under (default) displaying-only mode.
9628 * @param obj The clock object
9629 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9630 * put it back to "displaying only" mode
9632 * This function makes a clock's time to be editable or not <b>by
9633 * user interaction</b>. When in edition mode, clocks @b stop
9634 * ticking, until one brings them back to canonical mode. The
9635 * elm_clock_digit_edit_set() function will influence which digits
9636 * of the clock will be editable. By default, all of them will be
9637 * (#ELM_CLOCK_NONE).
9639 * @note am/pm sheets, if being shown, will @b always be editable
9640 * under edition mode.
9642 * @see elm_clock_edit_get()
9646 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9649 * Retrieve whether a given clock widget is under <b>edition
9650 * mode</b> or under (default) displaying-only mode.
9652 * @param obj The clock object
9653 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9656 * This function retrieves whether the clock's time can be edited
9657 * or not by user interaction.
9659 * @see elm_clock_edit_set() for more details
9663 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9666 * Set what digits of the given clock widget should be editable
9667 * when in edition mode.
9669 * @param obj The clock object
9670 * @param digedit Bit mask indicating the digits to be editable
9671 * (values in #Elm_Clock_Digedit).
9673 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9674 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9677 * @see elm_clock_digit_edit_get()
9681 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9684 * Retrieve what digits of the given clock widget should be
9685 * editable when in edition mode.
9687 * @param obj The clock object
9688 * @return Bit mask indicating the digits to be editable
9689 * (values in #Elm_Clock_Digedit).
9691 * @see elm_clock_digit_edit_set() for more details
9695 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9698 * Set if the given clock widget must show hours in military or
9701 * @param obj The clock object
9702 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9705 * This function sets if the clock must show hours in military or
9706 * am/pm mode. In some countries like Brazil the military mode
9707 * (00-24h-format) is used, in opposition to the USA, where the
9708 * am/pm mode is more commonly used.
9710 * @see elm_clock_show_am_pm_get()
9714 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9717 * Get if the given clock widget shows hours in military or am/pm
9720 * @param obj The clock object
9721 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9724 * This function gets if the clock shows hours in military or am/pm
9727 * @see elm_clock_show_am_pm_set() for more details
9731 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9734 * Set if the given clock widget must show time with seconds or not
9736 * @param obj The clock object
9737 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9739 * This function sets if the given clock must show or not elapsed
9740 * seconds. By default, they are @b not shown.
9742 * @see elm_clock_show_seconds_get()
9746 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9749 * Get whether the given clock widget is showing time with seconds
9752 * @param obj The clock object
9753 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9755 * This function gets whether @p obj is showing or not the elapsed
9758 * @see elm_clock_show_seconds_set()
9762 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9765 * Set the interval on time updates for an user mouse button hold
9766 * on clock widgets' time edition.
9768 * @param obj The clock object
9769 * @param interval The (first) interval value in seconds
9771 * This interval value is @b decreased while the user holds the
9772 * mouse pointer either incrementing or decrementing a given the
9773 * clock digit's value.
9775 * This helps the user to get to a given time distant from the
9776 * current one easier/faster, as it will start to flip quicker and
9777 * quicker on mouse button holds.
9779 * The calculation for the next flip interval value, starting from
9780 * the one set with this call, is the previous interval divided by
9781 * 1.05, so it decreases a little bit.
9783 * The default starting interval value for automatic flips is
9786 * @see elm_clock_interval_get()
9790 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9793 * Get the interval on time updates for an user mouse button hold
9794 * on clock widgets' time edition.
9796 * @param obj The clock object
9797 * @return The (first) interval value, in seconds, set on it
9799 * @see elm_clock_interval_set() for more details
9803 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9810 * @defgroup Layout Layout
9812 * @image html img/widget/layout/preview-00.png
9813 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9815 * @image html img/layout-predefined.png
9816 * @image latex img/layout-predefined.eps width=\textwidth
9818 * This is a container widget that takes a standard Edje design file and
9819 * wraps it very thinly in a widget.
9821 * An Edje design (theme) file has a very wide range of possibilities to
9822 * describe the behavior of elements added to the Layout. Check out the Edje
9823 * documentation and the EDC reference to get more information about what can
9824 * be done with Edje.
9826 * Just like @ref List, @ref Box, and other container widgets, any
9827 * object added to the Layout will become its child, meaning that it will be
9828 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9830 * The Layout widget can contain as many Contents, Boxes or Tables as
9831 * described in its theme file. For instance, objects can be added to
9832 * different Tables by specifying the respective Table part names. The same
9833 * is valid for Content and Box.
9835 * The objects added as child of the Layout will behave as described in the
9836 * part description where they were added. There are 3 possible types of
9837 * parts where a child can be added:
9839 * @section secContent Content (SWALLOW part)
9841 * Only one object can be added to the @c SWALLOW part (but you still can
9842 * have many @c SWALLOW parts and one object on each of them). Use the @c
9843 * elm_object_content_set/get/unset functions to set, retrieve and unset
9844 * objects as content of the @c SWALLOW. After being set to this part, the
9845 * object size, position, visibility, clipping and other description
9846 * properties will be totally controlled by the description of the given part
9847 * (inside the Edje theme file).
9849 * One can use @c evas_object_size_hint_* functions on the child to have some
9850 * kind of control over its behavior, but the resulting behavior will still
9851 * depend heavily on the @c SWALLOW part description.
9853 * The Edje theme also can change the part description, based on signals or
9854 * scripts running inside the theme. This change can also be animated. All of
9855 * this will affect the child object set as content accordingly. The object
9856 * size will be changed if the part size is changed, it will animate move if
9857 * the part is moving, and so on.
9859 * The following picture demonstrates a Layout widget with a child object
9860 * added to its @c SWALLOW:
9862 * @image html layout_swallow.png
9863 * @image latex layout_swallow.eps width=\textwidth
9865 * @section secBox Box (BOX part)
9867 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9868 * allows one to add objects to the box and have them distributed along its
9869 * area, accordingly to the specified @a layout property (now by @a layout we
9870 * mean the chosen layouting design of the Box, not the Layout widget
9873 * A similar effect for having a box with its position, size and other things
9874 * controlled by the Layout theme would be to create an Elementary @ref Box
9875 * widget and add it as a Content in the @c SWALLOW part.
9877 * The main difference of using the Layout Box is that its behavior, the box
9878 * properties like layouting format, padding, align, etc. will be all
9879 * controlled by the theme. This means, for example, that a signal could be
9880 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9881 * handled the signal by changing the box padding, or align, or both. Using
9882 * the Elementary @ref Box widget is not necessarily harder or easier, it
9883 * just depends on the circunstances and requirements.
9885 * The Layout Box can be used through the @c elm_layout_box_* set of
9888 * The following picture demonstrates a Layout widget with many child objects
9889 * added to its @c BOX part:
9891 * @image html layout_box.png
9892 * @image latex layout_box.eps width=\textwidth
9894 * @section secTable Table (TABLE part)
9896 * Just like the @ref secBox, the Layout Table is very similar to the
9897 * Elementary @ref Table widget. It allows one to add objects to the Table
9898 * specifying the row and column where the object should be added, and any
9899 * column or row span if necessary.
9901 * Again, we could have this design by adding a @ref Table widget to the @c
9902 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9903 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9904 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9906 * The Layout Table can be used through the @c elm_layout_table_* set of
9909 * The following picture demonstrates a Layout widget with many child objects
9910 * added to its @c TABLE part:
9912 * @image html layout_table.png
9913 * @image latex layout_table.eps width=\textwidth
9915 * @section secPredef Predefined Layouts
9917 * Another interesting thing about the Layout widget is that it offers some
9918 * predefined themes that come with the default Elementary theme. These
9919 * themes can be set by the call elm_layout_theme_set(), and provide some
9920 * basic functionality depending on the theme used.
9922 * Most of them already send some signals, some already provide a toolbar or
9923 * back and next buttons.
9925 * These are available predefined theme layouts. All of them have class = @c
9926 * layout, group = @c application, and style = one of the following options:
9928 * @li @c toolbar-content - application with toolbar and main content area
9929 * @li @c toolbar-content-back - application with toolbar and main content
9930 * area with a back button and title area
9931 * @li @c toolbar-content-back-next - application with toolbar and main
9932 * content area with a back and next buttons and title area
9933 * @li @c content-back - application with a main content area with a back
9934 * button and title area
9935 * @li @c content-back-next - application with a main content area with a
9936 * back and next buttons and title area
9937 * @li @c toolbar-vbox - application with toolbar and main content area as a
9939 * @li @c toolbar-table - application with toolbar and main content area as a
9942 * @section secExamples Examples
9944 * Some examples of the Layout widget can be found here:
9945 * @li @ref layout_example_01
9946 * @li @ref layout_example_02
9947 * @li @ref layout_example_03
9948 * @li @ref layout_example_edc
9953 * Add a new layout to the parent
9955 * @param parent The parent object
9956 * @return The new object or NULL if it cannot be created
9958 * @see elm_layout_file_set()
9959 * @see elm_layout_theme_set()
9963 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9965 * Set the file that will be used as layout
9967 * @param obj The layout object
9968 * @param file The path to file (edj) that will be used as layout
9969 * @param group The group that the layout belongs in edje file
9971 * @return (1 = success, 0 = error)
9975 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9977 * Set the edje group from the elementary theme that will be used as layout
9979 * @param obj The layout object
9980 * @param clas the clas of the group
9981 * @param group the group
9982 * @param style the style to used
9984 * @return (1 = success, 0 = error)
9988 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9990 * Set the layout content.
9992 * @param obj The layout object
9993 * @param swallow The swallow part name in the edje file
9994 * @param content The child that will be added in this layout object
9996 * Once the content object is set, a previously set one will be deleted.
9997 * If you want to keep that old content object, use the
9998 * elm_object_part_content_unset() function.
10000 * @note In an Edje theme, the part used as a content container is called @c
10001 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10002 * expected to be a part name just like the second parameter of
10003 * elm_layout_box_append().
10005 * @see elm_layout_box_append()
10006 * @see elm_object_part_content_get()
10007 * @see elm_object_part_content_unset()
10009 * @deprecated use elm_object_part_content_set() instead
10013 WILL_DEPRECATE EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10015 * Get the child object in the given content part.
10017 * @param obj The layout object
10018 * @param swallow The SWALLOW part to get its content
10020 * @return The swallowed object or NULL if none or an error occurred
10022 * @deprecated use elm_object_part_content_get() instead
10026 WILL_DEPRECATE EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10028 * Unset the layout content.
10030 * @param obj The layout object
10031 * @param swallow The swallow part name in the edje file
10032 * @return The content that was being used
10034 * Unparent and return the content object which was set for this part.
10036 * @deprecated use elm_object_part_content_unset() instead
10040 WILL_DEPRECATE EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10042 * Set the text of the given part
10044 * @param obj The layout object
10045 * @param part The TEXT part where to set the text
10046 * @param text The text to set
10049 * @deprecated use elm_object_part_text_set() instead.
10051 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10053 * Get the text set in the given part
10055 * @param obj The layout object
10056 * @param part The TEXT part to retrieve the text off
10058 * @return The text set in @p part
10061 * @deprecated use elm_object_part_text_get() instead.
10063 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10065 * Append child to layout box part.
10067 * @param obj the layout object
10068 * @param part the box part to which the object will be appended.
10069 * @param child the child object to append to box.
10071 * Once the object is appended, it will become child of the layout. Its
10072 * lifetime will be bound to the layout, whenever the layout dies the child
10073 * will be deleted automatically. One should use elm_layout_box_remove() to
10074 * make this layout forget about the object.
10076 * @see elm_layout_box_prepend()
10077 * @see elm_layout_box_insert_before()
10078 * @see elm_layout_box_insert_at()
10079 * @see elm_layout_box_remove()
10083 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10085 * Prepend child to layout box part.
10087 * @param obj the layout object
10088 * @param part the box part to prepend.
10089 * @param child the child object to prepend to box.
10091 * Once the object is prepended, it will become child of the layout. Its
10092 * lifetime will be bound to the layout, whenever the layout dies the child
10093 * will be deleted automatically. One should use elm_layout_box_remove() to
10094 * make this layout forget about the object.
10096 * @see elm_layout_box_append()
10097 * @see elm_layout_box_insert_before()
10098 * @see elm_layout_box_insert_at()
10099 * @see elm_layout_box_remove()
10103 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10105 * Insert child to layout box part before a reference object.
10107 * @param obj the layout object
10108 * @param part the box part to insert.
10109 * @param child the child object to insert into box.
10110 * @param reference another reference object to insert before in box.
10112 * Once the object is inserted, it will become child of the layout. Its
10113 * lifetime will be bound to the layout, whenever the layout dies the child
10114 * will be deleted automatically. One should use elm_layout_box_remove() to
10115 * make this layout forget about the object.
10117 * @see elm_layout_box_append()
10118 * @see elm_layout_box_prepend()
10119 * @see elm_layout_box_insert_before()
10120 * @see elm_layout_box_remove()
10124 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10126 * Insert child to layout box part at a given position.
10128 * @param obj the layout object
10129 * @param part the box part to insert.
10130 * @param child the child object to insert into box.
10131 * @param pos the numeric position >=0 to insert the child.
10133 * Once the object is inserted, it will become child of the layout. Its
10134 * lifetime will be bound to the layout, whenever the layout dies the child
10135 * will be deleted automatically. One should use elm_layout_box_remove() to
10136 * make this layout forget about the object.
10138 * @see elm_layout_box_append()
10139 * @see elm_layout_box_prepend()
10140 * @see elm_layout_box_insert_before()
10141 * @see elm_layout_box_remove()
10145 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10147 * Remove a child of the given part box.
10149 * @param obj The layout object
10150 * @param part The box part name to remove child.
10151 * @param child The object to remove from box.
10152 * @return The object that was being used, or NULL if not found.
10154 * The object will be removed from the box part and its lifetime will
10155 * not be handled by the layout anymore. This is equivalent to
10156 * elm_object_part_content_unset() for box.
10158 * @see elm_layout_box_append()
10159 * @see elm_layout_box_remove_all()
10163 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10165 * Remove all children of the given part box.
10167 * @param obj The layout object
10168 * @param part The box part name to remove child.
10169 * @param clear If EINA_TRUE, then all objects will be deleted as
10170 * well, otherwise they will just be removed and will be
10171 * dangling on the canvas.
10173 * The objects will be removed from the box part and their lifetime will
10174 * not be handled by the layout anymore. This is equivalent to
10175 * elm_layout_box_remove() for all box children.
10177 * @see elm_layout_box_append()
10178 * @see elm_layout_box_remove()
10182 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10184 * Insert child to layout table part.
10186 * @param obj the layout object
10187 * @param part the box part to pack child.
10188 * @param child_obj the child object to pack into table.
10189 * @param col the column to which the child should be added. (>= 0)
10190 * @param row the row to which the child should be added. (>= 0)
10191 * @param colspan how many columns should be used to store this object. (>=
10193 * @param rowspan how many rows should be used to store this object. (>= 1)
10195 * Once the object is inserted, it will become child of the table. Its
10196 * lifetime will be bound to the layout, and whenever the layout dies the
10197 * child will be deleted automatically. One should use
10198 * elm_layout_table_remove() to make this layout forget about the object.
10200 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10201 * more space than a single cell. For instance, the following code:
10203 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10206 * Would result in an object being added like the following picture:
10208 * @image html layout_colspan.png
10209 * @image latex layout_colspan.eps width=\textwidth
10211 * @see elm_layout_table_unpack()
10212 * @see elm_layout_table_clear()
10216 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);
10218 * Unpack (remove) a child of the given part table.
10220 * @param obj The layout object
10221 * @param part The table part name to remove child.
10222 * @param child_obj The object to remove from table.
10223 * @return The object that was being used, or NULL if not found.
10225 * The object will be unpacked from the table part and its lifetime
10226 * will not be handled by the layout anymore. This is equivalent to
10227 * elm_object_part_content_unset() for table.
10229 * @see elm_layout_table_pack()
10230 * @see elm_layout_table_clear()
10234 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10236 * Remove all the child objects of the given part table.
10238 * @param obj The layout object
10239 * @param part The table part name to remove child.
10240 * @param clear If EINA_TRUE, then all objects will be deleted as
10241 * well, otherwise they will just be removed and will be
10242 * dangling on the canvas.
10244 * The objects will be removed from the table part and their lifetime will
10245 * not be handled by the layout anymore. This is equivalent to
10246 * elm_layout_table_unpack() for all table children.
10248 * @see elm_layout_table_pack()
10249 * @see elm_layout_table_unpack()
10253 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10255 * Get the edje layout
10257 * @param obj The layout object
10259 * @return A Evas_Object with the edje layout settings loaded
10260 * with function elm_layout_file_set
10262 * This returns the edje object. It is not expected to be used to then
10263 * swallow objects via edje_object_part_swallow() for example. Use
10264 * elm_object_part_content_set() instead so child object handling and sizing is
10267 * @note This function should only be used if you really need to call some
10268 * low level Edje function on this edje object. All the common stuff (setting
10269 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10270 * with proper elementary functions.
10272 * @see elm_object_signal_callback_add()
10273 * @see elm_object_signal_emit()
10274 * @see elm_object_part_text_set()
10275 * @see elm_object_part_content_set()
10276 * @see elm_layout_box_append()
10277 * @see elm_layout_table_pack()
10278 * @see elm_layout_data_get()
10282 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10284 * Get the edje data from the given layout
10286 * @param obj The layout object
10287 * @param key The data key
10289 * @return The edje data string
10291 * This function fetches data specified inside the edje theme of this layout.
10292 * This function return NULL if data is not found.
10294 * In EDC this comes from a data block within the group block that @p
10295 * obj was loaded from. E.g.
10302 * item: "key1" "value1";
10303 * item: "key2" "value2";
10311 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10315 * @param obj The layout object
10317 * Manually forces a sizing re-evaluation. This is useful when the minimum
10318 * size required by the edje theme of this layout has changed. The change on
10319 * the minimum size required by the edje theme is not immediately reported to
10320 * the elementary layout, so one needs to call this function in order to tell
10321 * the widget (layout) that it needs to reevaluate its own size.
10323 * The minimum size of the theme is calculated based on minimum size of
10324 * parts, the size of elements inside containers like box and table, etc. All
10325 * of this can change due to state changes, and that's when this function
10326 * should be called.
10328 * Also note that a standard signal of "size,eval" "elm" emitted from the
10329 * edje object will cause this to happen too.
10333 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10336 * Sets a specific cursor for an edje part.
10338 * @param obj The layout object.
10339 * @param part_name a part from loaded edje group.
10340 * @param cursor cursor name to use, see Elementary_Cursor.h
10342 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10343 * part not exists or it has "mouse_events: 0".
10347 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10350 * Get the cursor to be shown when mouse is over an edje part
10352 * @param obj The layout object.
10353 * @param part_name a part from loaded edje group.
10354 * @return the cursor name.
10358 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10361 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10363 * @param obj The layout object.
10364 * @param part_name a part from loaded edje group, that had a cursor set
10365 * with elm_layout_part_cursor_set().
10369 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10372 * Sets a specific cursor style for an edje part.
10374 * @param obj The layout object.
10375 * @param part_name a part from loaded edje group.
10376 * @param style the theme style to use (default, transparent, ...)
10378 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10379 * part not exists or it did not had a cursor set.
10383 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10386 * Gets a specific cursor style for an edje part.
10388 * @param obj The layout object.
10389 * @param part_name a part from loaded edje group.
10391 * @return the theme style in use, defaults to "default". If the
10392 * object does not have a cursor set, then NULL is returned.
10396 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10399 * Sets if the cursor set should be searched on the theme or should use
10400 * the provided by the engine, only.
10402 * @note before you set if should look on theme you should define a
10403 * cursor with elm_layout_part_cursor_set(). By default it will only
10404 * look for cursors provided by the engine.
10406 * @param obj The layout object.
10407 * @param part_name a part from loaded edje group.
10408 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10409 * or should also search on widget's theme as well (EINA_FALSE)
10411 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10412 * part not exists or it did not had a cursor set.
10416 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);
10419 * Gets a specific cursor engine_only for an edje part.
10421 * @param obj The layout object.
10422 * @param part_name a part from loaded edje group.
10424 * @return whenever the cursor is just provided by engine or also from theme.
10428 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10431 * @def elm_layout_icon_set
10432 * Convenience macro to set the icon object in a layout that follows the
10433 * Elementary naming convention for its parts.
10437 #define elm_layout_icon_set(_ly, _obj) \
10440 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10441 if ((_obj)) sig = "elm,state,icon,visible"; \
10442 else sig = "elm,state,icon,hidden"; \
10443 elm_object_signal_emit((_ly), sig, "elm"); \
10447 * @def elm_layout_icon_get
10448 * Convienience macro to get the icon object from a layout that follows the
10449 * Elementary naming convention for its parts.
10453 #define elm_layout_icon_get(_ly) \
10454 elm_object_part_content_get((_ly), "elm.swallow.icon")
10457 * @def elm_layout_end_set
10458 * Convienience macro to set the end object in a layout that follows the
10459 * Elementary naming convention for its parts.
10463 #define elm_layout_end_set(_ly, _obj) \
10466 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10467 if ((_obj)) sig = "elm,state,end,visible"; \
10468 else sig = "elm,state,end,hidden"; \
10469 elm_object_signal_emit((_ly), sig, "elm"); \
10473 * @def elm_layout_end_get
10474 * Convienience macro to get the end object in a layout that follows the
10475 * Elementary naming convention for its parts.
10479 #define elm_layout_end_get(_ly) \
10480 elm_object_part_content_get((_ly), "elm.swallow.end")
10483 * @def elm_layout_label_set
10484 * Convienience macro to set the label in a layout that follows the
10485 * Elementary naming convention for its parts.
10488 * @deprecated use elm_object_text_set() instead.
10490 #define elm_layout_label_set(_ly, _txt) \
10491 elm_layout_text_set((_ly), "elm.text", (_txt))
10494 * @def elm_layout_label_get
10495 * Convenience macro to get the label in a layout that follows the
10496 * Elementary naming convention for its parts.
10499 * @deprecated use elm_object_text_set() instead.
10501 #define elm_layout_label_get(_ly) \
10502 elm_layout_text_get((_ly), "elm.text")
10504 /* smart callbacks called:
10505 * "theme,changed" - when elm theme is changed.
10509 * @defgroup Notify Notify
10511 * @image html img/widget/notify/preview-00.png
10512 * @image latex img/widget/notify/preview-00.eps
10514 * Display a container in a particular region of the parent(top, bottom,
10515 * etc). A timeout can be set to automatically hide the notify. This is so
10516 * that, after an evas_object_show() on a notify object, if a timeout was set
10517 * on it, it will @b automatically get hidden after that time.
10519 * Signals that you can add callbacks for are:
10520 * @li "timeout" - when timeout happens on notify and it's hidden
10521 * @li "block,clicked" - when a click outside of the notify happens
10523 * Default contents parts of the notify widget that you can use for are:
10524 * @li "default" - A content of the notify
10526 * @ref tutorial_notify show usage of the API.
10531 * @brief Possible orient values for notify.
10533 * This values should be used in conjunction to elm_notify_orient_set() to
10534 * set the position in which the notify should appear(relative to its parent)
10535 * and in conjunction with elm_notify_orient_get() to know where the notify
10538 typedef enum _Elm_Notify_Orient
10540 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10541 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10542 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10543 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10544 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10545 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10546 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10547 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10548 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10549 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10550 } Elm_Notify_Orient;
10552 * @brief Add a new notify to the parent
10554 * @param parent The parent object
10555 * @return The new object or NULL if it cannot be created
10557 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10559 * @brief Set the content of the notify widget
10561 * @param obj The notify object
10562 * @param content The content will be filled in this notify object
10564 * Once the content object is set, a previously set one will be deleted. If
10565 * you want to keep that old content object, use the
10566 * elm_notify_content_unset() function.
10568 * @deprecated use elm_object_content_set() instead
10571 WILL_DEPRECATE EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10573 * @brief Unset the content of the notify widget
10575 * @param obj The notify object
10576 * @return The content that was being used
10578 * Unparent and return the content object which was set for this widget
10580 * @see elm_notify_content_set()
10581 * @deprecated use elm_object_content_unset() instead
10584 WILL_DEPRECATE EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10586 * @brief Return the content of the notify widget
10588 * @param obj The notify object
10589 * @return The content that is being used
10591 * @see elm_notify_content_set()
10592 * @deprecated use elm_object_content_get() instead
10595 WILL_DEPRECATE EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10597 * @brief Set the notify parent
10599 * @param obj The notify object
10600 * @param content The new parent
10602 * Once the parent object is set, a previously set one will be disconnected
10605 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10607 * @brief Get the notify parent
10609 * @param obj The notify object
10610 * @return The parent
10612 * @see elm_notify_parent_set()
10614 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10616 * @brief Set the orientation
10618 * @param obj The notify object
10619 * @param orient The new orientation
10621 * Sets the position in which the notify will appear in its parent.
10623 * @see @ref Elm_Notify_Orient for possible values.
10625 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10627 * @brief Return the orientation
10628 * @param obj The notify object
10629 * @return The orientation of the notification
10631 * @see elm_notify_orient_set()
10632 * @see Elm_Notify_Orient
10634 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10636 * @brief Set the time interval after which the notify window is going to be
10639 * @param obj The notify object
10640 * @param time The timeout in seconds
10642 * This function sets a timeout and starts the timer controlling when the
10643 * notify is hidden. Since calling evas_object_show() on a notify restarts
10644 * the timer controlling when the notify is hidden, setting this before the
10645 * notify is shown will in effect mean starting the timer when the notify is
10648 * @note Set a value <= 0.0 to disable a running timer.
10650 * @note If the value > 0.0 and the notify is previously visible, the
10651 * timer will be started with this value, canceling any running timer.
10653 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10655 * @brief Return the timeout value (in seconds)
10656 * @param obj the notify object
10658 * @see elm_notify_timeout_set()
10660 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10662 * @brief Sets whether events should be passed to by a click outside
10665 * @param obj The notify object
10666 * @param repeats EINA_TRUE Events are repeats, else no
10668 * When true if the user clicks outside the window the events will be caught
10669 * by the others widgets, else the events are blocked.
10671 * @note The default value is EINA_TRUE.
10673 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10675 * @brief Return true if events are repeat below the notify object
10676 * @param obj the notify object
10678 * @see elm_notify_repeat_events_set()
10680 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10686 * @defgroup Hover Hover
10688 * @image html img/widget/hover/preview-00.png
10689 * @image latex img/widget/hover/preview-00.eps
10691 * A Hover object will hover over its @p parent object at the @p target
10692 * location. Anything in the background will be given a darker coloring to
10693 * indicate that the hover object is on top (at the default theme). When the
10694 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10695 * clicked that @b doesn't cause the hover to be dismissed.
10697 * A Hover object has two parents. One parent that owns it during creation
10698 * and the other parent being the one over which the hover object spans.
10701 * @note The hover object will take up the entire space of @p target
10704 * Elementary has the following styles for the hover widget:
10708 * @li hoversel_vertical
10710 * The following are the available position for content:
10722 * Signals that you can add callbacks for are:
10723 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10724 * @li "smart,changed" - a content object placed under the "smart"
10725 * policy was replaced to a new slot direction.
10727 * See @ref tutorial_hover for more information.
10731 typedef enum _Elm_Hover_Axis
10733 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10734 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10735 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10736 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10739 * @brief Adds a hover object to @p parent
10741 * @param parent The parent object
10742 * @return The hover object or NULL if one could not be created
10744 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10746 * @brief Sets the target object for the hover.
10748 * @param obj The hover object
10749 * @param target The object to center the hover onto.
10751 * This function will cause the hover to be centered on the target object.
10753 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10755 * @brief Gets the target object for the hover.
10757 * @param obj The hover object
10758 * @return The target object for the hover.
10760 * @see elm_hover_target_set()
10762 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10764 * @brief Sets the parent object for the hover.
10766 * @param obj The hover object
10767 * @param parent The object to locate the hover over.
10769 * This function will cause the hover to take up the entire space that the
10770 * parent object fills.
10772 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10774 * @brief Gets the parent object for the hover.
10776 * @param obj The hover object
10777 * @return The parent object to locate the hover over.
10779 * @see elm_hover_parent_set()
10781 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10783 * @brief Sets the content of the hover object and the direction in which it
10786 * @param obj The hover object
10787 * @param swallow The direction that the object will be displayed
10788 * at. Accepted values are "left", "top-left", "top", "top-right",
10789 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10791 * @param content The content to place at @p swallow
10793 * Once the content object is set for a given direction, a previously
10794 * set one (on the same direction) will be deleted. If you want to
10795 * keep that old content object, use the elm_hover_content_unset()
10798 * All directions may have contents at the same time, except for
10799 * "smart". This is a special placement hint and its use case
10800 * independs of the calculations coming from
10801 * elm_hover_best_content_location_get(). Its use is for cases when
10802 * one desires only one hover content, but with a dynamic special
10803 * placement within the hover area. The content's geometry, whenever
10804 * it changes, will be used to decide on a best location, not
10805 * extrapolating the hover's parent object view to show it in (still
10806 * being the hover's target determinant of its medium part -- move and
10807 * resize it to simulate finger sizes, for example). If one of the
10808 * directions other than "smart" are used, a previously content set
10809 * using it will be deleted, and vice-versa.
10811 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10813 * @brief Get the content of the hover object, in a given direction.
10815 * Return the content object which was set for this widget in the
10816 * @p swallow direction.
10818 * @param obj The hover object
10819 * @param swallow The direction that the object was display at.
10820 * @return The content that was being used
10822 * @see elm_hover_content_set()
10824 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10826 * @brief Unset the content of the hover object, in a given direction.
10828 * Unparent and return the content object set at @p swallow direction.
10830 * @param obj The hover object
10831 * @param swallow The direction that the object was display at.
10832 * @return The content that was being used.
10834 * @see elm_hover_content_set()
10836 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10838 * @brief Returns the best swallow location for content in the hover.
10840 * @param obj The hover object
10841 * @param pref_axis The preferred orientation axis for the hover object to use
10842 * @return The edje location to place content into the hover or @c
10845 * Best is defined here as the location at which there is the most available
10848 * @p pref_axis may be one of
10849 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10850 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10851 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10852 * - @c ELM_HOVER_AXIS_BOTH -- both
10854 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10855 * nescessarily be along the horizontal axis("left" or "right"). If
10856 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10857 * be along the vertical axis("top" or "bottom"). Chossing
10858 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10859 * returned position may be in either axis.
10861 * @see elm_hover_content_set()
10863 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10870 * @defgroup Entry Entry
10872 * @image html img/widget/entry/preview-00.png
10873 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10874 * @image html img/widget/entry/preview-01.png
10875 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10876 * @image html img/widget/entry/preview-02.png
10877 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10878 * @image html img/widget/entry/preview-03.png
10879 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10881 * An entry is a convenience widget which shows a box that the user can
10882 * enter text into. Entries by default don't scroll, so they grow to
10883 * accomodate the entire text, resizing the parent window as needed. This
10884 * can be changed with the elm_entry_scrollable_set() function.
10886 * They can also be single line or multi line (the default) and when set
10887 * to multi line mode they support text wrapping in any of the modes
10888 * indicated by #Elm_Wrap_Type.
10890 * Other features include password mode, filtering of inserted text with
10891 * elm_entry_text_filter_append() and related functions, inline "items" and
10892 * formatted markup text.
10894 * @section entry-markup Formatted text
10896 * The markup tags supported by the Entry are defined by the theme, but
10897 * even when writing new themes or extensions it's a good idea to stick to
10898 * a sane default, to maintain coherency and avoid application breakages.
10899 * Currently defined by the default theme are the following tags:
10900 * @li \<br\>: Inserts a line break.
10901 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10903 * @li \<tab\>: Inserts a tab.
10904 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10906 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10907 * @li \<link\>...\</link\>: Underlines the enclosed text.
10908 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10910 * @section entry-special Special markups
10912 * Besides those used to format text, entries support two special markup
10913 * tags used to insert clickable portions of text or items inlined within
10916 * @subsection entry-anchors Anchors
10918 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10919 * \</a\> tags and an event will be generated when this text is clicked,
10923 * This text is outside <a href=anc-01>but this one is an anchor</a>
10926 * The @c href attribute in the opening tag gives the name that will be
10927 * used to identify the anchor and it can be any valid utf8 string.
10929 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10930 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10931 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10932 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10935 * @subsection entry-items Items
10937 * Inlined in the text, any other @c Evas_Object can be inserted by using
10938 * \<item\> tags this way:
10941 * <item size=16x16 vsize=full href=emoticon/haha></item>
10944 * Just like with anchors, the @c href identifies each item, but these need,
10945 * in addition, to indicate their size, which is done using any one of
10946 * @c size, @c absize or @c relsize attributes. These attributes take their
10947 * value in the WxH format, where W is the width and H the height of the
10950 * @li absize: Absolute pixel size for the item. Whatever value is set will
10951 * be the item's size regardless of any scale value the object may have
10952 * been set to. The final line height will be adjusted to fit larger items.
10953 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10955 * @li relsize: Size is adjusted for the item to fit within the current
10958 * Besides their size, items are specificed a @c vsize value that affects
10959 * how their final size and position are calculated. The possible values
10961 * @li ascent: Item will be placed within the line's baseline and its
10962 * ascent. That is, the height between the line where all characters are
10963 * positioned and the highest point in the line. For @c size and @c absize
10964 * items, the descent value will be added to the total line height to make
10965 * them fit. @c relsize items will be adjusted to fit within this space.
10966 * @li full: Items will be placed between the descent and ascent, or the
10967 * lowest point in the line and its highest.
10969 * The next image shows different configurations of items and how
10970 * the previously mentioned options affect their sizes. In all cases,
10971 * the green line indicates the ascent, blue for the baseline and red for
10974 * @image html entry_item.png
10975 * @image latex entry_item.eps width=\textwidth
10977 * And another one to show how size differs from absize. In the first one,
10978 * the scale value is set to 1.0, while the second one is using one of 2.0.
10980 * @image html entry_item_scale.png
10981 * @image latex entry_item_scale.eps width=\textwidth
10983 * After the size for an item is calculated, the entry will request an
10984 * object to place in its space. For this, the functions set with
10985 * elm_entry_item_provider_append() and related functions will be called
10986 * in order until one of them returns a @c non-NULL value. If no providers
10987 * are available, or all of them return @c NULL, then the entry falls back
10988 * to one of the internal defaults, provided the name matches with one of
10991 * All of the following are currently supported:
10994 * - emoticon/angry-shout
10995 * - emoticon/crazy-laugh
10996 * - emoticon/evil-laugh
10998 * - emoticon/goggle-smile
10999 * - emoticon/grumpy
11000 * - emoticon/grumpy-smile
11001 * - emoticon/guilty
11002 * - emoticon/guilty-smile
11004 * - emoticon/half-smile
11005 * - emoticon/happy-panting
11007 * - emoticon/indifferent
11009 * - emoticon/knowing-grin
11011 * - emoticon/little-bit-sorry
11012 * - emoticon/love-lots
11014 * - emoticon/minimal-smile
11015 * - emoticon/not-happy
11016 * - emoticon/not-impressed
11018 * - emoticon/opensmile
11021 * - emoticon/squint-laugh
11022 * - emoticon/surprised
11023 * - emoticon/suspicious
11024 * - emoticon/tongue-dangling
11025 * - emoticon/tongue-poke
11027 * - emoticon/unhappy
11028 * - emoticon/very-sorry
11031 * - emoticon/worried
11034 * Alternatively, an item may reference an image by its path, using
11035 * the URI form @c file:///path/to/an/image.png and the entry will then
11036 * use that image for the item.
11038 * @section entry-files Loading and saving files
11040 * Entries have convinience functions to load text from a file and save
11041 * changes back to it after a short delay. The automatic saving is enabled
11042 * by default, but can be disabled with elm_entry_autosave_set() and files
11043 * can be loaded directly as plain text or have any markup in them
11044 * recognized. See elm_entry_file_set() for more details.
11046 * @section entry-signals Emitted signals
11048 * This widget emits the following signals:
11050 * @li "changed": The text within the entry was changed.
11051 * @li "changed,user": The text within the entry was changed because of user interaction.
11052 * @li "activated": The enter key was pressed on a single line entry.
11053 * @li "press": A mouse button has been pressed on the entry.
11054 * @li "longpressed": A mouse button has been pressed and held for a couple
11056 * @li "clicked": The entry has been clicked (mouse press and release).
11057 * @li "clicked,double": The entry has been double clicked.
11058 * @li "clicked,triple": The entry has been triple clicked.
11059 * @li "focused": The entry has received focus.
11060 * @li "unfocused": The entry has lost focus.
11061 * @li "selection,paste": A paste of the clipboard contents was requested.
11062 * @li "selection,copy": A copy of the selected text into the clipboard was
11064 * @li "selection,cut": A cut of the selected text into the clipboard was
11066 * @li "selection,start": A selection has begun and no previous selection
11068 * @li "selection,changed": The current selection has changed.
11069 * @li "selection,cleared": The current selection has been cleared.
11070 * @li "cursor,changed": The cursor has changed position.
11071 * @li "anchor,clicked": An anchor has been clicked. The event_info
11072 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11073 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11074 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11075 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11076 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11077 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11078 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11079 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11080 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11081 * @li "preedit,changed": The preedit string has changed.
11082 * @li "language,changed": Program language changed.
11084 * @section entry-examples
11086 * An overview of the Entry API can be seen in @ref entry_example_01
11091 * @typedef Elm_Entry_Anchor_Info
11093 * The info sent in the callback for the "anchor,clicked" signals emitted
11096 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11098 * @struct _Elm_Entry_Anchor_Info
11100 * The info sent in the callback for the "anchor,clicked" signals emitted
11103 struct _Elm_Entry_Anchor_Info
11105 const char *name; /**< The name of the anchor, as stated in its href */
11106 int button; /**< The mouse button used to click on it */
11107 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11108 y, /**< Anchor geometry, relative to canvas */
11109 w, /**< Anchor geometry, relative to canvas */
11110 h; /**< Anchor geometry, relative to canvas */
11113 * @typedef Elm_Entry_Filter_Cb
11114 * This callback type is used by entry filters to modify text.
11115 * @param data The data specified as the last param when adding the filter
11116 * @param entry The entry object
11117 * @param text A pointer to the location of the text being filtered. This data can be modified,
11118 * but any additional allocations must be managed by the user.
11119 * @see elm_entry_text_filter_append
11120 * @see elm_entry_text_filter_prepend
11122 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11125 * This adds an entry to @p parent object.
11127 * By default, entries are:
11131 * @li autosave is enabled
11133 * @param parent The parent object
11134 * @return The new object or NULL if it cannot be created
11136 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11138 * Sets the entry to single line mode.
11140 * In single line mode, entries don't ever wrap when the text reaches the
11141 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11142 * key will generate an @c "activate" event instead of adding a new line.
11144 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11145 * and pressing enter will break the text into a different line
11146 * without generating any events.
11148 * @param obj The entry object
11149 * @param single_line If true, the text in the entry
11150 * will be on a single line.
11152 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11154 * Gets whether the entry is set to be single line.
11156 * @param obj The entry object
11157 * @return single_line If true, the text in the entry is set to display
11158 * on a single line.
11160 * @see elm_entry_single_line_set()
11162 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11164 * Sets the entry to password mode.
11166 * In password mode, entries are implicitly single line and the display of
11167 * any text in them is replaced with asterisks (*).
11169 * @param obj The entry object
11170 * @param password If true, password mode is enabled.
11172 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11174 * Gets whether the entry is set to password mode.
11176 * @param obj The entry object
11177 * @return If true, the entry is set to display all characters
11178 * as asterisks (*).
11180 * @see elm_entry_password_set()
11182 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11184 * This sets the text displayed within the entry to @p entry.
11186 * @param obj The entry object
11187 * @param entry The text to be displayed
11189 * @deprecated Use elm_object_text_set() instead.
11190 * @note Using this function bypasses text filters
11192 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11194 * This returns the text currently shown in object @p entry.
11195 * See also elm_entry_entry_set().
11197 * @param obj The entry object
11198 * @return The currently displayed text or NULL on failure
11200 * @deprecated Use elm_object_text_get() instead.
11202 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11204 * Appends @p entry to the text of the entry.
11206 * Adds the text in @p entry to the end of any text already present in the
11209 * The appended text is subject to any filters set for the widget.
11211 * @param obj The entry object
11212 * @param entry The text to be displayed
11214 * @see elm_entry_text_filter_append()
11216 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11218 * Gets whether the entry is empty.
11220 * Empty means no text at all. If there are any markup tags, like an item
11221 * tag for which no provider finds anything, and no text is displayed, this
11222 * function still returns EINA_FALSE.
11224 * @param obj The entry object
11225 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11227 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11229 * Gets any selected text within the entry.
11231 * If there's any selected text in the entry, this function returns it as
11232 * a string in markup format. NULL is returned if no selection exists or
11233 * if an error occurred.
11235 * The returned value points to an internal string and should not be freed
11236 * or modified in any way. If the @p entry object is deleted or its
11237 * contents are changed, the returned pointer should be considered invalid.
11239 * @param obj The entry object
11240 * @return The selected text within the entry or NULL on failure
11242 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11244 * Returns the actual textblock object of the entry.
11246 * This function exposes the internal textblock object that actually
11247 * contains and draws the text. This should be used for low-level
11248 * manipulations that are otherwise not possible.
11250 * Changing the textblock directly from here will not notify edje/elm to
11251 * recalculate the textblock size automatically, so any modifications
11252 * done to the textblock returned by this function should be followed by
11253 * a call to elm_entry_calc_force().
11255 * The return value is marked as const as an additional warning.
11256 * One should not use the returned object with any of the generic evas
11257 * functions (geometry_get/resize/move and etc), but only with the textblock
11258 * functions; The former will either not work at all, or break the correct
11261 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11262 * the internal textblock object. Do NOT cache the returned object, and try
11263 * not to mix calls on this object with regular elm_entry calls (which may
11264 * change the internal textblock object). This applies to all cursors
11265 * returned from textblock calls, and all the other derivative values.
11267 * @param obj The entry object
11268 * @return The textblock object.
11270 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11272 * Forces calculation of the entry size and text layouting.
11274 * This should be used after modifying the textblock object directly. See
11275 * elm_entry_textblock_get() for more information.
11277 * @param obj The entry object
11279 * @see elm_entry_textblock_get()
11281 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11283 * Inserts the given text into the entry at the current cursor position.
11285 * This inserts text at the cursor position as if it was typed
11286 * by the user (note that this also allows markup which a user
11287 * can't just "type" as it would be converted to escaped text, so this
11288 * call can be used to insert things like emoticon items or bold push/pop
11289 * tags, other font and color change tags etc.)
11291 * If any selection exists, it will be replaced by the inserted text.
11293 * The inserted text is subject to any filters set for the widget.
11295 * @param obj The entry object
11296 * @param entry The text to insert
11298 * @see elm_entry_text_filter_append()
11300 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11302 * Set the line wrap type to use on multi-line entries.
11304 * Sets the wrap type used by the entry to any of the specified in
11305 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11306 * line (without inserting a line break or paragraph separator) when it
11307 * reaches the far edge of the widget.
11309 * Note that this only makes sense for multi-line entries. A widget set
11310 * to be single line will never wrap.
11312 * @param obj The entry object
11313 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11315 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11316 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11318 * Gets the wrap mode the entry was set to use.
11320 * @param obj The entry object
11321 * @return Wrap type
11323 * @see also elm_entry_line_wrap_set()
11325 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11327 * Sets if the entry is to be editable or not.
11329 * By default, entries are editable and when focused, any text input by the
11330 * user will be inserted at the current cursor position. But calling this
11331 * function with @p editable as EINA_FALSE will prevent the user from
11332 * inputting text into the entry.
11334 * The only way to change the text of a non-editable entry is to use
11335 * elm_object_text_set(), elm_entry_entry_insert() and other related
11338 * @param obj The entry object
11339 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11340 * if not, the entry is read-only and no user input is allowed.
11342 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11344 * Gets whether the entry is editable or not.
11346 * @param obj The entry object
11347 * @return If true, the entry is editable by the user.
11348 * If false, it is not editable by the user
11350 * @see elm_entry_editable_set()
11352 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11354 * This drops any existing text selection within the entry.
11356 * @param obj The entry object
11358 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11360 * This selects all text within the entry.
11362 * @param obj The entry object
11364 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11366 * This moves the cursor one place to the right within the entry.
11368 * @param obj The entry object
11369 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11371 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11373 * This moves the cursor one place to the left within the entry.
11375 * @param obj The entry object
11376 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11378 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11380 * This moves the cursor one line up within the entry.
11382 * @param obj The entry object
11383 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11385 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11387 * This moves the cursor one line down within the entry.
11389 * @param obj The entry object
11390 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11392 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11394 * This moves the cursor to the beginning of the entry.
11396 * @param obj The entry object
11398 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11400 * This moves the cursor to the end of the entry.
11402 * @param obj The entry object
11404 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11406 * This moves the cursor to the beginning of the current line.
11408 * @param obj The entry object
11410 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11412 * This moves the cursor to the end of the current line.
11414 * @param obj The entry object
11416 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11418 * This begins a selection within the entry as though
11419 * the user were holding down the mouse button to make a selection.
11421 * @param obj The entry object
11423 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11425 * This ends a selection within the entry as though
11426 * the user had just released the mouse button while making a selection.
11428 * @param obj The entry object
11430 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11432 * Gets whether a format node exists at the current cursor position.
11434 * A format node is anything that defines how the text is rendered. It can
11435 * be a visible format node, such as a line break or a paragraph separator,
11436 * or an invisible one, such as bold begin or end tag.
11437 * This function returns whether any format node exists at the current
11440 * @param obj The entry object
11441 * @return EINA_TRUE if the current cursor position contains a format node,
11442 * EINA_FALSE otherwise.
11444 * @see elm_entry_cursor_is_visible_format_get()
11446 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11448 * Gets if the current cursor position holds a visible format node.
11450 * @param obj The entry object
11451 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11452 * if it's an invisible one or no format exists.
11454 * @see elm_entry_cursor_is_format_get()
11456 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11458 * Gets the character pointed by the cursor at its current position.
11460 * This function returns a string with the utf8 character stored at the
11461 * current cursor position.
11462 * Only the text is returned, any format that may exist will not be part
11463 * of the return value.
11465 * @param obj The entry object
11466 * @return The text pointed by the cursors.
11468 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11470 * This function returns the geometry of the cursor.
11472 * It's useful if you want to draw something on the cursor (or where it is),
11473 * or for example in the case of scrolled entry where you want to show the
11476 * @param obj The entry object
11477 * @param x returned geometry
11478 * @param y returned geometry
11479 * @param w returned geometry
11480 * @param h returned geometry
11481 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11483 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);
11485 * Sets the cursor position in the entry to the given value
11487 * The value in @p pos is the index of the character position within the
11488 * contents of the string as returned by elm_entry_cursor_pos_get().
11490 * @param obj The entry object
11491 * @param pos The position of the cursor
11493 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11495 * Retrieves the current position of the cursor in the entry
11497 * @param obj The entry object
11498 * @return The cursor position
11500 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11502 * This executes a "cut" action on the selected text in the entry.
11504 * @param obj The entry object
11506 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11508 * This executes a "copy" action on the selected text in the entry.
11510 * @param obj The entry object
11512 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11514 * This executes a "paste" action in the entry.
11516 * @param obj The entry object
11518 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11520 * This clears and frees the items in a entry's contextual (longpress)
11523 * @param obj The entry object
11525 * @see elm_entry_context_menu_item_add()
11527 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11529 * This adds an item to the entry's contextual menu.
11531 * A longpress on an entry will make the contextual menu show up, if this
11532 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11533 * By default, this menu provides a few options like enabling selection mode,
11534 * which is useful on embedded devices that need to be explicit about it,
11535 * and when a selection exists it also shows the copy and cut actions.
11537 * With this function, developers can add other options to this menu to
11538 * perform any action they deem necessary.
11540 * @param obj The entry object
11541 * @param label The item's text label
11542 * @param icon_file The item's icon file
11543 * @param icon_type The item's icon type
11544 * @param func The callback to execute when the item is clicked
11545 * @param data The data to associate with the item for related functions
11547 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);
11549 * This disables the entry's contextual (longpress) menu.
11551 * @param obj The entry object
11552 * @param disabled If true, the menu is disabled
11554 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11556 * This returns whether the entry's contextual (longpress) menu is
11559 * @param obj The entry object
11560 * @return If true, the menu is disabled
11562 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11564 * This appends a custom item provider to the list for that entry
11566 * This appends the given callback. The list is walked from beginning to end
11567 * with each function called given the item href string in the text. If the
11568 * function returns an object handle other than NULL (it should create an
11569 * object to do this), then this object is used to replace that item. If
11570 * not the next provider is called until one provides an item object, or the
11571 * default provider in entry does.
11573 * @param obj The entry object
11574 * @param func The function called to provide the item object
11575 * @param data The data passed to @p func
11577 * @see @ref entry-items
11579 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);
11581 * This prepends a custom item provider to the list for that entry
11583 * This prepends the given callback. See elm_entry_item_provider_append() for
11586 * @param obj The entry object
11587 * @param func The function called to provide the item object
11588 * @param data The data passed to @p func
11590 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);
11592 * This removes a custom item provider to the list for that entry
11594 * This removes the given callback. See elm_entry_item_provider_append() for
11597 * @param obj The entry object
11598 * @param func The function called to provide the item object
11599 * @param data The data passed to @p func
11601 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);
11603 * Append a filter function for text inserted in the entry
11605 * Append the given callback to the list. This functions will be called
11606 * whenever any text is inserted into the entry, with the text to be inserted
11607 * as a parameter. The callback function is free to alter the text in any way
11608 * it wants, but it must remember to free the given pointer and update it.
11609 * If the new text is to be discarded, the function can free it and set its
11610 * text parameter to NULL. This will also prevent any following filters from
11613 * @param obj The entry object
11614 * @param func The function to use as text filter
11615 * @param data User data to pass to @p func
11617 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11619 * Prepend a filter function for text insdrted in the entry
11621 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11622 * for more information
11624 * @param obj The entry object
11625 * @param func The function to use as text filter
11626 * @param data User data to pass to @p func
11628 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11630 * Remove a filter from the list
11632 * Removes the given callback from the filter list. See
11633 * elm_entry_text_filter_append() for more information.
11635 * @param obj The entry object
11636 * @param func The filter function to remove
11637 * @param data The user data passed when adding the function
11639 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11641 * This converts a markup (HTML-like) string into UTF-8.
11643 * The returned string is a malloc'ed buffer and it should be freed when
11644 * not needed anymore.
11646 * @param s The string (in markup) to be converted
11647 * @return The converted string (in UTF-8). It should be freed.
11649 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11651 * This converts a UTF-8 string into markup (HTML-like).
11653 * The returned string is a malloc'ed buffer and it should be freed when
11654 * not needed anymore.
11656 * @param s The string (in UTF-8) to be converted
11657 * @return The converted string (in markup). It should be freed.
11659 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11661 * This sets the file (and implicitly loads it) for the text to display and
11662 * then edit. All changes are written back to the file after a short delay if
11663 * the entry object is set to autosave (which is the default).
11665 * If the entry had any other file set previously, any changes made to it
11666 * will be saved if the autosave feature is enabled, otherwise, the file
11667 * will be silently discarded and any non-saved changes will be lost.
11669 * @param obj The entry object
11670 * @param file The path to the file to load and save
11671 * @param format The file format
11673 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11675 * Gets the file being edited by the entry.
11677 * This function can be used to retrieve any file set on the entry for
11678 * edition, along with the format used to load and save it.
11680 * @param obj The entry object
11681 * @param file The path to the file to load and save
11682 * @param format The file format
11684 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11686 * This function writes any changes made to the file set with
11687 * elm_entry_file_set()
11689 * @param obj The entry object
11691 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11693 * This sets the entry object to 'autosave' the loaded text file or not.
11695 * @param obj The entry object
11696 * @param autosave Autosave the loaded file or not
11698 * @see elm_entry_file_set()
11700 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11702 * This gets the entry object's 'autosave' status.
11704 * @param obj The entry object
11705 * @return Autosave the loaded file or not
11707 * @see elm_entry_file_set()
11709 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11712 * @enum _Elm_CNP_Mode
11713 * @typedef Elm_CNP_Mode
11714 * Enum of entry's copy & paste policy.
11716 * @see elm_entry_cnp_mode_set()
11717 * @see elm_entry_cnp_mode_get()
11719 typedef enum _Elm_CNP_Mode {
11720 ELM_CNP_MODE_MARKUP = 0, /**< copy & paste text with markup tag */
11721 ELM_CNP_MODE_NO_IMAGE = 1, /**< copy & paste text without item(image) tag */
11722 ELM_CNP_MODE_PLAINTEXT = 2 /**< copy & paste text without markup tag */
11726 * Control pasting of text and images for the widget.
11728 * Normally the entry allows both text and images to be pasted.
11729 * By setting textonly to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
11730 * By setting textonly to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
11732 * @note this only changes the behaviour of text.
11734 * @param obj The entry object
11735 * @param mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11736 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11738 EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_CNP_Mode cnp_mode) EINA_ARG_NONNULL(1);
11740 * Getting elm_entry text paste/drop mode.
11742 * Normally the entry allows both text and images to be pasted.
11743 * This gets the copy & paste mode of the entry.
11745 * @param obj The entry object
11746 * @return mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11747 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11749 EAPI Elm_CNP_Mode elm_entry_cnp_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11752 * Control pasting of text and images for the widget.
11754 * Normally the entry allows both text and images to be pasted. By setting
11755 * textonly to be true, this prevents images from being pasted.
11757 * Note this only changes the behaviour of text.
11759 * @param obj The entry object
11760 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11761 * text+image+other.
11763 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11765 * Getting elm_entry text paste/drop mode.
11767 * In textonly mode, only text may be pasted or dropped into the widget.
11769 * @param obj The entry object
11770 * @return If the widget only accepts text from pastes.
11772 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11774 * Enable or disable scrolling in entry
11776 * Normally the entry is not scrollable unless you enable it with this call.
11778 * @param obj The entry object
11779 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11781 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11783 * Get the scrollable state of the entry
11785 * Normally the entry is not scrollable. This gets the scrollable state
11786 * of the entry. See elm_entry_scrollable_set() for more information.
11788 * @param obj The entry object
11789 * @return The scrollable state
11791 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11793 * This sets a widget to be displayed to the left of a scrolled entry.
11795 * @param obj The scrolled entry object
11796 * @param icon The widget to display on the left side of the scrolled
11799 * @note A previously set widget will be destroyed.
11800 * @note If the object being set does not have minimum size hints set,
11801 * it won't get properly displayed.
11803 * @see elm_entry_end_set()
11805 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11807 * Gets the leftmost widget of the scrolled entry. This object is
11808 * owned by the scrolled entry and should not be modified.
11810 * @param obj The scrolled entry object
11811 * @return the left widget inside the scroller
11813 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11815 * Unset the leftmost widget of the scrolled entry, unparenting and
11818 * @param obj The scrolled entry object
11819 * @return the previously set icon sub-object of this entry, on
11822 * @see elm_entry_icon_set()
11824 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11826 * Sets the visibility of the left-side widget of the scrolled entry,
11827 * set by elm_entry_icon_set().
11829 * @param obj The scrolled entry object
11830 * @param setting EINA_TRUE if the object should be displayed,
11831 * EINA_FALSE if not.
11833 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11835 * This sets a widget to be displayed to the end of a scrolled entry.
11837 * @param obj The scrolled entry object
11838 * @param end The widget to display on the right side of the scrolled
11841 * @note A previously set widget will be destroyed.
11842 * @note If the object being set does not have minimum size hints set,
11843 * it won't get properly displayed.
11845 * @see elm_entry_icon_set
11847 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11849 * Gets the endmost widget of the scrolled entry. This object is owned
11850 * by the scrolled entry and should not be modified.
11852 * @param obj The scrolled entry object
11853 * @return the right widget inside the scroller
11855 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11857 * Unset the endmost widget of the scrolled entry, unparenting and
11860 * @param obj The scrolled entry object
11861 * @return the previously set icon sub-object of this entry, on
11864 * @see elm_entry_icon_set()
11866 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11868 * Sets the visibility of the end widget of the scrolled entry, set by
11869 * elm_entry_end_set().
11871 * @param obj The scrolled entry object
11872 * @param setting EINA_TRUE if the object should be displayed,
11873 * EINA_FALSE if not.
11875 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11877 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11880 * Setting an entry to single-line mode with elm_entry_single_line_set()
11881 * will automatically disable the display of scrollbars when the entry
11882 * moves inside its scroller.
11884 * @param obj The scrolled entry object
11885 * @param h The horizontal scrollbar policy to apply
11886 * @param v The vertical scrollbar policy to apply
11888 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11890 * This enables/disables bouncing within the entry.
11892 * This function sets whether the entry will bounce when scrolling reaches
11893 * the end of the contained entry.
11895 * @param obj The scrolled entry object
11896 * @param h The horizontal bounce state
11897 * @param v The vertical bounce state
11899 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11901 * Get the bounce mode
11903 * @param obj The Entry object
11904 * @param h_bounce Allow bounce horizontally
11905 * @param v_bounce Allow bounce vertically
11907 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11909 /* pre-made filters for entries */
11911 * @typedef Elm_Entry_Filter_Limit_Size
11913 * Data for the elm_entry_filter_limit_size() entry filter.
11915 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11917 * @struct _Elm_Entry_Filter_Limit_Size
11919 * Data for the elm_entry_filter_limit_size() entry filter.
11921 struct _Elm_Entry_Filter_Limit_Size
11923 int max_char_count; /**< The maximum number of characters allowed. */
11924 int max_byte_count; /**< The maximum number of bytes allowed*/
11927 * Filter inserted text based on user defined character and byte limits
11929 * Add this filter to an entry to limit the characters that it will accept
11930 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11931 * The funtion works on the UTF-8 representation of the string, converting
11932 * it from the set markup, thus not accounting for any format in it.
11934 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11935 * it as data when setting the filter. In it, it's possible to set limits
11936 * by character count or bytes (any of them is disabled if 0), and both can
11937 * be set at the same time. In that case, it first checks for characters,
11940 * The function will cut the inserted text in order to allow only the first
11941 * number of characters that are still allowed. The cut is made in
11942 * characters, even when limiting by bytes, in order to always contain
11943 * valid ones and avoid half unicode characters making it in.
11945 * This filter, like any others, does not apply when setting the entry text
11946 * directly with elm_object_text_set() (or the deprecated
11947 * elm_entry_entry_set()).
11949 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11951 * @typedef Elm_Entry_Filter_Accept_Set
11953 * Data for the elm_entry_filter_accept_set() entry filter.
11955 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11957 * @struct _Elm_Entry_Filter_Accept_Set
11959 * Data for the elm_entry_filter_accept_set() entry filter.
11961 struct _Elm_Entry_Filter_Accept_Set
11963 const char *accepted; /**< Set of characters accepted in the entry. */
11964 const char *rejected; /**< Set of characters rejected from the entry. */
11967 * Filter inserted text based on accepted or rejected sets of characters
11969 * Add this filter to an entry to restrict the set of accepted characters
11970 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11971 * This structure contains both accepted and rejected sets, but they are
11972 * mutually exclusive.
11974 * The @c accepted set takes preference, so if it is set, the filter will
11975 * only work based on the accepted characters, ignoring anything in the
11976 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11978 * In both cases, the function filters by matching utf8 characters to the
11979 * raw markup text, so it can be used to remove formatting tags.
11981 * This filter, like any others, does not apply when setting the entry text
11982 * directly with elm_object_text_set() (or the deprecated
11983 * elm_entry_entry_set()).
11985 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11987 * Set the input panel layout of the entry
11989 * @param obj The entry object
11990 * @param layout layout type
11992 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11994 * Get the input panel layout of the entry
11996 * @param obj The entry object
11997 * @return layout type
11999 * @see elm_entry_input_panel_layout_set
12001 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12003 * Set the autocapitalization type on the immodule.
12005 * @param obj The entry object
12006 * @param autocapital_type The type of autocapitalization
12008 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12010 * Retrieve the autocapitalization type on the immodule.
12012 * @param obj The entry object
12013 * @return autocapitalization type
12015 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12017 * Sets the attribute to show the input panel automatically.
12019 * @param obj The entry object
12020 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12022 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12024 * Retrieve the attribute to show the input panel automatically.
12026 * @param obj The entry object
12027 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12029 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12031 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
12032 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
12033 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
12034 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
12035 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
12036 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
12037 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
12039 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
12040 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
12041 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
12042 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
12043 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
12049 /* composite widgets - these basically put together basic widgets above
12050 * in convenient packages that do more than basic stuff */
12054 * @defgroup Anchorview Anchorview
12056 * @image html img/widget/anchorview/preview-00.png
12057 * @image latex img/widget/anchorview/preview-00.eps
12059 * Anchorview is for displaying text that contains markup with anchors
12060 * like <c>\<a href=1234\>something\</\></c> in it.
12062 * Besides being styled differently, the anchorview widget provides the
12063 * necessary functionality so that clicking on these anchors brings up a
12064 * popup with user defined content such as "call", "add to contacts" or
12065 * "open web page". This popup is provided using the @ref Hover widget.
12067 * This widget is very similar to @ref Anchorblock, so refer to that
12068 * widget for an example. The only difference Anchorview has is that the
12069 * widget is already provided with scrolling functionality, so if the
12070 * text set to it is too large to fit in the given space, it will scroll,
12071 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12072 * text can be displayed.
12074 * This widget emits the following signals:
12075 * @li "anchor,clicked": will be called when an anchor is clicked. The
12076 * @p event_info parameter on the callback will be a pointer of type
12077 * ::Elm_Entry_Anchorview_Info.
12079 * See @ref Anchorblock for an example on how to use both of them.
12088 * @typedef Elm_Entry_Anchorview_Info
12090 * The info sent in the callback for "anchor,clicked" signals emitted by
12091 * the Anchorview widget.
12093 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12095 * @struct _Elm_Entry_Anchorview_Info
12097 * The info sent in the callback for "anchor,clicked" signals emitted by
12098 * the Anchorview widget.
12100 struct _Elm_Entry_Anchorview_Info
12102 const char *name; /**< Name of the anchor, as indicated in its href
12104 int button; /**< The mouse button used to click on it */
12105 Evas_Object *hover; /**< The hover object to use for the popup */
12107 Evas_Coord x, y, w, h;
12108 } anchor, /**< Geometry selection of text used as anchor */
12109 hover_parent; /**< Geometry of the object used as parent by the
12111 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12112 for content on the left side of
12113 the hover. Before calling the
12114 callback, the widget will make the
12115 necessary calculations to check
12116 which sides are fit to be set with
12117 content, based on the position the
12118 hover is activated and its distance
12119 to the edges of its parent object
12121 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12122 the right side of the hover.
12123 See @ref hover_left */
12124 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12125 of the hover. See @ref hover_left */
12126 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12127 below the hover. See @ref
12131 * Add a new Anchorview object
12133 * @param parent The parent object
12134 * @return The new object or NULL if it cannot be created
12136 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12138 * Set the text to show in the anchorview
12140 * Sets the text of the anchorview to @p text. This text can include markup
12141 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12142 * text that will be specially styled and react to click events, ended with
12143 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12144 * "anchor,clicked" signal that you can attach a callback to with
12145 * evas_object_smart_callback_add(). The name of the anchor given in the
12146 * event info struct will be the one set in the href attribute, in this
12147 * case, anchorname.
12149 * Other markup can be used to style the text in different ways, but it's
12150 * up to the style defined in the theme which tags do what.
12151 * @deprecated use elm_object_text_set() instead.
12153 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12155 * Get the markup text set for the anchorview
12157 * Retrieves the text set on the anchorview, with markup tags included.
12159 * @param obj The anchorview object
12160 * @return The markup text set or @c NULL if nothing was set or an error
12162 * @deprecated use elm_object_text_set() instead.
12164 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12166 * Set the parent of the hover popup
12168 * Sets the parent object to use by the hover created by the anchorview
12169 * when an anchor is clicked. See @ref Hover for more details on this.
12170 * If no parent is set, the same anchorview object will be used.
12172 * @param obj The anchorview object
12173 * @param parent The object to use as parent for the hover
12175 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12177 * Get the parent of the hover popup
12179 * Get the object used as parent for the hover created by the anchorview
12180 * widget. See @ref Hover for more details on this.
12182 * @param obj The anchorview object
12183 * @return The object used as parent for the hover, NULL if none is set.
12185 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12187 * Set the style that the hover should use
12189 * When creating the popup hover, anchorview will request that it's
12190 * themed according to @p style.
12192 * @param obj The anchorview object
12193 * @param style The style to use for the underlying hover
12195 * @see elm_object_style_set()
12197 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12199 * Get the style that the hover should use
12201 * Get the style the hover created by anchorview will use.
12203 * @param obj The anchorview object
12204 * @return The style to use by the hover. NULL means the default is used.
12206 * @see elm_object_style_set()
12208 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12210 * Ends the hover popup in the anchorview
12212 * When an anchor is clicked, the anchorview widget will create a hover
12213 * object to use as a popup with user provided content. This function
12214 * terminates this popup, returning the anchorview to its normal state.
12216 * @param obj The anchorview object
12218 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12220 * Set bouncing behaviour when the scrolled content reaches an edge
12222 * Tell the internal scroller object whether it should bounce or not
12223 * when it reaches the respective edges for each axis.
12225 * @param obj The anchorview object
12226 * @param h_bounce Whether to bounce or not in the horizontal axis
12227 * @param v_bounce Whether to bounce or not in the vertical axis
12229 * @see elm_scroller_bounce_set()
12231 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12233 * Get the set bouncing behaviour of the internal scroller
12235 * Get whether the internal scroller should bounce when the edge of each
12236 * axis is reached scrolling.
12238 * @param obj The anchorview object
12239 * @param h_bounce Pointer where to store the bounce state of the horizontal
12241 * @param v_bounce Pointer where to store the bounce state of the vertical
12244 * @see elm_scroller_bounce_get()
12246 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12248 * Appends a custom item provider to the given anchorview
12250 * Appends the given function to the list of items providers. This list is
12251 * called, one function at a time, with the given @p data pointer, the
12252 * anchorview object and, in the @p item parameter, the item name as
12253 * referenced in its href string. Following functions in the list will be
12254 * called in order until one of them returns something different to NULL,
12255 * which should be an Evas_Object which will be used in place of the item
12258 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12259 * href=item/name\>\</item\>
12261 * @param obj The anchorview object
12262 * @param func The function to add to the list of providers
12263 * @param data User data that will be passed to the callback function
12265 * @see elm_entry_item_provider_append()
12267 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);
12269 * Prepend a custom item provider to the given anchorview
12271 * Like elm_anchorview_item_provider_append(), but it adds the function
12272 * @p func to the beginning of the list, instead of the end.
12274 * @param obj The anchorview object
12275 * @param func The function to add to the list of providers
12276 * @param data User data that will be passed to the callback function
12278 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);
12280 * Remove a custom item provider from the list of the given anchorview
12282 * Removes the function and data pairing that matches @p func and @p data.
12283 * That is, unless the same function and same user data are given, the
12284 * function will not be removed from the list. This allows us to add the
12285 * same callback several times, with different @p data pointers and be
12286 * able to remove them later without conflicts.
12288 * @param obj The anchorview object
12289 * @param func The function to remove from the list
12290 * @param data The data matching the function to remove from the list
12292 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);
12299 * @defgroup Anchorblock Anchorblock
12301 * @image html img/widget/anchorblock/preview-00.png
12302 * @image latex img/widget/anchorblock/preview-00.eps
12304 * Anchorblock is for displaying text that contains markup with anchors
12305 * like <c>\<a href=1234\>something\</\></c> in it.
12307 * Besides being styled differently, the anchorblock widget provides the
12308 * necessary functionality so that clicking on these anchors brings up a
12309 * popup with user defined content such as "call", "add to contacts" or
12310 * "open web page". This popup is provided using the @ref Hover widget.
12312 * This widget emits the following signals:
12313 * @li "anchor,clicked": will be called when an anchor is clicked. The
12314 * @p event_info parameter on the callback will be a pointer of type
12315 * ::Elm_Entry_Anchorblock_Info.
12321 * Since examples are usually better than plain words, we might as well
12322 * try @ref tutorial_anchorblock_example "one".
12325 * @addtogroup Anchorblock
12329 * @typedef Elm_Entry_Anchorblock_Info
12331 * The info sent in the callback for "anchor,clicked" signals emitted by
12332 * the Anchorblock widget.
12334 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12336 * @struct _Elm_Entry_Anchorblock_Info
12338 * The info sent in the callback for "anchor,clicked" signals emitted by
12339 * the Anchorblock widget.
12341 struct _Elm_Entry_Anchorblock_Info
12343 const char *name; /**< Name of the anchor, as indicated in its href
12345 int button; /**< The mouse button used to click on it */
12346 Evas_Object *hover; /**< The hover object to use for the popup */
12348 Evas_Coord x, y, w, h;
12349 } anchor, /**< Geometry selection of text used as anchor */
12350 hover_parent; /**< Geometry of the object used as parent by the
12352 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12353 for content on the left side of
12354 the hover. Before calling the
12355 callback, the widget will make the
12356 necessary calculations to check
12357 which sides are fit to be set with
12358 content, based on the position the
12359 hover is activated and its distance
12360 to the edges of its parent object
12362 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12363 the right side of the hover.
12364 See @ref hover_left */
12365 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12366 of the hover. See @ref hover_left */
12367 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12368 below the hover. See @ref
12372 * Add a new Anchorblock object
12374 * @param parent The parent object
12375 * @return The new object or NULL if it cannot be created
12377 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12379 * Set the text to show in the anchorblock
12381 * Sets the text of the anchorblock to @p text. This text can include markup
12382 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12383 * of text that will be specially styled and react to click events, ended
12384 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12385 * "anchor,clicked" signal that you can attach a callback to with
12386 * evas_object_smart_callback_add(). The name of the anchor given in the
12387 * event info struct will be the one set in the href attribute, in this
12388 * case, anchorname.
12390 * Other markup can be used to style the text in different ways, but it's
12391 * up to the style defined in the theme which tags do what.
12392 * @deprecated use elm_object_text_set() instead.
12394 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12396 * Get the markup text set for the anchorblock
12398 * Retrieves the text set on the anchorblock, with markup tags included.
12400 * @param obj The anchorblock object
12401 * @return The markup text set or @c NULL if nothing was set or an error
12403 * @deprecated use elm_object_text_set() instead.
12405 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12407 * Set the parent of the hover popup
12409 * Sets the parent object to use by the hover created by the anchorblock
12410 * when an anchor is clicked. See @ref Hover for more details on this.
12412 * @param obj The anchorblock object
12413 * @param parent The object to use as parent for the hover
12415 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12417 * Get the parent of the hover popup
12419 * Get the object used as parent for the hover created by the anchorblock
12420 * widget. See @ref Hover for more details on this.
12421 * If no parent is set, the same anchorblock object will be used.
12423 * @param obj The anchorblock object
12424 * @return The object used as parent for the hover, NULL if none is set.
12426 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12428 * Set the style that the hover should use
12430 * When creating the popup hover, anchorblock will request that it's
12431 * themed according to @p style.
12433 * @param obj The anchorblock object
12434 * @param style The style to use for the underlying hover
12436 * @see elm_object_style_set()
12438 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12440 * Get the style that the hover should use
12442 * Get the style, the hover created by anchorblock will use.
12444 * @param obj The anchorblock object
12445 * @return The style to use by the hover. NULL means the default is used.
12447 * @see elm_object_style_set()
12449 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12451 * Ends the hover popup in the anchorblock
12453 * When an anchor is clicked, the anchorblock widget will create a hover
12454 * object to use as a popup with user provided content. This function
12455 * terminates this popup, returning the anchorblock to its normal state.
12457 * @param obj The anchorblock object
12459 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12461 * Appends a custom item provider to the given anchorblock
12463 * Appends the given function to the list of items providers. This list is
12464 * called, one function at a time, with the given @p data pointer, the
12465 * anchorblock object and, in the @p item parameter, the item name as
12466 * referenced in its href string. Following functions in the list will be
12467 * called in order until one of them returns something different to NULL,
12468 * which should be an Evas_Object which will be used in place of the item
12471 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12472 * href=item/name\>\</item\>
12474 * @param obj The anchorblock object
12475 * @param func The function to add to the list of providers
12476 * @param data User data that will be passed to the callback function
12478 * @see elm_entry_item_provider_append()
12480 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);
12482 * Prepend a custom item provider to the given anchorblock
12484 * Like elm_anchorblock_item_provider_append(), but it adds the function
12485 * @p func to the beginning of the list, instead of the end.
12487 * @param obj The anchorblock object
12488 * @param func The function to add to the list of providers
12489 * @param data User data that will be passed to the callback function
12491 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);
12493 * Remove a custom item provider from the list of the given anchorblock
12495 * Removes the function and data pairing that matches @p func and @p data.
12496 * That is, unless the same function and same user data are given, the
12497 * function will not be removed from the list. This allows us to add the
12498 * same callback several times, with different @p data pointers and be
12499 * able to remove them later without conflicts.
12501 * @param obj The anchorblock object
12502 * @param func The function to remove from the list
12503 * @param data The data matching the function to remove from the list
12505 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);
12511 * @defgroup Bubble Bubble
12513 * @image html img/widget/bubble/preview-00.png
12514 * @image latex img/widget/bubble/preview-00.eps
12515 * @image html img/widget/bubble/preview-01.png
12516 * @image latex img/widget/bubble/preview-01.eps
12517 * @image html img/widget/bubble/preview-02.png
12518 * @image latex img/widget/bubble/preview-02.eps
12520 * @brief The Bubble is a widget to show text similar to how speech is
12521 * represented in comics.
12523 * The bubble widget contains 5 important visual elements:
12524 * @li The frame is a rectangle with rounded edjes and an "arrow".
12525 * @li The @p icon is an image to which the frame's arrow points to.
12526 * @li The @p label is a text which appears to the right of the icon if the
12527 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12529 * @li The @p info is a text which appears to the right of the label. Info's
12530 * font is of a ligther color than label.
12531 * @li The @p content is an evas object that is shown inside the frame.
12533 * The position of the arrow, icon, label and info depends on which corner is
12534 * selected. The four available corners are:
12535 * @li "top_left" - Default
12537 * @li "bottom_left"
12538 * @li "bottom_right"
12540 * Signals that you can add callbacks for are:
12541 * @li "clicked" - This is called when a user has clicked the bubble.
12543 * Default contents parts of the bubble that you can use for are:
12544 * @li "default" - A content of the bubble
12545 * @li "icon" - An icon of the bubble
12547 * Default text parts of the button widget that you can use for are:
12548 * @li NULL - Label of the bubble
12550 * For an example of using a buble see @ref bubble_01_example_page "this".
12556 * Add a new bubble to the parent
12558 * @param parent The parent object
12559 * @return The new object or NULL if it cannot be created
12561 * This function adds a text bubble to the given parent evas object.
12563 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12565 * Set the label of the bubble
12567 * @param obj The bubble object
12568 * @param label The string to set in the label
12570 * This function sets the title of the bubble. Where this appears depends on
12571 * the selected corner.
12572 * @deprecated use elm_object_text_set() instead.
12574 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12576 * Get the label of the bubble
12578 * @param obj The bubble object
12579 * @return The string of set in the label
12581 * This function gets the title of the bubble.
12582 * @deprecated use elm_object_text_get() instead.
12584 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12586 * Set the info of the bubble
12588 * @param obj The bubble object
12589 * @param info The given info about the bubble
12591 * This function sets the info of the bubble. Where this appears depends on
12592 * the selected corner.
12593 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12595 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12597 * Get the info of the bubble
12599 * @param obj The bubble object
12601 * @return The "info" string of the bubble
12603 * This function gets the info text.
12604 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12606 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12608 * Set the content to be shown in the bubble
12610 * Once the content object is set, a previously set one will be deleted.
12611 * If you want to keep the old content object, use the
12612 * elm_bubble_content_unset() function.
12614 * @param obj The bubble object
12615 * @param content The given content of the bubble
12617 * This function sets the content shown on the middle of the bubble.
12619 * @deprecated use elm_object_content_set() instead
12622 WILL_DEPRECATE EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12624 * Get the content shown in the bubble
12626 * Return the content object which is set for this widget.
12628 * @param obj The bubble object
12629 * @return The content that is being used
12631 * @deprecated use elm_object_content_get() instead
12634 WILL_DEPRECATE EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12636 * Unset the content shown in the bubble
12638 * Unparent and return the content object which was set for this widget.
12640 * @param obj The bubble object
12641 * @return The content that was being used
12643 * @deprecated use elm_object_content_unset() instead
12646 WILL_DEPRECATE EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12648 * Set the icon of the bubble
12650 * Once the icon object is set, a previously set one will be deleted.
12651 * If you want to keep the old content object, use the
12652 * elm_icon_content_unset() function.
12654 * @param obj The bubble object
12655 * @param icon The given icon for the bubble
12657 * @deprecated use elm_object_part_content_set() instead
12660 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12662 * Get the icon of the bubble
12664 * @param obj The bubble object
12665 * @return The icon for the bubble
12667 * This function gets the icon shown on the top left of bubble.
12669 * @deprecated use elm_object_part_content_get() instead
12672 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12674 * Unset the icon of the bubble
12676 * Unparent and return the icon object which was set for this widget.
12678 * @param obj The bubble object
12679 * @return The icon that was being used
12681 * @deprecated use elm_object_part_content_unset() instead
12684 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12686 * Set the corner of the bubble
12688 * @param obj The bubble object.
12689 * @param corner The given corner for the bubble.
12691 * This function sets the corner of the bubble. The corner will be used to
12692 * determine where the arrow in the frame points to and where label, icon and
12695 * Possible values for corner are:
12696 * @li "top_left" - Default
12698 * @li "bottom_left"
12699 * @li "bottom_right"
12701 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12703 * Get the corner of the bubble
12705 * @param obj The bubble object.
12706 * @return The given corner for the bubble.
12708 * This function gets the selected corner of the bubble.
12710 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12712 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12713 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12720 * @defgroup Photo Photo
12722 * For displaying the photo of a person (contact). Simple, yet
12723 * with a very specific purpose.
12725 * Signals that you can add callbacks for are:
12727 * "clicked" - This is called when a user has clicked the photo
12728 * "drag,start" - Someone started dragging the image out of the object
12729 * "drag,end" - Dragged item was dropped (somewhere)
12735 * Add a new photo to the parent
12737 * @param parent The parent object
12738 * @return The new object or NULL if it cannot be created
12742 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12745 * Set the file that will be used as photo
12747 * @param obj The photo object
12748 * @param file The path to file that will be used as photo
12750 * @return (1 = success, 0 = error)
12754 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12757 * Set the file that will be used as thumbnail in the photo.
12759 * @param obj The photo object.
12760 * @param file The path to file that will be used as thumb.
12761 * @param group The key used in case of an EET file.
12765 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12768 * Set the size that will be used on the photo
12770 * @param obj The photo object
12771 * @param size The size that the photo will be
12775 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12778 * Set if the photo should be completely visible or not.
12780 * @param obj The photo object
12781 * @param fill if true the photo will be completely visible
12785 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12788 * Set editability of the photo.
12790 * An editable photo can be dragged to or from, and can be cut or
12791 * pasted too. Note that pasting an image or dropping an item on
12792 * the image will delete the existing content.
12794 * @param obj The photo object.
12795 * @param set To set of clear editablity.
12797 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12803 /* gesture layer */
12805 * @defgroup Elm_Gesture_Layer Gesture Layer
12806 * Gesture Layer Usage:
12808 * Use Gesture Layer to detect gestures.
12809 * The advantage is that you don't have to implement
12810 * gesture detection, just set callbacks of gesture state.
12811 * By using gesture layer we make standard interface.
12813 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12814 * with a parent object parameter.
12815 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12816 * call. Usually with same object as target (2nd parameter).
12818 * Now you need to tell gesture layer what gestures you follow.
12819 * This is done with @ref elm_gesture_layer_cb_set call.
12820 * By setting the callback you actually saying to gesture layer:
12821 * I would like to know when the gesture @ref Elm_Gesture_Types
12822 * switches to state @ref Elm_Gesture_State.
12824 * Next, you need to implement the actual action that follows the input
12825 * in your callback.
12827 * Note that if you like to stop being reported about a gesture, just set
12828 * all callbacks referring this gesture to NULL.
12829 * (again with @ref elm_gesture_layer_cb_set)
12831 * The information reported by gesture layer to your callback is depending
12832 * on @ref Elm_Gesture_Types:
12833 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12834 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12835 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12837 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12838 * @ref ELM_GESTURE_MOMENTUM.
12840 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12841 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12842 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12843 * Note that we consider a flick as a line-gesture that should be completed
12844 * in flick-time-limit as defined in @ref Config.
12846 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12848 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12851 * Gesture Layer Tweaks:
12853 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12854 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12856 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12857 * so gesture starts when user touches (a *DOWN event) touch-surface
12858 * and ends when no fingers touches surface (a *UP event).
12862 * @enum _Elm_Gesture_Types
12863 * Enum of supported gesture types.
12864 * @ingroup Elm_Gesture_Layer
12866 enum _Elm_Gesture_Types
12868 ELM_GESTURE_FIRST = 0,
12870 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12871 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12872 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12873 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12875 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12877 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12878 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12880 ELM_GESTURE_ZOOM, /**< Zoom */
12881 ELM_GESTURE_ROTATE, /**< Rotate */
12887 * @typedef Elm_Gesture_Types
12888 * gesture types enum
12889 * @ingroup Elm_Gesture_Layer
12891 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12894 * @enum _Elm_Gesture_State
12895 * Enum of gesture states.
12896 * @ingroup Elm_Gesture_Layer
12898 enum _Elm_Gesture_State
12900 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12901 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12902 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12903 ELM_GESTURE_STATE_END, /**< Gesture completed */
12904 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12908 * @typedef Elm_Gesture_State
12909 * gesture states enum
12910 * @ingroup Elm_Gesture_Layer
12912 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12915 * @struct _Elm_Gesture_Taps_Info
12916 * Struct holds taps info for user
12917 * @ingroup Elm_Gesture_Layer
12919 struct _Elm_Gesture_Taps_Info
12921 Evas_Coord x, y; /**< Holds center point between fingers */
12922 unsigned int n; /**< Number of fingers tapped */
12923 unsigned int timestamp; /**< event timestamp */
12927 * @typedef Elm_Gesture_Taps_Info
12928 * holds taps info for user
12929 * @ingroup Elm_Gesture_Layer
12931 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12934 * @struct _Elm_Gesture_Momentum_Info
12935 * Struct holds momentum info for user
12936 * x1 and y1 are not necessarily in sync
12937 * x1 holds x value of x direction starting point
12938 * and same holds for y1.
12939 * This is noticeable when doing V-shape movement
12940 * @ingroup Elm_Gesture_Layer
12942 struct _Elm_Gesture_Momentum_Info
12943 { /* Report line ends, timestamps, and momentum computed */
12944 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12945 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12946 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12947 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12949 unsigned int tx; /**< Timestamp of start of final x-swipe */
12950 unsigned int ty; /**< Timestamp of start of final y-swipe */
12952 Evas_Coord mx; /**< Momentum on X */
12953 Evas_Coord my; /**< Momentum on Y */
12955 unsigned int n; /**< Number of fingers */
12959 * @typedef Elm_Gesture_Momentum_Info
12960 * holds momentum info for user
12961 * @ingroup Elm_Gesture_Layer
12963 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12966 * @struct _Elm_Gesture_Line_Info
12967 * Struct holds line info for user
12968 * @ingroup Elm_Gesture_Layer
12970 struct _Elm_Gesture_Line_Info
12971 { /* Report line ends, timestamps, and momentum computed */
12972 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12973 double angle; /**< Angle (direction) of lines */
12977 * @typedef Elm_Gesture_Line_Info
12978 * Holds line info for user
12979 * @ingroup Elm_Gesture_Layer
12981 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12984 * @struct _Elm_Gesture_Zoom_Info
12985 * Struct holds zoom info for user
12986 * @ingroup Elm_Gesture_Layer
12988 struct _Elm_Gesture_Zoom_Info
12990 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12991 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12992 double zoom; /**< Zoom value: 1.0 means no zoom */
12993 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12997 * @typedef Elm_Gesture_Zoom_Info
12998 * Holds zoom info for user
12999 * @ingroup Elm_Gesture_Layer
13001 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13004 * @struct _Elm_Gesture_Rotate_Info
13005 * Struct holds rotation info for user
13006 * @ingroup Elm_Gesture_Layer
13008 struct _Elm_Gesture_Rotate_Info
13010 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13011 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13012 double base_angle; /**< Holds start-angle */
13013 double angle; /**< Rotation value: 0.0 means no rotation */
13014 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13018 * @typedef Elm_Gesture_Rotate_Info
13019 * Holds rotation info for user
13020 * @ingroup Elm_Gesture_Layer
13022 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13025 * @typedef Elm_Gesture_Event_Cb
13026 * User callback used to stream gesture info from gesture layer
13027 * @param data user data
13028 * @param event_info gesture report info
13029 * Returns a flag field to be applied on the causing event.
13030 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13031 * upon the event, in an irreversible way.
13033 * @ingroup Elm_Gesture_Layer
13035 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13038 * Use function to set callbacks to be notified about
13039 * change of state of gesture.
13040 * When a user registers a callback with this function
13041 * this means this gesture has to be tested.
13043 * When ALL callbacks for a gesture are set to NULL
13044 * it means user isn't interested in gesture-state
13045 * and it will not be tested.
13047 * @param obj Pointer to gesture-layer.
13048 * @param idx The gesture you would like to track its state.
13049 * @param cb callback function pointer.
13050 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13051 * @param data user info to be sent to callback (usually, Smart Data)
13053 * @ingroup Elm_Gesture_Layer
13055 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);
13058 * Call this function to get repeat-events settings.
13060 * @param obj Pointer to gesture-layer.
13062 * @return repeat events settings.
13063 * @see elm_gesture_layer_hold_events_set()
13064 * @ingroup Elm_Gesture_Layer
13066 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13069 * This function called in order to make gesture-layer repeat events.
13070 * Set this of you like to get the raw events only if gestures were not detected.
13071 * Clear this if you like gesture layer to fwd events as testing gestures.
13073 * @param obj Pointer to gesture-layer.
13074 * @param r Repeat: TRUE/FALSE
13076 * @ingroup Elm_Gesture_Layer
13078 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13081 * This function sets step-value for zoom action.
13082 * Set step to any positive value.
13083 * Cancel step setting by setting to 0.0
13085 * @param obj Pointer to gesture-layer.
13086 * @param s new zoom step value.
13088 * @ingroup Elm_Gesture_Layer
13090 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13093 * This function sets step-value for rotate action.
13094 * Set step to any positive value.
13095 * Cancel step setting by setting to 0.0
13097 * @param obj Pointer to gesture-layer.
13098 * @param s new roatate step value.
13100 * @ingroup Elm_Gesture_Layer
13102 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13105 * This function called to attach gesture-layer to an Evas_Object.
13106 * @param obj Pointer to gesture-layer.
13107 * @param t Pointer to underlying object (AKA Target)
13109 * @return TRUE, FALSE on success, failure.
13111 * @ingroup Elm_Gesture_Layer
13113 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13116 * Call this function to construct a new gesture-layer object.
13117 * This does not activate the gesture layer. You have to
13118 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13120 * @param parent the parent object.
13122 * @return Pointer to new gesture-layer object.
13124 * @ingroup Elm_Gesture_Layer
13126 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13129 * @defgroup Thumb Thumb
13131 * @image html img/widget/thumb/preview-00.png
13132 * @image latex img/widget/thumb/preview-00.eps
13134 * A thumb object is used for displaying the thumbnail of an image or video.
13135 * You must have compiled Elementary with Ethumb_Client support and the DBus
13136 * service must be present and auto-activated in order to have thumbnails to
13139 * Once the thumbnail object becomes visible, it will check if there is a
13140 * previously generated thumbnail image for the file set on it. If not, it
13141 * will start generating this thumbnail.
13143 * Different config settings will cause different thumbnails to be generated
13144 * even on the same file.
13146 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13147 * Ethumb documentation to change this path, and to see other configuration
13150 * Signals that you can add callbacks for are:
13152 * - "clicked" - This is called when a user has clicked the thumb without dragging
13154 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13155 * - "press" - This is called when a user has pressed down the thumb.
13156 * - "generate,start" - The thumbnail generation started.
13157 * - "generate,stop" - The generation process stopped.
13158 * - "generate,error" - The generation failed.
13159 * - "load,error" - The thumbnail image loading failed.
13161 * available styles:
13165 * An example of use of thumbnail:
13167 * - @ref thumb_example_01
13171 * @addtogroup Thumb
13176 * @enum _Elm_Thumb_Animation_Setting
13177 * @typedef Elm_Thumb_Animation_Setting
13179 * Used to set if a video thumbnail is animating or not.
13183 typedef enum _Elm_Thumb_Animation_Setting
13185 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13186 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13187 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13188 ELM_THUMB_ANIMATION_LAST
13189 } Elm_Thumb_Animation_Setting;
13192 * Add a new thumb object to the parent.
13194 * @param parent The parent object.
13195 * @return The new object or NULL if it cannot be created.
13197 * @see elm_thumb_file_set()
13198 * @see elm_thumb_ethumb_client_get()
13202 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13204 * Reload thumbnail if it was generated before.
13206 * @param obj The thumb object to reload
13208 * This is useful if the ethumb client configuration changed, like its
13209 * size, aspect or any other property one set in the handle returned
13210 * by elm_thumb_ethumb_client_get().
13212 * If the options didn't change, the thumbnail won't be generated again, but
13213 * the old one will still be used.
13215 * @see elm_thumb_file_set()
13219 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13221 * Set the file that will be used as thumbnail.
13223 * @param obj The thumb object.
13224 * @param file The path to file that will be used as thumb.
13225 * @param key The key used in case of an EET file.
13227 * The file can be an image or a video (in that case, acceptable extensions are:
13228 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13229 * function elm_thumb_animate().
13231 * @see elm_thumb_file_get()
13232 * @see elm_thumb_reload()
13233 * @see elm_thumb_animate()
13237 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13239 * Get the image or video path and key used to generate the thumbnail.
13241 * @param obj The thumb object.
13242 * @param file Pointer to filename.
13243 * @param key Pointer to key.
13245 * @see elm_thumb_file_set()
13246 * @see elm_thumb_path_get()
13250 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13252 * Get the path and key to the image or video generated by ethumb.
13254 * One just need to make sure that the thumbnail was generated before getting
13255 * its path; otherwise, the path will be NULL. One way to do that is by asking
13256 * for the path when/after the "generate,stop" smart callback is called.
13258 * @param obj The thumb object.
13259 * @param file Pointer to thumb path.
13260 * @param key Pointer to thumb key.
13262 * @see elm_thumb_file_get()
13266 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13268 * Set the animation state for the thumb object. If its content is an animated
13269 * video, you may start/stop the animation or tell it to play continuously and
13272 * @param obj The thumb object.
13273 * @param setting The animation setting.
13275 * @see elm_thumb_file_set()
13279 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13281 * Get the animation state for the thumb object.
13283 * @param obj The thumb object.
13284 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13287 * @see elm_thumb_animate_set()
13291 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13293 * Get the ethumb_client handle so custom configuration can be made.
13295 * @return Ethumb_Client instance or NULL.
13297 * This must be called before the objects are created to be sure no object is
13298 * visible and no generation started.
13300 * Example of usage:
13303 * #include <Elementary.h>
13304 * #ifndef ELM_LIB_QUICKLAUNCH
13306 * elm_main(int argc, char **argv)
13308 * Ethumb_Client *client;
13310 * elm_need_ethumb();
13314 * client = elm_thumb_ethumb_client_get();
13317 * ERR("could not get ethumb_client");
13320 * ethumb_client_size_set(client, 100, 100);
13321 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13324 * // Create elm_thumb objects here
13334 * @note There's only one client handle for Ethumb, so once a configuration
13335 * change is done to it, any other request for thumbnails (for any thumbnail
13336 * object) will use that configuration. Thus, this configuration is global.
13340 EAPI void *elm_thumb_ethumb_client_get(void);
13342 * Get the ethumb_client connection state.
13344 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13347 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13349 * Make the thumbnail 'editable'.
13351 * @param obj Thumb object.
13352 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13354 * This means the thumbnail is a valid drag target for drag and drop, and can be
13355 * cut or pasted too.
13357 * @see elm_thumb_editable_get()
13361 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13362 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13364 * Make the thumbnail 'editable'.
13366 * @param obj Thumb object.
13367 * @return Editability.
13369 * This means the thumbnail is a valid drag target for drag and drop, and can be
13370 * cut or pasted too.
13372 * @see elm_thumb_editable_set()
13376 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13383 * @defgroup Web Web
13385 * @image html img/widget/web/preview-00.png
13386 * @image latex img/widget/web/preview-00.eps
13388 * A web object is used for displaying web pages (HTML/CSS/JS)
13389 * using WebKit-EFL. You must have compiled Elementary with
13392 * Signals that you can add callbacks for are:
13393 * @li "download,request": A file download has been requested. Event info is
13394 * a pointer to a Elm_Web_Download
13395 * @li "editorclient,contents,changed": Editor client's contents changed
13396 * @li "editorclient,selection,changed": Editor client's selection changed
13397 * @li "frame,created": A new frame was created. Event info is an
13398 * Evas_Object which can be handled with WebKit's ewk_frame API
13399 * @li "icon,received": An icon was received by the main frame
13400 * @li "inputmethod,changed": Input method changed. Event info is an
13401 * Eina_Bool indicating whether it's enabled or not
13402 * @li "js,windowobject,clear": JS window object has been cleared
13403 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13404 * is a char *link[2], where the first string contains the URL the link
13405 * points to, and the second one the title of the link
13406 * @li "link,hover,out": Mouse cursor left the link
13407 * @li "load,document,finished": Loading of a document finished. Event info
13408 * is the frame that finished loading
13409 * @li "load,error": Load failed. Event info is a pointer to
13410 * Elm_Web_Frame_Load_Error
13411 * @li "load,finished": Load finished. Event info is NULL on success, on
13412 * error it's a pointer to Elm_Web_Frame_Load_Error
13413 * @li "load,newwindow,show": A new window was created and is ready to be
13415 * @li "load,progress": Overall load progress. Event info is a pointer to
13416 * a double containing a value between 0.0 and 1.0
13417 * @li "load,provisional": Started provisional load
13418 * @li "load,started": Loading of a document started
13419 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13420 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13421 * the menubar is visible, or EINA_FALSE in case it's not
13422 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13423 * an Eina_Bool indicating the visibility
13424 * @li "popup,created": A dropdown widget was activated, requesting its
13425 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13426 * @li "popup,willdelete": The web object is ready to destroy the popup
13427 * object created. Event info is a pointer to Elm_Web_Menu
13428 * @li "ready": Page is fully loaded
13429 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13430 * info is a pointer to Eina_Bool where the visibility state should be set
13431 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13432 * is an Eina_Bool with the visibility state set
13433 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13434 * a string with the new text
13435 * @li "statusbar,visible,get": Queries visibility of the status bar.
13436 * Event info is a pointer to Eina_Bool where the visibility state should be
13438 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13439 * an Eina_Bool with the visibility value
13440 * @li "title,changed": Title of the main frame changed. Event info is a
13441 * string with the new title
13442 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13443 * is a pointer to Eina_Bool where the visibility state should be set
13444 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13445 * info is an Eina_Bool with the visibility state
13446 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13447 * a string with the text to show
13448 * @li "uri,changed": URI of the main frame changed. Event info is a string
13450 * @li "view,resized": The web object internal's view changed sized
13451 * @li "windows,close,request": A JavaScript request to close the current
13452 * window was requested
13453 * @li "zoom,animated,end": Animated zoom finished
13455 * available styles:
13458 * An example of use of web:
13460 * - @ref web_example_01 TBD
13469 * Structure used to report load errors.
13471 * Load errors are reported as signal by elm_web. All the strings are
13472 * temporary references and should @b not be used after the signal
13473 * callback returns. If it's required, make copies with strdup() or
13474 * eina_stringshare_add() (they are not even guaranteed to be
13475 * stringshared, so must use eina_stringshare_add() and not
13476 * eina_stringshare_ref()).
13478 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13480 * Structure used to report load errors.
13482 * Load errors are reported as signal by elm_web. All the strings are
13483 * temporary references and should @b not be used after the signal
13484 * callback returns. If it's required, make copies with strdup() or
13485 * eina_stringshare_add() (they are not even guaranteed to be
13486 * stringshared, so must use eina_stringshare_add() and not
13487 * eina_stringshare_ref()).
13489 struct _Elm_Web_Frame_Load_Error
13491 int code; /**< Numeric error code */
13492 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13493 const char *domain; /**< Error domain name */
13494 const char *description; /**< Error description (already localized) */
13495 const char *failing_url; /**< The URL that failed to load */
13496 Evas_Object *frame; /**< Frame object that produced the error */
13500 * The possibles types that the items in a menu can be
13502 typedef enum _Elm_Web_Menu_Item_Type
13504 ELM_WEB_MENU_SEPARATOR,
13505 ELM_WEB_MENU_GROUP,
13506 ELM_WEB_MENU_OPTION
13507 } Elm_Web_Menu_Item_Type;
13510 * Structure describing the items in a menu
13512 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13514 * Structure describing the items in a menu
13516 struct _Elm_Web_Menu_Item
13518 const char *text; /**< The text for the item */
13519 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13523 * Structure describing the menu of a popup
13525 * This structure will be passed as the @c event_info for the "popup,create"
13526 * signal, which is emitted when a dropdown menu is opened. Users wanting
13527 * to handle these popups by themselves should listen to this signal and
13528 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13529 * property as @c EINA_FALSE means that the user will not handle the popup
13530 * and the default implementation will be used.
13532 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13533 * will be emitted to notify the user that it can destroy any objects and
13534 * free all data related to it.
13536 * @see elm_web_popup_selected_set()
13537 * @see elm_web_popup_destroy()
13539 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13541 * Structure describing the menu of a popup
13543 * This structure will be passed as the @c event_info for the "popup,create"
13544 * signal, which is emitted when a dropdown menu is opened. Users wanting
13545 * to handle these popups by themselves should listen to this signal and
13546 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13547 * property as @c EINA_FALSE means that the user will not handle the popup
13548 * and the default implementation will be used.
13550 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13551 * will be emitted to notify the user that it can destroy any objects and
13552 * free all data related to it.
13554 * @see elm_web_popup_selected_set()
13555 * @see elm_web_popup_destroy()
13557 struct _Elm_Web_Menu
13559 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13560 int x; /**< The X position of the popup, relative to the elm_web object */
13561 int y; /**< The Y position of the popup, relative to the elm_web object */
13562 int width; /**< Width of the popup menu */
13563 int height; /**< Height of the popup menu */
13565 Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13568 typedef struct _Elm_Web_Download Elm_Web_Download;
13569 struct _Elm_Web_Download
13575 * Types of zoom available.
13577 typedef enum _Elm_Web_Zoom_Mode
13579 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13580 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13581 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13582 ELM_WEB_ZOOM_MODE_LAST
13583 } Elm_Web_Zoom_Mode;
13585 * Opaque handler containing the features (such as statusbar, menubar, etc)
13586 * that are to be set on a newly requested window.
13588 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13590 * Callback type for the create_window hook.
13592 * The function parameters are:
13593 * @li @p data User data pointer set when setting the hook function
13594 * @li @p obj The elm_web object requesting the new window
13595 * @li @p js Set to @c EINA_TRUE if the request was originated from
13596 * JavaScript. @c EINA_FALSE otherwise.
13597 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13598 * the features requested for the new window.
13600 * The returned value of the function should be the @c elm_web widget where
13601 * the request will be loaded. That is, if a new window or tab is created,
13602 * the elm_web widget in it should be returned, and @b NOT the window
13604 * Returning @c NULL should cancel the request.
13606 * @see elm_web_window_create_hook_set()
13608 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13610 * Callback type for the JS alert hook.
13612 * The function parameters are:
13613 * @li @p data User data pointer set when setting the hook function
13614 * @li @p obj The elm_web object requesting the new window
13615 * @li @p message The message to show in the alert dialog
13617 * The function should return the object representing the alert dialog.
13618 * Elm_Web will run a second main loop to handle the dialog and normal
13619 * flow of the application will be restored when the object is deleted, so
13620 * the user should handle the popup properly in order to delete the object
13621 * when the action is finished.
13622 * If the function returns @c NULL the popup will be ignored.
13624 * @see elm_web_dialog_alert_hook_set()
13626 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13628 * Callback type for the JS confirm hook.
13630 * The function parameters are:
13631 * @li @p data User data pointer set when setting the hook function
13632 * @li @p obj The elm_web object requesting the new window
13633 * @li @p message The message to show in the confirm dialog
13634 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13635 * the user selected @c Ok, @c EINA_FALSE otherwise.
13637 * The function should return the object representing the confirm dialog.
13638 * Elm_Web will run a second main loop to handle the dialog and normal
13639 * flow of the application will be restored when the object is deleted, so
13640 * the user should handle the popup properly in order to delete the object
13641 * when the action is finished.
13642 * If the function returns @c NULL the popup will be ignored.
13644 * @see elm_web_dialog_confirm_hook_set()
13646 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13648 * Callback type for the JS prompt hook.
13650 * The function parameters are:
13651 * @li @p data User data pointer set when setting the hook function
13652 * @li @p obj The elm_web object requesting the new window
13653 * @li @p message The message to show in the prompt dialog
13654 * @li @p def_value The default value to present the user in the entry
13655 * @li @p value Pointer where to store the value given by the user. Must
13656 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13657 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13658 * the user selected @c Ok, @c EINA_FALSE otherwise.
13660 * The function should return the object representing the prompt dialog.
13661 * Elm_Web will run a second main loop to handle the dialog and normal
13662 * flow of the application will be restored when the object is deleted, so
13663 * the user should handle the popup properly in order to delete the object
13664 * when the action is finished.
13665 * If the function returns @c NULL the popup will be ignored.
13667 * @see elm_web_dialog_prompt_hook_set()
13669 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13671 * Callback type for the JS file selector hook.
13673 * The function parameters are:
13674 * @li @p data User data pointer set when setting the hook function
13675 * @li @p obj The elm_web object requesting the new window
13676 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13677 * @li @p accept_types Mime types accepted
13678 * @li @p selected Pointer where to store the list of malloc'ed strings
13679 * containing the path to each file selected. Must be @c NULL if the file
13680 * dialog is cancelled
13681 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13682 * the user selected @c Ok, @c EINA_FALSE otherwise.
13684 * The function should return the object representing the file selector
13686 * Elm_Web will run a second main loop to handle the dialog and normal
13687 * flow of the application will be restored when the object is deleted, so
13688 * the user should handle the popup properly in order to delete the object
13689 * when the action is finished.
13690 * If the function returns @c NULL the popup will be ignored.
13692 * @see elm_web_dialog_file selector_hook_set()
13694 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13696 * Callback type for the JS console message hook.
13698 * When a console message is added from JavaScript, any set function to the
13699 * console message hook will be called for the user to handle. There is no
13700 * default implementation of this hook.
13702 * The function parameters are:
13703 * @li @p data User data pointer set when setting the hook function
13704 * @li @p obj The elm_web object that originated the message
13705 * @li @p message The message sent
13706 * @li @p line_number The line number
13707 * @li @p source_id Source id
13709 * @see elm_web_console_message_hook_set()
13711 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13713 * Add a new web object to the parent.
13715 * @param parent The parent object.
13716 * @return The new object or NULL if it cannot be created.
13718 * @see elm_web_uri_set()
13719 * @see elm_web_webkit_view_get()
13721 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13724 * Get internal ewk_view object from web object.
13726 * Elementary may not provide some low level features of EWebKit,
13727 * instead of cluttering the API with proxy methods we opted to
13728 * return the internal reference. Be careful using it as it may
13729 * interfere with elm_web behavior.
13731 * @param obj The web object.
13732 * @return The internal ewk_view object or NULL if it does not
13733 * exist. (Failure to create or Elementary compiled without
13736 * @see elm_web_add()
13738 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13741 * Sets the function to call when a new window is requested
13743 * This hook will be called when a request to create a new window is
13744 * issued from the web page loaded.
13745 * There is no default implementation for this feature, so leaving this
13746 * unset or passing @c NULL in @p func will prevent new windows from
13749 * @param obj The web object where to set the hook function
13750 * @param func The hook function to be called when a window is requested
13751 * @param data User data
13753 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13755 * Sets the function to call when an alert dialog
13757 * This hook will be called when a JavaScript alert dialog is requested.
13758 * If no function is set or @c NULL is passed in @p func, the default
13759 * implementation will take place.
13761 * @param obj The web object where to set the hook function
13762 * @param func The callback function to be used
13763 * @param data User data
13765 * @see elm_web_inwin_mode_set()
13767 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13769 * Sets the function to call when an confirm dialog
13771 * This hook will be called when a JavaScript confirm dialog is requested.
13772 * If no function is set or @c NULL is passed in @p func, the default
13773 * implementation will take place.
13775 * @param obj The web object where to set the hook function
13776 * @param func The callback function to be used
13777 * @param data User data
13779 * @see elm_web_inwin_mode_set()
13781 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13783 * Sets the function to call when an prompt dialog
13785 * This hook will be called when a JavaScript prompt dialog is requested.
13786 * If no function is set or @c NULL is passed in @p func, the default
13787 * implementation will take place.
13789 * @param obj The web object where to set the hook function
13790 * @param func The callback function to be used
13791 * @param data User data
13793 * @see elm_web_inwin_mode_set()
13795 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13797 * Sets the function to call when an file selector dialog
13799 * This hook will be called when a JavaScript file selector dialog is
13801 * If no function is set or @c NULL is passed in @p func, the default
13802 * implementation will take place.
13804 * @param obj The web object where to set the hook function
13805 * @param func The callback function to be used
13806 * @param data User data
13808 * @see elm_web_inwin_mode_set()
13810 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13812 * Sets the function to call when a console message is emitted from JS
13814 * This hook will be called when a console message is emitted from
13815 * JavaScript. There is no default implementation for this feature.
13817 * @param obj The web object where to set the hook function
13818 * @param func The callback function to be used
13819 * @param data User data
13821 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13823 * Gets the status of the tab propagation
13825 * @param obj The web object to query
13826 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13828 * @see elm_web_tab_propagate_set()
13830 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13832 * Sets whether to use tab propagation
13834 * If tab propagation is enabled, whenever the user presses the Tab key,
13835 * Elementary will handle it and switch focus to the next widget.
13836 * The default value is disabled, where WebKit will handle the Tab key to
13837 * cycle focus though its internal objects, jumping to the next widget
13838 * only when that cycle ends.
13840 * @param obj The web object
13841 * @param propagate Whether to propagate Tab keys to Elementary or not
13843 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13845 * Sets the URI for the web object
13847 * It must be a full URI, with resource included, in the form
13848 * http://www.enlightenment.org or file:///tmp/something.html
13850 * @param obj The web object
13851 * @param uri The URI to set
13852 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13854 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13856 * Gets the current URI for the object
13858 * The returned string must not be freed and is guaranteed to be
13861 * @param obj The web object
13862 * @return A stringshared internal string with the current URI, or NULL on
13865 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13867 * Gets the current title
13869 * The returned string must not be freed and is guaranteed to be
13872 * @param obj The web object
13873 * @return A stringshared internal string with the current title, or NULL on
13876 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13878 * Sets the background color to be used by the web object
13880 * This is the color that will be used by default when the loaded page
13881 * does not set it's own. Color values are pre-multiplied.
13883 * @param obj The web object
13884 * @param r Red component
13885 * @param g Green component
13886 * @param b Blue component
13887 * @param a Alpha component
13889 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13891 * Gets the background color to be used by the web object
13893 * This is the color that will be used by default when the loaded page
13894 * does not set it's own. Color values are pre-multiplied.
13896 * @param obj The web object
13897 * @param r Red component
13898 * @param g Green component
13899 * @param b Blue component
13900 * @param a Alpha component
13902 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13904 * Gets a copy of the currently selected text
13906 * The string returned must be freed by the user when it's done with it.
13908 * @param obj The web object
13909 * @return A newly allocated string, or NULL if nothing is selected or an
13912 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13914 * Tells the web object which index in the currently open popup was selected
13916 * When the user handles the popup creation from the "popup,created" signal,
13917 * it needs to tell the web object which item was selected by calling this
13918 * function with the index corresponding to the item.
13920 * @param obj The web object
13921 * @param index The index selected
13923 * @see elm_web_popup_destroy()
13925 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13927 * Dismisses an open dropdown popup
13929 * When the popup from a dropdown widget is to be dismissed, either after
13930 * selecting an option or to cancel it, this function must be called, which
13931 * will later emit an "popup,willdelete" signal to notify the user that
13932 * any memory and objects related to this popup can be freed.
13934 * @param obj The web object
13935 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13936 * if there was no menu to destroy
13938 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13940 * Searches the given string in a document.
13942 * @param obj The web object where to search the text
13943 * @param string String to search
13944 * @param case_sensitive If search should be case sensitive or not
13945 * @param forward If search is from cursor and on or backwards
13946 * @param wrap If search should wrap at the end
13948 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13951 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13953 * Marks matches of the given string in a document.
13955 * @param obj The web object where to search text
13956 * @param string String to match
13957 * @param case_sensitive If match should be case sensitive or not
13958 * @param highlight If matches should be highlighted
13959 * @param limit Maximum amount of matches, or zero to unlimited
13961 * @return number of matched @a string
13963 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13965 * Clears all marked matches in the document
13967 * @param obj The web object
13969 * @return EINA_TRUE on success, EINA_FALSE otherwise
13971 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13973 * Sets whether to highlight the matched marks
13975 * If enabled, marks set with elm_web_text_matches_mark() will be
13978 * @param obj The web object
13979 * @param highlight Whether to highlight the marks or not
13981 * @return EINA_TRUE on success, EINA_FALSE otherwise
13983 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13985 * Gets whether highlighting marks is enabled
13987 * @param The web object
13989 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13992 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13994 * Gets the overall loading progress of the page
13996 * Returns the estimated loading progress of the page, with a value between
13997 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13998 * included in the page.
14000 * @param The web object
14002 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14005 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14007 * Stops loading the current page
14009 * Cancels the loading of the current page in the web object. This will
14010 * cause a "load,error" signal to be emitted, with the is_cancellation
14011 * flag set to EINA_TRUE.
14013 * @param obj The web object
14015 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14017 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14019 * Requests a reload of the current document in the object
14021 * @param obj The web object
14023 * @return EINA_TRUE on success, EINA_FALSE otherwise
14025 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14027 * Requests a reload of the current document, avoiding any existing caches
14029 * @param obj The web object
14031 * @return EINA_TRUE on success, EINA_FALSE otherwise
14033 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14035 * Goes back one step in the browsing history
14037 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14039 * @param obj The web object
14041 * @return EINA_TRUE on success, EINA_FALSE otherwise
14043 * @see elm_web_history_enable_set()
14044 * @see elm_web_back_possible()
14045 * @see elm_web_forward()
14046 * @see elm_web_navigate()
14048 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14050 * Goes forward one step in the browsing history
14052 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14054 * @param obj The web object
14056 * @return EINA_TRUE on success, EINA_FALSE otherwise
14058 * @see elm_web_history_enable_set()
14059 * @see elm_web_forward_possible()
14060 * @see elm_web_back()
14061 * @see elm_web_navigate()
14063 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14065 * Jumps the given number of steps in the browsing history
14067 * The @p steps value can be a negative integer to back in history, or a
14068 * positive to move forward.
14070 * @param obj The web object
14071 * @param steps The number of steps to jump
14073 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14074 * history exists to jump the given number of steps
14076 * @see elm_web_history_enable_set()
14077 * @see elm_web_navigate_possible()
14078 * @see elm_web_back()
14079 * @see elm_web_forward()
14081 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14083 * Queries whether it's possible to go back in history
14085 * @param obj The web object
14087 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14090 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14092 * Queries whether it's possible to go forward in history
14094 * @param obj The web object
14096 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14099 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14101 * Queries whether it's possible to jump the given number of steps
14103 * The @p steps value can be a negative integer to back in history, or a
14104 * positive to move forward.
14106 * @param obj The web object
14107 * @param steps The number of steps to check for
14109 * @return EINA_TRUE if enough history exists to perform the given jump,
14110 * EINA_FALSE otherwise
14112 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14114 * Gets whether browsing history is enabled for the given object
14116 * @param obj The web object
14118 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14120 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14122 * Enables or disables the browsing history
14124 * @param obj The web object
14125 * @param enable Whether to enable or disable the browsing history
14127 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14129 * Sets the zoom level of the web object
14131 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14132 * values meaning zoom in and lower meaning zoom out. This function will
14133 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14134 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14136 * @param obj The web object
14137 * @param zoom The zoom level to set
14139 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14141 * Gets the current zoom level set on the web object
14143 * Note that this is the zoom level set on the web object and not that
14144 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14145 * the two zoom levels should match, but for the other two modes the
14146 * Webkit zoom is calculated internally to match the chosen mode without
14147 * changing the zoom level set for the web object.
14149 * @param obj The web object
14151 * @return The zoom level set on the object
14153 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14155 * Sets the zoom mode to use
14157 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14158 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14160 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14161 * with the elm_web_zoom_set() function.
14162 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14163 * make sure the entirety of the web object's contents are shown.
14164 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14165 * fit the contents in the web object's size, without leaving any space
14168 * @param obj The web object
14169 * @param mode The mode to set
14171 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14173 * Gets the currently set zoom mode
14175 * @param obj The web object
14177 * @return The current zoom mode set for the object, or
14178 * ::ELM_WEB_ZOOM_MODE_LAST on error
14180 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14182 * Shows the given region in the web object
14184 * @param obj The web object
14185 * @param x The x coordinate of the region to show
14186 * @param y The y coordinate of the region to show
14187 * @param w The width of the region to show
14188 * @param h The height of the region to show
14190 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14192 * Brings in the region to the visible area
14194 * Like elm_web_region_show(), but it animates the scrolling of the object
14197 * @param obj The web object
14198 * @param x The x coordinate of the region to show
14199 * @param y The y coordinate of the region to show
14200 * @param w The width of the region to show
14201 * @param h The height of the region to show
14203 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14205 * Sets the default dialogs to use an Inwin instead of a normal window
14207 * If set, then the default implementation for the JavaScript dialogs and
14208 * file selector will be opened in an Inwin. Otherwise they will use a
14209 * normal separated window.
14211 * @param obj The web object
14212 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14214 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14216 * Gets whether Inwin mode is set for the current object
14218 * @param obj The web object
14220 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14222 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14224 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14225 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14226 EAPI void elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
14227 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14234 * @defgroup Hoversel Hoversel
14236 * @image html img/widget/hoversel/preview-00.png
14237 * @image latex img/widget/hoversel/preview-00.eps
14239 * A hoversel is a button that pops up a list of items (automatically
14240 * choosing the direction to display) that have a label and, optionally, an
14241 * icon to select from. It is a convenience widget to avoid the need to do
14242 * all the piecing together yourself. It is intended for a small number of
14243 * items in the hoversel menu (no more than 8), though is capable of many
14246 * Signals that you can add callbacks for are:
14247 * "clicked" - the user clicked the hoversel button and popped up the sel
14248 * "selected" - an item in the hoversel list is selected. event_info is the item
14249 * "dismissed" - the hover is dismissed
14251 * See @ref tutorial_hoversel for an example.
14254 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14256 * @brief Add a new Hoversel object
14258 * @param parent The parent object
14259 * @return The new object or NULL if it cannot be created
14261 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14263 * @brief This sets the hoversel to expand horizontally.
14265 * @param obj The hoversel object
14266 * @param horizontal If true, the hover will expand horizontally to the
14269 * @note The initial button will display horizontally regardless of this
14272 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14274 * @brief This returns whether the hoversel is set to expand horizontally.
14276 * @param obj The hoversel object
14277 * @return If true, the hover will expand horizontally to the right.
14279 * @see elm_hoversel_horizontal_set()
14281 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14283 * @brief Set the Hover parent
14285 * @param obj The hoversel object
14286 * @param parent The parent to use
14288 * Sets the hover parent object, the area that will be darkened when the
14289 * hoversel is clicked. Should probably be the window that the hoversel is
14290 * in. See @ref Hover objects for more information.
14292 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14294 * @brief Get the Hover parent
14296 * @param obj The hoversel object
14297 * @return The used parent
14299 * Gets the hover parent object.
14301 * @see elm_hoversel_hover_parent_set()
14303 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14305 * @brief Set the hoversel button label
14307 * @param obj The hoversel object
14308 * @param label The label text.
14310 * This sets the label of the button that is always visible (before it is
14311 * clicked and expanded).
14313 * @deprecated elm_object_text_set()
14315 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14317 * @brief Get the hoversel button label
14319 * @param obj The hoversel object
14320 * @return The label text.
14322 * @deprecated elm_object_text_get()
14324 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14326 * @brief Set the icon of the hoversel button
14328 * @param obj The hoversel object
14329 * @param icon The icon object
14331 * Sets the icon of the button that is always visible (before it is clicked
14332 * and expanded). Once the icon object is set, a previously set one will be
14333 * deleted, if you want to keep that old content object, use the
14334 * elm_hoversel_icon_unset() function.
14336 * @see elm_object_content_set() for the button widget
14338 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14340 * @brief Get the icon of the hoversel button
14342 * @param obj The hoversel object
14343 * @return The icon object
14345 * Get the icon of the button that is always visible (before it is clicked
14346 * and expanded). Also see elm_object_content_get() for the button widget.
14348 * @see elm_hoversel_icon_set()
14350 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14352 * @brief Get and unparent the icon of the hoversel button
14354 * @param obj The hoversel object
14355 * @return The icon object that was being used
14357 * Unparent and return the icon of the button that is always visible
14358 * (before it is clicked and expanded).
14360 * @see elm_hoversel_icon_set()
14361 * @see elm_object_content_unset() for the button widget
14363 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14365 * @brief This triggers the hoversel popup from code, the same as if the user
14366 * had clicked the button.
14368 * @param obj The hoversel object
14370 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14372 * @brief This dismisses the hoversel popup as if the user had clicked
14373 * outside the hover.
14375 * @param obj The hoversel object
14377 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14379 * @brief Returns whether the hoversel is expanded.
14381 * @param obj The hoversel object
14382 * @return This will return EINA_TRUE if the hoversel is expanded or
14383 * EINA_FALSE if it is not expanded.
14385 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14387 * @brief This will remove all the children items from the hoversel.
14389 * @param obj The hoversel object
14391 * @warning Should @b not be called while the hoversel is active; use
14392 * elm_hoversel_expanded_get() to check first.
14394 * @see elm_hoversel_item_del_cb_set()
14395 * @see elm_hoversel_item_del()
14397 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14399 * @brief Get the list of items within the given hoversel.
14401 * @param obj The hoversel object
14402 * @return Returns a list of Elm_Hoversel_Item*
14404 * @see elm_hoversel_item_add()
14406 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14408 * @brief Add an item to the hoversel button
14410 * @param obj The hoversel object
14411 * @param label The text label to use for the item (NULL if not desired)
14412 * @param icon_file An image file path on disk to use for the icon or standard
14413 * icon name (NULL if not desired)
14414 * @param icon_type The icon type if relevant
14415 * @param func Convenience function to call when this item is selected
14416 * @param data Data to pass to item-related functions
14417 * @return A handle to the item added.
14419 * This adds an item to the hoversel to show when it is clicked. Note: if you
14420 * need to use an icon from an edje file then use
14421 * elm_hoversel_item_icon_set() right after the this function, and set
14422 * icon_file to NULL here.
14424 * For more information on what @p icon_file and @p icon_type are see the
14425 * @ref Icon "icon documentation".
14427 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);
14429 * @brief Delete an item from the hoversel
14431 * @param item The item to delete
14433 * This deletes the item from the hoversel (should not be called while the
14434 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14436 * @see elm_hoversel_item_add()
14437 * @see elm_hoversel_item_del_cb_set()
14439 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14441 * @brief Set the function to be called when an item from the hoversel is
14444 * @param item The item to set the callback on
14445 * @param func The function called
14447 * That function will receive these parameters:
14448 * @li void *item_data
14449 * @li Evas_Object *the_item_object
14450 * @li Elm_Hoversel_Item *the_object_struct
14452 * @see elm_hoversel_item_add()
14454 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14456 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14457 * that will be passed to associated function callbacks.
14459 * @param item The item to get the data from
14460 * @return The data pointer set with elm_hoversel_item_add()
14462 * @see elm_hoversel_item_add()
14464 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14466 * @brief This returns the label text of the given hoversel item.
14468 * @param item The item to get the label
14469 * @return The label text of the hoversel item
14471 * @see elm_hoversel_item_add()
14473 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14475 * @brief This sets the icon for the given hoversel item.
14477 * @param item The item to set the icon
14478 * @param icon_file An image file path on disk to use for the icon or standard
14480 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14481 * to NULL if the icon is not an edje file
14482 * @param icon_type The icon type
14484 * The icon can be loaded from the standard set, from an image file, or from
14487 * @see elm_hoversel_item_add()
14489 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);
14491 * @brief Get the icon object of the hoversel item
14493 * @param item The item to get the icon from
14494 * @param icon_file The image file path on disk used for the icon or standard
14496 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14497 * if the icon is not an edje file
14498 * @param icon_type The icon type
14500 * @see elm_hoversel_item_icon_set()
14501 * @see elm_hoversel_item_add()
14503 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);
14509 * @defgroup Toolbar Toolbar
14510 * @ingroup Elementary
14512 * @image html img/widget/toolbar/preview-00.png
14513 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14515 * @image html img/toolbar.png
14516 * @image latex img/toolbar.eps width=\textwidth
14518 * A toolbar is a widget that displays a list of items inside
14519 * a box. It can be scrollable, show a menu with items that don't fit
14520 * to toolbar size or even crop them.
14522 * Only one item can be selected at a time.
14524 * Items can have multiple states, or show menus when selected by the user.
14526 * Smart callbacks one can listen to:
14527 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14528 * - "language,changed" - when the program language changes
14530 * Available styles for it:
14532 * - @c "transparent" - no background or shadow, just show the content
14534 * List of examples:
14535 * @li @ref toolbar_example_01
14536 * @li @ref toolbar_example_02
14537 * @li @ref toolbar_example_03
14541 * @addtogroup Toolbar
14546 * @enum _Elm_Toolbar_Shrink_Mode
14547 * @typedef Elm_Toolbar_Shrink_Mode
14549 * Set toolbar's items display behavior, it can be scrollabel,
14550 * show a menu with exceeding items, or simply hide them.
14552 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14555 * Values <b> don't </b> work as bitmask, only one can be choosen.
14557 * @see elm_toolbar_mode_shrink_set()
14558 * @see elm_toolbar_mode_shrink_get()
14562 typedef enum _Elm_Toolbar_Shrink_Mode
14564 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14565 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14566 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14567 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14568 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14569 } Elm_Toolbar_Shrink_Mode;
14571 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(). */
14573 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(). */
14576 * Add a new toolbar widget to the given parent Elementary
14577 * (container) object.
14579 * @param parent The parent object.
14580 * @return a new toolbar widget handle or @c NULL, on errors.
14582 * This function inserts a new toolbar widget on the canvas.
14586 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14589 * Set the icon size, in pixels, to be used by toolbar items.
14591 * @param obj The toolbar object
14592 * @param icon_size The icon size in pixels
14594 * @note Default value is @c 32. It reads value from elm config.
14596 * @see elm_toolbar_icon_size_get()
14600 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14603 * Get the icon size, in pixels, to be used by toolbar items.
14605 * @param obj The toolbar object.
14606 * @return The icon size in pixels.
14608 * @see elm_toolbar_icon_size_set() for details.
14612 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14615 * Sets icon lookup order, for toolbar items' icons.
14617 * @param obj The toolbar object.
14618 * @param order The icon lookup order.
14620 * Icons added before calling this function will not be affected.
14621 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14623 * @see elm_toolbar_icon_order_lookup_get()
14627 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14630 * Gets the icon lookup order.
14632 * @param obj The toolbar object.
14633 * @return The icon lookup order.
14635 * @see elm_toolbar_icon_order_lookup_set() for details.
14639 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14642 * Set whether the toolbar should always have an item selected.
14644 * @param obj The toolbar object.
14645 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14648 * This will cause the toolbar to always have an item selected, and clicking
14649 * the selected item will not cause a selected event to be emitted. Enabling this mode
14650 * will immediately select the first toolbar item.
14652 * Always-selected is disabled by default.
14654 * @see elm_toolbar_always_select_mode_get().
14658 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14661 * Get whether the toolbar should always have an item selected.
14663 * @param obj The toolbar object.
14664 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14665 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14667 * @see elm_toolbar_always_select_mode_set() for details.
14671 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14674 * Set whether the toolbar items' should be selected by the user or not.
14676 * @param obj The toolbar object.
14677 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14680 * This will turn off the ability to select items entirely and they will
14681 * neither appear selected nor emit selected signals. The clicked
14682 * callback function will still be called.
14684 * Selection is enabled by default.
14686 * @see elm_toolbar_no_select_mode_get().
14690 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14693 * Set whether the toolbar items' should be selected by the user or not.
14695 * @param obj The toolbar object.
14696 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14697 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14699 * @see elm_toolbar_no_select_mode_set() for details.
14703 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14706 * Append item to the toolbar.
14708 * @param obj The toolbar object.
14709 * @param icon A string with icon name or the absolute path of an image file.
14710 * @param label The label of the item.
14711 * @param func The function to call when the item is clicked.
14712 * @param data The data to associate with the item for related callbacks.
14713 * @return The created item or @c NULL upon failure.
14715 * A new item will be created and appended to the toolbar, i.e., will
14716 * be set as @b last item.
14718 * Items created with this method can be deleted with
14719 * elm_toolbar_item_del().
14721 * Associated @p data can be properly freed when item is deleted if a
14722 * callback function is set with elm_toolbar_item_del_cb_set().
14724 * If a function is passed as argument, it will be called everytime this item
14725 * is selected, i.e., the user clicks over an unselected item.
14726 * If such function isn't needed, just passing
14727 * @c NULL as @p func is enough. The same should be done for @p data.
14729 * Toolbar will load icon image from fdo or current theme.
14730 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14731 * If an absolute path is provided it will load it direct from a file.
14733 * @see elm_toolbar_item_icon_set()
14734 * @see elm_toolbar_item_del()
14735 * @see elm_toolbar_item_del_cb_set()
14739 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);
14742 * Prepend item to the toolbar.
14744 * @param obj The toolbar object.
14745 * @param icon A string with icon name or the absolute path of an image file.
14746 * @param label The label of the item.
14747 * @param func The function to call when the item is clicked.
14748 * @param data The data to associate with the item for related callbacks.
14749 * @return The created item or @c NULL upon failure.
14751 * A new item will be created and prepended to the toolbar, i.e., will
14752 * be set as @b first item.
14754 * Items created with this method can be deleted with
14755 * elm_toolbar_item_del().
14757 * Associated @p data can be properly freed when item is deleted if a
14758 * callback function is set with elm_toolbar_item_del_cb_set().
14760 * If a function is passed as argument, it will be called everytime this item
14761 * is selected, i.e., the user clicks over an unselected item.
14762 * If such function isn't needed, just passing
14763 * @c NULL as @p func is enough. The same should be done for @p data.
14765 * Toolbar will load icon image from fdo or current theme.
14766 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14767 * If an absolute path is provided it will load it direct from a file.
14769 * @see elm_toolbar_item_icon_set()
14770 * @see elm_toolbar_item_del()
14771 * @see elm_toolbar_item_del_cb_set()
14775 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);
14778 * Insert a new item into the toolbar object before item @p before.
14780 * @param obj The toolbar object.
14781 * @param before The toolbar item to insert before.
14782 * @param icon A string with icon name or the absolute path of an image file.
14783 * @param label The label of the item.
14784 * @param func The function to call when the item is clicked.
14785 * @param data The data to associate with the item for related callbacks.
14786 * @return The created item or @c NULL upon failure.
14788 * A new item will be created and added to the toolbar. Its position in
14789 * this toolbar will be just before item @p before.
14791 * Items created with this method can be deleted with
14792 * elm_toolbar_item_del().
14794 * Associated @p data can be properly freed when item is deleted if a
14795 * callback function is set with elm_toolbar_item_del_cb_set().
14797 * If a function is passed as argument, it will be called everytime this item
14798 * is selected, i.e., the user clicks over an unselected item.
14799 * If such function isn't needed, just passing
14800 * @c NULL as @p func is enough. The same should be done for @p data.
14802 * Toolbar will load icon image from fdo or current theme.
14803 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14804 * If an absolute path is provided it will load it direct from a file.
14806 * @see elm_toolbar_item_icon_set()
14807 * @see elm_toolbar_item_del()
14808 * @see elm_toolbar_item_del_cb_set()
14812 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);
14815 * Insert a new item into the toolbar object after item @p after.
14817 * @param obj The toolbar object.
14818 * @param after The toolbar item to insert after.
14819 * @param icon A string with icon name or the absolute path of an image file.
14820 * @param label The label of the item.
14821 * @param func The function to call when the item is clicked.
14822 * @param data The data to associate with the item for related callbacks.
14823 * @return The created item or @c NULL upon failure.
14825 * A new item will be created and added to the toolbar. Its position in
14826 * this toolbar will be just after item @p after.
14828 * Items created with this method can be deleted with
14829 * elm_toolbar_item_del().
14831 * Associated @p data can be properly freed when item is deleted if a
14832 * callback function is set with elm_toolbar_item_del_cb_set().
14834 * If a function is passed as argument, it will be called everytime this item
14835 * is selected, i.e., the user clicks over an unselected item.
14836 * If such function isn't needed, just passing
14837 * @c NULL as @p func is enough. The same should be done for @p data.
14839 * Toolbar will load icon image from fdo or current theme.
14840 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14841 * If an absolute path is provided it will load it direct from a file.
14843 * @see elm_toolbar_item_icon_set()
14844 * @see elm_toolbar_item_del()
14845 * @see elm_toolbar_item_del_cb_set()
14849 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);
14852 * Get the first item in the given toolbar widget's list of
14855 * @param obj The toolbar object
14856 * @return The first item or @c NULL, if it has no items (and on
14859 * @see elm_toolbar_item_append()
14860 * @see elm_toolbar_last_item_get()
14864 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14867 * Get the last item in the given toolbar widget's list of
14870 * @param obj The toolbar object
14871 * @return The last item or @c NULL, if it has no items (and on
14874 * @see elm_toolbar_item_prepend()
14875 * @see elm_toolbar_first_item_get()
14879 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14882 * Get the item after @p item in toolbar.
14884 * @param item The toolbar item.
14885 * @return The item after @p item, or @c NULL if none or on failure.
14887 * @note If it is the last item, @c NULL will be returned.
14889 * @see elm_toolbar_item_append()
14893 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14896 * Get the item before @p item in toolbar.
14898 * @param item The toolbar item.
14899 * @return The item before @p item, or @c NULL if none or on failure.
14901 * @note If it is the first item, @c NULL will be returned.
14903 * @see elm_toolbar_item_prepend()
14907 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14910 * Get the toolbar object from an item.
14912 * @param item The item.
14913 * @return The toolbar object.
14915 * This returns the toolbar object itself that an item belongs to.
14919 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14922 * Set the priority of a toolbar item.
14924 * @param item The toolbar item.
14925 * @param priority The item priority. The default is zero.
14927 * This is used only when the toolbar shrink mode is set to
14928 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14929 * When space is less than required, items with low priority
14930 * will be removed from the toolbar and added to a dynamically-created menu,
14931 * while items with higher priority will remain on the toolbar,
14932 * with the same order they were added.
14934 * @see elm_toolbar_item_priority_get()
14938 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14941 * Get the priority of a toolbar item.
14943 * @param item The toolbar item.
14944 * @return The @p item priority, or @c 0 on failure.
14946 * @see elm_toolbar_item_priority_set() for details.
14950 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14953 * Get the label of item.
14955 * @param item The item of toolbar.
14956 * @return The label of item.
14958 * The return value is a pointer to the label associated to @p item when
14959 * it was created, with function elm_toolbar_item_append() or similar,
14961 * with function elm_toolbar_item_label_set. If no label
14962 * was passed as argument, it will return @c NULL.
14964 * @see elm_toolbar_item_label_set() for more details.
14965 * @see elm_toolbar_item_append()
14969 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14972 * Set the label of item.
14974 * @param item The item of toolbar.
14975 * @param text The label of item.
14977 * The label to be displayed by the item.
14978 * Label will be placed at icons bottom (if set).
14980 * If a label was passed as argument on item creation, with function
14981 * elm_toolbar_item_append() or similar, it will be already
14982 * displayed by the item.
14984 * @see elm_toolbar_item_label_get()
14985 * @see elm_toolbar_item_append()
14989 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14992 * Return the data associated with a given toolbar widget item.
14994 * @param item The toolbar widget item handle.
14995 * @return The data associated with @p item.
14997 * @see elm_toolbar_item_data_set()
15001 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15004 * Set the data associated with a given toolbar widget item.
15006 * @param item The toolbar widget item handle.
15007 * @param data The new data pointer to set to @p item.
15009 * This sets new item data on @p item.
15011 * @warning The old data pointer won't be touched by this function, so
15012 * the user had better to free that old data himself/herself.
15016 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
15019 * Returns a pointer to a toolbar item by its label.
15021 * @param obj The toolbar object.
15022 * @param label The label of the item to find.
15024 * @return The pointer to the toolbar item matching @p label or @c NULL
15029 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15032 * Get whether the @p item is selected or not.
15034 * @param item The toolbar item.
15035 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15036 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15038 * @see elm_toolbar_selected_item_set() for details.
15039 * @see elm_toolbar_item_selected_get()
15043 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15046 * Set the selected state of an item.
15048 * @param item The toolbar item
15049 * @param selected The selected state
15051 * This sets the selected state of the given item @p it.
15052 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15054 * If a new item is selected the previosly selected will be unselected.
15055 * Previoulsy selected item can be get with function
15056 * elm_toolbar_selected_item_get().
15058 * Selected items will be highlighted.
15060 * @see elm_toolbar_item_selected_get()
15061 * @see elm_toolbar_selected_item_get()
15065 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15068 * Get the selected item.
15070 * @param obj The toolbar object.
15071 * @return The selected toolbar item.
15073 * The selected item can be unselected with function
15074 * elm_toolbar_item_selected_set().
15076 * The selected item always will be highlighted on toolbar.
15078 * @see elm_toolbar_selected_items_get()
15082 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15085 * Set the icon associated with @p item.
15087 * @param obj The parent of this item.
15088 * @param item The toolbar item.
15089 * @param icon A string with icon name or the absolute path of an image file.
15091 * Toolbar will load icon image from fdo or current theme.
15092 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15093 * If an absolute path is provided it will load it direct from a file.
15095 * @see elm_toolbar_icon_order_lookup_set()
15096 * @see elm_toolbar_icon_order_lookup_get()
15100 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15103 * Get the string used to set the icon of @p item.
15105 * @param item The toolbar item.
15106 * @return The string associated with the icon object.
15108 * @see elm_toolbar_item_icon_set() for details.
15112 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15115 * Get the object of @p item.
15117 * @param item The toolbar item.
15118 * @return The object
15122 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15125 * Get the icon object of @p item.
15127 * @param item The toolbar item.
15128 * @return The icon object
15130 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15134 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15137 * Set the icon associated with @p item to an image in a binary buffer.
15139 * @param item The toolbar item.
15140 * @param img The binary data that will be used as an image
15141 * @param size The size of binary data @p img
15142 * @param format Optional format of @p img to pass to the image loader
15143 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15145 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15147 * @note The icon image set by this function can be changed by
15148 * elm_toolbar_item_icon_set().
15152 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15155 * Delete them item from the toolbar.
15157 * @param item The item of toolbar to be deleted.
15159 * @see elm_toolbar_item_append()
15160 * @see elm_toolbar_item_del_cb_set()
15164 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15167 * Set the function called when a toolbar item is freed.
15169 * @param item The item to set the callback on.
15170 * @param func The function called.
15172 * If there is a @p func, then it will be called prior item's memory release.
15173 * That will be called with the following arguments:
15175 * @li item's Evas object;
15178 * This way, a data associated to a toolbar item could be properly freed.
15182 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15185 * Get a value whether toolbar item is disabled or not.
15187 * @param item The item.
15188 * @return The disabled state.
15190 * @see elm_toolbar_item_disabled_set() for more details.
15194 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15197 * Sets the disabled/enabled state of a toolbar item.
15199 * @param item The item.
15200 * @param disabled The disabled state.
15202 * A disabled item cannot be selected or unselected. It will also
15203 * change its appearance (generally greyed out). This sets the
15204 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15209 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15212 * Set or unset item as a separator.
15214 * @param item The toolbar item.
15215 * @param setting @c EINA_TRUE to set item @p item as separator or
15216 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15218 * Items aren't set as separator by default.
15220 * If set as separator it will display separator theme, so won't display
15223 * @see elm_toolbar_item_separator_get()
15227 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15230 * Get a value whether item is a separator or not.
15232 * @param item The toolbar item.
15233 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15234 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15236 * @see elm_toolbar_item_separator_set() for details.
15240 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15243 * Set the shrink state of toolbar @p obj.
15245 * @param obj The toolbar object.
15246 * @param shrink_mode Toolbar's items display behavior.
15248 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15249 * but will enforce a minimun size so all the items will fit, won't scroll
15250 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15251 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15252 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15256 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15259 * Get the shrink mode of toolbar @p obj.
15261 * @param obj The toolbar object.
15262 * @return Toolbar's items display behavior.
15264 * @see elm_toolbar_mode_shrink_set() for details.
15268 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15271 * Enable/disable homogenous mode.
15273 * @param obj The toolbar object
15274 * @param homogeneous Assume the items within the toolbar are of the
15275 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15277 * This will enable the homogeneous mode where items are of the same size.
15278 * @see elm_toolbar_homogeneous_get()
15282 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15285 * Get whether the homogenous mode is enabled.
15287 * @param obj The toolbar object.
15288 * @return Assume the items within the toolbar are of the same height
15289 * and width (EINA_TRUE = on, EINA_FALSE = off).
15291 * @see elm_toolbar_homogeneous_set()
15295 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15298 * Enable/disable homogenous mode.
15300 * @param obj The toolbar object
15301 * @param homogeneous Assume the items within the toolbar are of the
15302 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15304 * This will enable the homogeneous mode where items are of the same size.
15305 * @see elm_toolbar_homogeneous_get()
15307 * @deprecated use elm_toolbar_homogeneous_set() instead.
15311 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15314 * Get whether the homogenous mode is enabled.
15316 * @param obj The toolbar object.
15317 * @return Assume the items within the toolbar are of the same height
15318 * and width (EINA_TRUE = on, EINA_FALSE = off).
15320 * @see elm_toolbar_homogeneous_set()
15321 * @deprecated use elm_toolbar_homogeneous_get() instead.
15325 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15328 * Set the parent object of the toolbar items' menus.
15330 * @param obj The toolbar object.
15331 * @param parent The parent of the menu objects.
15333 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15335 * For more details about setting the parent for toolbar menus, see
15336 * elm_menu_parent_set().
15338 * @see elm_menu_parent_set() for details.
15339 * @see elm_toolbar_item_menu_set() for details.
15343 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15346 * Get the parent object of the toolbar items' menus.
15348 * @param obj The toolbar object.
15349 * @return The parent of the menu objects.
15351 * @see elm_toolbar_menu_parent_set() for details.
15355 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15358 * Set the alignment of the items.
15360 * @param obj The toolbar object.
15361 * @param align The new alignment, a float between <tt> 0.0 </tt>
15362 * and <tt> 1.0 </tt>.
15364 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15365 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15368 * Centered items by default.
15370 * @see elm_toolbar_align_get()
15374 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15377 * Get the alignment of the items.
15379 * @param obj The toolbar object.
15380 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15383 * @see elm_toolbar_align_set() for details.
15387 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15390 * Set whether the toolbar item opens a menu.
15392 * @param item The toolbar item.
15393 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15395 * A toolbar item can be set to be a menu, using this function.
15397 * Once it is set to be a menu, it can be manipulated through the
15398 * menu-like function elm_toolbar_menu_parent_set() and the other
15399 * elm_menu functions, using the Evas_Object @c menu returned by
15400 * elm_toolbar_item_menu_get().
15402 * So, items to be displayed in this item's menu should be added with
15403 * elm_menu_item_add().
15405 * The following code exemplifies the most basic usage:
15407 * tb = elm_toolbar_add(win)
15408 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15409 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15410 * elm_toolbar_menu_parent_set(tb, win);
15411 * menu = elm_toolbar_item_menu_get(item);
15412 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15413 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15417 * @see elm_toolbar_item_menu_get()
15421 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15424 * Get toolbar item's menu.
15426 * @param item The toolbar item.
15427 * @return Item's menu object or @c NULL on failure.
15429 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15430 * this function will set it.
15432 * @see elm_toolbar_item_menu_set() for details.
15436 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15439 * Add a new state to @p item.
15441 * @param item The item.
15442 * @param icon A string with icon name or the absolute path of an image file.
15443 * @param label The label of the new state.
15444 * @param func The function to call when the item is clicked when this
15445 * state is selected.
15446 * @param data The data to associate with the state.
15447 * @return The toolbar item state, or @c NULL upon failure.
15449 * Toolbar will load icon image from fdo or current theme.
15450 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15451 * If an absolute path is provided it will load it direct from a file.
15453 * States created with this function can be removed with
15454 * elm_toolbar_item_state_del().
15456 * @see elm_toolbar_item_state_del()
15457 * @see elm_toolbar_item_state_sel()
15458 * @see elm_toolbar_item_state_get()
15462 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);
15465 * Delete a previoulsy added state to @p item.
15467 * @param item The toolbar item.
15468 * @param state The state to be deleted.
15469 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15471 * @see elm_toolbar_item_state_add()
15473 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15476 * Set @p state as the current state of @p it.
15478 * @param it The item.
15479 * @param state The state to use.
15480 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15482 * If @p state is @c NULL, it won't select any state and the default item's
15483 * icon and label will be used. It's the same behaviour than
15484 * elm_toolbar_item_state_unser().
15486 * @see elm_toolbar_item_state_unset()
15490 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15493 * Unset the state of @p it.
15495 * @param it The item.
15497 * The default icon and label from this item will be displayed.
15499 * @see elm_toolbar_item_state_set() for more details.
15503 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15506 * Get the current state of @p it.
15508 * @param item The item.
15509 * @return The selected state or @c NULL if none is selected or on failure.
15511 * @see elm_toolbar_item_state_set() for details.
15512 * @see elm_toolbar_item_state_unset()
15513 * @see elm_toolbar_item_state_add()
15517 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15520 * Get the state after selected state in toolbar's @p item.
15522 * @param it The toolbar item to change state.
15523 * @return The state after current state, or @c NULL on failure.
15525 * If last state is selected, this function will return first state.
15527 * @see elm_toolbar_item_state_set()
15528 * @see elm_toolbar_item_state_add()
15532 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15535 * Get the state before selected state in toolbar's @p item.
15537 * @param it The toolbar item to change state.
15538 * @return The state before current state, or @c NULL on failure.
15540 * If first state is selected, this function will return last state.
15542 * @see elm_toolbar_item_state_set()
15543 * @see elm_toolbar_item_state_add()
15547 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15550 * Set the text to be shown in a given toolbar item's tooltips.
15552 * @param item Target item.
15553 * @param text The text to set in the content.
15555 * Setup the text as tooltip to object. The item can have only one tooltip,
15556 * so any previous tooltip data - set with this function or
15557 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15559 * @see elm_object_tooltip_text_set() for more details.
15563 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15566 * Set the content to be shown in the tooltip item.
15568 * Setup the tooltip to item. The item can have only one tooltip,
15569 * so any previous tooltip data is removed. @p func(with @p data) will
15570 * be called every time that need show the tooltip and it should
15571 * return a valid Evas_Object. This object is then managed fully by
15572 * tooltip system and is deleted when the tooltip is gone.
15574 * @param item the toolbar item being attached a tooltip.
15575 * @param func the function used to create the tooltip contents.
15576 * @param data what to provide to @a func as callback data/context.
15577 * @param del_cb called when data is not needed anymore, either when
15578 * another callback replaces @a func, the tooltip is unset with
15579 * elm_toolbar_item_tooltip_unset() or the owner @a item
15580 * dies. This callback receives as the first parameter the
15581 * given @a data, and @c event_info is the item.
15583 * @see elm_object_tooltip_content_cb_set() for more details.
15587 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);
15590 * Unset tooltip from item.
15592 * @param item toolbar item to remove previously set tooltip.
15594 * Remove tooltip from item. The callback provided as del_cb to
15595 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15596 * it is not used anymore.
15598 * @see elm_object_tooltip_unset() for more details.
15599 * @see elm_toolbar_item_tooltip_content_cb_set()
15603 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15606 * Sets a different style for this item tooltip.
15608 * @note before you set a style you should define a tooltip with
15609 * elm_toolbar_item_tooltip_content_cb_set() or
15610 * elm_toolbar_item_tooltip_text_set()
15612 * @param item toolbar item with tooltip already set.
15613 * @param style the theme style to use (default, transparent, ...)
15615 * @see elm_object_tooltip_style_set() for more details.
15619 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15622 * Get the style for this item tooltip.
15624 * @param item toolbar item with tooltip already set.
15625 * @return style the theme style in use, defaults to "default". If the
15626 * object does not have a tooltip set, then NULL is returned.
15628 * @see elm_object_tooltip_style_get() for more details.
15629 * @see elm_toolbar_item_tooltip_style_set()
15633 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15636 * Set the type of mouse pointer/cursor decoration to be shown,
15637 * when the mouse pointer is over the given toolbar widget item
15639 * @param item toolbar item to customize cursor on
15640 * @param cursor the cursor type's name
15642 * This function works analogously as elm_object_cursor_set(), but
15643 * here the cursor's changing area is restricted to the item's
15644 * area, and not the whole widget's. Note that that item cursors
15645 * have precedence over widget cursors, so that a mouse over an
15646 * item with custom cursor set will always show @b that cursor.
15648 * If this function is called twice for an object, a previously set
15649 * cursor will be unset on the second call.
15651 * @see elm_object_cursor_set()
15652 * @see elm_toolbar_item_cursor_get()
15653 * @see elm_toolbar_item_cursor_unset()
15657 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15660 * Get the type of mouse pointer/cursor decoration set to be shown,
15661 * when the mouse pointer is over the given toolbar widget item
15663 * @param item toolbar item with custom cursor set
15664 * @return the cursor type's name or @c NULL, if no custom cursors
15665 * were set to @p item (and on errors)
15667 * @see elm_object_cursor_get()
15668 * @see elm_toolbar_item_cursor_set()
15669 * @see elm_toolbar_item_cursor_unset()
15673 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15676 * Unset any custom mouse pointer/cursor decoration set to be
15677 * shown, when the mouse pointer is over the given toolbar widget
15678 * item, thus making it show the @b default cursor again.
15680 * @param item a toolbar item
15682 * Use this call to undo any custom settings on this item's cursor
15683 * decoration, bringing it back to defaults (no custom style set).
15685 * @see elm_object_cursor_unset()
15686 * @see elm_toolbar_item_cursor_set()
15690 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15693 * Set a different @b style for a given custom cursor set for a
15696 * @param item toolbar item with custom cursor set
15697 * @param style the <b>theme style</b> to use (e.g. @c "default",
15698 * @c "transparent", etc)
15700 * This function only makes sense when one is using custom mouse
15701 * cursor decorations <b>defined in a theme file</b>, which can have,
15702 * given a cursor name/type, <b>alternate styles</b> on it. It
15703 * works analogously as elm_object_cursor_style_set(), but here
15704 * applyed only to toolbar item objects.
15706 * @warning Before you set a cursor style you should have definen a
15707 * custom cursor previously on the item, with
15708 * elm_toolbar_item_cursor_set()
15710 * @see elm_toolbar_item_cursor_engine_only_set()
15711 * @see elm_toolbar_item_cursor_style_get()
15715 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15718 * Get the current @b style set for a given toolbar item's custom
15721 * @param item toolbar item with custom cursor set.
15722 * @return style the cursor style in use. If the object does not
15723 * have a cursor set, then @c NULL is returned.
15725 * @see elm_toolbar_item_cursor_style_set() for more details
15729 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15732 * Set if the (custom)cursor for a given toolbar item should be
15733 * searched in its theme, also, or should only rely on the
15734 * rendering engine.
15736 * @param item item with custom (custom) cursor already set on
15737 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15738 * only on those provided by the rendering engine, @c EINA_FALSE to
15739 * have them searched on the widget's theme, as well.
15741 * @note This call is of use only if you've set a custom cursor
15742 * for toolbar items, with elm_toolbar_item_cursor_set().
15744 * @note By default, cursors will only be looked for between those
15745 * provided by the rendering engine.
15749 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15752 * Get if the (custom) cursor for a given toolbar item is being
15753 * searched in its theme, also, or is only relying on the rendering
15756 * @param item a toolbar item
15757 * @return @c EINA_TRUE, if cursors are being looked for only on
15758 * those provided by the rendering engine, @c EINA_FALSE if they
15759 * are being searched on the widget's theme, as well.
15761 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15765 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15768 * Change a toolbar's orientation
15769 * @param obj The toolbar object
15770 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15771 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15773 * @deprecated use elm_toolbar_horizontal_set() instead.
15775 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15778 * Change a toolbar's orientation
15779 * @param obj The toolbar object
15780 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15781 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15784 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15787 * Get a toolbar's orientation
15788 * @param obj The toolbar object
15789 * @return If @c EINA_TRUE, the toolbar is vertical
15790 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15792 * @deprecated use elm_toolbar_horizontal_get() instead.
15794 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15797 * Get a toolbar's orientation
15798 * @param obj The toolbar object
15799 * @return If @c EINA_TRUE, the toolbar is horizontal
15800 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15803 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15809 * @defgroup Tooltips Tooltips
15811 * The Tooltip is an (internal, for now) smart object used to show a
15812 * content in a frame on mouse hover of objects(or widgets), with
15813 * tips/information about them.
15818 EAPI double elm_tooltip_delay_get(void);
15819 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15820 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15821 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15822 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15823 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15824 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15825 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);
15826 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15827 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15828 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15829 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15830 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15837 * @defgroup Cursors Cursors
15839 * The Elementary cursor is an internal smart object used to
15840 * customize the mouse cursor displayed over objects (or
15841 * widgets). In the most common scenario, the cursor decoration
15842 * comes from the graphical @b engine Elementary is running
15843 * on. Those engines may provide different decorations for cursors,
15844 * and Elementary provides functions to choose them (think of X11
15845 * cursors, as an example).
15847 * There's also the possibility of, besides using engine provided
15848 * cursors, also use ones coming from Edje theming files. Both
15849 * globally and per widget, Elementary makes it possible for one to
15850 * make the cursors lookup to be held on engines only or on
15851 * Elementary's theme file, too. To set cursor's hot spot,
15852 * two data items should be added to cursor's theme: "hot_x" and
15853 * "hot_y", that are the offset from upper-left corner of the cursor
15854 * (coordinates 0,0).
15860 * Set the cursor to be shown when mouse is over the object
15862 * Set the cursor that will be displayed when mouse is over the
15863 * object. The object can have only one cursor set to it, so if
15864 * this function is called twice for an object, the previous set
15866 * If using X cursors, a definition of all the valid cursor names
15867 * is listed on Elementary_Cursors.h. If an invalid name is set
15868 * the default cursor will be used.
15870 * @param obj the object being set a cursor.
15871 * @param cursor the cursor name to be used.
15875 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15878 * Get the cursor to be shown when mouse is over the object
15880 * @param obj an object with cursor already set.
15881 * @return the cursor name.
15885 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15888 * Unset cursor for object
15890 * Unset cursor for object, and set the cursor to default if the mouse
15891 * was over this object.
15893 * @param obj Target object
15894 * @see elm_object_cursor_set()
15898 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15901 * Sets a different style for this object cursor.
15903 * @note before you set a style you should define a cursor with
15904 * elm_object_cursor_set()
15906 * @param obj an object with cursor already set.
15907 * @param style the theme style to use (default, transparent, ...)
15911 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15914 * Get the style for this object cursor.
15916 * @param obj an object with cursor already set.
15917 * @return style the theme style in use, defaults to "default". If the
15918 * object does not have a cursor set, then NULL is returned.
15922 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15925 * Set if the cursor set should be searched on the theme or should use
15926 * the provided by the engine, only.
15928 * @note before you set if should look on theme you should define a cursor
15929 * with elm_object_cursor_set(). By default it will only look for cursors
15930 * provided by the engine.
15932 * @param obj an object with cursor already set.
15933 * @param engine_only boolean to define it cursors should be looked only
15934 * between the provided by the engine or searched on widget's theme as well.
15938 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15941 * Get the cursor engine only usage for this object cursor.
15943 * @param obj an object with cursor already set.
15944 * @return engine_only boolean to define it cursors should be
15945 * looked only between the provided by the engine or searched on
15946 * widget's theme as well. If the object does not have a cursor
15947 * set, then EINA_FALSE is returned.
15951 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15954 * Get the configured cursor engine only usage
15956 * This gets the globally configured exclusive usage of engine cursors.
15958 * @return 1 if only engine cursors should be used
15961 EAPI int elm_cursor_engine_only_get(void);
15964 * Set the configured cursor engine only usage
15966 * This sets the globally configured exclusive usage of engine cursors.
15967 * It won't affect cursors set before changing this value.
15969 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15970 * look for them on theme before.
15971 * @return EINA_TRUE if value is valid and setted (0 or 1)
15974 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15981 * @defgroup Menu Menu
15983 * @image html img/widget/menu/preview-00.png
15984 * @image latex img/widget/menu/preview-00.eps
15986 * A menu is a list of items displayed above its parent. When the menu is
15987 * showing its parent is darkened. Each item can have a sub-menu. The menu
15988 * object can be used to display a menu on a right click event, in a toolbar,
15991 * Signals that you can add callbacks for are:
15992 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15993 * event_info is NULL.
15995 * @see @ref tutorial_menu
15998 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
16000 * @brief Add a new menu to the parent
16002 * @param parent The parent object.
16003 * @return The new object or NULL if it cannot be created.
16005 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16007 * @brief Set the parent for the given menu widget
16009 * @param obj The menu object.
16010 * @param parent The new parent.
16012 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16014 * @brief Get the parent for the given menu widget
16016 * @param obj The menu object.
16017 * @return The parent.
16019 * @see elm_menu_parent_set()
16021 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16023 * @brief Move the menu to a new position
16025 * @param obj The menu object.
16026 * @param x The new position.
16027 * @param y The new position.
16029 * Sets the top-left position of the menu to (@p x,@p y).
16031 * @note @p x and @p y coordinates are relative to parent.
16033 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16035 * @brief Close a opened menu
16037 * @param obj the menu object
16040 * Hides the menu and all it's sub-menus.
16042 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16044 * @brief Returns a list of @p item's items.
16046 * @param obj The menu object
16047 * @return An Eina_List* of @p item's items
16049 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16051 * @brief Get the Evas_Object of an Elm_Menu_Item
16053 * @param item The menu item object.
16054 * @return The edje object containing the swallowed content
16056 * @warning Don't manipulate this object!
16058 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16060 * @brief Add an item at the end of the given menu widget
16062 * @param obj The menu object.
16063 * @param parent The parent menu item (optional)
16064 * @param icon A icon display on the item. The icon will be destryed by the menu.
16065 * @param label The label of the item.
16066 * @param func Function called when the user select the item.
16067 * @param data Data sent by the callback.
16068 * @return Returns the new item.
16070 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);
16072 * @brief Add an object swallowed in an item at the end of the given menu
16075 * @param obj The menu object.
16076 * @param parent The parent menu item (optional)
16077 * @param subobj The object to swallow
16078 * @param func Function called when the user select the item.
16079 * @param data Data sent by the callback.
16080 * @return Returns the new item.
16082 * Add an evas object as an item to the menu.
16084 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);
16086 * @brief Set the label of a menu item
16088 * @param item The menu item object.
16089 * @param label The label to set for @p item
16091 * @warning Don't use this funcion on items created with
16092 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16094 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16096 * @brief Get the label of a menu item
16098 * @param item The menu item object.
16099 * @return The label of @p item
16101 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16103 * @brief Set the icon of a menu item to the standard icon with name @p icon
16105 * @param item The menu item object.
16106 * @param icon The icon object to set for the content of @p item
16108 * Once this icon is set, any previously set icon will be deleted.
16110 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16112 * @brief Get the string representation from the icon of a menu item
16114 * @param item The menu item object.
16115 * @return The string representation of @p item's icon or NULL
16117 * @see elm_menu_item_object_icon_name_set()
16119 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16121 * @brief Set the content object of a menu item
16123 * @param item The menu item object
16124 * @param The content object or NULL
16125 * @return EINA_TRUE on success, else EINA_FALSE
16127 * Use this function to change the object swallowed by a menu item, deleting
16128 * any previously swallowed object.
16130 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16132 * @brief Get the content object of a menu item
16134 * @param item The menu item object
16135 * @return The content object or NULL
16136 * @note If @p item was added with elm_menu_item_add_object, this
16137 * function will return the object passed, else it will return the
16140 * @see elm_menu_item_object_content_set()
16142 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16144 EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
16146 elm_menu_item_object_icon_name_set(item, icon);
16149 EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16151 return elm_menu_item_object_content_get(item);
16154 EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16156 return elm_menu_item_object_icon_name_get(item);
16160 * @brief Set the selected state of @p item.
16162 * @param item The menu item object.
16163 * @param selected The selected/unselected state of the item
16165 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16167 * @brief Get the selected state of @p item.
16169 * @param item The menu item object.
16170 * @return The selected/unselected state of the item
16172 * @see elm_menu_item_selected_set()
16174 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16176 * @brief Set the disabled state of @p item.
16178 * @param item The menu item object.
16179 * @param disabled The enabled/disabled state of the item
16181 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16183 * @brief Get the disabled state of @p item.
16185 * @param item The menu item object.
16186 * @return The enabled/disabled state of the item
16188 * @see elm_menu_item_disabled_set()
16190 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16192 * @brief Add a separator item to menu @p obj under @p parent.
16194 * @param obj The menu object
16195 * @param parent The item to add the separator under
16196 * @return The created item or NULL on failure
16198 * This is item is a @ref Separator.
16200 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16202 * @brief Returns whether @p item is a separator.
16204 * @param item The item to check
16205 * @return If true, @p item is a separator
16207 * @see elm_menu_item_separator_add()
16209 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16211 * @brief Deletes an item from the menu.
16213 * @param item The item to delete.
16215 * @see elm_menu_item_add()
16217 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16219 * @brief Set the function called when a menu item is deleted.
16221 * @param item The item to set the callback on
16222 * @param func The function called
16224 * @see elm_menu_item_add()
16225 * @see elm_menu_item_del()
16227 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16229 * @brief Returns the data associated with menu item @p item.
16231 * @param item The item
16232 * @return The data associated with @p item or NULL if none was set.
16234 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16236 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16238 * @brief Sets the data to be associated with menu item @p item.
16240 * @param item The item
16241 * @param data The data to be associated with @p item
16243 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16245 * @brief Returns a list of @p item's subitems.
16247 * @param item The item
16248 * @return An Eina_List* of @p item's subitems
16250 * @see elm_menu_add()
16252 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16254 * @brief Get the position of a menu item
16256 * @param item The menu item
16257 * @return The item's index
16259 * This function returns the index position of a menu item in a menu.
16260 * For a sub-menu, this number is relative to the first item in the sub-menu.
16262 * @note Index values begin with 0
16264 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16266 * @brief @brief Return a menu item's owner menu
16268 * @param item The menu item
16269 * @return The menu object owning @p item, or NULL on failure
16271 * Use this function to get the menu object owning an item.
16273 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16275 * @brief Get the selected item in the menu
16277 * @param obj The menu object
16278 * @return The selected item, or NULL if none
16280 * @see elm_menu_item_selected_get()
16281 * @see elm_menu_item_selected_set()
16283 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16285 * @brief Get the last item in the menu
16287 * @param obj The menu object
16288 * @return The last item, or NULL if none
16290 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16292 * @brief Get the first item in the menu
16294 * @param obj The menu object
16295 * @return The first item, or NULL if none
16297 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16299 * @brief Get the next item in the menu.
16301 * @param item The menu item object.
16302 * @return The item after it, or NULL if none
16304 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16306 * @brief Get the previous item in the menu.
16308 * @param item The menu item object.
16309 * @return The item before it, or NULL if none
16311 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16317 * @defgroup List List
16318 * @ingroup Elementary
16320 * @image html img/widget/list/preview-00.png
16321 * @image latex img/widget/list/preview-00.eps width=\textwidth
16323 * @image html img/list.png
16324 * @image latex img/list.eps width=\textwidth
16326 * A list widget is a container whose children are displayed vertically or
16327 * horizontally, in order, and can be selected.
16328 * The list can accept only one or multiple items selection. Also has many
16329 * modes of items displaying.
16331 * A list is a very simple type of list widget. For more robust
16332 * lists, @ref Genlist should probably be used.
16334 * Smart callbacks one can listen to:
16335 * - @c "activated" - The user has double-clicked or pressed
16336 * (enter|return|spacebar) on an item. The @c event_info parameter
16337 * is the item that was activated.
16338 * - @c "clicked,double" - The user has double-clicked an item.
16339 * The @c event_info parameter is the item that was double-clicked.
16340 * - "selected" - when the user selected an item
16341 * - "unselected" - when the user unselected an item
16342 * - "longpressed" - an item in the list is long-pressed
16343 * - "edge,top" - the list is scrolled until the top edge
16344 * - "edge,bottom" - the list is scrolled until the bottom edge
16345 * - "edge,left" - the list is scrolled until the left edge
16346 * - "edge,right" - the list is scrolled until the right edge
16347 * - "language,changed" - the program's language changed
16349 * Available styles for it:
16352 * List of examples:
16353 * @li @ref list_example_01
16354 * @li @ref list_example_02
16355 * @li @ref list_example_03
16364 * @enum _Elm_List_Mode
16365 * @typedef Elm_List_Mode
16367 * Set list's resize behavior, transverse axis scroll and
16368 * items cropping. See each mode's description for more details.
16370 * @note Default value is #ELM_LIST_SCROLL.
16372 * Values <b> don't </b> work as bitmask, only one can be choosen.
16374 * @see elm_list_mode_set()
16375 * @see elm_list_mode_get()
16379 typedef enum _Elm_List_Mode
16381 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. */
16382 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). */
16383 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. */
16384 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. */
16385 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16388 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(). */
16391 * Add a new list widget to the given parent Elementary
16392 * (container) object.
16394 * @param parent The parent object.
16395 * @return a new list widget handle or @c NULL, on errors.
16397 * This function inserts a new list widget on the canvas.
16401 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16406 * @param obj The list object
16408 * @note Call before running show() on the list object.
16409 * @warning If not called, it won't display the list properly.
16412 * li = elm_list_add(win);
16413 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16414 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16416 * evas_object_show(li);
16421 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16424 * Enable or disable multiple items selection on the list object.
16426 * @param obj The list object
16427 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16430 * Disabled by default. If disabled, the user can select a single item of
16431 * the list each time. Selected items are highlighted on list.
16432 * If enabled, many items can be selected.
16434 * If a selected item is selected again, it will be unselected.
16436 * @see elm_list_multi_select_get()
16440 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16443 * Get a value whether multiple items selection is enabled or not.
16445 * @see elm_list_multi_select_set() for details.
16447 * @param obj The list object.
16448 * @return @c EINA_TRUE means multiple items selection is enabled.
16449 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16450 * @c EINA_FALSE is returned.
16454 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16457 * Set which mode to use for the list object.
16459 * @param obj The list object
16460 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16461 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16463 * Set list's resize behavior, transverse axis scroll and
16464 * items cropping. See each mode's description for more details.
16466 * @note Default value is #ELM_LIST_SCROLL.
16468 * Only one can be set, if a previous one was set, it will be changed
16469 * by the new mode set. Bitmask won't work as well.
16471 * @see elm_list_mode_get()
16475 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16478 * Get the mode the list is at.
16480 * @param obj The list object
16481 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16482 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16484 * @note see elm_list_mode_set() for more information.
16488 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16491 * Enable or disable horizontal mode on the list object.
16493 * @param obj The list object.
16494 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16495 * disable it, i.e., to enable vertical mode.
16497 * @note Vertical mode is set by default.
16499 * On horizontal mode items are displayed on list from left to right,
16500 * instead of from top to bottom. Also, the list will scroll horizontally.
16501 * Each item will presents left icon on top and right icon, or end, at
16504 * @see elm_list_horizontal_get()
16508 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16511 * Get a value whether horizontal mode is enabled or not.
16513 * @param obj The list object.
16514 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16515 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16516 * @c EINA_FALSE is returned.
16518 * @see elm_list_horizontal_set() for details.
16522 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16525 * Enable or disable always select mode on the list object.
16527 * @param obj The list object
16528 * @param always_select @c EINA_TRUE to enable always select mode or
16529 * @c EINA_FALSE to disable it.
16531 * @note Always select mode is disabled by default.
16533 * Default behavior of list items is to only call its callback function
16534 * the first time it's pressed, i.e., when it is selected. If a selected
16535 * item is pressed again, and multi-select is disabled, it won't call
16536 * this function (if multi-select is enabled it will unselect the item).
16538 * If always select is enabled, it will call the callback function
16539 * everytime a item is pressed, so it will call when the item is selected,
16540 * and again when a selected item is pressed.
16542 * @see elm_list_always_select_mode_get()
16543 * @see elm_list_multi_select_set()
16547 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16550 * Get a value whether always select mode is enabled or not, meaning that
16551 * an item will always call its callback function, even if already selected.
16553 * @param obj The list object
16554 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16555 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16556 * @c EINA_FALSE is returned.
16558 * @see elm_list_always_select_mode_set() for details.
16562 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16565 * Set bouncing behaviour when the scrolled content reaches an edge.
16567 * Tell the internal scroller object whether it should bounce or not
16568 * when it reaches the respective edges for each axis.
16570 * @param obj The list object
16571 * @param h_bounce Whether to bounce or not in the horizontal axis.
16572 * @param v_bounce Whether to bounce or not in the vertical axis.
16574 * @see elm_scroller_bounce_set()
16578 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16581 * Get the bouncing behaviour of the internal scroller.
16583 * Get whether the internal scroller should bounce when the edge of each
16584 * axis is reached scrolling.
16586 * @param obj The list object.
16587 * @param h_bounce Pointer where to store the bounce state of the horizontal
16589 * @param v_bounce Pointer where to store the bounce state of the vertical
16592 * @see elm_scroller_bounce_get()
16593 * @see elm_list_bounce_set()
16597 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16600 * Set the scrollbar policy.
16602 * @param obj The list object
16603 * @param policy_h Horizontal scrollbar policy.
16604 * @param policy_v Vertical scrollbar policy.
16606 * This sets the scrollbar visibility policy for the given scroller.
16607 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16608 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16609 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16610 * This applies respectively for the horizontal and vertical scrollbars.
16612 * The both are disabled by default, i.e., are set to
16613 * #ELM_SCROLLER_POLICY_OFF.
16617 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16620 * Get the scrollbar policy.
16622 * @see elm_list_scroller_policy_get() for details.
16624 * @param obj The list object.
16625 * @param policy_h Pointer where to store horizontal scrollbar policy.
16626 * @param policy_v Pointer where to store vertical scrollbar policy.
16630 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);
16633 * Append a new item to the list object.
16635 * @param obj The list object.
16636 * @param label The label of the list item.
16637 * @param icon The icon object to use for the left side of the item. An
16638 * icon can be any Evas object, but usually it is an icon created
16639 * with elm_icon_add().
16640 * @param end The icon object to use for the right side of the item. An
16641 * icon can be any Evas object.
16642 * @param func The function to call when the item is clicked.
16643 * @param data The data to associate with the item for related callbacks.
16645 * @return The created item or @c NULL upon failure.
16647 * A new item will be created and appended to the list, i.e., will
16648 * be set as @b last item.
16650 * Items created with this method can be deleted with
16651 * elm_list_item_del().
16653 * Associated @p data can be properly freed when item is deleted if a
16654 * callback function is set with elm_list_item_del_cb_set().
16656 * If a function is passed as argument, it will be called everytime this item
16657 * is selected, i.e., the user clicks over an unselected item.
16658 * If always select is enabled it will call this function every time
16659 * user clicks over an item (already selected or not).
16660 * If such function isn't needed, just passing
16661 * @c NULL as @p func is enough. The same should be done for @p data.
16663 * Simple example (with no function callback or data associated):
16665 * li = elm_list_add(win);
16666 * ic = elm_icon_add(win);
16667 * elm_icon_file_set(ic, "path/to/image", NULL);
16668 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16669 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16671 * evas_object_show(li);
16674 * @see elm_list_always_select_mode_set()
16675 * @see elm_list_item_del()
16676 * @see elm_list_item_del_cb_set()
16677 * @see elm_list_clear()
16678 * @see elm_icon_add()
16682 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);
16685 * Prepend a new item to the list object.
16687 * @param obj The list object.
16688 * @param label The label of the list item.
16689 * @param icon The icon object to use for the left side of the item. An
16690 * icon can be any Evas object, but usually it is an icon created
16691 * with elm_icon_add().
16692 * @param end The icon object to use for the right side of the item. An
16693 * icon can be any Evas object.
16694 * @param func The function to call when the item is clicked.
16695 * @param data The data to associate with the item for related callbacks.
16697 * @return The created item or @c NULL upon failure.
16699 * A new item will be created and prepended to the list, i.e., will
16700 * be set as @b first item.
16702 * Items created with this method can be deleted with
16703 * elm_list_item_del().
16705 * Associated @p data can be properly freed when item is deleted if a
16706 * callback function is set with elm_list_item_del_cb_set().
16708 * If a function is passed as argument, it will be called everytime this item
16709 * is selected, i.e., the user clicks over an unselected item.
16710 * If always select is enabled it will call this function every time
16711 * user clicks over an item (already selected or not).
16712 * If such function isn't needed, just passing
16713 * @c NULL as @p func is enough. The same should be done for @p data.
16715 * @see elm_list_item_append() for a simple code example.
16716 * @see elm_list_always_select_mode_set()
16717 * @see elm_list_item_del()
16718 * @see elm_list_item_del_cb_set()
16719 * @see elm_list_clear()
16720 * @see elm_icon_add()
16724 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);
16727 * Insert a new item into the list object before item @p before.
16729 * @param obj The list object.
16730 * @param before The list item to insert before.
16731 * @param label The label of the list item.
16732 * @param icon The icon object to use for the left side of the item. An
16733 * icon can be any Evas object, but usually it is an icon created
16734 * with elm_icon_add().
16735 * @param end The icon object to use for the right side of the item. An
16736 * icon can be any Evas object.
16737 * @param func The function to call when the item is clicked.
16738 * @param data The data to associate with the item for related callbacks.
16740 * @return The created item or @c NULL upon failure.
16742 * A new item will be created and added to the list. Its position in
16743 * this list will be just before item @p before.
16745 * Items created with this method can be deleted with
16746 * elm_list_item_del().
16748 * Associated @p data can be properly freed when item is deleted if a
16749 * callback function is set with elm_list_item_del_cb_set().
16751 * If a function is passed as argument, it will be called everytime this item
16752 * is selected, i.e., the user clicks over an unselected item.
16753 * If always select is enabled it will call this function every time
16754 * user clicks over an item (already selected or not).
16755 * If such function isn't needed, just passing
16756 * @c NULL as @p func is enough. The same should be done for @p data.
16758 * @see elm_list_item_append() for a simple code example.
16759 * @see elm_list_always_select_mode_set()
16760 * @see elm_list_item_del()
16761 * @see elm_list_item_del_cb_set()
16762 * @see elm_list_clear()
16763 * @see elm_icon_add()
16767 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);
16770 * Insert a new item into the list object after item @p after.
16772 * @param obj The list object.
16773 * @param after The list item to insert after.
16774 * @param label The label of the list item.
16775 * @param icon The icon object to use for the left side of the item. An
16776 * icon can be any Evas object, but usually it is an icon created
16777 * with elm_icon_add().
16778 * @param end The icon object to use for the right side of the item. An
16779 * icon can be any Evas object.
16780 * @param func The function to call when the item is clicked.
16781 * @param data The data to associate with the item for related callbacks.
16783 * @return The created item or @c NULL upon failure.
16785 * A new item will be created and added to the list. Its position in
16786 * this list will be just after item @p after.
16788 * Items created with this method can be deleted with
16789 * elm_list_item_del().
16791 * Associated @p data can be properly freed when item is deleted if a
16792 * callback function is set with elm_list_item_del_cb_set().
16794 * If a function is passed as argument, it will be called everytime this item
16795 * is selected, i.e., the user clicks over an unselected item.
16796 * If always select is enabled it will call this function every time
16797 * user clicks over an item (already selected or not).
16798 * If such function isn't needed, just passing
16799 * @c NULL as @p func is enough. The same should be done for @p data.
16801 * @see elm_list_item_append() for a simple code example.
16802 * @see elm_list_always_select_mode_set()
16803 * @see elm_list_item_del()
16804 * @see elm_list_item_del_cb_set()
16805 * @see elm_list_clear()
16806 * @see elm_icon_add()
16810 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);
16813 * Insert a new item into the sorted list object.
16815 * @param obj The list object.
16816 * @param label The label of the list item.
16817 * @param icon The icon object to use for the left side of the item. An
16818 * icon can be any Evas object, but usually it is an icon created
16819 * with elm_icon_add().
16820 * @param end The icon object to use for the right side of the item. An
16821 * icon can be any Evas object.
16822 * @param func The function to call when the item is clicked.
16823 * @param data The data to associate with the item for related callbacks.
16824 * @param cmp_func The comparing function to be used to sort list
16825 * items <b>by #Elm_List_Item item handles</b>. This function will
16826 * receive two items and compare them, returning a non-negative integer
16827 * if the second item should be place after the first, or negative value
16828 * if should be placed before.
16830 * @return The created item or @c NULL upon failure.
16832 * @note This function inserts values into a list object assuming it was
16833 * sorted and the result will be sorted.
16835 * A new item will be created and added to the list. Its position in
16836 * this list will be found comparing the new item with previously inserted
16837 * items using function @p cmp_func.
16839 * Items created with this method can be deleted with
16840 * elm_list_item_del().
16842 * Associated @p data can be properly freed when item is deleted if a
16843 * callback function is set with elm_list_item_del_cb_set().
16845 * If a function is passed as argument, it will be called everytime this item
16846 * is selected, i.e., the user clicks over an unselected item.
16847 * If always select is enabled it will call this function every time
16848 * user clicks over an item (already selected or not).
16849 * If such function isn't needed, just passing
16850 * @c NULL as @p func is enough. The same should be done for @p data.
16852 * @see elm_list_item_append() for a simple code example.
16853 * @see elm_list_always_select_mode_set()
16854 * @see elm_list_item_del()
16855 * @see elm_list_item_del_cb_set()
16856 * @see elm_list_clear()
16857 * @see elm_icon_add()
16861 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);
16864 * Remove all list's items.
16866 * @param obj The list object
16868 * @see elm_list_item_del()
16869 * @see elm_list_item_append()
16873 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16876 * Get a list of all the list items.
16878 * @param obj The list object
16879 * @return An @c Eina_List of list items, #Elm_List_Item,
16880 * or @c NULL on failure.
16882 * @see elm_list_item_append()
16883 * @see elm_list_item_del()
16884 * @see elm_list_clear()
16888 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16891 * Get the selected item.
16893 * @param obj The list object.
16894 * @return The selected list item.
16896 * The selected item can be unselected with function
16897 * elm_list_item_selected_set().
16899 * The selected item always will be highlighted on list.
16901 * @see elm_list_selected_items_get()
16905 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16908 * Return a list of the currently selected list items.
16910 * @param obj The list object.
16911 * @return An @c Eina_List of list items, #Elm_List_Item,
16912 * or @c NULL on failure.
16914 * Multiple items can be selected if multi select is enabled. It can be
16915 * done with elm_list_multi_select_set().
16917 * @see elm_list_selected_item_get()
16918 * @see elm_list_multi_select_set()
16922 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16925 * Set the selected state of an item.
16927 * @param item The list item
16928 * @param selected The selected state
16930 * This sets the selected state of the given item @p it.
16931 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16933 * If a new item is selected the previosly selected will be unselected,
16934 * unless multiple selection is enabled with elm_list_multi_select_set().
16935 * Previoulsy selected item can be get with function
16936 * elm_list_selected_item_get().
16938 * Selected items will be highlighted.
16940 * @see elm_list_item_selected_get()
16941 * @see elm_list_selected_item_get()
16942 * @see elm_list_multi_select_set()
16946 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16949 * Get whether the @p item is selected or not.
16951 * @param item The list item.
16952 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16953 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16955 * @see elm_list_selected_item_set() for details.
16956 * @see elm_list_item_selected_get()
16960 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16963 * Set or unset item as a separator.
16965 * @param it The list item.
16966 * @param setting @c EINA_TRUE to set item @p it as separator or
16967 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16969 * Items aren't set as separator by default.
16971 * If set as separator it will display separator theme, so won't display
16974 * @see elm_list_item_separator_get()
16978 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16981 * Get a value whether item is a separator or not.
16983 * @see elm_list_item_separator_set() for details.
16985 * @param it The list item.
16986 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16987 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16991 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16994 * Show @p item in the list view.
16996 * @param item The list item to be shown.
16998 * It won't animate list until item is visible. If such behavior is wanted,
16999 * use elm_list_bring_in() intead.
17003 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17006 * Bring in the given item to list view.
17008 * @param item The item.
17010 * This causes list to jump to the given item @p item and show it
17011 * (by scrolling), if it is not fully visible.
17013 * This may use animation to do so and take a period of time.
17015 * If animation isn't wanted, elm_list_item_show() can be used.
17019 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17022 * Delete them item from the list.
17024 * @param item The item of list to be deleted.
17026 * If deleting all list items is required, elm_list_clear()
17027 * should be used instead of getting items list and deleting each one.
17029 * @see elm_list_clear()
17030 * @see elm_list_item_append()
17031 * @see elm_list_item_del_cb_set()
17035 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17038 * Set the function called when a list item is freed.
17040 * @param item The item to set the callback on
17041 * @param func The function called
17043 * If there is a @p func, then it will be called prior item's memory release.
17044 * That will be called with the following arguments:
17046 * @li item's Evas object;
17049 * This way, a data associated to a list item could be properly freed.
17053 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17056 * Get the data associated to the item.
17058 * @param item The list item
17059 * @return The data associated to @p item
17061 * The return value is a pointer to data associated to @p item when it was
17062 * created, with function elm_list_item_append() or similar. If no data
17063 * was passed as argument, it will return @c NULL.
17065 * @see elm_list_item_append()
17069 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17072 * Get the left side icon associated to the item.
17074 * @param item The list item
17075 * @return The left side icon associated to @p item
17077 * The return value is a pointer to the icon associated to @p item when
17079 * created, with function elm_list_item_append() or similar, or later
17080 * with function elm_list_item_icon_set(). If no icon
17081 * was passed as argument, it will return @c NULL.
17083 * @see elm_list_item_append()
17084 * @see elm_list_item_icon_set()
17088 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17091 * Set the left side icon associated to the item.
17093 * @param item The list item
17094 * @param icon The left side icon object to associate with @p item
17096 * The icon object to use at left side of the item. An
17097 * icon can be any Evas object, but usually it is an icon created
17098 * with elm_icon_add().
17100 * Once the icon object is set, a previously set one will be deleted.
17101 * @warning Setting the same icon for two items will cause the icon to
17102 * dissapear from the first item.
17104 * If an icon was passed as argument on item creation, with function
17105 * elm_list_item_append() or similar, it will be already
17106 * associated to the item.
17108 * @see elm_list_item_append()
17109 * @see elm_list_item_icon_get()
17113 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17116 * Get the right side icon associated to the item.
17118 * @param item The list item
17119 * @return The right side icon associated to @p item
17121 * The return value is a pointer to the icon associated to @p item when
17123 * created, with function elm_list_item_append() or similar, or later
17124 * with function elm_list_item_icon_set(). If no icon
17125 * was passed as argument, it will return @c NULL.
17127 * @see elm_list_item_append()
17128 * @see elm_list_item_icon_set()
17132 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17135 * Set the right side icon associated to the item.
17137 * @param item The list item
17138 * @param end The right side icon object to associate with @p item
17140 * The icon object to use at right side of the item. An
17141 * icon can be any Evas object, but usually it is an icon created
17142 * with elm_icon_add().
17144 * Once the icon object is set, a previously set one will be deleted.
17145 * @warning Setting the same icon for two items will cause the icon to
17146 * dissapear from the first item.
17148 * If an icon was passed as argument on item creation, with function
17149 * elm_list_item_append() or similar, it will be already
17150 * associated to the item.
17152 * @see elm_list_item_append()
17153 * @see elm_list_item_end_get()
17157 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17160 * Gets the base object of the item.
17162 * @param item The list item
17163 * @return The base object associated with @p item
17165 * Base object is the @c Evas_Object that represents that item.
17169 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17170 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17173 * Get the label of item.
17175 * @param item The item of list.
17176 * @return The label of item.
17178 * The return value is a pointer to the label associated to @p item when
17179 * it was created, with function elm_list_item_append(), or later
17180 * with function elm_list_item_label_set. If no label
17181 * was passed as argument, it will return @c NULL.
17183 * @see elm_list_item_label_set() for more details.
17184 * @see elm_list_item_append()
17188 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17191 * Set the label of item.
17193 * @param item The item of list.
17194 * @param text The label of item.
17196 * The label to be displayed by the item.
17197 * Label will be placed between left and right side icons (if set).
17199 * If a label was passed as argument on item creation, with function
17200 * elm_list_item_append() or similar, it will be already
17201 * displayed by the item.
17203 * @see elm_list_item_label_get()
17204 * @see elm_list_item_append()
17208 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17212 * Get the item before @p it in list.
17214 * @param it The list item.
17215 * @return The item before @p it, or @c NULL if none or on failure.
17217 * @note If it is the first item, @c NULL will be returned.
17219 * @see elm_list_item_append()
17220 * @see elm_list_items_get()
17224 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17227 * Get the item after @p it in list.
17229 * @param it The list item.
17230 * @return The item after @p it, or @c NULL if none or on failure.
17232 * @note If it is the last item, @c NULL will be returned.
17234 * @see elm_list_item_append()
17235 * @see elm_list_items_get()
17239 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17242 * Sets the disabled/enabled state of a list item.
17244 * @param it The item.
17245 * @param disabled The disabled state.
17247 * A disabled item cannot be selected or unselected. It will also
17248 * change its appearance (generally greyed out). This sets the
17249 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17254 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17257 * Get a value whether list item is disabled or not.
17259 * @param it The item.
17260 * @return The disabled state.
17262 * @see elm_list_item_disabled_set() for more details.
17266 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17269 * Set the text to be shown in a given list item's tooltips.
17271 * @param item Target item.
17272 * @param text The text to set in the content.
17274 * Setup the text as tooltip to object. The item can have only one tooltip,
17275 * so any previous tooltip data - set with this function or
17276 * elm_list_item_tooltip_content_cb_set() - is removed.
17278 * @see elm_object_tooltip_text_set() for more details.
17282 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17286 * @brief Disable size restrictions on an object's tooltip
17287 * @param item The tooltip's anchor object
17288 * @param disable If EINA_TRUE, size restrictions are disabled
17289 * @return EINA_FALSE on failure, EINA_TRUE on success
17291 * This function allows a tooltip to expand beyond its parant window's canvas.
17292 * It will instead be limited only by the size of the display.
17294 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17296 * @brief Retrieve size restriction state of an object's tooltip
17297 * @param obj The tooltip's anchor object
17298 * @return If EINA_TRUE, size restrictions are disabled
17300 * This function returns whether a tooltip is allowed to expand beyond
17301 * its parant window's canvas.
17302 * It will instead be limited only by the size of the display.
17304 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17307 * Set the content to be shown in the tooltip item.
17309 * Setup the tooltip to item. The item can have only one tooltip,
17310 * so any previous tooltip data is removed. @p func(with @p data) will
17311 * be called every time that need show the tooltip and it should
17312 * return a valid Evas_Object. This object is then managed fully by
17313 * tooltip system and is deleted when the tooltip is gone.
17315 * @param item the list item being attached a tooltip.
17316 * @param func the function used to create the tooltip contents.
17317 * @param data what to provide to @a func as callback data/context.
17318 * @param del_cb called when data is not needed anymore, either when
17319 * another callback replaces @a func, the tooltip is unset with
17320 * elm_list_item_tooltip_unset() or the owner @a item
17321 * dies. This callback receives as the first parameter the
17322 * given @a data, and @c event_info is the item.
17324 * @see elm_object_tooltip_content_cb_set() for more details.
17328 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);
17331 * Unset tooltip from item.
17333 * @param item list item to remove previously set tooltip.
17335 * Remove tooltip from item. The callback provided as del_cb to
17336 * elm_list_item_tooltip_content_cb_set() will be called to notify
17337 * it is not used anymore.
17339 * @see elm_object_tooltip_unset() for more details.
17340 * @see elm_list_item_tooltip_content_cb_set()
17344 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17347 * Sets a different style for this item tooltip.
17349 * @note before you set a style you should define a tooltip with
17350 * elm_list_item_tooltip_content_cb_set() or
17351 * elm_list_item_tooltip_text_set()
17353 * @param item list item with tooltip already set.
17354 * @param style the theme style to use (default, transparent, ...)
17356 * @see elm_object_tooltip_style_set() for more details.
17360 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17363 * Get the style for this item tooltip.
17365 * @param item list item with tooltip already set.
17366 * @return style the theme style in use, defaults to "default". If the
17367 * object does not have a tooltip set, then NULL is returned.
17369 * @see elm_object_tooltip_style_get() for more details.
17370 * @see elm_list_item_tooltip_style_set()
17374 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17377 * Set the type of mouse pointer/cursor decoration to be shown,
17378 * when the mouse pointer is over the given list widget item
17380 * @param item list item to customize cursor on
17381 * @param cursor the cursor type's name
17383 * This function works analogously as elm_object_cursor_set(), but
17384 * here the cursor's changing area is restricted to the item's
17385 * area, and not the whole widget's. Note that that item cursors
17386 * have precedence over widget cursors, so that a mouse over an
17387 * item with custom cursor set will always show @b that cursor.
17389 * If this function is called twice for an object, a previously set
17390 * cursor will be unset on the second call.
17392 * @see elm_object_cursor_set()
17393 * @see elm_list_item_cursor_get()
17394 * @see elm_list_item_cursor_unset()
17398 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17401 * Get the type of mouse pointer/cursor decoration set to be shown,
17402 * when the mouse pointer is over the given list widget item
17404 * @param item list item with custom cursor set
17405 * @return the cursor type's name or @c NULL, if no custom cursors
17406 * were set to @p item (and on errors)
17408 * @see elm_object_cursor_get()
17409 * @see elm_list_item_cursor_set()
17410 * @see elm_list_item_cursor_unset()
17414 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17417 * Unset any custom mouse pointer/cursor decoration set to be
17418 * shown, when the mouse pointer is over the given list widget
17419 * item, thus making it show the @b default cursor again.
17421 * @param item a list item
17423 * Use this call to undo any custom settings on this item's cursor
17424 * decoration, bringing it back to defaults (no custom style set).
17426 * @see elm_object_cursor_unset()
17427 * @see elm_list_item_cursor_set()
17431 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17434 * Set a different @b style for a given custom cursor set for a
17437 * @param item list item with custom cursor set
17438 * @param style the <b>theme style</b> to use (e.g. @c "default",
17439 * @c "transparent", etc)
17441 * This function only makes sense when one is using custom mouse
17442 * cursor decorations <b>defined in a theme file</b>, which can have,
17443 * given a cursor name/type, <b>alternate styles</b> on it. It
17444 * works analogously as elm_object_cursor_style_set(), but here
17445 * applyed only to list item objects.
17447 * @warning Before you set a cursor style you should have definen a
17448 * custom cursor previously on the item, with
17449 * elm_list_item_cursor_set()
17451 * @see elm_list_item_cursor_engine_only_set()
17452 * @see elm_list_item_cursor_style_get()
17456 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17459 * Get the current @b style set for a given list item's custom
17462 * @param item list item with custom cursor set.
17463 * @return style the cursor style in use. If the object does not
17464 * have a cursor set, then @c NULL is returned.
17466 * @see elm_list_item_cursor_style_set() for more details
17470 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17473 * Set if the (custom)cursor for a given list item should be
17474 * searched in its theme, also, or should only rely on the
17475 * rendering engine.
17477 * @param item item with custom (custom) cursor already set on
17478 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17479 * only on those provided by the rendering engine, @c EINA_FALSE to
17480 * have them searched on the widget's theme, as well.
17482 * @note This call is of use only if you've set a custom cursor
17483 * for list items, with elm_list_item_cursor_set().
17485 * @note By default, cursors will only be looked for between those
17486 * provided by the rendering engine.
17490 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17493 * Get if the (custom) cursor for a given list item is being
17494 * searched in its theme, also, or is only relying on the rendering
17497 * @param item a list item
17498 * @return @c EINA_TRUE, if cursors are being looked for only on
17499 * those provided by the rendering engine, @c EINA_FALSE if they
17500 * are being searched on the widget's theme, as well.
17502 * @see elm_list_item_cursor_engine_only_set(), for more details
17506 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17513 * @defgroup Slider Slider
17514 * @ingroup Elementary
17516 * @image html img/widget/slider/preview-00.png
17517 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17519 * The slider adds a dragable āsliderā widget for selecting the value of
17520 * something within a range.
17522 * A slider can be horizontal or vertical. It can contain an Icon and has a
17523 * primary label as well as a units label (that is formatted with floating
17524 * point values and thus accepts a printf-style format string, like
17525 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17526 * else (like on the slider itself) that also accepts a format string like
17527 * units. Label, Icon Unit and Indicator strings/objects are optional.
17529 * A slider may be inverted which means values invert, with high vales being
17530 * on the left or top and low values on the right or bottom (as opposed to
17531 * normally being low on the left or top and high on the bottom and right).
17533 * The slider should have its minimum and maximum values set by the
17534 * application with elm_slider_min_max_set() and value should also be set by
17535 * the application before use with elm_slider_value_set(). The span of the
17536 * slider is its length (horizontally or vertically). This will be scaled by
17537 * the object or applications scaling factor. At any point code can query the
17538 * slider for its value with elm_slider_value_get().
17540 * Smart callbacks one can listen to:
17541 * - "changed" - Whenever the slider value is changed by the user.
17542 * - "slider,drag,start" - dragging the slider indicator around has started.
17543 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17544 * - "delay,changed" - A short time after the value is changed by the user.
17545 * This will be called only when the user stops dragging for
17546 * a very short period or when they release their
17547 * finger/mouse, so it avoids possibly expensive reactions to
17548 * the value change.
17550 * Available styles for it:
17553 * Default contents parts of the slider widget that you can use for are:
17554 * @li "icon" - A icon of the slider
17555 * @li "end" - A end part content of the slider
17557 * Default text parts of the silder widget that you can use for are:
17558 * @li "default" - Label of the silder
17559 * Here is an example on its usage:
17560 * @li @ref slider_example
17564 * @addtogroup Slider
17569 * Add a new slider widget to the given parent Elementary
17570 * (container) object.
17572 * @param parent The parent object.
17573 * @return a new slider widget handle or @c NULL, on errors.
17575 * This function inserts a new slider widget on the canvas.
17579 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17582 * Set the label of a given slider widget
17584 * @param obj The progress bar object
17585 * @param label The text label string, in UTF-8
17588 * @deprecated use elm_object_text_set() instead.
17590 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17593 * Get the label of a given slider widget
17595 * @param obj The progressbar object
17596 * @return The text label string, in UTF-8
17599 * @deprecated use elm_object_text_get() instead.
17601 WILL_DEPRECATE EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17604 * Set the icon object of the slider object.
17606 * @param obj The slider object.
17607 * @param icon The icon object.
17609 * On horizontal mode, icon is placed at left, and on vertical mode,
17612 * @note Once the icon object is set, a previously set one will be deleted.
17613 * If you want to keep that old content object, use the
17614 * elm_slider_icon_unset() function.
17616 * @warning If the object being set does not have minimum size hints set,
17617 * it won't get properly displayed.
17620 * @deprecated use elm_object_part_content_set() instead.
17622 WILL_DEPRECATE EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17625 * Unset an icon set on a given slider widget.
17627 * @param obj The slider object.
17628 * @return The icon object that was being used, if any was set, or
17629 * @c NULL, otherwise (and on errors).
17631 * On horizontal mode, icon is placed at left, and on vertical mode,
17634 * This call will unparent and return the icon object which was set
17635 * for this widget, previously, on success.
17637 * @see elm_slider_icon_set() for more details
17638 * @see elm_slider_icon_get()
17639 * @deprecated use elm_object_part_content_unset() instead.
17643 WILL_DEPRECATE EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17646 * Retrieve the icon object set for a given slider widget.
17648 * @param obj The slider object.
17649 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17650 * otherwise (and on errors).
17652 * On horizontal mode, icon is placed at left, and on vertical mode,
17655 * @see elm_slider_icon_set() for more details
17656 * @see elm_slider_icon_unset()
17658 * @deprecated use elm_object_part_content_get() instead.
17662 WILL_DEPRECATE EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17665 * Set the end object of the slider object.
17667 * @param obj The slider object.
17668 * @param end The end object.
17670 * On horizontal mode, end is placed at left, and on vertical mode,
17671 * placed at bottom.
17673 * @note Once the icon object is set, a previously set one will be deleted.
17674 * If you want to keep that old content object, use the
17675 * elm_slider_end_unset() function.
17677 * @warning If the object being set does not have minimum size hints set,
17678 * it won't get properly displayed.
17680 * @deprecated use elm_object_part_content_set() instead.
17684 WILL_DEPRECATE EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17687 * Unset an end object set on a given slider widget.
17689 * @param obj The slider object.
17690 * @return The end object that was being used, if any was set, or
17691 * @c NULL, otherwise (and on errors).
17693 * On horizontal mode, end is placed at left, and on vertical mode,
17694 * placed at bottom.
17696 * This call will unparent and return the icon object which was set
17697 * for this widget, previously, on success.
17699 * @see elm_slider_end_set() for more details.
17700 * @see elm_slider_end_get()
17702 * @deprecated use elm_object_part_content_unset() instead
17707 WILL_DEPRECATE EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17710 * Retrieve the end object set for a given slider widget.
17712 * @param obj The slider object.
17713 * @return The end object's handle, if @p obj had one set, or @c NULL,
17714 * otherwise (and on errors).
17716 * On horizontal mode, icon is placed at right, and on vertical mode,
17717 * placed at bottom.
17719 * @see elm_slider_end_set() for more details.
17720 * @see elm_slider_end_unset()
17723 * @deprecated use elm_object_part_content_get() instead
17728 WILL_DEPRECATE EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17731 * Set the (exact) length of the bar region of a given slider widget.
17733 * @param obj The slider object.
17734 * @param size The length of the slider's bar region.
17736 * This sets the minimum width (when in horizontal mode) or height
17737 * (when in vertical mode) of the actual bar area of the slider
17738 * @p obj. This in turn affects the object's minimum size. Use
17739 * this when you're not setting other size hints expanding on the
17740 * given direction (like weight and alignment hints) and you would
17741 * like it to have a specific size.
17743 * @note Icon, end, label, indicator and unit text around @p obj
17744 * will require their
17745 * own space, which will make @p obj to require more the @p size,
17748 * @see elm_slider_span_size_get()
17752 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17755 * Get the length set for the bar region of a given slider widget
17757 * @param obj The slider object.
17758 * @return The length of the slider's bar region.
17760 * If that size was not set previously, with
17761 * elm_slider_span_size_set(), this call will return @c 0.
17765 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17768 * Set the format string for the unit label.
17770 * @param obj The slider object.
17771 * @param format The format string for the unit display.
17773 * Unit label is displayed all the time, if set, after slider's bar.
17774 * In horizontal mode, at right and in vertical mode, at bottom.
17776 * If @c NULL, unit label won't be visible. If not it sets the format
17777 * string for the label text. To the label text is provided a floating point
17778 * value, so the label text can display up to 1 floating point value.
17779 * Note that this is optional.
17781 * Use a format string such as "%1.2f meters" for example, and it will
17782 * display values like: "3.14 meters" for a value equal to 3.14159.
17784 * Default is unit label disabled.
17786 * @see elm_slider_indicator_format_get()
17790 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17793 * Get the unit label format of the slider.
17795 * @param obj The slider object.
17796 * @return The unit label format string in UTF-8.
17798 * Unit label is displayed all the time, if set, after slider's bar.
17799 * In horizontal mode, at right and in vertical mode, at bottom.
17801 * @see elm_slider_unit_format_set() for more
17802 * information on how this works.
17806 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17809 * Set the format string for the indicator label.
17811 * @param obj The slider object.
17812 * @param indicator The format string for the indicator display.
17814 * The slider may display its value somewhere else then unit label,
17815 * for example, above the slider knob that is dragged around. This function
17816 * sets the format string used for this.
17818 * If @c NULL, indicator label won't be visible. If not it sets the format
17819 * string for the label text. To the label text is provided a floating point
17820 * value, so the label text can display up to 1 floating point value.
17821 * Note that this is optional.
17823 * Use a format string such as "%1.2f meters" for example, and it will
17824 * display values like: "3.14 meters" for a value equal to 3.14159.
17826 * Default is indicator label disabled.
17828 * @see elm_slider_indicator_format_get()
17832 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17835 * Get the indicator label format of the slider.
17837 * @param obj The slider object.
17838 * @return The indicator label format string in UTF-8.
17840 * The slider may display its value somewhere else then unit label,
17841 * for example, above the slider knob that is dragged around. This function
17842 * gets the format string used for this.
17844 * @see elm_slider_indicator_format_set() for more
17845 * information on how this works.
17849 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17852 * Set the format function pointer for the indicator label
17854 * @param obj The slider object.
17855 * @param func The indicator format function.
17856 * @param free_func The freeing function for the format string.
17858 * Set the callback function to format the indicator string.
17860 * @see elm_slider_indicator_format_set() for more info on how this works.
17864 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);
17867 * Set the format function pointer for the units label
17869 * @param obj The slider object.
17870 * @param func The units format function.
17871 * @param free_func The freeing function for the format string.
17873 * Set the callback function to format the indicator string.
17875 * @see elm_slider_units_format_set() for more info on how this works.
17879 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);
17882 * Set the orientation of a given slider widget.
17884 * @param obj The slider object.
17885 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17886 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17888 * Use this function to change how your slider is to be
17889 * disposed: vertically or horizontally.
17891 * By default it's displayed horizontally.
17893 * @see elm_slider_horizontal_get()
17897 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17900 * Retrieve the orientation of a given slider widget
17902 * @param obj The slider object.
17903 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17904 * @c EINA_FALSE if it's @b vertical (and on errors).
17906 * @see elm_slider_horizontal_set() for more details.
17910 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17913 * Set the minimum and maximum values for the slider.
17915 * @param obj The slider object.
17916 * @param min The minimum value.
17917 * @param max The maximum value.
17919 * Define the allowed range of values to be selected by the user.
17921 * If actual value is less than @p min, it will be updated to @p min. If it
17922 * is bigger then @p max, will be updated to @p max. Actual value can be
17923 * get with elm_slider_value_get().
17925 * By default, min is equal to 0.0, and max is equal to 1.0.
17927 * @warning Maximum must be greater than minimum, otherwise behavior
17930 * @see elm_slider_min_max_get()
17934 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17937 * Get the minimum and maximum values of the slider.
17939 * @param obj The slider object.
17940 * @param min Pointer where to store the minimum value.
17941 * @param max Pointer where to store the maximum value.
17943 * @note If only one value is needed, the other pointer can be passed
17946 * @see elm_slider_min_max_set() for details.
17950 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17953 * Set the value the slider displays.
17955 * @param obj The slider object.
17956 * @param val The value to be displayed.
17958 * Value will be presented on the unit label following format specified with
17959 * elm_slider_unit_format_set() and on indicator with
17960 * elm_slider_indicator_format_set().
17962 * @warning The value must to be between min and max values. This values
17963 * are set by elm_slider_min_max_set().
17965 * @see elm_slider_value_get()
17966 * @see elm_slider_unit_format_set()
17967 * @see elm_slider_indicator_format_set()
17968 * @see elm_slider_min_max_set()
17972 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17975 * Get the value displayed by the spinner.
17977 * @param obj The spinner object.
17978 * @return The value displayed.
17980 * @see elm_spinner_value_set() for details.
17984 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17987 * Invert a given slider widget's displaying values order
17989 * @param obj The slider object.
17990 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17991 * @c EINA_FALSE to bring it back to default, non-inverted values.
17993 * A slider may be @b inverted, in which state it gets its
17994 * values inverted, with high vales being on the left or top and
17995 * low values on the right or bottom, as opposed to normally have
17996 * the low values on the former and high values on the latter,
17997 * respectively, for horizontal and vertical modes.
17999 * @see elm_slider_inverted_get()
18003 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18006 * Get whether a given slider widget's displaying values are
18009 * @param obj The slider object.
18010 * @return @c EINA_TRUE, if @p obj has inverted values,
18011 * @c EINA_FALSE otherwise (and on errors).
18013 * @see elm_slider_inverted_set() for more details.
18017 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18020 * Set whether to enlarge slider indicator (augmented knob) or not.
18022 * @param obj The slider object.
18023 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18024 * let the knob always at default size.
18026 * By default, indicator will be bigger while dragged by the user.
18028 * @warning It won't display values set with
18029 * elm_slider_indicator_format_set() if you disable indicator.
18033 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18036 * Get whether a given slider widget's enlarging indicator or not.
18038 * @param obj The slider object.
18039 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18040 * @c EINA_FALSE otherwise (and on errors).
18042 * @see elm_slider_indicator_show_set() for details.
18046 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18053 * @addtogroup Actionslider Actionslider
18055 * @image html img/widget/actionslider/preview-00.png
18056 * @image latex img/widget/actionslider/preview-00.eps
18058 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18059 * properties. The user drags and releases the indicator, to choose a label.
18061 * Labels occupy the following positions.
18066 * Positions can be enabled or disabled.
18068 * Magnets can be set on the above positions.
18070 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18072 * @note By default all positions are set as enabled.
18074 * Signals that you can add callbacks for are:
18076 * "selected" - when user selects an enabled position (the label is passed
18079 * "pos_changed" - when the indicator reaches any of the positions("left",
18080 * "right" or "center").
18082 * See an example of actionslider usage @ref actionslider_example_page "here"
18086 typedef enum _Elm_Actionslider_Indicator_Pos
18088 ELM_ACTIONSLIDER_INDICATOR_NONE,
18089 ELM_ACTIONSLIDER_INDICATOR_LEFT,
18090 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18091 ELM_ACTIONSLIDER_INDICATOR_CENTER
18092 } Elm_Actionslider_Indicator_Pos;
18094 typedef enum _Elm_Actionslider_Magnet_Pos
18096 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18097 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18098 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18099 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18100 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18101 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18102 } Elm_Actionslider_Magnet_Pos;
18104 typedef enum _Elm_Actionslider_Label_Pos
18106 ELM_ACTIONSLIDER_LABEL_LEFT,
18107 ELM_ACTIONSLIDER_LABEL_RIGHT,
18108 ELM_ACTIONSLIDER_LABEL_CENTER,
18109 ELM_ACTIONSLIDER_LABEL_BUTTON
18110 } Elm_Actionslider_Label_Pos;
18112 /* smart callbacks called:
18113 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18117 * Add a new actionslider to the parent.
18119 * @param parent The parent object
18120 * @return The new actionslider object or NULL if it cannot be created
18122 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18125 * Set actionslider label.
18127 * @param[in] obj The actionslider object
18128 * @param[in] pos The position of the label.
18129 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18130 * @param label The label which is going to be set.
18132 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18134 * Get actionslider labels.
18136 * @param obj The actionslider object
18137 * @param left_label A char** to place the left_label of @p obj into.
18138 * @param center_label A char** to place the center_label of @p obj into.
18139 * @param right_label A char** to place the right_label of @p obj into.
18141 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);
18143 * Get actionslider selected label.
18145 * @param obj The actionslider object
18146 * @return The selected label
18148 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18150 * Set actionslider indicator position.
18152 * @param obj The actionslider object.
18153 * @param pos The position of the indicator.
18155 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18157 * Get actionslider indicator position.
18159 * @param obj The actionslider object.
18160 * @return The position of the indicator.
18162 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18164 * Set actionslider magnet position. To make multiple positions magnets @c or
18165 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18167 * @param obj The actionslider object.
18168 * @param pos Bit mask indicating the magnet positions.
18170 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18172 * Get actionslider magnet position.
18174 * @param obj The actionslider object.
18175 * @return The positions with magnet property.
18177 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18179 * Set actionslider enabled position. To set multiple positions as enabled @c or
18180 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18182 * @note All the positions are enabled by default.
18184 * @param obj The actionslider object.
18185 * @param pos Bit mask indicating the enabled positions.
18187 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18189 * Get actionslider enabled position.
18191 * @param obj The actionslider object.
18192 * @return The enabled positions.
18194 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18196 * Set the label used on the indicator.
18198 * @param obj The actionslider object
18199 * @param label The label to be set on the indicator.
18200 * @deprecated use elm_object_text_set() instead.
18202 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18204 * Get the label used on the indicator object.
18206 * @param obj The actionslider object
18207 * @return The indicator label
18208 * @deprecated use elm_object_text_get() instead.
18210 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18213 * Hold actionslider object movement.
18215 * @param[in] obj The actionslider object
18216 * @param[in] flag Actionslider hold/release
18217 * (EINA_TURE = hold/EIN_FALSE = release)
18219 * @ingroup Actionslider
18221 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18229 * @defgroup Genlist Genlist
18231 * @image html img/widget/genlist/preview-00.png
18232 * @image latex img/widget/genlist/preview-00.eps
18233 * @image html img/genlist.png
18234 * @image latex img/genlist.eps
18236 * This widget aims to have more expansive list than the simple list in
18237 * Elementary that could have more flexible items and allow many more entries
18238 * while still being fast and low on memory usage. At the same time it was
18239 * also made to be able to do tree structures. But the price to pay is more
18240 * complexity when it comes to usage. If all you want is a simple list with
18241 * icons and a single label, use the normal @ref List object.
18243 * Genlist has a fairly large API, mostly because it's relatively complex,
18244 * trying to be both expansive, powerful and efficient. First we will begin
18245 * an overview on the theory behind genlist.
18247 * @section Genlist_Item_Class Genlist item classes - creating items
18249 * In order to have the ability to add and delete items on the fly, genlist
18250 * implements a class (callback) system where the application provides a
18251 * structure with information about that type of item (genlist may contain
18252 * multiple different items with different classes, states and styles).
18253 * Genlist will call the functions in this struct (methods) when an item is
18254 * "realized" (i.e., created dynamically, while the user is scrolling the
18255 * grid). All objects will simply be deleted when no longer needed with
18256 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18257 * following members:
18258 * - @c item_style - This is a constant string and simply defines the name
18259 * of the item style. It @b must be specified and the default should be @c
18262 * - @c func - A struct with pointers to functions that will be called when
18263 * an item is going to be actually created. All of them receive a @c data
18264 * parameter that will point to the same data passed to
18265 * elm_genlist_item_append() and related item creation functions, and a @c
18266 * obj parameter that points to the genlist object itself.
18268 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18269 * state_get and @c del. The 3 first functions also receive a @c part
18270 * parameter described below. A brief description of these functions follows:
18272 * - @c label_get - The @c part parameter is the name string of one of the
18273 * existing text parts in the Edje group implementing the item's theme.
18274 * This function @b must return a strdup'()ed string, as the caller will
18275 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18276 * - @c content_get - The @c part parameter is the name string of one of the
18277 * existing (content) swallow parts in the Edje group implementing the item's
18278 * theme. It must return @c NULL, when no content is desired, or a valid
18279 * object handle, otherwise. The object will be deleted by the genlist on
18280 * its deletion or when the item is "unrealized". See
18281 * #Elm_Genlist_Item_Content_Get_Cb.
18282 * - @c func.state_get - The @c part parameter is the name string of one of
18283 * the state parts in the Edje group implementing the item's theme. Return
18284 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18285 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18286 * and @c "elm" as "emission" and "source" arguments, respectively, when
18287 * the state is true (the default is false), where @c XXX is the name of
18288 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18289 * - @c func.del - This is intended for use when genlist items are deleted,
18290 * so any data attached to the item (e.g. its data parameter on creation)
18291 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18293 * available item styles:
18295 * - default_style - The text part is a textblock
18297 * @image html img/widget/genlist/preview-04.png
18298 * @image latex img/widget/genlist/preview-04.eps
18302 * @image html img/widget/genlist/preview-01.png
18303 * @image latex img/widget/genlist/preview-01.eps
18305 * - icon_top_text_bottom
18307 * @image html img/widget/genlist/preview-02.png
18308 * @image latex img/widget/genlist/preview-02.eps
18312 * @image html img/widget/genlist/preview-03.png
18313 * @image latex img/widget/genlist/preview-03.eps
18315 * @section Genlist_Items Structure of items
18317 * An item in a genlist can have 0 or more text labels (they can be regular
18318 * text or textblock Evas objects - that's up to the style to determine), 0
18319 * or more contents (which are simply objects swallowed into the genlist item's
18320 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18321 * behavior left to the user to define. The Edje part names for each of
18322 * these properties will be looked up, in the theme file for the genlist,
18323 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18324 * "states", respectively. For each of those properties, if more than one
18325 * part is provided, they must have names listed separated by spaces in the
18326 * data fields. For the default genlist item theme, we have @b one label
18327 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18328 * "elm.swallow.end") and @b no state parts.
18330 * A genlist item may be at one of several styles. Elementary provides one
18331 * by default - "default", but this can be extended by system or application
18332 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18335 * @section Genlist_Manipulation Editing and Navigating
18337 * Items can be added by several calls. All of them return a @ref
18338 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18339 * They all take a data parameter that is meant to be used for a handle to
18340 * the applications internal data (eg the struct with the original item
18341 * data). The parent parameter is the parent genlist item this belongs to if
18342 * it is a tree or an indexed group, and NULL if there is no parent. The
18343 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18344 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18345 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18346 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18347 * is set then this item is group index item that is displayed at the top
18348 * until the next group comes. The func parameter is a convenience callback
18349 * that is called when the item is selected and the data parameter will be
18350 * the func_data parameter, obj be the genlist object and event_info will be
18351 * the genlist item.
18353 * elm_genlist_item_append() adds an item to the end of the list, or if
18354 * there is a parent, to the end of all the child items of the parent.
18355 * elm_genlist_item_prepend() is the same but adds to the beginning of
18356 * the list or children list. elm_genlist_item_insert_before() inserts at
18357 * item before another item and elm_genlist_item_insert_after() inserts after
18358 * the indicated item.
18360 * The application can clear the list with elm_gen_clear() which deletes
18361 * all the items in the list and elm_genlist_item_del() will delete a specific
18362 * item. elm_genlist_item_subitems_clear() will clear all items that are
18363 * children of the indicated parent item.
18365 * To help inspect list items you can jump to the item at the top of the list
18366 * with elm_genlist_first_item_get() which will return the item pointer, and
18367 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18368 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18369 * and previous items respectively relative to the indicated item. Using
18370 * these calls you can walk the entire item list/tree. Note that as a tree
18371 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18372 * let you know which item is the parent (and thus know how to skip them if
18375 * @section Genlist_Muti_Selection Multi-selection
18377 * If the application wants multiple items to be able to be selected,
18378 * elm_genlist_multi_select_set() can enable this. If the list is
18379 * single-selection only (the default), then elm_genlist_selected_item_get()
18380 * will return the selected item, if any, or NULL if none is selected. If the
18381 * list is multi-select then elm_genlist_selected_items_get() will return a
18382 * list (that is only valid as long as no items are modified (added, deleted,
18383 * selected or unselected)).
18385 * @section Genlist_Usage_Hints Usage hints
18387 * There are also convenience functions. elm_gen_item_genlist_get() will
18388 * return the genlist object the item belongs to. elm_genlist_item_show()
18389 * will make the scroller scroll to show that specific item so its visible.
18390 * elm_genlist_item_data_get() returns the data pointer set by the item
18391 * creation functions.
18393 * If an item changes (state of boolean changes, label or contents change),
18394 * then use elm_genlist_item_update() to have genlist update the item with
18395 * the new state. Genlist will re-realize the item thus call the functions
18396 * in the _Elm_Genlist_Item_Class for that item.
18398 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18399 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18400 * to expand/contract an item and get its expanded state, use
18401 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18402 * again to make an item disabled (unable to be selected and appear
18403 * differently) use elm_genlist_item_disabled_set() to set this and
18404 * elm_genlist_item_disabled_get() to get the disabled state.
18406 * In general to indicate how the genlist should expand items horizontally to
18407 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18408 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18409 * mode means that if items are too wide to fit, the scroller will scroll
18410 * horizontally. Otherwise items are expanded to fill the width of the
18411 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18412 * to the viewport width and limited to that size. This can be combined with
18413 * a different style that uses edjes' ellipsis feature (cutting text off like
18416 * Items will only call their selection func and callback when first becoming
18417 * selected. Any further clicks will do nothing, unless you enable always
18418 * select with elm_gen_always_select_mode_set(). This means even if
18419 * selected, every click will make the selected callbacks be called.
18420 * elm_genlist_no_select_mode_set() will turn off the ability to select
18421 * items entirely and they will neither appear selected nor call selected
18422 * callback functions.
18424 * Remember that you can create new styles and add your own theme augmentation
18425 * per application with elm_theme_extension_add(). If you absolutely must
18426 * have a specific style that overrides any theme the user or system sets up
18427 * you can use elm_theme_overlay_add() to add such a file.
18429 * @section Genlist_Implementation Implementation
18431 * Evas tracks every object you create. Every time it processes an event
18432 * (mouse move, down, up etc.) it needs to walk through objects and find out
18433 * what event that affects. Even worse every time it renders display updates,
18434 * in order to just calculate what to re-draw, it needs to walk through many
18435 * many many objects. Thus, the more objects you keep active, the more
18436 * overhead Evas has in just doing its work. It is advisable to keep your
18437 * active objects to the minimum working set you need. Also remember that
18438 * object creation and deletion carries an overhead, so there is a
18439 * middle-ground, which is not easily determined. But don't keep massive lists
18440 * of objects you can't see or use. Genlist does this with list objects. It
18441 * creates and destroys them dynamically as you scroll around. It groups them
18442 * into blocks so it can determine the visibility etc. of a whole block at
18443 * once as opposed to having to walk the whole list. This 2-level list allows
18444 * for very large numbers of items to be in the list (tests have used up to
18445 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18446 * may be different sizes, every item added needs to be calculated as to its
18447 * size and thus this presents a lot of overhead on populating the list, this
18448 * genlist employs a queue. Any item added is queued and spooled off over
18449 * time, actually appearing some time later, so if your list has many members
18450 * you may find it takes a while for them to all appear, with your process
18451 * consuming a lot of CPU while it is busy spooling.
18453 * Genlist also implements a tree structure, but it does so with callbacks to
18454 * the application, with the application filling in tree structures when
18455 * requested (allowing for efficient building of a very deep tree that could
18456 * even be used for file-management). See the above smart signal callbacks for
18459 * @section Genlist_Smart_Events Genlist smart events
18461 * Signals that you can add callbacks for are:
18462 * - @c "activated" - The user has double-clicked or pressed
18463 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18464 * item that was activated.
18465 * - @c "clicked,double" - The user has double-clicked an item. The @c
18466 * event_info parameter is the item that was double-clicked.
18467 * - @c "selected" - This is called when a user has made an item selected.
18468 * The event_info parameter is the genlist item that was selected.
18469 * - @c "unselected" - This is called when a user has made an item
18470 * unselected. The event_info parameter is the genlist item that was
18472 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18473 * called and the item is now meant to be expanded. The event_info
18474 * parameter is the genlist item that was indicated to expand. It is the
18475 * job of this callback to then fill in the child items.
18476 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18477 * called and the item is now meant to be contracted. The event_info
18478 * parameter is the genlist item that was indicated to contract. It is the
18479 * job of this callback to then delete the child items.
18480 * - @c "expand,request" - This is called when a user has indicated they want
18481 * to expand a tree branch item. The callback should decide if the item can
18482 * expand (has any children) and then call elm_genlist_item_expanded_set()
18483 * appropriately to set the state. The event_info parameter is the genlist
18484 * item that was indicated to expand.
18485 * - @c "contract,request" - This is called when a user has indicated they
18486 * want to contract a tree branch item. The callback should decide if the
18487 * item can contract (has any children) and then call
18488 * elm_genlist_item_expanded_set() appropriately to set the state. The
18489 * event_info parameter is the genlist item that was indicated to contract.
18490 * - @c "realized" - This is called when the item in the list is created as a
18491 * real evas object. event_info parameter is the genlist item that was
18492 * created. The object may be deleted at any time, so it is up to the
18493 * caller to not use the object pointer from elm_genlist_item_object_get()
18494 * in a way where it may point to freed objects.
18495 * - @c "unrealized" - This is called just before an item is unrealized.
18496 * After this call content objects provided will be deleted and the item
18497 * object itself delete or be put into a floating cache.
18498 * - @c "drag,start,up" - This is called when the item in the list has been
18499 * dragged (not scrolled) up.
18500 * - @c "drag,start,down" - This is called when the item in the list has been
18501 * dragged (not scrolled) down.
18502 * - @c "drag,start,left" - This is called when the item in the list has been
18503 * dragged (not scrolled) left.
18504 * - @c "drag,start,right" - This is called when the item in the list has
18505 * been dragged (not scrolled) right.
18506 * - @c "drag,stop" - This is called when the item in the list has stopped
18508 * - @c "drag" - This is called when the item in the list is being dragged.
18509 * - @c "longpressed" - This is called when the item is pressed for a certain
18510 * amount of time. By default it's 1 second.
18511 * - @c "scroll,anim,start" - This is called when scrolling animation has
18513 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18515 * - @c "scroll,drag,start" - This is called when dragging the content has
18517 * - @c "scroll,drag,stop" - This is called when dragging the content has
18519 * - @c "edge,top" - This is called when the genlist is scrolled until
18521 * - @c "edge,bottom" - This is called when the genlist is scrolled
18522 * until the bottom edge.
18523 * - @c "edge,left" - This is called when the genlist is scrolled
18524 * until the left edge.
18525 * - @c "edge,right" - This is called when the genlist is scrolled
18526 * until the right edge.
18527 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18529 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18531 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18533 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18535 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18536 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18537 * multi-touch pinched in.
18538 * - @c "swipe" - This is called when the genlist is swiped.
18539 * - @c "moved" - This is called when a genlist item is moved.
18540 * - @c "language,changed" - This is called when the program's language is
18543 * @section Genlist_Examples Examples
18545 * Here is a list of examples that use the genlist, trying to show some of
18546 * its capabilities:
18547 * - @ref genlist_example_01
18548 * - @ref genlist_example_02
18549 * - @ref genlist_example_03
18550 * - @ref genlist_example_04
18551 * - @ref genlist_example_05
18555 * @addtogroup Genlist
18560 * @enum _Elm_Genlist_Item_Flags
18561 * @typedef Elm_Genlist_Item_Flags
18563 * Defines if the item is of any special type (has subitems or it's the
18564 * index of a group), or is just a simple item.
18568 typedef enum _Elm_Genlist_Item_Flags
18570 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18571 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18572 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18573 } Elm_Genlist_Item_Flags;
18574 typedef enum _Elm_Genlist_Item_Field_Flags
18576 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18577 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18578 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18579 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18580 } Elm_Genlist_Item_Field_Flags;
18581 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18582 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18583 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18584 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18585 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18586 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18587 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18588 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18591 * @struct _Elm_Genlist_Item_Class
18593 * Genlist item class definition structs.
18595 * This struct contains the style and fetching functions that will define the
18596 * contents of each item.
18598 * @see @ref Genlist_Item_Class
18600 struct _Elm_Genlist_Item_Class
18602 const char *item_style;
18604 GenlistItemLabelGetFunc label_get;
18605 GenlistItemIconGetFunc icon_get;
18606 GenlistItemStateGetFunc state_get;
18607 GenlistItemDelFunc del;
18608 GenlistItemMovedFunc moved;
18610 const char *edit_item_style;
18611 const char *mode_item_style;
18613 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18615 * Add a new genlist widget to the given parent Elementary
18616 * (container) object
18618 * @param parent The parent object
18619 * @return a new genlist widget handle or @c NULL, on errors
18621 * This function inserts a new genlist widget on the canvas.
18623 * @see elm_genlist_item_append()
18624 * @see elm_genlist_item_del()
18625 * @see elm_gen_clear()
18629 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18631 * Remove all items from a given genlist widget.
18633 * @param obj The genlist object
18635 * This removes (and deletes) all items in @p obj, leaving it empty.
18637 * This is deprecated. Please use elm_gen_clear() instead.
18639 * @see elm_genlist_item_del(), to remove just one item.
18643 WILL_DEPRECATE EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18645 * Enable or disable multi-selection in the genlist
18647 * @param obj The genlist object
18648 * @param multi Multi-select enable/disable. Default is disabled.
18650 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18651 * the list. This allows more than 1 item to be selected. To retrieve the list
18652 * of selected items, use elm_genlist_selected_items_get().
18654 * @see elm_genlist_selected_items_get()
18655 * @see elm_genlist_multi_select_get()
18659 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18661 * Gets if multi-selection in genlist is enabled or disabled.
18663 * @param obj The genlist object
18664 * @return Multi-select enabled/disabled
18665 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18667 * @see elm_genlist_multi_select_set()
18671 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18673 * This sets the horizontal stretching mode.
18675 * @param obj The genlist object
18676 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18678 * This sets the mode used for sizing items horizontally. Valid modes
18679 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18680 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18681 * the scroller will scroll horizontally. Otherwise items are expanded
18682 * to fill the width of the viewport of the scroller. If it is
18683 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18684 * limited to that size.
18686 * @see elm_genlist_horizontal_get()
18690 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18692 * Gets the horizontal stretching mode.
18694 * @param obj The genlist object
18695 * @return The mode to use
18696 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18698 * @see elm_genlist_horizontal_set()
18702 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18704 * Set the always select mode.
18706 * @param obj The genlist object
18707 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18708 * EINA_FALSE = off). Default is @c EINA_FALSE.
18710 * Items will only call their selection func and callback when first
18711 * becoming selected. Any further clicks will do nothing, unless you
18712 * enable always select with elm_gen_always_select_mode_set().
18713 * This means that, even if selected, every click will make the selected
18714 * callbacks be called.
18716 * This function is deprecated. please see elm_gen_always_select_mode_set()
18718 * @see elm_genlist_always_select_mode_get()
18722 WILL_DEPRECATE EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18724 * Get the always select mode.
18726 * @param obj The genlist object
18727 * @return The always select mode
18728 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18730 * @see elm_genlist_always_select_mode_set()
18734 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18736 * Enable/disable the no select mode.
18738 * @param obj The genlist object
18739 * @param no_select The no select mode
18740 * (EINA_TRUE = on, EINA_FALSE = off)
18742 * This will turn off the ability to select items entirely and they
18743 * will neither appear selected nor call selected callback functions.
18745 * @see elm_genlist_no_select_mode_get()
18749 WILL_DEPRECATE EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18751 * Gets whether the no select mode is enabled.
18753 * @param obj The genlist object
18754 * @return The no select mode
18755 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18757 * @see elm_genlist_no_select_mode_set()
18761 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18763 * Enable/disable compress mode.
18765 * @param obj The genlist object
18766 * @param compress The compress mode
18767 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18769 * This will enable the compress mode where items are "compressed"
18770 * horizontally to fit the genlist scrollable viewport width. This is
18771 * special for genlist. Do not rely on
18772 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18773 * work as genlist needs to handle it specially.
18775 * @see elm_genlist_compress_mode_get()
18779 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18781 * Get whether the compress mode is enabled.
18783 * @param obj The genlist object
18784 * @return The compress mode
18785 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18787 * @see elm_genlist_compress_mode_set()
18791 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18793 * Enable/disable height-for-width mode.
18795 * @param obj The genlist object
18796 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18797 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18799 * With height-for-width mode the item width will be fixed (restricted
18800 * to a minimum of) to the list width when calculating its size in
18801 * order to allow the height to be calculated based on it. This allows,
18802 * for instance, text block to wrap lines if the Edje part is
18803 * configured with "text.min: 0 1".
18805 * @note This mode will make list resize slower as it will have to
18806 * recalculate every item height again whenever the list width
18809 * @note When height-for-width mode is enabled, it also enables
18810 * compress mode (see elm_genlist_compress_mode_set()) and
18811 * disables homogeneous (see elm_genlist_homogeneous_set()).
18815 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18817 * Get whether the height-for-width mode is enabled.
18819 * @param obj The genlist object
18820 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18825 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18827 * Enable/disable horizontal and vertical bouncing effect.
18829 * @param obj The genlist object
18830 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18831 * EINA_FALSE = off). Default is @c EINA_FALSE.
18832 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18833 * EINA_FALSE = off). Default is @c EINA_TRUE.
18835 * This will enable or disable the scroller bouncing effect for the
18836 * genlist. See elm_scroller_bounce_set() for details.
18838 * @see elm_scroller_bounce_set()
18839 * @see elm_genlist_bounce_get()
18843 WILL_DEPRECATE EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18845 * Get whether the horizontal and vertical bouncing effect is enabled.
18847 * @param obj The genlist object
18848 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18850 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18853 * @see elm_genlist_bounce_set()
18857 WILL_DEPRECATE EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18859 * Enable/disable homogenous mode.
18861 * @param obj The genlist object
18862 * @param homogeneous Assume the items within the genlist are of the
18863 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18866 * This will enable the homogeneous mode where items are of the same
18867 * height and width so that genlist may do the lazy-loading at its
18868 * maximum (which increases the performance for scrolling the list). This
18869 * implies 'compressed' mode.
18871 * @see elm_genlist_compress_mode_set()
18872 * @see elm_genlist_homogeneous_get()
18876 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18878 * Get whether the homogenous mode is enabled.
18880 * @param obj The genlist object
18881 * @return Assume the items within the genlist are of the same height
18882 * and width (EINA_TRUE = on, EINA_FALSE = off)
18884 * @see elm_genlist_homogeneous_set()
18888 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18890 * Set the maximum number of items within an item block
18892 * @param obj The genlist object
18893 * @param n Maximum number of items within an item block. Default is 32.
18895 * This will configure the block count to tune to the target with
18896 * particular performance matrix.
18898 * A block of objects will be used to reduce the number of operations due to
18899 * many objects in the screen. It can determine the visibility, or if the
18900 * object has changed, it theme needs to be updated, etc. doing this kind of
18901 * calculation to the entire block, instead of per object.
18903 * The default value for the block count is enough for most lists, so unless
18904 * you know you will have a lot of objects visible in the screen at the same
18905 * time, don't try to change this.
18907 * @see elm_genlist_block_count_get()
18908 * @see @ref Genlist_Implementation
18912 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18914 * Get the maximum number of items within an item block
18916 * @param obj The genlist object
18917 * @return Maximum number of items within an item block
18919 * @see elm_genlist_block_count_set()
18923 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18925 * Set the timeout in seconds for the longpress event.
18927 * @param obj The genlist object
18928 * @param timeout timeout in seconds. Default is 1.
18930 * This option will change how long it takes to send an event "longpressed"
18931 * after the mouse down signal is sent to the list. If this event occurs, no
18932 * "clicked" event will be sent.
18934 * @see elm_genlist_longpress_timeout_set()
18938 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18940 * Get the timeout in seconds for the longpress event.
18942 * @param obj The genlist object
18943 * @return timeout in seconds
18945 * @see elm_genlist_longpress_timeout_get()
18949 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18951 * Append a new item in a given genlist widget.
18953 * @param obj The genlist object
18954 * @param itc The item class for the item
18955 * @param data The item data
18956 * @param parent The parent item, or NULL if none
18957 * @param flags Item flags
18958 * @param func Convenience function called when the item is selected
18959 * @param func_data Data passed to @p func above.
18960 * @return A handle to the item added or @c NULL if not possible
18962 * This adds the given item to the end of the list or the end of
18963 * the children list if the @p parent is given.
18965 * @see elm_genlist_item_prepend()
18966 * @see elm_genlist_item_insert_before()
18967 * @see elm_genlist_item_insert_after()
18968 * @see elm_genlist_item_del()
18972 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);
18974 * Prepend a new item in a given genlist widget.
18976 * @param obj The genlist object
18977 * @param itc The item class for the item
18978 * @param data The item data
18979 * @param parent The parent item, or NULL if none
18980 * @param flags Item flags
18981 * @param func Convenience function called when the item is selected
18982 * @param func_data Data passed to @p func above.
18983 * @return A handle to the item added or NULL if not possible
18985 * This adds an item to the beginning of the list or beginning of the
18986 * children of the parent if given.
18988 * @see elm_genlist_item_append()
18989 * @see elm_genlist_item_insert_before()
18990 * @see elm_genlist_item_insert_after()
18991 * @see elm_genlist_item_del()
18995 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);
18997 * Insert an item before another in a genlist widget
18999 * @param obj The genlist object
19000 * @param itc The item class for the item
19001 * @param data The item data
19002 * @param before The item to place this new one before.
19003 * @param flags Item flags
19004 * @param func Convenience function called when the item is selected
19005 * @param func_data Data passed to @p func above.
19006 * @return A handle to the item added or @c NULL if not possible
19008 * This inserts an item before another in the list. It will be in the
19009 * same tree level or group as the item it is inserted before.
19011 * @see elm_genlist_item_append()
19012 * @see elm_genlist_item_prepend()
19013 * @see elm_genlist_item_insert_after()
19014 * @see elm_genlist_item_del()
19018 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);
19020 * Insert an item after another in a genlist widget
19022 * @param obj The genlist object
19023 * @param itc The item class for the item
19024 * @param data The item data
19025 * @param after The item to place this new one after.
19026 * @param flags Item flags
19027 * @param func Convenience function called when the item is selected
19028 * @param func_data Data passed to @p func above.
19029 * @return A handle to the item added or @c NULL if not possible
19031 * This inserts an item after another in the list. It will be in the
19032 * same tree level or group as the item it is inserted after.
19034 * @see elm_genlist_item_append()
19035 * @see elm_genlist_item_prepend()
19036 * @see elm_genlist_item_insert_before()
19037 * @see elm_genlist_item_del()
19041 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);
19043 * Insert a new item into the sorted genlist object
19045 * @param obj The genlist object
19046 * @param itc The item class for the item
19047 * @param data The item data
19048 * @param parent The parent item, or NULL if none
19049 * @param flags Item flags
19050 * @param comp The function called for the sort
19051 * @param func Convenience function called when item selected
19052 * @param func_data Data passed to @p func above.
19053 * @return A handle to the item added or NULL if not possible
19057 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);
19058 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);
19059 /* operations to retrieve existing items */
19061 * Get the selectd item in the genlist.
19063 * @param obj The genlist object
19064 * @return The selected item, or NULL if none is selected.
19066 * This gets the selected item in the list (if multi-selection is enabled, only
19067 * the item that was first selected in the list is returned - which is not very
19068 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19071 * If no item is selected, NULL is returned.
19073 * @see elm_genlist_selected_items_get()
19077 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19079 * Get a list of selected items in the genlist.
19081 * @param obj The genlist object
19082 * @return The list of selected items, or NULL if none are selected.
19084 * It returns a list of the selected items. This list pointer is only valid so
19085 * long as the selection doesn't change (no items are selected or unselected, or
19086 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19087 * pointers. The order of the items in this list is the order which they were
19088 * selected, i.e. the first item in this list is the first item that was
19089 * selected, and so on.
19091 * @note If not in multi-select mode, consider using function
19092 * elm_genlist_selected_item_get() instead.
19094 * @see elm_genlist_multi_select_set()
19095 * @see elm_genlist_selected_item_get()
19099 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19101 * Get the mode item style of items in the genlist
19102 * @param obj The genlist object
19103 * @return The mode item style string, or NULL if none is specified
19105 * This is a constant string and simply defines the name of the
19106 * style that will be used for mode animations. It can be
19107 * @c NULL if you don't plan to use Genlist mode. See
19108 * elm_genlist_item_mode_set() for more info.
19112 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19114 * Set the mode item style of items in the genlist
19115 * @param obj The genlist object
19116 * @param style The mode item style string, or NULL if none is desired
19118 * This is a constant string and simply defines the name of the
19119 * style that will be used for mode animations. It can be
19120 * @c NULL if you don't plan to use Genlist mode. See
19121 * elm_genlist_item_mode_set() for more info.
19125 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19127 * Get a list of realized items in genlist
19129 * @param obj The genlist object
19130 * @return The list of realized items, nor NULL if none are realized.
19132 * This returns a list of the realized items in the genlist. The list
19133 * contains Elm_Genlist_Item pointers. The list must be freed by the
19134 * caller when done with eina_list_free(). The item pointers in the
19135 * list are only valid so long as those items are not deleted or the
19136 * genlist is not deleted.
19138 * @see elm_genlist_realized_items_update()
19142 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19144 * Get the item that is at the x, y canvas coords.
19146 * @param obj The gelinst object.
19147 * @param x The input x coordinate
19148 * @param y The input y coordinate
19149 * @param posret The position relative to the item returned here
19150 * @return The item at the coordinates or NULL if none
19152 * This returns the item at the given coordinates (which are canvas
19153 * relative, not object-relative). If an item is at that coordinate,
19154 * that item handle is returned, and if @p posret is not NULL, the
19155 * integer pointed to is set to a value of -1, 0 or 1, depending if
19156 * the coordinate is on the upper portion of that item (-1), on the
19157 * middle section (0) or on the lower part (1). If NULL is returned as
19158 * an item (no item found there), then posret may indicate -1 or 1
19159 * based if the coordinate is above or below all items respectively in
19164 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);
19166 * Get the first item in the genlist
19168 * This returns the first item in the list.
19170 * @param obj The genlist object
19171 * @return The first item, or NULL if none
19175 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19177 * Get the last item in the genlist
19179 * This returns the last item in the list.
19181 * @return The last item, or NULL if none
19185 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19187 * Set the scrollbar policy
19189 * @param obj The genlist object
19190 * @param policy_h Horizontal scrollbar policy.
19191 * @param policy_v Vertical scrollbar policy.
19193 * This sets the scrollbar visibility policy for the given genlist
19194 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19195 * made visible if it is needed, and otherwise kept hidden.
19196 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19197 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19198 * respectively for the horizontal and vertical scrollbars. Default is
19199 * #ELM_SMART_SCROLLER_POLICY_AUTO
19201 * @see elm_genlist_scroller_policy_get()
19205 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19207 * Get the scrollbar policy
19209 * @param obj The genlist object
19210 * @param policy_h Pointer to store the horizontal scrollbar policy.
19211 * @param policy_v Pointer to store the vertical scrollbar policy.
19213 * @see elm_genlist_scroller_policy_set()
19217 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);
19219 * Get the @b next item in a genlist widget's internal list of items,
19220 * given a handle to one of those items.
19222 * @param item The genlist item to fetch next from
19223 * @return The item after @p item, or @c NULL if there's none (and
19226 * This returns the item placed after the @p item, on the container
19229 * @see elm_genlist_item_prev_get()
19233 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19235 * Get the @b previous item in a genlist widget's internal list of items,
19236 * given a handle to one of those items.
19238 * @param item The genlist item to fetch previous from
19239 * @return The item before @p item, or @c NULL if there's none (and
19242 * This returns the item placed before the @p item, on the container
19245 * @see elm_genlist_item_next_get()
19249 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19251 * Get the genlist object's handle which contains a given genlist
19254 * @param item The item to fetch the container from
19255 * @return The genlist (parent) object
19257 * This returns the genlist object itself that an item belongs to.
19259 * This function is deprecated. Please use elm_gen_item_widget_get()
19263 WILL_DEPRECATE EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19265 * Get the parent item of the given item
19267 * @param it The item
19268 * @return The parent of the item or @c NULL if it has no parent.
19270 * This returns the item that was specified as parent of the item @p it on
19271 * elm_genlist_item_append() and insertion related functions.
19275 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19277 * Remove all sub-items (children) of the given item
19279 * @param it The item
19281 * This removes all items that are children (and their descendants) of the
19282 * given item @p it.
19284 * @see elm_genlist_clear()
19285 * @see elm_genlist_item_del()
19289 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19291 * Set whether a given genlist item is selected or not
19293 * @param it The item
19294 * @param selected Use @c EINA_TRUE, to make it selected, @c
19295 * EINA_FALSE to make it unselected
19297 * This sets the selected state of an item. If multi selection is
19298 * not enabled on the containing genlist and @p selected is @c
19299 * EINA_TRUE, any other previously selected items will get
19300 * unselected in favor of this new one.
19302 * @see elm_genlist_item_selected_get()
19306 WILL_DEPRECATE EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19308 * Get whether a given genlist item is selected or not
19310 * @param it The item
19311 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19313 * @see elm_genlist_item_selected_set() for more details
19317 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19319 * Sets the expanded state of an item.
19321 * @param it The item
19322 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19324 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19327 * The theme will respond to this change visually, and a signal "expanded" or
19328 * "contracted" will be sent from the genlist with a pointer to the item that
19329 * has been expanded/contracted.
19331 * Calling this function won't show or hide any child of this item (if it is
19332 * a parent). You must manually delete and create them on the callbacks fo
19333 * the "expanded" or "contracted" signals.
19335 * @see elm_genlist_item_expanded_get()
19339 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19341 * Get the expanded state of an item
19343 * @param it The item
19344 * @return The expanded state
19346 * This gets the expanded state of an item.
19348 * @see elm_genlist_item_expanded_set()
19352 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19354 * Get the depth of expanded item
19356 * @param it The genlist item object
19357 * @return The depth of expanded item
19361 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19363 * Set whether a given genlist item is disabled or not.
19365 * @param it The item
19366 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19367 * to enable it back.
19369 * A disabled item cannot be selected or unselected. It will also
19370 * change its appearance, to signal the user it's disabled.
19372 * @see elm_genlist_item_disabled_get()
19376 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19378 * Get whether a given genlist item is disabled or not.
19380 * @param it The item
19381 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19384 * @see elm_genlist_item_disabled_set() for more details
19388 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19390 * Sets the display only state of an item.
19392 * @param it The item
19393 * @param display_only @c EINA_TRUE if the item is display only, @c
19394 * EINA_FALSE otherwise.
19396 * A display only item cannot be selected or unselected. It is for
19397 * display only and not selecting or otherwise clicking, dragging
19398 * etc. by the user, thus finger size rules will not be applied to
19401 * It's good to set group index items to display only state.
19403 * @see elm_genlist_item_display_only_get()
19407 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19409 * Get the display only state of an item
19411 * @param it The item
19412 * @return @c EINA_TRUE if the item is display only, @c
19413 * EINA_FALSE otherwise.
19415 * @see elm_genlist_item_display_only_set()
19419 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19421 * Show the portion of a genlist's internal list containing a given
19422 * item, immediately.
19424 * @param it The item to display
19426 * This causes genlist to jump to the given item @p it and show it (by
19427 * immediately scrolling to that position), if it is not fully visible.
19429 * @see elm_genlist_item_bring_in()
19430 * @see elm_genlist_item_top_show()
19431 * @see elm_genlist_item_middle_show()
19435 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19437 * Animatedly bring in, to the visible are of a genlist, a given
19440 * @param it The item to display
19442 * This causes genlist to jump to the given item @p it and show it (by
19443 * animatedly scrolling), if it is not fully visible. This may use animation
19444 * to do so and take a period of time
19446 * @see elm_genlist_item_show()
19447 * @see elm_genlist_item_top_bring_in()
19448 * @see elm_genlist_item_middle_bring_in()
19452 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19454 * Show the portion of a genlist's internal list containing a given
19455 * item, immediately.
19457 * @param it The item to display
19459 * This causes genlist to jump to the given item @p it and show it (by
19460 * immediately scrolling to that position), if it is not fully visible.
19462 * The item will be positioned at the top of the genlist viewport.
19464 * @see elm_genlist_item_show()
19465 * @see elm_genlist_item_top_bring_in()
19469 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19471 * Animatedly bring in, to the visible are of a genlist, a given
19474 * @param it The item
19476 * This causes genlist to jump to the given item @p it and show it (by
19477 * animatedly scrolling), if it is not fully visible. This may use animation
19478 * to do so and take a period of time
19480 * The item will be positioned at the top of the genlist viewport.
19482 * @see elm_genlist_item_bring_in()
19483 * @see elm_genlist_item_top_show()
19487 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19489 * Show the portion of a genlist's internal list containing a given
19490 * item, immediately.
19492 * @param it The item to display
19494 * This causes genlist to jump to the given item @p it and show it (by
19495 * immediately scrolling to that position), if it is not fully visible.
19497 * The item will be positioned at the middle of the genlist viewport.
19499 * @see elm_genlist_item_show()
19500 * @see elm_genlist_item_middle_bring_in()
19504 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19506 * Animatedly bring in, to the visible are of a genlist, a given
19509 * @param it The item
19511 * This causes genlist to jump to the given item @p it and show it (by
19512 * animatedly scrolling), if it is not fully visible. This may use animation
19513 * to do so and take a period of time
19515 * The item will be positioned at the middle of the genlist viewport.
19517 * @see elm_genlist_item_bring_in()
19518 * @see elm_genlist_item_middle_show()
19522 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19524 * Remove a genlist item from the its parent, deleting it.
19526 * @param item The item to be removed.
19527 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19529 * @see elm_genlist_clear(), to remove all items in a genlist at
19534 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19536 * Return the data associated to a given genlist item
19538 * @param item The genlist item.
19539 * @return the data associated to this item.
19541 * This returns the @c data value passed on the
19542 * elm_genlist_item_append() and related item addition calls.
19544 * @see elm_genlist_item_append()
19545 * @see elm_genlist_item_data_set()
19549 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19551 * Set the data associated to a given genlist item
19553 * @param item The genlist item
19554 * @param data The new data pointer to set on it
19556 * This @b overrides the @c data value passed on the
19557 * elm_genlist_item_append() and related item addition calls. This
19558 * function @b won't call elm_genlist_item_update() automatically,
19559 * so you'd issue it afterwards if you want to hove the item
19560 * updated to reflect the that new data.
19562 * @see elm_genlist_item_data_get()
19566 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19568 * Tells genlist to "orphan" icons fetchs by the item class
19570 * @param it The item
19572 * This instructs genlist to release references to icons in the item,
19573 * meaning that they will no longer be managed by genlist and are
19574 * floating "orphans" that can be re-used elsewhere if the user wants
19579 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19580 WILL_DEPRECATE EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19582 * Get the real Evas object created to implement the view of a
19583 * given genlist item
19585 * @param item The genlist item.
19586 * @return the Evas object implementing this item's view.
19588 * This returns the actual Evas object used to implement the
19589 * specified genlist item's view. This may be @c NULL, as it may
19590 * not have been created or may have been deleted, at any time, by
19591 * the genlist. <b>Do not modify this object</b> (move, resize,
19592 * show, hide, etc.), as the genlist is controlling it. This
19593 * function is for querying, emitting custom signals or hooking
19594 * lower level callbacks for events on that object. Do not delete
19595 * this object under any circumstances.
19597 * @see elm_genlist_item_data_get()
19601 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19603 * Update the contents of an item
19605 * @param it The item
19607 * This updates an item by calling all the item class functions again
19608 * to get the icons, labels and states. Use this when the original
19609 * item data has changed and the changes are desired to be reflected.
19611 * Use elm_genlist_realized_items_update() to update all already realized
19614 * @see elm_genlist_realized_items_update()
19618 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19619 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19621 * Update the item class of an item
19623 * @param it The item
19624 * @param itc The item class for the item
19626 * This sets another class fo the item, changing the way that it is
19627 * displayed. After changing the item class, elm_genlist_item_update() is
19628 * called on the item @p it.
19632 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19633 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19635 * Set the text to be shown in a given genlist item's tooltips.
19637 * @param item The genlist item
19638 * @param text The text to set in the content
19640 * This call will setup the text to be used as tooltip to that item
19641 * (analogous to elm_object_tooltip_text_set(), but being item
19642 * tooltips with higher precedence than object tooltips). It can
19643 * have only one tooltip at a time, so any previous tooltip data
19644 * will get removed.
19646 * In order to set an icon or something else as a tooltip, look at
19647 * elm_genlist_item_tooltip_content_cb_set().
19651 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19653 * Set the content to be shown in a given genlist item's tooltips
19655 * @param item The genlist item.
19656 * @param func The function returning the tooltip contents.
19657 * @param data What to provide to @a func as callback data/context.
19658 * @param del_cb Called when data is not needed anymore, either when
19659 * another callback replaces @p func, the tooltip is unset with
19660 * elm_genlist_item_tooltip_unset() or the owner @p item
19661 * dies. This callback receives as its first parameter the
19662 * given @p data, being @c event_info the item handle.
19664 * This call will setup the tooltip's contents to @p item
19665 * (analogous to elm_object_tooltip_content_cb_set(), but being
19666 * item tooltips with higher precedence than object tooltips). It
19667 * can have only one tooltip at a time, so any previous tooltip
19668 * content will get removed. @p func (with @p data) will be called
19669 * every time Elementary needs to show the tooltip and it should
19670 * return a valid Evas object, which will be fully managed by the
19671 * tooltip system, getting deleted when the tooltip is gone.
19673 * In order to set just a text as a tooltip, look at
19674 * elm_genlist_item_tooltip_text_set().
19678 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);
19680 * Unset a tooltip from a given genlist item
19682 * @param item genlist item to remove a previously set tooltip from.
19684 * This call removes any tooltip set on @p item. The callback
19685 * provided as @c del_cb to
19686 * elm_genlist_item_tooltip_content_cb_set() will be called to
19687 * notify it is not used anymore (and have resources cleaned, if
19690 * @see elm_genlist_item_tooltip_content_cb_set()
19694 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19696 * Set a different @b style for a given genlist item's tooltip.
19698 * @param item genlist item with tooltip set
19699 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19700 * "default", @c "transparent", etc)
19702 * Tooltips can have <b>alternate styles</b> to be displayed on,
19703 * which are defined by the theme set on Elementary. This function
19704 * works analogously as elm_object_tooltip_style_set(), but here
19705 * applied only to genlist item objects. The default style for
19706 * tooltips is @c "default".
19708 * @note before you set a style you should define a tooltip with
19709 * elm_genlist_item_tooltip_content_cb_set() or
19710 * elm_genlist_item_tooltip_text_set()
19712 * @see elm_genlist_item_tooltip_style_get()
19716 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19718 * Get the style set a given genlist item's tooltip.
19720 * @param item genlist item with tooltip already set on.
19721 * @return style the theme style in use, which defaults to
19722 * "default". If the object does not have a tooltip set,
19723 * then @c NULL is returned.
19725 * @see elm_genlist_item_tooltip_style_set() for more details
19729 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19731 * @brief Disable size restrictions on an object's tooltip
19732 * @param item The tooltip's anchor object
19733 * @param disable If EINA_TRUE, size restrictions are disabled
19734 * @return EINA_FALSE on failure, EINA_TRUE on success
19736 * This function allows a tooltip to expand beyond its parant window's canvas.
19737 * It will instead be limited only by the size of the display.
19739 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19741 * @brief Retrieve size restriction state of an object's tooltip
19742 * @param item The tooltip's anchor object
19743 * @return If EINA_TRUE, size restrictions are disabled
19745 * This function returns whether a tooltip is allowed to expand beyond
19746 * its parant window's canvas.
19747 * It will instead be limited only by the size of the display.
19749 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19751 * Set the type of mouse pointer/cursor decoration to be shown,
19752 * when the mouse pointer is over the given genlist widget item
19754 * @param item genlist item to customize cursor on
19755 * @param cursor the cursor type's name
19757 * This function works analogously as elm_object_cursor_set(), but
19758 * here the cursor's changing area is restricted to the item's
19759 * area, and not the whole widget's. Note that that item cursors
19760 * have precedence over widget cursors, so that a mouse over @p
19761 * item will always show cursor @p type.
19763 * If this function is called twice for an object, a previously set
19764 * cursor will be unset on the second call.
19766 * @see elm_object_cursor_set()
19767 * @see elm_genlist_item_cursor_get()
19768 * @see elm_genlist_item_cursor_unset()
19772 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19774 * Get the type of mouse pointer/cursor decoration set to be shown,
19775 * when the mouse pointer is over the given genlist widget item
19777 * @param item genlist item with custom cursor set
19778 * @return the cursor type's name or @c NULL, if no custom cursors
19779 * were set to @p item (and on errors)
19781 * @see elm_object_cursor_get()
19782 * @see elm_genlist_item_cursor_set() for more details
19783 * @see elm_genlist_item_cursor_unset()
19787 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19789 * Unset any custom mouse pointer/cursor decoration set to be
19790 * shown, when the mouse pointer is over the given genlist widget
19791 * item, thus making it show the @b default cursor again.
19793 * @param item a genlist item
19795 * Use this call to undo any custom settings on this item's cursor
19796 * decoration, bringing it back to defaults (no custom style set).
19798 * @see elm_object_cursor_unset()
19799 * @see elm_genlist_item_cursor_set() for more details
19803 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19805 * Set a different @b style for a given custom cursor set for a
19808 * @param item genlist item with custom cursor set
19809 * @param style the <b>theme style</b> to use (e.g. @c "default",
19810 * @c "transparent", etc)
19812 * This function only makes sense when one is using custom mouse
19813 * cursor decorations <b>defined in a theme file</b> , which can
19814 * have, given a cursor name/type, <b>alternate styles</b> on
19815 * it. It works analogously as elm_object_cursor_style_set(), but
19816 * here applied only to genlist item objects.
19818 * @warning Before you set a cursor style you should have defined a
19819 * custom cursor previously on the item, with
19820 * elm_genlist_item_cursor_set()
19822 * @see elm_genlist_item_cursor_engine_only_set()
19823 * @see elm_genlist_item_cursor_style_get()
19827 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19829 * Get the current @b style set for a given genlist item's custom
19832 * @param item genlist item with custom cursor set.
19833 * @return style the cursor style in use. If the object does not
19834 * have a cursor set, then @c NULL is returned.
19836 * @see elm_genlist_item_cursor_style_set() for more details
19840 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19842 * Set if the (custom) cursor for a given genlist item should be
19843 * searched in its theme, also, or should only rely on the
19844 * rendering engine.
19846 * @param item item with custom (custom) cursor already set on
19847 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19848 * only on those provided by the rendering engine, @c EINA_FALSE to
19849 * have them searched on the widget's theme, as well.
19851 * @note This call is of use only if you've set a custom cursor
19852 * for genlist items, with elm_genlist_item_cursor_set().
19854 * @note By default, cursors will only be looked for between those
19855 * provided by the rendering engine.
19859 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19861 * Get if the (custom) cursor for a given genlist item is being
19862 * searched in its theme, also, or is only relying on the rendering
19865 * @param item a genlist item
19866 * @return @c EINA_TRUE, if cursors are being looked for only on
19867 * those provided by the rendering engine, @c EINA_FALSE if they
19868 * are being searched on the widget's theme, as well.
19870 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19874 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19876 * Update the contents of all realized items.
19878 * @param obj The genlist object.
19880 * This updates all realized items by calling all the item class functions again
19881 * to get the icons, labels and states. Use this when the original
19882 * item data has changed and the changes are desired to be reflected.
19884 * To update just one item, use elm_genlist_item_update().
19886 * @see elm_genlist_realized_items_get()
19887 * @see elm_genlist_item_update()
19891 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19893 * Activate a genlist mode on an item
19895 * @param item The genlist item
19896 * @param mode Mode name
19897 * @param mode_set Boolean to define set or unset mode.
19899 * A genlist mode is a different way of selecting an item. Once a mode is
19900 * activated on an item, any other selected item is immediately unselected.
19901 * This feature provides an easy way of implementing a new kind of animation
19902 * for selecting an item, without having to entirely rewrite the item style
19903 * theme. However, the elm_genlist_selected_* API can't be used to get what
19904 * item is activate for a mode.
19906 * The current item style will still be used, but applying a genlist mode to
19907 * an item will select it using a different kind of animation.
19909 * The current active item for a mode can be found by
19910 * elm_genlist_mode_item_get().
19912 * The characteristics of genlist mode are:
19913 * - Only one mode can be active at any time, and for only one item.
19914 * - Genlist handles deactivating other items when one item is activated.
19915 * - A mode is defined in the genlist theme (edc), and more modes can easily
19917 * - A mode style and the genlist item style are different things. They
19918 * can be combined to provide a default style to the item, with some kind
19919 * of animation for that item when the mode is activated.
19921 * When a mode is activated on an item, a new view for that item is created.
19922 * The theme of this mode defines the animation that will be used to transit
19923 * the item from the old view to the new view. This second (new) view will be
19924 * active for that item while the mode is active on the item, and will be
19925 * destroyed after the mode is totally deactivated from that item.
19927 * @see elm_genlist_mode_get()
19928 * @see elm_genlist_mode_item_get()
19932 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19934 * Get the last (or current) genlist mode used.
19936 * @param obj The genlist object
19938 * This function just returns the name of the last used genlist mode. It will
19939 * be the current mode if it's still active.
19941 * @see elm_genlist_item_mode_set()
19942 * @see elm_genlist_mode_item_get()
19946 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19948 * Get active genlist mode item
19950 * @param obj The genlist object
19951 * @return The active item for that current mode. Or @c NULL if no item is
19952 * activated with any mode.
19954 * This function returns the item that was activated with a mode, by the
19955 * function elm_genlist_item_mode_set().
19957 * @see elm_genlist_item_mode_set()
19958 * @see elm_genlist_mode_get()
19962 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19967 * @param obj The genlist object
19968 * @param reorder_mode The reorder mode
19969 * (EINA_TRUE = on, EINA_FALSE = off)
19973 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19976 * Get the reorder mode
19978 * @param obj The genlist object
19979 * @return The reorder mode
19980 * (EINA_TRUE = on, EINA_FALSE = off)
19984 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19986 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19987 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19988 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19989 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19990 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19991 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19992 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19993 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19994 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19995 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20002 * @defgroup Check Check
20004 * @image html img/widget/check/preview-00.png
20005 * @image latex img/widget/check/preview-00.eps
20006 * @image html img/widget/check/preview-01.png
20007 * @image latex img/widget/check/preview-01.eps
20008 * @image html img/widget/check/preview-02.png
20009 * @image latex img/widget/check/preview-02.eps
20011 * @brief The check widget allows for toggling a value between true and
20014 * Check objects are a lot like radio objects in layout and functionality
20015 * except they do not work as a group, but independently and only toggle the
20016 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20017 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20018 * returns the current state. For convenience, like the radio objects, you
20019 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20020 * for it to modify.
20022 * Signals that you can add callbacks for are:
20023 * "changed" - This is called whenever the user changes the state of one of
20024 * the check object(event_info is NULL).
20026 * Default contents parts of the check widget that you can use for are:
20027 * @li "icon" - A icon of the check
20029 * Default text parts of the check widget that you can use for are:
20030 * @li "elm.text" - Label of the check
20032 * @ref tutorial_check should give you a firm grasp of how to use this widget
20037 * @brief Add a new Check object
20039 * @param parent The parent object
20040 * @return The new object or NULL if it cannot be created
20042 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20044 * @brief Set the text label of the check object
20046 * @param obj The check object
20047 * @param label The text label string in UTF-8
20049 * @deprecated use elm_object_text_set() instead.
20051 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20053 * @brief Get the text label of the check object
20055 * @param obj The check object
20056 * @return The text label string in UTF-8
20058 * @deprecated use elm_object_text_get() instead.
20060 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20062 * @brief Set the icon object of the check object
20064 * @param obj The check object
20065 * @param icon The icon object
20067 * Once the icon object is set, a previously set one will be deleted.
20068 * If you want to keep that old content object, use the
20069 * elm_object_content_unset() function.
20071 * @deprecated use elm_object_part_content_set() instead.
20074 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20076 * @brief Get the icon object of the check object
20078 * @param obj The check object
20079 * @return The icon object
20081 * @deprecated use elm_object_part_content_get() instead.
20084 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20086 * @brief Unset the icon used for the check object
20088 * @param obj The check object
20089 * @return The icon object that was being used
20091 * Unparent and return the icon object which was set for this widget.
20093 * @deprecated use elm_object_part_content_unset() instead.
20096 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20098 * @brief Set the on/off state of the check object
20100 * @param obj The check object
20101 * @param state The state to use (1 == on, 0 == off)
20103 * This sets the state of the check. If set
20104 * with elm_check_state_pointer_set() the state of that variable is also
20105 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20107 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20109 * @brief Get the state of the check object
20111 * @param obj The check object
20112 * @return The boolean state
20114 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20116 * @brief Set a convenience pointer to a boolean to change
20118 * @param obj The check object
20119 * @param statep Pointer to the boolean to modify
20121 * This sets a pointer to a boolean, that, in addition to the check objects
20122 * state will also be modified directly. To stop setting the object pointed
20123 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20124 * then when this is called, the check objects state will also be modified to
20125 * reflect the value of the boolean @p statep points to, just like calling
20126 * elm_check_state_set().
20128 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20133 /* compatibility code for toggle controls */
20135 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20139 obj = elm_check_add(parent);
20140 elm_object_style_set(obj, "toggle");
20141 elm_object_part_text_set(obj, "on", "ON");
20142 elm_object_part_text_set(obj, "off", "OFF");
20146 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20148 elm_object_text_set(obj, label);
20151 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20153 return elm_object_text_get(obj);
20156 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20158 elm_object_content_set(obj, icon);
20161 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20163 return elm_object_content_get(obj);
20166 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20168 return elm_object_content_unset(obj);
20171 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20173 elm_object_part_text_set(obj, "on", onlabel);
20174 elm_object_part_text_set(obj, "off", offlabel);
20177 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1)
20179 if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20180 if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20183 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20185 elm_check_state_set(obj, state);
20188 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20190 return elm_check_state_get(obj);
20193 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20195 elm_check_state_pointer_set(obj, statep);
20199 * @defgroup Radio Radio
20201 * @image html img/widget/radio/preview-00.png
20202 * @image latex img/widget/radio/preview-00.eps
20204 * @brief Radio is a widget that allows for 1 or more options to be displayed
20205 * and have the user choose only 1 of them.
20207 * A radio object contains an indicator, an optional Label and an optional
20208 * icon object. While it's possible to have a group of only one radio they,
20209 * are normally used in groups of 2 or more. To add a radio to a group use
20210 * elm_radio_group_add(). The radio object(s) will select from one of a set
20211 * of integer values, so any value they are configuring needs to be mapped to
20212 * a set of integers. To configure what value that radio object represents,
20213 * use elm_radio_state_value_set() to set the integer it represents. To set
20214 * the value the whole group(which one is currently selected) is to indicate
20215 * use elm_radio_value_set() on any group member, and to get the groups value
20216 * use elm_radio_value_get(). For convenience the radio objects are also able
20217 * to directly set an integer(int) to the value that is selected. To specify
20218 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20219 * The radio objects will modify this directly. That implies the pointer must
20220 * point to valid memory for as long as the radio objects exist.
20222 * Signals that you can add callbacks for are:
20223 * @li changed - This is called whenever the user changes the state of one of
20224 * the radio objects within the group of radio objects that work together.
20226 * Default contents parts of the radio widget that you can use for are:
20227 * @li "icon" - A icon of the radio
20229 * @ref tutorial_radio show most of this API in action.
20233 * @brief Add a new radio to the parent
20235 * @param parent The parent object
20236 * @return The new object or NULL if it cannot be created
20238 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20240 * @brief Set the text label of the radio object
20242 * @param obj The radio object
20243 * @param label The text label string in UTF-8
20245 * @deprecated use elm_object_text_set() instead.
20247 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20249 * @brief Get the text label of the radio object
20251 * @param obj The radio object
20252 * @return The text label string in UTF-8
20254 * @deprecated use elm_object_text_set() instead.
20256 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20258 * @brief Set the icon object of the radio object
20260 * @param obj The radio object
20261 * @param icon The icon object
20263 * Once the icon object is set, a previously set one will be deleted. If you
20264 * want to keep that old content object, use the elm_radio_icon_unset()
20267 * @deprecated use elm_object_part_content_set() instead.
20270 WILL_DEPRECATE EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20272 * @brief Get the icon object of the radio object
20274 * @param obj The radio object
20275 * @return The icon object
20277 * @see elm_radio_icon_set()
20279 * @deprecated use elm_object_part_content_get() instead.
20282 WILL_DEPRECATE EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20284 * @brief Unset the icon used for the radio object
20286 * @param obj The radio object
20287 * @return The icon object that was being used
20289 * Unparent and return the icon object which was set for this widget.
20291 * @see elm_radio_icon_set()
20292 * @deprecated use elm_object_part_content_unset() instead.
20295 WILL_DEPRECATE EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20297 * @brief Add this radio to a group of other radio objects
20299 * @param obj The radio object
20300 * @param group Any object whose group the @p obj is to join.
20302 * Radio objects work in groups. Each member should have a different integer
20303 * value assigned. In order to have them work as a group, they need to know
20304 * about each other. This adds the given radio object to the group of which
20305 * the group object indicated is a member.
20307 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20309 * @brief Set the integer value that this radio object represents
20311 * @param obj The radio object
20312 * @param value The value to use if this radio object is selected
20314 * This sets the value of the radio.
20316 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20318 * @brief Get the integer value that this radio object represents
20320 * @param obj The radio object
20321 * @return The value used if this radio object is selected
20323 * This gets the value of the radio.
20325 * @see elm_radio_value_set()
20327 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20329 * @brief Set the value of the radio.
20331 * @param obj The radio object
20332 * @param value The value to use for the group
20334 * This sets the value of the radio group and will also set the value if
20335 * pointed to, to the value supplied, but will not call any callbacks.
20337 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20339 * @brief Get the state of the radio object
20341 * @param obj The radio object
20342 * @return The integer state
20344 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20346 * @brief Set a convenience pointer to a integer to change
20348 * @param obj The radio object
20349 * @param valuep Pointer to the integer to modify
20351 * This sets a pointer to a integer, that, in addition to the radio objects
20352 * state will also be modified directly. To stop setting the object pointed
20353 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20354 * when this is called, the radio objects state will also be modified to
20355 * reflect the value of the integer valuep points to, just like calling
20356 * elm_radio_value_set().
20358 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20364 * @defgroup Pager Pager
20366 * @image html img/widget/pager/preview-00.png
20367 * @image latex img/widget/pager/preview-00.eps
20369 * @brief Widget that allows flipping between one or more āpagesā
20372 * The flipping between pages of objects is animated. All content
20373 * in the pager is kept in a stack, being the last content added
20374 * (visible one) on the top of that stack.
20376 * Objects can be pushed or popped from the stack or deleted as
20377 * well. Pushes and pops will animate the widget accordingly to its
20378 * style (a pop will also delete the child object once the
20379 * animation is finished). Any object already in the pager can be
20380 * promoted to the top (from its current stacking position) through
20381 * the use of elm_pager_content_promote(). New objects are pushed
20382 * to the top with elm_pager_content_push(). When the top item is
20383 * no longer wanted, simply pop it with elm_pager_content_pop() and
20384 * it will also be deleted. If an object is no longer needed and is
20385 * not the top item, just delete it as normal. You can query which
20386 * objects are the top and bottom with
20387 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20389 * Signals that you can add callbacks for are:
20390 * - @c "show,finished" - when a new page is actually shown on the top
20391 * - @c "hide,finished" - when a previous page is hidden
20393 * Only after the first of that signals the child object is
20394 * guaranteed to be visible, as in @c evas_object_visible_get().
20396 * This widget has the following styles available:
20399 * - @c "fade_translucide"
20400 * - @c "fade_invisible"
20402 * @note These styles affect only the flipping animations on the
20403 * default theme; the appearance when not animating is unaffected
20406 * @ref tutorial_pager gives a good overview of the usage of the API.
20411 * Add a new pager to the parent
20413 * @param parent The parent object
20414 * @return The new object or NULL if it cannot be created
20418 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20421 * @brief Push an object to the top of the pager stack (and show it).
20423 * @param obj The pager object
20424 * @param content The object to push
20426 * The object pushed becomes a child of the pager, it will be controlled and
20427 * deleted when the pager is deleted.
20429 * @note If the content is already in the stack use
20430 * elm_pager_content_promote().
20431 * @warning Using this function on @p content already in the stack results in
20432 * undefined behavior.
20434 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20437 * @brief Pop the object that is on top of the stack
20439 * @param obj The pager object
20441 * This pops the object that is on the top(visible) of the pager, makes it
20442 * disappear, then deletes the object. The object that was underneath it on
20443 * the stack will become visible.
20445 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20448 * @brief Moves an object already in the pager stack to the top of the stack.
20450 * @param obj The pager object
20451 * @param content The object to promote
20453 * This will take the @p content and move it to the top of the stack as
20454 * if it had been pushed there.
20456 * @note If the content isn't already in the stack use
20457 * elm_pager_content_push().
20458 * @warning Using this function on @p content not already in the stack
20459 * results in undefined behavior.
20461 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20464 * @brief Return the object at the bottom of the pager stack
20466 * @param obj The pager object
20467 * @return The bottom object or NULL if none
20469 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20472 * @brief Return the object at the top of the pager stack
20474 * @param obj The pager object
20475 * @return The top object or NULL if none
20477 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20479 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20480 EINA_DEPRECATED EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20487 * @defgroup Slideshow Slideshow
20489 * @image html img/widget/slideshow/preview-00.png
20490 * @image latex img/widget/slideshow/preview-00.eps
20492 * This widget, as the name indicates, is a pre-made image
20493 * slideshow panel, with API functions acting on (child) image
20494 * items presentation. Between those actions, are:
20495 * - advance to next/previous image
20496 * - select the style of image transition animation
20497 * - set the exhibition time for each image
20498 * - start/stop the slideshow
20500 * The transition animations are defined in the widget's theme,
20501 * consequently new animations can be added without having to
20502 * update the widget's code.
20504 * @section Slideshow_Items Slideshow items
20506 * For slideshow items, just like for @ref Genlist "genlist" ones,
20507 * the user defines a @b classes, specifying functions that will be
20508 * called on the item's creation and deletion times.
20510 * The #Elm_Slideshow_Item_Class structure contains the following
20513 * - @c func.get - When an item is displayed, this function is
20514 * called, and it's where one should create the item object, de
20515 * facto. For example, the object can be a pure Evas image object
20516 * or an Elementary @ref Photocam "photocam" widget. See
20517 * #SlideshowItemGetFunc.
20518 * - @c func.del - When an item is no more displayed, this function
20519 * is called, where the user must delete any data associated to
20520 * the item. See #SlideshowItemDelFunc.
20522 * @section Slideshow_Caching Slideshow caching
20524 * The slideshow provides facilities to have items adjacent to the
20525 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20526 * you, so that the system does not have to decode image data
20527 * anymore at the time it has to actually switch images on its
20528 * viewport. The user is able to set the numbers of items to be
20529 * cached @b before and @b after the current item, in the widget's
20532 * Smart events one can add callbacks for are:
20534 * - @c "changed" - when the slideshow switches its view to a new
20537 * List of examples for the slideshow widget:
20538 * @li @ref slideshow_example
20542 * @addtogroup Slideshow
20546 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20547 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20548 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20549 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20550 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20553 * @struct _Elm_Slideshow_Item_Class
20555 * Slideshow item class definition. See @ref Slideshow_Items for
20558 struct _Elm_Slideshow_Item_Class
20560 struct _Elm_Slideshow_Item_Class_Func
20562 SlideshowItemGetFunc get;
20563 SlideshowItemDelFunc del;
20565 }; /**< #Elm_Slideshow_Item_Class member definitions */
20568 * Add a new slideshow widget to the given parent Elementary
20569 * (container) object
20571 * @param parent The parent object
20572 * @return A new slideshow widget handle or @c NULL, on errors
20574 * This function inserts a new slideshow widget on the canvas.
20576 * @ingroup Slideshow
20578 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20581 * Add (append) a new item in a given slideshow widget.
20583 * @param obj The slideshow object
20584 * @param itc The item class for the item
20585 * @param data The item's data
20586 * @return A handle to the item added or @c NULL, on errors
20588 * Add a new item to @p obj's internal list of items, appending it.
20589 * The item's class must contain the function really fetching the
20590 * image object to show for this item, which could be an Evas image
20591 * object or an Elementary photo, for example. The @p data
20592 * parameter is going to be passed to both class functions of the
20595 * @see #Elm_Slideshow_Item_Class
20596 * @see elm_slideshow_item_sorted_insert()
20598 * @ingroup Slideshow
20600 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20603 * Insert a new item into the given slideshow widget, using the @p func
20604 * function to sort items (by item handles).
20606 * @param obj The slideshow object
20607 * @param itc The item class for the item
20608 * @param data The item's data
20609 * @param func The comparing function to be used to sort slideshow
20610 * items <b>by #Elm_Slideshow_Item item handles</b>
20611 * @return Returns The slideshow item handle, on success, or
20612 * @c NULL, on errors
20614 * Add a new item to @p obj's internal list of items, in a position
20615 * determined by the @p func comparing function. The item's class
20616 * must contain the function really fetching the image object to
20617 * show for this item, which could be an Evas image object or an
20618 * Elementary photo, for example. The @p data parameter is going to
20619 * be passed to both class functions of the item.
20621 * @see #Elm_Slideshow_Item_Class
20622 * @see elm_slideshow_item_add()
20624 * @ingroup Slideshow
20626 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);
20629 * Display a given slideshow widget's item, programmatically.
20631 * @param obj The slideshow object
20632 * @param item The item to display on @p obj's viewport
20634 * The change between the current item and @p item will use the
20635 * transition @p obj is set to use (@see
20636 * elm_slideshow_transition_set()).
20638 * @ingroup Slideshow
20640 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20643 * Slide to the @b next item, in a given slideshow widget
20645 * @param obj The slideshow object
20647 * The sliding animation @p obj is set to use will be the
20648 * transition effect used, after this call is issued.
20650 * @note If the end of the slideshow's internal list of items is
20651 * reached, it'll wrap around to the list's beginning, again.
20653 * @ingroup Slideshow
20655 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20658 * Slide to the @b previous item, in a given slideshow widget
20660 * @param obj The slideshow object
20662 * The sliding animation @p obj is set to use will be the
20663 * transition effect used, after this call is issued.
20665 * @note If the beginning of the slideshow's internal list of items
20666 * is reached, it'll wrap around to the list's end, again.
20668 * @ingroup Slideshow
20670 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20673 * Returns the list of sliding transition/effect names available, for a
20674 * given slideshow widget.
20676 * @param obj The slideshow object
20677 * @return The list of transitions (list of @b stringshared strings
20680 * The transitions, which come from @p obj's theme, must be an EDC
20681 * data item named @c "transitions" on the theme file, with (prefix)
20682 * names of EDC programs actually implementing them.
20684 * The available transitions for slideshows on the default theme are:
20685 * - @c "fade" - the current item fades out, while the new one
20686 * fades in to the slideshow's viewport.
20687 * - @c "black_fade" - the current item fades to black, and just
20688 * then, the new item will fade in.
20689 * - @c "horizontal" - the current item slides horizontally, until
20690 * it gets out of the slideshow's viewport, while the new item
20691 * comes from the left to take its place.
20692 * - @c "vertical" - the current item slides vertically, until it
20693 * gets out of the slideshow's viewport, while the new item comes
20694 * from the bottom to take its place.
20695 * - @c "square" - the new item starts to appear from the middle of
20696 * the current one, but with a tiny size, growing until its
20697 * target (full) size and covering the old one.
20699 * @warning The stringshared strings get no new references
20700 * exclusive to the user grabbing the list, here, so if you'd like
20701 * to use them out of this call's context, you'd better @c
20702 * eina_stringshare_ref() them.
20704 * @see elm_slideshow_transition_set()
20706 * @ingroup Slideshow
20708 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20711 * Set the current slide transition/effect in use for a given
20714 * @param obj The slideshow object
20715 * @param transition The new transition's name string
20717 * If @p transition is implemented in @p obj's theme (i.e., is
20718 * contained in the list returned by
20719 * elm_slideshow_transitions_get()), this new sliding effect will
20720 * be used on the widget.
20722 * @see elm_slideshow_transitions_get() for more details
20724 * @ingroup Slideshow
20726 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20729 * Get the current slide transition/effect in use for a given
20732 * @param obj The slideshow object
20733 * @return The current transition's name
20735 * @see elm_slideshow_transition_set() for more details
20737 * @ingroup Slideshow
20739 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20742 * Set the interval between each image transition on a given
20743 * slideshow widget, <b>and start the slideshow, itself</b>
20745 * @param obj The slideshow object
20746 * @param timeout The new displaying timeout for images
20748 * After this call, the slideshow widget will start cycling its
20749 * view, sequentially and automatically, with the images of the
20750 * items it has. The time between each new image displayed is going
20751 * to be @p timeout, in @b seconds. If a different timeout was set
20752 * previously and an slideshow was in progress, it will continue
20753 * with the new time between transitions, after this call.
20755 * @note A value less than or equal to 0 on @p timeout will disable
20756 * the widget's internal timer, thus halting any slideshow which
20757 * could be happening on @p obj.
20759 * @see elm_slideshow_timeout_get()
20761 * @ingroup Slideshow
20763 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20766 * Get the interval set for image transitions on a given slideshow
20769 * @param obj The slideshow object
20770 * @return Returns the timeout set on it
20772 * @see elm_slideshow_timeout_set() for more details
20774 * @ingroup Slideshow
20776 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20779 * Set if, after a slideshow is started, for a given slideshow
20780 * widget, its items should be displayed cyclically or not.
20782 * @param obj The slideshow object
20783 * @param loop Use @c EINA_TRUE to make it cycle through items or
20784 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20787 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20788 * ignore what is set by this functions, i.e., they'll @b always
20789 * cycle through items. This affects only the "automatic"
20790 * slideshow, as set by elm_slideshow_timeout_set().
20792 * @see elm_slideshow_loop_get()
20794 * @ingroup Slideshow
20796 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20799 * Get if, after a slideshow is started, for a given slideshow
20800 * widget, its items are to be displayed cyclically or not.
20802 * @param obj The slideshow object
20803 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20804 * through or @c EINA_FALSE, otherwise
20806 * @see elm_slideshow_loop_set() for more details
20808 * @ingroup Slideshow
20810 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20813 * Remove all items from a given slideshow widget
20815 * @param obj The slideshow object
20817 * This removes (and deletes) all items in @p obj, leaving it
20820 * @see elm_slideshow_item_del(), to remove just one item.
20822 * @ingroup Slideshow
20824 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20827 * Get the internal list of items in a given slideshow widget.
20829 * @param obj The slideshow object
20830 * @return The list of items (#Elm_Slideshow_Item as data) or
20831 * @c NULL on errors.
20833 * This list is @b not to be modified in any way and must not be
20834 * freed. Use the list members with functions like
20835 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20837 * @warning This list is only valid until @p obj object's internal
20838 * items list is changed. It should be fetched again with another
20839 * call to this function when changes happen.
20841 * @ingroup Slideshow
20843 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20846 * Delete a given item from a slideshow widget.
20848 * @param item The slideshow item
20850 * @ingroup Slideshow
20852 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20855 * Return the data associated with a given slideshow item
20857 * @param item The slideshow item
20858 * @return Returns the data associated to this item
20860 * @ingroup Slideshow
20862 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20865 * Returns the currently displayed item, in a given slideshow widget
20867 * @param obj The slideshow object
20868 * @return A handle to the item being displayed in @p obj or
20869 * @c NULL, if none is (and on errors)
20871 * @ingroup Slideshow
20873 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20876 * Get the real Evas object created to implement the view of a
20877 * given slideshow item
20879 * @param item The slideshow item.
20880 * @return the Evas object implementing this item's view.
20882 * This returns the actual Evas object used to implement the
20883 * specified slideshow item's view. This may be @c NULL, as it may
20884 * not have been created or may have been deleted, at any time, by
20885 * the slideshow. <b>Do not modify this object</b> (move, resize,
20886 * show, hide, etc.), as the slideshow is controlling it. This
20887 * function is for querying, emitting custom signals or hooking
20888 * lower level callbacks for events on that object. Do not delete
20889 * this object under any circumstances.
20891 * @see elm_slideshow_item_data_get()
20893 * @ingroup Slideshow
20895 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20898 * Get the the item, in a given slideshow widget, placed at
20899 * position @p nth, in its internal items list
20901 * @param obj The slideshow object
20902 * @param nth The number of the item to grab a handle to (0 being
20904 * @return The item stored in @p obj at position @p nth or @c NULL,
20905 * if there's no item with that index (and on errors)
20907 * @ingroup Slideshow
20909 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20912 * Set the current slide layout in use for a given slideshow widget
20914 * @param obj The slideshow object
20915 * @param layout The new layout's name string
20917 * If @p layout is implemented in @p obj's theme (i.e., is contained
20918 * in the list returned by elm_slideshow_layouts_get()), this new
20919 * images layout will be used on the widget.
20921 * @see elm_slideshow_layouts_get() for more details
20923 * @ingroup Slideshow
20925 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20928 * Get the current slide layout in use for a given slideshow widget
20930 * @param obj The slideshow object
20931 * @return The current layout's name
20933 * @see elm_slideshow_layout_set() for more details
20935 * @ingroup Slideshow
20937 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20940 * Returns the list of @b layout names available, for a given
20941 * slideshow widget.
20943 * @param obj The slideshow object
20944 * @return The list of layouts (list of @b stringshared strings
20947 * Slideshow layouts will change how the widget is to dispose each
20948 * image item in its viewport, with regard to cropping, scaling,
20951 * The layouts, which come from @p obj's theme, must be an EDC
20952 * data item name @c "layouts" on the theme file, with (prefix)
20953 * names of EDC programs actually implementing them.
20955 * The available layouts for slideshows on the default theme are:
20956 * - @c "fullscreen" - item images with original aspect, scaled to
20957 * touch top and down slideshow borders or, if the image's heigh
20958 * is not enough, left and right slideshow borders.
20959 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20960 * one, but always leaving 10% of the slideshow's dimensions of
20961 * distance between the item image's borders and the slideshow
20962 * borders, for each axis.
20964 * @warning The stringshared strings get no new references
20965 * exclusive to the user grabbing the list, here, so if you'd like
20966 * to use them out of this call's context, you'd better @c
20967 * eina_stringshare_ref() them.
20969 * @see elm_slideshow_layout_set()
20971 * @ingroup Slideshow
20973 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20976 * Set the number of items to cache, on a given slideshow widget,
20977 * <b>before the current item</b>
20979 * @param obj The slideshow object
20980 * @param count Number of items to cache before the current one
20982 * The default value for this property is @c 2. See
20983 * @ref Slideshow_Caching "slideshow caching" for more details.
20985 * @see elm_slideshow_cache_before_get()
20987 * @ingroup Slideshow
20989 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20992 * Retrieve the number of items to cache, on a given slideshow widget,
20993 * <b>before the current item</b>
20995 * @param obj The slideshow object
20996 * @return The number of items set to be cached before the current one
20998 * @see elm_slideshow_cache_before_set() for more details
21000 * @ingroup Slideshow
21002 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21005 * Set the number of items to cache, on a given slideshow widget,
21006 * <b>after the current item</b>
21008 * @param obj The slideshow object
21009 * @param count Number of items to cache after the current one
21011 * The default value for this property is @c 2. See
21012 * @ref Slideshow_Caching "slideshow caching" for more details.
21014 * @see elm_slideshow_cache_after_get()
21016 * @ingroup Slideshow
21018 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21021 * Retrieve the number of items to cache, on a given slideshow widget,
21022 * <b>after the current item</b>
21024 * @param obj The slideshow object
21025 * @return The number of items set to be cached after the current one
21027 * @see elm_slideshow_cache_after_set() for more details
21029 * @ingroup Slideshow
21031 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21034 * Get the number of items stored in a given slideshow widget
21036 * @param obj The slideshow object
21037 * @return The number of items on @p obj, at the moment of this call
21039 * @ingroup Slideshow
21041 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21048 * @defgroup Fileselector File Selector
21050 * @image html img/widget/fileselector/preview-00.png
21051 * @image latex img/widget/fileselector/preview-00.eps
21053 * A file selector is a widget that allows a user to navigate
21054 * through a file system, reporting file selections back via its
21057 * It contains shortcut buttons for home directory (@c ~) and to
21058 * jump one directory upwards (..), as well as cancel/ok buttons to
21059 * confirm/cancel a given selection. After either one of those two
21060 * former actions, the file selector will issue its @c "done" smart
21063 * There's a text entry on it, too, showing the name of the current
21064 * selection. There's the possibility of making it editable, so it
21065 * is useful on file saving dialogs on applications, where one
21066 * gives a file name to save contents to, in a given directory in
21067 * the system. This custom file name will be reported on the @c
21068 * "done" smart callback (explained in sequence).
21070 * Finally, it has a view to display file system items into in two
21075 * If Elementary is built with support of the Ethumb thumbnailing
21076 * library, the second form of view will display preview thumbnails
21077 * of files which it supports.
21079 * Smart callbacks one can register to:
21081 * - @c "selected" - the user has clicked on a file (when not in
21082 * folders-only mode) or directory (when in folders-only mode)
21083 * - @c "directory,open" - the list has been populated with new
21084 * content (@c event_info is a pointer to the directory's
21085 * path, a @b stringshared string)
21086 * - @c "done" - the user has clicked on the "ok" or "cancel"
21087 * buttons (@c event_info is a pointer to the selection's
21088 * path, a @b stringshared string)
21090 * Here is an example on its usage:
21091 * @li @ref fileselector_example
21095 * @addtogroup Fileselector
21100 * Defines how a file selector widget is to layout its contents
21101 * (file system entries).
21103 typedef enum _Elm_Fileselector_Mode
21105 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21106 ELM_FILESELECTOR_GRID, /**< layout as a grid */
21107 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21108 } Elm_Fileselector_Mode;
21111 * Add a new file selector widget to the given parent Elementary
21112 * (container) object
21114 * @param parent The parent object
21115 * @return a new file selector widget handle or @c NULL, on errors
21117 * This function inserts a new file selector widget on the canvas.
21119 * @ingroup Fileselector
21121 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21124 * Enable/disable the file name entry box where the user can type
21125 * in a name for a file, in a given file selector widget
21127 * @param obj The file selector object
21128 * @param is_save @c EINA_TRUE to make the file selector a "saving
21129 * dialog", @c EINA_FALSE otherwise
21131 * Having the entry editable is useful on file saving dialogs on
21132 * applications, where one gives a file name to save contents to,
21133 * in a given directory in the system. This custom file name will
21134 * be reported on the @c "done" smart callback.
21136 * @see elm_fileselector_is_save_get()
21138 * @ingroup Fileselector
21140 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21143 * Get whether the given file selector is in "saving dialog" mode
21145 * @param obj The file selector object
21146 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21147 * mode, @c EINA_FALSE otherwise (and on errors)
21149 * @see elm_fileselector_is_save_set() for more details
21151 * @ingroup Fileselector
21153 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21156 * Enable/disable folder-only view for a given file selector widget
21158 * @param obj The file selector object
21159 * @param only @c EINA_TRUE to make @p obj only display
21160 * directories, @c EINA_FALSE to make files to be displayed in it
21163 * If enabled, the widget's view will only display folder items,
21166 * @see elm_fileselector_folder_only_get()
21168 * @ingroup Fileselector
21170 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21173 * Get whether folder-only view is set for a given file selector
21176 * @param obj The file selector object
21177 * @return only @c EINA_TRUE if @p obj is only displaying
21178 * directories, @c EINA_FALSE if files are being displayed in it
21179 * too (and on errors)
21181 * @see elm_fileselector_folder_only_get()
21183 * @ingroup Fileselector
21185 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21188 * Enable/disable the "ok" and "cancel" buttons on a given file
21191 * @param obj The file selector object
21192 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21194 * @note A file selector without those buttons will never emit the
21195 * @c "done" smart event, and is only usable if one is just hooking
21196 * to the other two events.
21198 * @see elm_fileselector_buttons_ok_cancel_get()
21200 * @ingroup Fileselector
21202 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21205 * Get whether the "ok" and "cancel" buttons on a given file
21206 * selector widget are being shown.
21208 * @param obj The file selector object
21209 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21210 * otherwise (and on errors)
21212 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21214 * @ingroup Fileselector
21216 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21219 * Enable/disable a tree view in the given file selector widget,
21220 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21222 * @param obj The file selector object
21223 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21226 * In a tree view, arrows are created on the sides of directories,
21227 * allowing them to expand in place.
21229 * @note If it's in other mode, the changes made by this function
21230 * will only be visible when one switches back to "list" mode.
21232 * @see elm_fileselector_expandable_get()
21234 * @ingroup Fileselector
21236 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21239 * Get whether tree view is enabled for the given file selector
21242 * @param obj The file selector object
21243 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21244 * otherwise (and or errors)
21246 * @see elm_fileselector_expandable_set() for more details
21248 * @ingroup Fileselector
21250 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21253 * Set, programmatically, the @b directory that a given file
21254 * selector widget will display contents from
21256 * @param obj The file selector object
21257 * @param path The path to display in @p obj
21259 * This will change the @b directory that @p obj is displaying. It
21260 * will also clear the text entry area on the @p obj object, which
21261 * displays select files' names.
21263 * @see elm_fileselector_path_get()
21265 * @ingroup Fileselector
21267 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21270 * Get the parent directory's path that a given file selector
21271 * widget is displaying
21273 * @param obj The file selector object
21274 * @return The (full) path of the directory the file selector is
21275 * displaying, a @b stringshared string
21277 * @see elm_fileselector_path_set()
21279 * @ingroup Fileselector
21281 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21284 * Set, programmatically, the currently selected file/directory in
21285 * the given file selector widget
21287 * @param obj The file selector object
21288 * @param path The (full) path to a file or directory
21289 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21290 * latter case occurs if the directory or file pointed to do not
21293 * @see elm_fileselector_selected_get()
21295 * @ingroup Fileselector
21297 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21300 * Get the currently selected item's (full) path, in the given file
21303 * @param obj The file selector object
21304 * @return The absolute path of the selected item, a @b
21305 * stringshared string
21307 * @note Custom editions on @p obj object's text entry, if made,
21308 * will appear on the return string of this function, naturally.
21310 * @see elm_fileselector_selected_set() for more details
21312 * @ingroup Fileselector
21314 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21317 * Set the mode in which a given file selector widget will display
21318 * (layout) file system entries in its view
21320 * @param obj The file selector object
21321 * @param mode The mode of the fileselector, being it one of
21322 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21323 * first one, naturally, will display the files in a list. The
21324 * latter will make the widget to display its entries in a grid
21327 * @note By using elm_fileselector_expandable_set(), the user may
21328 * trigger a tree view for that list.
21330 * @note If Elementary is built with support of the Ethumb
21331 * thumbnailing library, the second form of view will display
21332 * preview thumbnails of files which it supports. You must have
21333 * elm_need_ethumb() called in your Elementary for thumbnailing to
21336 * @see elm_fileselector_expandable_set().
21337 * @see elm_fileselector_mode_get().
21339 * @ingroup Fileselector
21341 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21344 * Get the mode in which a given file selector widget is displaying
21345 * (layouting) file system entries in its view
21347 * @param obj The fileselector object
21348 * @return The mode in which the fileselector is at
21350 * @see elm_fileselector_mode_set() for more details
21352 * @ingroup Fileselector
21354 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21361 * @defgroup Progressbar Progress bar
21363 * The progress bar is a widget for visually representing the
21364 * progress status of a given job/task.
21366 * A progress bar may be horizontal or vertical. It may display an
21367 * icon besides it, as well as primary and @b units labels. The
21368 * former is meant to label the widget as a whole, while the
21369 * latter, which is formatted with floating point values (and thus
21370 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21371 * units"</c>), is meant to label the widget's <b>progress
21372 * value</b>. Label, icon and unit strings/objects are @b optional
21373 * for progress bars.
21375 * A progress bar may be @b inverted, in which state it gets its
21376 * values inverted, with high values being on the left or top and
21377 * low values on the right or bottom, as opposed to normally have
21378 * the low values on the former and high values on the latter,
21379 * respectively, for horizontal and vertical modes.
21381 * The @b span of the progress, as set by
21382 * elm_progressbar_span_size_set(), is its length (horizontally or
21383 * vertically), unless one puts size hints on the widget to expand
21384 * on desired directions, by any container. That length will be
21385 * scaled by the object or applications scaling factor. At any
21386 * point code can query the progress bar for its value with
21387 * elm_progressbar_value_get().
21389 * Available widget styles for progress bars:
21391 * - @c "wheel" (simple style, no text, no progression, only
21392 * "pulse" effect is available)
21394 * Default contents parts of the progressbar widget that you can use for are:
21395 * @li "icon" - A icon of the progressbar
21397 * Here is an example on its usage:
21398 * @li @ref progressbar_example
21402 * Add a new progress bar widget to the given parent Elementary
21403 * (container) object
21405 * @param parent The parent object
21406 * @return a new progress bar widget handle or @c NULL, on errors
21408 * This function inserts a new progress bar widget on the canvas.
21410 * @ingroup Progressbar
21412 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21415 * Set whether a given progress bar widget is at "pulsing mode" or
21418 * @param obj The progress bar object
21419 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21420 * @c EINA_FALSE to put it back to its default one
21422 * By default, progress bars will display values from the low to
21423 * high value boundaries. There are, though, contexts in which the
21424 * state of progression of a given task is @b unknown. For those,
21425 * one can set a progress bar widget to a "pulsing state", to give
21426 * the user an idea that some computation is being held, but
21427 * without exact progress values. In the default theme it will
21428 * animate its bar with the contents filling in constantly and back
21429 * to non-filled, in a loop. To start and stop this pulsing
21430 * animation, one has to explicitly call elm_progressbar_pulse().
21432 * @see elm_progressbar_pulse_get()
21433 * @see elm_progressbar_pulse()
21435 * @ingroup Progressbar
21437 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21440 * Get whether a given progress bar widget is at "pulsing mode" or
21443 * @param obj The progress bar object
21444 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21445 * if it's in the default one (and on errors)
21447 * @ingroup Progressbar
21449 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21452 * Start/stop a given progress bar "pulsing" animation, if its
21455 * @param obj The progress bar object
21456 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21457 * @c EINA_FALSE to @b stop it
21459 * @note This call won't do anything if @p obj is not under "pulsing mode".
21461 * @see elm_progressbar_pulse_set() for more details.
21463 * @ingroup Progressbar
21465 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21468 * Set the progress value (in percentage) on a given progress bar
21471 * @param obj The progress bar object
21472 * @param val The progress value (@b must be between @c 0.0 and @c
21475 * Use this call to set progress bar levels.
21477 * @note If you passes a value out of the specified range for @p
21478 * val, it will be interpreted as the @b closest of the @b boundary
21479 * values in the range.
21481 * @ingroup Progressbar
21483 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21486 * Get the progress value (in percentage) on a given progress bar
21489 * @param obj The progress bar object
21490 * @return The value of the progressbar
21492 * @see elm_progressbar_value_set() for more details
21494 * @ingroup Progressbar
21496 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21499 * Set the label of a given progress bar widget
21501 * @param obj The progress bar object
21502 * @param label The text label string, in UTF-8
21504 * @ingroup Progressbar
21505 * @deprecated use elm_object_text_set() instead.
21507 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21510 * Get the label of a given progress bar widget
21512 * @param obj The progressbar object
21513 * @return The text label string, in UTF-8
21515 * @ingroup Progressbar
21516 * @deprecated use elm_object_text_set() instead.
21518 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21521 * Set the icon object of a given progress bar widget
21523 * @param obj The progress bar object
21524 * @param icon The icon object
21526 * Use this call to decorate @p obj with an icon next to it.
21528 * @note Once the icon object is set, a previously set one will be
21529 * deleted. If you want to keep that old content object, use the
21530 * elm_progressbar_icon_unset() function.
21532 * @see elm_progressbar_icon_get()
21533 * @deprecated use elm_object_part_content_set() instead.
21535 * @ingroup Progressbar
21537 WILL_DEPRECATE EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21540 * Retrieve the icon object set for a given progress bar widget
21542 * @param obj The progress bar object
21543 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21544 * otherwise (and on errors)
21546 * @see elm_progressbar_icon_set() for more details
21547 * @deprecated use elm_object_part_content_get() instead.
21549 * @ingroup Progressbar
21551 WILL_DEPRECATE EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21554 * Unset an icon set on a given progress bar widget
21556 * @param obj The progress bar object
21557 * @return The icon object that was being used, if any was set, or
21558 * @c NULL, otherwise (and on errors)
21560 * This call will unparent and return the icon object which was set
21561 * for this widget, previously, on success.
21563 * @see elm_progressbar_icon_set() for more details
21564 * @deprecated use elm_object_part_content_unset() instead.
21566 * @ingroup Progressbar
21568 WILL_DEPRECATE EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21571 * Set the (exact) length of the bar region of a given progress bar
21574 * @param obj The progress bar object
21575 * @param size The length of the progress bar's bar region
21577 * This sets the minimum width (when in horizontal mode) or height
21578 * (when in vertical mode) of the actual bar area of the progress
21579 * bar @p obj. This in turn affects the object's minimum size. Use
21580 * this when you're not setting other size hints expanding on the
21581 * given direction (like weight and alignment hints) and you would
21582 * like it to have a specific size.
21584 * @note Icon, label and unit text around @p obj will require their
21585 * own space, which will make @p obj to require more the @p size,
21588 * @see elm_progressbar_span_size_get()
21590 * @ingroup Progressbar
21592 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21595 * Get the length set for the bar region of a given progress bar
21598 * @param obj The progress bar object
21599 * @return The length of the progress bar's bar region
21601 * If that size was not set previously, with
21602 * elm_progressbar_span_size_set(), this call will return @c 0.
21604 * @ingroup Progressbar
21606 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21609 * Set the format string for a given progress bar widget's units
21612 * @param obj The progress bar object
21613 * @param format The format string for @p obj's units label
21615 * If @c NULL is passed on @p format, it will make @p obj's units
21616 * area to be hidden completely. If not, it'll set the <b>format
21617 * string</b> for the units label's @b text. The units label is
21618 * provided a floating point value, so the units text is up display
21619 * at most one floating point falue. Note that the units label is
21620 * optional. Use a format string such as "%1.2f meters" for
21623 * @note The default format string for a progress bar is an integer
21624 * percentage, as in @c "%.0f %%".
21626 * @see elm_progressbar_unit_format_get()
21628 * @ingroup Progressbar
21630 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21633 * Retrieve the format string set for a given progress bar widget's
21636 * @param obj The progress bar object
21637 * @return The format set string for @p obj's units label or
21638 * @c NULL, if none was set (and on errors)
21640 * @see elm_progressbar_unit_format_set() for more details
21642 * @ingroup Progressbar
21644 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21647 * Set the orientation of a given progress bar widget
21649 * @param obj The progress bar object
21650 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21651 * @b horizontal, @c EINA_FALSE to make it @b vertical
21653 * Use this function to change how your progress bar is to be
21654 * disposed: vertically or horizontally.
21656 * @see elm_progressbar_horizontal_get()
21658 * @ingroup Progressbar
21660 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21663 * Retrieve the orientation of a given progress bar widget
21665 * @param obj The progress bar object
21666 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21667 * @c EINA_FALSE if it's @b vertical (and on errors)
21669 * @see elm_progressbar_horizontal_set() for more details
21671 * @ingroup Progressbar
21673 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21676 * Invert a given progress bar widget's displaying values order
21678 * @param obj The progress bar object
21679 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21680 * @c EINA_FALSE to bring it back to default, non-inverted values.
21682 * A progress bar may be @b inverted, in which state it gets its
21683 * values inverted, with high values being on the left or top and
21684 * low values on the right or bottom, as opposed to normally have
21685 * the low values on the former and high values on the latter,
21686 * respectively, for horizontal and vertical modes.
21688 * @see elm_progressbar_inverted_get()
21690 * @ingroup Progressbar
21692 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21695 * Get whether a given progress bar widget's displaying values are
21698 * @param obj The progress bar object
21699 * @return @c EINA_TRUE, if @p obj has inverted values,
21700 * @c EINA_FALSE otherwise (and on errors)
21702 * @see elm_progressbar_inverted_set() for more details
21704 * @ingroup Progressbar
21706 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21709 * @defgroup Separator Separator
21711 * @brief Separator is a very thin object used to separate other objects.
21713 * A separator can be vertical or horizontal.
21715 * @ref tutorial_separator is a good example of how to use a separator.
21719 * @brief Add a separator object to @p parent
21721 * @param parent The parent object
21723 * @return The separator object, or NULL upon failure
21725 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21727 * @brief Set the horizontal mode of a separator object
21729 * @param obj The separator object
21730 * @param horizontal If true, the separator is horizontal
21732 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21734 * @brief Get the horizontal mode of a separator object
21736 * @param obj The separator object
21737 * @return If true, the separator is horizontal
21739 * @see elm_separator_horizontal_set()
21741 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21747 * @defgroup Spinner Spinner
21748 * @ingroup Elementary
21750 * @image html img/widget/spinner/preview-00.png
21751 * @image latex img/widget/spinner/preview-00.eps
21753 * A spinner is a widget which allows the user to increase or decrease
21754 * numeric values using arrow buttons, or edit values directly, clicking
21755 * over it and typing the new value.
21757 * By default the spinner will not wrap and has a label
21758 * of "%.0f" (just showing the integer value of the double).
21760 * A spinner has a label that is formatted with floating
21761 * point values and thus accepts a printf-style format string, like
21762 * ā%1.2f unitsā.
21764 * It also allows specific values to be replaced by pre-defined labels.
21766 * Smart callbacks one can register to:
21768 * - "changed" - Whenever the spinner value is changed.
21769 * - "delay,changed" - A short time after the value is changed by the user.
21770 * This will be called only when the user stops dragging for a very short
21771 * period or when they release their finger/mouse, so it avoids possibly
21772 * expensive reactions to the value change.
21774 * Available styles for it:
21776 * - @c "vertical": up/down buttons at the right side and text left aligned.
21778 * Here is an example on its usage:
21779 * @ref spinner_example
21783 * @addtogroup Spinner
21788 * Add a new spinner widget to the given parent Elementary
21789 * (container) object.
21791 * @param parent The parent object.
21792 * @return a new spinner widget handle or @c NULL, on errors.
21794 * This function inserts a new spinner widget on the canvas.
21799 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21802 * Set the format string of the displayed label.
21804 * @param obj The spinner object.
21805 * @param fmt The format string for the label display.
21807 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21808 * string for the label text. The label text is provided a floating point
21809 * value, so the label text can display up to 1 floating point value.
21810 * Note that this is optional.
21812 * Use a format string such as "%1.2f meters" for example, and it will
21813 * display values like: "3.14 meters" for a value equal to 3.14159.
21815 * Default is "%0.f".
21817 * @see elm_spinner_label_format_get()
21821 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21824 * Get the label format of the spinner.
21826 * @param obj The spinner object.
21827 * @return The text label format string in UTF-8.
21829 * @see elm_spinner_label_format_set() for details.
21833 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21836 * Set the minimum and maximum values for the spinner.
21838 * @param obj The spinner object.
21839 * @param min The minimum value.
21840 * @param max The maximum value.
21842 * Define the allowed range of values to be selected by the user.
21844 * If actual value is less than @p min, it will be updated to @p min. If it
21845 * is bigger then @p max, will be updated to @p max. Actual value can be
21846 * get with elm_spinner_value_get().
21848 * By default, min is equal to 0, and max is equal to 100.
21850 * @warning Maximum must be greater than minimum.
21852 * @see elm_spinner_min_max_get()
21856 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21859 * Get the minimum and maximum values of the spinner.
21861 * @param obj The spinner object.
21862 * @param min Pointer where to store the minimum value.
21863 * @param max Pointer where to store the maximum value.
21865 * @note If only one value is needed, the other pointer can be passed
21868 * @see elm_spinner_min_max_set() for details.
21872 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21875 * Set the step used to increment or decrement the spinner value.
21877 * @param obj The spinner object.
21878 * @param step The step value.
21880 * This value will be incremented or decremented to the displayed value.
21881 * It will be incremented while the user keep right or top arrow pressed,
21882 * and will be decremented while the user keep left or bottom arrow pressed.
21884 * The interval to increment / decrement can be set with
21885 * elm_spinner_interval_set().
21887 * By default step value is equal to 1.
21889 * @see elm_spinner_step_get()
21893 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21896 * Get the step used to increment or decrement the spinner value.
21898 * @param obj The spinner object.
21899 * @return The step value.
21901 * @see elm_spinner_step_get() for more details.
21905 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21908 * Set the value the spinner displays.
21910 * @param obj The spinner object.
21911 * @param val The value to be displayed.
21913 * Value will be presented on the label following format specified with
21914 * elm_spinner_format_set().
21916 * @warning The value must to be between min and max values. This values
21917 * are set by elm_spinner_min_max_set().
21919 * @see elm_spinner_value_get().
21920 * @see elm_spinner_format_set().
21921 * @see elm_spinner_min_max_set().
21925 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21928 * Get the value displayed by the spinner.
21930 * @param obj The spinner object.
21931 * @return The value displayed.
21933 * @see elm_spinner_value_set() for details.
21937 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21940 * Set whether the spinner should wrap when it reaches its
21941 * minimum or maximum value.
21943 * @param obj The spinner object.
21944 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21947 * Disabled by default. If disabled, when the user tries to increment the
21949 * but displayed value plus step value is bigger than maximum value,
21951 * won't allow it. The same happens when the user tries to decrement it,
21952 * but the value less step is less than minimum value.
21954 * When wrap is enabled, in such situations it will allow these changes,
21955 * but will get the value that would be less than minimum and subtracts
21956 * from maximum. Or add the value that would be more than maximum to
21960 * @li min value = 10
21961 * @li max value = 50
21962 * @li step value = 20
21963 * @li displayed value = 20
21965 * When the user decrement value (using left or bottom arrow), it will
21966 * displays @c 40, because max - (min - (displayed - step)) is
21967 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21969 * @see elm_spinner_wrap_get().
21973 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21976 * Get whether the spinner should wrap when it reaches its
21977 * minimum or maximum value.
21979 * @param obj The spinner object
21980 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21981 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21983 * @see elm_spinner_wrap_set() for details.
21987 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21990 * Set whether the spinner can be directly edited by the user or not.
21992 * @param obj The spinner object.
21993 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21994 * don't allow users to edit it directly.
21996 * Spinner objects can have edition @b disabled, in which state they will
21997 * be changed only by arrows.
21998 * Useful for contexts
21999 * where you don't want your users to interact with it writting the value.
22001 * when using special values, the user can see real value instead
22002 * of special label on edition.
22004 * It's enabled by default.
22006 * @see elm_spinner_editable_get()
22010 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22013 * Get whether the spinner can be directly edited by the user or not.
22015 * @param obj The spinner object.
22016 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22017 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22019 * @see elm_spinner_editable_set() for details.
22023 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22026 * Set a special string to display in the place of the numerical value.
22028 * @param obj The spinner object.
22029 * @param value The value to be replaced.
22030 * @param label The label to be used.
22032 * It's useful for cases when a user should select an item that is
22033 * better indicated by a label than a value. For example, weekdays or months.
22037 * sp = elm_spinner_add(win);
22038 * elm_spinner_min_max_set(sp, 1, 3);
22039 * elm_spinner_special_value_add(sp, 1, "January");
22040 * elm_spinner_special_value_add(sp, 2, "February");
22041 * elm_spinner_special_value_add(sp, 3, "March");
22042 * evas_object_show(sp);
22047 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22050 * Set the interval on time updates for an user mouse button hold
22051 * on spinner widgets' arrows.
22053 * @param obj The spinner object.
22054 * @param interval The (first) interval value in seconds.
22056 * This interval value is @b decreased while the user holds the
22057 * mouse pointer either incrementing or decrementing spinner's value.
22059 * This helps the user to get to a given value distant from the
22060 * current one easier/faster, as it will start to change quicker and
22061 * quicker on mouse button holds.
22063 * The calculation for the next change interval value, starting from
22064 * the one set with this call, is the previous interval divided by
22065 * @c 1.05, so it decreases a little bit.
22067 * The default starting interval value for automatic changes is
22070 * @see elm_spinner_interval_get()
22074 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22077 * Get the interval on time updates for an user mouse button hold
22078 * on spinner widgets' arrows.
22080 * @param obj The spinner object.
22081 * @return The (first) interval value, in seconds, set on it.
22083 * @see elm_spinner_interval_set() for more details.
22087 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22094 * @defgroup Index Index
22096 * @image html img/widget/index/preview-00.png
22097 * @image latex img/widget/index/preview-00.eps
22099 * An index widget gives you an index for fast access to whichever
22100 * group of other UI items one might have. It's a list of text
22101 * items (usually letters, for alphabetically ordered access).
22103 * Index widgets are by default hidden and just appear when the
22104 * user clicks over it's reserved area in the canvas. In its
22105 * default theme, it's an area one @ref Fingers "finger" wide on
22106 * the right side of the index widget's container.
22108 * When items on the index are selected, smart callbacks get
22109 * called, so that its user can make other container objects to
22110 * show a given area or child object depending on the index item
22111 * selected. You'd probably be using an index together with @ref
22112 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22115 * Smart events one can add callbacks for are:
22116 * - @c "changed" - When the selected index item changes. @c
22117 * event_info is the selected item's data pointer.
22118 * - @c "delay,changed" - When the selected index item changes, but
22119 * after a small idling period. @c event_info is the selected
22120 * item's data pointer.
22121 * - @c "selected" - When the user releases a mouse button and
22122 * selects an item. @c event_info is the selected item's data
22124 * - @c "level,up" - when the user moves a finger from the first
22125 * level to the second level
22126 * - @c "level,down" - when the user moves a finger from the second
22127 * level to the first level
22129 * The @c "delay,changed" event is so that it'll wait a small time
22130 * before actually reporting those events and, moreover, just the
22131 * last event happening on those time frames will actually be
22134 * Here are some examples on its usage:
22135 * @li @ref index_example_01
22136 * @li @ref index_example_02
22140 * @addtogroup Index
22144 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22147 * Add a new index widget to the given parent Elementary
22148 * (container) object
22150 * @param parent The parent object
22151 * @return a new index widget handle or @c NULL, on errors
22153 * This function inserts a new index widget on the canvas.
22157 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22160 * Set whether a given index widget is or not visible,
22163 * @param obj The index object
22164 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22166 * Not to be confused with visible as in @c evas_object_show() --
22167 * visible with regard to the widget's auto hiding feature.
22169 * @see elm_index_active_get()
22173 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22176 * Get whether a given index widget is currently visible or not.
22178 * @param obj The index object
22179 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22181 * @see elm_index_active_set() for more details
22185 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22188 * Set the items level for a given index widget.
22190 * @param obj The index object.
22191 * @param level @c 0 or @c 1, the currently implemented levels.
22193 * @see elm_index_item_level_get()
22197 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22200 * Get the items level set for a given index widget.
22202 * @param obj The index object.
22203 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22205 * @see elm_index_item_level_set() for more information
22209 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22212 * Returns the last selected item's data, for a given index widget.
22214 * @param obj The index object.
22215 * @return The item @b data associated to the last selected item on
22216 * @p obj (or @c NULL, on errors).
22218 * @warning The returned value is @b not an #Elm_Index_Item item
22219 * handle, but the data associated to it (see the @c item parameter
22220 * in elm_index_item_append(), as an example).
22224 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22227 * Append a new item on a given index widget.
22229 * @param obj The index object.
22230 * @param letter Letter under which the item should be indexed
22231 * @param item The item data to set for the index's item
22233 * Despite the most common usage of the @p letter argument is for
22234 * single char strings, one could use arbitrary strings as index
22237 * @c item will be the pointer returned back on @c "changed", @c
22238 * "delay,changed" and @c "selected" smart events.
22242 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22245 * Prepend a new item on a given index widget.
22247 * @param obj The index object.
22248 * @param letter Letter under which the item should be indexed
22249 * @param item The item data to set for the index's item
22251 * Despite the most common usage of the @p letter argument is for
22252 * single char strings, one could use arbitrary strings as index
22255 * @c item will be the pointer returned back on @c "changed", @c
22256 * "delay,changed" and @c "selected" smart events.
22260 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22263 * Append a new item, on a given index widget, <b>after the item
22264 * having @p relative as data</b>.
22266 * @param obj The index object.
22267 * @param letter Letter under which the item should be indexed
22268 * @param item The item data to set for the index's item
22269 * @param relative The item data of the index item to be the
22270 * predecessor of this new one
22272 * Despite the most common usage of the @p letter argument is for
22273 * single char strings, one could use arbitrary strings as index
22276 * @c item will be the pointer returned back on @c "changed", @c
22277 * "delay,changed" and @c "selected" smart events.
22279 * @note If @p relative is @c NULL or if it's not found to be data
22280 * set on any previous item on @p obj, this function will behave as
22281 * elm_index_item_append().
22285 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22288 * Prepend a new item, on a given index widget, <b>after the item
22289 * having @p relative as data</b>.
22291 * @param obj The index object.
22292 * @param letter Letter under which the item should be indexed
22293 * @param item The item data to set for the index's item
22294 * @param relative The item data of the index item to be the
22295 * successor of this new one
22297 * Despite the most common usage of the @p letter argument is for
22298 * single char strings, one could use arbitrary strings as index
22301 * @c item will be the pointer returned back on @c "changed", @c
22302 * "delay,changed" and @c "selected" smart events.
22304 * @note If @p relative is @c NULL or if it's not found to be data
22305 * set on any previous item on @p obj, this function will behave as
22306 * elm_index_item_prepend().
22310 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22313 * Insert a new item into the given index widget, using @p cmp_func
22314 * function to sort items (by item handles).
22316 * @param obj The index object.
22317 * @param letter Letter under which the item should be indexed
22318 * @param item The item data to set for the index's item
22319 * @param cmp_func The comparing function to be used to sort index
22320 * items <b>by #Elm_Index_Item item handles</b>
22321 * @param cmp_data_func A @b fallback function to be called for the
22322 * sorting of index items <b>by item data</b>). It will be used
22323 * when @p cmp_func returns @c 0 (equality), which means an index
22324 * item with provided item data already exists. To decide which
22325 * data item should be pointed to by the index item in question, @p
22326 * cmp_data_func will be used. If @p cmp_data_func returns a
22327 * non-negative value, the previous index item data will be
22328 * replaced by the given @p item pointer. If the previous data need
22329 * to be freed, it should be done by the @p cmp_data_func function,
22330 * because all references to it will be lost. If this function is
22331 * not provided (@c NULL is given), index items will be @b
22332 * duplicated, if @p cmp_func returns @c 0.
22334 * Despite the most common usage of the @p letter argument is for
22335 * single char strings, one could use arbitrary strings as index
22338 * @c item will be the pointer returned back on @c "changed", @c
22339 * "delay,changed" and @c "selected" smart events.
22343 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);
22346 * Remove an item from a given index widget, <b>to be referenced by
22347 * it's data value</b>.
22349 * @param obj The index object
22350 * @param item The item's data pointer for the item to be removed
22353 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22354 * that callback function will be called by this one.
22356 * @warning The item to be removed from @p obj will be found via
22357 * its item data pointer, and not by an #Elm_Index_Item handle.
22361 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22364 * Find a given index widget's item, <b>using item data</b>.
22366 * @param obj The index object
22367 * @param item The item data pointed to by the desired index item
22368 * @return The index item handle, if found, or @c NULL otherwise
22372 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22375 * Removes @b all items from a given index widget.
22377 * @param obj The index object.
22379 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22380 * that callback function will be called for each item in @p obj.
22384 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22387 * Go to a given items level on a index widget
22389 * @param obj The index object
22390 * @param level The index level (one of @c 0 or @c 1)
22394 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22397 * Return the data associated with a given index widget item
22399 * @param it The index widget item handle
22400 * @return The data associated with @p it
22402 * @see elm_index_item_data_set()
22406 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22409 * Set the data associated with a given index widget item
22411 * @param it The index widget item handle
22412 * @param data The new data pointer to set to @p it
22414 * This sets new item data on @p it.
22416 * @warning The old data pointer won't be touched by this function, so
22417 * the user had better to free that old data himself/herself.
22421 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22424 * Set the function to be called when a given index widget item is freed.
22426 * @param it The item to set the callback on
22427 * @param func The function to call on the item's deletion
22429 * When called, @p func will have both @c data and @c event_info
22430 * arguments with the @p it item's data value and, naturally, the
22431 * @c obj argument with a handle to the parent index widget.
22435 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22438 * Get the letter (string) set on a given index widget item.
22440 * @param it The index item handle
22441 * @return The letter string set on @p it
22445 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22449 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22456 * @defgroup Photocam Photocam
22458 * @image html img/widget/photocam/preview-00.png
22459 * @image latex img/widget/photocam/preview-00.eps
22461 * This is a widget specifically for displaying high-resolution digital
22462 * camera photos giving speedy feedback (fast load), low memory footprint
22463 * and zooming and panning as well as fitting logic. It is entirely focused
22464 * on jpeg images, and takes advantage of properties of the jpeg format (via
22465 * evas loader features in the jpeg loader).
22467 * Signals that you can add callbacks for are:
22468 * @li "clicked" - This is called when a user has clicked the photo without
22470 * @li "press" - This is called when a user has pressed down on the photo.
22471 * @li "longpressed" - This is called when a user has pressed down on the
22472 * photo for a long time without dragging around.
22473 * @li "clicked,double" - This is called when a user has double-clicked the
22475 * @li "load" - Photo load begins.
22476 * @li "loaded" - This is called when the image file load is complete for the
22477 * first view (low resolution blurry version).
22478 * @li "load,detail" - Photo detailed data load begins.
22479 * @li "loaded,detail" - This is called when the image file load is complete
22480 * for the detailed image data (full resolution needed).
22481 * @li "zoom,start" - Zoom animation started.
22482 * @li "zoom,stop" - Zoom animation stopped.
22483 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22484 * @li "scroll" - the content has been scrolled (moved)
22485 * @li "scroll,anim,start" - scrolling animation has started
22486 * @li "scroll,anim,stop" - scrolling animation has stopped
22487 * @li "scroll,drag,start" - dragging the contents around has started
22488 * @li "scroll,drag,stop" - dragging the contents around has stopped
22490 * @ref tutorial_photocam shows the API in action.
22494 * @brief Types of zoom available.
22496 typedef enum _Elm_Photocam_Zoom_Mode
22498 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22499 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22500 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22501 ELM_PHOTOCAM_ZOOM_MODE_LAST
22502 } Elm_Photocam_Zoom_Mode;
22504 * @brief Add a new Photocam object
22506 * @param parent The parent object
22507 * @return The new object or NULL if it cannot be created
22509 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22511 * @brief Set the photo file to be shown
22513 * @param obj The photocam object
22514 * @param file The photo file
22515 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22517 * This sets (and shows) the specified file (with a relative or absolute
22518 * path) and will return a load error (same error that
22519 * evas_object_image_load_error_get() will return). The image will change and
22520 * adjust its size at this point and begin a background load process for this
22521 * photo that at some time in the future will be displayed at the full
22524 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22526 * @brief Returns the path of the current image file
22528 * @param obj The photocam object
22529 * @return Returns the path
22531 * @see elm_photocam_file_set()
22533 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22535 * @brief Set the zoom level of the photo
22537 * @param obj The photocam object
22538 * @param zoom The zoom level to set
22540 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22541 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22542 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22543 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22546 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22548 * @brief Get the zoom level of the photo
22550 * @param obj The photocam object
22551 * @return The current zoom level
22553 * This returns the current zoom level of the photocam object. Note that if
22554 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22555 * (which is the default), the zoom level may be changed at any time by the
22556 * photocam object itself to account for photo size and photocam viewpoer
22559 * @see elm_photocam_zoom_set()
22560 * @see elm_photocam_zoom_mode_set()
22562 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22564 * @brief Set the zoom mode
22566 * @param obj The photocam object
22567 * @param mode The desired mode
22569 * This sets the zoom mode to manual or one of several automatic levels.
22570 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22571 * elm_photocam_zoom_set() and will stay at that level until changed by code
22572 * or until zoom mode is changed. This is the default mode. The Automatic
22573 * modes will allow the photocam object to automatically adjust zoom mode
22574 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22575 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22576 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22577 * pixels within the frame are left unfilled.
22579 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22581 * @brief Get the zoom mode
22583 * @param obj The photocam object
22584 * @return The current zoom mode
22586 * This gets the current zoom mode of the photocam object.
22588 * @see elm_photocam_zoom_mode_set()
22590 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22592 * @brief Get the current image pixel width and height
22594 * @param obj The photocam object
22595 * @param w A pointer to the width return
22596 * @param h A pointer to the height return
22598 * This gets the current photo pixel width and height (for the original).
22599 * The size will be returned in the integers @p w and @p h that are pointed
22602 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22604 * @brief Get the area of the image that is currently shown
22607 * @param x A pointer to the X-coordinate of region
22608 * @param y A pointer to the Y-coordinate of region
22609 * @param w A pointer to the width
22610 * @param h A pointer to the height
22612 * @see elm_photocam_image_region_show()
22613 * @see elm_photocam_image_region_bring_in()
22615 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22617 * @brief Set the viewed portion of the image
22619 * @param obj The photocam object
22620 * @param x X-coordinate of region in image original pixels
22621 * @param y Y-coordinate of region in image original pixels
22622 * @param w Width of region in image original pixels
22623 * @param h Height of region in image original pixels
22625 * This shows the region of the image without using animation.
22627 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22629 * @brief Bring in the viewed portion of the image
22631 * @param obj The photocam object
22632 * @param x X-coordinate of region in image original pixels
22633 * @param y Y-coordinate of region in image original pixels
22634 * @param w Width of region in image original pixels
22635 * @param h Height of region in image original pixels
22637 * This shows the region of the image using animation.
22639 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22641 * @brief Set the paused state for photocam
22643 * @param obj The photocam object
22644 * @param paused The pause state to set
22646 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22647 * photocam. The default is off. This will stop zooming using animation on
22648 * zoom levels changes and change instantly. This will stop any existing
22649 * animations that are running.
22651 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22653 * @brief Get the paused state for photocam
22655 * @param obj The photocam object
22656 * @return The current paused state
22658 * This gets the current paused state for the photocam object.
22660 * @see elm_photocam_paused_set()
22662 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22664 * @brief Get the internal low-res image used for photocam
22666 * @param obj The photocam object
22667 * @return The internal image object handle, or NULL if none exists
22669 * This gets the internal image object inside photocam. Do not modify it. It
22670 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22671 * deleted at any time as well.
22673 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22675 * @brief Set the photocam scrolling bouncing.
22677 * @param obj The photocam object
22678 * @param h_bounce bouncing for horizontal
22679 * @param v_bounce bouncing for vertical
22681 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22683 * @brief Get the photocam scrolling bouncing.
22685 * @param obj The photocam object
22686 * @param h_bounce bouncing for horizontal
22687 * @param v_bounce bouncing for vertical
22689 * @see elm_photocam_bounce_set()
22691 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22697 * @defgroup Map Map
22698 * @ingroup Elementary
22700 * @image html img/widget/map/preview-00.png
22701 * @image latex img/widget/map/preview-00.eps
22703 * This is a widget specifically for displaying a map. It uses basically
22704 * OpenStreetMap provider http://www.openstreetmap.org/,
22705 * but custom providers can be added.
22707 * It supports some basic but yet nice features:
22708 * @li zoom and scroll
22709 * @li markers with content to be displayed when user clicks over it
22710 * @li group of markers
22713 * Smart callbacks one can listen to:
22715 * - "clicked" - This is called when a user has clicked the map without
22717 * - "press" - This is called when a user has pressed down on the map.
22718 * - "longpressed" - This is called when a user has pressed down on the map
22719 * for a long time without dragging around.
22720 * - "clicked,double" - This is called when a user has double-clicked
22722 * - "load,detail" - Map detailed data load begins.
22723 * - "loaded,detail" - This is called when all currently visible parts of
22724 * the map are loaded.
22725 * - "zoom,start" - Zoom animation started.
22726 * - "zoom,stop" - Zoom animation stopped.
22727 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22728 * - "scroll" - the content has been scrolled (moved).
22729 * - "scroll,anim,start" - scrolling animation has started.
22730 * - "scroll,anim,stop" - scrolling animation has stopped.
22731 * - "scroll,drag,start" - dragging the contents around has started.
22732 * - "scroll,drag,stop" - dragging the contents around has stopped.
22733 * - "downloaded" - This is called when all currently required map images
22735 * - "route,load" - This is called when route request begins.
22736 * - "route,loaded" - This is called when route request ends.
22737 * - "name,load" - This is called when name request begins.
22738 * - "name,loaded- This is called when name request ends.
22740 * Available style for map widget:
22743 * Available style for markers:
22748 * Available style for marker bubble:
22751 * List of examples:
22752 * @li @ref map_example_01
22753 * @li @ref map_example_02
22754 * @li @ref map_example_03
22763 * @enum _Elm_Map_Zoom_Mode
22764 * @typedef Elm_Map_Zoom_Mode
22766 * Set map's zoom behavior. It can be set to manual or automatic.
22768 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22770 * Values <b> don't </b> work as bitmask, only one can be choosen.
22772 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22773 * than the scroller view.
22775 * @see elm_map_zoom_mode_set()
22776 * @see elm_map_zoom_mode_get()
22780 typedef enum _Elm_Map_Zoom_Mode
22782 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22783 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22784 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22785 ELM_MAP_ZOOM_MODE_LAST
22786 } Elm_Map_Zoom_Mode;
22789 * @enum _Elm_Map_Route_Sources
22790 * @typedef Elm_Map_Route_Sources
22792 * Set route service to be used. By default used source is
22793 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22795 * @see elm_map_route_source_set()
22796 * @see elm_map_route_source_get()
22800 typedef enum _Elm_Map_Route_Sources
22802 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22803 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. */
22804 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22805 ELM_MAP_ROUTE_SOURCE_LAST
22806 } Elm_Map_Route_Sources;
22808 typedef enum _Elm_Map_Name_Sources
22810 ELM_MAP_NAME_SOURCE_NOMINATIM,
22811 ELM_MAP_NAME_SOURCE_LAST
22812 } Elm_Map_Name_Sources;
22815 * @enum _Elm_Map_Route_Type
22816 * @typedef Elm_Map_Route_Type
22818 * Set type of transport used on route.
22820 * @see elm_map_route_add()
22824 typedef enum _Elm_Map_Route_Type
22826 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22827 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22828 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22829 ELM_MAP_ROUTE_TYPE_LAST
22830 } Elm_Map_Route_Type;
22833 * @enum _Elm_Map_Route_Method
22834 * @typedef Elm_Map_Route_Method
22836 * Set the routing method, what should be priorized, time or distance.
22838 * @see elm_map_route_add()
22842 typedef enum _Elm_Map_Route_Method
22844 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22845 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22846 ELM_MAP_ROUTE_METHOD_LAST
22847 } Elm_Map_Route_Method;
22849 typedef enum _Elm_Map_Name_Method
22851 ELM_MAP_NAME_METHOD_SEARCH,
22852 ELM_MAP_NAME_METHOD_REVERSE,
22853 ELM_MAP_NAME_METHOD_LAST
22854 } Elm_Map_Name_Method;
22856 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(). */
22857 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(). */
22858 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(). */
22859 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(). */
22860 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22861 typedef struct _Elm_Map_Track Elm_Map_Track;
22863 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. */
22864 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22865 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22866 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22868 typedef char *(*ElmMapModuleSourceFunc) (void);
22869 typedef int (*ElmMapModuleZoomMinFunc) (void);
22870 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22871 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22872 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22873 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22874 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22875 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22876 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22879 * Add a new map widget to the given parent Elementary (container) object.
22881 * @param parent The parent object.
22882 * @return a new map widget handle or @c NULL, on errors.
22884 * This function inserts a new map widget on the canvas.
22888 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22891 * Set the zoom level of the map.
22893 * @param obj The map object.
22894 * @param zoom The zoom level to set.
22896 * This sets the zoom level.
22898 * It will respect limits defined by elm_map_source_zoom_min_set() and
22899 * elm_map_source_zoom_max_set().
22901 * By default these values are 0 (world map) and 18 (maximum zoom).
22903 * This function should be used when zoom mode is set to
22904 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22905 * with elm_map_zoom_mode_set().
22907 * @see elm_map_zoom_mode_set().
22908 * @see elm_map_zoom_get().
22912 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22915 * Get the zoom level of the map.
22917 * @param obj The map object.
22918 * @return The current zoom level.
22920 * This returns the current zoom level of the map object.
22922 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22923 * (which is the default), the zoom level may be changed at any time by the
22924 * map object itself to account for map size and map viewport size.
22926 * @see elm_map_zoom_set() for details.
22930 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22933 * Set the zoom mode used by the map object.
22935 * @param obj The map object.
22936 * @param mode The zoom mode of the map, being it one of
22937 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22938 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22940 * This sets the zoom mode to manual or one of the automatic levels.
22941 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22942 * elm_map_zoom_set() and will stay at that level until changed by code
22943 * or until zoom mode is changed. This is the default mode.
22945 * The Automatic modes will allow the map object to automatically
22946 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22947 * adjust zoom so the map fits inside the scroll frame with no pixels
22948 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22949 * ensure no pixels within the frame are left unfilled. Do not forget that
22950 * the valid sizes are 2^zoom, consequently the map may be smaller than
22951 * the scroller view.
22953 * @see elm_map_zoom_set()
22957 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22960 * Get the zoom mode used by the map object.
22962 * @param obj The map object.
22963 * @return The zoom mode of the map, being it one of
22964 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22965 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22967 * This function returns the current zoom mode used by the map object.
22969 * @see elm_map_zoom_mode_set() for more details.
22973 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22976 * Get the current coordinates of the map.
22978 * @param obj The map object.
22979 * @param lon Pointer where to store longitude.
22980 * @param lat Pointer where to store latitude.
22982 * This gets the current center coordinates of the map object. It can be
22983 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22985 * @see elm_map_geo_region_bring_in()
22986 * @see elm_map_geo_region_show()
22990 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22993 * Animatedly bring in given coordinates to the center of the map.
22995 * @param obj The map object.
22996 * @param lon Longitude to center at.
22997 * @param lat Latitude to center at.
22999 * This causes map to jump to the given @p lat and @p lon coordinates
23000 * and show it (by scrolling) in the center of the viewport, if it is not
23001 * already centered. This will use animation to do so and take a period
23002 * of time to complete.
23004 * @see elm_map_geo_region_show() for a function to avoid animation.
23005 * @see elm_map_geo_region_get()
23009 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23012 * Show the given coordinates at the center of the map, @b immediately.
23014 * @param obj The map object.
23015 * @param lon Longitude to center at.
23016 * @param lat Latitude to center at.
23018 * This causes map to @b redraw its viewport's contents to the
23019 * region contining the given @p lat and @p lon, that will be moved to the
23020 * center of the map.
23022 * @see elm_map_geo_region_bring_in() for a function to move with animation.
23023 * @see elm_map_geo_region_get()
23027 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23030 * Pause or unpause the map.
23032 * @param obj The map object.
23033 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23036 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23039 * The default is off.
23041 * This will stop zooming using animation, changing zoom levels will
23042 * change instantly. This will stop any existing animations that are running.
23044 * @see elm_map_paused_get()
23048 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23051 * Get a value whether map is paused or not.
23053 * @param obj The map object.
23054 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23055 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23057 * This gets the current paused state for the map object.
23059 * @see elm_map_paused_set() for details.
23063 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23066 * Set to show markers during zoom level changes or not.
23068 * @param obj The map object.
23069 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23072 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23075 * The default is off.
23077 * This will stop zooming using animation, changing zoom levels will
23078 * change instantly. This will stop any existing animations that are running.
23080 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23083 * The default is off.
23085 * Enabling it will force the map to stop displaying the markers during
23086 * zoom level changes. Set to on if you have a large number of markers.
23088 * @see elm_map_paused_markers_get()
23092 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23095 * Get a value whether markers will be displayed on zoom level changes or not
23097 * @param obj The map object.
23098 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23099 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23101 * This gets the current markers paused state for the map object.
23103 * @see elm_map_paused_markers_set() for details.
23107 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23110 * Get the information of downloading status.
23112 * @param obj The map object.
23113 * @param try_num Pointer where to store number of tiles being downloaded.
23114 * @param finish_num Pointer where to store number of tiles successfully
23117 * This gets the current downloading status for the map object, the number
23118 * of tiles being downloaded and the number of tiles already downloaded.
23122 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23125 * Convert a pixel coordinate (x,y) into a geographic coordinate
23126 * (longitude, latitude).
23128 * @param obj The map object.
23129 * @param x the coordinate.
23130 * @param y the coordinate.
23131 * @param size the size in pixels of the map.
23132 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23133 * @param lon Pointer where to store the longitude that correspond to x.
23134 * @param lat Pointer where to store the latitude that correspond to y.
23136 * @note Origin pixel point is the top left corner of the viewport.
23137 * Map zoom and size are taken on account.
23139 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23143 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);
23146 * Convert a geographic coordinate (longitude, latitude) into a pixel
23147 * coordinate (x, y).
23149 * @param obj The map object.
23150 * @param lon the longitude.
23151 * @param lat the latitude.
23152 * @param size the size in pixels of the map. The map is a square
23153 * and generally his size is : pow(2.0, zoom)*256.
23154 * @param x Pointer where to store the horizontal pixel coordinate that
23155 * correspond to the longitude.
23156 * @param y Pointer where to store the vertical pixel coordinate that
23157 * correspond to the latitude.
23159 * @note Origin pixel point is the top left corner of the viewport.
23160 * Map zoom and size are taken on account.
23162 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23166 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);
23169 * Convert a geographic coordinate (longitude, latitude) into a name
23172 * @param obj The map object.
23173 * @param lon the longitude.
23174 * @param lat the latitude.
23175 * @return name A #Elm_Map_Name handle for this coordinate.
23177 * To get the string for this address, elm_map_name_address_get()
23180 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23184 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23187 * Convert a name (address) into a geographic coordinate
23188 * (longitude, latitude).
23190 * @param obj The map object.
23191 * @param name The address.
23192 * @return name A #Elm_Map_Name handle for this address.
23194 * To get the longitude and latitude, elm_map_name_region_get()
23197 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23201 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23204 * Convert a pixel coordinate into a rotated pixel coordinate.
23206 * @param obj The map object.
23207 * @param x horizontal coordinate of the point to rotate.
23208 * @param y vertical coordinate of the point to rotate.
23209 * @param cx rotation's center horizontal position.
23210 * @param cy rotation's center vertical position.
23211 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23212 * @param xx Pointer where to store rotated x.
23213 * @param yy Pointer where to store rotated y.
23217 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);
23220 * Add a new marker to the map object.
23222 * @param obj The map object.
23223 * @param lon The longitude of the marker.
23224 * @param lat The latitude of the marker.
23225 * @param clas The class, to use when marker @b isn't grouped to others.
23226 * @param clas_group The class group, to use when marker is grouped to others
23227 * @param data The data passed to the callbacks.
23229 * @return The created marker or @c NULL upon failure.
23231 * A marker will be created and shown in a specific point of the map, defined
23232 * by @p lon and @p lat.
23234 * It will be displayed using style defined by @p class when this marker
23235 * is displayed alone (not grouped). A new class can be created with
23236 * elm_map_marker_class_new().
23238 * If the marker is grouped to other markers, it will be displayed with
23239 * style defined by @p class_group. Markers with the same group are grouped
23240 * if they are close. A new group class can be created with
23241 * elm_map_marker_group_class_new().
23243 * Markers created with this method can be deleted with
23244 * elm_map_marker_remove().
23246 * A marker can have associated content to be displayed by a bubble,
23247 * when a user click over it, as well as an icon. These objects will
23248 * be fetch using class' callback functions.
23250 * @see elm_map_marker_class_new()
23251 * @see elm_map_marker_group_class_new()
23252 * @see elm_map_marker_remove()
23256 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);
23259 * Set the maximum numbers of markers' content to be displayed in a group.
23261 * @param obj The map object.
23262 * @param max The maximum numbers of items displayed in a bubble.
23264 * A bubble will be displayed when the user clicks over the group,
23265 * and will place the content of markers that belong to this group
23268 * A group can have a long list of markers, consequently the creation
23269 * of the content of the bubble can be very slow.
23271 * In order to avoid this, a maximum number of items is displayed
23274 * By default this number is 30.
23276 * Marker with the same group class are grouped if they are close.
23278 * @see elm_map_marker_add()
23282 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23285 * Remove a marker from the map.
23287 * @param marker The marker to remove.
23289 * @see elm_map_marker_add()
23293 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23296 * Get the current coordinates of the marker.
23298 * @param marker marker.
23299 * @param lat Pointer where to store the marker's latitude.
23300 * @param lon Pointer where to store the marker's longitude.
23302 * These values are set when adding markers, with function
23303 * elm_map_marker_add().
23305 * @see elm_map_marker_add()
23309 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23312 * Animatedly bring in given marker to the center of the map.
23314 * @param marker The marker to center at.
23316 * This causes map to jump to the given @p marker's coordinates
23317 * and show it (by scrolling) in the center of the viewport, if it is not
23318 * already centered. This will use animation to do so and take a period
23319 * of time to complete.
23321 * @see elm_map_marker_show() for a function to avoid animation.
23322 * @see elm_map_marker_region_get()
23326 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23329 * Show the given marker at the center of the map, @b immediately.
23331 * @param marker The marker to center at.
23333 * This causes map to @b redraw its viewport's contents to the
23334 * region contining the given @p marker's coordinates, that will be
23335 * moved to the center of the map.
23337 * @see elm_map_marker_bring_in() for a function to move with animation.
23338 * @see elm_map_markers_list_show() if more than one marker need to be
23340 * @see elm_map_marker_region_get()
23344 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23347 * Move and zoom the map to display a list of markers.
23349 * @param markers A list of #Elm_Map_Marker handles.
23351 * The map will be centered on the center point of the markers in the list.
23352 * Then the map will be zoomed in order to fit the markers using the maximum
23353 * zoom which allows display of all the markers.
23355 * @warning All the markers should belong to the same map object.
23357 * @see elm_map_marker_show() to show a single marker.
23358 * @see elm_map_marker_bring_in()
23362 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23365 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23367 * @param marker The marker wich content should be returned.
23368 * @return Return the evas object if it exists, else @c NULL.
23370 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23371 * elm_map_marker_class_get_cb_set() should be used.
23373 * This content is what will be inside the bubble that will be displayed
23374 * when an user clicks over the marker.
23376 * This returns the actual Evas object used to be placed inside
23377 * the bubble. This may be @c NULL, as it may
23378 * not have been created or may have been deleted, at any time, by
23379 * the map. <b>Do not modify this object</b> (move, resize,
23380 * show, hide, etc.), as the map is controlling it. This
23381 * function is for querying, emitting custom signals or hooking
23382 * lower level callbacks for events on that object. Do not delete
23383 * this object under any circumstances.
23387 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23390 * Update the marker
23392 * @param marker The marker to be updated.
23394 * If a content is set to this marker, it will call function to delete it,
23395 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23396 * #ElmMapMarkerGetFunc.
23398 * These functions are set for the marker class with
23399 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23403 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23406 * Close all the bubbles opened by the user.
23408 * @param obj The map object.
23410 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23411 * when the user clicks on a marker.
23413 * This functions is set for the marker class with
23414 * elm_map_marker_class_get_cb_set().
23418 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23421 * Create a new group class.
23423 * @param obj The map object.
23424 * @return Returns the new group class.
23426 * Each marker must be associated to a group class. Markers in the same
23427 * group are grouped if they are close.
23429 * The group class defines the style of the marker when a marker is grouped
23430 * to others markers. When it is alone, another class will be used.
23432 * A group class will need to be provided when creating a marker with
23433 * elm_map_marker_add().
23435 * Some properties and functions can be set by class, as:
23436 * - style, with elm_map_group_class_style_set()
23437 * - data - to be associated to the group class. It can be set using
23438 * elm_map_group_class_data_set().
23439 * - min zoom to display markers, set with
23440 * elm_map_group_class_zoom_displayed_set().
23441 * - max zoom to group markers, set using
23442 * elm_map_group_class_zoom_grouped_set().
23443 * - visibility - set if markers will be visible or not, set with
23444 * elm_map_group_class_hide_set().
23445 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23446 * It can be set using elm_map_group_class_icon_cb_set().
23448 * @see elm_map_marker_add()
23449 * @see elm_map_group_class_style_set()
23450 * @see elm_map_group_class_data_set()
23451 * @see elm_map_group_class_zoom_displayed_set()
23452 * @see elm_map_group_class_zoom_grouped_set()
23453 * @see elm_map_group_class_hide_set()
23454 * @see elm_map_group_class_icon_cb_set()
23458 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23461 * Set the marker's style of a group class.
23463 * @param clas The group class.
23464 * @param style The style to be used by markers.
23466 * Each marker must be associated to a group class, and will use the style
23467 * defined by such class when grouped to other markers.
23469 * The following styles are provided by default theme:
23470 * @li @c radio - blue circle
23471 * @li @c radio2 - green circle
23474 * @see elm_map_group_class_new() for more details.
23475 * @see elm_map_marker_add()
23479 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23482 * Set the icon callback function of a group class.
23484 * @param clas The group class.
23485 * @param icon_get The callback function that will return the icon.
23487 * Each marker must be associated to a group class, and it can display a
23488 * custom icon. The function @p icon_get must return this icon.
23490 * @see elm_map_group_class_new() for more details.
23491 * @see elm_map_marker_add()
23495 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23498 * Set the data associated to the group class.
23500 * @param clas The group class.
23501 * @param data The new user data.
23503 * This data will be passed for callback functions, like icon get callback,
23504 * that can be set with elm_map_group_class_icon_cb_set().
23506 * If a data was previously set, the object will lose the pointer for it,
23507 * so if needs to be freed, you must do it yourself.
23509 * @see elm_map_group_class_new() for more details.
23510 * @see elm_map_group_class_icon_cb_set()
23511 * @see elm_map_marker_add()
23515 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23518 * Set the minimum zoom from where the markers are displayed.
23520 * @param clas The group class.
23521 * @param zoom The minimum zoom.
23523 * Markers only will be displayed when the map is displayed at @p zoom
23526 * @see elm_map_group_class_new() for more details.
23527 * @see elm_map_marker_add()
23531 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23534 * Set the zoom from where the markers are no more grouped.
23536 * @param clas The group class.
23537 * @param zoom The maximum zoom.
23539 * Markers only will be grouped when the map is displayed at
23540 * less than @p zoom.
23542 * @see elm_map_group_class_new() for more details.
23543 * @see elm_map_marker_add()
23547 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23550 * Set if the markers associated to the group class @clas are hidden or not.
23552 * @param clas The group class.
23553 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23556 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23561 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23564 * Create a new marker class.
23566 * @param obj The map object.
23567 * @return Returns the new group class.
23569 * Each marker must be associated to a class.
23571 * The marker class defines the style of the marker when a marker is
23572 * displayed alone, i.e., not grouped to to others markers. When grouped
23573 * it will use group class style.
23575 * A marker class will need to be provided when creating a marker with
23576 * elm_map_marker_add().
23578 * Some properties and functions can be set by class, as:
23579 * - style, with elm_map_marker_class_style_set()
23580 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23581 * It can be set using elm_map_marker_class_icon_cb_set().
23582 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23583 * Set using elm_map_marker_class_get_cb_set().
23584 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23585 * Set using elm_map_marker_class_del_cb_set().
23587 * @see elm_map_marker_add()
23588 * @see elm_map_marker_class_style_set()
23589 * @see elm_map_marker_class_icon_cb_set()
23590 * @see elm_map_marker_class_get_cb_set()
23591 * @see elm_map_marker_class_del_cb_set()
23595 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23598 * Set the marker's style of a marker class.
23600 * @param clas The marker class.
23601 * @param style The style to be used by markers.
23603 * Each marker must be associated to a marker class, and will use the style
23604 * defined by such class when alone, i.e., @b not grouped to other markers.
23606 * The following styles are provided by default theme:
23611 * @see elm_map_marker_class_new() for more details.
23612 * @see elm_map_marker_add()
23616 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23619 * Set the icon callback function of a marker class.
23621 * @param clas The marker class.
23622 * @param icon_get The callback function that will return the icon.
23624 * Each marker must be associated to a marker class, and it can display a
23625 * custom icon. The function @p icon_get must return this icon.
23627 * @see elm_map_marker_class_new() for more details.
23628 * @see elm_map_marker_add()
23632 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23635 * Set the bubble content callback function of a marker class.
23637 * @param clas The marker class.
23638 * @param get The callback function that will return the content.
23640 * Each marker must be associated to a marker class, and it can display a
23641 * a content on a bubble that opens when the user click over the marker.
23642 * The function @p get must return this content object.
23644 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23647 * @see elm_map_marker_class_new() for more details.
23648 * @see elm_map_marker_class_del_cb_set()
23649 * @see elm_map_marker_add()
23653 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23656 * Set the callback function used to delete bubble content of a marker class.
23658 * @param clas The marker class.
23659 * @param del The callback function that will delete the content.
23661 * Each marker must be associated to a marker class, and it can display a
23662 * a content on a bubble that opens when the user click over the marker.
23663 * The function to return such content can be set with
23664 * elm_map_marker_class_get_cb_set().
23666 * If this content must be freed, a callback function need to be
23667 * set for that task with this function.
23669 * If this callback is defined it will have to delete (or not) the
23670 * object inside, but if the callback is not defined the object will be
23671 * destroyed with evas_object_del().
23673 * @see elm_map_marker_class_new() for more details.
23674 * @see elm_map_marker_class_get_cb_set()
23675 * @see elm_map_marker_add()
23679 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23682 * Get the list of available sources.
23684 * @param obj The map object.
23685 * @return The source names list.
23687 * It will provide a list with all available sources, that can be set as
23688 * current source with elm_map_source_name_set(), or get with
23689 * elm_map_source_name_get().
23691 * Available sources:
23697 * @see elm_map_source_name_set() for more details.
23698 * @see elm_map_source_name_get()
23702 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23705 * Set the source of the map.
23707 * @param obj The map object.
23708 * @param source The source to be used.
23710 * Map widget retrieves images that composes the map from a web service.
23711 * This web service can be set with this method.
23713 * A different service can return a different maps with different
23714 * information and it can use different zoom values.
23716 * The @p source_name need to match one of the names provided by
23717 * elm_map_source_names_get().
23719 * The current source can be get using elm_map_source_name_get().
23721 * @see elm_map_source_names_get()
23722 * @see elm_map_source_name_get()
23727 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23730 * Get the name of currently used source.
23732 * @param obj The map object.
23733 * @return Returns the name of the source in use.
23735 * @see elm_map_source_name_set() for more details.
23739 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23742 * Set the source of the route service to be used by the map.
23744 * @param obj The map object.
23745 * @param source The route service to be used, being it one of
23746 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23747 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23749 * Each one has its own algorithm, so the route retrieved may
23750 * differ depending on the source route. Now, only the default is working.
23752 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23753 * http://www.yournavigation.org/.
23755 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23756 * assumptions. Its routing core is based on Contraction Hierarchies.
23758 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23760 * @see elm_map_route_source_get().
23764 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23767 * Get the current route source.
23769 * @param obj The map object.
23770 * @return The source of the route service used by the map.
23772 * @see elm_map_route_source_set() for details.
23776 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23779 * Set the minimum zoom of the source.
23781 * @param obj The map object.
23782 * @param zoom New minimum zoom value to be used.
23784 * By default, it's 0.
23788 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23791 * Get the minimum zoom of the source.
23793 * @param obj The map object.
23794 * @return Returns the minimum zoom of the source.
23796 * @see elm_map_source_zoom_min_set() for details.
23800 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23803 * Set the maximum zoom of the source.
23805 * @param obj The map object.
23806 * @param zoom New maximum zoom value to be used.
23808 * By default, it's 18.
23812 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23815 * Get the maximum zoom of the source.
23817 * @param obj The map object.
23818 * @return Returns the maximum zoom of the source.
23820 * @see elm_map_source_zoom_min_set() for details.
23824 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23827 * Set the user agent used by the map object to access routing services.
23829 * @param obj The map object.
23830 * @param user_agent The user agent to be used by the map.
23832 * User agent is a client application implementing a network protocol used
23833 * in communications within a clientāserver distributed computing system
23835 * The @p user_agent identification string will transmitted in a header
23836 * field @c User-Agent.
23838 * @see elm_map_user_agent_get()
23842 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23845 * Get the user agent used by the map object.
23847 * @param obj The map object.
23848 * @return The user agent identification string used by the map.
23850 * @see elm_map_user_agent_set() for details.
23854 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23857 * Add a new route to the map object.
23859 * @param obj The map object.
23860 * @param type The type of transport to be considered when tracing a route.
23861 * @param method The routing method, what should be priorized.
23862 * @param flon The start longitude.
23863 * @param flat The start latitude.
23864 * @param tlon The destination longitude.
23865 * @param tlat The destination latitude.
23867 * @return The created route or @c NULL upon failure.
23869 * A route will be traced by point on coordinates (@p flat, @p flon)
23870 * to point on coordinates (@p tlat, @p tlon), using the route service
23871 * set with elm_map_route_source_set().
23873 * It will take @p type on consideration to define the route,
23874 * depending if the user will be walking or driving, the route may vary.
23875 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23876 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23878 * Another parameter is what the route should priorize, the minor distance
23879 * or the less time to be spend on the route. So @p method should be one
23880 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23882 * Routes created with this method can be deleted with
23883 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23884 * and distance can be get with elm_map_route_distance_get().
23886 * @see elm_map_route_remove()
23887 * @see elm_map_route_color_set()
23888 * @see elm_map_route_distance_get()
23889 * @see elm_map_route_source_set()
23893 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);
23896 * Remove a route from the map.
23898 * @param route The route to remove.
23900 * @see elm_map_route_add()
23904 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23907 * Set the route color.
23909 * @param route The route object.
23910 * @param r Red channel value, from 0 to 255.
23911 * @param g Green channel value, from 0 to 255.
23912 * @param b Blue channel value, from 0 to 255.
23913 * @param a Alpha channel value, from 0 to 255.
23915 * It uses an additive color model, so each color channel represents
23916 * how much of each primary colors must to be used. 0 represents
23917 * ausence of this color, so if all of the three are set to 0,
23918 * the color will be black.
23920 * These component values should be integers in the range 0 to 255,
23921 * (single 8-bit byte).
23923 * This sets the color used for the route. By default, it is set to
23924 * solid red (r = 255, g = 0, b = 0, a = 255).
23926 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23928 * @see elm_map_route_color_get()
23932 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23935 * Get the route color.
23937 * @param route The route object.
23938 * @param r Pointer where to store the red channel value.
23939 * @param g Pointer where to store the green channel value.
23940 * @param b Pointer where to store the blue channel value.
23941 * @param a Pointer where to store the alpha channel value.
23943 * @see elm_map_route_color_set() for details.
23947 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23950 * Get the route distance in kilometers.
23952 * @param route The route object.
23953 * @return The distance of route (unit : km).
23957 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23960 * Get the information of route nodes.
23962 * @param route The route object.
23963 * @return Returns a string with the nodes of route.
23967 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23970 * Get the information of route waypoint.
23972 * @param route the route object.
23973 * @return Returns a string with information about waypoint of route.
23977 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23980 * Get the address of the name.
23982 * @param name The name handle.
23983 * @return Returns the address string of @p name.
23985 * This gets the coordinates of the @p name, created with one of the
23986 * conversion functions.
23988 * @see elm_map_utils_convert_name_into_coord()
23989 * @see elm_map_utils_convert_coord_into_name()
23993 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23996 * Get the current coordinates of the name.
23998 * @param name The name handle.
23999 * @param lat Pointer where to store the latitude.
24000 * @param lon Pointer where to store The longitude.
24002 * This gets the coordinates of the @p name, created with one of the
24003 * conversion functions.
24005 * @see elm_map_utils_convert_name_into_coord()
24006 * @see elm_map_utils_convert_coord_into_name()
24010 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24013 * Remove a name from the map.
24015 * @param name The name to remove.
24017 * Basically the struct handled by @p name will be freed, so convertions
24018 * between address and coordinates will be lost.
24020 * @see elm_map_utils_convert_name_into_coord()
24021 * @see elm_map_utils_convert_coord_into_name()
24025 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24030 * @param obj The map object.
24031 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24032 * @param cx Rotation's center horizontal position.
24033 * @param cy Rotation's center vertical position.
24035 * @see elm_map_rotate_get()
24039 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24042 * Get the rotate degree of the map
24044 * @param obj The map object
24045 * @param degree Pointer where to store degrees from 0.0 to 360.0
24046 * to rotate arount Z axis.
24047 * @param cx Pointer where to store rotation's center horizontal position.
24048 * @param cy Pointer where to store rotation's center vertical position.
24050 * @see elm_map_rotate_set() to set map rotation.
24054 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);
24057 * Enable or disable mouse wheel to be used to zoom in / out the map.
24059 * @param obj The map object.
24060 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24063 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24065 * It's disabled by default.
24067 * @see elm_map_wheel_disabled_get()
24071 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24074 * Get a value whether mouse wheel is enabled or not.
24076 * @param obj The map object.
24077 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24078 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24080 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24082 * @see elm_map_wheel_disabled_set() for details.
24086 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24090 * Add a track on the map
24092 * @param obj The map object.
24093 * @param emap The emap route object.
24094 * @return The route object. This is an elm object of type Route.
24096 * @see elm_route_add() for details.
24100 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24104 * Remove a track from the map
24106 * @param obj The map object.
24107 * @param route The track to remove.
24111 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24118 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24120 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24122 EAPI double elm_route_lon_min_get(Evas_Object *obj);
24123 EAPI double elm_route_lat_min_get(Evas_Object *obj);
24124 EAPI double elm_route_lon_max_get(Evas_Object *obj);
24125 EAPI double elm_route_lat_max_get(Evas_Object *obj);
24129 * @defgroup Panel Panel
24131 * @image html img/widget/panel/preview-00.png
24132 * @image latex img/widget/panel/preview-00.eps
24134 * @brief A panel is a type of animated container that contains subobjects.
24135 * It can be expanded or contracted by clicking the button on it's edge.
24137 * Orientations are as follows:
24138 * @li ELM_PANEL_ORIENT_TOP
24139 * @li ELM_PANEL_ORIENT_LEFT
24140 * @li ELM_PANEL_ORIENT_RIGHT
24142 * Default contents parts of the panel widget that you can use for are:
24143 * @li "default" - A content of the panel
24145 * @ref tutorial_panel shows one way to use this widget.
24148 typedef enum _Elm_Panel_Orient
24150 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24151 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24152 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24153 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24154 } Elm_Panel_Orient;
24156 * @brief Adds a panel object
24158 * @param parent The parent object
24160 * @return The panel object, or NULL on failure
24162 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24164 * @brief Sets the orientation of the panel
24166 * @param parent The parent object
24167 * @param orient The panel orientation. Can be one of the following:
24168 * @li ELM_PANEL_ORIENT_TOP
24169 * @li ELM_PANEL_ORIENT_LEFT
24170 * @li ELM_PANEL_ORIENT_RIGHT
24172 * Sets from where the panel will (dis)appear.
24174 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24176 * @brief Get the orientation of the panel.
24178 * @param obj The panel object
24179 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24181 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24183 * @brief Set the content of the panel.
24185 * @param obj The panel object
24186 * @param content The panel content
24188 * Once the content object is set, a previously set one will be deleted.
24189 * If you want to keep that old content object, use the
24190 * elm_panel_content_unset() function.
24192 * @deprecated use elm_object_content_set() instead
24195 WILL_DEPRECATE EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24197 * @brief Get the content of the panel.
24199 * @param obj The panel object
24200 * @return The content that is being used
24202 * Return the content object which is set for this widget.
24204 * @see elm_panel_content_set()
24206 * @deprecated use elm_object_content_get() instead
24209 WILL_DEPRECATE EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24211 * @brief Unset the content of the panel.
24213 * @param obj The panel object
24214 * @return The content that was being used
24216 * Unparent and return the content object which was set for this widget.
24218 * @see elm_panel_content_set()
24220 * @deprecated use elm_object_content_unset() instead
24223 WILL_DEPRECATE EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24225 * @brief Set the state of the panel.
24227 * @param obj The panel object
24228 * @param hidden If true, the panel will run the animation to contract
24230 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24232 * @brief Get the state of the panel.
24234 * @param obj The panel object
24235 * @param hidden If true, the panel is in the "hide" state
24237 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24239 * @brief Toggle the hidden state of the panel from code
24241 * @param obj The panel object
24243 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24249 * @defgroup Panes Panes
24250 * @ingroup Elementary
24252 * @image html img/widget/panes/preview-00.png
24253 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24255 * @image html img/panes.png
24256 * @image latex img/panes.eps width=\textwidth
24258 * The panes adds a dragable bar between two contents. When dragged
24259 * this bar will resize contents size.
24261 * Panes can be displayed vertically or horizontally, and contents
24262 * size proportion can be customized (homogeneous by default).
24264 * Smart callbacks one can listen to:
24265 * - "press" - The panes has been pressed (button wasn't released yet).
24266 * - "unpressed" - The panes was released after being pressed.
24267 * - "clicked" - The panes has been clicked>
24268 * - "clicked,double" - The panes has been double clicked
24270 * Available styles for it:
24273 * Default contents parts of the panes widget that you can use for are:
24274 * @li "left" - A leftside content of the panes
24275 * @li "right" - A rightside content of the panes
24277 * If panes is displayed vertically, left content will be displayed at
24280 * Here is an example on its usage:
24281 * @li @ref panes_example
24285 * @addtogroup Panes
24290 * Add a new panes widget to the given parent Elementary
24291 * (container) object.
24293 * @param parent The parent object.
24294 * @return a new panes widget handle or @c NULL, on errors.
24296 * This function inserts a new panes widget on the canvas.
24300 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24303 * Set the left content of the panes widget.
24305 * @param obj The panes object.
24306 * @param content The new left content object.
24308 * Once the content object is set, a previously set one will be deleted.
24309 * If you want to keep that old content object, use the
24310 * elm_panes_content_left_unset() function.
24312 * If panes is displayed vertically, left content will be displayed at
24315 * @see elm_panes_content_left_get()
24316 * @see elm_panes_content_right_set() to set content on the other side.
24318 * @deprecated use elm_object_part_content_set() instead
24322 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24325 * Set the right content of the panes widget.
24327 * @param obj The panes object.
24328 * @param content The new right content object.
24330 * Once the content object is set, a previously set one will be deleted.
24331 * If you want to keep that old content object, use the
24332 * elm_panes_content_right_unset() function.
24334 * If panes is displayed vertically, left content will be displayed at
24337 * @see elm_panes_content_right_get()
24338 * @see elm_panes_content_left_set() to set content on the other side.
24340 * @deprecated use elm_object_part_content_set() instead
24344 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24347 * Get the left content of the panes.
24349 * @param obj The panes object.
24350 * @return The left content object that is being used.
24352 * Return the left content object which is set for this widget.
24354 * @see elm_panes_content_left_set() for details.
24356 * @deprecated use elm_object_part_content_get() instead
24360 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 * Get the right content of the panes.
24365 * @param obj The panes object
24366 * @return The right content object that is being used
24368 * Return the right content object which is set for this widget.
24370 * @see elm_panes_content_right_set() for details.
24372 * @deprecated use elm_object_part_content_get() instead
24376 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24379 * Unset the left content used for the panes.
24381 * @param obj The panes object.
24382 * @return The left content object that was being used.
24384 * Unparent and return the left content object which was set for this widget.
24386 * @see elm_panes_content_left_set() for details.
24387 * @see elm_panes_content_left_get().
24389 * @deprecated use elm_object_part_content_unset() instead
24393 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24396 * Unset the right content used for the panes.
24398 * @param obj The panes object.
24399 * @return The right content object that was being used.
24401 * Unparent and return the right content object which was set for this
24404 * @see elm_panes_content_right_set() for details.
24405 * @see elm_panes_content_right_get().
24407 * @deprecated use elm_object_part_content_unset() instead
24411 WILL_DEPRECATE EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24414 * Get the size proportion of panes widget's left side.
24416 * @param obj The panes object.
24417 * @return float value between 0.0 and 1.0 representing size proportion
24420 * @see elm_panes_content_left_size_set() for more details.
24424 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24427 * Set the size proportion of panes widget's left side.
24429 * @param obj The panes object.
24430 * @param size Value between 0.0 and 1.0 representing size proportion
24433 * By default it's homogeneous, i.e., both sides have the same size.
24435 * If something different is required, it can be set with this function.
24436 * For example, if the left content should be displayed over
24437 * 75% of the panes size, @p size should be passed as @c 0.75.
24438 * This way, right content will be resized to 25% of panes size.
24440 * If displayed vertically, left content is displayed at top, and
24441 * right content at bottom.
24443 * @note This proportion will change when user drags the panes bar.
24445 * @see elm_panes_content_left_size_get()
24449 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24452 * Set the orientation of a given panes widget.
24454 * @param obj The panes object.
24455 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24456 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24458 * Use this function to change how your panes is to be
24459 * disposed: vertically or horizontally.
24461 * By default it's displayed horizontally.
24463 * @see elm_panes_horizontal_get()
24467 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24470 * Retrieve the orientation of a given panes widget.
24472 * @param obj The panes object.
24473 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24474 * @c EINA_FALSE if it's @b vertical (and on errors).
24476 * @see elm_panes_horizontal_set() for more details.
24480 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24481 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24482 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24489 * @defgroup Flip Flip
24491 * @image html img/widget/flip/preview-00.png
24492 * @image latex img/widget/flip/preview-00.eps
24494 * This widget holds 2 content objects(Evas_Object): one on the front and one
24495 * on the back. It allows you to flip from front to back and vice-versa using
24496 * various animations.
24498 * If either the front or back contents are not set the flip will treat that
24499 * as transparent. So if you wore to set the front content but not the back,
24500 * and then call elm_flip_go() you would see whatever is below the flip.
24502 * For a list of supported animations see elm_flip_go().
24504 * Signals that you can add callbacks for are:
24505 * "animate,begin" - when a flip animation was started
24506 * "animate,done" - when a flip animation is finished
24508 * @ref tutorial_flip show how to use most of the API.
24512 typedef enum _Elm_Flip_Mode
24514 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24515 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24516 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24517 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24518 ELM_FLIP_CUBE_LEFT,
24519 ELM_FLIP_CUBE_RIGHT,
24521 ELM_FLIP_CUBE_DOWN,
24522 ELM_FLIP_PAGE_LEFT,
24523 ELM_FLIP_PAGE_RIGHT,
24527 typedef enum _Elm_Flip_Interaction
24529 ELM_FLIP_INTERACTION_NONE,
24530 ELM_FLIP_INTERACTION_ROTATE,
24531 ELM_FLIP_INTERACTION_CUBE,
24532 ELM_FLIP_INTERACTION_PAGE
24533 } Elm_Flip_Interaction;
24534 typedef enum _Elm_Flip_Direction
24536 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24537 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24538 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24539 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24540 } Elm_Flip_Direction;
24542 * @brief Add a new flip to the parent
24544 * @param parent The parent object
24545 * @return The new object or NULL if it cannot be created
24547 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24549 * @brief Set the front content of the flip widget.
24551 * @param obj The flip object
24552 * @param content The new front content object
24554 * Once the content object is set, a previously set one will be deleted.
24555 * If you want to keep that old content object, use the
24556 * elm_flip_content_front_unset() function.
24558 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24560 * @brief Set the back content of the flip widget.
24562 * @param obj The flip object
24563 * @param content The new back content object
24565 * Once the content object is set, a previously set one will be deleted.
24566 * If you want to keep that old content object, use the
24567 * elm_flip_content_back_unset() function.
24569 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24571 * @brief Get the front content used for the flip
24573 * @param obj The flip object
24574 * @return The front content object that is being used
24576 * Return the front content object which is set for this widget.
24578 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24580 * @brief Get the back content used for the flip
24582 * @param obj The flip object
24583 * @return The back content object that is being used
24585 * Return the back content object which is set for this widget.
24587 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24589 * @brief Unset the front content used for the flip
24591 * @param obj The flip object
24592 * @return The front content object that was being used
24594 * Unparent and return the front content object which was set for this widget.
24596 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24598 * @brief Unset the back content used for the flip
24600 * @param obj The flip object
24601 * @return The back content object that was being used
24603 * Unparent and return the back content object which was set for this widget.
24605 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24607 * @brief Get flip front visibility state
24609 * @param obj The flip objct
24610 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24613 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24615 * @brief Set flip perspective
24617 * @param obj The flip object
24618 * @param foc The coordinate to set the focus on
24619 * @param x The X coordinate
24620 * @param y The Y coordinate
24622 * @warning This function currently does nothing.
24624 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24626 * @brief Runs the flip animation
24628 * @param obj The flip object
24629 * @param mode The mode type
24631 * Flips the front and back contents using the @p mode animation. This
24632 * efectively hides the currently visible content and shows the hidden one.
24634 * There a number of possible animations to use for the flipping:
24635 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24636 * around a horizontal axis in the middle of its height, the other content
24637 * is shown as the other side of the flip.
24638 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24639 * around a vertical axis in the middle of its width, the other content is
24640 * shown as the other side of the flip.
24641 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24642 * around a diagonal axis in the middle of its width, the other content is
24643 * shown as the other side of the flip.
24644 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24645 * around a diagonal axis in the middle of its height, the other content is
24646 * shown as the other side of the flip.
24647 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24648 * as if the flip was a cube, the other content is show as the right face of
24650 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24651 * right as if the flip was a cube, the other content is show as the left
24652 * face of the cube.
24653 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24654 * flip was a cube, the other content is show as the bottom face of the cube.
24655 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24656 * the flip was a cube, the other content is show as the upper face of the
24658 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24659 * if the flip was a book, the other content is shown as the page below that.
24660 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24661 * as if the flip was a book, the other content is shown as the page below
24663 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24664 * flip was a book, the other content is shown as the page below that.
24665 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24666 * flip was a book, the other content is shown as the page below that.
24668 * @image html elm_flip.png
24669 * @image latex elm_flip.eps width=\textwidth
24671 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24673 * @brief Set the interactive flip mode
24675 * @param obj The flip object
24676 * @param mode The interactive flip mode to use
24678 * This sets if the flip should be interactive (allow user to click and
24679 * drag a side of the flip to reveal the back page and cause it to flip).
24680 * By default a flip is not interactive. You may also need to set which
24681 * sides of the flip are "active" for flipping and how much space they use
24682 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24683 * and elm_flip_interacton_direction_hitsize_set()
24685 * The four avilable mode of interaction are:
24686 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24687 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24688 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24689 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24691 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24692 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24693 * happen, those can only be acheived with elm_flip_go();
24695 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24697 * @brief Get the interactive flip mode
24699 * @param obj The flip object
24700 * @return The interactive flip mode
24702 * Returns the interactive flip mode set by elm_flip_interaction_set()
24704 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24706 * @brief Set which directions of the flip respond to interactive flip
24708 * @param obj The flip object
24709 * @param dir The direction to change
24710 * @param enabled If that direction is enabled or not
24712 * By default all directions are disabled, so you may want to enable the
24713 * desired directions for flipping if you need interactive flipping. You must
24714 * call this function once for each direction that should be enabled.
24716 * @see elm_flip_interaction_set()
24718 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24720 * @brief Get the enabled state of that flip direction
24722 * @param obj The flip object
24723 * @param dir The direction to check
24724 * @return If that direction is enabled or not
24726 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24728 * @see elm_flip_interaction_set()
24730 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24732 * @brief Set the amount of the flip that is sensitive to interactive flip
24734 * @param obj The flip object
24735 * @param dir The direction to modify
24736 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24738 * Set the amount of the flip that is sensitive to interactive flip, with 0
24739 * representing no area in the flip and 1 representing the entire flip. There
24740 * is however a consideration to be made in that the area will never be
24741 * smaller than the finger size set(as set in your Elementary configuration).
24743 * @see elm_flip_interaction_set()
24745 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24747 * @brief Get the amount of the flip that is sensitive to interactive flip
24749 * @param obj The flip object
24750 * @param dir The direction to check
24751 * @return The size set for that direction
24753 * Returns the amount os sensitive area set by
24754 * elm_flip_interacton_direction_hitsize_set().
24756 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24761 /* scrolledentry */
24762 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24763 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24764 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24765 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24766 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24767 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24768 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24769 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24770 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24772 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24773 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24774 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24775 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24776 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24777 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24778 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24779 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24780 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24781 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24782 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24783 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24784 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24785 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24786 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24787 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24788 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24789 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24790 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24791 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24792 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24793 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24794 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24795 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24796 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24797 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);
24798 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24799 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24800 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);
24801 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24802 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);
24803 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24804 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24805 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24806 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24807 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24808 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24809 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24810 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24811 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);
24812 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);
24813 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);
24814 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);
24815 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);
24816 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);
24817 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24818 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24819 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24820 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24821 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24822 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24823 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24824 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24825 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24826 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24827 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24828 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24829 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24832 * @defgroup Conformant Conformant
24833 * @ingroup Elementary
24835 * @image html img/widget/conformant/preview-00.png
24836 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24838 * @image html img/conformant.png
24839 * @image latex img/conformant.eps width=\textwidth
24841 * The aim is to provide a widget that can be used in elementary apps to
24842 * account for space taken up by the indicator, virtual keypad & softkey
24843 * windows when running the illume2 module of E17.
24845 * So conformant content will be sized and positioned considering the
24846 * space required for such stuff, and when they popup, as a keyboard
24847 * shows when an entry is selected, conformant content won't change.
24849 * Available styles for it:
24852 * Default contents parts of the conformant widget that you can use for are:
24853 * @li "default" - A content of the conformant
24855 * See how to use this widget in this example:
24856 * @ref conformant_example
24860 * @addtogroup Conformant
24865 * Add a new conformant widget to the given parent Elementary
24866 * (container) object.
24868 * @param parent The parent object.
24869 * @return A new conformant widget handle or @c NULL, on errors.
24871 * This function inserts a new conformant widget on the canvas.
24873 * @ingroup Conformant
24875 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24878 * Set the content of the conformant widget.
24880 * @param obj The conformant object.
24881 * @param content The content to be displayed by the conformant.
24883 * Content will be sized and positioned considering the space required
24884 * to display a virtual keyboard. So it won't fill all the conformant
24885 * size. This way is possible to be sure that content won't resize
24886 * or be re-positioned after the keyboard is displayed.
24888 * Once the content object is set, a previously set one will be deleted.
24889 * If you want to keep that old content object, use the
24890 * elm_object_content_unset() function.
24892 * @see elm_object_content_unset()
24893 * @see elm_object_content_get()
24895 * @deprecated use elm_object_content_set() instead
24897 * @ingroup Conformant
24899 WILL_DEPRECATE EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24902 * Get the content of the conformant widget.
24904 * @param obj The conformant object.
24905 * @return The content that is being used.
24907 * Return the content object which is set for this widget.
24908 * It won't be unparent from conformant. For that, use
24909 * elm_object_content_unset().
24911 * @see elm_object_content_set().
24912 * @see elm_object_content_unset()
24914 * @deprecated use elm_object_content_get() instead
24916 * @ingroup Conformant
24918 WILL_DEPRECATE EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24921 * Unset the content of the conformant widget.
24923 * @param obj The conformant object.
24924 * @return The content that was being used.
24926 * Unparent and return the content object which was set for this widget.
24928 * @see elm_object_content_set().
24930 * @deprecated use elm_object_content_unset() instead
24932 * @ingroup Conformant
24934 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24937 * Returns the Evas_Object that represents the content area.
24939 * @param obj The conformant object.
24940 * @return The content area of the widget.
24942 * @ingroup Conformant
24944 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24951 * @defgroup Mapbuf Mapbuf
24952 * @ingroup Elementary
24954 * @image html img/widget/mapbuf/preview-00.png
24955 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24957 * This holds one content object and uses an Evas Map of transformation
24958 * points to be later used with this content. So the content will be
24959 * moved, resized, etc as a single image. So it will improve performance
24960 * when you have a complex interafce, with a lot of elements, and will
24961 * need to resize or move it frequently (the content object and its
24964 * Default contents parts of the mapbuf widget that you can use for are:
24965 * @li "default" - A content of the mapbuf
24967 * To enable map, elm_mapbuf_enabled_set() should be used.
24969 * See how to use this widget in this example:
24970 * @ref mapbuf_example
24974 * @addtogroup Mapbuf
24979 * Add a new mapbuf widget to the given parent Elementary
24980 * (container) object.
24982 * @param parent The parent object.
24983 * @return A new mapbuf widget handle or @c NULL, on errors.
24985 * This function inserts a new mapbuf widget on the canvas.
24989 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24992 * Set the content of the mapbuf.
24994 * @param obj The mapbuf object.
24995 * @param content The content that will be filled in this mapbuf object.
24997 * Once the content object is set, a previously set one will be deleted.
24998 * If you want to keep that old content object, use the
24999 * elm_mapbuf_content_unset() function.
25001 * To enable map, elm_mapbuf_enabled_set() should be used.
25003 * @deprecated use elm_object_content_set() instead
25007 WILL_DEPRECATE EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25010 * Get the content of the mapbuf.
25012 * @param obj The mapbuf object.
25013 * @return The content that is being used.
25015 * Return the content object which is set for this widget.
25017 * @see elm_mapbuf_content_set() for details.
25019 * @deprecated use elm_object_content_get() instead
25023 WILL_DEPRECATE EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25026 * Unset the content of the mapbuf.
25028 * @param obj The mapbuf object.
25029 * @return The content that was being used.
25031 * Unparent and return the content object which was set for this widget.
25033 * @see elm_mapbuf_content_set() for details.
25035 * @deprecated use elm_object_content_unset() instead
25039 WILL_DEPRECATE EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25042 * Enable or disable the map.
25044 * @param obj The mapbuf object.
25045 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25047 * This enables the map that is set or disables it. On enable, the object
25048 * geometry will be saved, and the new geometry will change (position and
25049 * size) to reflect the map geometry set.
25051 * Also, when enabled, alpha and smooth states will be used, so if the
25052 * content isn't solid, alpha should be enabled, for example, otherwise
25053 * a black retangle will fill the content.
25055 * When disabled, the stored map will be freed and geometry prior to
25056 * enabling the map will be restored.
25058 * It's disabled by default.
25060 * @see elm_mapbuf_alpha_set()
25061 * @see elm_mapbuf_smooth_set()
25065 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25068 * Get a value whether map is enabled or not.
25070 * @param obj The mapbuf object.
25071 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25072 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25074 * @see elm_mapbuf_enabled_set() for details.
25078 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25081 * Enable or disable smooth map rendering.
25083 * @param obj The mapbuf object.
25084 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25087 * This sets smoothing for map rendering. If the object is a type that has
25088 * its own smoothing settings, then both the smooth settings for this object
25089 * and the map must be turned off.
25091 * By default smooth maps are enabled.
25095 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25098 * Get a value whether smooth map rendering is enabled or not.
25100 * @param obj The mapbuf object.
25101 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25102 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25104 * @see elm_mapbuf_smooth_set() for details.
25108 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25111 * Set or unset alpha flag for map rendering.
25113 * @param obj The mapbuf object.
25114 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25117 * This sets alpha flag for map rendering. If the object is a type that has
25118 * its own alpha settings, then this will take precedence. Only image objects
25119 * have this currently. It stops alpha blending of the map area, and is
25120 * useful if you know the object and/or all sub-objects is 100% solid.
25122 * Alpha is enabled by default.
25126 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25129 * Get a value whether alpha blending is enabled or not.
25131 * @param obj The mapbuf object.
25132 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25133 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25135 * @see elm_mapbuf_alpha_set() for details.
25139 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25146 * @defgroup Flipselector Flip Selector
25148 * @image html img/widget/flipselector/preview-00.png
25149 * @image latex img/widget/flipselector/preview-00.eps
25151 * A flip selector is a widget to show a set of @b text items, one
25152 * at a time, with the same sheet switching style as the @ref Clock
25153 * "clock" widget, when one changes the current displaying sheet
25154 * (thus, the "flip" in the name).
25156 * User clicks to flip sheets which are @b held for some time will
25157 * make the flip selector to flip continuosly and automatically for
25158 * the user. The interval between flips will keep growing in time,
25159 * so that it helps the user to reach an item which is distant from
25160 * the current selection.
25162 * Smart callbacks one can register to:
25163 * - @c "selected" - when the widget's selected text item is changed
25164 * - @c "overflowed" - when the widget's current selection is changed
25165 * from the first item in its list to the last
25166 * - @c "underflowed" - when the widget's current selection is changed
25167 * from the last item in its list to the first
25169 * Available styles for it:
25172 * To set/get the label of the flipselector item, you can use
25173 * elm_object_item_text_set/get APIs.
25174 * Once the text is set, a previously set one will be deleted.
25176 * Here is an example on its usage:
25177 * @li @ref flipselector_example
25181 * @addtogroup Flipselector
25186 * Add a new flip selector widget to the given parent Elementary
25187 * (container) widget
25189 * @param parent The parent object
25190 * @return a new flip selector widget handle or @c NULL, on errors
25192 * This function inserts a new flip selector widget on the canvas.
25194 * @ingroup Flipselector
25196 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25199 * Programmatically select the next item of a flip selector widget
25201 * @param obj The flipselector object
25203 * @note The selection will be animated. Also, if it reaches the
25204 * end of its list of member items, it will continue with the first
25207 * @ingroup Flipselector
25209 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25212 * Programmatically select the previous item of a flip selector
25215 * @param obj The flipselector object
25217 * @note The selection will be animated. Also, if it reaches the
25218 * beginning of its list of member items, it will continue with the
25219 * last one backwards.
25221 * @ingroup Flipselector
25223 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25226 * Append a (text) item to a flip selector widget
25228 * @param obj The flipselector object
25229 * @param label The (text) label of the new item
25230 * @param func Convenience callback function to take place when
25232 * @param data Data passed to @p func, above
25233 * @return A handle to the item added or @c NULL, on errors
25235 * The widget's list of labels to show will be appended with the
25236 * given value. If the user wishes so, a callback function pointer
25237 * can be passed, which will get called when this same item is
25240 * @note The current selection @b won't be modified by appending an
25241 * element to the list.
25243 * @note The maximum length of the text label is going to be
25244 * determined <b>by the widget's theme</b>. Strings larger than
25245 * that value are going to be @b truncated.
25247 * @ingroup Flipselector
25249 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25252 * Prepend a (text) item to a flip selector widget
25254 * @param obj The flipselector object
25255 * @param label The (text) label of the new item
25256 * @param func Convenience callback function to take place when
25258 * @param data Data passed to @p func, above
25259 * @return A handle to the item added or @c NULL, on errors
25261 * The widget's list of labels to show will be prepended with the
25262 * given value. If the user wishes so, a callback function pointer
25263 * can be passed, which will get called when this same item is
25266 * @note The current selection @b won't be modified by prepending
25267 * an element to the list.
25269 * @note The maximum length of the text label is going to be
25270 * determined <b>by the widget's theme</b>. Strings larger than
25271 * that value are going to be @b truncated.
25273 * @ingroup Flipselector
25275 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25278 * Get the internal list of items in a given flip selector widget.
25280 * @param obj The flipselector object
25281 * @return The list of items (#Elm_Object_Item as data) or
25282 * @c NULL on errors.
25284 * This list is @b not to be modified in any way and must not be
25285 * freed. Use the list members with functions like
25286 * elm_object_item_text_set(),
25287 * elm_object_item_text_get(),
25288 * elm_flipselector_item_del(),
25289 * elm_flipselector_item_selected_get(),
25290 * elm_flipselector_item_selected_set().
25292 * @warning This list is only valid until @p obj object's internal
25293 * items list is changed. It should be fetched again with another
25294 * call to this function when changes happen.
25296 * @ingroup Flipselector
25298 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25301 * Get the first item in the given flip selector widget's list of
25304 * @param obj The flipselector object
25305 * @return The first item or @c NULL, if it has no items (and on
25308 * @see elm_flipselector_item_append()
25309 * @see elm_flipselector_last_item_get()
25311 * @ingroup Flipselector
25313 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25316 * Get the last item in the given flip selector widget's list of
25319 * @param obj The flipselector object
25320 * @return The last item or @c NULL, if it has no items (and on
25323 * @see elm_flipselector_item_prepend()
25324 * @see elm_flipselector_first_item_get()
25326 * @ingroup Flipselector
25328 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25331 * Get the currently selected item in a flip selector widget.
25333 * @param obj The flipselector object
25334 * @return The selected item or @c NULL, if the widget has no items
25337 * @ingroup Flipselector
25339 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25342 * Set whether a given flip selector widget's item should be the
25343 * currently selected one.
25345 * @param it The flip selector item
25346 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25348 * This sets whether @p item is or not the selected (thus, under
25349 * display) one. If @p item is different than one under display,
25350 * the latter will be unselected. If the @p item is set to be
25351 * unselected, on the other hand, the @b first item in the widget's
25352 * internal members list will be the new selected one.
25354 * @see elm_flipselector_item_selected_get()
25356 * @ingroup Flipselector
25358 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25361 * Get whether a given flip selector widget's item is the currently
25364 * @param it The flip selector item
25365 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25368 * @see elm_flipselector_item_selected_set()
25370 * @ingroup Flipselector
25372 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25375 * Delete a given item from a flip selector widget.
25377 * @param it The item to delete
25379 * @ingroup Flipselector
25381 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25384 * Get the label of a given flip selector widget's item.
25386 * @param it The item to get label from
25387 * @return The text label of @p item or @c NULL, on errors
25389 * @see elm_object_item_text_set()
25391 * @deprecated see elm_object_item_text_get() instead
25392 * @ingroup Flipselector
25394 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25397 * Set the label of a given flip selector widget's item.
25399 * @param it The item to set label on
25400 * @param label The text label string, in UTF-8 encoding
25402 * @see elm_object_item_text_get()
25404 * @deprecated see elm_object_item_text_set() instead
25405 * @ingroup Flipselector
25407 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25410 * Gets the item before @p item in a flip selector widget's
25411 * internal list of items.
25413 * @param it The item to fetch previous from
25414 * @return The item before the @p item, in its parent's list. If
25415 * there is no previous item for @p item or there's an
25416 * error, @c NULL is returned.
25418 * @see elm_flipselector_item_next_get()
25420 * @ingroup Flipselector
25422 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25425 * Gets the item after @p item in a flip selector widget's
25426 * internal list of items.
25428 * @param it The item to fetch next from
25429 * @return The item after the @p item, in its parent's list. If
25430 * there is no next item for @p item or there's an
25431 * error, @c NULL is returned.
25433 * @see elm_flipselector_item_next_get()
25435 * @ingroup Flipselector
25437 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25440 * Set the interval on time updates for an user mouse button hold
25441 * on a flip selector widget.
25443 * @param obj The flip selector object
25444 * @param interval The (first) interval value in seconds
25446 * This interval value is @b decreased while the user holds the
25447 * mouse pointer either flipping up or flipping doww a given flip
25450 * This helps the user to get to a given item distant from the
25451 * current one easier/faster, as it will start to flip quicker and
25452 * quicker on mouse button holds.
25454 * The calculation for the next flip interval value, starting from
25455 * the one set with this call, is the previous interval divided by
25456 * 1.05, so it decreases a little bit.
25458 * The default starting interval value for automatic flips is
25461 * @see elm_flipselector_interval_get()
25463 * @ingroup Flipselector
25465 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25468 * Get the interval on time updates for an user mouse button hold
25469 * on a flip selector widget.
25471 * @param obj The flip selector object
25472 * @return The (first) interval value, in seconds, set on it
25474 * @see elm_flipselector_interval_set() for more details
25476 * @ingroup Flipselector
25478 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25484 * @addtogroup Calendar
25489 * @enum _Elm_Calendar_Mark_Repeat
25490 * @typedef Elm_Calendar_Mark_Repeat
25492 * Event periodicity, used to define if a mark should be repeated
25493 * @b beyond event's day. It's set when a mark is added.
25495 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25496 * there will be marks every week after this date. Marks will be displayed
25497 * at 13th, 20th, 27th, 3rd June ...
25499 * Values don't work as bitmask, only one can be choosen.
25501 * @see elm_calendar_mark_add()
25503 * @ingroup Calendar
25505 typedef enum _Elm_Calendar_Mark_Repeat
25507 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25508 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25509 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25510 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*/
25511 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. */
25512 } Elm_Calendar_Mark_Repeat;
25514 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(). */
25517 * Add a new calendar widget to the given parent Elementary
25518 * (container) object.
25520 * @param parent The parent object.
25521 * @return a new calendar widget handle or @c NULL, on errors.
25523 * This function inserts a new calendar widget on the canvas.
25525 * @ref calendar_example_01
25527 * @ingroup Calendar
25529 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25532 * Get weekdays names displayed by the calendar.
25534 * @param obj The calendar object.
25535 * @return Array of seven strings to be used as weekday names.
25537 * By default, weekdays abbreviations get from system are displayed:
25538 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25539 * The first string is related to Sunday, the second to Monday...
25541 * @see elm_calendar_weekdays_name_set()
25543 * @ref calendar_example_05
25545 * @ingroup Calendar
25547 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25550 * Set weekdays names to be displayed by the calendar.
25552 * @param obj The calendar object.
25553 * @param weekdays Array of seven strings to be used as weekday names.
25554 * @warning It must have 7 elements, or it will access invalid memory.
25555 * @warning The strings must be NULL terminated ('@\0').
25557 * By default, weekdays abbreviations get from system are displayed:
25558 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25560 * The first string should be related to Sunday, the second to Monday...
25562 * The usage should be like this:
25564 * const char *weekdays[] =
25566 * "Sunday", "Monday", "Tuesday", "Wednesday",
25567 * "Thursday", "Friday", "Saturday"
25569 * elm_calendar_weekdays_names_set(calendar, weekdays);
25572 * @see elm_calendar_weekdays_name_get()
25574 * @ref calendar_example_02
25576 * @ingroup Calendar
25578 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25581 * Set the minimum and maximum values for the year
25583 * @param obj The calendar object
25584 * @param min The minimum year, greater than 1901;
25585 * @param max The maximum year;
25587 * Maximum must be greater than minimum, except if you don't wan't to set
25589 * Default values are 1902 and -1.
25591 * If the maximum year is a negative value, it will be limited depending
25592 * on the platform architecture (year 2037 for 32 bits);
25594 * @see elm_calendar_min_max_year_get()
25596 * @ref calendar_example_03
25598 * @ingroup Calendar
25600 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25603 * Get the minimum and maximum values for the year
25605 * @param obj The calendar object.
25606 * @param min The minimum year.
25607 * @param max The maximum year.
25609 * Default values are 1902 and -1.
25611 * @see elm_calendar_min_max_year_get() for more details.
25613 * @ref calendar_example_05
25615 * @ingroup Calendar
25617 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25620 * Enable or disable day selection
25622 * @param obj The calendar object.
25623 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25626 * Enabled by default. If disabled, the user still can select months,
25627 * but not days. Selected days are highlighted on calendar.
25628 * It should be used if you won't need such selection for the widget usage.
25630 * When a day is selected, or month is changed, smart callbacks for
25631 * signal "changed" will be called.
25633 * @see elm_calendar_day_selection_enable_get()
25635 * @ref calendar_example_04
25637 * @ingroup Calendar
25639 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25642 * Get a value whether day selection is enabled or not.
25644 * @see elm_calendar_day_selection_enable_set() for details.
25646 * @param obj The calendar object.
25647 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25648 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25650 * @ref calendar_example_05
25652 * @ingroup Calendar
25654 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25658 * Set selected date to be highlighted on calendar.
25660 * @param obj The calendar object.
25661 * @param selected_time A @b tm struct to represent the selected date.
25663 * Set the selected date, changing the displayed month if needed.
25664 * Selected date changes when the user goes to next/previous month or
25665 * select a day pressing over it on calendar.
25667 * @see elm_calendar_selected_time_get()
25669 * @ref calendar_example_04
25671 * @ingroup Calendar
25673 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25676 * Get selected date.
25678 * @param obj The calendar object
25679 * @param selected_time A @b tm struct to point to selected date
25680 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25683 * Get date selected by the user or set by function
25684 * elm_calendar_selected_time_set().
25685 * Selected date changes when the user goes to next/previous month or
25686 * select a day pressing over it on calendar.
25688 * @see elm_calendar_selected_time_get()
25690 * @ref calendar_example_05
25692 * @ingroup Calendar
25694 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25697 * Set a function to format the string that will be used to display
25700 * @param obj The calendar object
25701 * @param format_function Function to set the month-year string given
25702 * the selected date
25704 * By default it uses strftime with "%B %Y" format string.
25705 * It should allocate the memory that will be used by the string,
25706 * that will be freed by the widget after usage.
25707 * A pointer to the string and a pointer to the time struct will be provided.
25712 * _format_month_year(struct tm *selected_time)
25715 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25716 * return strdup(buf);
25719 * elm_calendar_format_function_set(calendar, _format_month_year);
25722 * @ref calendar_example_02
25724 * @ingroup Calendar
25726 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25729 * Add a new mark to the calendar
25731 * @param obj The calendar object
25732 * @param mark_type A string used to define the type of mark. It will be
25733 * emitted to the theme, that should display a related modification on these
25734 * days representation.
25735 * @param mark_time A time struct to represent the date of inclusion of the
25736 * mark. For marks that repeats it will just be displayed after the inclusion
25737 * date in the calendar.
25738 * @param repeat Repeat the event following this periodicity. Can be a unique
25739 * mark (that don't repeat), daily, weekly, monthly or annually.
25740 * @return The created mark or @p NULL upon failure.
25742 * Add a mark that will be drawn in the calendar respecting the insertion
25743 * time and periodicity. It will emit the type as signal to the widget theme.
25744 * Default theme supports "holiday" and "checked", but it can be extended.
25746 * It won't immediately update the calendar, drawing the marks.
25747 * For this, call elm_calendar_marks_draw(). However, when user selects
25748 * next or previous month calendar forces marks drawn.
25750 * Marks created with this method can be deleted with
25751 * elm_calendar_mark_del().
25755 * struct tm selected_time;
25756 * time_t current_time;
25758 * current_time = time(NULL) + 5 * 84600;
25759 * localtime_r(¤t_time, &selected_time);
25760 * elm_calendar_mark_add(cal, "holiday", selected_time,
25761 * ELM_CALENDAR_ANNUALLY);
25763 * current_time = time(NULL) + 1 * 84600;
25764 * localtime_r(¤t_time, &selected_time);
25765 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25767 * elm_calendar_marks_draw(cal);
25770 * @see elm_calendar_marks_draw()
25771 * @see elm_calendar_mark_del()
25773 * @ref calendar_example_06
25775 * @ingroup Calendar
25777 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);
25780 * Delete mark from the calendar.
25782 * @param mark The mark to be deleted.
25784 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25785 * should be used instead of getting marks list and deleting each one.
25787 * @see elm_calendar_mark_add()
25789 * @ref calendar_example_06
25791 * @ingroup Calendar
25793 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25796 * Remove all calendar's marks
25798 * @param obj The calendar object.
25800 * @see elm_calendar_mark_add()
25801 * @see elm_calendar_mark_del()
25803 * @ingroup Calendar
25805 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25809 * Get a list of all the calendar marks.
25811 * @param obj The calendar object.
25812 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25814 * @see elm_calendar_mark_add()
25815 * @see elm_calendar_mark_del()
25816 * @see elm_calendar_marks_clear()
25818 * @ingroup Calendar
25820 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25823 * Draw calendar marks.
25825 * @param obj The calendar object.
25827 * Should be used after adding, removing or clearing marks.
25828 * It will go through the entire marks list updating the calendar.
25829 * If lots of marks will be added, add all the marks and then call
25832 * When the month is changed, i.e. user selects next or previous month,
25833 * marks will be drawed.
25835 * @see elm_calendar_mark_add()
25836 * @see elm_calendar_mark_del()
25837 * @see elm_calendar_marks_clear()
25839 * @ref calendar_example_06
25841 * @ingroup Calendar
25843 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25846 * Set a day text color to the same that represents Saturdays.
25848 * @param obj The calendar object.
25849 * @param pos The text position. Position is the cell counter, from left
25850 * to right, up to down. It starts on 0 and ends on 41.
25852 * @deprecated use elm_calendar_mark_add() instead like:
25855 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25856 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25859 * @see elm_calendar_mark_add()
25861 * @ingroup Calendar
25863 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25866 * Set a day text color to the same that represents Sundays.
25868 * @param obj The calendar object.
25869 * @param pos The text position. Position is the cell counter, from left
25870 * to right, up to down. It starts on 0 and ends on 41.
25872 * @deprecated use elm_calendar_mark_add() instead like:
25875 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25876 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25879 * @see elm_calendar_mark_add()
25881 * @ingroup Calendar
25883 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25886 * Set a day text color to the same that represents Weekdays.
25888 * @param obj The calendar object
25889 * @param pos The text position. Position is the cell counter, from left
25890 * to right, up to down. It starts on 0 and ends on 41.
25892 * @deprecated use elm_calendar_mark_add() instead like:
25895 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25897 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25898 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25899 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25900 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25901 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25902 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25903 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25904 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25905 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25908 * @see elm_calendar_mark_add()
25910 * @ingroup Calendar
25912 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25915 * Set the interval on time updates for an user mouse button hold
25916 * on calendar widgets' month selection.
25918 * @param obj The calendar object
25919 * @param interval The (first) interval value in seconds
25921 * This interval value is @b decreased while the user holds the
25922 * mouse pointer either selecting next or previous month.
25924 * This helps the user to get to a given month distant from the
25925 * current one easier/faster, as it will start to change quicker and
25926 * quicker on mouse button holds.
25928 * The calculation for the next change interval value, starting from
25929 * the one set with this call, is the previous interval divided by
25930 * 1.05, so it decreases a little bit.
25932 * The default starting interval value for automatic changes is
25935 * @see elm_calendar_interval_get()
25937 * @ingroup Calendar
25939 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25942 * Get the interval on time updates for an user mouse button hold
25943 * on calendar widgets' month selection.
25945 * @param obj The calendar object
25946 * @return The (first) interval value, in seconds, set on it
25948 * @see elm_calendar_interval_set() for more details
25950 * @ingroup Calendar
25952 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25959 * @defgroup Diskselector Diskselector
25960 * @ingroup Elementary
25962 * @image html img/widget/diskselector/preview-00.png
25963 * @image latex img/widget/diskselector/preview-00.eps
25965 * A diskselector is a kind of list widget. It scrolls horizontally,
25966 * and can contain label and icon objects. Three items are displayed
25967 * with the selected one in the middle.
25969 * It can act like a circular list with round mode and labels can be
25970 * reduced for a defined length for side items.
25972 * Smart callbacks one can listen to:
25973 * - "selected" - when item is selected, i.e. scroller stops.
25975 * Available styles for it:
25978 * List of examples:
25979 * @li @ref diskselector_example_01
25980 * @li @ref diskselector_example_02
25984 * @addtogroup Diskselector
25988 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(). */
25991 * Add a new diskselector widget to the given parent Elementary
25992 * (container) object.
25994 * @param parent The parent object.
25995 * @return a new diskselector widget handle or @c NULL, on errors.
25997 * This function inserts a new diskselector widget on the canvas.
25999 * @ingroup Diskselector
26001 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26004 * Enable or disable round mode.
26006 * @param obj The diskselector object.
26007 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26010 * Disabled by default. If round mode is enabled the items list will
26011 * work like a circle list, so when the user reaches the last item,
26012 * the first one will popup.
26014 * @see elm_diskselector_round_get()
26016 * @ingroup Diskselector
26018 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
26021 * Get a value whether round mode is enabled or not.
26023 * @see elm_diskselector_round_set() for details.
26025 * @param obj The diskselector object.
26026 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
26027 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26029 * @ingroup Diskselector
26031 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26034 * Get the side labels max length.
26036 * @deprecated use elm_diskselector_side_label_length_get() instead:
26038 * @param obj The diskselector object.
26039 * @return The max length defined for side labels, or 0 if not a valid
26042 * @ingroup Diskselector
26044 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26047 * Set the side labels max length.
26049 * @deprecated use elm_diskselector_side_label_length_set() instead:
26051 * @param obj The diskselector object.
26052 * @param len The max length defined for side labels.
26054 * @ingroup Diskselector
26056 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26059 * Get the side labels max length.
26061 * @see elm_diskselector_side_label_length_set() for details.
26063 * @param obj The diskselector object.
26064 * @return The max length defined for side labels, or 0 if not a valid
26067 * @ingroup Diskselector
26069 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26072 * Set the side labels max length.
26074 * @param obj The diskselector object.
26075 * @param len The max length defined for side labels.
26077 * Length is the number of characters of items' label that will be
26078 * visible when it's set on side positions. It will just crop
26079 * the string after defined size. E.g.:
26081 * An item with label "January" would be displayed on side position as
26082 * "Jan" if max length is set to 3, or "Janu", if this property
26085 * When it's selected, the entire label will be displayed, except for
26086 * width restrictions. In this case label will be cropped and "..."
26087 * will be concatenated.
26089 * Default side label max length is 3.
26091 * This property will be applyed over all items, included before or
26092 * later this function call.
26094 * @ingroup Diskselector
26096 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26099 * Set the number of items to be displayed.
26101 * @param obj The diskselector object.
26102 * @param num The number of items the diskselector will display.
26104 * Default value is 3, and also it's the minimun. If @p num is less
26105 * than 3, it will be set to 3.
26107 * Also, it can be set on theme, using data item @c display_item_num
26108 * on group "elm/diskselector/item/X", where X is style set.
26111 * group { name: "elm/diskselector/item/X";
26113 * item: "display_item_num" "5";
26116 * @ingroup Diskselector
26118 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26121 * Get the number of items in the diskselector object.
26123 * @param obj The diskselector object.
26125 * @ingroup Diskselector
26127 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26130 * Set bouncing behaviour when the scrolled content reaches an edge.
26132 * Tell the internal scroller object whether it should bounce or not
26133 * when it reaches the respective edges for each axis.
26135 * @param obj The diskselector object.
26136 * @param h_bounce Whether to bounce or not in the horizontal axis.
26137 * @param v_bounce Whether to bounce or not in the vertical axis.
26139 * @see elm_scroller_bounce_set()
26141 * @ingroup Diskselector
26143 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26146 * Get the bouncing behaviour of the internal scroller.
26148 * Get whether the internal scroller should bounce when the edge of each
26149 * axis is reached scrolling.
26151 * @param obj The diskselector object.
26152 * @param h_bounce Pointer where to store the bounce state of the horizontal
26154 * @param v_bounce Pointer where to store the bounce state of the vertical
26157 * @see elm_scroller_bounce_get()
26158 * @see elm_diskselector_bounce_set()
26160 * @ingroup Diskselector
26162 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26165 * Get the scrollbar policy.
26167 * @see elm_diskselector_scroller_policy_get() for details.
26169 * @param obj The diskselector object.
26170 * @param policy_h Pointer where to store horizontal scrollbar policy.
26171 * @param policy_v Pointer where to store vertical scrollbar policy.
26173 * @ingroup Diskselector
26175 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);
26178 * Set the scrollbar policy.
26180 * @param obj The diskselector object.
26181 * @param policy_h Horizontal scrollbar policy.
26182 * @param policy_v Vertical scrollbar policy.
26184 * This sets the scrollbar visibility policy for the given scroller.
26185 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26186 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26187 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26188 * This applies respectively for the horizontal and vertical scrollbars.
26190 * The both are disabled by default, i.e., are set to
26191 * #ELM_SCROLLER_POLICY_OFF.
26193 * @ingroup Diskselector
26195 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26198 * Remove all diskselector's items.
26200 * @param obj The diskselector object.
26202 * @see elm_diskselector_item_del()
26203 * @see elm_diskselector_item_append()
26205 * @ingroup Diskselector
26207 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26210 * Get a list of all the diskselector items.
26212 * @param obj The diskselector object.
26213 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26214 * or @c NULL on failure.
26216 * @see elm_diskselector_item_append()
26217 * @see elm_diskselector_item_del()
26218 * @see elm_diskselector_clear()
26220 * @ingroup Diskselector
26222 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26225 * Appends a new item to the diskselector object.
26227 * @param obj The diskselector object.
26228 * @param label The label of the diskselector item.
26229 * @param icon The icon object to use at left side of the item. An
26230 * icon can be any Evas object, but usually it is an icon created
26231 * with elm_icon_add().
26232 * @param func The function to call when the item is selected.
26233 * @param data The data to associate with the item for related callbacks.
26235 * @return The created item or @c NULL upon failure.
26237 * A new item will be created and appended to the diskselector, i.e., will
26238 * be set as last item. Also, if there is no selected item, it will
26239 * be selected. This will always happens for the first appended item.
26241 * If no icon is set, label will be centered on item position, otherwise
26242 * the icon will be placed at left of the label, that will be shifted
26245 * Items created with this method can be deleted with
26246 * elm_diskselector_item_del().
26248 * Associated @p data can be properly freed when item is deleted if a
26249 * callback function is set with elm_diskselector_item_del_cb_set().
26251 * If a function is passed as argument, it will be called everytime this item
26252 * is selected, i.e., the user stops the diskselector with this
26253 * item on center position. If such function isn't needed, just passing
26254 * @c NULL as @p func is enough. The same should be done for @p data.
26256 * Simple example (with no function callback or data associated):
26258 * disk = elm_diskselector_add(win);
26259 * ic = elm_icon_add(win);
26260 * elm_icon_file_set(ic, "path/to/image", NULL);
26261 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26262 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26265 * @see elm_diskselector_item_del()
26266 * @see elm_diskselector_item_del_cb_set()
26267 * @see elm_diskselector_clear()
26268 * @see elm_icon_add()
26270 * @ingroup Diskselector
26272 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);
26276 * Delete them item from the diskselector.
26278 * @param it The item of diskselector to be deleted.
26280 * If deleting all diskselector items is required, elm_diskselector_clear()
26281 * should be used instead of getting items list and deleting each one.
26283 * @see elm_diskselector_clear()
26284 * @see elm_diskselector_item_append()
26285 * @see elm_diskselector_item_del_cb_set()
26287 * @ingroup Diskselector
26289 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26292 * Set the function called when a diskselector item is freed.
26294 * @param it The item to set the callback on
26295 * @param func The function called
26297 * If there is a @p func, then it will be called prior item's memory release.
26298 * That will be called with the following arguments:
26300 * @li item's Evas object;
26303 * This way, a data associated to a diskselector item could be properly
26306 * @ingroup Diskselector
26308 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26311 * Get the data associated to the item.
26313 * @param it The diskselector item
26314 * @return The data associated to @p it
26316 * The return value is a pointer to data associated to @p item when it was
26317 * created, with function elm_diskselector_item_append(). If no data
26318 * was passed as argument, it will return @c NULL.
26320 * @see elm_diskselector_item_append()
26322 * @ingroup Diskselector
26324 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26327 * Set the icon associated to the item.
26329 * @param it The diskselector item
26330 * @param icon The icon object to associate with @p it
26332 * The icon object to use at left side of the item. An
26333 * icon can be any Evas object, but usually it is an icon created
26334 * with elm_icon_add().
26336 * Once the icon object is set, a previously set one will be deleted.
26337 * @warning Setting the same icon for two items will cause the icon to
26338 * dissapear from the first item.
26340 * If an icon was passed as argument on item creation, with function
26341 * elm_diskselector_item_append(), it will be already
26342 * associated to the item.
26344 * @see elm_diskselector_item_append()
26345 * @see elm_diskselector_item_icon_get()
26347 * @ingroup Diskselector
26349 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26352 * Get the icon associated to the item.
26354 * @param it The diskselector item
26355 * @return The icon associated to @p it
26357 * The return value is a pointer to the icon associated to @p item when it was
26358 * created, with function elm_diskselector_item_append(), or later
26359 * with function elm_diskselector_item_icon_set. If no icon
26360 * was passed as argument, it will return @c NULL.
26362 * @see elm_diskselector_item_append()
26363 * @see elm_diskselector_item_icon_set()
26365 * @ingroup Diskselector
26367 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26370 * Set the label of item.
26372 * @param it The item of diskselector.
26373 * @param label The label of item.
26375 * The label to be displayed by the item.
26377 * If no icon is set, label will be centered on item position, otherwise
26378 * the icon will be placed at left of the label, that will be shifted
26381 * An item with label "January" would be displayed on side position as
26382 * "Jan" if max length is set to 3 with function
26383 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26386 * When this @p item is selected, the entire label will be displayed,
26387 * except for width restrictions.
26388 * In this case label will be cropped and "..." will be concatenated,
26389 * but only for display purposes. It will keep the entire string, so
26390 * if diskselector is resized the remaining characters will be displayed.
26392 * If a label was passed as argument on item creation, with function
26393 * elm_diskselector_item_append(), it will be already
26394 * displayed by the item.
26396 * @see elm_diskselector_side_label_lenght_set()
26397 * @see elm_diskselector_item_label_get()
26398 * @see elm_diskselector_item_append()
26400 * @ingroup Diskselector
26402 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26405 * Get the label of item.
26407 * @param it The item of diskselector.
26408 * @return The label of item.
26410 * The return value is a pointer to the label associated to @p item when it was
26411 * created, with function elm_diskselector_item_append(), or later
26412 * with function elm_diskselector_item_label_set. If no label
26413 * was passed as argument, it will return @c NULL.
26415 * @see elm_diskselector_item_label_set() for more details.
26416 * @see elm_diskselector_item_append()
26418 * @ingroup Diskselector
26420 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26423 * Get the selected item.
26425 * @param obj The diskselector object.
26426 * @return The selected diskselector item.
26428 * The selected item can be unselected with function
26429 * elm_diskselector_item_selected_set(), and the first item of
26430 * diskselector will be selected.
26432 * The selected item always will be centered on diskselector, with
26433 * full label displayed, i.e., max lenght set to side labels won't
26434 * apply on the selected item. More details on
26435 * elm_diskselector_side_label_length_set().
26437 * @ingroup Diskselector
26439 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26442 * Set the selected state of an item.
26444 * @param it The diskselector item
26445 * @param selected The selected state
26447 * This sets the selected state of the given item @p it.
26448 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26450 * If a new item is selected the previosly selected will be unselected.
26451 * Previoulsy selected item can be get with function
26452 * elm_diskselector_selected_item_get().
26454 * If the item @p it is unselected, the first item of diskselector will
26457 * Selected items will be visible on center position of diskselector.
26458 * So if it was on another position before selected, or was invisible,
26459 * diskselector will animate items until the selected item reaches center
26462 * @see elm_diskselector_item_selected_get()
26463 * @see elm_diskselector_selected_item_get()
26465 * @ingroup Diskselector
26467 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26470 * Get whether the @p item is selected or not.
26472 * @param it The diskselector item.
26473 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26474 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26476 * @see elm_diskselector_selected_item_set() for details.
26477 * @see elm_diskselector_item_selected_get()
26479 * @ingroup Diskselector
26481 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26484 * Get the first item of the diskselector.
26486 * @param obj The diskselector object.
26487 * @return The first item, or @c NULL if none.
26489 * The list of items follows append order. So it will return the first
26490 * item appended to the widget that wasn't deleted.
26492 * @see elm_diskselector_item_append()
26493 * @see elm_diskselector_items_get()
26495 * @ingroup Diskselector
26497 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26500 * Get the last item of the diskselector.
26502 * @param obj The diskselector object.
26503 * @return The last item, or @c NULL if none.
26505 * The list of items follows append order. So it will return last first
26506 * item appended to the widget that wasn't deleted.
26508 * @see elm_diskselector_item_append()
26509 * @see elm_diskselector_items_get()
26511 * @ingroup Diskselector
26513 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26516 * Get the item before @p item in diskselector.
26518 * @param it The diskselector item.
26519 * @return The item before @p item, or @c NULL if none or on failure.
26521 * The list of items follows append order. So it will return item appended
26522 * just before @p item and that wasn't deleted.
26524 * If it is the first item, @c NULL will be returned.
26525 * First item can be get by elm_diskselector_first_item_get().
26527 * @see elm_diskselector_item_append()
26528 * @see elm_diskselector_items_get()
26530 * @ingroup Diskselector
26532 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26535 * Get the item after @p item in diskselector.
26537 * @param it The diskselector item.
26538 * @return The item after @p item, or @c NULL if none or on failure.
26540 * The list of items follows append order. So it will return item appended
26541 * just after @p item and that wasn't deleted.
26543 * If it is the last item, @c NULL will be returned.
26544 * Last item can be get by elm_diskselector_last_item_get().
26546 * @see elm_diskselector_item_append()
26547 * @see elm_diskselector_items_get()
26549 * @ingroup Diskselector
26551 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26554 * Set the text to be shown in the diskselector item.
26556 * @param item Target item
26557 * @param text The text to set in the content
26559 * Setup the text as tooltip to object. The item can have only one tooltip,
26560 * so any previous tooltip data is removed.
26562 * @see elm_object_tooltip_text_set() for more details.
26564 * @ingroup Diskselector
26566 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26569 * Set the content to be shown in the tooltip item.
26571 * Setup the tooltip to item. The item can have only one tooltip,
26572 * so any previous tooltip data is removed. @p func(with @p data) will
26573 * be called every time that need show the tooltip and it should
26574 * return a valid Evas_Object. This object is then managed fully by
26575 * tooltip system and is deleted when the tooltip is gone.
26577 * @param item the diskselector item being attached a tooltip.
26578 * @param func the function used to create the tooltip contents.
26579 * @param data what to provide to @a func as callback data/context.
26580 * @param del_cb called when data is not needed anymore, either when
26581 * another callback replaces @p func, the tooltip is unset with
26582 * elm_diskselector_item_tooltip_unset() or the owner @a item
26583 * dies. This callback receives as the first parameter the
26584 * given @a data, and @c event_info is the item.
26586 * @see elm_object_tooltip_content_cb_set() for more details.
26588 * @ingroup Diskselector
26590 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);
26593 * Unset tooltip from item.
26595 * @param item diskselector item to remove previously set tooltip.
26597 * Remove tooltip from item. The callback provided as del_cb to
26598 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26599 * it is not used anymore.
26601 * @see elm_object_tooltip_unset() for more details.
26602 * @see elm_diskselector_item_tooltip_content_cb_set()
26604 * @ingroup Diskselector
26606 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26610 * Sets a different style for this item tooltip.
26612 * @note before you set a style you should define a tooltip with
26613 * elm_diskselector_item_tooltip_content_cb_set() or
26614 * elm_diskselector_item_tooltip_text_set()
26616 * @param item diskselector item with tooltip already set.
26617 * @param style the theme style to use (default, transparent, ...)
26619 * @see elm_object_tooltip_style_set() for more details.
26621 * @ingroup Diskselector
26623 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26626 * Get the style for this item tooltip.
26628 * @param item diskselector item with tooltip already set.
26629 * @return style the theme style in use, defaults to "default". If the
26630 * object does not have a tooltip set, then NULL is returned.
26632 * @see elm_object_tooltip_style_get() for more details.
26633 * @see elm_diskselector_item_tooltip_style_set()
26635 * @ingroup Diskselector
26637 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26640 * Set the cursor to be shown when mouse is over the diskselector item
26642 * @param item Target item
26643 * @param cursor the cursor name to be used.
26645 * @see elm_object_cursor_set() for more details.
26647 * @ingroup Diskselector
26649 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26652 * Get the cursor to be shown when mouse is over the diskselector item
26654 * @param item diskselector item with cursor already set.
26655 * @return the cursor name.
26657 * @see elm_object_cursor_get() for more details.
26658 * @see elm_diskselector_cursor_set()
26660 * @ingroup Diskselector
26662 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26666 * Unset the cursor to be shown when mouse is over the diskselector item
26668 * @param item Target item
26670 * @see elm_object_cursor_unset() for more details.
26671 * @see elm_diskselector_cursor_set()
26673 * @ingroup Diskselector
26675 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26678 * Sets a different style for this item cursor.
26680 * @note before you set a style you should define a cursor with
26681 * elm_diskselector_item_cursor_set()
26683 * @param item diskselector item with cursor already set.
26684 * @param style the theme style to use (default, transparent, ...)
26686 * @see elm_object_cursor_style_set() for more details.
26688 * @ingroup Diskselector
26690 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26694 * Get the style for this item cursor.
26696 * @param item diskselector item with cursor already set.
26697 * @return style the theme style in use, defaults to "default". If the
26698 * object does not have a cursor set, then @c NULL is returned.
26700 * @see elm_object_cursor_style_get() for more details.
26701 * @see elm_diskselector_item_cursor_style_set()
26703 * @ingroup Diskselector
26705 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26709 * Set if the cursor set should be searched on the theme or should use
26710 * the provided by the engine, only.
26712 * @note before you set if should look on theme you should define a cursor
26713 * with elm_diskselector_item_cursor_set().
26714 * By default it will only look for cursors provided by the engine.
26716 * @param item widget item with cursor already set.
26717 * @param engine_only boolean to define if cursors set with
26718 * elm_diskselector_item_cursor_set() should be searched only
26719 * between cursors provided by the engine or searched on widget's
26722 * @see elm_object_cursor_engine_only_set() for more details.
26724 * @ingroup Diskselector
26726 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26729 * Get the cursor engine only usage for this item cursor.
26731 * @param item widget item with cursor already set.
26732 * @return engine_only boolean to define it cursors should be looked only
26733 * between the provided by the engine or searched on widget's theme as well.
26734 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26736 * @see elm_object_cursor_engine_only_get() for more details.
26737 * @see elm_diskselector_item_cursor_engine_only_set()
26739 * @ingroup Diskselector
26741 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26748 * @defgroup Colorselector Colorselector
26752 * @image html img/widget/colorselector/preview-00.png
26753 * @image latex img/widget/colorselector/preview-00.eps
26755 * @brief Widget for user to select a color.
26757 * Signals that you can add callbacks for are:
26758 * "changed" - When the color value changes(event_info is NULL).
26760 * See @ref tutorial_colorselector.
26763 * @brief Add a new colorselector to the parent
26765 * @param parent The parent object
26766 * @return The new object or NULL if it cannot be created
26768 * @ingroup Colorselector
26770 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26772 * Set a color for the colorselector
26774 * @param obj Colorselector object
26775 * @param r r-value of color
26776 * @param g g-value of color
26777 * @param b b-value of color
26778 * @param a a-value of color
26780 * @ingroup Colorselector
26782 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26784 * Get a color from the colorselector
26786 * @param obj Colorselector object
26787 * @param r integer pointer for r-value of color
26788 * @param g integer pointer for g-value of color
26789 * @param b integer pointer for b-value of color
26790 * @param a integer pointer for a-value of color
26792 * @ingroup Colorselector
26794 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26800 * @defgroup Ctxpopup Ctxpopup
26802 * @image html img/widget/ctxpopup/preview-00.png
26803 * @image latex img/widget/ctxpopup/preview-00.eps
26805 * @brief Context popup widet.
26807 * A ctxpopup is a widget that, when shown, pops up a list of items.
26808 * It automatically chooses an area inside its parent object's view
26809 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26810 * optimally fit into it. In the default theme, it will also point an
26811 * arrow to it's top left position at the time one shows it. Ctxpopup
26812 * items have a label and/or an icon. It is intended for a small
26813 * number of items (hence the use of list, not genlist).
26815 * @note Ctxpopup is a especialization of @ref Hover.
26817 * Signals that you can add callbacks for are:
26818 * "dismissed" - the ctxpopup was dismissed
26820 * Default contents parts of the ctxpopup widget that you can use for are:
26821 * @li "default" - A content of the ctxpopup
26823 * Default contents parts of the naviframe items that you can use for are:
26824 * @li "icon" - A icon in the title area
26826 * Default text parts of the naviframe items that you can use for are:
26827 * @li "default" - Title label in the title area
26829 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26832 typedef enum _Elm_Ctxpopup_Direction
26834 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26836 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26837 the clicked area */
26838 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26839 the clicked area */
26840 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26842 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26843 } Elm_Ctxpopup_Direction;
26844 #define Elm_Ctxpopup_Item Elm_Object_Item
26847 * @brief Add a new Ctxpopup object to the parent.
26849 * @param parent Parent object
26850 * @return New object or @c NULL, if it cannot be created
26852 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26854 * @brief Set the Ctxpopup's parent
26856 * @param obj The ctxpopup object
26857 * @param area The parent to use
26859 * Set the parent object.
26861 * @note elm_ctxpopup_add() will automatically call this function
26862 * with its @c parent argument.
26864 * @see elm_ctxpopup_add()
26865 * @see elm_hover_parent_set()
26867 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26869 * @brief Get the Ctxpopup's parent
26871 * @param obj The ctxpopup object
26873 * @see elm_ctxpopup_hover_parent_set() for more information
26875 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26877 * @brief Clear all items in the given ctxpopup object.
26879 * @param obj Ctxpopup object
26881 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26883 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26885 * @param obj Ctxpopup object
26886 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26888 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26890 * @brief Get the value of current ctxpopup object's orientation.
26892 * @param obj Ctxpopup object
26893 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26895 * @see elm_ctxpopup_horizontal_set()
26897 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26899 * @brief Add a new item to a ctxpopup object.
26901 * @param obj Ctxpopup object
26902 * @param icon Icon to be set on new item
26903 * @param label The Label of the new item
26904 * @param func Convenience function called when item selected
26905 * @param data Data passed to @p func
26906 * @return A handle to the item added or @c NULL, on errors
26908 * @warning Ctxpopup can't hold both an item list and a content at the same
26909 * time. When an item is added, any previous content will be removed.
26911 * @see elm_ctxpopup_content_set()
26913 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);
26915 * @brief Delete the given item in a ctxpopup object.
26917 * @param it Ctxpopup item to be deleted
26919 * @see elm_ctxpopup_item_append()
26921 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26923 * @brief Set the ctxpopup item's state as disabled or enabled.
26925 * @param it Ctxpopup item to be enabled/disabled
26926 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26928 * When disabled the item is greyed out to indicate it's state.
26929 * @deprecated use elm_object_item_disabled_set() instead
26931 WILL_DEPRECATE EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26933 * @brief Get the ctxpopup item's disabled/enabled state.
26935 * @param it Ctxpopup item to be enabled/disabled
26936 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26938 * @see elm_ctxpopup_item_disabled_set()
26939 * @deprecated use elm_object_item_disabled_get() instead
26941 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26943 * @brief Get the icon object for the given ctxpopup item.
26945 * @param it Ctxpopup item
26946 * @return icon object or @c NULL, if the item does not have icon or an error
26949 * @see elm_ctxpopup_item_append()
26950 * @see elm_ctxpopup_item_icon_set()
26952 * @deprecated use elm_object_item_part_content_get() instead
26954 WILL_DEPRECATE EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26956 * @brief Sets the side icon associated with the ctxpopup item
26958 * @param it Ctxpopup item
26959 * @param icon Icon object to be set
26961 * Once the icon object is set, a previously set one will be deleted.
26962 * @warning Setting the same icon for two items will cause the icon to
26963 * dissapear from the first item.
26965 * @see elm_ctxpopup_item_append()
26967 * @deprecated use elm_object_item_part_content_set() instead
26970 WILL_DEPRECATE EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26972 * @brief Get the label for the given ctxpopup item.
26974 * @param it Ctxpopup item
26975 * @return label string or @c NULL, if the item does not have label or an
26978 * @see elm_ctxpopup_item_append()
26979 * @see elm_ctxpopup_item_label_set()
26981 * @deprecated use elm_object_item_text_get() instead
26983 WILL_DEPRECATE EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26985 * @brief (Re)set the label on the given ctxpopup item.
26987 * @param it Ctxpopup item
26988 * @param label String to set as label
26990 * @deprecated use elm_object_item_text_set() instead
26992 WILL_DEPRECATE EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26994 * @brief Set an elm widget as the content of the ctxpopup.
26996 * @param obj Ctxpopup object
26997 * @param content Content to be swallowed
26999 * If the content object is already set, a previous one will bedeleted. If
27000 * you want to keep that old content object, use the
27001 * elm_ctxpopup_content_unset() function.
27003 * @warning Ctxpopup can't hold both a item list and a content at the same
27004 * time. When a content is set, any previous items will be removed.
27006 * @deprecated use elm_object_content_set() instead
27009 WILL_DEPRECATE EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
27011 * @brief Unset the ctxpopup content
27013 * @param obj Ctxpopup object
27014 * @return The content that was being used
27016 * Unparent and return the content object which was set for this widget.
27018 * @deprecated use elm_object_content_unset()
27020 * @see elm_ctxpopup_content_set()
27022 * @deprecated use elm_object_content_unset() instead
27025 WILL_DEPRECATE EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
27027 * @brief Set the direction priority of a ctxpopup.
27029 * @param obj Ctxpopup object
27030 * @param first 1st priority of direction
27031 * @param second 2nd priority of direction
27032 * @param third 3th priority of direction
27033 * @param fourth 4th priority of direction
27035 * This functions gives a chance to user to set the priority of ctxpopup
27036 * showing direction. This doesn't guarantee the ctxpopup will appear in the
27037 * requested direction.
27039 * @see Elm_Ctxpopup_Direction
27041 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);
27043 * @brief Get the direction priority of a ctxpopup.
27045 * @param obj Ctxpopup object
27046 * @param first 1st priority of direction to be returned
27047 * @param second 2nd priority of direction to be returned
27048 * @param third 3th priority of direction to be returned
27049 * @param fourth 4th priority of direction to be returned
27051 * @see elm_ctxpopup_direction_priority_set() for more information.
27053 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);
27056 * @brief Get the current direction of a ctxpopup.
27058 * @param obj Ctxpopup object
27059 * @return current direction of a ctxpopup
27061 * @warning Once the ctxpopup showed up, the direction would be determined
27063 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27072 * @defgroup Transit Transit
27073 * @ingroup Elementary
27075 * Transit is designed to apply various animated transition effects to @c
27076 * Evas_Object, such like translation, rotation, etc. For using these
27077 * effects, create an @ref Elm_Transit and add the desired transition effects.
27079 * Once the effects are added into transit, they will be automatically
27080 * managed (their callback will be called until the duration is ended, and
27081 * they will be deleted on completion).
27085 * Elm_Transit *trans = elm_transit_add();
27086 * elm_transit_object_add(trans, obj);
27087 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27088 * elm_transit_duration_set(transit, 1);
27089 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27090 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27091 * elm_transit_repeat_times_set(transit, 3);
27094 * Some transition effects are used to change the properties of objects. They
27096 * @li @ref elm_transit_effect_translation_add
27097 * @li @ref elm_transit_effect_color_add
27098 * @li @ref elm_transit_effect_rotation_add
27099 * @li @ref elm_transit_effect_wipe_add
27100 * @li @ref elm_transit_effect_zoom_add
27101 * @li @ref elm_transit_effect_resizing_add
27103 * Other transition effects are used to make one object disappear and another
27104 * object appear on its old place. These effects are:
27106 * @li @ref elm_transit_effect_flip_add
27107 * @li @ref elm_transit_effect_resizable_flip_add
27108 * @li @ref elm_transit_effect_fade_add
27109 * @li @ref elm_transit_effect_blend_add
27111 * It's also possible to make a transition chain with @ref
27112 * elm_transit_chain_transit_add.
27114 * @warning We strongly recommend to use elm_transit just when edje can not do
27115 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27116 * animations can be manipulated inside the theme.
27118 * List of examples:
27119 * @li @ref transit_example_01_explained
27120 * @li @ref transit_example_02_explained
27121 * @li @ref transit_example_03_c
27122 * @li @ref transit_example_04_c
27128 * @enum Elm_Transit_Tween_Mode
27130 * The type of acceleration used in the transition.
27134 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27135 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27136 over time, then decrease again
27138 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27140 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27142 } Elm_Transit_Tween_Mode;
27145 * @enum Elm_Transit_Effect_Flip_Axis
27147 * The axis where flip effect should be applied.
27151 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27152 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27153 } Elm_Transit_Effect_Flip_Axis;
27155 * @enum Elm_Transit_Effect_Wipe_Dir
27157 * The direction where the wipe effect should occur.
27161 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27162 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27163 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27164 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27165 } Elm_Transit_Effect_Wipe_Dir;
27166 /** @enum Elm_Transit_Effect_Wipe_Type
27168 * Whether the wipe effect should show or hide the object.
27172 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27174 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27176 } Elm_Transit_Effect_Wipe_Type;
27179 * @typedef Elm_Transit
27181 * The Transit created with elm_transit_add(). This type has the information
27182 * about the objects which the transition will be applied, and the
27183 * transition effects that will be used. It also contains info about
27184 * duration, number of repetitions, auto-reverse, etc.
27186 typedef struct _Elm_Transit Elm_Transit;
27187 typedef void Elm_Transit_Effect;
27189 * @typedef Elm_Transit_Effect_Transition_Cb
27191 * Transition callback called for this effect on each transition iteration.
27193 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27195 * Elm_Transit_Effect_End_Cb
27197 * Transition callback called for this effect when the transition is over.
27199 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27202 * Elm_Transit_Del_Cb
27204 * A callback called when the transit is deleted.
27206 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27211 * @note Is not necessary to delete the transit object, it will be deleted at
27212 * the end of its operation.
27213 * @note The transit will start playing when the program enter in the main loop, is not
27214 * necessary to give a start to the transit.
27216 * @return The transit object.
27220 EAPI Elm_Transit *elm_transit_add(void);
27223 * Stops the animation and delete the @p transit object.
27225 * Call this function if you wants to stop the animation before the duration
27226 * time. Make sure the @p transit object is still alive with
27227 * elm_transit_del_cb_set() function.
27228 * All added effects will be deleted, calling its repective data_free_cb
27229 * functions. The function setted by elm_transit_del_cb_set() will be called.
27231 * @see elm_transit_del_cb_set()
27233 * @param transit The transit object to be deleted.
27236 * @warning Just call this function if you are sure the transit is alive.
27238 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27241 * Add a new effect to the transit.
27243 * @note The cb function and the data are the key to the effect. If you try to
27244 * add an already added effect, nothing is done.
27245 * @note After the first addition of an effect in @p transit, if its
27246 * effect list become empty again, the @p transit will be killed by
27247 * elm_transit_del(transit) function.
27251 * Elm_Transit *transit = elm_transit_add();
27252 * elm_transit_effect_add(transit,
27253 * elm_transit_effect_blend_op,
27254 * elm_transit_effect_blend_context_new(),
27255 * elm_transit_effect_blend_context_free);
27258 * @param transit The transit object.
27259 * @param transition_cb The operation function. It is called when the
27260 * animation begins, it is the function that actually performs the animation.
27261 * It is called with the @p data, @p transit and the time progression of the
27262 * animation (a double value between 0.0 and 1.0).
27263 * @param effect The context data of the effect.
27264 * @param end_cb The function to free the context data, it will be called
27265 * at the end of the effect, it must finalize the animation and free the
27269 * @warning The transit free the context data at the and of the transition with
27270 * the data_free_cb function, do not use the context data in another transit.
27272 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);
27275 * Delete an added effect.
27277 * This function will remove the effect from the @p transit, calling the
27278 * data_free_cb to free the @p data.
27280 * @see elm_transit_effect_add()
27282 * @note If the effect is not found, nothing is done.
27283 * @note If the effect list become empty, this function will call
27284 * elm_transit_del(transit), that is, it will kill the @p transit.
27286 * @param transit The transit object.
27287 * @param transition_cb The operation function.
27288 * @param effect The context data of the effect.
27292 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);
27295 * Add new object to apply the effects.
27297 * @note After the first addition of an object in @p transit, if its
27298 * object list become empty again, the @p transit will be killed by
27299 * elm_transit_del(transit) function.
27300 * @note If the @p obj belongs to another transit, the @p obj will be
27301 * removed from it and it will only belong to the @p transit. If the old
27302 * transit stays without objects, it will die.
27303 * @note When you add an object into the @p transit, its state from
27304 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27305 * transit ends, if you change this state whith evas_object_pass_events_set()
27306 * after add the object, this state will change again when @p transit stops to
27309 * @param transit The transit object.
27310 * @param obj Object to be animated.
27313 * @warning It is not allowed to add a new object after transit begins to go.
27315 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27318 * Removes an added object from the transit.
27320 * @note If the @p obj is not in the @p transit, nothing is done.
27321 * @note If the list become empty, this function will call
27322 * elm_transit_del(transit), that is, it will kill the @p transit.
27324 * @param transit The transit object.
27325 * @param obj Object to be removed from @p transit.
27328 * @warning It is not allowed to remove objects after transit begins to go.
27330 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27333 * Get the objects of the transit.
27335 * @param transit The transit object.
27336 * @return a Eina_List with the objects from the transit.
27340 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27343 * Enable/disable keeping up the objects states.
27344 * If it is not kept, the objects states will be reset when transition ends.
27346 * @note @p transit can not be NULL.
27347 * @note One state includes geometry, color, map data.
27349 * @param transit The transit object.
27350 * @param state_keep Keeping or Non Keeping.
27354 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27357 * Get a value whether the objects states will be reset or not.
27359 * @note @p transit can not be NULL
27361 * @see elm_transit_objects_final_state_keep_set()
27363 * @param transit The transit object.
27364 * @return EINA_TRUE means the states of the objects will be reset.
27365 * If @p transit is NULL, EINA_FALSE is returned
27369 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27372 * Set the event enabled when transit is operating.
27374 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27375 * events from mouse and keyboard during the animation.
27376 * @note When you add an object with elm_transit_object_add(), its state from
27377 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27378 * transit ends, if you change this state with evas_object_pass_events_set()
27379 * after adding the object, this state will change again when @p transit stops
27382 * @param transit The transit object.
27383 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27384 * ignored otherwise.
27388 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27391 * Get the value of event enabled status.
27393 * @see elm_transit_event_enabled_set()
27395 * @param transit The Transit object
27396 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27397 * EINA_FALSE is returned
27401 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27404 * Set the user-callback function when the transit is deleted.
27406 * @note Using this function twice will overwrite the first function setted.
27407 * @note the @p transit object will be deleted after call @p cb function.
27409 * @param transit The transit object.
27410 * @param cb Callback function pointer. This function will be called before
27411 * the deletion of the transit.
27412 * @param data Callback funtion user data. It is the @p op parameter.
27416 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27419 * Set reverse effect automatically.
27421 * If auto reverse is setted, after running the effects with the progress
27422 * parameter from 0 to 1, it will call the effecs again with the progress
27423 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27424 * where the duration was setted with the function elm_transit_add and
27425 * the repeat with the function elm_transit_repeat_times_set().
27427 * @param transit The transit object.
27428 * @param reverse EINA_TRUE means the auto_reverse is on.
27432 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27435 * Get if the auto reverse is on.
27437 * @see elm_transit_auto_reverse_set()
27439 * @param transit The transit object.
27440 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27441 * EINA_FALSE is returned
27445 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27448 * Set the transit repeat count. Effect will be repeated by repeat count.
27450 * This function sets the number of repetition the transit will run after
27451 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27452 * If the @p repeat is a negative number, it will repeat infinite times.
27454 * @note If this function is called during the transit execution, the transit
27455 * will run @p repeat times, ignoring the times it already performed.
27457 * @param transit The transit object
27458 * @param repeat Repeat count
27462 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27465 * Get the transit repeat count.
27467 * @see elm_transit_repeat_times_set()
27469 * @param transit The Transit object.
27470 * @return The repeat count. If @p transit is NULL
27475 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27478 * Set the transit animation acceleration type.
27480 * This function sets the tween mode of the transit that can be:
27481 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27482 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27483 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27484 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27486 * @param transit The transit object.
27487 * @param tween_mode The tween type.
27491 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27494 * Get the transit animation acceleration type.
27496 * @note @p transit can not be NULL
27498 * @param transit The transit object.
27499 * @return The tween type. If @p transit is NULL
27500 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27504 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27507 * Set the transit animation time
27509 * @note @p transit can not be NULL
27511 * @param transit The transit object.
27512 * @param duration The animation time.
27516 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27519 * Get the transit animation time
27521 * @note @p transit can not be NULL
27523 * @param transit The transit object.
27525 * @return The transit animation time.
27529 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27532 * Starts the transition.
27533 * Once this API is called, the transit begins to measure the time.
27535 * @note @p transit can not be NULL
27537 * @param transit The transit object.
27541 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27544 * Pause/Resume the transition.
27546 * If you call elm_transit_go again, the transit will be started from the
27547 * beginning, and will be unpaused.
27549 * @note @p transit can not be NULL
27551 * @param transit The transit object.
27552 * @param paused Whether the transition should be paused or not.
27556 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27559 * Get the value of paused status.
27561 * @see elm_transit_paused_set()
27563 * @note @p transit can not be NULL
27565 * @param transit The transit object.
27566 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27567 * EINA_FALSE is returned
27571 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27574 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27576 * The value returned is a fraction (current time / total time). It
27577 * represents the progression position relative to the total.
27579 * @note @p transit can not be NULL
27581 * @param transit The transit object.
27583 * @return The time progression value. If @p transit is NULL
27588 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27591 * Makes the chain relationship between two transits.
27593 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27594 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27596 * @param transit The transit object.
27597 * @param chain_transit The chain transit object. This transit will be operated
27598 * after transit is done.
27600 * This function adds @p chain_transit transition to a chain after the @p
27601 * transit, and will be started as soon as @p transit ends. See @ref
27602 * transit_example_02_explained for a full example.
27606 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27609 * Cut off the chain relationship between two transits.
27611 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27612 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27614 * @param transit The transit object.
27615 * @param chain_transit The chain transit object.
27617 * This function remove the @p chain_transit transition from the @p transit.
27621 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27624 * Get the current chain transit list.
27626 * @note @p transit can not be NULL.
27628 * @param transit The transit object.
27629 * @return chain transit list.
27633 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27636 * Add the Resizing Effect to Elm_Transit.
27638 * @note This API is one of the facades. It creates resizing effect context
27639 * and add it's required APIs to elm_transit_effect_add.
27641 * @see elm_transit_effect_add()
27643 * @param transit Transit object.
27644 * @param from_w Object width size when effect begins.
27645 * @param from_h Object height size when effect begins.
27646 * @param to_w Object width size when effect ends.
27647 * @param to_h Object height size when effect ends.
27648 * @return Resizing effect context data.
27652 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);
27655 * Add the Translation Effect to Elm_Transit.
27657 * @note This API is one of the facades. It creates translation effect context
27658 * and add it's required APIs to elm_transit_effect_add.
27660 * @see elm_transit_effect_add()
27662 * @param transit Transit object.
27663 * @param from_dx X Position variation when effect begins.
27664 * @param from_dy Y Position variation when effect begins.
27665 * @param to_dx X Position variation when effect ends.
27666 * @param to_dy Y Position variation when effect ends.
27667 * @return Translation effect context data.
27670 * @warning It is highly recommended just create a transit with this effect when
27671 * the window that the objects of the transit belongs has already been created.
27672 * This is because this effect needs the geometry information about the objects,
27673 * and if the window was not created yet, it can get a wrong information.
27675 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);
27678 * Add the Zoom Effect to Elm_Transit.
27680 * @note This API is one of the facades. It creates zoom effect context
27681 * and add it's required APIs to elm_transit_effect_add.
27683 * @see elm_transit_effect_add()
27685 * @param transit Transit object.
27686 * @param from_rate Scale rate when effect begins (1 is current rate).
27687 * @param to_rate Scale rate when effect ends.
27688 * @return Zoom effect context data.
27691 * @warning It is highly recommended just create a transit with this effect when
27692 * the window that the objects of the transit belongs has already been created.
27693 * This is because this effect needs the geometry information about the objects,
27694 * and if the window was not created yet, it can get a wrong information.
27696 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27699 * Add the Flip Effect to Elm_Transit.
27701 * @note This API is one of the facades. It creates flip effect context
27702 * and add it's required APIs to elm_transit_effect_add.
27703 * @note This effect is applied to each pair of objects in the order they are listed
27704 * in the transit list of objects. The first object in the pair will be the
27705 * "front" object and the second will be the "back" object.
27707 * @see elm_transit_effect_add()
27709 * @param transit Transit object.
27710 * @param axis Flipping Axis(X or Y).
27711 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27712 * @return Flip effect context data.
27715 * @warning It is highly recommended just create a transit with this effect when
27716 * the window that the objects of the transit belongs has already been created.
27717 * This is because this effect needs the geometry information about the objects,
27718 * and if the window was not created yet, it can get a wrong information.
27720 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27723 * Add the Resizable Flip Effect to Elm_Transit.
27725 * @note This API is one of the facades. It creates resizable flip effect context
27726 * and add it's required APIs to elm_transit_effect_add.
27727 * @note This effect is applied to each pair of objects in the order they are listed
27728 * in the transit list of objects. The first object in the pair will be the
27729 * "front" object and the second will be the "back" object.
27731 * @see elm_transit_effect_add()
27733 * @param transit Transit object.
27734 * @param axis Flipping Axis(X or Y).
27735 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27736 * @return Resizable flip effect context data.
27739 * @warning It is highly recommended just create a transit with this effect when
27740 * the window that the objects of the transit belongs has already been created.
27741 * This is because this effect needs the geometry information about the objects,
27742 * and if the window was not created yet, it can get a wrong information.
27744 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27747 * Add the Wipe Effect to Elm_Transit.
27749 * @note This API is one of the facades. It creates wipe effect context
27750 * and add it's required APIs to elm_transit_effect_add.
27752 * @see elm_transit_effect_add()
27754 * @param transit Transit object.
27755 * @param type Wipe type. Hide or show.
27756 * @param dir Wipe Direction.
27757 * @return Wipe effect context data.
27760 * @warning It is highly recommended just create a transit with this effect when
27761 * the window that the objects of the transit belongs has already been created.
27762 * This is because this effect needs the geometry information about the objects,
27763 * and if the window was not created yet, it can get a wrong information.
27765 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27768 * Add the Color Effect to Elm_Transit.
27770 * @note This API is one of the facades. It creates color effect context
27771 * and add it's required APIs to elm_transit_effect_add.
27773 * @see elm_transit_effect_add()
27775 * @param transit Transit object.
27776 * @param from_r RGB R when effect begins.
27777 * @param from_g RGB G when effect begins.
27778 * @param from_b RGB B when effect begins.
27779 * @param from_a RGB A when effect begins.
27780 * @param to_r RGB R when effect ends.
27781 * @param to_g RGB G when effect ends.
27782 * @param to_b RGB B when effect ends.
27783 * @param to_a RGB A when effect ends.
27784 * @return Color effect context data.
27788 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);
27791 * Add the Fade Effect to Elm_Transit.
27793 * @note This API is one of the facades. It creates fade effect context
27794 * and add it's required APIs to elm_transit_effect_add.
27795 * @note This effect is applied to each pair of objects in the order they are listed
27796 * in the transit list of objects. The first object in the pair will be the
27797 * "before" object and the second will be the "after" object.
27799 * @see elm_transit_effect_add()
27801 * @param transit Transit object.
27802 * @return Fade effect context data.
27805 * @warning It is highly recommended just create a transit with this effect when
27806 * the window that the objects of the transit belongs has already been created.
27807 * This is because this effect needs the color information about the objects,
27808 * and if the window was not created yet, it can get a wrong information.
27810 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27813 * Add the Blend Effect to Elm_Transit.
27815 * @note This API is one of the facades. It creates blend effect context
27816 * and add it's required APIs to elm_transit_effect_add.
27817 * @note This effect is applied to each pair of objects in the order they are listed
27818 * in the transit list of objects. The first object in the pair will be the
27819 * "before" object and the second will be the "after" object.
27821 * @see elm_transit_effect_add()
27823 * @param transit Transit object.
27824 * @return Blend effect context data.
27827 * @warning It is highly recommended just create a transit with this effect when
27828 * the window that the objects of the transit belongs has already been created.
27829 * This is because this effect needs the color information about the objects,
27830 * and if the window was not created yet, it can get a wrong information.
27832 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27835 * Add the Rotation Effect to Elm_Transit.
27837 * @note This API is one of the facades. It creates rotation effect context
27838 * and add it's required APIs to elm_transit_effect_add.
27840 * @see elm_transit_effect_add()
27842 * @param transit Transit object.
27843 * @param from_degree Degree when effect begins.
27844 * @param to_degree Degree when effect is ends.
27845 * @return Rotation effect context data.
27848 * @warning It is highly recommended just create a transit with this effect when
27849 * the window that the objects of the transit belongs has already been created.
27850 * This is because this effect needs the geometry information about the objects,
27851 * and if the window was not created yet, it can get a wrong information.
27853 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27856 * Add the ImageAnimation Effect to Elm_Transit.
27858 * @note This API is one of the facades. It creates image animation effect context
27859 * and add it's required APIs to elm_transit_effect_add.
27860 * The @p images parameter is a list images paths. This list and
27861 * its contents will be deleted at the end of the effect by
27862 * elm_transit_effect_image_animation_context_free() function.
27866 * char buf[PATH_MAX];
27867 * Eina_List *images = NULL;
27868 * Elm_Transit *transi = elm_transit_add();
27870 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27871 * images = eina_list_append(images, eina_stringshare_add(buf));
27873 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27874 * images = eina_list_append(images, eina_stringshare_add(buf));
27875 * elm_transit_effect_image_animation_add(transi, images);
27879 * @see elm_transit_effect_add()
27881 * @param transit Transit object.
27882 * @param images Eina_List of images file paths. This list and
27883 * its contents will be deleted at the end of the effect by
27884 * elm_transit_effect_image_animation_context_free() function.
27885 * @return Image Animation effect context data.
27889 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27895 typedef struct _Elm_Store Elm_Store;
27896 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27897 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27898 typedef struct _Elm_Store_Item Elm_Store_Item;
27899 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27900 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27901 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27902 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27903 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27904 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27905 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27906 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27907 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27909 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27910 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27911 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27912 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27913 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27914 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27915 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27919 ELM_STORE_ITEM_MAPPING_NONE = 0,
27920 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27921 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27922 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27923 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27924 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27925 // can add more here as needed by common apps
27926 ELM_STORE_ITEM_MAPPING_LAST
27927 } Elm_Store_Item_Mapping_Type;
27929 struct _Elm_Store_Item_Mapping_Icon
27931 // FIXME: allow edje file icons
27933 Elm_Icon_Lookup_Order lookup_order;
27934 Eina_Bool standard_name : 1;
27935 Eina_Bool no_scale : 1;
27936 Eina_Bool smooth : 1;
27937 Eina_Bool scale_up : 1;
27938 Eina_Bool scale_down : 1;
27941 struct _Elm_Store_Item_Mapping_Empty
27946 struct _Elm_Store_Item_Mapping_Photo
27951 struct _Elm_Store_Item_Mapping_Custom
27953 Elm_Store_Item_Mapping_Cb func;
27956 struct _Elm_Store_Item_Mapping
27958 Elm_Store_Item_Mapping_Type type;
27963 Elm_Store_Item_Mapping_Empty empty;
27964 Elm_Store_Item_Mapping_Icon icon;
27965 Elm_Store_Item_Mapping_Photo photo;
27966 Elm_Store_Item_Mapping_Custom custom;
27967 // add more types here
27971 struct _Elm_Store_Item_Info
27976 Eina_Bool rec_item;
27977 int pre_group_index;
27979 Elm_Genlist_Item_Class *item_class;
27980 const Elm_Store_Item_Mapping *mapping;
27985 struct _Elm_Store_Item_Info_Filesystem
27987 Elm_Store_Item_Info base;
27991 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27992 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27995 * dbsystem Store object
27997 * @addtogroup DBStore
28000 * @return The new object or NULL if it cannot be created
28002 EAPI Elm_Store *elm_store_dbsystem_new(void);
28004 * Sets the item count of a store
28006 * @param st The store object
28007 * @param count The item count of an store
28009 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
28011 * Set the select func that select the state of a list item whether true or false
28013 * @param st The store object
28014 * @param func The select cb function of an store
28015 * @param data The new data pointer to set
28017 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
28019 * Sets the sort func that sort the item with a next in the list
28021 * @param st The store object
28022 * @param func The sort cb function of an store
28023 * @param data The new data pointer to set
28025 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
28027 * Set the store item free func
28029 * @param st The store object
28030 * @param func The free cb function of an store
28031 * @param data The new data pointer to set
28033 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
28035 * Get the item index that included header items
28037 * @param sti The store item object
28038 * @return The item index in genlist
28040 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28042 * Get the DB pointer of an item
28044 * @param sti The store item object
28045 * @return The DB pointer of item
28047 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28049 * Set the DB pointer of an item
28051 * @param sti The store item object
28052 * @parm p_db The DB pointer of item
28054 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
28057 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28059 * Append the item to the genlist
28061 * @param st The store object
28062 * @param info The store item info dbsystem object
28063 * @return The item of store
28065 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
28067 * Realize the visible items to the screen
28069 * @param st The store object
28071 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28073 * Realize the item to the screen
28075 * @param sti The store item object
28077 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
28079 * Delete the item of genlist
28081 * @param sti The store item object
28083 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28084 EAPI void elm_store_free(Elm_Store *st);
28085 EAPI Elm_Store *elm_store_filesystem_new(void);
28086 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28087 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28088 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28090 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28092 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28093 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28094 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28095 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28096 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28097 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28099 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28100 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28101 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28102 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28103 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28104 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28105 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28111 * @defgroup SegmentControl SegmentControl
28112 * @ingroup Elementary
28114 * @image html img/widget/segment_control/preview-00.png
28115 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
28117 * @image html img/segment_control.png
28118 * @image latex img/segment_control.eps width=\textwidth
28120 * Segment control widget is a horizontal control made of multiple segment
28121 * items, each segment item functioning similar to discrete two state button.
28122 * A segment control groups the items together and provides compact
28123 * single button with multiple equal size segments.
28125 * Segment item size is determined by base widget
28126 * size and the number of items added.
28127 * Only one segment item can be at selected state. A segment item can display
28128 * combination of Text and any Evas_Object like Images or other widget.
28130 * Smart callbacks one can listen to:
28131 * - "changed" - When the user clicks on a segment item which is not
28132 * previously selected and get selected. The event_info parameter is the
28133 * segment item pointer.
28135 * Available styles for it:
28138 * Here is an example on its usage:
28139 * @li @ref segment_control_example
28143 * @addtogroup SegmentControl
28147 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28150 * Add a new segment control widget to the given parent Elementary
28151 * (container) object.
28153 * @param parent The parent object.
28154 * @return a new segment control widget handle or @c NULL, on errors.
28156 * This function inserts a new segment control widget on the canvas.
28158 * @ingroup SegmentControl
28160 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28163 * Append a new item to the segment control object.
28165 * @param obj The segment control object.
28166 * @param icon The icon object to use for the left side of the item. An
28167 * icon can be any Evas object, but usually it is an icon created
28168 * with elm_icon_add().
28169 * @param label The label of the item.
28170 * Note that, NULL is different from empty string "".
28171 * @return The created item or @c NULL upon failure.
28173 * A new item will be created and appended to the segment control, i.e., will
28174 * be set as @b last item.
28176 * If it should be inserted at another position,
28177 * elm_segment_control_item_insert_at() should be used instead.
28179 * Items created with this function can be deleted with function
28180 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28182 * @note @p label set to @c NULL is different from empty string "".
28184 * only has icon, it will be displayed bigger and centered. If it has
28185 * icon and label, even that an empty string, icon will be smaller and
28186 * positioned at left.
28190 * sc = elm_segment_control_add(win);
28191 * ic = elm_icon_add(win);
28192 * elm_icon_file_set(ic, "path/to/image", NULL);
28193 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28194 * elm_segment_control_item_add(sc, ic, "label");
28195 * evas_object_show(sc);
28198 * @see elm_segment_control_item_insert_at()
28199 * @see elm_segment_control_item_del()
28201 * @ingroup SegmentControl
28203 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28206 * Insert a new item to the segment control object at specified position.
28208 * @param obj The segment control object.
28209 * @param icon The icon object to use for the left side of the item. An
28210 * icon can be any Evas object, but usually it is an icon created
28211 * with elm_icon_add().
28212 * @param label The label of the item.
28213 * @param index Item position. Value should be between 0 and items count.
28214 * @return The created item or @c NULL upon failure.
28216 * Index values must be between @c 0, when item will be prepended to
28217 * segment control, and items count, that can be get with
28218 * elm_segment_control_item_count_get(), case when item will be appended
28219 * to segment control, just like elm_segment_control_item_add().
28221 * Items created with this function can be deleted with function
28222 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28224 * @note @p label set to @c NULL is different from empty string "".
28226 * only has icon, it will be displayed bigger and centered. If it has
28227 * icon and label, even that an empty string, icon will be smaller and
28228 * positioned at left.
28230 * @see elm_segment_control_item_add()
28231 * @see elm_segment_control_item_count_get()
28232 * @see elm_segment_control_item_del()
28234 * @ingroup SegmentControl
28236 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);
28239 * Remove a segment control item from its parent, deleting it.
28241 * @param it The item to be removed.
28243 * Items can be added with elm_segment_control_item_add() or
28244 * elm_segment_control_item_insert_at().
28246 * @ingroup SegmentControl
28248 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28251 * Remove a segment control item at given index from its parent,
28254 * @param obj The segment control object.
28255 * @param index The position of the segment control item to be deleted.
28257 * Items can be added with elm_segment_control_item_add() or
28258 * elm_segment_control_item_insert_at().
28260 * @ingroup SegmentControl
28262 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28265 * Get the Segment items count from segment control.
28267 * @param obj The segment control object.
28268 * @return Segment items count.
28270 * It will just return the number of items added to segment control @p obj.
28272 * @ingroup SegmentControl
28274 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28277 * Get the item placed at specified index.
28279 * @param obj The segment control object.
28280 * @param index The index of the segment item.
28281 * @return The segment control item or @c NULL on failure.
28283 * Index is the position of an item in segment control widget. Its
28284 * range is from @c 0 to <tt> count - 1 </tt>.
28285 * Count is the number of items, that can be get with
28286 * elm_segment_control_item_count_get().
28288 * @ingroup SegmentControl
28290 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28293 * Get the label of item.
28295 * @param obj The segment control object.
28296 * @param index The index of the segment item.
28297 * @return The label of the item at @p index.
28299 * The return value is a pointer to the label associated to the item when
28300 * it was created, with function elm_segment_control_item_add(), or later
28301 * with function elm_segment_control_item_label_set. If no label
28302 * was passed as argument, it will return @c NULL.
28304 * @see elm_segment_control_item_label_set() for more details.
28305 * @see elm_segment_control_item_add()
28307 * @ingroup SegmentControl
28309 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28312 * Set the label of item.
28314 * @param it The item of segment control.
28315 * @param text The label of item.
28317 * The label to be displayed by the item.
28318 * Label will be at right of the icon (if set).
28320 * If a label was passed as argument on item creation, with function
28321 * elm_control_segment_item_add(), it will be already
28322 * displayed by the item.
28324 * @see elm_segment_control_item_label_get()
28325 * @see elm_segment_control_item_add()
28327 * @ingroup SegmentControl
28329 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28332 * Get the icon associated to the item.
28334 * @param obj The segment control object.
28335 * @param index The index of the segment item.
28336 * @return The left side icon associated to the item at @p index.
28338 * The return value is a pointer to the icon associated to the item when
28339 * it was created, with function elm_segment_control_item_add(), or later
28340 * with function elm_segment_control_item_icon_set(). If no icon
28341 * was passed as argument, it will return @c NULL.
28343 * @see elm_segment_control_item_add()
28344 * @see elm_segment_control_item_icon_set()
28346 * @ingroup SegmentControl
28348 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28351 * Set the icon associated to the item.
28353 * @param it The segment control item.
28354 * @param icon The icon object to associate with @p it.
28356 * The icon object to use at left side of the item. An
28357 * icon can be any Evas object, but usually it is an icon created
28358 * with elm_icon_add().
28360 * Once the icon object is set, a previously set one will be deleted.
28361 * @warning Setting the same icon for two items will cause the icon to
28362 * dissapear from the first item.
28364 * If an icon was passed as argument on item creation, with function
28365 * elm_segment_control_item_add(), it will be already
28366 * associated to the item.
28368 * @see elm_segment_control_item_add()
28369 * @see elm_segment_control_item_icon_get()
28371 * @ingroup SegmentControl
28373 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28376 * Get the index of an item.
28378 * @param it The segment control item.
28379 * @return The position of item in segment control widget.
28381 * Index is the position of an item in segment control widget. Its
28382 * range is from @c 0 to <tt> count - 1 </tt>.
28383 * Count is the number of items, that can be get with
28384 * elm_segment_control_item_count_get().
28386 * @ingroup SegmentControl
28388 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28391 * Get the base object of the item.
28393 * @param it The segment control item.
28394 * @return The base object associated with @p it.
28396 * Base object is the @c Evas_Object that represents that item.
28398 * @ingroup SegmentControl
28400 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28403 * Get the selected item.
28405 * @param obj The segment control object.
28406 * @return The selected item or @c NULL if none of segment items is
28409 * The selected item can be unselected with function
28410 * elm_segment_control_item_selected_set().
28412 * The selected item always will be highlighted on segment control.
28414 * @ingroup SegmentControl
28416 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28419 * Set the selected state of an item.
28421 * @param it The segment control item
28422 * @param select The selected state
28424 * This sets the selected state of the given item @p it.
28425 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28427 * If a new item is selected the previosly selected will be unselected.
28428 * Previoulsy selected item can be get with function
28429 * elm_segment_control_item_selected_get().
28431 * The selected item always will be highlighted on segment control.
28433 * @see elm_segment_control_item_selected_get()
28435 * @ingroup SegmentControl
28437 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28444 * @defgroup Grid Grid
28446 * The grid is a grid layout widget that lays out a series of children as a
28447 * fixed "grid" of widgets using a given percentage of the grid width and
28448 * height each using the child object.
28450 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28451 * widgets size itself. The default is 100 x 100, so that means the
28452 * position and sizes of children will effectively be percentages (0 to 100)
28453 * of the width or height of the grid widget
28459 * Add a new grid to the parent
28461 * @param parent The parent object
28462 * @return The new object or NULL if it cannot be created
28466 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28469 * Set the virtual size of the grid
28471 * @param obj The grid object
28472 * @param w The virtual width of the grid
28473 * @param h The virtual height of the grid
28477 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28480 * Get the virtual size of the grid
28482 * @param obj The grid object
28483 * @param w Pointer to integer to store the virtual width of the grid
28484 * @param h Pointer to integer to store the virtual height of the grid
28488 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28491 * Pack child at given position and size
28493 * @param obj The grid object
28494 * @param subobj The child to pack
28495 * @param x The virtual x coord at which to pack it
28496 * @param y The virtual y coord at which to pack it
28497 * @param w The virtual width at which to pack it
28498 * @param h The virtual height at which to pack it
28502 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28505 * Unpack a child from a grid object
28507 * @param obj The grid object
28508 * @param subobj The child to unpack
28512 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28515 * Faster way to remove all child objects from a grid object.
28517 * @param obj The grid object
28518 * @param clear If true, it will delete just removed children
28522 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28525 * Set packing of an existing child at to position and size
28527 * @param subobj The child to set packing of
28528 * @param x The virtual x coord at which to pack it
28529 * @param y The virtual y coord at which to pack it
28530 * @param w The virtual width at which to pack it
28531 * @param h The virtual height at which to pack it
28535 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28538 * get packing of a child
28540 * @param subobj The child to query
28541 * @param x Pointer to integer to store the virtual x coord
28542 * @param y Pointer to integer to store the virtual y coord
28543 * @param w Pointer to integer to store the virtual width
28544 * @param h Pointer to integer to store the virtual height
28548 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28554 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28555 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28556 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28557 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28558 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28559 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28562 * @defgroup Video Video
28564 * @addtogroup Video
28567 * Elementary comes with two object that help design application that need
28568 * to display video. The main one, Elm_Video, display a video by using Emotion.
28569 * It does embedded the video inside an Edje object, so you can do some
28570 * animation depending on the video state change. It does also implement a
28571 * ressource management policy to remove this burden from the application writer.
28573 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28574 * It take care of updating its content according to Emotion event and provide a
28575 * way to theme itself. It also does automatically raise the priority of the
28576 * linked Elm_Video so it will use the video decoder if available. It also does
28577 * activate the remember function on the linked Elm_Video object.
28579 * Signals that you can add callback for are :
28581 * "forward,clicked" - the user clicked the forward button.
28582 * "info,clicked" - the user clicked the info button.
28583 * "next,clicked" - the user clicked the next button.
28584 * "pause,clicked" - the user clicked the pause button.
28585 * "play,clicked" - the user clicked the play button.
28586 * "prev,clicked" - the user clicked the prev button.
28587 * "rewind,clicked" - the user clicked the rewind button.
28588 * "stop,clicked" - the user clicked the stop button.
28590 * Default contents parts of the player widget that you can use for are:
28591 * @li "video" - A video of the player
28596 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28598 * @param parent The parent object
28599 * @return a new player widget handle or @c NULL, on errors.
28601 * This function inserts a new player widget on the canvas.
28603 * @see elm_object_part_content_set()
28607 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28610 * @brief Link a Elm_Payer with an Elm_Video object.
28612 * @param player the Elm_Player object.
28613 * @param video The Elm_Video object.
28615 * This mean that action on the player widget will affect the
28616 * video object and the state of the video will be reflected in
28617 * the player itself.
28619 * @see elm_player_add()
28620 * @see elm_video_add()
28621 * @deprecated use elm_object_part_content_set() instead
28625 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28628 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28630 * @param parent The parent object
28631 * @return a new video widget handle or @c NULL, on errors.
28633 * This function inserts a new video widget on the canvas.
28635 * @seeelm_video_file_set()
28636 * @see elm_video_uri_set()
28640 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28643 * @brief Define the file that will be the video source.
28645 * @param video The video object to define the file for.
28646 * @param filename The file to target.
28648 * This function will explicitly define a filename as a source
28649 * for the video of the Elm_Video object.
28651 * @see elm_video_uri_set()
28652 * @see elm_video_add()
28653 * @see elm_player_add()
28657 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28660 * @brief Define the uri that will be the video source.
28662 * @param video The video object to define the file for.
28663 * @param uri The uri to target.
28665 * This function will define an uri as a source for the video of the
28666 * Elm_Video object. URI could be remote source of video, like http:// or local source
28667 * like for example WebCam who are most of the time v4l2:// (but that depend and
28668 * you should use Emotion API to request and list the available Webcam on your system).
28670 * @see elm_video_file_set()
28671 * @see elm_video_add()
28672 * @see elm_player_add()
28676 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28679 * @brief Get the underlying Emotion object.
28681 * @param video The video object to proceed the request on.
28682 * @return the underlying Emotion object.
28686 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28689 * @brief Start to play the video
28691 * @param video The video object to proceed the request on.
28693 * Start to play the video and cancel all suspend state.
28697 EAPI void elm_video_play(Evas_Object *video);
28700 * @brief Pause the video
28702 * @param video The video object to proceed the request on.
28704 * Pause the video and start a timer to trigger suspend mode.
28708 EAPI void elm_video_pause(Evas_Object *video);
28711 * @brief Stop the video
28713 * @param video The video object to proceed the request on.
28715 * Stop the video and put the emotion in deep sleep mode.
28719 EAPI void elm_video_stop(Evas_Object *video);
28722 * @brief Is the video actually playing.
28724 * @param video The video object to proceed the request on.
28725 * @return EINA_TRUE if the video is actually playing.
28727 * You should consider watching event on the object instead of polling
28728 * the object state.
28732 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28735 * @brief Is it possible to seek inside the video.
28737 * @param video The video object to proceed the request on.
28738 * @return EINA_TRUE if is possible to seek inside the video.
28742 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28745 * @brief Is the audio muted.
28747 * @param video The video object to proceed the request on.
28748 * @return EINA_TRUE if the audio is muted.
28752 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28755 * @brief Change the mute state of the Elm_Video object.
28757 * @param video The video object to proceed the request on.
28758 * @param mute The new mute state.
28762 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28765 * @brief Get the audio level of the current video.
28767 * @param video The video object to proceed the request on.
28768 * @return the current audio level.
28772 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28775 * @brief Set the audio level of anElm_Video object.
28777 * @param video The video object to proceed the request on.
28778 * @param volume The new audio volume.
28782 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28784 EAPI double elm_video_play_position_get(const Evas_Object *video);
28785 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28786 EAPI double elm_video_play_length_get(const Evas_Object *video);
28787 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28788 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28789 EAPI const char *elm_video_title_get(const Evas_Object *video);
28794 // FIXME: incomplete - carousel. don't use this until this comment is removed
28795 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28796 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28797 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28798 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28799 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28800 /* smart callbacks called:
28801 * "clicked" - when the user clicks on a carousel item and becomes selected
28806 typedef enum _Elm_Datefield_ItemType
28808 ELM_DATEFIELD_YEAR = 0,
28809 ELM_DATEFIELD_MONTH,
28810 ELM_DATEFIELD_DATE,
28811 ELM_DATEFIELD_HOUR,
28812 ELM_DATEFIELD_MINUTE,
28814 } Elm_Datefield_ItemType;
28816 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28817 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28818 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28819 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28820 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28821 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28822 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28823 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28824 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28825 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28826 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28827 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28828 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28830 /* smart callbacks called:
28831 * "changed" - when datefield value is changed, this signal is sent.
28834 ////////////////////// DEPRECATED ///////////////////////////////////
28836 typedef enum _Elm_Datefield_Layout
28838 ELM_DATEFIELD_LAYOUT_TIME,
28839 ELM_DATEFIELD_LAYOUT_DATE,
28840 ELM_DATEFIELD_LAYOUT_DATEANDTIME
28841 } Elm_Datefield_Layout;
28843 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28844 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28845 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28846 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
28847 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28848 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
28849 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28850 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28851 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28852 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28853 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28854 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28855 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28856 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28857 /////////////////////////////////////////////////////////////////////
28860 typedef enum _Elm_Popup_Response
28862 ELM_POPUP_RESPONSE_NONE = -1,
28863 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28864 ELM_POPUP_RESPONSE_OK = -3,
28865 ELM_POPUP_RESPONSE_CANCEL = -4,
28866 ELM_POPUP_RESPONSE_CLOSE = -5
28867 } Elm_Popup_Response;
28869 typedef enum _Elm_Popup_Mode
28871 ELM_POPUP_TYPE_NONE = 0,
28872 ELM_POPUP_TYPE_ALERT = (1 << 0)
28875 typedef enum _Elm_Popup_Orient
28877 ELM_POPUP_ORIENT_TOP,
28878 ELM_POPUP_ORIENT_CENTER,
28879 ELM_POPUP_ORIENT_BOTTOM,
28880 ELM_POPUP_ORIENT_LEFT,
28881 ELM_POPUP_ORIENT_RIGHT,
28882 ELM_POPUP_ORIENT_TOP_LEFT,
28883 ELM_POPUP_ORIENT_TOP_RIGHT,
28884 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28885 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28886 } Elm_Popup_Orient;
28888 /* smart callbacks called:
28889 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28892 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28893 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28894 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28895 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28896 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28897 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28898 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28899 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28900 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28901 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28902 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28903 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28904 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28905 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28906 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28907 EAPI int elm_popup_run(Evas_Object *obj);
28910 * @defgroup Naviframe Naviframe
28911 * @ingroup Elementary
28913 * @brief Naviframe is a kind of view manager for the applications.
28915 * Naviframe provides functions to switch different pages with stack
28916 * mechanism. It means if one page(item) needs to be changed to the new one,
28917 * then naviframe would push the new page to it's internal stack. Of course,
28918 * it can be back to the previous page by popping the top page. Naviframe
28919 * provides some transition effect while the pages are switching (same as
28922 * Since each item could keep the different styles, users could keep the
28923 * same look & feel for the pages or different styles for the items in it's
28926 * Signals that you can add callback for are:
28927 * @li "transition,finished" - When the transition is finished in changing
28929 * @li "title,clicked" - User clicked title area
28931 * Default contents parts of the naviframe items that you can use for are:
28932 * @li "default" - A main content of the page
28933 * @li "icon" - A icon in the title area
28934 * @li "prev_btn" - A button to go to the previous page
28935 * @li "next_btn" - A button to go to the next page
28937 * Default text parts of the naviframe items that you can use for are:
28938 * @li "default" - Title label in the title area
28939 * @li "subtitle" - Sub-title label in the title area
28941 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28944 //Available commonly
28945 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28946 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28947 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28948 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28949 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28950 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28951 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28952 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28953 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28954 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28955 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28956 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28957 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28958 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28959 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28960 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28961 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28963 //Available only in a style - "2line"
28964 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28966 //Available only in a style - "segment"
28967 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28968 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28971 * @addtogroup Naviframe
28976 * @brief Add a new Naviframe object to the parent.
28978 * @param parent Parent object
28979 * @return New object or @c NULL, if it cannot be created
28981 * @ingroup Naviframe
28983 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28985 * @brief Push a new item to the top of the naviframe stack (and show it).
28987 * @param obj The naviframe object
28988 * @param title_label The label in the title area. The name of the title
28989 * label part is "elm.text.title"
28990 * @param prev_btn The button to go to the previous item. If it is NULL,
28991 * then naviframe will create a back button automatically. The name of
28992 * the prev_btn part is "elm.swallow.prev_btn"
28993 * @param next_btn The button to go to the next item. Or It could be just an
28994 * extra function button. The name of the next_btn part is
28995 * "elm.swallow.next_btn"
28996 * @param content The main content object. The name of content part is
28997 * "elm.swallow.content"
28998 * @param item_style The current item style name. @c NULL would be default.
28999 * @return The created item or @c NULL upon failure.
29001 * The item pushed becomes one page of the naviframe, this item will be
29002 * deleted when it is popped.
29004 * @see also elm_naviframe_item_style_set()
29005 * @see also elm_naviframe_item_insert_before()
29006 * @see also elm_naviframe_item_insert_after()
29008 * The following styles are available for this item:
29011 * @ingroup Naviframe
29013 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);
29015 * @brief Insert a new item into the naviframe before item @p before.
29017 * @param before The naviframe item to insert before.
29018 * @param title_label The label in the title area. The name of the title
29019 * label part is "elm.text.title"
29020 * @param prev_btn The button to go to the previous item. If it is NULL,
29021 * then naviframe will create a back button automatically. The name of
29022 * the prev_btn part is "elm.swallow.prev_btn"
29023 * @param next_btn The button to go to the next item. Or It could be just an
29024 * extra function button. The name of the next_btn part is
29025 * "elm.swallow.next_btn"
29026 * @param content The main content object. The name of content part is
29027 * "elm.swallow.content"
29028 * @param item_style The current item style name. @c NULL would be default.
29029 * @return The created item or @c NULL upon failure.
29031 * The item is inserted into the naviframe straight away without any
29032 * transition operations. This item will be deleted when it is popped.
29034 * @see also elm_naviframe_item_style_set()
29035 * @see also elm_naviframe_item_push()
29036 * @see also elm_naviframe_item_insert_after()
29038 * The following styles are available for this item:
29041 * @ingroup Naviframe
29043 EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
29045 * @brief Insert a new item into the naviframe after item @p after.
29047 * @param after The naviframe item to insert after.
29048 * @param title_label The label in the title area. The name of the title
29049 * label part is "elm.text.title"
29050 * @param prev_btn The button to go to the previous item. If it is NULL,
29051 * then naviframe will create a back button automatically. The name of
29052 * the prev_btn part is "elm.swallow.prev_btn"
29053 * @param next_btn The button to go to the next item. Or It could be just an
29054 * extra function button. The name of the next_btn part is
29055 * "elm.swallow.next_btn"
29056 * @param content The main content object. The name of content part is
29057 * "elm.swallow.content"
29058 * @param item_style The current item style name. @c NULL would be default.
29059 * @return The created item or @c NULL upon failure.
29061 * The item is inserted into the naviframe straight away without any
29062 * transition operations. This item will be deleted when it is popped.
29064 * @see also elm_naviframe_item_style_set()
29065 * @see also elm_naviframe_item_push()
29066 * @see also elm_naviframe_item_insert_before()
29068 * The following styles are available for this item:
29071 * @ingroup Naviframe
29073 EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
29075 * @brief Pop an item that is on top of the stack
29077 * @param obj The naviframe object
29078 * @return @c NULL or the content object(if the
29079 * elm_naviframe_content_preserve_on_pop_get is true).
29081 * This pops an item that is on the top(visible) of the naviframe, makes it
29082 * disappear, then deletes the item. The item that was underneath it on the
29083 * stack will become visible.
29085 * @see also elm_naviframe_content_preserve_on_pop_get()
29087 * @ingroup Naviframe
29089 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29091 * @brief Pop the items between the top and the above one on the given item.
29093 * @param it The naviframe item
29095 * @ingroup Naviframe
29097 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29099 * Promote an item already in the naviframe stack to the top of the stack
29101 * @param it The naviframe item
29103 * This will take the indicated item and promote it to the top of the stack
29104 * as if it had been pushed there. The item must already be inside the
29105 * naviframe stack to work.
29108 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29110 * @brief Delete the given item instantly.
29112 * @param it The naviframe item
29114 * This just deletes the given item from the naviframe item list instantly.
29115 * So this would not emit any signals for view transitions but just change
29116 * the current view if the given item is a top one.
29118 * @ingroup Naviframe
29120 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29122 * @brief preserve the content objects when items are popped.
29124 * @param obj The naviframe object
29125 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29127 * @see also elm_naviframe_content_preserve_on_pop_get()
29129 * @ingroup Naviframe
29131 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29133 * @brief Get a value whether preserve mode is enabled or not.
29135 * @param obj The naviframe object
29136 * @return If @c EINA_TRUE, preserve mode is enabled
29138 * @see also elm_naviframe_content_preserve_on_pop_set()
29140 * @ingroup Naviframe
29142 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29144 * @brief Get a top item on the naviframe stack
29146 * @param obj The naviframe object
29147 * @return The top item on the naviframe stack or @c NULL, if the stack is
29150 * @ingroup Naviframe
29152 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29154 * @brief Get a bottom item on the naviframe stack
29156 * @param obj The naviframe object
29157 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29160 * @ingroup Naviframe
29162 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29164 * @brief Set an item style
29166 * @param obj The naviframe item
29167 * @param item_style The current item style name. @c NULL would be default
29169 * The following styles are available for this item:
29172 * @see also elm_naviframe_item_style_get()
29174 * @ingroup Naviframe
29176 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29178 * @brief Get an item style
29180 * @param obj The naviframe item
29181 * @return The current item style name
29183 * @see also elm_naviframe_item_style_set()
29185 * @ingroup Naviframe
29187 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29189 * @brief Show/Hide the title area
29191 * @param it The naviframe item
29192 * @param visible If @c EINA_TRUE, title area will be visible, hidden
29195 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
29197 * @see also elm_naviframe_item_title_visible_get()
29199 * @ingroup Naviframe
29201 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29203 * @brief Get a value whether title area is visible or not.
29205 * @param it The naviframe item
29206 * @return If @c EINA_TRUE, title area is visible
29208 * @see also elm_naviframe_item_title_visible_set()
29210 * @ingroup Naviframe
29212 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29215 * @brief Set creating prev button automatically or not
29217 * @param obj The naviframe object
29218 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29219 * be created internally when you pass the @c NULL to the prev_btn
29220 * parameter in elm_naviframe_item_push
29222 * @see also elm_naviframe_item_push()
29224 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29226 * @brief Get a value whether prev button(back button) will be auto pushed or
29229 * @param obj The naviframe object
29230 * @return If @c EINA_TRUE, prev button will be auto pushed.
29232 * @see also elm_naviframe_item_push()
29233 * elm_naviframe_prev_btn_auto_pushed_set()
29235 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29237 * @brief Get a list of all the naviframe items.
29239 * @param obj The naviframe object
29240 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29241 * or @c NULL on failure.
29243 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29250 * @defgroup Controlbar Controlbar
29251 * @ingroup Elementary
29252 * @addtogroup Controlbar
29255 * This is a Controlbar. It can contain label and icon objects.
29256 * In edit mode, you can change the location of items.
29260 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29261 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29262 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29263 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29264 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29265 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29266 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29267 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29268 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29270 typedef enum _Elm_Controlbar_Mode_Type
29272 ELM_CONTROLBAR_MODE_DEFAULT = 0,
29273 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29274 ELM_CONTROLBAR_MODE_TRANSPARENCY,
29275 ELM_CONTROLBAR_MODE_LARGE,
29276 ELM_CONTROLBAR_MODE_SMALL,
29277 ELM_CONTROLBAR_MODE_LEFT,
29278 ELM_CONTROLBAR_MODE_RIGHT
29279 } Elm_Controlbar_Mode_Type;
29281 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29283 * Add a new controlbar object
29285 * @param parent The parent object
29286 * @return The new object or NULL if it cannot be created
29288 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29290 * Append new tab item
29292 * @param obj The controlbar object
29293 * @param icon_path The icon path of item
29294 * @param label The label of item
29295 * @param view The view of item
29296 * @return The item of controlbar
29298 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29300 * Prepend new tab item
29302 * @param obj The controlbar object
29303 * @param icon_path The icon path of item
29304 * @param label The label of item
29305 * @param view The view of item
29306 * @return The item of controlbar
29308 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29310 * Insert new tab item before given item
29312 * @param obj The controlbar object
29313 * @param before The given item
29314 * @param icon_path The icon path of item
29315 * @param label The label of item
29316 * @param view The view of item
29317 * @return The item of controlbar
29319 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
29321 * Insert new tab item after given item
29323 * @param obj The controlbar object
29324 * @param after The given item
29325 * @param icon_path The icon path of item
29326 * @param label The label of item
29327 * @param view The view of item
29328 * @return The item of controlbar
29330 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
29332 * Append new tool item
29334 * @param obj The controlbar object
29335 * @param icon_path The icon path of item
29336 * @param label The label of item
29337 * @param func Callback function of item
29338 * @param data The data of callback function
29339 * @return The item of controlbar
29341 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29343 * Prepend new tool item
29345 * @param obj The controlbar object
29346 * @param icon_path The icon path of item
29347 * @param label The label of item
29348 * @param func Callback function of item
29349 * @param data The data of callback function
29350 * @return The item of controlbar
29352 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29354 * Insert new tool item before given item
29356 * @param obj The controlbar object
29357 * @param before The given item
29358 * @param icon_path The icon path of item
29359 * @param label The label of item
29360 * @param func Callback function of item
29361 * @param data The data of callback function
29362 * @return The item of controlbar
29364 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29366 * Insert new tool item after given item
29368 * @param obj The controlbar object
29369 * @param after The given item
29370 * @param icon_path The icon path of item
29371 * @param label The label of item
29372 * @param func Callback function of item
29373 * @param data The data of callback function
29374 * @return The item of controlbar
29376 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29378 * Append new object item
29380 * @param obj The controlbar object
29381 * @param obj_item The object of item
29382 * @param sel The number of sel occupied
29383 * @return The item of controlbar
29385 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29387 * Prepend new object item
29389 * @param obj The controlbar object
29390 * @param obj_item The object of item
29391 * @param sel The number of sel occupied
29392 * @return The item of controlbar
29394 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29396 * Insert new object item before given item
29398 * @param obj The controlbar object
29399 * @param before The given item
29400 * @param obj_item The object of item
29401 * @param sel The number of sel occupied
29402 * @return The item of controlbar
29404 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29406 * Insert new object item after given item
29408 * @param obj The controlbar object
29409 * @param after The given item
29410 * @param obj_item The object of item
29411 * @param sel The number of sel occupied
29412 * @return The item of controlbar
29414 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29416 * Get the object of the object item
29418 * @param it The item of controlbar
29419 * @return The object of the object item
29421 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29423 * Delete item from controlbar
29425 * @param it The item of controlbar
29427 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
29429 * Select item in controlbar
29431 * @param it The item of controlbar
29433 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
29435 * Set the visible status of item in bar
29437 * @param it The item of controlbar
29438 * @param bar EINA_TRUE or EINA_FALSE
29440 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29442 * Get the result which or not item is visible in bar
29444 * @param it The item of controlbar
29445 * @return EINA_TRUE or EINA_FALSE
29447 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29451 * @param it The item of controlbar
29452 * @param bar EINA_TRUE or EINA_FALSE
29454 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29458 * @param it The item of controlbar
29459 * @return EINA_TRUE or EINA_FALSE
29461 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29463 * Set the icon of item
29465 * @param it The item of controlbar
29466 * @param icon_path The icon path of the item
29467 * @return The icon object
29469 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29471 * Get the icon of item
29473 * @param it The item of controlbar
29474 * @return The icon object
29476 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29478 * Set the label of item
29480 * @param it The item of controlbar
29481 * @param label The label of item
29483 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29485 * Get the label of item
29487 * @param it The item of controlbar
29488 * @return The label of item
29490 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29492 * Get the selected item
29494 * @param obj The controlbar object
29495 * @return The item of controlbar
29497 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29499 * Get the first item
29501 * @param obj The controlbar object
29502 * @return The item of controlbar
29504 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29506 * Get the last item
29508 * @param obj The controlbar object
29509 * @return The item of controlbar
29511 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29515 * @param obj The controlbar object
29516 * @return The list of the items
29518 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
29520 * Get the previous item
29522 * @param it The item of controlbar
29523 * @return The previous item of the parameter item
29525 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29527 * Get the next item
29529 * @param obj The controlbar object
29530 * @return The next item of the parameter item
29532 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29534 * Set the view of the item
29536 * @param it The item of controlbar
29537 * @param view The view for the item
29539 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29541 * Get the view of the item
29543 * @param it The item of controlbar
29544 * @return The view for the item
29546 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29548 * Unset the view of the item
29550 * @param it The item of controlbar
29551 * @return The view for the item
29553 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29555 * Set the vertical mode of the controlbar
29557 * @param obj The object of the controlbar
29558 * @param vertical The vertical mode of the controlbar (TRUE = vertical, FALSE = horizontal)
29560 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29562 * Set the mode of the controlbar
29564 * @param obj The object of the controlbar
29565 * @param mode The mode of the controlbar
29567 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
29569 * Set the alpha of the controlbar
29571 * @param obj The object of the controlbar
29572 * @param alpha The alpha value of the controlbar (0-100)
29574 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29576 * Set auto-align mode of the controlbar(It's not prepared yet)
29577 * If you set the auto-align and add items more than 5,
29578 * the "more" item will be made and the items more than 5 will be unvisible.
29580 * @param obj The object of the controlbar
29581 * @param auto_align The dicision that the controlbar use the auto-align
29583 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29585 * Get the button object of the item
29587 * @param it The item of controlbar
29588 * @return button object of the item
29590 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29597 * @defgroup Searchbar Searchbar
29598 * @addtogroup TickerNoti
29600 * @ingroup Elementary
29602 * This is Searchbar.
29603 * It can contain a simple entry and button object.
29607 * Add a new searchbar to the parent
29608 * @param parent The parent object
29609 * @return The new object or NULL if it cannot be created
29611 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29613 * set the text of entry
29615 * @param obj The searchbar object
29618 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29620 * get the text of entry
29622 * @param obj The searchbar object
29623 * @return string pointer of entry
29625 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
29627 * get the pointer of entry
29629 * @param obj The searchbar object
29630 * @return the entry object
29632 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29634 * get the pointer of editfield
29636 * @param obj The searchbar object
29637 * @return the editfield object
29639 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29641 * set the cancel button animation flag
29643 * @param obj The searchbar object
29644 * @param cancel_btn_ani_flag The flag of animating cancen button or not
29647 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29649 * set the cancel button show mode
29651 * @param obj The searchbar object
29652 * @param visible The flag of cancen button show or not
29655 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29657 * clear searchbar status
29659 * @param obj The searchbar object
29662 EAPI void elm_searchbar_clear(Evas_Object *obj);
29664 * set the searchbar boundary rect mode(with bg rect) set
29666 * @param obj The searchbar object
29667 * @param boundary The present flag of boundary rect or not
29670 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29675 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29676 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29677 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29678 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29681 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29682 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
29683 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
29684 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29685 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29688 * @defgroup TickerNoti TickerNoti
29689 * @addtogroup TickerNoti
29692 * This is a notification widget which can be used to display some short information.
29694 * Parts which can be used with elm_object_text_part_set() and
29695 * elm_object_text_part_get():
29697 * @li NULL/"default" - Operates on tickernoti content-text
29699 * Parts which can be used with elm_object_content_part_set(),
29700 * elm_object_content_part_get() and elm_object_content_part_unset():
29702 * @li "icon" - Operates on tickernoti's icon
29703 * @li "button" - Operates on tickernoti's button
29705 * smart callbacks called:
29706 * @li "clicked" - emitted when tickernoti is clicked, except at the
29707 * swallow/button region, if any.
29708 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29709 * any hide animation, this signal is emitted after the animation.
29713 ELM_TICKERNOTI_ORIENT_TOP = 0,
29714 ELM_TICKERNOTI_ORIENT_BOTTOM,
29715 ELM_TICKERNOTI_ORIENT_LAST
29716 } Elm_Tickernoti_Orient;
29719 * Add a tickernoti object to @p parent
29721 * @param parent The parent object
29723 * @return The tickernoti object, or NULL upon failure
29725 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
29727 * Set the orientation of the tickernoti object
29729 * @param obj The tickernoti object
29730 * @param orient The orientation of tickernoti object
29732 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29734 * Get the orientation of the tickernoti object
29736 * @param obj The tickernotil object
29737 * @return The orientation of tickernotil object
29739 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29741 * Get the rotation of tickernoti object
29743 * @param obj The tickernotil object
29744 * @return The rotation angle
29746 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29748 * Set the rotation angle for the tickernoti object
29750 * @param obj The tickernoti object
29751 * @param angle The rotation angle(in degree) will be used on the tickernoti object
29753 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29755 * Get the view window(elm_win) on the tickernoti object
29757 * @param obj The tickernotil object
29758 * @return internal view window(elm_win) object
29760 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29761 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29767 ELM_TICKERNOTI_DEFAULT,
29768 ELM_TICKERNOTI_DETAILVIEW
29769 } Elm_Tickernoti_Mode;
29771 * Set the detail label on the tickernoti object
29773 * @param obj The tickernoti object
29774 * @param label The label will be used on the tickernoti object
29775 * @deprecated use elm_object_text_set() instead
29777 WILL_DEPRECATE EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29779 * Get the detail label used on the tickernoti object
29781 * @param obj The tickernotil object
29782 * @return The string inside the label
29783 * @deprecated use elm_object_text_get() instead
29785 WILL_DEPRECATE EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29787 * Set the button object used on the tickernoti object
29789 * @param obj The tickernotil object
29790 * @param button The button object will be used on the tickernoti object
29791 * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29793 WILL_DEPRECATE EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29795 * Get the button object used on the tickernoti object
29797 * @param obj The tickernotil object
29798 * @return The button object inside the tickernoti
29799 * @deprecated use elm_object_content_part_get() instead with "button" as part name
29801 WILL_DEPRECATE EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29803 * Set the detail icon object used on the tickernoti object
29805 * @param obj The tickernotil object
29806 * @param icon The icon object will be used on the tickernoti object
29807 * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29809 WILL_DEPRECATE EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29811 * Get the detail icon object used on the tickernoti object
29813 * @param obj The tickernotil object
29814 * @return The icon object inside the tickernoti
29815 * @deprecated use elm_object_content_part_get() instead with "icon" as part name
29817 WILL_DEPRECATE EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29819 * Get the view mode on the tickernoti object
29821 * @param obj The tickernotil object
29822 * @return The view mode
29823 * @deprecated removed as now styles are used instead
29825 WILL_DEPRECATE EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29827 * Set the view mode used on the tickernoti object
29829 * @param obj The tickernotil object
29830 * @param mode The view mode will be used on the tickernoti object
29831 * @deprecated removed as now styles are used instead
29833 WILL_DEPRECATE EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29835 * Get the detail view window(elm_win) on the tickernoti object
29837 * @param obj The tickernotil object
29838 * @return detail view window(elm_win) object
29840 WILL_DEPRECATE EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29842 * Set the orientation of the tickernoti object
29844 * @param obj The tickernoti object
29845 * @param orient The orientation of tickernoti object
29846 * @deprecated use elm_tickernoti_orient_set() instead
29848 WILL_DEPRECATE EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29850 * Get the orientation of the tickernoti object
29852 * @param obj The tickernotil object
29853 * @return The orientation of tickernotil object
29854 * @deprecated use elm_tickernoti_orient_get() instead
29856 WILL_DEPRECATE EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29858 * Set the label on the tickernoti object
29860 * @param obj The tickernoti object
29861 * @param label The label will be used on the tickernoti object
29862 * @deprecated use elm_object_text_get()
29864 WILL_DEPRECATE EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29866 * Get the label used on the tickernoti object
29868 * @param obj The tickernotil object
29869 * @return The string inside the label
29870 * @deprecated use elm_object_text_get() instead
29872 WILL_DEPRECATE EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29874 * Set the icon object of the tickernoti object
29876 * @param obj The tickernotil object
29877 * @param icon The icon object will be used on the tickernoti object
29878 * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29880 WILL_DEPRECATE EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29882 * Get the icon object of the tickernoti object
29884 * @param obj The tickernotil object
29885 * @return The icon object inside the tickernoti
29886 * @deprecated use elm_object_content_part_get() instead with "icon" as part name
29888 WILL_DEPRECATE EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29890 * Set the action button object used on the tickernoti object
29892 * @param obj The tickernotil object
29893 * @param button The button object will be used on the tickernoti object
29894 * @deprecated use elm_object_content_part_set() instead with "button" as part name
29896 WILL_DEPRECATE EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29898 * Get the action button object used on the tickernoti object
29900 * @param obj The tickernotil object
29901 * @return The button object inside the tickernoti
29902 * @deprecated use elm_object_content_part_get() instead with "button" as part name
29904 WILL_DEPRECATE EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29910 * @defgroup Colorpalette Colorpalette
29911 * @ingroup Elementary
29912 * @addtogroup Colorpalette
29915 * Using colorpalette, you can select a color by clicking
29916 * a color rectangle on the colorpalette.
29918 * Smart callbacks that you can add are:
29920 * clicked - This signal is sent when a color rectangle is clicked.
29922 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29923 struct _Colorpalette_Color
29925 unsigned int r, g, b;
29929 * Add a new colorpalette to the parent.
29931 * @param parent The parent object
29932 * @return The new object or NULL if it cannot be created
29934 * @ingroup Colorpalette
29936 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29938 * Set colors to the colorpalette.
29940 * @param obj Colorpalette object
29941 * @param color_num number of the colors on the colorpalette
29942 * @param color Color lists
29944 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29946 * Set row/column value for the colorpalette.
29948 * @param obj Colorpalette object
29949 * @param row row value for the colorpalette
29950 * @param col column value for the colorpalette
29952 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29959 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29960 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29961 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29962 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29963 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29964 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29965 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29966 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29967 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29968 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29969 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29970 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29971 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29972 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29973 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29974 /* smart callbacks called:
29975 * "clicked" - when an editfield is clicked
29976 * "unfocused" - when an editfield is unfocused
29981 * @defgroup Multibuttonenetry Multibuttonenetry
29983 * @image html img/widget/flipselector/preview-00.png
29984 * @image latex img/widget/flipselector/preview-00.eps
29986 * A Multibuttonentry is a widget to allow a user to insert a text button.
29987 * the text button is inserted by pressing the "return" key. If there is no space in the current row,
29988 * the new button is entered in the next row. If the button is pressed, it will become focused.
29989 * The focus can be removed by pressing the "backspace" key.
29990 * when items are added over 1 lines, if Multibuttonentry lost focus, it becase shrink mode ( made it 1 line)
29992 * Smart callbacks one can register to:
29993 * - @c "item,selected" - when item is selected . it can be called by backspace key.
29994 * - @c "item,added" - when a new multibuttonentry item is added.
29995 * - @c "item,deleted" -when a multibuttonentry item is deleted.
29996 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
29997 * - @c "clicked" - when multibuttonentry is clicked.
29998 * - @c "focused" - when multibuttonentry is focused.
29999 * - @c "unfocused" - when multibuttonentry is unfocused.
30000 * - @c "expanded" - when multibuttonentry is expanded .
30001 * - @c "shrank" - when multibuttonentry is shrank.
30002 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30004 * Here is an example on its usage:
30005 * @li @ref multibuttonentry_example
30008 * @addtogroup Multibuttonentry
30012 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30013 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30016 * @brief Add a new multibuttonentry to the parent
30018 * @param parent The parent object
30019 * @return The new object or NULL if it cannot be created
30021 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
30025 * @param obj The multibuttonentry object
30026 * @return The label, or NULL if none
30028 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
30032 * @param obj The multibuttonentry object
30033 * @param label The text label string
30035 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
30037 * Get the entry of the multibuttonentry object
30039 * @param obj The multibuttonentry object
30040 * @return The entry object, or NULL if none
30042 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
30044 * Get the guide text
30046 * @param obj The multibuttonentry object
30047 * @return The guide text, or NULL if none
30049 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
30051 * Set the guide text
30053 * @param obj The multibuttonentry object
30054 * @param label The guide text string
30056 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
30058 * Get the value of shrink_mode state.
30060 * @param obj The multibuttonentry object
30061 * @param the value of shrink mode state.
30063 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
30065 * Set/Unset the multibuttonentry to shrink mode state of single line
30067 * @param obj The multibuttonentry object
30068 * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
30070 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
30072 * Prepend a new item to the multibuttonentry
30074 * @param obj The multibuttonentry object
30075 * @param label The label of new item
30076 * @param data The ponter to the data to be attached
30077 * @return A handle to the item added or NULL if not possible
30079 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
30081 * Append a new item to the multibuttonentry
30083 * @param obj The multibuttonentry object
30084 * @param label The label of new item
30085 * @param data The ponter to the data to be attached
30086 * @return A handle to the item added or NULL if not possible
30088 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
30090 * Add a new item to the multibuttonentry before the indicated object
30093 * @param obj The multibuttonentry object
30094 * @param before The item before which to add it
30095 * @param label The label of new item
30096 * @param data The ponter to the data to be attached
30097 * @return A handle to the item added or NULL if not possible
30099 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
30101 * Add a new item to the multibuttonentry after the indicated object
30103 * @param obj The multibuttonentry object
30104 * @param after The item after which to add it
30105 * @param label The label of new item
30106 * @param data The ponter to the data to be attached
30107 * @return A handle to the item added or NULL if not possible
30109 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
30111 * Get a list of items in the multibuttonentry
30113 * @param obj The multibuttonentry object
30114 * @return The list of items, or NULL if none
30116 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
30118 * Get the first item in the multibuttonentry
30120 * @param obj The multibuttonentry object
30121 * @return The first item, or NULL if none
30123 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
30125 * Get the last item in the multibuttonentry
30127 * @param obj The multibuttonentry object
30128 * @return The last item, or NULL if none
30130 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
30132 * Get the selected item in the multibuttonentry
30134 * @param obj The multibuttonentry object
30135 * @return The selected item, or NULL if none
30137 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
30139 * Set the selected state of an item
30141 * @param item The item
30142 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30144 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
30146 * unselect all of items.
30148 * @param obj The multibuttonentry object
30150 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
30152 * Delete a given item
30154 * @param item The item
30156 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
30158 * Remove all items in the multibuttonentry.
30160 * @param obj The multibuttonentry object
30162 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
30164 * Get the label of a given item
30166 * @param item The item
30167 * @return The label of a given item, or NULL if none
30169 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
30171 * Set the label of a given item
30173 * @param item The item
30174 * @param label The text label string
30176 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
30178 * Get the previous item in the multibuttonentry
30180 * @param item The item
30181 * @return The item before the item @p item
30183 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
30185 * Get the next item in the multibuttonentry
30187 * @param item The item
30188 * @return The item after the item @p item
30190 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
30192 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
30193 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
30194 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
30201 * @defgroup Stackedicon Stackedicon
30202 * @ingroup Elementary
30203 * @addtogroup Stackedicon
30206 * This is a Stackedicon.
30207 * smart callback called:
30208 * "expanded" - This signal is emitted when a stackedicon is expanded.
30209 * "clicked" - This signal is emitted when a stackedicon is clicked.
30211 * available styles:
30214 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
30216 * Add a new stackedicon to the parent
30218 * @param parent The parent object
30219 * @return The new object or NULL if it cannot be created
30221 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
30223 * This appends a path to the stackedicon
30225 * @param obj The stackedicon object
30226 * @param path The image full path
30227 * @return The new item or NULL if it cannot be created
30229 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
30231 * This prepends a path to the stackedicon
30233 * @param obj The stackedicon object
30234 * @param path The image full path
30235 * @return The new item or NULL if it cannot be created
30237 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
30239 * This delete a path at the stackedicon
30241 * @param Elm_Stackedicon_Item The delete item
30243 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
30245 * Get item list from the stackedicon
30247 * @param obj The stackedicon object
30248 * @return The item list or NULL if it cannot be created
30250 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
30256 /* dialoguegroup */
30257 typedef struct _Dialogue_Item Dialogue_Item;
30259 typedef enum _Elm_Dialoguegourp_Item_Style
30261 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
30262 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
30263 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
30264 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
30265 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
30266 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
30267 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
30268 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
30269 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
30270 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
30271 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
30272 } Elm_Dialoguegroup_Item_Style;
30274 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
30275 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
30276 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
30277 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
30278 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
30279 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
30280 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
30281 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
30282 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
30283 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
30284 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
30285 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
30286 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
30287 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
30288 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
30289 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
30294 ELM_DAYSELECTOR_SUN,
30295 ELM_DAYSELECTOR_MON,
30296 ELM_DAYSELECTOR_TUE,
30297 ELM_DAYSELECTOR_WED,
30298 ELM_DAYSELECTOR_THU,
30299 ELM_DAYSELECTOR_FRI,
30300 ELM_DAYSELECTOR_SAT
30301 } Elm_DaySelector_Day;
30303 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
30304 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
30305 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
30308 * @defgroup Imageslider Imageslider
30309 * @ingroup Elementary
30310 * @addtogroup Imageslider
30313 * By flicking images on the screen,
30314 * you can see the images in specific path.
30316 typedef struct _Imageslider_Item Elm_Imageslider_Item;
30317 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
30320 * Add an Image Slider widget
30322 * @param parent The parent object
30323 * @return The new Image slider object or NULL if it cannot be created
30325 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30327 * Append an Image Slider item
30329 * @param obj The Image Slider object
30330 * @param photo_file photo file path
30331 * @param func callback function
30332 * @param data callback data
30333 * @return The Image Slider item handle or NULL
30335 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
30337 * Insert an Image Slider item into the Image Slider Widget by using the given index.
30339 * @param obj The Image Slider object
30340 * @param photo_file photo file path
30341 * @param func callback function
30342 * @param index required position
30343 * @param data callback data
30344 * @return The Image Slider item handle or NULL
30346 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
30348 * Prepend Image Slider item
30350 * @param obj The Image Slider object
30351 * @param photo_file photo file path
30352 * @param func callback function
30353 * @param data callback data
30354 * @return The imageslider item handle or NULL
30356 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
30358 * Delete the selected Image Slider item
30360 * @param it The selected Image Slider item handle
30362 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30364 * Get the selected Image Slider item
30366 * @param obj The Image Slider object
30367 * @return The selected Image Slider item or NULL
30369 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
30371 * Get whether an Image Slider item is selected or not
30373 * @param it the selected Image Slider item
30374 * @return EINA_TRUE or EINA_FALSE
30376 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30378 * Set the selected Image Slider item
30380 * @param it The Imaga Slider item
30382 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30384 * Get the photo file path of given Image Slider item
30386 * @param it The Image Slider item
30387 * @return The photo file path or NULL;
30389 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30391 * Sets the photo file path of given Image Slider item
30393 * @param it The Image Slider item
30394 * @param photo_file The photo file path or NULL;
30396 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30398 * Get the previous Image Slider item
30400 * @param it The Image Slider item
30401 * @return The previous Image Slider item or NULL
30403 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30405 * Get the next Image Slider item
30407 * @param it The Image Slider item
30408 * @return The next Image Slider item or NULL
30410 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
30412 * Move to the previous Image Slider item
30414 * @param obj The Image Slider object
30416 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
30418 * Move to the next Image Slider item
30420 * @param obj The Image Slider object
30422 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
30424 * Updates an Image Slider item
30426 * @param it The Image Slider item
30428 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);