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);
3422 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3424 * @param obj The root object
3425 * @param file The path of output file
3428 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3435 * @defgroup Theme Theme
3437 * Elementary uses Edje to theme its widgets, naturally. But for the most
3438 * part this is hidden behind a simpler interface that lets the user set
3439 * extensions and choose the style of widgets in a much easier way.
3441 * Instead of thinking in terms of paths to Edje files and their groups
3442 * each time you want to change the appearance of a widget, Elementary
3443 * works so you can add any theme file with extensions or replace the
3444 * main theme at one point in the application, and then just set the style
3445 * of widgets with elm_object_style_set() and related functions. Elementary
3446 * will then look in its list of themes for a matching group and apply it,
3447 * and when the theme changes midway through the application, all widgets
3448 * will be updated accordingly.
3450 * There are three concepts you need to know to understand how Elementary
3451 * theming works: default theme, extensions and overlays.
3453 * Default theme, obviously enough, is the one that provides the default
3454 * look of all widgets. End users can change the theme used by Elementary
3455 * by setting the @c ELM_THEME environment variable before running an
3456 * application, or globally for all programs using the @c elementary_config
3457 * utility. Applications can change the default theme using elm_theme_set(),
3458 * but this can go against the user wishes, so it's not an adviced practice.
3460 * Ideally, applications should find everything they need in the already
3461 * provided theme, but there may be occasions when that's not enough and
3462 * custom styles are required to correctly express the idea. For this
3463 * cases, Elementary has extensions.
3465 * Extensions allow the application developer to write styles of its own
3466 * to apply to some widgets. This requires knowledge of how each widget
3467 * is themed, as extensions will always replace the entire group used by
3468 * the widget, so important signals and parts need to be there for the
3469 * object to behave properly (see documentation of Edje for details).
3470 * Once the theme for the extension is done, the application needs to add
3471 * it to the list of themes Elementary will look into, using
3472 * elm_theme_extension_add(), and set the style of the desired widgets as
3473 * he would normally with elm_object_style_set().
3475 * Overlays, on the other hand, can replace the look of all widgets by
3476 * overriding the default style. Like extensions, it's up to the application
3477 * developer to write the theme for the widgets it wants, the difference
3478 * being that when looking for the theme, Elementary will check first the
3479 * list of overlays, then the set theme and lastly the list of extensions,
3480 * so with overlays it's possible to replace the default view and every
3481 * widget will be affected. This is very much alike to setting the whole
3482 * theme for the application and will probably clash with the end user
3483 * options, not to mention the risk of ending up with not matching styles
3484 * across the program. Unless there's a very special reason to use them,
3485 * overlays should be avoided for the resons exposed before.
3487 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3488 * keeps one default internally and every function that receives one of
3489 * these can be called with NULL to refer to this default (except for
3490 * elm_theme_free()). It's possible to create a new instance of a
3491 * ::Elm_Theme to set other theme for a specific widget (and all of its
3492 * children), but this is as discouraged, if not even more so, than using
3493 * overlays. Don't use this unless you really know what you are doing.
3495 * But to be less negative about things, you can look at the following
3497 * @li @ref theme_example_01 "Using extensions"
3498 * @li @ref theme_example_02 "Using overlays"
3503 * @typedef Elm_Theme
3505 * Opaque handler for the list of themes Elementary looks for when
3506 * rendering widgets.
3508 * Stay out of this unless you really know what you are doing. For most
3509 * cases, sticking to the default is all a developer needs.
3511 typedef struct _Elm_Theme Elm_Theme;
3514 * Create a new specific theme
3516 * This creates an empty specific theme that only uses the default theme. A
3517 * specific theme has its own private set of extensions and overlays too
3518 * (which are empty by default). Specific themes do not fall back to themes
3519 * of parent objects. They are not intended for this use. Use styles, overlays
3520 * and extensions when needed, but avoid specific themes unless there is no
3521 * other way (example: you want to have a preview of a new theme you are
3522 * selecting in a "theme selector" window. The preview is inside a scroller
3523 * and should display what the theme you selected will look like, but not
3524 * actually apply it yet. The child of the scroller will have a specific
3525 * theme set to show this preview before the user decides to apply it to all
3528 EAPI Elm_Theme *elm_theme_new(void);
3530 * Free a specific theme
3532 * @param th The theme to free
3534 * This frees a theme created with elm_theme_new().
3536 EAPI void elm_theme_free(Elm_Theme *th);
3538 * Copy the theme fom the source to the destination theme
3540 * @param th The source theme to copy from
3541 * @param thdst The destination theme to copy data to
3543 * This makes a one-time static copy of all the theme config, extensions
3544 * and overlays from @p th to @p thdst. If @p th references a theme, then
3545 * @p thdst is also set to reference it, with all the theme settings,
3546 * overlays and extensions that @p th had.
3548 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3550 * Tell the source theme to reference the ref theme
3552 * @param th The theme that will do the referencing
3553 * @param thref The theme that is the reference source
3555 * This clears @p th to be empty and then sets it to refer to @p thref
3556 * so @p th acts as an override to @p thref, but where its overrides
3557 * don't apply, it will fall through to @p thref for configuration.
3559 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3561 * Return the theme referred to
3563 * @param th The theme to get the reference from
3564 * @return The referenced theme handle
3566 * This gets the theme set as the reference theme by elm_theme_ref_set().
3567 * If no theme is set as a reference, NULL is returned.
3569 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3571 * Return the default theme
3573 * @return The default theme handle
3575 * This returns the internal default theme setup handle that all widgets
3576 * use implicitly unless a specific theme is set. This is also often use
3577 * as a shorthand of NULL.
3579 EAPI Elm_Theme *elm_theme_default_get(void);
3581 * Prepends a theme overlay to the list of overlays
3583 * @param th The theme to add to, or if NULL, the default theme
3584 * @param item The Edje file path to be used
3586 * Use this if your application needs to provide some custom overlay theme
3587 * (An Edje file that replaces some default styles of widgets) where adding
3588 * new styles, or changing system theme configuration is not possible. Do
3589 * NOT use this instead of a proper system theme configuration. Use proper
3590 * configuration files, profiles, environment variables etc. to set a theme
3591 * so that the theme can be altered by simple confiugration by a user. Using
3592 * this call to achieve that effect is abusing the API and will create lots
3595 * @see elm_theme_extension_add()
3597 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3599 * Delete a theme overlay from the list of overlays
3601 * @param th The theme to delete from, or if NULL, the default theme
3602 * @param item The name of the theme overlay
3604 * @see elm_theme_overlay_add()
3606 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3608 * Appends a theme extension to the list of extensions.
3610 * @param th The theme to add to, or if NULL, the default theme
3611 * @param item The Edje file path to be used
3613 * This is intended when an application needs more styles of widgets or new
3614 * widget themes that the default does not provide (or may not provide). The
3615 * application has "extended" usage by coming up with new custom style names
3616 * for widgets for specific uses, but as these are not "standard", they are
3617 * not guaranteed to be provided by a default theme. This means the
3618 * application is required to provide these extra elements itself in specific
3619 * Edje files. This call adds one of those Edje files to the theme search
3620 * path to be search after the default theme. The use of this call is
3621 * encouraged when default styles do not meet the needs of the application.
3622 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3624 * @see elm_object_style_set()
3626 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3628 * Deletes a theme extension from the list of extensions.
3630 * @param th The theme to delete from, or if NULL, the default theme
3631 * @param item The name of the theme extension
3633 * @see elm_theme_extension_add()
3635 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3637 * Set the theme search order for the given theme
3639 * @param th The theme to set the search order, or if NULL, the default theme
3640 * @param theme Theme search string
3642 * This sets the search string for the theme in path-notation from first
3643 * theme to search, to last, delimited by the : character. Example:
3645 * "shiny:/path/to/file.edj:default"
3647 * See the ELM_THEME environment variable for more information.
3649 * @see elm_theme_get()
3650 * @see elm_theme_list_get()
3652 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3654 * Return the theme search order
3656 * @param th The theme to get the search order, or if NULL, the default theme
3657 * @return The internal search order path
3659 * This function returns a colon separated string of theme elements as
3660 * returned by elm_theme_list_get().
3662 * @see elm_theme_set()
3663 * @see elm_theme_list_get()
3665 EAPI const char *elm_theme_get(Elm_Theme *th);
3667 * Return a list of theme elements to be used in a theme.
3669 * @param th Theme to get the list of theme elements from.
3670 * @return The internal list of theme elements
3672 * This returns the internal list of theme elements (will only be valid as
3673 * long as the theme is not modified by elm_theme_set() or theme is not
3674 * freed by elm_theme_free(). This is a list of strings which must not be
3675 * altered as they are also internal. If @p th is NULL, then the default
3676 * theme element list is returned.
3678 * A theme element can consist of a full or relative path to a .edj file,
3679 * or a name, without extension, for a theme to be searched in the known
3680 * theme paths for Elemementary.
3682 * @see elm_theme_set()
3683 * @see elm_theme_get()
3685 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3687 * Return the full patrh for a theme element
3689 * @param f The theme element name
3690 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3691 * @return The full path to the file found.
3693 * This returns a string you should free with free() on success, NULL on
3694 * failure. This will search for the given theme element, and if it is a
3695 * full or relative path element or a simple searchable name. The returned
3696 * path is the full path to the file, if searched, and the file exists, or it
3697 * is simply the full path given in the element or a resolved path if
3698 * relative to home. The @p in_search_path boolean pointed to is set to
3699 * EINA_TRUE if the file was a searchable file andis in the search path,
3700 * and EINA_FALSE otherwise.
3702 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3704 * Flush the current theme.
3706 * @param th Theme to flush
3708 * This flushes caches that let elementary know where to find theme elements
3709 * in the given theme. If @p th is NULL, then the default theme is flushed.
3710 * Call this function if source theme data has changed in such a way as to
3711 * make any caches Elementary kept invalid.
3713 EAPI void elm_theme_flush(Elm_Theme *th);
3715 * This flushes all themes (default and specific ones).
3717 * This will flush all themes in the current application context, by calling
3718 * elm_theme_flush() on each of them.
3720 EAPI void elm_theme_full_flush(void);
3722 * Set the theme for all elementary using applications on the current display
3724 * @param theme The name of the theme to use. Format same as the ELM_THEME
3725 * environment variable.
3727 EAPI void elm_theme_all_set(const char *theme);
3729 * Return a list of theme elements in the theme search path
3731 * @return A list of strings that are the theme element names.
3733 * This lists all available theme files in the standard Elementary search path
3734 * for theme elements, and returns them in alphabetical order as theme
3735 * element names in a list of strings. Free this with
3736 * elm_theme_name_available_list_free() when you are done with the list.
3738 EAPI Eina_List *elm_theme_name_available_list_new(void);
3740 * Free the list returned by elm_theme_name_available_list_new()
3742 * This frees the list of themes returned by
3743 * elm_theme_name_available_list_new(). Once freed the list should no longer
3744 * be used. a new list mys be created.
3746 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3748 * Set a specific theme to be used for this object and its children
3750 * @param obj The object to set the theme on
3751 * @param th The theme to set
3753 * This sets a specific theme that will be used for the given object and any
3754 * child objects it has. If @p th is NULL then the theme to be used is
3755 * cleared and the object will inherit its theme from its parent (which
3756 * ultimately will use the default theme if no specific themes are set).
3758 * Use special themes with great care as this will annoy users and make
3759 * configuration difficult. Avoid any custom themes at all if it can be
3762 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3764 * Get the specific theme to be used
3766 * @param obj The object to get the specific theme from
3767 * @return The specifc theme set.
3769 * This will return a specific theme set, or NULL if no specific theme is
3770 * set on that object. It will not return inherited themes from parents, only
3771 * the specific theme set for that specific object. See elm_object_theme_set()
3772 * for more information.
3774 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777 * Get a data item from a theme
3779 * @param th The theme, or NULL for default theme
3780 * @param key The data key to search with
3781 * @return The data value, or NULL on failure
3783 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3784 * It works the same way as edje_file_data_get() except that the return is stringshared.
3786 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3792 /** @defgroup Win Win
3794 * @image html img/widget/win/preview-00.png
3795 * @image latex img/widget/win/preview-00.eps
3797 * The window class of Elementary. Contains functions to manipulate
3798 * windows. The Evas engine used to render the window contents is specified
3799 * in the system or user elementary config files (whichever is found last),
3800 * and can be overridden with the ELM_ENGINE environment variable for
3801 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3802 * compilation setup and modules actually installed at runtime) are (listed
3803 * in order of best supported and most likely to be complete and work to
3806 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3807 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3809 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3811 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3813 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3815 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3816 * rendering using SDL as the buffer)
3817 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3818 * GDI with software)
3819 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3820 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3821 * grayscale using dedicated 8bit software engine in X11)
3822 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3823 * X11 using 16bit software engine)
3824 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3825 * (Windows CE rendering via GDI with 16bit software renderer)
3826 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3827 * buffer with 16bit software renderer)
3828 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3829 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3830 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3832 * All engines use a simple string to select the engine to render, EXCEPT
3833 * the "shot" engine. This actually encodes the output of the virtual
3834 * screenshot and how long to delay in the engine string. The engine string
3835 * is encoded in the following way:
3837 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3839 * Where options are separated by a ":" char if more than one option is
3840 * given, with delay, if provided being the first option and file the last
3841 * (order is important). The delay specifies how long to wait after the
3842 * window is shown before doing the virtual "in memory" rendering and then
3843 * save the output to the file specified by the file option (and then exit).
3844 * If no delay is given, the default is 0.5 seconds. If no file is given the
3845 * default output file is "out.png". Repeat option is for continous
3846 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3847 * fixed to "out001.png" Some examples of using the shot engine:
3849 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3850 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3851 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3852 * ELM_ENGINE="shot:delay=2.0" elementary_test
3853 * ELM_ENGINE="shot:" elementary_test
3855 * Signals that you can add callbacks for are:
3857 * @li "delete,request": the user requested to close the window. See
3858 * elm_win_autodel_set().
3859 * @li "focus,in": window got focus
3860 * @li "focus,out": window lost focus
3861 * @li "moved": window that holds the canvas was moved
3864 * @li @ref win_example_01
3869 * Defines the types of window that can be created
3871 * These are hints set on the window so that a running Window Manager knows
3872 * how the window should be handled and/or what kind of decorations it
3875 * Currently, only the X11 backed engines use them.
3877 typedef enum _Elm_Win_Type
3879 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3880 window. Almost every window will be created with this
3882 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3883 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3884 window holding desktop icons. */
3885 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3886 be kept on top of any other window by the Window
3888 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3890 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3891 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3893 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3894 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3895 entry in a menubar is clicked. Typically used
3896 with elm_win_override_set(). This hint exists
3897 for completion only, as the EFL way of
3898 implementing a menu would not normally use a
3899 separate window for its contents. */
3900 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3901 triggered by right-clicking an object. */
3902 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3903 explanatory text that typically appear after the
3904 mouse cursor hovers over an object for a while.
3905 Typically used with elm_win_override_set() and also
3906 not very commonly used in the EFL. */
3907 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3908 battery life or a new E-Mail received. */
3909 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3910 usually used in the EFL. */
3911 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3912 object being dragged across different windows, or even
3913 applications. Typically used with
3914 elm_win_override_set(). */
3915 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3916 buffer. No actual window is created for this
3917 type, instead the window and all of its
3918 contents will be rendered to an image buffer.
3919 This allows to have children window inside a
3920 parent one just like any other object would
3921 be, and do other things like applying @c
3922 Evas_Map effects to it. This is the only type
3923 of window that requires the @c parent
3924 parameter of elm_win_add() to be a valid @c
3929 * The differents layouts that can be requested for the virtual keyboard.
3931 * When the application window is being managed by Illume, it may request
3932 * any of the following layouts for the virtual keyboard.
3934 typedef enum _Elm_Win_Keyboard_Mode
3936 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3937 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3938 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3939 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3940 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3941 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3942 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3943 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3944 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3945 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3946 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3947 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3948 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3949 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3950 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3951 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3952 } Elm_Win_Keyboard_Mode;
3955 * Available commands that can be sent to the Illume manager.
3957 * When running under an Illume session, a window may send commands to the
3958 * Illume manager to perform different actions.
3960 typedef enum _Elm_Illume_Command
3962 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3964 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3966 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3968 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3969 } Elm_Illume_Command;
3972 * Adds a window object. If this is the first window created, pass NULL as
3975 * @param parent Parent object to add the window to, or NULL
3976 * @param name The name of the window
3977 * @param type The window type, one of #Elm_Win_Type.
3979 * The @p parent paramter can be @c NULL for every window @p type except
3980 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3981 * which the image object will be created.
3983 * @return The created object, or NULL on failure
3985 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3987 * Adds a window object with standard setup
3989 * @param name The name of the window
3990 * @param title The title for the window
3992 * This creates a window like elm_win_add() but also puts in a standard
3993 * background with elm_bg_add(), as well as setting the window title to
3994 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3995 * as the parent widget.
3997 * @return The created object, or NULL on failure
3999 * @see elm_win_add()
4001 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4003 * Add @p subobj as a resize object of window @p obj.
4006 * Setting an object as a resize object of the window means that the
4007 * @p subobj child's size and position will be controlled by the window
4008 * directly. That is, the object will be resized to match the window size
4009 * and should never be moved or resized manually by the developer.
4011 * In addition, resize objects of the window control what the minimum size
4012 * of it will be, as well as whether it can or not be resized by the user.
4014 * For the end user to be able to resize a window by dragging the handles
4015 * or borders provided by the Window Manager, or using any other similar
4016 * mechanism, all of the resize objects in the window should have their
4017 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4019 * @param obj The window object
4020 * @param subobj The resize object to add
4022 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4024 * Delete @p subobj as a resize object of window @p obj.
4026 * This function removes the object @p subobj from the resize objects of
4027 * the window @p obj. It will not delete the object itself, which will be
4028 * left unmanaged and should be deleted by the developer, manually handled
4029 * or set as child of some other container.
4031 * @param obj The window object
4032 * @param subobj The resize object to add
4034 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4036 * Set the title of the window
4038 * @param obj The window object
4039 * @param title The title to set
4041 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4043 * Get the title of the window
4045 * The returned string is an internal one and should not be freed or
4046 * modified. It will also be rendered invalid if a new title is set or if
4047 * the window is destroyed.
4049 * @param obj The window object
4052 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4054 * Set the window's autodel state.
4056 * When closing the window in any way outside of the program control, like
4057 * pressing the X button in the titlebar or using a command from the
4058 * Window Manager, a "delete,request" signal is emitted to indicate that
4059 * this event occurred and the developer can take any action, which may
4060 * include, or not, destroying the window object.
4062 * When the @p autodel parameter is set, the window will be automatically
4063 * destroyed when this event occurs, after the signal is emitted.
4064 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4065 * and is up to the program to do so when it's required.
4067 * @param obj The window object
4068 * @param autodel If true, the window will automatically delete itself when
4071 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4073 * Get the window's autodel state.
4075 * @param obj The window object
4076 * @return If the window will automatically delete itself when closed
4078 * @see elm_win_autodel_set()
4080 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4082 * Activate a window object.
4084 * This function sends a request to the Window Manager to activate the
4085 * window pointed by @p obj. If honored by the WM, the window will receive
4086 * the keyboard focus.
4088 * @note This is just a request that a Window Manager may ignore, so calling
4089 * this function does not ensure in any way that the window will be the
4090 * active one after it.
4092 * @param obj The window object
4094 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4096 * Lower a window object.
4098 * Places the window pointed by @p obj at the bottom of the stack, so that
4099 * no other window is covered by it.
4101 * If elm_win_override_set() is not set, the Window Manager may ignore this
4104 * @param obj The window object
4106 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4108 * Raise a window object.
4110 * Places the window pointed by @p obj at the top of the stack, so that it's
4111 * not covered by any other window.
4113 * If elm_win_override_set() is not set, the Window Manager may ignore this
4116 * @param obj The window object
4118 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4120 * Set the borderless state of a window.
4122 * This function requests the Window Manager to not draw any decoration
4123 * around the window.
4125 * @param obj The window object
4126 * @param borderless If true, the window is borderless
4128 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4130 * Get the borderless state of a window.
4132 * @param obj The window object
4133 * @return If true, the window is borderless
4135 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4137 * Set the shaped state of a window.
4139 * Shaped windows, when supported, will render the parts of the window that
4140 * has no content, transparent.
4142 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4143 * background object or cover the entire window in any other way, or the
4144 * parts of the canvas that have no data will show framebuffer artifacts.
4146 * @param obj The window object
4147 * @param shaped If true, the window is shaped
4149 * @see elm_win_alpha_set()
4151 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4153 * Get the shaped state of a window.
4155 * @param obj The window object
4156 * @return If true, the window is shaped
4158 * @see elm_win_shaped_set()
4160 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4162 * Set the alpha channel state of a window.
4164 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4165 * possibly making parts of the window completely or partially transparent.
4166 * This is also subject to the underlying system supporting it, like for
4167 * example, running under a compositing manager. If no compositing is
4168 * available, enabling this option will instead fallback to using shaped
4169 * windows, with elm_win_shaped_set().
4171 * @param obj The window object
4172 * @param alpha If true, the window has an alpha channel
4174 * @see elm_win_alpha_set()
4176 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4178 * Get the transparency state of a window.
4180 * @param obj The window object
4181 * @return If true, the window is transparent
4183 * @see elm_win_transparent_set()
4185 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4187 * Set the transparency state of a window.
4189 * Use elm_win_alpha_set() instead.
4191 * @param obj The window object
4192 * @param transparent If true, the window is transparent
4194 * @see elm_win_alpha_set()
4196 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4198 * Get the alpha channel state of a window.
4200 * @param obj The window object
4201 * @return If true, the window has an alpha channel
4203 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4205 * Set the override state of a window.
4207 * A window with @p override set to EINA_TRUE will not be managed by the
4208 * Window Manager. This means that no decorations of any kind will be shown
4209 * for it, moving and resizing must be handled by the application, as well
4210 * as the window visibility.
4212 * This should not be used for normal windows, and even for not so normal
4213 * ones, it should only be used when there's a good reason and with a lot
4214 * of care. Mishandling override windows may result situations that
4215 * disrupt the normal workflow of the end user.
4217 * @param obj The window object
4218 * @param override If true, the window is overridden
4220 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4222 * Get the override state of a window.
4224 * @param obj The window object
4225 * @return If true, the window is overridden
4227 * @see elm_win_override_set()
4229 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Set the fullscreen state of a window.
4233 * @param obj The window object
4234 * @param fullscreen If true, the window is fullscreen
4236 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4238 * Get the fullscreen state of a window.
4240 * @param obj The window object
4241 * @return If true, the window is fullscreen
4243 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4245 * Set the maximized state of a window.
4247 * @param obj The window object
4248 * @param maximized If true, the window is maximized
4250 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4252 * Get the maximized state of a window.
4254 * @param obj The window object
4255 * @return If true, the window is maximized
4257 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the iconified state of a window.
4261 * @param obj The window object
4262 * @param iconified If true, the window is iconified
4264 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4266 * Get the iconified state of a window.
4268 * @param obj The window object
4269 * @return If true, the window is iconified
4271 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4273 * Set the layer of the window.
4275 * What this means exactly will depend on the underlying engine used.
4277 * In the case of X11 backed engines, the value in @p layer has the
4278 * following meanings:
4279 * @li < 3: The window will be placed below all others.
4280 * @li > 5: The window will be placed above all others.
4281 * @li other: The window will be placed in the default layer.
4283 * @param obj The window object
4284 * @param layer The layer of the window
4286 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4288 * Get the layer of the window.
4290 * @param obj The window object
4291 * @return The layer of the window
4293 * @see elm_win_layer_set()
4295 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4297 * Set the rotation of the window.
4299 * Most engines only work with multiples of 90.
4301 * This function is used to set the orientation of the window @p obj to
4302 * match that of the screen. The window itself will be resized to adjust
4303 * to the new geometry of its contents. If you want to keep the window size,
4304 * see elm_win_rotation_with_resize_set().
4306 * @param obj The window object
4307 * @param rotation The rotation of the window, in degrees (0-360),
4308 * counter-clockwise.
4310 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4312 * Rotates the window and resizes it.
4314 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4315 * that they fit inside the current window geometry.
4317 * @param obj The window object
4318 * @param layer The rotation of the window in degrees (0-360),
4319 * counter-clockwise.
4321 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4323 * Get the rotation of the window.
4325 * @param obj The window object
4326 * @return The rotation of the window in degrees (0-360)
4328 * @see elm_win_rotation_set()
4329 * @see elm_win_rotation_with_resize_set()
4331 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4333 * Set the sticky state of the window.
4335 * Hints the Window Manager that the window in @p obj should be left fixed
4336 * at its position even when the virtual desktop it's on moves or changes.
4338 * @param obj The window object
4339 * @param sticky If true, the window's sticky state is enabled
4341 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4343 * Get the sticky state of the window.
4345 * @param obj The window object
4346 * @return If true, the window's sticky state is enabled
4348 * @see elm_win_sticky_set()
4350 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4352 * Set if this window is an illume conformant window
4354 * @param obj The window object
4355 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4357 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4359 * Get if this window is an illume conformant window
4361 * @param obj The window object
4362 * @return A boolean if this window is illume conformant or not
4364 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4366 * Set a window to be an illume quickpanel window
4368 * By default window objects are not quickpanel windows.
4370 * @param obj The window object
4371 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4373 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4375 * Get if this window is a quickpanel or not
4377 * @param obj The window object
4378 * @return A boolean if this window is a quickpanel or not
4380 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4382 * Set the major priority of a quickpanel window
4384 * @param obj The window object
4385 * @param priority The major priority for this quickpanel
4387 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4389 * Get the major priority of a quickpanel window
4391 * @param obj The window object
4392 * @return The major priority of this quickpanel
4394 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4396 * Set the minor priority of a quickpanel window
4398 * @param obj The window object
4399 * @param priority The minor priority for this quickpanel
4401 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4403 * Get the minor priority of a quickpanel window
4405 * @param obj The window object
4406 * @return The minor priority of this quickpanel
4408 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4410 * Set which zone this quickpanel should appear in
4412 * @param obj The window object
4413 * @param zone The requested zone for this quickpanel
4415 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4417 * Get which zone this quickpanel should appear in
4419 * @param obj The window object
4420 * @return The requested zone for this quickpanel
4422 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4424 * Set the window to be skipped by keyboard focus
4426 * This sets the window to be skipped by normal keyboard input. This means
4427 * a window manager will be asked to not focus this window as well as omit
4428 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4430 * Call this and enable it on a window BEFORE you show it for the first time,
4431 * otherwise it may have no effect.
4433 * Use this for windows that have only output information or might only be
4434 * interacted with by the mouse or fingers, and never for typing input.
4435 * Be careful that this may have side-effects like making the window
4436 * non-accessible in some cases unless the window is specially handled. Use
4439 * @param obj The window object
4440 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4442 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4444 * Send a command to the windowing environment
4446 * This is intended to work in touchscreen or small screen device
4447 * environments where there is a more simplistic window management policy in
4448 * place. This uses the window object indicated to select which part of the
4449 * environment to control (the part that this window lives in), and provides
4450 * a command and an optional parameter structure (use NULL for this if not
4453 * @param obj The window object that lives in the environment to control
4454 * @param command The command to send
4455 * @param params Optional parameters for the command
4457 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4459 * Get the inlined image object handle
4461 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4462 * then the window is in fact an evas image object inlined in the parent
4463 * canvas. You can get this object (be careful to not manipulate it as it
4464 * is under control of elementary), and use it to do things like get pixel
4465 * data, save the image to a file, etc.
4467 * @param obj The window object to get the inlined image from
4468 * @return The inlined image object, or NULL if none exists
4470 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4472 * Determine whether a window has focus
4473 * @param obj The window to query
4474 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4476 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4478 * Get screen geometry details for the screen that a window is on
4479 * @param obj The window to query
4480 * @param x where to return the horizontal offset value. May be NULL.
4481 * @param y where to return the vertical offset value. May be NULL.
4482 * @param w where to return the width value. May be NULL.
4483 * @param h where to return the height value. May be NULL.
4485 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4487 * Set the enabled status for the focus highlight in a window
4489 * This function will enable or disable the focus highlight only for the
4490 * given window, regardless of the global setting for it
4492 * @param obj The window where to enable the highlight
4493 * @param enabled The enabled value for the highlight
4495 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4497 * Get the enabled value of the focus highlight for this window
4499 * @param obj The window in which to check if the focus highlight is enabled
4501 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4503 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4505 * Set the style for the focus highlight on this window
4507 * Sets the style to use for theming the highlight of focused objects on
4508 * the given window. If @p style is NULL, the default will be used.
4510 * @param obj The window where to set the style
4511 * @param style The style to set
4513 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4515 * Get the style set for the focus highlight object
4517 * Gets the style set for this windows highilght object, or NULL if none
4520 * @param obj The window to retrieve the highlights style from
4522 * @return The style set or NULL if none was. Default is used in that case.
4524 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4525 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4526 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
4528 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4529 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4530 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4531 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4532 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4533 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4534 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4536 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4537 * (blank mouse, private mouse obj, defaultmouse)
4541 * Sets the keyboard mode of the window.
4543 * @param obj The window object
4544 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4546 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4548 * Gets the keyboard mode of the window.
4550 * @param obj The window object
4551 * @return The mode, one of #Elm_Win_Keyboard_Mode
4553 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4555 * Sets whether the window is a keyboard.
4557 * @param obj The window object
4558 * @param is_keyboard If true, the window is a virtual keyboard
4560 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4562 * Gets whether the window is a keyboard.
4564 * @param obj The window object
4565 * @return If the window is a virtual keyboard
4567 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4570 * Get the screen position of a window.
4572 * @param obj The window object
4573 * @param x The int to store the x coordinate to
4574 * @param y The int to store the y coordinate to
4576 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4582 * @defgroup Inwin Inwin
4584 * @image html img/widget/inwin/preview-00.png
4585 * @image latex img/widget/inwin/preview-00.eps
4586 * @image html img/widget/inwin/preview-01.png
4587 * @image latex img/widget/inwin/preview-01.eps
4588 * @image html img/widget/inwin/preview-02.png
4589 * @image latex img/widget/inwin/preview-02.eps
4591 * An inwin is a window inside a window that is useful for a quick popup.
4592 * It does not hover.
4594 * It works by creating an object that will occupy the entire window, so it
4595 * must be created using an @ref Win "elm_win" as parent only. The inwin
4596 * object can be hidden or restacked below every other object if it's
4597 * needed to show what's behind it without destroying it. If this is done,
4598 * the elm_win_inwin_activate() function can be used to bring it back to
4599 * full visibility again.
4601 * There are three styles available in the default theme. These are:
4602 * @li default: The inwin is sized to take over most of the window it's
4604 * @li minimal: The size of the inwin will be the minimum necessary to show
4606 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4607 * possible, but it's sized vertically the most it needs to fit its\
4610 * Some examples of Inwin can be found in the following:
4611 * @li @ref inwin_example_01
4616 * Adds an inwin to the current window
4618 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4619 * Never call this function with anything other than the top-most window
4620 * as its parameter, unless you are fond of undefined behavior.
4622 * After creating the object, the widget will set itself as resize object
4623 * for the window with elm_win_resize_object_add(), so when shown it will
4624 * appear to cover almost the entire window (how much of it depends on its
4625 * content and the style used). It must not be added into other container
4626 * objects and it needs not be moved or resized manually.
4628 * @param parent The parent object
4629 * @return The new object or NULL if it cannot be created
4631 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4633 * Activates an inwin object, ensuring its visibility
4635 * This function will make sure that the inwin @p obj is completely visible
4636 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4637 * to the front. It also sets the keyboard focus to it, which will be passed
4640 * The object's theme will also receive the signal "elm,action,show" with
4643 * @param obj The inwin to activate
4645 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4647 * Set the content of an inwin object.
4649 * Once the content object is set, a previously set one will be deleted.
4650 * If you want to keep that old content object, use the
4651 * elm_win_inwin_content_unset() function.
4653 * @param obj The inwin object
4654 * @param content The object to set as content
4656 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4658 * Get the content of an inwin object.
4660 * Return the content object which is set for this widget.
4662 * The returned object is valid as long as the inwin is still alive and no
4663 * other content is set on it. Deleting the object will notify the inwin
4664 * about it and this one will be left empty.
4666 * If you need to remove an inwin's content to be reused somewhere else,
4667 * see elm_win_inwin_content_unset().
4669 * @param obj The inwin object
4670 * @return The content that is being used
4672 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4674 * Unset the content of an inwin object.
4676 * Unparent and return the content object which was set for this widget.
4678 * @param obj The inwin object
4679 * @return The content that was being used
4681 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4685 /* X specific calls - won't work on non-x engines (return 0) */
4688 * Get the Ecore_X_Window of an Evas_Object
4690 * @param obj The object
4692 * @return The Ecore_X_Window of @p obj
4696 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4698 /* smart callbacks called:
4699 * "delete,request" - the user requested to delete the window
4700 * "focus,in" - window got focus
4701 * "focus,out" - window lost focus
4702 * "moved" - window that holds the canvas was moved
4708 * @image html img/widget/bg/preview-00.png
4709 * @image latex img/widget/bg/preview-00.eps
4711 * @brief Background object, used for setting a solid color, image or Edje
4712 * group as background to a window or any container object.
4714 * The bg object is used for setting a solid background to a window or
4715 * packing into any container object. It works just like an image, but has
4716 * some properties useful to a background, like setting it to tiled,
4717 * centered, scaled or stretched.
4719 * Default contents parts of the bg widget that you can use for are:
4720 * @li "overlay" - overlay of the bg
4722 * Here is some sample code using it:
4723 * @li @ref bg_01_example_page
4724 * @li @ref bg_02_example_page
4725 * @li @ref bg_03_example_page
4729 typedef enum _Elm_Bg_Option
4731 ELM_BG_OPTION_CENTER, /**< center the background */
4732 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4733 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4734 ELM_BG_OPTION_TILE /**< tile background at its original size */
4738 * Add a new background to the parent
4740 * @param parent The parent object
4741 * @return The new object or NULL if it cannot be created
4745 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4748 * Set the file (image or edje) used for the background
4750 * @param obj The bg object
4751 * @param file The file path
4752 * @param group Optional key (group in Edje) within the file
4754 * This sets the image file used in the background object. The image (or edje)
4755 * will be stretched (retaining aspect if its an image file) to completely fill
4756 * the bg object. This may mean some parts are not visible.
4758 * @note Once the image of @p obj is set, a previously set one will be deleted,
4759 * even if @p file is NULL.
4763 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4766 * Get the file (image or edje) used for the background
4768 * @param obj The bg object
4769 * @param file The file path
4770 * @param group Optional key (group in Edje) within the file
4774 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4777 * Set the option used for the background image
4779 * @param obj The bg object
4780 * @param option The desired background option (TILE, SCALE)
4782 * This sets the option used for manipulating the display of the background
4783 * image. The image can be tiled or scaled.
4787 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4790 * Get the option used for the background image
4792 * @param obj The bg object
4793 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4797 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4799 * Set the option used for the background color
4801 * @param obj The bg object
4806 * This sets the color used for the background rectangle. Its range goes
4811 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4813 * Get the option used for the background color
4815 * @param obj The bg object
4822 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4825 * Set the overlay object used for the background object.
4827 * @param obj The bg object
4828 * @param overlay The overlay object
4830 * This provides a way for elm_bg to have an 'overlay' that will be on top
4831 * of the bg. Once the over object is set, a previously set one will be
4832 * deleted, even if you set the new one to NULL. If you want to keep that
4833 * old content object, use the elm_bg_overlay_unset() function.
4835 * @deprecated use elm_object_part_content_set() instead
4840 WILL_DEPRECATE EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4843 * Get the overlay object used for the background object.
4845 * @param obj The bg object
4846 * @return The content that is being used
4848 * Return the content object which is set for this widget
4850 * @deprecated use elm_object_part_content_get() instead
4854 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4857 * Get the overlay object used for the background object.
4859 * @param obj The bg object
4860 * @return The content that was being used
4862 * Unparent and return the overlay object which was set for this widget
4864 * @deprecated use elm_object_part_content_unset() instead
4868 WILL_DEPRECATE EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4871 * Set the size of the pixmap representation of the image.
4873 * This option just makes sense if an image is going to be set in the bg.
4875 * @param obj The bg object
4876 * @param w The new width of the image pixmap representation.
4877 * @param h The new height of the image pixmap representation.
4879 * This function sets a new size for pixmap representation of the given bg
4880 * image. It allows the image to be loaded already in the specified size,
4881 * reducing the memory usage and load time when loading a big image with load
4882 * size set to a smaller size.
4884 * NOTE: this is just a hint, the real size of the pixmap may differ
4885 * depending on the type of image being loaded, being bigger than requested.
4889 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4890 /* smart callbacks called:
4894 * @defgroup Icon Icon
4896 * @image html img/widget/icon/preview-00.png
4897 * @image latex img/widget/icon/preview-00.eps
4899 * An object that provides standard icon images (delete, edit, arrows, etc.)
4900 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4902 * The icon image requested can be in the elementary theme, or in the
4903 * freedesktop.org paths. It's possible to set the order of preference from
4904 * where the image will be used.
4906 * This API is very similar to @ref Image, but with ready to use images.
4908 * Default images provided by the theme are described below.
4910 * The first list contains icons that were first intended to be used in
4911 * toolbars, but can be used in many other places too:
4927 * Now some icons that were designed to be used in menus (but again, you can
4928 * use them anywhere else):
4933 * @li menu/arrow_down
4934 * @li menu/arrow_left
4935 * @li menu/arrow_right
4944 * And here we have some media player specific icons:
4945 * @li media_player/forward
4946 * @li media_player/info
4947 * @li media_player/next
4948 * @li media_player/pause
4949 * @li media_player/play
4950 * @li media_player/prev
4951 * @li media_player/rewind
4952 * @li media_player/stop
4954 * Signals that you can add callbacks for are:
4956 * "clicked" - This is called when a user has clicked the icon
4958 * An example of usage for this API follows:
4959 * @li @ref tutorial_icon
4967 typedef enum _Elm_Icon_Type
4974 * @enum _Elm_Icon_Lookup_Order
4975 * @typedef Elm_Icon_Lookup_Order
4977 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4978 * theme, FDO paths, or both?
4982 typedef enum _Elm_Icon_Lookup_Order
4984 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4985 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4986 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4987 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4988 } Elm_Icon_Lookup_Order;
4991 * Add a new icon object to the parent.
4993 * @param parent The parent object
4994 * @return The new object or NULL if it cannot be created
4996 * @see elm_icon_file_set()
5000 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5002 * Set the file that will be used as icon.
5004 * @param obj The icon object
5005 * @param file The path to file that will be used as icon image
5006 * @param group The group that the icon belongs to an edje file
5008 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5010 * @note The icon image set by this function can be changed by
5011 * elm_icon_standard_set().
5013 * @see elm_icon_file_get()
5017 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5019 * Set a location in memory to be used as an icon
5021 * @param obj The icon object
5022 * @param img The binary data that will be used as an image
5023 * @param size The size of binary data @p img
5024 * @param format Optional format of @p img to pass to the image loader
5025 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5027 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5029 * @note The icon image set by this function can be changed by
5030 * elm_icon_standard_set().
5034 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);
5036 * Get the file that will be used as icon.
5038 * @param obj The icon object
5039 * @param file The path to file that will be used as the icon image
5040 * @param group The group that the icon belongs to, in edje file
5042 * @see elm_icon_file_set()
5046 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5047 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5049 * Set the icon by icon standards names.
5051 * @param obj The icon object
5052 * @param name The icon name
5054 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5056 * For example, freedesktop.org defines standard icon names such as "home",
5057 * "network", etc. There can be different icon sets to match those icon
5058 * keys. The @p name given as parameter is one of these "keys", and will be
5059 * used to look in the freedesktop.org paths and elementary theme. One can
5060 * change the lookup order with elm_icon_order_lookup_set().
5062 * If name is not found in any of the expected locations and it is the
5063 * absolute path of an image file, this image will be used.
5065 * @note The icon image set by this function can be changed by
5066 * elm_icon_file_set().
5068 * @see elm_icon_standard_get()
5069 * @see elm_icon_file_set()
5073 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5075 * Get the icon name set by icon standard names.
5077 * @param obj The icon object
5078 * @return The icon name
5080 * If the icon image was set using elm_icon_file_set() instead of
5081 * elm_icon_standard_set(), then this function will return @c NULL.
5083 * @see elm_icon_standard_set()
5087 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5089 * Set the smooth scaling for an icon object.
5091 * @param obj The icon object
5092 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5093 * otherwise. Default is @c EINA_TRUE.
5095 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5096 * scaling provides a better resulting image, but is slower.
5098 * The smooth scaling should be disabled when making animations that change
5099 * the icon size, since they will be faster. Animations that don't require
5100 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5101 * is already scaled, since the scaled icon image will be cached).
5103 * @see elm_icon_smooth_get()
5107 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5109 * Get whether smooth scaling is enabled for an icon object.
5111 * @param obj The icon object
5112 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5114 * @see elm_icon_smooth_set()
5118 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5120 * Disable scaling of this object.
5122 * @param obj The icon object.
5123 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5124 * otherwise. Default is @c EINA_FALSE.
5126 * This function disables scaling of the icon object through the function
5127 * elm_object_scale_set(). However, this does not affect the object
5128 * size/resize in any way. For that effect, take a look at
5129 * elm_icon_scale_set().
5131 * @see elm_icon_no_scale_get()
5132 * @see elm_icon_scale_set()
5133 * @see elm_object_scale_set()
5137 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5139 * Get whether scaling is disabled on the object.
5141 * @param obj The icon object
5142 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5144 * @see elm_icon_no_scale_set()
5148 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5150 * Set if the object is (up/down) resizable.
5152 * @param obj The icon object
5153 * @param scale_up A bool to set if the object is resizable up. Default is
5155 * @param scale_down A bool to set if the object is resizable down. Default
5158 * This function limits the icon object resize ability. If @p scale_up is set to
5159 * @c EINA_FALSE, the object can't have its height or width resized to a value
5160 * higher than the original icon size. Same is valid for @p scale_down.
5162 * @see elm_icon_scale_get()
5166 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5168 * Get if the object is (up/down) resizable.
5170 * @param obj The icon object
5171 * @param scale_up A bool to set if the object is resizable up
5172 * @param scale_down A bool to set if the object is resizable down
5174 * @see elm_icon_scale_set()
5178 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5180 * Get the object's image size
5182 * @param obj The icon object
5183 * @param w A pointer to store the width in
5184 * @param h A pointer to store the height in
5188 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5190 * Set if the icon fill the entire object area.
5192 * @param obj The icon object
5193 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5194 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5196 * When the icon object is resized to a different aspect ratio from the
5197 * original icon image, the icon image will still keep its aspect. This flag
5198 * tells how the image should fill the object's area. They are: keep the
5199 * entire icon inside the limits of height and width of the object (@p
5200 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5201 * of the object, and the icon will fill the entire object (@p fill_outside
5204 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5205 * retain property to false. Thus, the icon image will always keep its
5206 * original aspect ratio.
5208 * @see elm_icon_fill_outside_get()
5209 * @see elm_image_fill_outside_set()
5213 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5215 * Get if the object is filled outside.
5217 * @param obj The icon object
5218 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5220 * @see elm_icon_fill_outside_set()
5224 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5226 * Set the prescale size for the icon.
5228 * @param obj The icon object
5229 * @param size The prescale size. This value is used for both width and
5232 * This function sets a new size for pixmap representation of the given
5233 * icon. It allows the icon to be loaded already in the specified size,
5234 * reducing the memory usage and load time when loading a big icon with load
5235 * size set to a smaller size.
5237 * It's equivalent to the elm_bg_load_size_set() function for bg.
5239 * @note this is just a hint, the real size of the pixmap may differ
5240 * depending on the type of icon being loaded, being bigger than requested.
5242 * @see elm_icon_prescale_get()
5243 * @see elm_bg_load_size_set()
5247 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5249 * Get the prescale size for the icon.
5251 * @param obj The icon object
5252 * @return The prescale size
5254 * @see elm_icon_prescale_set()
5258 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5260 * Gets the image object of the icon. DO NOT MODIFY THIS.
5262 * @param obj The icon object
5263 * @return The internal icon object
5267 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5269 * Sets the icon lookup order used by elm_icon_standard_set().
5271 * @param obj The icon object
5272 * @param order The icon lookup order (can be one of
5273 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5274 * or ELM_ICON_LOOKUP_THEME)
5276 * @see elm_icon_order_lookup_get()
5277 * @see Elm_Icon_Lookup_Order
5281 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5283 * Gets the icon lookup order.
5285 * @param obj The icon object
5286 * @return The icon lookup order
5288 * @see elm_icon_order_lookup_set()
5289 * @see Elm_Icon_Lookup_Order
5293 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5295 * Enable or disable preloading of the icon
5297 * @param obj The icon object
5298 * @param disable If EINA_TRUE, preloading will be disabled
5301 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5303 * Get if the icon supports animation or not.
5305 * @param obj The icon object
5306 * @return @c EINA_TRUE if the icon supports animation,
5307 * @c EINA_FALSE otherwise.
5309 * Return if this elm icon's image can be animated. Currently Evas only
5310 * supports gif animation. If the return value is EINA_FALSE, other
5311 * elm_icon_animated_XXX APIs won't work.
5314 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316 * Set animation mode of the icon.
5318 * @param obj The icon object
5319 * @param anim @c EINA_TRUE if the object do animation job,
5320 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5322 * Since the default animation mode is set to EINA_FALSE,
5323 * the icon is shown without animation.
5324 * This might be desirable when the application developer wants to show
5325 * a snapshot of the animated icon.
5326 * Set it to EINA_TRUE when the icon needs to be animated.
5329 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5331 * Get animation mode of the icon.
5333 * @param obj The icon object
5334 * @return The animation mode of the icon object
5335 * @see elm_icon_animated_set
5338 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5340 * Set animation play mode of the icon.
5342 * @param obj The icon object
5343 * @param play @c EINA_TRUE the object play animation images,
5344 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5346 * To play elm icon's animation, set play to EINA_TURE.
5347 * For example, you make gif player using this set/get API and click event.
5349 * 1. Click event occurs
5350 * 2. Check play flag using elm_icon_animaged_play_get
5351 * 3. If elm icon was playing, set play to EINA_FALSE.
5352 * Then animation will be stopped and vice versa
5355 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5357 * Get animation play mode of the icon.
5359 * @param obj The icon object
5360 * @return The play mode of the icon object
5362 * @see elm_icon_animated_play_get
5365 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5372 * @defgroup Image Image
5374 * @image html img/widget/image/preview-00.png
5375 * @image latex img/widget/image/preview-00.eps
5378 * An object that allows one to load an image file to it. It can be used
5379 * anywhere like any other elementary widget.
5381 * This widget provides most of the functionality provided from @ref Bg or @ref
5382 * Icon, but with a slightly different API (use the one that fits better your
5385 * The features not provided by those two other image widgets are:
5386 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5387 * @li change the object orientation with elm_image_orient_set();
5388 * @li and turning the image editable with elm_image_editable_set().
5390 * Signals that you can add callbacks for are:
5392 * @li @c "clicked" - This is called when a user has clicked the image
5394 * An example of usage for this API follows:
5395 * @li @ref tutorial_image
5404 * @enum _Elm_Image_Orient
5405 * @typedef Elm_Image_Orient
5407 * Possible orientation options for elm_image_orient_set().
5409 * @image html elm_image_orient_set.png
5410 * @image latex elm_image_orient_set.eps width=\textwidth
5414 typedef enum _Elm_Image_Orient
5416 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5417 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5418 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5419 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5420 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5421 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5422 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5423 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5427 * Add a new image to the parent.
5429 * @param parent The parent object
5430 * @return The new object or NULL if it cannot be created
5432 * @see elm_image_file_set()
5436 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5438 * Set the file that will be used as image.
5440 * @param obj The image object
5441 * @param file The path to file that will be used as image
5442 * @param group The group that the image belongs in edje file (if it's an
5445 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5447 * @see elm_image_file_get()
5451 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5453 * Get the file that will be used as image.
5455 * @param obj The image object
5456 * @param file The path to file
5457 * @param group The group that the image belongs in edje file
5459 * @see elm_image_file_set()
5463 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5465 * Set the smooth effect for an image.
5467 * @param obj The image object
5468 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5469 * otherwise. Default is @c EINA_TRUE.
5471 * Set the scaling algorithm to be used when scaling the image. Smooth
5472 * scaling provides a better resulting image, but is slower.
5474 * The smooth scaling should be disabled when making animations that change
5475 * the image size, since it will be faster. Animations that don't require
5476 * resizing of the image can keep the smooth scaling enabled (even if the
5477 * image is already scaled, since the scaled image will be cached).
5479 * @see elm_image_smooth_get()
5483 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5485 * Get the smooth effect for an image.
5487 * @param obj The image object
5488 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5490 * @see elm_image_smooth_get()
5494 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5497 * Gets the current size of the image.
5499 * @param obj The image object.
5500 * @param w Pointer to store width, or NULL.
5501 * @param h Pointer to store height, or NULL.
5503 * This is the real size of the image, not the size of the object.
5505 * On error, neither w or h will be written.
5509 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5511 * Disable scaling of this object.
5513 * @param obj The image object.
5514 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5515 * otherwise. Default is @c EINA_FALSE.
5517 * This function disables scaling of the elm_image widget through the
5518 * function elm_object_scale_set(). However, this does not affect the widget
5519 * size/resize in any way. For that effect, take a look at
5520 * elm_image_scale_set().
5522 * @see elm_image_no_scale_get()
5523 * @see elm_image_scale_set()
5524 * @see elm_object_scale_set()
5528 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5530 * Get whether scaling is disabled on the object.
5532 * @param obj The image object
5533 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5535 * @see elm_image_no_scale_set()
5539 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5541 * Set if the object is (up/down) resizable.
5543 * @param obj The image object
5544 * @param scale_up A bool to set if the object is resizable up. Default is
5546 * @param scale_down A bool to set if the object is resizable down. Default
5549 * This function limits the image resize ability. If @p scale_up is set to
5550 * @c EINA_FALSE, the object can't have its height or width resized to a value
5551 * higher than the original image size. Same is valid for @p scale_down.
5553 * @see elm_image_scale_get()
5557 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5559 * Get if the object is (up/down) resizable.
5561 * @param obj The image object
5562 * @param scale_up A bool to set if the object is resizable up
5563 * @param scale_down A bool to set if the object is resizable down
5565 * @see elm_image_scale_set()
5569 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5571 * Set if the image fills the entire object area, when keeping the aspect ratio.
5573 * @param obj The image object
5574 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5575 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5577 * When the image should keep its aspect ratio even if resized to another
5578 * aspect ratio, there are two possibilities to resize it: keep the entire
5579 * image inside the limits of height and width of the object (@p fill_outside
5580 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5581 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5583 * @note This option will have no effect if
5584 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5586 * @see elm_image_fill_outside_get()
5587 * @see elm_image_aspect_ratio_retained_set()
5591 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5593 * Get if the object is filled outside
5595 * @param obj The image object
5596 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5598 * @see elm_image_fill_outside_set()
5602 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5604 * Set the prescale size for the image
5606 * @param obj The image object
5607 * @param size The prescale size. This value is used for both width and
5610 * This function sets a new size for pixmap representation of the given
5611 * image. It allows the image to be loaded already in the specified size,
5612 * reducing the memory usage and load time when loading a big image with load
5613 * size set to a smaller size.
5615 * It's equivalent to the elm_bg_load_size_set() function for bg.
5617 * @note this is just a hint, the real size of the pixmap may differ
5618 * depending on the type of image being loaded, being bigger than requested.
5620 * @see elm_image_prescale_get()
5621 * @see elm_bg_load_size_set()
5625 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5627 * Get the prescale size for the image
5629 * @param obj The image object
5630 * @return The prescale size
5632 * @see elm_image_prescale_set()
5636 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5638 * Set the image orientation.
5640 * @param obj The image object
5641 * @param orient The image orientation @ref Elm_Image_Orient
5642 * Default is #ELM_IMAGE_ORIENT_NONE.
5644 * This function allows to rotate or flip the given image.
5646 * @see elm_image_orient_get()
5647 * @see @ref Elm_Image_Orient
5651 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5653 * Get the image orientation.
5655 * @param obj The image object
5656 * @return The image orientation @ref Elm_Image_Orient
5658 * @see elm_image_orient_set()
5659 * @see @ref Elm_Image_Orient
5663 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5665 * Make the image 'editable'.
5667 * @param obj Image object.
5668 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5670 * This means the image is a valid drag target for drag and drop, and can be
5671 * cut or pasted too.
5675 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5677 * Check if the image 'editable'.
5679 * @param obj Image object.
5680 * @return Editability.
5682 * A return value of EINA_TRUE means the image is a valid drag target
5683 * for drag and drop, and can be cut or pasted too.
5687 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5689 * Get the basic Evas_Image object from this object (widget).
5691 * @param obj The image object to get the inlined image from
5692 * @return The inlined image object, or NULL if none exists
5694 * This function allows one to get the underlying @c Evas_Object of type
5695 * Image from this elementary widget. It can be useful to do things like get
5696 * the pixel data, save the image to a file, etc.
5698 * @note Be careful to not manipulate it, as it is under control of
5703 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5705 * Set whether the original aspect ratio of the image should be kept on resize.
5707 * @param obj The image object.
5708 * @param retained @c EINA_TRUE if the image should retain the aspect,
5709 * @c EINA_FALSE otherwise.
5711 * The original aspect ratio (width / height) of the image is usually
5712 * distorted to match the object's size. Enabling this option will retain
5713 * this original aspect, and the way that the image is fit into the object's
5714 * area depends on the option set by elm_image_fill_outside_set().
5716 * @see elm_image_aspect_ratio_retained_get()
5717 * @see elm_image_fill_outside_set()
5721 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5723 * Get if the object retains the original aspect ratio.
5725 * @param obj The image object.
5726 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5731 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5738 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5740 /* old API compatibility */
5741 typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5743 typedef enum _Elm_GLView_Mode
5745 ELM_GLVIEW_ALPHA = 1,
5746 ELM_GLVIEW_DEPTH = 2,
5747 ELM_GLVIEW_STENCIL = 4
5751 * Defines a policy for the glview resizing.
5753 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5755 typedef enum _Elm_GLView_Resize_Policy
5757 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5758 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5759 } Elm_GLView_Resize_Policy;
5761 typedef enum _Elm_GLView_Render_Policy
5763 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5764 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5765 } Elm_GLView_Render_Policy;
5770 * A simple GLView widget that allows GL rendering.
5772 * Signals that you can add callbacks for are:
5778 * Add a new glview to the parent
5780 * @param parent The parent object
5781 * @return The new object or NULL if it cannot be created
5785 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5788 * Sets the size of the glview
5790 * @param obj The glview object
5791 * @param width width of the glview object
5792 * @param height height of the glview object
5796 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5799 * Gets the size of the glview.
5801 * @param obj The glview object
5802 * @param width width of the glview object
5803 * @param height height of the glview object
5805 * Note that this function returns the actual image size of the
5806 * glview. This means that when the scale policy is set to
5807 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5812 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5815 * Gets the gl api struct for gl rendering
5817 * @param obj The glview object
5818 * @return The api object or NULL if it cannot be created
5822 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825 * Set the mode of the GLView. Supports Three simple modes.
5827 * @param obj The glview object
5828 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5829 * @return True if set properly.
5833 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5836 * Set the resize policy for the glview object.
5838 * @param obj The glview object.
5839 * @param policy The scaling policy.
5841 * By default, the resize policy is set to
5842 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5843 * destroys the previous surface and recreates the newly specified
5844 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5845 * however, glview only scales the image object and not the underlying
5850 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5853 * Set the render policy for the glview object.
5855 * @param obj The glview object.
5856 * @param policy The render policy.
5858 * By default, the render policy is set to
5859 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5860 * that during the render loop, glview is only redrawn if it needs
5861 * to be redrawn. (i.e. When it is visible) If the policy is set to
5862 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5863 * whether it is visible/need redrawing or not.
5867 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5870 * Set the init function that runs once in the main loop.
5872 * @param obj The glview object.
5873 * @param func The init function to be registered.
5875 * The registered init function gets called once during the render loop.
5879 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5882 * Set the render function that runs in the main loop.
5884 * @param obj The glview object.
5885 * @param func The delete function to be registered.
5887 * The registered del function gets called when GLView object is deleted.
5891 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5894 * Set the resize function that gets called when resize happens.
5896 * @param obj The glview object.
5897 * @param func The resize function to be registered.
5901 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5904 * Set the render function that runs in the main loop.
5906 * @param obj The glview object.
5907 * @param func The render function to be registered.
5911 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5914 * Notifies that there has been changes in the GLView.
5916 * @param obj The glview object.
5920 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5930 * @image html img/widget/box/preview-00.png
5931 * @image latex img/widget/box/preview-00.eps width=\textwidth
5933 * @image html img/box.png
5934 * @image latex img/box.eps width=\textwidth
5936 * A box arranges objects in a linear fashion, governed by a layout function
5937 * that defines the details of this arrangement.
5939 * By default, the box will use an internal function to set the layout to
5940 * a single row, either vertical or horizontal. This layout is affected
5941 * by a number of parameters, such as the homogeneous flag set by
5942 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5943 * elm_box_align_set() and the hints set to each object in the box.
5945 * For this default layout, it's possible to change the orientation with
5946 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5947 * placing its elements ordered from top to bottom. When horizontal is set,
5948 * the order will go from left to right. If the box is set to be
5949 * homogeneous, every object in it will be assigned the same space, that
5950 * of the largest object. Padding can be used to set some spacing between
5951 * the cell given to each object. The alignment of the box, set with
5952 * elm_box_align_set(), determines how the bounding box of all the elements
5953 * will be placed within the space given to the box widget itself.
5955 * The size hints of each object also affect how they are placed and sized
5956 * within the box. evas_object_size_hint_min_set() will give the minimum
5957 * size the object can have, and the box will use it as the basis for all
5958 * latter calculations. Elementary widgets set their own minimum size as
5959 * needed, so there's rarely any need to use it manually.
5961 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5962 * used to tell whether the object will be allocated the minimum size it
5963 * needs or if the space given to it should be expanded. It's important
5964 * to realize that expanding the size given to the object is not the same
5965 * thing as resizing the object. It could very well end being a small
5966 * widget floating in a much larger empty space. If not set, the weight
5967 * for objects will normally be 0.0 for both axis, meaning the widget will
5968 * not be expanded. To take as much space possible, set the weight to
5969 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5971 * Besides how much space each object is allocated, it's possible to control
5972 * how the widget will be placed within that space using
5973 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5974 * for both axis, meaning the object will be centered, but any value from
5975 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5976 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5977 * is -1.0, means the object will be resized to fill the entire space it
5980 * In addition, customized functions to define the layout can be set, which
5981 * allow the application developer to organize the objects within the box
5982 * in any number of ways.
5984 * The special elm_box_layout_transition() function can be used
5985 * to switch from one layout to another, animating the motion of the
5986 * children of the box.
5988 * @note Objects should not be added to box objects using _add() calls.
5990 * Some examples on how to use boxes follow:
5991 * @li @ref box_example_01
5992 * @li @ref box_example_02
5997 * @typedef Elm_Box_Transition
5999 * Opaque handler containing the parameters to perform an animated
6000 * transition of the layout the box uses.
6002 * @see elm_box_transition_new()
6003 * @see elm_box_layout_set()
6004 * @see elm_box_layout_transition()
6006 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6009 * Add a new box to the parent
6011 * By default, the box will be in vertical mode and non-homogeneous.
6013 * @param parent The parent object
6014 * @return The new object or NULL if it cannot be created
6016 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6018 * Set the horizontal orientation
6020 * By default, box object arranges their contents vertically from top to
6022 * By calling this function with @p horizontal as EINA_TRUE, the box will
6023 * become horizontal, arranging contents from left to right.
6025 * @note This flag is ignored if a custom layout function is set.
6027 * @param obj The box object
6028 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6029 * EINA_FALSE = vertical)
6031 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6033 * Get the horizontal orientation
6035 * @param obj The box object
6036 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6038 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6040 * Set the box to arrange its children homogeneously
6042 * If enabled, homogeneous layout makes all items the same size, according
6043 * to the size of the largest of its children.
6045 * @note This flag is ignored if a custom layout function is set.
6047 * @param obj The box object
6048 * @param homogeneous The homogeneous flag
6050 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6052 * Get whether the box is using homogeneous mode or not
6054 * @param obj The box object
6055 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6057 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6058 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6059 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6061 * Add an object to the beginning of the pack list
6063 * Pack @p subobj into the box @p obj, placing it first in the list of
6064 * children objects. The actual position the object will get on screen
6065 * depends on the layout used. If no custom layout is set, it will be at
6066 * the top or left, depending if the box is vertical or horizontal,
6069 * @param obj The box object
6070 * @param subobj The object to add to the box
6072 * @see elm_box_pack_end()
6073 * @see elm_box_pack_before()
6074 * @see elm_box_pack_after()
6075 * @see elm_box_unpack()
6076 * @see elm_box_unpack_all()
6077 * @see elm_box_clear()
6079 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6081 * Add an object at the end of the pack list
6083 * Pack @p subobj into the box @p obj, placing it last in the list of
6084 * children objects. The actual position the object will get on screen
6085 * depends on the layout used. If no custom layout is set, it will be at
6086 * the bottom or right, depending if the box is vertical or horizontal,
6089 * @param obj The box object
6090 * @param subobj The object to add to the box
6092 * @see elm_box_pack_start()
6093 * @see elm_box_pack_before()
6094 * @see elm_box_pack_after()
6095 * @see elm_box_unpack()
6096 * @see elm_box_unpack_all()
6097 * @see elm_box_clear()
6099 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6101 * Adds an object to the box before the indicated object
6103 * This will add the @p subobj to the box indicated before the object
6104 * indicated with @p before. If @p before is not already in the box, results
6105 * are undefined. Before means either to the left of the indicated object or
6106 * above it depending on orientation.
6108 * @param obj The box object
6109 * @param subobj The object to add to the box
6110 * @param before The object before which to add it
6112 * @see elm_box_pack_start()
6113 * @see elm_box_pack_end()
6114 * @see elm_box_pack_after()
6115 * @see elm_box_unpack()
6116 * @see elm_box_unpack_all()
6117 * @see elm_box_clear()
6119 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6121 * Adds an object to the box after the indicated object
6123 * This will add the @p subobj to the box indicated after the object
6124 * indicated with @p after. If @p after is not already in the box, results
6125 * are undefined. After means either to the right of the indicated object or
6126 * below it depending on orientation.
6128 * @param obj The box object
6129 * @param subobj The object to add to the box
6130 * @param after The object after which to add it
6132 * @see elm_box_pack_start()
6133 * @see elm_box_pack_end()
6134 * @see elm_box_pack_before()
6135 * @see elm_box_unpack()
6136 * @see elm_box_unpack_all()
6137 * @see elm_box_clear()
6139 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6141 * Clear the box of all children
6143 * Remove all the elements contained by the box, deleting the respective
6146 * @param obj The box object
6148 * @see elm_box_unpack()
6149 * @see elm_box_unpack_all()
6151 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6155 * Remove the object given by @p subobj from the box @p obj without
6158 * @param obj The box object
6160 * @see elm_box_unpack_all()
6161 * @see elm_box_clear()
6163 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6165 * Remove all items from the box, without deleting them
6167 * Clear the box from all children, but don't delete the respective objects.
6168 * If no other references of the box children exist, the objects will never
6169 * be deleted, and thus the application will leak the memory. Make sure
6170 * when using this function that you hold a reference to all the objects
6171 * in the box @p obj.
6173 * @param obj The box object
6175 * @see elm_box_clear()
6176 * @see elm_box_unpack()
6178 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6180 * Retrieve a list of the objects packed into the box
6182 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6183 * The order of the list corresponds to the packing order the box uses.
6185 * You must free this list with eina_list_free() once you are done with it.
6187 * @param obj The box object
6189 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6191 * Set the space (padding) between the box's elements.
6193 * Extra space in pixels that will be added between a box child and its
6194 * neighbors after its containing cell has been calculated. This padding
6195 * is set for all elements in the box, besides any possible padding that
6196 * individual elements may have through their size hints.
6198 * @param obj The box object
6199 * @param horizontal The horizontal space between elements
6200 * @param vertical The vertical space between elements
6202 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6204 * Get the space (padding) between the box's elements.
6206 * @param obj The box object
6207 * @param horizontal The horizontal space between elements
6208 * @param vertical The vertical space between elements
6210 * @see elm_box_padding_set()
6212 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6214 * Set the alignment of the whole bouding box of contents.
6216 * Sets how the bounding box containing all the elements of the box, after
6217 * their sizes and position has been calculated, will be aligned within
6218 * the space given for the whole box widget.
6220 * @param obj The box object
6221 * @param horizontal The horizontal alignment of elements
6222 * @param vertical The vertical alignment of elements
6224 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6226 * Get the alignment of the whole bouding box of contents.
6228 * @param obj The box object
6229 * @param horizontal The horizontal alignment of elements
6230 * @param vertical The vertical alignment of elements
6232 * @see elm_box_align_set()
6234 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6237 * Force the box to recalculate its children packing.
6239 * If any children was added or removed, box will not calculate the
6240 * values immediately rather leaving it to the next main loop
6241 * iteration. While this is great as it would save lots of
6242 * recalculation, whenever you need to get the position of a just
6243 * added item you must force recalculate before doing so.
6245 * @param obj The box object.
6247 EAPI void elm_box_recalculate(Evas_Object *obj);
6250 * Set the layout defining function to be used by the box
6252 * Whenever anything changes that requires the box in @p obj to recalculate
6253 * the size and position of its elements, the function @p cb will be called
6254 * to determine what the layout of the children will be.
6256 * Once a custom function is set, everything about the children layout
6257 * is defined by it. The flags set by elm_box_horizontal_set() and
6258 * elm_box_homogeneous_set() no longer have any meaning, and the values
6259 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6260 * layout function to decide if they are used and how. These last two
6261 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6262 * passed to @p cb. The @c Evas_Object the function receives is not the
6263 * Elementary widget, but the internal Evas Box it uses, so none of the
6264 * functions described here can be used on it.
6266 * Any of the layout functions in @c Evas can be used here, as well as the
6267 * special elm_box_layout_transition().
6269 * The final @p data argument received by @p cb is the same @p data passed
6270 * here, and the @p free_data function will be called to free it
6271 * whenever the box is destroyed or another layout function is set.
6273 * Setting @p cb to NULL will revert back to the default layout function.
6275 * @param obj The box object
6276 * @param cb The callback function used for layout
6277 * @param data Data that will be passed to layout function
6278 * @param free_data Function called to free @p data
6280 * @see elm_box_layout_transition()
6282 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);
6284 * Special layout function that animates the transition from one layout to another
6286 * Normally, when switching the layout function for a box, this will be
6287 * reflected immediately on screen on the next render, but it's also
6288 * possible to do this through an animated transition.
6290 * This is done by creating an ::Elm_Box_Transition and setting the box
6291 * layout to this function.
6295 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6296 * evas_object_box_layout_vertical, // start
6297 * NULL, // data for initial layout
6298 * NULL, // free function for initial data
6299 * evas_object_box_layout_horizontal, // end
6300 * NULL, // data for final layout
6301 * NULL, // free function for final data
6302 * anim_end, // will be called when animation ends
6303 * NULL); // data for anim_end function\
6304 * elm_box_layout_set(box, elm_box_layout_transition, t,
6305 * elm_box_transition_free);
6308 * @note This function can only be used with elm_box_layout_set(). Calling
6309 * it directly will not have the expected results.
6311 * @see elm_box_transition_new
6312 * @see elm_box_transition_free
6313 * @see elm_box_layout_set
6315 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6317 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6319 * If you want to animate the change from one layout to another, you need
6320 * to set the layout function of the box to elm_box_layout_transition(),
6321 * passing as user data to it an instance of ::Elm_Box_Transition with the
6322 * necessary information to perform this animation. The free function to
6323 * set for the layout is elm_box_transition_free().
6325 * The parameters to create an ::Elm_Box_Transition sum up to how long
6326 * will it be, in seconds, a layout function to describe the initial point,
6327 * another for the final position of the children and one function to be
6328 * called when the whole animation ends. This last function is useful to
6329 * set the definitive layout for the box, usually the same as the end
6330 * layout for the animation, but could be used to start another transition.
6332 * @param start_layout The layout function that will be used to start the animation
6333 * @param start_layout_data The data to be passed the @p start_layout function
6334 * @param start_layout_free_data Function to free @p start_layout_data
6335 * @param end_layout The layout function that will be used to end the animation
6336 * @param end_layout_free_data The data to be passed the @p end_layout function
6337 * @param end_layout_free_data Function to free @p end_layout_data
6338 * @param transition_end_cb Callback function called when animation ends
6339 * @param transition_end_data Data to be passed to @p transition_end_cb
6340 * @return An instance of ::Elm_Box_Transition
6342 * @see elm_box_transition_new
6343 * @see elm_box_layout_transition
6345 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);
6347 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6349 * This function is mostly useful as the @c free_data parameter in
6350 * elm_box_layout_set() when elm_box_layout_transition().
6352 * @param data The Elm_Box_Transition instance to be freed.
6354 * @see elm_box_transition_new
6355 * @see elm_box_layout_transition
6357 EAPI void elm_box_transition_free(void *data);
6364 * @defgroup Button Button
6366 * @image html img/widget/button/preview-00.png
6367 * @image latex img/widget/button/preview-00.eps
6368 * @image html img/widget/button/preview-01.png
6369 * @image latex img/widget/button/preview-01.eps
6370 * @image html img/widget/button/preview-02.png
6371 * @image latex img/widget/button/preview-02.eps
6373 * This is a push-button. Press it and run some function. It can contain
6374 * a simple label and icon object and it also has an autorepeat feature.
6376 * This widgets emits the following signals:
6377 * @li "clicked": the user clicked the button (press/release).
6378 * @li "repeated": the user pressed the button without releasing it.
6379 * @li "pressed": button was pressed.
6380 * @li "unpressed": button was released after being pressed.
6381 * In all three cases, the @c event parameter of the callback will be
6384 * Also, defined in the default theme, the button has the following styles
6386 * @li default: a normal button.
6387 * @li anchor: Like default, but the button fades away when the mouse is not
6388 * over it, leaving only the text or icon.
6389 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6390 * continuous look across its options.
6391 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6393 * Default contents parts of the button widget that you can use for are:
6394 * @li "icon" - A icon of the button
6396 * Default text parts of the button widget that you can use for are:
6397 * @li "default" - Label of the button
6399 * Follow through a complete example @ref button_example_01 "here".
6405 UIControlStateDefault,
6406 UIControlStateHighlighted,
6407 UIControlStateDisabled,
6408 UIControlStateFocused,
6409 UIControlStateReserved
6413 * Add a new button to the parent's canvas
6415 * @param parent The parent object
6416 * @return The new object or NULL if it cannot be created
6418 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6420 * Set the label used in the button
6422 * The passed @p label can be NULL to clean any existing text in it and
6423 * leave the button as an icon only object.
6425 * @param obj The button object
6426 * @param label The text will be written on the button
6427 * @deprecated use elm_object_text_set() instead.
6429 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6431 * Get the label set for the button
6433 * The string returned is an internal pointer and should not be freed or
6434 * altered. It will also become invalid when the button is destroyed.
6435 * The string returned, if not NULL, is a stringshare, so if you need to
6436 * keep it around even after the button is destroyed, you can use
6437 * eina_stringshare_ref().
6439 * @param obj The button object
6440 * @return The text set to the label, or NULL if nothing is set
6441 * @deprecated use elm_object_text_set() instead.
6443 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6445 * Set the icon used for the button
6447 * Setting a new icon will delete any other that was previously set, making
6448 * any reference to them invalid. If you need to maintain the previous
6449 * object alive, unset it first with elm_button_icon_unset().
6451 * @param obj The button object
6452 * @param icon The icon object for the button
6453 * @deprecated use elm_object_part_content_set() instead.
6455 WILL_DEPRECATE EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6457 * Get the icon used for the button
6459 * Return the icon object which is set for this widget. If the button is
6460 * destroyed or another icon is set, the returned object will be deleted
6461 * and any reference to it will be invalid.
6463 * @param obj The button object
6464 * @return The icon object that is being used
6466 * @deprecated use elm_object_part_content_get() instead
6468 WILL_DEPRECATE EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6470 * Remove the icon set without deleting it and return the object
6472 * This function drops the reference the button holds of the icon object
6473 * and returns this last object. It is used in case you want to remove any
6474 * icon, or set another one, without deleting the actual object. The button
6475 * will be left without an icon set.
6477 * @param obj The button object
6478 * @return The icon object that was being used
6479 * @deprecated use elm_object_part_content_unset() instead.
6481 WILL_DEPRECATE EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6483 * Turn on/off the autorepeat event generated when the button is kept pressed
6485 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6486 * signal when they are clicked.
6488 * When on, keeping a button pressed will continuously emit a @c repeated
6489 * signal until the button is released. The time it takes until it starts
6490 * emitting the signal is given by
6491 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6492 * new emission by elm_button_autorepeat_gap_timeout_set().
6494 * @param obj The button object
6495 * @param on A bool to turn on/off the event
6497 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6499 * Get whether the autorepeat feature is enabled
6501 * @param obj The button object
6502 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6504 * @see elm_button_autorepeat_set()
6506 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6508 * Set the initial timeout before the autorepeat event is generated
6510 * Sets the timeout, in seconds, since the button is pressed until the
6511 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6512 * won't be any delay and the even will be fired the moment the button is
6515 * @param obj The button object
6516 * @param t Timeout in seconds
6518 * @see elm_button_autorepeat_set()
6519 * @see elm_button_autorepeat_gap_timeout_set()
6521 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6523 * Get the initial timeout before the autorepeat event is generated
6525 * @param obj The button object
6526 * @return Timeout in seconds
6528 * @see elm_button_autorepeat_initial_timeout_set()
6530 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6532 * Set the interval between each generated autorepeat event
6534 * After the first @c repeated event is fired, all subsequent ones will
6535 * follow after a delay of @p t seconds for each.
6537 * @param obj The button object
6538 * @param t Interval in seconds
6540 * @see elm_button_autorepeat_initial_timeout_set()
6542 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6544 * Get the interval between each generated autorepeat event
6546 * @param obj The button object
6547 * @return Interval in seconds
6549 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6555 * @defgroup File_Selector_Button File Selector Button
6557 * @image html img/widget/fileselector_button/preview-00.png
6558 * @image latex img/widget/fileselector_button/preview-00.eps
6559 * @image html img/widget/fileselector_button/preview-01.png
6560 * @image latex img/widget/fileselector_button/preview-01.eps
6561 * @image html img/widget/fileselector_button/preview-02.png
6562 * @image latex img/widget/fileselector_button/preview-02.eps
6564 * This is a button that, when clicked, creates an Elementary
6565 * window (or inner window) <b> with a @ref Fileselector "file
6566 * selector widget" within</b>. When a file is chosen, the (inner)
6567 * window is closed and the button emits a signal having the
6568 * selected file as it's @c event_info.
6570 * This widget encapsulates operations on its internal file
6571 * selector on its own API. There is less control over its file
6572 * selector than that one would have instatiating one directly.
6574 * The following styles are available for this button:
6577 * @li @c "hoversel_vertical"
6578 * @li @c "hoversel_vertical_entry"
6580 * Smart callbacks one can register to:
6581 * - @c "file,chosen" - the user has selected a path, whose string
6582 * pointer comes as the @c event_info data (a stringshared
6585 * Here is an example on its usage:
6586 * @li @ref fileselector_button_example
6588 * @see @ref File_Selector_Entry for a similar widget.
6593 * Add a new file selector button widget to the given parent
6594 * Elementary (container) object
6596 * @param parent The parent object
6597 * @return a new file selector button widget handle or @c NULL, on
6600 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6603 * Set the label for a given file selector button widget
6605 * @param obj The file selector button widget
6606 * @param label The text label to be displayed on @p obj
6608 * @deprecated use elm_object_text_set() instead.
6610 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6613 * Get the label set for a given file selector button widget
6615 * @param obj The file selector button widget
6616 * @return The button label
6618 * @deprecated use elm_object_text_set() instead.
6620 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6623 * Set the icon on a given file selector button widget
6625 * @param obj The file selector button widget
6626 * @param icon The icon object for the button
6628 * Once the icon object is set, a previously set one will be
6629 * deleted. If you want to keep the latter, use the
6630 * elm_fileselector_button_icon_unset() function.
6632 * @see elm_fileselector_button_icon_get()
6634 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6637 * Get the icon set for a given file selector button widget
6639 * @param obj The file selector button widget
6640 * @return The icon object currently set on @p obj or @c NULL, if
6643 * @see elm_fileselector_button_icon_set()
6645 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648 * Unset the icon used in a given file selector button widget
6650 * @param obj The file selector button widget
6651 * @return The icon object that was being used on @p obj or @c
6654 * Unparent and return the icon object which was set for this
6657 * @see elm_fileselector_button_icon_set()
6659 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6662 * Set the title for a given file selector button widget's window
6664 * @param obj The file selector button widget
6665 * @param title The title string
6667 * This will change the window's title, when the file selector pops
6668 * out after a click on the button. Those windows have the default
6669 * (unlocalized) value of @c "Select a file" as titles.
6671 * @note It will only take any effect if the file selector
6672 * button widget is @b not under "inwin mode".
6674 * @see elm_fileselector_button_window_title_get()
6676 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6679 * Get the title set for a given file selector button widget's
6682 * @param obj The file selector button widget
6683 * @return Title of the file selector button's window
6685 * @see elm_fileselector_button_window_title_get() for more details
6687 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690 * Set the size of a given file selector button widget's window,
6691 * holding the file selector itself.
6693 * @param obj The file selector button widget
6694 * @param width The window's width
6695 * @param height The window's height
6697 * @note it will only take any effect if the file selector button
6698 * widget is @b not under "inwin mode". The default size for the
6699 * window (when applicable) is 400x400 pixels.
6701 * @see elm_fileselector_button_window_size_get()
6703 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6706 * Get the size of a given file selector button widget's window,
6707 * holding the file selector itself.
6709 * @param obj The file selector button widget
6710 * @param width Pointer into which to store the width value
6711 * @param height Pointer into which to store the height value
6713 * @note Use @c NULL pointers on the size values you're not
6714 * interested in: they'll be ignored by the function.
6716 * @see elm_fileselector_button_window_size_set(), for more details
6718 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6721 * Set the initial file system path for a given file selector
6724 * @param obj The file selector button widget
6725 * @param path The path string
6727 * It must be a <b>directory</b> path, which will have the contents
6728 * displayed initially in the file selector's view, when invoked
6729 * from @p obj. The default initial path is the @c "HOME"
6730 * environment variable's value.
6732 * @see elm_fileselector_button_path_get()
6734 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6737 * Get the initial file system path set for a given file selector
6740 * @param obj The file selector button widget
6741 * @return path The path string
6743 * @see elm_fileselector_button_path_set() for more details
6745 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6748 * Enable/disable a tree view in the given file selector button
6749 * widget's internal file selector
6751 * @param obj The file selector button widget
6752 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6755 * This has the same effect as elm_fileselector_expandable_set(),
6756 * but now applied to a file selector button's internal file
6759 * @note There's no way to put a file selector button's internal
6760 * file selector in "grid mode", as one may do with "pure" file
6763 * @see elm_fileselector_expandable_get()
6765 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6768 * Get whether tree view is enabled for the given file selector
6769 * button widget's internal file selector
6771 * @param obj The file selector button widget
6772 * @return @c EINA_TRUE if @p obj widget's internal file selector
6773 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6775 * @see elm_fileselector_expandable_set() for more details
6777 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6780 * Set whether a given file selector button widget's internal file
6781 * selector is to display folders only or the directory contents,
6784 * @param obj The file selector button widget
6785 * @param only @c EINA_TRUE to make @p obj widget's internal file
6786 * selector only display directories, @c EINA_FALSE to make files
6787 * to be displayed in it too
6789 * This has the same effect as elm_fileselector_folder_only_set(),
6790 * but now applied to a file selector button's internal file
6793 * @see elm_fileselector_folder_only_get()
6795 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6798 * Get whether a given file selector button widget's internal file
6799 * selector is displaying folders only or the directory contents,
6802 * @param obj The file selector button widget
6803 * @return @c EINA_TRUE if @p obj widget's internal file
6804 * selector is only displaying directories, @c EINA_FALSE if files
6805 * are being displayed in it too (and on errors)
6807 * @see elm_fileselector_button_folder_only_set() for more details
6809 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6812 * Enable/disable the file name entry box where the user can type
6813 * in a name for a file, in a given file selector button widget's
6814 * internal file selector.
6816 * @param obj The file selector button widget
6817 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6818 * file selector a "saving dialog", @c EINA_FALSE otherwise
6820 * This has the same effect as elm_fileselector_is_save_set(),
6821 * but now applied to a file selector button's internal file
6824 * @see elm_fileselector_is_save_get()
6826 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6829 * Get whether the given file selector button widget's internal
6830 * file selector is in "saving dialog" mode
6832 * @param obj The file selector button widget
6833 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6834 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6837 * @see elm_fileselector_button_is_save_set() for more details
6839 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6842 * Set whether a given file selector button widget's internal file
6843 * selector will raise an Elementary "inner window", instead of a
6844 * dedicated Elementary window. By default, it won't.
6846 * @param obj The file selector button widget
6847 * @param value @c EINA_TRUE to make it use an inner window, @c
6848 * EINA_TRUE to make it use a dedicated window
6850 * @see elm_win_inwin_add() for more information on inner windows
6851 * @see elm_fileselector_button_inwin_mode_get()
6853 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6856 * Get whether a given file selector button widget's internal file
6857 * selector will raise an Elementary "inner window", instead of a
6858 * dedicated Elementary window.
6860 * @param obj The file selector button widget
6861 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6862 * if it will use a dedicated window
6864 * @see elm_fileselector_button_inwin_mode_set() for more details
6866 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6873 * @defgroup File_Selector_Entry File Selector Entry
6875 * @image html img/widget/fileselector_entry/preview-00.png
6876 * @image latex img/widget/fileselector_entry/preview-00.eps
6878 * This is an entry made to be filled with or display a <b>file
6879 * system path string</b>. Besides the entry itself, the widget has
6880 * a @ref File_Selector_Button "file selector button" on its side,
6881 * which will raise an internal @ref Fileselector "file selector widget",
6882 * when clicked, for path selection aided by file system
6885 * This file selector may appear in an Elementary window or in an
6886 * inner window. When a file is chosen from it, the (inner) window
6887 * is closed and the selected file's path string is exposed both as
6888 * an smart event and as the new text on the entry.
6890 * This widget encapsulates operations on its internal file
6891 * selector on its own API. There is less control over its file
6892 * selector than that one would have instatiating one directly.
6894 * Smart callbacks one can register to:
6895 * - @c "changed" - The text within the entry was changed
6896 * - @c "activated" - The entry has had editing finished and
6897 * changes are to be "committed"
6898 * - @c "press" - The entry has been clicked
6899 * - @c "longpressed" - The entry has been clicked (and held) for a
6901 * - @c "clicked" - The entry has been clicked
6902 * - @c "clicked,double" - The entry has been double clicked
6903 * - @c "focused" - The entry has received focus
6904 * - @c "unfocused" - The entry has lost focus
6905 * - @c "selection,paste" - A paste action has occurred on the
6907 * - @c "selection,copy" - A copy action has occurred on the entry
6908 * - @c "selection,cut" - A cut action has occurred on the entry
6909 * - @c "unpressed" - The file selector entry's button was released
6910 * after being pressed.
6911 * - @c "file,chosen" - The user has selected a path via the file
6912 * selector entry's internal file selector, whose string pointer
6913 * comes as the @c event_info data (a stringshared string)
6915 * Here is an example on its usage:
6916 * @li @ref fileselector_entry_example
6918 * @see @ref File_Selector_Button for a similar widget.
6923 * Add a new file selector entry widget to the given parent
6924 * Elementary (container) object
6926 * @param parent The parent object
6927 * @return a new file selector entry widget handle or @c NULL, on
6930 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6933 * Set the label for a given file selector entry widget's button
6935 * @param obj The file selector entry widget
6936 * @param label The text label to be displayed on @p obj widget's
6939 * @deprecated use elm_object_text_set() instead.
6941 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6944 * Get the label set for a given file selector entry widget's button
6946 * @param obj The file selector entry widget
6947 * @return The widget button's label
6949 * @deprecated use elm_object_text_set() instead.
6951 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6954 * Set the icon on a given file selector entry widget's button
6956 * @param obj The file selector entry widget
6957 * @param icon The icon object for the entry's button
6959 * Once the icon object is set, a previously set one will be
6960 * deleted. If you want to keep the latter, use the
6961 * elm_fileselector_entry_button_icon_unset() function.
6963 * @see elm_fileselector_entry_button_icon_get()
6965 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6968 * Get the icon set for a given file selector entry widget's button
6970 * @param obj The file selector entry widget
6971 * @return The icon object currently set on @p obj widget's button
6972 * or @c NULL, if none is
6974 * @see elm_fileselector_entry_button_icon_set()
6976 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6979 * Unset the icon used in a given file selector entry widget's
6982 * @param obj The file selector entry widget
6983 * @return The icon object that was being used on @p obj widget's
6984 * button or @c NULL, on errors
6986 * Unparent and return the icon object which was set for this
6989 * @see elm_fileselector_entry_button_icon_set()
6991 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6994 * Set the title for a given file selector entry widget's window
6996 * @param obj The file selector entry widget
6997 * @param title The title string
6999 * This will change the window's title, when the file selector pops
7000 * out after a click on the entry's button. Those windows have the
7001 * default (unlocalized) value of @c "Select a file" as titles.
7003 * @note It will only take any effect if the file selector
7004 * entry widget is @b not under "inwin mode".
7006 * @see elm_fileselector_entry_window_title_get()
7008 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7011 * Get the title set for a given file selector entry widget's
7014 * @param obj The file selector entry widget
7015 * @return Title of the file selector entry's window
7017 * @see elm_fileselector_entry_window_title_get() for more details
7019 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7022 * Set the size of a given file selector entry widget's window,
7023 * holding the file selector itself.
7025 * @param obj The file selector entry widget
7026 * @param width The window's width
7027 * @param height The window's height
7029 * @note it will only take any effect if the file selector entry
7030 * widget is @b not under "inwin mode". The default size for the
7031 * window (when applicable) is 400x400 pixels.
7033 * @see elm_fileselector_entry_window_size_get()
7035 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7038 * Get the size of a given file selector entry widget's window,
7039 * holding the file selector itself.
7041 * @param obj The file selector entry widget
7042 * @param width Pointer into which to store the width value
7043 * @param height Pointer into which to store the height value
7045 * @note Use @c NULL pointers on the size values you're not
7046 * interested in: they'll be ignored by the function.
7048 * @see elm_fileselector_entry_window_size_set(), for more details
7050 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7053 * Set the initial file system path and the entry's path string for
7054 * a given file selector entry widget
7056 * @param obj The file selector entry widget
7057 * @param path The path string
7059 * It must be a <b>directory</b> path, which will have the contents
7060 * displayed initially in the file selector's view, when invoked
7061 * from @p obj. The default initial path is the @c "HOME"
7062 * environment variable's value.
7064 * @see elm_fileselector_entry_path_get()
7066 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7069 * Get the entry's path string for a given file selector entry
7072 * @param obj The file selector entry widget
7073 * @return path The path string
7075 * @see elm_fileselector_entry_path_set() for more details
7077 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7080 * Enable/disable a tree view in the given file selector entry
7081 * widget's internal file selector
7083 * @param obj The file selector entry widget
7084 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7087 * This has the same effect as elm_fileselector_expandable_set(),
7088 * but now applied to a file selector entry's internal file
7091 * @note There's no way to put a file selector entry's internal
7092 * file selector in "grid mode", as one may do with "pure" file
7095 * @see elm_fileselector_expandable_get()
7097 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7100 * Get whether tree view is enabled for the given file selector
7101 * entry widget's internal file selector
7103 * @param obj The file selector entry widget
7104 * @return @c EINA_TRUE if @p obj widget's internal file selector
7105 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7107 * @see elm_fileselector_expandable_set() for more details
7109 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7112 * Set whether a given file selector entry widget's internal file
7113 * selector is to display folders only or the directory contents,
7116 * @param obj The file selector entry widget
7117 * @param only @c EINA_TRUE to make @p obj widget's internal file
7118 * selector only display directories, @c EINA_FALSE to make files
7119 * to be displayed in it too
7121 * This has the same effect as elm_fileselector_folder_only_set(),
7122 * but now applied to a file selector entry's internal file
7125 * @see elm_fileselector_folder_only_get()
7127 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7130 * Get whether a given file selector entry widget's internal file
7131 * selector is displaying folders only or the directory contents,
7134 * @param obj The file selector entry widget
7135 * @return @c EINA_TRUE if @p obj widget's internal file
7136 * selector is only displaying directories, @c EINA_FALSE if files
7137 * are being displayed in it too (and on errors)
7139 * @see elm_fileselector_entry_folder_only_set() for more details
7141 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7144 * Enable/disable the file name entry box where the user can type
7145 * in a name for a file, in a given file selector entry widget's
7146 * internal file selector.
7148 * @param obj The file selector entry widget
7149 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7150 * file selector a "saving dialog", @c EINA_FALSE otherwise
7152 * This has the same effect as elm_fileselector_is_save_set(),
7153 * but now applied to a file selector entry's internal file
7156 * @see elm_fileselector_is_save_get()
7158 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7161 * Get whether the given file selector entry widget's internal
7162 * file selector is in "saving dialog" mode
7164 * @param obj The file selector entry widget
7165 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7166 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7169 * @see elm_fileselector_entry_is_save_set() for more details
7171 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7174 * Set whether a given file selector entry widget's internal file
7175 * selector will raise an Elementary "inner window", instead of a
7176 * dedicated Elementary window. By default, it won't.
7178 * @param obj The file selector entry widget
7179 * @param value @c EINA_TRUE to make it use an inner window, @c
7180 * EINA_TRUE to make it use a dedicated window
7182 * @see elm_win_inwin_add() for more information on inner windows
7183 * @see elm_fileselector_entry_inwin_mode_get()
7185 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7188 * Get whether a given file selector entry widget's internal file
7189 * selector will raise an Elementary "inner window", instead of a
7190 * dedicated Elementary window.
7192 * @param obj The file selector entry widget
7193 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7194 * if it will use a dedicated window
7196 * @see elm_fileselector_entry_inwin_mode_set() for more details
7198 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7201 * Set the initial file system path for a given file selector entry
7204 * @param obj The file selector entry widget
7205 * @param path The path string
7207 * It must be a <b>directory</b> path, which will have the contents
7208 * displayed initially in the file selector's view, when invoked
7209 * from @p obj. The default initial path is the @c "HOME"
7210 * environment variable's value.
7212 * @see elm_fileselector_entry_path_get()
7214 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7217 * Get the parent directory's path to the latest file selection on
7218 * a given filer selector entry widget
7220 * @param obj The file selector object
7221 * @return The (full) path of the directory of the last selection
7222 * on @p obj widget, a @b stringshared string
7224 * @see elm_fileselector_entry_path_set()
7226 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7233 * @defgroup Scroller Scroller
7235 * A scroller holds a single object and "scrolls it around". This means that
7236 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7237 * region around, allowing to move through a much larger object that is
7238 * contained in the scroller. The scroller will always have a small minimum
7239 * size by default as it won't be limited by the contents of the scroller.
7241 * Signals that you can add callbacks for are:
7242 * @li "edge,left" - the left edge of the content has been reached
7243 * @li "edge,right" - the right edge of the content has been reached
7244 * @li "edge,top" - the top edge of the content has been reached
7245 * @li "edge,bottom" - the bottom edge of the content has been reached
7246 * @li "scroll" - the content has been scrolled (moved)
7247 * @li "scroll,anim,start" - scrolling animation has started
7248 * @li "scroll,anim,stop" - scrolling animation has stopped
7249 * @li "scroll,drag,start" - dragging the contents around has started
7250 * @li "scroll,drag,stop" - dragging the contents around has stopped
7251 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7254 * @note When Elemementary is in embedded mode the scrollbars will not be
7255 * dragable, they appear merely as indicators of how much has been scrolled.
7256 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7257 * fingerscroll) won't work.
7259 * Default contents parts of the scroller widget that you can use for are:
7260 * @li "default" - A content of the scroller
7262 * In @ref tutorial_scroller you'll find an example of how to use most of
7267 * @brief Type that controls when scrollbars should appear.
7269 * @see elm_scroller_policy_set()
7271 typedef enum _Elm_Scroller_Policy
7273 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7274 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7275 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7276 ELM_SCROLLER_POLICY_LAST
7277 } Elm_Scroller_Policy;
7279 * @brief Add a new scroller to the parent
7281 * @param parent The parent object
7282 * @return The new object or NULL if it cannot be created
7284 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7286 * @brief Set the content of the scroller widget (the object to be scrolled around).
7288 * @param obj The scroller object
7289 * @param content The new content object
7291 * Once the content object is set, a previously set one will be deleted.
7292 * If you want to keep that old content object, use the
7293 * elm_scroller_content_unset() function.
7294 * @deprecated use elm_object_content_set() instead
7296 WILL_DEPRECATE EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7298 * @brief Get the content of the scroller widget
7300 * @param obj The slider object
7301 * @return The content that is being used
7303 * Return the content object which is set for this widget
7305 * @see elm_scroller_content_set()
7306 * @deprecated use elm_object_content_get() instead.
7308 WILL_DEPRECATE EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7310 * @brief Unset the content of the scroller widget
7312 * @param obj The slider object
7313 * @return The content that was being used
7315 * Unparent and return the content object which was set for this widget
7317 * @see elm_scroller_content_set()
7318 * @deprecated use elm_object_content_unset() instead.
7320 WILL_DEPRECATE EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7322 * @brief Set custom theme elements for the scroller
7324 * @param obj The scroller object
7325 * @param widget The widget name to use (default is "scroller")
7326 * @param base The base name to use (default is "base")
7328 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7330 * @brief Make the scroller minimum size limited to the minimum size of the content
7332 * @param obj The scroller object
7333 * @param w Enable limiting minimum size horizontally
7334 * @param h Enable limiting minimum size vertically
7336 * By default the scroller will be as small as its design allows,
7337 * irrespective of its content. This will make the scroller minimum size the
7338 * right size horizontally and/or vertically to perfectly fit its content in
7341 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7343 * @brief Show a specific virtual region within the scroller content object
7345 * @param obj The scroller object
7346 * @param x X coordinate of the region
7347 * @param y Y coordinate of the region
7348 * @param w Width of the region
7349 * @param h Height of the region
7351 * This will ensure all (or part if it does not fit) of the designated
7352 * region in the virtual content object (0, 0 starting at the top-left of the
7353 * virtual content object) is shown within the scroller.
7355 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);
7357 * @brief Set the scrollbar visibility policy
7359 * @param obj The scroller object
7360 * @param policy_h Horizontal scrollbar policy
7361 * @param policy_v Vertical scrollbar policy
7363 * This sets the scrollbar visibility policy for the given scroller.
7364 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7365 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7366 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7367 * respectively for the horizontal and vertical scrollbars.
7369 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7371 * @brief Gets scrollbar visibility policy
7373 * @param obj The scroller object
7374 * @param policy_h Horizontal scrollbar policy
7375 * @param policy_v Vertical scrollbar policy
7377 * @see elm_scroller_policy_set()
7379 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7381 * @brief Get the currently visible content region
7383 * @param obj The scroller object
7384 * @param x X coordinate of the region
7385 * @param y Y coordinate of the region
7386 * @param w Width of the region
7387 * @param h Height of the region
7389 * This gets the current region in the content object that is visible through
7390 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7391 * w, @p h values pointed to.
7393 * @note All coordinates are relative to the content.
7395 * @see elm_scroller_region_show()
7397 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);
7399 * @brief Get the size of the content object
7401 * @param obj The scroller object
7402 * @param w Width of the content object.
7403 * @param h Height of the content object.
7405 * This gets the size of the content object of the scroller.
7407 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7409 * @brief Set bouncing behavior
7411 * @param obj The scroller object
7412 * @param h_bounce Allow bounce horizontally
7413 * @param v_bounce Allow bounce vertically
7415 * When scrolling, the scroller may "bounce" when reaching an edge of the
7416 * content object. This is a visual way to indicate the end has been reached.
7417 * This is enabled by default for both axis. This API will set if it is enabled
7418 * for the given axis with the boolean parameters for each axis.
7420 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7422 * @brief Get the bounce behaviour
7424 * @param obj The Scroller object
7425 * @param h_bounce Will the scroller bounce horizontally or not
7426 * @param v_bounce Will the scroller bounce vertically or not
7428 * @see elm_scroller_bounce_set()
7430 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7432 * @brief Set scroll page size relative to viewport size.
7434 * @param obj The scroller object
7435 * @param h_pagerel The horizontal page relative size
7436 * @param v_pagerel The vertical page relative size
7438 * The scroller is capable of limiting scrolling by the user to "pages". That
7439 * is to jump by and only show a "whole page" at a time as if the continuous
7440 * area of the scroller content is split into page sized pieces. This sets
7441 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7442 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7443 * axis. This is mutually exclusive with page size
7444 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7445 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7446 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7449 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7451 * @brief Set scroll page size.
7453 * @param obj The scroller object
7454 * @param h_pagesize The horizontal page size
7455 * @param v_pagesize The vertical page size
7457 * This sets the page size to an absolute fixed value, with 0 turning it off
7460 * @see elm_scroller_page_relative_set()
7462 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7464 * @brief Get scroll current page number.
7466 * @param obj The scroller object
7467 * @param h_pagenumber The horizontal page number
7468 * @param v_pagenumber The vertical page number
7470 * The page number starts from 0. 0 is the first page.
7471 * Current page means the page which meets the top-left of the viewport.
7472 * If there are two or more pages in the viewport, it returns the number of the page
7473 * which meets the top-left of the viewport.
7475 * @see elm_scroller_last_page_get()
7476 * @see elm_scroller_page_show()
7477 * @see elm_scroller_page_brint_in()
7479 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7481 * @brief Get scroll last page number.
7483 * @param obj The scroller object
7484 * @param h_pagenumber The horizontal page number
7485 * @param v_pagenumber The vertical page number
7487 * The page number starts from 0. 0 is the first page.
7488 * This returns the last page number among the pages.
7490 * @see elm_scroller_current_page_get()
7491 * @see elm_scroller_page_show()
7492 * @see elm_scroller_page_brint_in()
7494 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7496 * Show a specific virtual region within the scroller content object by page number.
7498 * @param obj The scroller object
7499 * @param h_pagenumber The horizontal page number
7500 * @param v_pagenumber The vertical page number
7502 * 0, 0 of the indicated page is located at the top-left of the viewport.
7503 * This will jump to the page directly without animation.
7508 * sc = elm_scroller_add(win);
7509 * elm_scroller_content_set(sc, content);
7510 * elm_scroller_page_relative_set(sc, 1, 0);
7511 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7512 * elm_scroller_page_show(sc, h_page + 1, v_page);
7515 * @see elm_scroller_page_bring_in()
7517 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7519 * Show a specific virtual region within the scroller content object by page number.
7521 * @param obj The scroller object
7522 * @param h_pagenumber The horizontal page number
7523 * @param v_pagenumber The vertical page number
7525 * 0, 0 of the indicated page is located at the top-left of the viewport.
7526 * This will slide to the page with animation.
7531 * sc = elm_scroller_add(win);
7532 * elm_scroller_content_set(sc, content);
7533 * elm_scroller_page_relative_set(sc, 1, 0);
7534 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7535 * elm_scroller_page_bring_in(sc, h_page, v_page);
7538 * @see elm_scroller_page_show()
7540 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7542 * @brief Show a specific virtual region within the scroller content object.
7544 * @param obj The scroller object
7545 * @param x X coordinate of the region
7546 * @param y Y coordinate of the region
7547 * @param w Width of the region
7548 * @param h Height of the region
7550 * This will ensure all (or part if it does not fit) of the designated
7551 * region in the virtual content object (0, 0 starting at the top-left of the
7552 * virtual content object) is shown within the scroller. Unlike
7553 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7554 * to this location (if configuration in general calls for transitions). It
7555 * may not jump immediately to the new location and make take a while and
7556 * show other content along the way.
7558 * @see elm_scroller_region_show()
7560 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);
7562 * @brief Set event propagation on a scroller
7564 * @param obj The scroller object
7565 * @param propagation If propagation is enabled or not
7567 * This enables or disabled event propagation from the scroller content to
7568 * the scroller and its parent. By default event propagation is disabled.
7570 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7572 * @brief Get event propagation for a scroller
7574 * @param obj The scroller object
7575 * @return The propagation state
7577 * This gets the event propagation for a scroller.
7579 * @see elm_scroller_propagate_events_set()
7581 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7583 * @brief Set scrolling gravity on a scroller
7585 * @param obj The scroller object
7586 * @param x The scrolling horizontal gravity
7587 * @param y The scrolling vertical gravity
7589 * The gravity, defines how the scroller will adjust its view
7590 * when the size of the scroller contents increase.
7592 * The scroller will adjust the view to glue itself as follows.
7594 * x=0.0, for showing the left most region of the content.
7595 * x=1.0, for showing the right most region of the content.
7596 * y=0.0, for showing the bottom most region of the content.
7597 * y=1.0, for showing the top most region of the content.
7599 * Default values for x and y are 0.0
7601 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7603 * @brief Get scrolling gravity values for a scroller
7605 * @param obj The scroller object
7606 * @param x The scrolling horizontal gravity
7607 * @param y The scrolling vertical gravity
7609 * This gets gravity values for a scroller.
7611 * @see elm_scroller_gravity_set()
7614 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7620 * @defgroup Label Label
7622 * @image html img/widget/label/preview-00.png
7623 * @image latex img/widget/label/preview-00.eps
7625 * @brief Widget to display text, with simple html-like markup.
7627 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7628 * text doesn't fit the geometry of the label it will be ellipsized or be
7629 * cut. Elementary provides several styles for this widget:
7630 * @li default - No animation
7631 * @li marker - Centers the text in the label and make it bold by default
7632 * @li slide_long - The entire text appears from the right of the screen and
7633 * slides until it disappears in the left of the screen(reappering on the
7635 * @li slide_short - The text appears in the left of the label and slides to
7636 * the right to show the overflow. When all of the text has been shown the
7637 * position is reset.
7638 * @li slide_bounce - The text appears in the left of the label and slides to
7639 * the right to show the overflow. When all of the text has been shown the
7640 * animation reverses, moving the text to the left.
7642 * Custom themes can of course invent new markup tags and style them any way
7645 * The following signals may be emitted by the label widget:
7646 * @li "language,changed": The program's language changed.
7648 * See @ref tutorial_label for a demonstration of how to use a label widget.
7652 * @brief Add a new label to the parent
7654 * @param parent The parent object
7655 * @return The new object or NULL if it cannot be created
7657 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7659 * @brief Set the label on the label object
7661 * @param obj The label object
7662 * @param label The label will be used on the label object
7663 * @deprecated See elm_object_text_set()
7665 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 */
7667 * @brief Get the label used on the label object
7669 * @param obj The label object
7670 * @return The string inside the label
7671 * @deprecated See elm_object_text_get()
7673 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7675 * @brief Set the wrapping behavior of the label
7677 * @param obj The label object
7678 * @param wrap To wrap text or not
7680 * By default no wrapping is done. Possible values for @p wrap are:
7681 * @li ELM_WRAP_NONE - No wrapping
7682 * @li ELM_WRAP_CHAR - wrap between characters
7683 * @li ELM_WRAP_WORD - wrap between words
7684 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7686 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7688 * @brief Get the wrapping behavior of the label
7690 * @param obj The label object
7693 * @see elm_label_line_wrap_set()
7695 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7697 * @brief Set wrap width of the label
7699 * @param obj The label object
7700 * @param w The wrap width in pixels at a minimum where words need to wrap
7702 * This function sets the maximum width size hint of the label.
7704 * @warning This is only relevant if the label is inside a container.
7706 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7708 * @brief Get wrap width of the label
7710 * @param obj The label object
7711 * @return The wrap width in pixels at a minimum where words need to wrap
7713 * @see elm_label_wrap_width_set()
7715 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7717 * @brief Set wrap height of the label
7719 * @param obj The label object
7720 * @param h The wrap height in pixels at a minimum where words need to wrap
7722 * This function sets the maximum height size hint of the label.
7724 * @warning This is only relevant if the label is inside a container.
7726 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7728 * @brief get wrap width of the label
7730 * @param obj The label object
7731 * @return The wrap height in pixels at a minimum where words need to wrap
7733 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7735 * @brief Set the font size on the label object.
7737 * @param obj The label object
7738 * @param size font size
7740 * @warning NEVER use this. It is for hyper-special cases only. use styles
7741 * instead. e.g. "default", "marker", "slide_long" etc.
7743 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7745 * @brief Set the text color on the label object
7747 * @param obj The label object
7748 * @param r Red property background color of The label object
7749 * @param g Green property background color of The label object
7750 * @param b Blue property background color of The label object
7751 * @param a Alpha property background color of The label object
7753 * @warning NEVER use this. It is for hyper-special cases only. use styles
7754 * instead. e.g. "default", "marker", "slide_long" etc.
7756 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);
7758 * @brief Set the text align on the label object
7760 * @param obj The label object
7761 * @param align align mode ("left", "center", "right")
7763 * @warning NEVER use this. It is for hyper-special cases only. use styles
7764 * instead. e.g. "default", "marker", "slide_long" etc.
7766 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7768 * @brief Set background color of the label
7770 * @param obj The label object
7771 * @param r Red property background color of The label object
7772 * @param g Green property background color of The label object
7773 * @param b Blue property background color of The label object
7774 * @param a Alpha property background alpha of The label object
7776 * @warning NEVER use this. It is for hyper-special cases only. use styles
7777 * instead. e.g. "default", "marker", "slide_long" etc.
7779 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);
7781 * @brief Set the ellipsis behavior of the label
7783 * @param obj The label object
7784 * @param ellipsis To ellipsis text or not
7786 * If set to true and the text doesn't fit in the label an ellipsis("...")
7787 * will be shown at the end of the widget.
7789 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7790 * choosen wrap method was ELM_WRAP_WORD.
7792 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7794 * @brief Set the text slide of the label
7796 * @param obj The label object
7797 * @param slide To start slide or stop
7799 * If set to true, the text of the label will slide/scroll through the length of
7802 * @warning This only works with the themes "slide_short", "slide_long" and
7805 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7807 * @brief Get the text slide mode of the label
7809 * @param obj The label object
7810 * @return slide slide mode value
7812 * @see elm_label_slide_set()
7814 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7816 * @brief Set the slide duration(speed) of the label
7818 * @param obj The label object
7819 * @return The duration in seconds in moving text from slide begin position
7820 * to slide end position
7822 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7824 * @brief Get the slide duration(speed) of the label
7826 * @param obj The label object
7827 * @return The duration time in moving text from slide begin position to slide end position
7829 * @see elm_label_slide_duration_set()
7831 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7837 * @defgroup Frame Frame
7839 * @image html img/widget/frame/preview-00.png
7840 * @image latex img/widget/frame/preview-00.eps
7842 * @brief Frame is a widget that holds some content and has a title.
7844 * The default look is a frame with a title, but Frame supports multple
7852 * @li outdent_bottom
7854 * Of all this styles only default shows the title. Frame emits no signals.
7856 * Default contents parts of the frame widget that you can use for are:
7857 * @li "default" - A content of the frame
7859 * Default text parts of the frame widget that you can use for are:
7860 * @li "elm.text" - Label of the frame
7862 * For a detailed example see the @ref tutorial_frame.
7867 * @brief Add a new frame to the parent
7869 * @param parent The parent object
7870 * @return The new object or NULL if it cannot be created
7872 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7874 * @brief Set the frame label
7876 * @param obj The frame object
7877 * @param label The label of this frame object
7879 * @deprecated use elm_object_text_set() instead.
7881 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7883 * @brief Get the frame label
7885 * @param obj The frame object
7887 * @return The label of this frame objet or NULL if unable to get frame
7889 * @deprecated use elm_object_text_get() instead.
7891 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7893 * @brief Set the content of the frame widget
7895 * Once the content object is set, a previously set one will be deleted.
7896 * If you want to keep that old content object, use the
7897 * elm_frame_content_unset() function.
7899 * @param obj The frame object
7900 * @param content The content will be filled in this frame object
7902 * @deprecated use elm_object_content_set() instead.
7904 WILL_DEPRECATE EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7906 * @brief Get the content of the frame widget
7908 * Return the content object which is set for this widget
7910 * @param obj The frame object
7911 * @return The content that is being used
7913 * @deprecated use elm_object_content_get() instead.
7915 WILL_DEPRECATE EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7917 * @brief Unset the content of the frame widget
7919 * Unparent and return the content object which was set for this widget
7921 * @param obj The frame object
7922 * @return The content that was being used
7924 * @deprecated use elm_object_content_unset() instead.
7926 WILL_DEPRECATE EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7932 * @defgroup Table Table
7934 * A container widget to arrange other widgets in a table where items can
7935 * also span multiple columns or rows - even overlap (and then be raised or
7936 * lowered accordingly to adjust stacking if they do overlap).
7938 * For a Table widget the row/column count is not fixed.
7939 * The table widget adjusts itself when subobjects are added to it dynamically.
7941 * The followin are examples of how to use a table:
7942 * @li @ref tutorial_table_01
7943 * @li @ref tutorial_table_02
7948 * @brief Add a new table to the parent
7950 * @param parent The parent object
7951 * @return The new object or NULL if it cannot be created
7953 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7955 * @brief Set the homogeneous layout in the table
7957 * @param obj The layout object
7958 * @param homogeneous A boolean to set if the layout is homogeneous in the
7959 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7961 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7963 * @brief Get the current table homogeneous mode.
7965 * @param obj The table object
7966 * @return A boolean to indicating if the layout is homogeneous in the table
7967 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7969 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7971 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7973 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7975 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7977 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7979 * @brief Set padding between cells.
7981 * @param obj The layout object.
7982 * @param horizontal set the horizontal padding.
7983 * @param vertical set the vertical padding.
7985 * Default value is 0.
7987 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7989 * @brief Get padding between cells.
7991 * @param obj The layout object.
7992 * @param horizontal set the horizontal padding.
7993 * @param vertical set the vertical padding.
7995 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7997 * @brief Add a subobject on the table with the coordinates passed
7999 * @param obj The table object
8000 * @param subobj The subobject to be added to the table
8001 * @param x Row number
8002 * @param y Column number
8006 * @note All positioning inside the table is relative to rows and columns, so
8007 * a value of 0 for x and y, means the top left cell of the table, and a
8008 * value of 1 for w and h means @p subobj only takes that 1 cell.
8010 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8012 * @brief Remove child from table.
8014 * @param obj The table object
8015 * @param subobj The subobject
8017 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8019 * @brief Faster way to remove all child objects from a table object.
8021 * @param obj The table object
8022 * @param clear If true, will delete children, else just remove from table.
8024 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8026 * @brief Set the packing location of an existing child of the table
8028 * @param subobj The subobject to be modified in the table
8029 * @param x Row number
8030 * @param y Column number
8034 * Modifies the position of an object already in the table.
8036 * @note All positioning inside the table is relative to rows and columns, so
8037 * a value of 0 for x and y, means the top left cell of the table, and a
8038 * value of 1 for w and h means @p subobj only takes that 1 cell.
8040 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8042 * @brief Get the packing location of an existing child of the table
8044 * @param subobj The subobject to be modified in the table
8045 * @param x Row number
8046 * @param y Column number
8050 * @see elm_table_pack_set()
8052 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8058 * @defgroup Gengrid Gengrid (Generic grid)
8060 * This widget aims to position objects in a grid layout while
8061 * actually creating and rendering only the visible ones, using the
8062 * same idea as the @ref Genlist "genlist": the user defines a @b
8063 * class for each item, specifying functions that will be called at
8064 * object creation, deletion, etc. When those items are selected by
8065 * the user, a callback function is issued. Users may interact with
8066 * a gengrid via the mouse (by clicking on items to select them and
8067 * clicking on the grid's viewport and swiping to pan the whole
8068 * view) or via the keyboard, navigating through item with the
8071 * @section Gengrid_Layouts Gengrid layouts
8073 * Gengrid may layout its items in one of two possible layouts:
8077 * When in "horizontal mode", items will be placed in @b columns,
8078 * from top to bottom and, when the space for a column is filled,
8079 * another one is started on the right, thus expanding the grid
8080 * horizontally, making for horizontal scrolling. When in "vertical
8081 * mode" , though, items will be placed in @b rows, from left to
8082 * right and, when the space for a row is filled, another one is
8083 * started below, thus expanding the grid vertically (and making
8084 * for vertical scrolling).
8086 * @section Gengrid_Items Gengrid items
8088 * An item in a gengrid can have 0 or more text labels (they can be
8089 * regular text or textblock Evas objects - that's up to the style
8090 * to determine), 0 or more icons (which are simply objects
8091 * swallowed into the gengrid item's theming Edje object) and 0 or
8092 * more <b>boolean states</b>, which have the behavior left to the
8093 * user to define. The Edje part names for each of these properties
8094 * will be looked up, in the theme file for the gengrid, under the
8095 * Edje (string) data items named @c "labels", @c "icons" and @c
8096 * "states", respectively. For each of those properties, if more
8097 * than one part is provided, they must have names listed separated
8098 * by spaces in the data fields. For the default gengrid item
8099 * theme, we have @b one label part (@c "elm.text"), @b two icon
8100 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8103 * A gengrid item may be at one of several styles. Elementary
8104 * provides one by default - "default", but this can be extended by
8105 * system or application custom themes/overlays/extensions (see
8106 * @ref Theme "themes" for more details).
8108 * @section Gengrid_Item_Class Gengrid item classes
8110 * In order to have the ability to add and delete items on the fly,
8111 * gengrid implements a class (callback) system where the
8112 * application provides a structure with information about that
8113 * type of item (gengrid may contain multiple different items with
8114 * different classes, states and styles). Gengrid will call the
8115 * functions in this struct (methods) when an item is "realized"
8116 * (i.e., created dynamically, while the user is scrolling the
8117 * grid). All objects will simply be deleted when no longer needed
8118 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8119 * contains the following members:
8120 * - @c item_style - This is a constant string and simply defines
8121 * the name of the item style. It @b must be specified and the
8122 * default should be @c "default".
8123 * - @c func.label_get - This function is called when an item
8124 * object is actually created. The @c data parameter will point to
8125 * the same data passed to elm_gengrid_item_append() and related
8126 * item creation functions. The @c obj parameter is the gengrid
8127 * object itself, while the @c part one is the name string of one
8128 * of the existing text parts in the Edje group implementing the
8129 * item's theme. This function @b must return a strdup'()ed string,
8130 * as the caller will free() it when done. See
8131 * #Elm_Gengrid_Item_Label_Get_Cb.
8132 * - @c func.content_get - This function is called when an item object
8133 * is actually created. The @c data parameter will point to the
8134 * same data passed to elm_gengrid_item_append() and related item
8135 * creation functions. The @c obj parameter is the gengrid object
8136 * itself, while the @c part one is the name string of one of the
8137 * existing (content) swallow parts in the Edje group implementing the
8138 * item's theme. It must return @c NULL, when no content is desired,
8139 * or a valid object handle, otherwise. The object will be deleted
8140 * by the gengrid on its deletion or when the item is "unrealized".
8141 * See #Elm_Gengrid_Item_Content_Get_Cb.
8142 * - @c func.state_get - This function is called when an item
8143 * object is actually created. The @c data parameter will point to
8144 * the same data passed to elm_gengrid_item_append() and related
8145 * item creation functions. The @c obj parameter is the gengrid
8146 * object itself, while the @c part one is the name string of one
8147 * of the state parts in the Edje group implementing the item's
8148 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8149 * true/on. Gengrids will emit a signal to its theming Edje object
8150 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8151 * "source" arguments, respectively, when the state is true (the
8152 * default is false), where @c XXX is the name of the (state) part.
8153 * See #Elm_Gengrid_Item_State_Get_Cb.
8154 * - @c func.del - This is called when elm_gengrid_item_del() is
8155 * called on an item or elm_gengrid_clear() is called on the
8156 * gengrid. This is intended for use when gengrid items are
8157 * deleted, so any data attached to the item (e.g. its data
8158 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8160 * @section Gengrid_Usage_Hints Usage hints
8162 * If the user wants to have multiple items selected at the same
8163 * time, elm_gengrid_multi_select_set() will permit it. If the
8164 * gengrid is single-selection only (the default), then
8165 * elm_gengrid_select_item_get() will return the selected item or
8166 * @c NULL, if none is selected. If the gengrid is under
8167 * multi-selection, then elm_gengrid_selected_items_get() will
8168 * return a list (that is only valid as long as no items are
8169 * modified (added, deleted, selected or unselected) of child items
8172 * If an item changes (internal (boolean) state, label or content
8173 * changes), then use elm_gengrid_item_update() to have gengrid
8174 * update the item with the new state. A gengrid will re-"realize"
8175 * the item, thus calling the functions in the
8176 * #Elm_Gengrid_Item_Class set for that item.
8178 * To programmatically (un)select an item, use
8179 * elm_gengrid_item_selected_set(). To get its selected state use
8180 * elm_gengrid_item_selected_get(). To make an item disabled
8181 * (unable to be selected and appear differently) use
8182 * elm_gengrid_item_disabled_set() to set this and
8183 * elm_gengrid_item_disabled_get() to get the disabled state.
8185 * Grid cells will only have their selection smart callbacks called
8186 * when firstly getting selected. Any further clicks will do
8187 * nothing, unless you enable the "always select mode", with
8188 * elm_gengrid_always_select_mode_set(), thus making every click to
8189 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8190 * turn off the ability to select items entirely in the widget and
8191 * they will neither appear selected nor call the selection smart
8194 * Remember that you can create new styles and add your own theme
8195 * augmentation per application with elm_theme_extension_add(). If
8196 * you absolutely must have a specific style that overrides any
8197 * theme the user or system sets up you can use
8198 * elm_theme_overlay_add() to add such a file.
8200 * @section Gengrid_Smart_Events Gengrid smart events
8202 * Smart events that you can add callbacks for are:
8203 * - @c "activated" - The user has double-clicked or pressed
8204 * (enter|return|spacebar) on an item. The @c event_info parameter
8205 * is the gengrid item that was activated.
8206 * - @c "clicked,double" - The user has double-clicked an item.
8207 * The @c event_info parameter is the gengrid item that was double-clicked.
8208 * - @c "longpressed" - This is called when the item is pressed for a certain
8209 * amount of time. By default it's 1 second.
8210 * - @c "selected" - The user has made an item selected. The
8211 * @c event_info parameter is the gengrid item that was selected.
8212 * - @c "unselected" - The user has made an item unselected. The
8213 * @c event_info parameter is the gengrid item that was unselected.
8214 * - @c "realized" - This is called when the item in the gengrid
8215 * has its implementing Evas object instantiated, de facto. @c
8216 * event_info is the gengrid item that was created. The object
8217 * may be deleted at any time, so it is highly advised to the
8218 * caller @b not to use the object pointer returned from
8219 * elm_gengrid_item_object_get(), because it may point to freed
8221 * - @c "unrealized" - This is called when the implementing Evas
8222 * object for this item is deleted. @c event_info is the gengrid
8223 * item that was deleted.
8224 * - @c "changed" - Called when an item is added, removed, resized
8225 * or moved and when the gengrid is resized or gets "horizontal"
8227 * - @c "scroll,anim,start" - This is called when scrolling animation has
8229 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8231 * - @c "drag,start,up" - Called when the item in the gengrid has
8232 * been dragged (not scrolled) up.
8233 * - @c "drag,start,down" - Called when the item in the gengrid has
8234 * been dragged (not scrolled) down.
8235 * - @c "drag,start,left" - Called when the item in the gengrid has
8236 * been dragged (not scrolled) left.
8237 * - @c "drag,start,right" - Called when the item in the gengrid has
8238 * been dragged (not scrolled) right.
8239 * - @c "drag,stop" - Called when the item in the gengrid has
8240 * stopped being dragged.
8241 * - @c "drag" - Called when the item in the gengrid is being
8243 * - @c "scroll" - called when the content has been scrolled
8245 * - @c "scroll,drag,start" - called when dragging the content has
8247 * - @c "scroll,drag,stop" - called when dragging the content has
8249 * - @c "edge,top" - This is called when the gengrid is scrolled until
8251 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8252 * until the bottom edge.
8253 * - @c "edge,left" - This is called when the gengrid is scrolled
8254 * until the left edge.
8255 * - @c "edge,right" - This is called when the gengrid is scrolled
8256 * until the right edge.
8258 * List of gengrid examples:
8259 * @li @ref gengrid_example
8263 * @addtogroup Gengrid
8267 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8268 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8269 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8271 * Label fetching class function for Elm_Gen_Item_Class.
8272 * @param data The data passed in the item creation function
8273 * @param obj The base widget object
8274 * @param part The part name of the swallow
8275 * @return The allocated (NOT stringshared) string to set as the label
8277 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8279 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8280 * @param data The data passed in the item creation function
8281 * @param obj The base widget object
8282 * @param part The part name of the swallow
8283 * @return The content object to swallow
8285 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8287 * State fetching class function for Elm_Gen_Item_Class.
8288 * @param data The data passed in the item creation function
8289 * @param obj The base widget object
8290 * @param part The part name of the swallow
8291 * @return The hell if I know
8293 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8295 * Deletion class function for Elm_Gen_Item_Class.
8296 * @param data The data passed in the item creation function
8297 * @param obj The base widget object
8299 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8301 /* temporary compatibility code */
8302 typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8303 typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8304 typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8305 typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8308 * @struct _Elm_Gengrid_Item_Class
8310 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8313 struct _Elm_Gengrid_Item_Class
8315 const char *item_style;
8316 struct _Elm_Gengrid_Item_Class_Func
8318 Elm_Gengrid_Item_Label_Get_Cb label_get;
8319 union { /* temporary compatibility code */
8320 Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8321 Elm_Gengrid_Item_Content_Get_Cb content_get;
8323 Elm_Gengrid_Item_State_Get_Cb state_get;
8324 Elm_Gengrid_Item_Del_Cb del;
8326 }; /**< #Elm_Gengrid_Item_Class member definitions */
8328 * Add a new gengrid widget to the given parent Elementary
8329 * (container) object
8331 * @param parent The parent object
8332 * @return a new gengrid widget handle or @c NULL, on errors
8334 * This function inserts a new gengrid widget on the canvas.
8336 * @see elm_gengrid_item_size_set()
8337 * @see elm_gengrid_group_item_size_set()
8338 * @see elm_gengrid_horizontal_set()
8339 * @see elm_gengrid_item_append()
8340 * @see elm_gengrid_item_del()
8341 * @see elm_gengrid_clear()
8345 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8348 * Set the size for the items of a given gengrid widget
8350 * @param obj The gengrid object.
8351 * @param w The items' width.
8352 * @param h The items' height;
8354 * A gengrid, after creation, has still no information on the size
8355 * to give to each of its cells. So, you most probably will end up
8356 * with squares one @ref Fingers "finger" wide, the default
8357 * size. Use this function to force a custom size for you items,
8358 * making them as big as you wish.
8360 * @see elm_gengrid_item_size_get()
8364 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8367 * Get the size set for the items of a given gengrid widget
8369 * @param obj The gengrid object.
8370 * @param w Pointer to a variable where to store the items' width.
8371 * @param h Pointer to a variable where to store the items' height.
8373 * @note Use @c NULL pointers on the size values you're not
8374 * interested in: they'll be ignored by the function.
8376 * @see elm_gengrid_item_size_get() for more details
8380 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8383 * Set the items grid's alignment within a given gengrid widget
8385 * @param obj The gengrid object.
8386 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8387 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8389 * This sets the alignment of the whole grid of items of a gengrid
8390 * within its given viewport. By default, those values are both
8391 * 0.5, meaning that the gengrid will have its items grid placed
8392 * exactly in the middle of its viewport.
8394 * @note If given alignment values are out of the cited ranges,
8395 * they'll be changed to the nearest boundary values on the valid
8398 * @see elm_gengrid_align_get()
8402 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8405 * Get the items grid's alignment values within a given gengrid
8408 * @param obj The gengrid object.
8409 * @param align_x Pointer to a variable where to store the
8410 * horizontal alignment.
8411 * @param align_y Pointer to a variable where to store the vertical
8414 * @note Use @c NULL pointers on the alignment values you're not
8415 * interested in: they'll be ignored by the function.
8417 * @see elm_gengrid_align_set() for more details
8421 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8424 * Set whether a given gengrid widget is or not able have items
8427 * @param obj The gengrid object
8428 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8429 * @c EINA_FALSE to turn it off
8431 * If a gengrid is set to allow reordering, a click held for more
8432 * than 0.5 over a given item will highlight it specially,
8433 * signalling the gengrid has entered the reordering state. From
8434 * that time on, the user will be able to, while still holding the
8435 * mouse button down, move the item freely in the gengrid's
8436 * viewport, replacing to said item to the locations it goes to.
8437 * The replacements will be animated and, whenever the user
8438 * releases the mouse button, the item being replaced gets a new
8439 * definitive place in the grid.
8441 * @see elm_gengrid_reorder_mode_get()
8445 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8448 * Get whether a given gengrid widget is or not able have items
8451 * @param obj The gengrid object
8452 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8455 * @see elm_gengrid_reorder_mode_set() for more details
8459 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8462 * Append a new item in a given gengrid widget.
8464 * @param obj The gengrid object.
8465 * @param gic The item class for the item.
8466 * @param data The item data.
8467 * @param func Convenience function called when the item is
8469 * @param func_data Data to be passed to @p func.
8470 * @return A handle to the item added or @c NULL, on errors.
8472 * This adds an item to the beginning of the gengrid.
8474 * @see elm_gengrid_item_prepend()
8475 * @see elm_gengrid_item_insert_before()
8476 * @see elm_gengrid_item_insert_after()
8477 * @see elm_gengrid_item_del()
8481 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);
8484 * Prepend a new item in a given gengrid widget.
8486 * @param obj The gengrid object.
8487 * @param gic The item class for the item.
8488 * @param data The item data.
8489 * @param func Convenience function called when the item is
8491 * @param func_data Data to be passed to @p func.
8492 * @return A handle to the item added or @c NULL, on errors.
8494 * This adds an item to the end of the gengrid.
8496 * @see elm_gengrid_item_append()
8497 * @see elm_gengrid_item_insert_before()
8498 * @see elm_gengrid_item_insert_after()
8499 * @see elm_gengrid_item_del()
8503 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);
8506 * Insert an item before another in a gengrid widget
8508 * @param obj The gengrid object.
8509 * @param gic The item class for the item.
8510 * @param data The item data.
8511 * @param relative The item to place this new one before.
8512 * @param func Convenience function called when the item is
8514 * @param func_data Data to be passed to @p func.
8515 * @return A handle to the item added or @c NULL, on errors.
8517 * This inserts an item before another in the gengrid.
8519 * @see elm_gengrid_item_append()
8520 * @see elm_gengrid_item_prepend()
8521 * @see elm_gengrid_item_insert_after()
8522 * @see elm_gengrid_item_del()
8526 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);
8529 * Insert an item after another in a gengrid widget
8531 * @param obj The gengrid object.
8532 * @param gic The item class for the item.
8533 * @param data The item data.
8534 * @param relative The item to place this new one after.
8535 * @param func Convenience function called when the item is
8537 * @param func_data Data to be passed to @p func.
8538 * @return A handle to the item added or @c NULL, on errors.
8540 * This inserts an item after another in the gengrid.
8542 * @see elm_gengrid_item_append()
8543 * @see elm_gengrid_item_prepend()
8544 * @see elm_gengrid_item_insert_after()
8545 * @see elm_gengrid_item_del()
8549 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);
8552 * Insert an item in a gengrid widget using a user-defined sort function.
8554 * @param obj The gengrid object.
8555 * @param gic The item class for the item.
8556 * @param data The item data.
8557 * @param comp User defined comparison function that defines the sort order based on
8558 * Elm_Gen_Item and its data param.
8559 * @param func Convenience function called when the item is selected.
8560 * @param func_data Data to be passed to @p func.
8561 * @return A handle to the item added or @c NULL, on errors.
8563 * This inserts an item in the gengrid based on user defined comparison function.
8565 * @see elm_gengrid_item_append()
8566 * @see elm_gengrid_item_prepend()
8567 * @see elm_gengrid_item_insert_after()
8568 * @see elm_gengrid_item_del()
8569 * @see elm_gengrid_item_direct_sorted_insert()
8573 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);
8576 * Insert an item in a gengrid widget using a user-defined sort function.
8578 * @param obj The gengrid object.
8579 * @param gic The item class for the item.
8580 * @param data The item data.
8581 * @param comp User defined comparison function that defines the sort order based on
8583 * @param func Convenience function called when the item is selected.
8584 * @param func_data Data to be passed to @p func.
8585 * @return A handle to the item added or @c NULL, on errors.
8587 * This inserts an item in the gengrid based on user defined comparison function.
8589 * @see elm_gengrid_item_append()
8590 * @see elm_gengrid_item_prepend()
8591 * @see elm_gengrid_item_insert_after()
8592 * @see elm_gengrid_item_del()
8593 * @see elm_gengrid_item_sorted_insert()
8597 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);
8600 * Set whether items on a given gengrid widget are to get their
8601 * selection callbacks issued for @b every subsequent selection
8602 * click on them or just for the first click.
8604 * @param obj The gengrid object
8605 * @param always_select @c EINA_TRUE to make items "always
8606 * selected", @c EINA_FALSE, otherwise
8608 * By default, grid items will only call their selection callback
8609 * function when firstly getting selected, any subsequent further
8610 * clicks will do nothing. With this call, you make those
8611 * subsequent clicks also to issue the selection callbacks.
8613 * @note <b>Double clicks</b> will @b always be reported on items.
8615 * @see elm_gengrid_always_select_mode_get()
8619 WILL_DEPRECATE EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8622 * Get whether items on a given gengrid widget have their selection
8623 * callbacks issued for @b every subsequent selection click on them
8624 * or just for the first click.
8626 * @param obj The gengrid object.
8627 * @return @c EINA_TRUE if the gengrid items are "always selected",
8628 * @c EINA_FALSE, otherwise
8630 * @see elm_gengrid_always_select_mode_set() for more details
8634 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8637 * Set whether items on a given gengrid widget can be selected or not.
8639 * @param obj The gengrid object
8640 * @param no_select @c EINA_TRUE to make items selectable,
8641 * @c EINA_FALSE otherwise
8643 * This will make items in @p obj selectable or not. In the latter
8644 * case, any user interaction on the gengrid items will neither make
8645 * them appear selected nor them call their selection callback
8648 * @see elm_gengrid_no_select_mode_get()
8652 WILL_DEPRECATE EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8655 * Get whether items on a given gengrid widget can be selected or
8658 * @param obj The gengrid object
8659 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8662 * @see elm_gengrid_no_select_mode_set() for more details
8666 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8669 * Enable or disable multi-selection in a given gengrid widget
8671 * @param obj The gengrid object.
8672 * @param multi @c EINA_TRUE, to enable multi-selection,
8673 * @c EINA_FALSE to disable it.
8675 * Multi-selection is the ability to have @b more than one
8676 * item selected, on a given gengrid, simultaneously. When it is
8677 * enabled, a sequence of clicks on different items will make them
8678 * all selected, progressively. A click on an already selected item
8679 * will unselect it. If interacting via the keyboard,
8680 * multi-selection is enabled while holding the "Shift" key.
8682 * @note By default, multi-selection is @b disabled on gengrids
8684 * @see elm_gengrid_multi_select_get()
8688 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8691 * Get whether multi-selection is enabled or disabled for a given
8694 * @param obj The gengrid object.
8695 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8696 * EINA_FALSE otherwise
8698 * @see elm_gengrid_multi_select_set() for more details
8702 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8705 * Enable or disable bouncing effect for a given gengrid widget
8707 * @param obj The gengrid object
8708 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8709 * @c EINA_FALSE to disable it
8710 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8711 * @c EINA_FALSE to disable it
8713 * The bouncing effect occurs whenever one reaches the gengrid's
8714 * edge's while panning it -- it will scroll past its limits a
8715 * little bit and return to the edge again, in a animated for,
8718 * @note By default, gengrids have bouncing enabled on both axis
8720 * @see elm_gengrid_bounce_get()
8724 WILL_DEPRECATE EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8727 * Get whether bouncing effects are enabled or disabled, for a
8728 * given gengrid widget, on each axis
8730 * @param obj The gengrid object
8731 * @param h_bounce Pointer to a variable where to store the
8732 * horizontal bouncing flag.
8733 * @param v_bounce Pointer to a variable where to store the
8734 * vertical bouncing flag.
8736 * @see elm_gengrid_bounce_set() for more details
8740 WILL_DEPRECATE EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8743 * Set a given gengrid widget's scrolling page size, relative to
8744 * its viewport size.
8746 * @param obj The gengrid object
8747 * @param h_pagerel The horizontal page (relative) size
8748 * @param v_pagerel The vertical page (relative) size
8750 * The gengrid's scroller is capable of binding scrolling by the
8751 * user to "pages". It means that, while scrolling and, specially
8752 * after releasing the mouse button, the grid will @b snap to the
8753 * nearest displaying page's area. When page sizes are set, the
8754 * grid's continuous content area is split into (equal) page sized
8757 * This function sets the size of a page <b>relatively to the
8758 * viewport dimensions</b> of the gengrid, for each axis. A value
8759 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8760 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8761 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8762 * 1.0. Values beyond those will make it behave behave
8763 * inconsistently. If you only want one axis to snap to pages, use
8764 * the value @c 0.0 for the other one.
8766 * There is a function setting page size values in @b absolute
8767 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8768 * is mutually exclusive to this one.
8770 * @see elm_gengrid_page_relative_get()
8774 WILL_DEPRECATE EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8777 * Get a given gengrid widget's scrolling page size, relative to
8778 * its viewport size.
8780 * @param obj The gengrid object
8781 * @param h_pagerel Pointer to a variable where to store the
8782 * horizontal page (relative) size
8783 * @param v_pagerel Pointer to a variable where to store the
8784 * vertical page (relative) size
8786 * @see elm_gengrid_page_relative_set() for more details
8790 WILL_DEPRECATE EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8793 * Set a given gengrid widget's scrolling page size
8795 * @param obj The gengrid object
8796 * @param h_pagerel The horizontal page size, in pixels
8797 * @param v_pagerel The vertical page size, in pixels
8799 * The gengrid's scroller is capable of binding scrolling by the
8800 * user to "pages". It means that, while scrolling and, specially
8801 * after releasing the mouse button, the grid will @b snap to the
8802 * nearest displaying page's area. When page sizes are set, the
8803 * grid's continuous content area is split into (equal) page sized
8806 * This function sets the size of a page of the gengrid, in pixels,
8807 * for each axis. Sane usable values are, between @c 0 and the
8808 * dimensions of @p obj, for each axis. Values beyond those will
8809 * make it behave behave inconsistently. If you only want one axis
8810 * to snap to pages, use the value @c 0 for the other one.
8812 * There is a function setting page size values in @b relative
8813 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8814 * use is mutually exclusive to this one.
8818 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8821 * Set the direction in which a given gengrid widget will expand while
8822 * placing its items.
8824 * @param obj The gengrid object.
8825 * @param setting @c EINA_TRUE to make the gengrid expand
8826 * horizontally, @c EINA_FALSE to expand vertically.
8828 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8829 * in @b columns, from top to bottom and, when the space for a
8830 * column is filled, another one is started on the right, thus
8831 * expanding the grid horizontally. When in "vertical mode"
8832 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8833 * to right and, when the space for a row is filled, another one is
8834 * started below, thus expanding the grid vertically.
8836 * @see elm_gengrid_horizontal_get()
8840 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8843 * Get for what direction a given gengrid widget will expand while
8844 * placing its items.
8846 * @param obj The gengrid object.
8847 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8848 * @c EINA_FALSE if it's set to expand vertically.
8850 * @see elm_gengrid_horizontal_set() for more detais
8854 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8857 * Get the first item in a given gengrid widget
8859 * @param obj The gengrid object
8860 * @return The first item's handle or @c NULL, if there are no
8861 * items in @p obj (and on errors)
8863 * This returns the first item in the @p obj's internal list of
8866 * @see elm_gengrid_last_item_get()
8870 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8873 * Get the last item in a given gengrid widget
8875 * @param obj The gengrid object
8876 * @return The last item's handle or @c NULL, if there are no
8877 * items in @p obj (and on errors)
8879 * This returns the last item in the @p obj's internal list of
8882 * @see elm_gengrid_first_item_get()
8886 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8889 * Get the @b next item in a gengrid widget's internal list of items,
8890 * given a handle to one of those items.
8892 * @param item The gengrid item to fetch next from
8893 * @return The item after @p item, or @c NULL if there's none (and
8896 * This returns the item placed after the @p item, on the container
8899 * @see elm_gengrid_item_prev_get()
8903 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8906 * Get the @b previous item in a gengrid widget's internal list of items,
8907 * given a handle to one of those items.
8909 * @param item The gengrid item to fetch previous from
8910 * @return The item before @p item, or @c NULL if there's none (and
8913 * This returns the item placed before the @p item, on the container
8916 * @see elm_gengrid_item_next_get()
8920 WILL_DEPRECATE EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8923 * Get the gengrid object's handle which contains a given gengrid
8926 * @param item The item to fetch the container from
8927 * @return The gengrid (parent) object
8929 * This returns the gengrid object itself that an item belongs to.
8933 WILL_DEPRECATE EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8936 * Remove a gengrid item from its parent, deleting it.
8938 * @param item The item to be removed.
8939 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8941 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8946 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8949 * Update the contents of a given gengrid item
8951 * @param item The gengrid item
8953 * This updates an item by calling all the item class functions
8954 * again to get the contents, labels and states. Use this when the
8955 * original item data has changed and you want the changes to be
8960 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8963 * Get the Gengrid Item class for the given Gengrid Item.
8965 * @param item The gengrid item
8967 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8968 * the function pointers and item_style.
8972 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8975 * Get the Gengrid Item class for the given Gengrid Item.
8977 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8978 * the function pointers and item_style.
8980 * @param item The gengrid item
8981 * @param gic The gengrid item class describing the function pointers and the item style.
8985 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8988 * Return the data associated to a given gengrid item
8990 * @param item The gengrid item.
8991 * @return the data associated with this item.
8993 * This returns the @c data value passed on the
8994 * elm_gengrid_item_append() and related item addition calls.
8996 * @see elm_gengrid_item_append()
8997 * @see elm_gengrid_item_data_set()
9001 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9004 * Set the data associated with a given gengrid item
9006 * @param item The gengrid item
9007 * @param data The data pointer to set on it
9009 * This @b overrides the @c data value passed on the
9010 * elm_gengrid_item_append() and related item addition calls. This
9011 * function @b won't call elm_gengrid_item_update() automatically,
9012 * so you'd issue it afterwards if you want to have the item
9013 * updated to reflect the new data.
9015 * @see elm_gengrid_item_data_get()
9016 * @see elm_gengrid_item_update()
9020 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9023 * Get a given gengrid item's position, relative to the whole
9024 * gengrid's grid area.
9026 * @param item The Gengrid item.
9027 * @param x Pointer to variable to store the item's <b>row number</b>.
9028 * @param y Pointer to variable to store the item's <b>column number</b>.
9030 * This returns the "logical" position of the item within the
9031 * gengrid. For example, @c (0, 1) would stand for first row,
9036 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9039 * Set whether a given gengrid item is selected or not
9041 * @param item The gengrid item
9042 * @param selected Use @c EINA_TRUE, to make it selected, @c
9043 * EINA_FALSE to make it unselected
9045 * This sets the selected state of an item. If multi-selection is
9046 * not enabled on the containing gengrid and @p selected is @c
9047 * EINA_TRUE, any other previously selected items will get
9048 * unselected in favor of this new one.
9050 * @see elm_gengrid_item_selected_get()
9054 WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9057 * Get whether a given gengrid item is selected or not
9059 * @param item The gengrid item
9060 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9062 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9064 * @see elm_gengrid_item_selected_set() for more details
9068 WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9071 * Get the real Evas object created to implement the view of a
9072 * given gengrid item
9074 * @param item The gengrid item.
9075 * @return the Evas object implementing this item's view.
9077 * This returns the actual Evas object used to implement the
9078 * specified gengrid item's view. This may be @c NULL, as it may
9079 * not have been created or may have been deleted, at any time, by
9080 * the gengrid. <b>Do not modify this object</b> (move, resize,
9081 * show, hide, etc.), as the gengrid is controlling it. This
9082 * function is for querying, emitting custom signals or hooking
9083 * lower level callbacks for events on that object. Do not delete
9084 * this object under any circumstances.
9086 * @see elm_gengrid_item_data_get()
9090 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9093 * Show the portion of a gengrid's internal grid containing a given
9094 * item, @b immediately.
9096 * @param item The item to display
9098 * This causes gengrid to @b redraw its viewport's contents to the
9099 * region contining the given @p item item, if it is not fully
9102 * @see elm_gengrid_item_bring_in()
9106 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9109 * Animatedly bring in, to the visible area of a gengrid, a given
9112 * @param item The gengrid item to display
9114 * This causes gengrid to jump to the given @p item and show
9115 * it (by scrolling), if it is not fully visible. This will use
9116 * animation to do so and take a period of time to complete.
9118 * @see elm_gengrid_item_show()
9122 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9125 * Set whether a given gengrid item is disabled or not.
9127 * @param item The gengrid item
9128 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9129 * to enable it back.
9131 * A disabled item cannot be selected or unselected. It will also
9132 * change its appearance, to signal the user it's disabled.
9134 * @see elm_gengrid_item_disabled_get()
9138 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9141 * Get whether a given gengrid item is disabled or not.
9143 * @param item The gengrid item
9144 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9147 * @see elm_gengrid_item_disabled_set() for more details
9151 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9154 * Set the text to be shown in a given gengrid item's tooltips.
9156 * @param item The gengrid item
9157 * @param text The text to set in the content
9159 * This call will setup the text to be used as tooltip to that item
9160 * (analogous to elm_object_tooltip_text_set(), but being item
9161 * tooltips with higher precedence than object tooltips). It can
9162 * have only one tooltip at a time, so any previous tooltip data
9167 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9170 * Set the content to be shown in a given gengrid item's tooltip
9172 * @param item The gengrid item.
9173 * @param func The function returning the tooltip contents.
9174 * @param data What to provide to @a func as callback data/context.
9175 * @param del_cb Called when data is not needed anymore, either when
9176 * another callback replaces @p func, the tooltip is unset with
9177 * elm_gengrid_item_tooltip_unset() or the owner @p item
9178 * dies. This callback receives as its first parameter the
9179 * given @p data, being @c event_info the item handle.
9181 * This call will setup the tooltip's contents to @p item
9182 * (analogous to elm_object_tooltip_content_cb_set(), but being
9183 * item tooltips with higher precedence than object tooltips). It
9184 * can have only one tooltip at a time, so any previous tooltip
9185 * content will get removed. @p func (with @p data) will be called
9186 * every time Elementary needs to show the tooltip and it should
9187 * return a valid Evas object, which will be fully managed by the
9188 * tooltip system, getting deleted when the tooltip is gone.
9192 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);
9195 * Unset a tooltip from a given gengrid item
9197 * @param item gengrid item to remove a previously set tooltip from.
9199 * This call removes any tooltip set on @p item. The callback
9200 * provided as @c del_cb to
9201 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9202 * notify it is not used anymore (and have resources cleaned, if
9205 * @see elm_gengrid_item_tooltip_content_cb_set()
9209 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9212 * Set a different @b style for a given gengrid item's tooltip.
9214 * @param item gengrid item with tooltip set
9215 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9216 * "default", @c "transparent", etc)
9218 * Tooltips can have <b>alternate styles</b> to be displayed on,
9219 * which are defined by the theme set on Elementary. This function
9220 * works analogously as elm_object_tooltip_style_set(), but here
9221 * applied only to gengrid item objects. The default style for
9222 * tooltips is @c "default".
9224 * @note before you set a style you should define a tooltip with
9225 * elm_gengrid_item_tooltip_content_cb_set() or
9226 * elm_gengrid_item_tooltip_text_set()
9228 * @see elm_gengrid_item_tooltip_style_get()
9232 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9235 * Get the style set a given gengrid item's tooltip.
9237 * @param item gengrid item with tooltip already set on.
9238 * @return style the theme style in use, which defaults to
9239 * "default". If the object does not have a tooltip set,
9240 * then @c NULL is returned.
9242 * @see elm_gengrid_item_tooltip_style_set() for more details
9246 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9248 * @brief Disable size restrictions on an object's tooltip
9249 * @param item The tooltip's anchor object
9250 * @param disable If EINA_TRUE, size restrictions are disabled
9251 * @return EINA_FALSE on failure, EINA_TRUE on success
9253 * This function allows a tooltip to expand beyond its parant window's canvas.
9254 * It will instead be limited only by the size of the display.
9256 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9258 * @brief Retrieve size restriction state of an object's tooltip
9259 * @param item The tooltip's anchor object
9260 * @return If EINA_TRUE, size restrictions are disabled
9262 * This function returns whether a tooltip is allowed to expand beyond
9263 * its parant window's canvas.
9264 * It will instead be limited only by the size of the display.
9266 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9268 * Set the type of mouse pointer/cursor decoration to be shown,
9269 * when the mouse pointer is over the given gengrid widget item
9271 * @param item gengrid item to customize cursor on
9272 * @param cursor the cursor type's name
9274 * This function works analogously as elm_object_cursor_set(), but
9275 * here the cursor's changing area is restricted to the item's
9276 * area, and not the whole widget's. Note that that item cursors
9277 * have precedence over widget cursors, so that a mouse over @p
9278 * item will always show cursor @p type.
9280 * If this function is called twice for an object, a previously set
9281 * cursor will be unset on the second call.
9283 * @see elm_object_cursor_set()
9284 * @see elm_gengrid_item_cursor_get()
9285 * @see elm_gengrid_item_cursor_unset()
9289 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9292 * Get the type of mouse pointer/cursor decoration set to be shown,
9293 * when the mouse pointer is over the given gengrid widget item
9295 * @param item gengrid item with custom cursor set
9296 * @return the cursor type's name or @c NULL, if no custom cursors
9297 * were set to @p item (and on errors)
9299 * @see elm_object_cursor_get()
9300 * @see elm_gengrid_item_cursor_set() for more details
9301 * @see elm_gengrid_item_cursor_unset()
9305 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9308 * Unset any custom mouse pointer/cursor decoration set to be
9309 * shown, when the mouse pointer is over the given gengrid widget
9310 * item, thus making it show the @b default cursor again.
9312 * @param item a gengrid item
9314 * Use this call to undo any custom settings on this item's cursor
9315 * decoration, bringing it back to defaults (no custom style set).
9317 * @see elm_object_cursor_unset()
9318 * @see elm_gengrid_item_cursor_set() for more details
9322 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9325 * Set a different @b style for a given custom cursor set for a
9328 * @param item gengrid item with custom cursor set
9329 * @param style the <b>theme style</b> to use (e.g. @c "default",
9330 * @c "transparent", etc)
9332 * This function only makes sense when one is using custom mouse
9333 * cursor decorations <b>defined in a theme file</b> , which can
9334 * have, given a cursor name/type, <b>alternate styles</b> on
9335 * it. It works analogously as elm_object_cursor_style_set(), but
9336 * here applied only to gengrid item objects.
9338 * @warning Before you set a cursor style you should have defined a
9339 * custom cursor previously on the item, with
9340 * elm_gengrid_item_cursor_set()
9342 * @see elm_gengrid_item_cursor_engine_only_set()
9343 * @see elm_gengrid_item_cursor_style_get()
9347 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9350 * Get the current @b style set for a given gengrid item's custom
9353 * @param item gengrid item with custom cursor set.
9354 * @return style the cursor style in use. If the object does not
9355 * have a cursor set, then @c NULL is returned.
9357 * @see elm_gengrid_item_cursor_style_set() for more details
9361 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9364 * Set if the (custom) cursor for a given gengrid item should be
9365 * searched in its theme, also, or should only rely on the
9368 * @param item item with custom (custom) cursor already set on
9369 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9370 * only on those provided by the rendering engine, @c EINA_FALSE to
9371 * have them searched on the widget's theme, as well.
9373 * @note This call is of use only if you've set a custom cursor
9374 * for gengrid items, with elm_gengrid_item_cursor_set().
9376 * @note By default, cursors will only be looked for between those
9377 * provided by the rendering engine.
9381 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9384 * Get if the (custom) cursor for a given gengrid item is being
9385 * searched in its theme, also, or is only relying on the rendering
9388 * @param item a gengrid item
9389 * @return @c EINA_TRUE, if cursors are being looked for only on
9390 * those provided by the rendering engine, @c EINA_FALSE if they
9391 * are being searched on the widget's theme, as well.
9393 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9397 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9400 * Remove all items from a given gengrid widget
9402 * @param obj The gengrid object.
9404 * This removes (and deletes) all items in @p obj, leaving it
9407 * @see elm_gengrid_item_del(), to remove just one item.
9411 WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9414 * Get the selected item in a given gengrid widget
9416 * @param obj The gengrid object.
9417 * @return The selected item's handleor @c NULL, if none is
9418 * selected at the moment (and on errors)
9420 * This returns the selected item in @p obj. If multi selection is
9421 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9422 * the first item in the list is selected, which might not be very
9423 * useful. For that case, see elm_gengrid_selected_items_get().
9427 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9430 * Get <b>a list</b> of selected items in a given gengrid
9432 * @param obj The gengrid object.
9433 * @return The list of selected items or @c NULL, if none is
9434 * selected at the moment (and on errors)
9436 * This returns a list of the selected items, in the order that
9437 * they appear in the grid. This list is only valid as long as no
9438 * more items are selected or unselected (or unselected implictly
9439 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9442 * @see elm_gengrid_selected_item_get()
9446 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9453 * @defgroup Clock Clock
9455 * @image html img/widget/clock/preview-00.png
9456 * @image latex img/widget/clock/preview-00.eps
9458 * This is a @b digital clock widget. In its default theme, it has a
9459 * vintage "flipping numbers clock" appearance, which will animate
9460 * sheets of individual algarisms individually as time goes by.
9462 * A newly created clock will fetch system's time (already
9463 * considering local time adjustments) to start with, and will tick
9464 * accondingly. It may or may not show seconds.
9466 * Clocks have an @b edition mode. When in it, the sheets will
9467 * display extra arrow indications on the top and bottom and the
9468 * user may click on them to raise or lower the time values. After
9469 * it's told to exit edition mode, it will keep ticking with that
9470 * new time set (it keeps the difference from local time).
9472 * Also, when under edition mode, user clicks on the cited arrows
9473 * which are @b held for some time will make the clock to flip the
9474 * sheet, thus editing the time, continuosly and automatically for
9475 * the user. The interval between sheet flips will keep growing in
9476 * time, so that it helps the user to reach a time which is distant
9479 * The time display is, by default, in military mode (24h), but an
9480 * am/pm indicator may be optionally shown, too, when it will
9483 * Smart callbacks one can register to:
9484 * - "changed" - the clock's user changed the time
9486 * Here is an example on its usage:
9487 * @li @ref clock_example
9496 * Identifiers for which clock digits should be editable, when a
9497 * clock widget is in edition mode. Values may be ORed together to
9498 * make a mask, naturally.
9500 * @see elm_clock_edit_set()
9501 * @see elm_clock_digit_edit_set()
9503 typedef enum _Elm_Clock_Digedit
9505 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9506 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9507 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9508 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9509 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9510 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9511 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9512 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9513 } Elm_Clock_Digedit;
9516 * Add a new clock widget to the given parent Elementary
9517 * (container) object
9519 * @param parent The parent object
9520 * @return a new clock widget handle or @c NULL, on errors
9522 * This function inserts a new clock widget on the canvas.
9526 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9529 * Set a clock widget's time, programmatically
9531 * @param obj The clock widget object
9532 * @param hrs The hours to set
9533 * @param min The minutes to set
9534 * @param sec The secondes to set
9536 * This function updates the time that is showed by the clock
9539 * Values @b must be set within the following ranges:
9540 * - 0 - 23, for hours
9541 * - 0 - 59, for minutes
9542 * - 0 - 59, for seconds,
9544 * even if the clock is not in "military" mode.
9546 * @warning The behavior for values set out of those ranges is @b
9551 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9554 * Get a clock widget's time values
9556 * @param obj The clock object
9557 * @param[out] hrs Pointer to the variable to get the hours value
9558 * @param[out] min Pointer to the variable to get the minutes value
9559 * @param[out] sec Pointer to the variable to get the seconds value
9561 * This function gets the time set for @p obj, returning
9562 * it on the variables passed as the arguments to function
9564 * @note Use @c NULL pointers on the time values you're not
9565 * interested in: they'll be ignored by the function.
9569 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9572 * Set whether a given clock widget is under <b>edition mode</b> or
9573 * under (default) displaying-only mode.
9575 * @param obj The clock object
9576 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9577 * put it back to "displaying only" mode
9579 * This function makes a clock's time to be editable or not <b>by
9580 * user interaction</b>. When in edition mode, clocks @b stop
9581 * ticking, until one brings them back to canonical mode. The
9582 * elm_clock_digit_edit_set() function will influence which digits
9583 * of the clock will be editable. By default, all of them will be
9584 * (#ELM_CLOCK_NONE).
9586 * @note am/pm sheets, if being shown, will @b always be editable
9587 * under edition mode.
9589 * @see elm_clock_edit_get()
9593 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9596 * Retrieve whether a given clock widget is under <b>edition
9597 * mode</b> or under (default) displaying-only mode.
9599 * @param obj The clock object
9600 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9603 * This function retrieves whether the clock's time can be edited
9604 * or not by user interaction.
9606 * @see elm_clock_edit_set() for more details
9610 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9613 * Set what digits of the given clock widget should be editable
9614 * when in edition mode.
9616 * @param obj The clock object
9617 * @param digedit Bit mask indicating the digits to be editable
9618 * (values in #Elm_Clock_Digedit).
9620 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9621 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9624 * @see elm_clock_digit_edit_get()
9628 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9631 * Retrieve what digits of the given clock widget should be
9632 * editable when in edition mode.
9634 * @param obj The clock object
9635 * @return Bit mask indicating the digits to be editable
9636 * (values in #Elm_Clock_Digedit).
9638 * @see elm_clock_digit_edit_set() for more details
9642 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9645 * Set if the given clock widget must show hours in military or
9648 * @param obj The clock object
9649 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9652 * This function sets if the clock must show hours in military or
9653 * am/pm mode. In some countries like Brazil the military mode
9654 * (00-24h-format) is used, in opposition to the USA, where the
9655 * am/pm mode is more commonly used.
9657 * @see elm_clock_show_am_pm_get()
9661 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9664 * Get if the given clock widget shows hours in military or am/pm
9667 * @param obj The clock object
9668 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9671 * This function gets if the clock shows hours in military or am/pm
9674 * @see elm_clock_show_am_pm_set() for more details
9678 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9681 * Set if the given clock widget must show time with seconds or not
9683 * @param obj The clock object
9684 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9686 * This function sets if the given clock must show or not elapsed
9687 * seconds. By default, they are @b not shown.
9689 * @see elm_clock_show_seconds_get()
9693 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9696 * Get whether the given clock widget is showing time with seconds
9699 * @param obj The clock object
9700 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9702 * This function gets whether @p obj is showing or not the elapsed
9705 * @see elm_clock_show_seconds_set()
9709 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9712 * Set the interval on time updates for an user mouse button hold
9713 * on clock widgets' time edition.
9715 * @param obj The clock object
9716 * @param interval The (first) interval value in seconds
9718 * This interval value is @b decreased while the user holds the
9719 * mouse pointer either incrementing or decrementing a given the
9720 * clock digit's value.
9722 * This helps the user to get to a given time distant from the
9723 * current one easier/faster, as it will start to flip quicker and
9724 * quicker on mouse button holds.
9726 * The calculation for the next flip interval value, starting from
9727 * the one set with this call, is the previous interval divided by
9728 * 1.05, so it decreases a little bit.
9730 * The default starting interval value for automatic flips is
9733 * @see elm_clock_interval_get()
9737 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9740 * Get the interval on time updates for an user mouse button hold
9741 * on clock widgets' time edition.
9743 * @param obj The clock object
9744 * @return The (first) interval value, in seconds, set on it
9746 * @see elm_clock_interval_set() for more details
9750 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9757 * @defgroup Layout Layout
9759 * @image html img/widget/layout/preview-00.png
9760 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9762 * @image html img/layout-predefined.png
9763 * @image latex img/layout-predefined.eps width=\textwidth
9765 * This is a container widget that takes a standard Edje design file and
9766 * wraps it very thinly in a widget.
9768 * An Edje design (theme) file has a very wide range of possibilities to
9769 * describe the behavior of elements added to the Layout. Check out the Edje
9770 * documentation and the EDC reference to get more information about what can
9771 * be done with Edje.
9773 * Just like @ref List, @ref Box, and other container widgets, any
9774 * object added to the Layout will become its child, meaning that it will be
9775 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9777 * The Layout widget can contain as many Contents, Boxes or Tables as
9778 * described in its theme file. For instance, objects can be added to
9779 * different Tables by specifying the respective Table part names. The same
9780 * is valid for Content and Box.
9782 * The objects added as child of the Layout will behave as described in the
9783 * part description where they were added. There are 3 possible types of
9784 * parts where a child can be added:
9786 * @section secContent Content (SWALLOW part)
9788 * Only one object can be added to the @c SWALLOW part (but you still can
9789 * have many @c SWALLOW parts and one object on each of them). Use the @c
9790 * elm_object_content_set/get/unset functions to set, retrieve and unset
9791 * objects as content of the @c SWALLOW. After being set to this part, the
9792 * object size, position, visibility, clipping and other description
9793 * properties will be totally controlled by the description of the given part
9794 * (inside the Edje theme file).
9796 * One can use @c evas_object_size_hint_* functions on the child to have some
9797 * kind of control over its behavior, but the resulting behavior will still
9798 * depend heavily on the @c SWALLOW part description.
9800 * The Edje theme also can change the part description, based on signals or
9801 * scripts running inside the theme. This change can also be animated. All of
9802 * this will affect the child object set as content accordingly. The object
9803 * size will be changed if the part size is changed, it will animate move if
9804 * the part is moving, and so on.
9806 * The following picture demonstrates a Layout widget with a child object
9807 * added to its @c SWALLOW:
9809 * @image html layout_swallow.png
9810 * @image latex layout_swallow.eps width=\textwidth
9812 * @section secBox Box (BOX part)
9814 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9815 * allows one to add objects to the box and have them distributed along its
9816 * area, accordingly to the specified @a layout property (now by @a layout we
9817 * mean the chosen layouting design of the Box, not the Layout widget
9820 * A similar effect for having a box with its position, size and other things
9821 * controlled by the Layout theme would be to create an Elementary @ref Box
9822 * widget and add it as a Content in the @c SWALLOW part.
9824 * The main difference of using the Layout Box is that its behavior, the box
9825 * properties like layouting format, padding, align, etc. will be all
9826 * controlled by the theme. This means, for example, that a signal could be
9827 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9828 * handled the signal by changing the box padding, or align, or both. Using
9829 * the Elementary @ref Box widget is not necessarily harder or easier, it
9830 * just depends on the circunstances and requirements.
9832 * The Layout Box can be used through the @c elm_layout_box_* set of
9835 * The following picture demonstrates a Layout widget with many child objects
9836 * added to its @c BOX part:
9838 * @image html layout_box.png
9839 * @image latex layout_box.eps width=\textwidth
9841 * @section secTable Table (TABLE part)
9843 * Just like the @ref secBox, the Layout Table is very similar to the
9844 * Elementary @ref Table widget. It allows one to add objects to the Table
9845 * specifying the row and column where the object should be added, and any
9846 * column or row span if necessary.
9848 * Again, we could have this design by adding a @ref Table widget to the @c
9849 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9850 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9851 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9853 * The Layout Table can be used through the @c elm_layout_table_* set of
9856 * The following picture demonstrates a Layout widget with many child objects
9857 * added to its @c TABLE part:
9859 * @image html layout_table.png
9860 * @image latex layout_table.eps width=\textwidth
9862 * @section secPredef Predefined Layouts
9864 * Another interesting thing about the Layout widget is that it offers some
9865 * predefined themes that come with the default Elementary theme. These
9866 * themes can be set by the call elm_layout_theme_set(), and provide some
9867 * basic functionality depending on the theme used.
9869 * Most of them already send some signals, some already provide a toolbar or
9870 * back and next buttons.
9872 * These are available predefined theme layouts. All of them have class = @c
9873 * layout, group = @c application, and style = one of the following options:
9875 * @li @c toolbar-content - application with toolbar and main content area
9876 * @li @c toolbar-content-back - application with toolbar and main content
9877 * area with a back button and title area
9878 * @li @c toolbar-content-back-next - application with toolbar and main
9879 * content area with a back and next buttons and title area
9880 * @li @c content-back - application with a main content area with a back
9881 * button and title area
9882 * @li @c content-back-next - application with a main content area with a
9883 * back and next buttons and title area
9884 * @li @c toolbar-vbox - application with toolbar and main content area as a
9886 * @li @c toolbar-table - application with toolbar and main content area as a
9889 * @section secExamples Examples
9891 * Some examples of the Layout widget can be found here:
9892 * @li @ref layout_example_01
9893 * @li @ref layout_example_02
9894 * @li @ref layout_example_03
9895 * @li @ref layout_example_edc
9900 * Add a new layout to the parent
9902 * @param parent The parent object
9903 * @return The new object or NULL if it cannot be created
9905 * @see elm_layout_file_set()
9906 * @see elm_layout_theme_set()
9910 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9912 * Set the file that will be used as layout
9914 * @param obj The layout object
9915 * @param file The path to file (edj) that will be used as layout
9916 * @param group The group that the layout belongs in edje file
9918 * @return (1 = success, 0 = error)
9922 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9924 * Set the edje group from the elementary theme that will be used as layout
9926 * @param obj The layout object
9927 * @param clas the clas of the group
9928 * @param group the group
9929 * @param style the style to used
9931 * @return (1 = success, 0 = error)
9935 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9937 * Set the layout content.
9939 * @param obj The layout object
9940 * @param swallow The swallow part name in the edje file
9941 * @param content The child that will be added in this layout object
9943 * Once the content object is set, a previously set one will be deleted.
9944 * If you want to keep that old content object, use the
9945 * elm_object_part_content_unset() function.
9947 * @note In an Edje theme, the part used as a content container is called @c
9948 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9949 * expected to be a part name just like the second parameter of
9950 * elm_layout_box_append().
9952 * @see elm_layout_box_append()
9953 * @see elm_object_part_content_get()
9954 * @see elm_object_part_content_unset()
9956 * @deprecated use elm_object_part_content_set() instead
9960 WILL_DEPRECATE EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9962 * Get the child object in the given content part.
9964 * @param obj The layout object
9965 * @param swallow The SWALLOW part to get its content
9967 * @return The swallowed object or NULL if none or an error occurred
9969 * @deprecated use elm_object_part_content_get() instead
9973 WILL_DEPRECATE EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9975 * Unset the layout content.
9977 * @param obj The layout object
9978 * @param swallow The swallow part name in the edje file
9979 * @return The content that was being used
9981 * Unparent and return the content object which was set for this part.
9983 * @deprecated use elm_object_part_content_unset() instead
9987 WILL_DEPRECATE EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9989 * Set the text of the given part
9991 * @param obj The layout object
9992 * @param part The TEXT part where to set the text
9993 * @param text The text to set
9996 * @deprecated use elm_object_part_text_set() instead.
9998 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10000 * Get the text set in the given part
10002 * @param obj The layout object
10003 * @param part The TEXT part to retrieve the text off
10005 * @return The text set in @p part
10008 * @deprecated use elm_object_part_text_get() instead.
10010 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10012 * Append child to layout box part.
10014 * @param obj the layout object
10015 * @param part the box part to which the object will be appended.
10016 * @param child the child object to append to box.
10018 * Once the object is appended, it will become child of the layout. Its
10019 * lifetime will be bound to the layout, whenever the layout dies the child
10020 * will be deleted automatically. One should use elm_layout_box_remove() to
10021 * make this layout forget about the object.
10023 * @see elm_layout_box_prepend()
10024 * @see elm_layout_box_insert_before()
10025 * @see elm_layout_box_insert_at()
10026 * @see elm_layout_box_remove()
10030 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10032 * Prepend child to layout box part.
10034 * @param obj the layout object
10035 * @param part the box part to prepend.
10036 * @param child the child object to prepend to box.
10038 * Once the object is prepended, it will become child of the layout. Its
10039 * lifetime will be bound to the layout, whenever the layout dies the child
10040 * will be deleted automatically. One should use elm_layout_box_remove() to
10041 * make this layout forget about the object.
10043 * @see elm_layout_box_append()
10044 * @see elm_layout_box_insert_before()
10045 * @see elm_layout_box_insert_at()
10046 * @see elm_layout_box_remove()
10050 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10052 * Insert child to layout box part before a reference object.
10054 * @param obj the layout object
10055 * @param part the box part to insert.
10056 * @param child the child object to insert into box.
10057 * @param reference another reference object to insert before in box.
10059 * Once the object is inserted, it will become child of the layout. Its
10060 * lifetime will be bound to the layout, whenever the layout dies the child
10061 * will be deleted automatically. One should use elm_layout_box_remove() to
10062 * make this layout forget about the object.
10064 * @see elm_layout_box_append()
10065 * @see elm_layout_box_prepend()
10066 * @see elm_layout_box_insert_before()
10067 * @see elm_layout_box_remove()
10071 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10073 * Insert child to layout box part at a given position.
10075 * @param obj the layout object
10076 * @param part the box part to insert.
10077 * @param child the child object to insert into box.
10078 * @param pos the numeric position >=0 to insert the child.
10080 * Once the object is inserted, it will become child of the layout. Its
10081 * lifetime will be bound to the layout, whenever the layout dies the child
10082 * will be deleted automatically. One should use elm_layout_box_remove() to
10083 * make this layout forget about the object.
10085 * @see elm_layout_box_append()
10086 * @see elm_layout_box_prepend()
10087 * @see elm_layout_box_insert_before()
10088 * @see elm_layout_box_remove()
10092 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10094 * Remove a child of the given part box.
10096 * @param obj The layout object
10097 * @param part The box part name to remove child.
10098 * @param child The object to remove from box.
10099 * @return The object that was being used, or NULL if not found.
10101 * The object will be removed from the box part and its lifetime will
10102 * not be handled by the layout anymore. This is equivalent to
10103 * elm_object_part_content_unset() for box.
10105 * @see elm_layout_box_append()
10106 * @see elm_layout_box_remove_all()
10110 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10112 * Remove all children of the given part box.
10114 * @param obj The layout object
10115 * @param part The box part name to remove child.
10116 * @param clear If EINA_TRUE, then all objects will be deleted as
10117 * well, otherwise they will just be removed and will be
10118 * dangling on the canvas.
10120 * The objects will be removed from the box part and their lifetime will
10121 * not be handled by the layout anymore. This is equivalent to
10122 * elm_layout_box_remove() for all box children.
10124 * @see elm_layout_box_append()
10125 * @see elm_layout_box_remove()
10129 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10131 * Insert child to layout table part.
10133 * @param obj the layout object
10134 * @param part the box part to pack child.
10135 * @param child_obj the child object to pack into table.
10136 * @param col the column to which the child should be added. (>= 0)
10137 * @param row the row to which the child should be added. (>= 0)
10138 * @param colspan how many columns should be used to store this object. (>=
10140 * @param rowspan how many rows should be used to store this object. (>= 1)
10142 * Once the object is inserted, it will become child of the table. Its
10143 * lifetime will be bound to the layout, and whenever the layout dies the
10144 * child will be deleted automatically. One should use
10145 * elm_layout_table_remove() to make this layout forget about the object.
10147 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10148 * more space than a single cell. For instance, the following code:
10150 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10153 * Would result in an object being added like the following picture:
10155 * @image html layout_colspan.png
10156 * @image latex layout_colspan.eps width=\textwidth
10158 * @see elm_layout_table_unpack()
10159 * @see elm_layout_table_clear()
10163 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);
10165 * Unpack (remove) a child of the given part table.
10167 * @param obj The layout object
10168 * @param part The table part name to remove child.
10169 * @param child_obj The object to remove from table.
10170 * @return The object that was being used, or NULL if not found.
10172 * The object will be unpacked from the table part and its lifetime
10173 * will not be handled by the layout anymore. This is equivalent to
10174 * elm_object_part_content_unset() for table.
10176 * @see elm_layout_table_pack()
10177 * @see elm_layout_table_clear()
10181 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10183 * Remove all the child objects of the given part table.
10185 * @param obj The layout object
10186 * @param part The table part name to remove child.
10187 * @param clear If EINA_TRUE, then all objects will be deleted as
10188 * well, otherwise they will just be removed and will be
10189 * dangling on the canvas.
10191 * The objects will be removed from the table part and their lifetime will
10192 * not be handled by the layout anymore. This is equivalent to
10193 * elm_layout_table_unpack() for all table children.
10195 * @see elm_layout_table_pack()
10196 * @see elm_layout_table_unpack()
10200 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10202 * Get the edje layout
10204 * @param obj The layout object
10206 * @return A Evas_Object with the edje layout settings loaded
10207 * with function elm_layout_file_set
10209 * This returns the edje object. It is not expected to be used to then
10210 * swallow objects via edje_object_part_swallow() for example. Use
10211 * elm_object_part_content_set() instead so child object handling and sizing is
10214 * @note This function should only be used if you really need to call some
10215 * low level Edje function on this edje object. All the common stuff (setting
10216 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10217 * with proper elementary functions.
10219 * @see elm_object_signal_callback_add()
10220 * @see elm_object_signal_emit()
10221 * @see elm_object_part_text_set()
10222 * @see elm_object_part_content_set()
10223 * @see elm_layout_box_append()
10224 * @see elm_layout_table_pack()
10225 * @see elm_layout_data_get()
10229 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10231 * Get the edje data from the given layout
10233 * @param obj The layout object
10234 * @param key The data key
10236 * @return The edje data string
10238 * This function fetches data specified inside the edje theme of this layout.
10239 * This function return NULL if data is not found.
10241 * In EDC this comes from a data block within the group block that @p
10242 * obj was loaded from. E.g.
10249 * item: "key1" "value1";
10250 * item: "key2" "value2";
10258 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10262 * @param obj The layout object
10264 * Manually forces a sizing re-evaluation. This is useful when the minimum
10265 * size required by the edje theme of this layout has changed. The change on
10266 * the minimum size required by the edje theme is not immediately reported to
10267 * the elementary layout, so one needs to call this function in order to tell
10268 * the widget (layout) that it needs to reevaluate its own size.
10270 * The minimum size of the theme is calculated based on minimum size of
10271 * parts, the size of elements inside containers like box and table, etc. All
10272 * of this can change due to state changes, and that's when this function
10273 * should be called.
10275 * Also note that a standard signal of "size,eval" "elm" emitted from the
10276 * edje object will cause this to happen too.
10280 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10283 * Sets a specific cursor for an edje part.
10285 * @param obj The layout object.
10286 * @param part_name a part from loaded edje group.
10287 * @param cursor cursor name to use, see Elementary_Cursor.h
10289 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10290 * part not exists or it has "mouse_events: 0".
10294 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10297 * Get the cursor to be shown when mouse is over an edje part
10299 * @param obj The layout object.
10300 * @param part_name a part from loaded edje group.
10301 * @return the cursor name.
10305 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10308 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10310 * @param obj The layout object.
10311 * @param part_name a part from loaded edje group, that had a cursor set
10312 * with elm_layout_part_cursor_set().
10316 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10319 * Sets a specific cursor style for an edje part.
10321 * @param obj The layout object.
10322 * @param part_name a part from loaded edje group.
10323 * @param style the theme style to use (default, transparent, ...)
10325 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10326 * part not exists or it did not had a cursor set.
10330 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10333 * Gets a specific cursor style for an edje part.
10335 * @param obj The layout object.
10336 * @param part_name a part from loaded edje group.
10338 * @return the theme style in use, defaults to "default". If the
10339 * object does not have a cursor set, then NULL is returned.
10343 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10346 * Sets if the cursor set should be searched on the theme or should use
10347 * the provided by the engine, only.
10349 * @note before you set if should look on theme you should define a
10350 * cursor with elm_layout_part_cursor_set(). By default it will only
10351 * look for cursors provided by the engine.
10353 * @param obj The layout object.
10354 * @param part_name a part from loaded edje group.
10355 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10356 * or should also search on widget's theme as well (EINA_FALSE)
10358 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10359 * part not exists or it did not had a cursor set.
10363 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);
10366 * Gets a specific cursor engine_only for an edje part.
10368 * @param obj The layout object.
10369 * @param part_name a part from loaded edje group.
10371 * @return whenever the cursor is just provided by engine or also from theme.
10375 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10378 * @def elm_layout_icon_set
10379 * Convenience macro to set the icon object in a layout that follows the
10380 * Elementary naming convention for its parts.
10384 #define elm_layout_icon_set(_ly, _obj) \
10387 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10388 if ((_obj)) sig = "elm,state,icon,visible"; \
10389 else sig = "elm,state,icon,hidden"; \
10390 elm_object_signal_emit((_ly), sig, "elm"); \
10394 * @def elm_layout_icon_get
10395 * Convienience macro to get the icon object from a layout that follows the
10396 * Elementary naming convention for its parts.
10400 #define elm_layout_icon_get(_ly) \
10401 elm_object_part_content_get((_ly), "elm.swallow.icon")
10404 * @def elm_layout_end_set
10405 * Convienience macro to set the end object in a layout that follows the
10406 * Elementary naming convention for its parts.
10410 #define elm_layout_end_set(_ly, _obj) \
10413 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10414 if ((_obj)) sig = "elm,state,end,visible"; \
10415 else sig = "elm,state,end,hidden"; \
10416 elm_object_signal_emit((_ly), sig, "elm"); \
10420 * @def elm_layout_end_get
10421 * Convienience macro to get the end object in a layout that follows the
10422 * Elementary naming convention for its parts.
10426 #define elm_layout_end_get(_ly) \
10427 elm_object_part_content_get((_ly), "elm.swallow.end")
10430 * @def elm_layout_label_set
10431 * Convienience macro to set the label in a layout that follows the
10432 * Elementary naming convention for its parts.
10435 * @deprecated use elm_object_text_set() instead.
10437 #define elm_layout_label_set(_ly, _txt) \
10438 elm_layout_text_set((_ly), "elm.text", (_txt))
10441 * @def elm_layout_label_get
10442 * Convenience macro to get the label in a layout that follows the
10443 * Elementary naming convention for its parts.
10446 * @deprecated use elm_object_text_set() instead.
10448 #define elm_layout_label_get(_ly) \
10449 elm_layout_text_get((_ly), "elm.text")
10451 /* smart callbacks called:
10452 * "theme,changed" - when elm theme is changed.
10456 * @defgroup Notify Notify
10458 * @image html img/widget/notify/preview-00.png
10459 * @image latex img/widget/notify/preview-00.eps
10461 * Display a container in a particular region of the parent(top, bottom,
10462 * etc). A timeout can be set to automatically hide the notify. This is so
10463 * that, after an evas_object_show() on a notify object, if a timeout was set
10464 * on it, it will @b automatically get hidden after that time.
10466 * Signals that you can add callbacks for are:
10467 * @li "timeout" - when timeout happens on notify and it's hidden
10468 * @li "block,clicked" - when a click outside of the notify happens
10470 * Default contents parts of the notify widget that you can use for are:
10471 * @li "default" - A content of the notify
10473 * @ref tutorial_notify show usage of the API.
10478 * @brief Possible orient values for notify.
10480 * This values should be used in conjunction to elm_notify_orient_set() to
10481 * set the position in which the notify should appear(relative to its parent)
10482 * and in conjunction with elm_notify_orient_get() to know where the notify
10485 typedef enum _Elm_Notify_Orient
10487 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10488 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10489 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10490 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10491 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10492 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10493 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10494 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10495 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10496 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10497 } Elm_Notify_Orient;
10499 * @brief Add a new notify to the parent
10501 * @param parent The parent object
10502 * @return The new object or NULL if it cannot be created
10504 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10506 * @brief Set the content of the notify widget
10508 * @param obj The notify object
10509 * @param content The content will be filled in this notify object
10511 * Once the content object is set, a previously set one will be deleted. If
10512 * you want to keep that old content object, use the
10513 * elm_notify_content_unset() function.
10515 * @deprecated use elm_object_content_set() instead
10518 WILL_DEPRECATE EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10520 * @brief Unset the content of the notify widget
10522 * @param obj The notify object
10523 * @return The content that was being used
10525 * Unparent and return the content object which was set for this widget
10527 * @see elm_notify_content_set()
10528 * @deprecated use elm_object_content_unset() instead
10531 WILL_DEPRECATE EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10533 * @brief Return the content of the notify widget
10535 * @param obj The notify object
10536 * @return The content that is being used
10538 * @see elm_notify_content_set()
10539 * @deprecated use elm_object_content_get() instead
10542 WILL_DEPRECATE EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10544 * @brief Set the notify parent
10546 * @param obj The notify object
10547 * @param content The new parent
10549 * Once the parent object is set, a previously set one will be disconnected
10552 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10554 * @brief Get the notify parent
10556 * @param obj The notify object
10557 * @return The parent
10559 * @see elm_notify_parent_set()
10561 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10563 * @brief Set the orientation
10565 * @param obj The notify object
10566 * @param orient The new orientation
10568 * Sets the position in which the notify will appear in its parent.
10570 * @see @ref Elm_Notify_Orient for possible values.
10572 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10574 * @brief Return the orientation
10575 * @param obj The notify object
10576 * @return The orientation of the notification
10578 * @see elm_notify_orient_set()
10579 * @see Elm_Notify_Orient
10581 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10583 * @brief Set the time interval after which the notify window is going to be
10586 * @param obj The notify object
10587 * @param time The timeout in seconds
10589 * This function sets a timeout and starts the timer controlling when the
10590 * notify is hidden. Since calling evas_object_show() on a notify restarts
10591 * the timer controlling when the notify is hidden, setting this before the
10592 * notify is shown will in effect mean starting the timer when the notify is
10595 * @note Set a value <= 0.0 to disable a running timer.
10597 * @note If the value > 0.0 and the notify is previously visible, the
10598 * timer will be started with this value, canceling any running timer.
10600 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10602 * @brief Return the timeout value (in seconds)
10603 * @param obj the notify object
10605 * @see elm_notify_timeout_set()
10607 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10609 * @brief Sets whether events should be passed to by a click outside
10612 * @param obj The notify object
10613 * @param repeats EINA_TRUE Events are repeats, else no
10615 * When true if the user clicks outside the window the events will be caught
10616 * by the others widgets, else the events are blocked.
10618 * @note The default value is EINA_TRUE.
10620 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10622 * @brief Return true if events are repeat below the notify object
10623 * @param obj the notify object
10625 * @see elm_notify_repeat_events_set()
10627 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10633 * @defgroup Hover Hover
10635 * @image html img/widget/hover/preview-00.png
10636 * @image latex img/widget/hover/preview-00.eps
10638 * A Hover object will hover over its @p parent object at the @p target
10639 * location. Anything in the background will be given a darker coloring to
10640 * indicate that the hover object is on top (at the default theme). When the
10641 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10642 * clicked that @b doesn't cause the hover to be dismissed.
10644 * A Hover object has two parents. One parent that owns it during creation
10645 * and the other parent being the one over which the hover object spans.
10648 * @note The hover object will take up the entire space of @p target
10651 * Elementary has the following styles for the hover widget:
10655 * @li hoversel_vertical
10657 * The following are the available position for content:
10669 * Signals that you can add callbacks for are:
10670 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10671 * @li "smart,changed" - a content object placed under the "smart"
10672 * policy was replaced to a new slot direction.
10674 * See @ref tutorial_hover for more information.
10678 typedef enum _Elm_Hover_Axis
10680 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10681 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10682 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10683 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10686 * @brief Adds a hover object to @p parent
10688 * @param parent The parent object
10689 * @return The hover object or NULL if one could not be created
10691 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10693 * @brief Sets the target object for the hover.
10695 * @param obj The hover object
10696 * @param target The object to center the hover onto.
10698 * This function will cause the hover to be centered on the target object.
10700 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10702 * @brief Gets the target object for the hover.
10704 * @param obj The hover object
10705 * @return The target object for the hover.
10707 * @see elm_hover_target_set()
10709 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10711 * @brief Sets the parent object for the hover.
10713 * @param obj The hover object
10714 * @param parent The object to locate the hover over.
10716 * This function will cause the hover to take up the entire space that the
10717 * parent object fills.
10719 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10721 * @brief Gets the parent object for the hover.
10723 * @param obj The hover object
10724 * @return The parent object to locate the hover over.
10726 * @see elm_hover_parent_set()
10728 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10730 * @brief Sets the content of the hover object and the direction in which it
10733 * @param obj The hover object
10734 * @param swallow The direction that the object will be displayed
10735 * at. Accepted values are "left", "top-left", "top", "top-right",
10736 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10738 * @param content The content to place at @p swallow
10740 * Once the content object is set for a given direction, a previously
10741 * set one (on the same direction) will be deleted. If you want to
10742 * keep that old content object, use the elm_hover_content_unset()
10745 * All directions may have contents at the same time, except for
10746 * "smart". This is a special placement hint and its use case
10747 * independs of the calculations coming from
10748 * elm_hover_best_content_location_get(). Its use is for cases when
10749 * one desires only one hover content, but with a dynamic special
10750 * placement within the hover area. The content's geometry, whenever
10751 * it changes, will be used to decide on a best location, not
10752 * extrapolating the hover's parent object view to show it in (still
10753 * being the hover's target determinant of its medium part -- move and
10754 * resize it to simulate finger sizes, for example). If one of the
10755 * directions other than "smart" are used, a previously content set
10756 * using it will be deleted, and vice-versa.
10758 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10760 * @brief Get the content of the hover object, in a given direction.
10762 * Return the content object which was set for this widget in the
10763 * @p swallow direction.
10765 * @param obj The hover object
10766 * @param swallow The direction that the object was display at.
10767 * @return The content that was being used
10769 * @see elm_hover_content_set()
10771 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10773 * @brief Unset the content of the hover object, in a given direction.
10775 * Unparent and return the content object set at @p swallow direction.
10777 * @param obj The hover object
10778 * @param swallow The direction that the object was display at.
10779 * @return The content that was being used.
10781 * @see elm_hover_content_set()
10783 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10785 * @brief Returns the best swallow location for content in the hover.
10787 * @param obj The hover object
10788 * @param pref_axis The preferred orientation axis for the hover object to use
10789 * @return The edje location to place content into the hover or @c
10792 * Best is defined here as the location at which there is the most available
10795 * @p pref_axis may be one of
10796 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10797 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10798 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10799 * - @c ELM_HOVER_AXIS_BOTH -- both
10801 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10802 * nescessarily be along the horizontal axis("left" or "right"). If
10803 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10804 * be along the vertical axis("top" or "bottom"). Chossing
10805 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10806 * returned position may be in either axis.
10808 * @see elm_hover_content_set()
10810 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10817 * @defgroup Entry Entry
10819 * @image html img/widget/entry/preview-00.png
10820 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10821 * @image html img/widget/entry/preview-01.png
10822 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10823 * @image html img/widget/entry/preview-02.png
10824 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10825 * @image html img/widget/entry/preview-03.png
10826 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10828 * An entry is a convenience widget which shows a box that the user can
10829 * enter text into. Entries by default don't scroll, so they grow to
10830 * accomodate the entire text, resizing the parent window as needed. This
10831 * can be changed with the elm_entry_scrollable_set() function.
10833 * They can also be single line or multi line (the default) and when set
10834 * to multi line mode they support text wrapping in any of the modes
10835 * indicated by #Elm_Wrap_Type.
10837 * Other features include password mode, filtering of inserted text with
10838 * elm_entry_text_filter_append() and related functions, inline "items" and
10839 * formatted markup text.
10841 * @section entry-markup Formatted text
10843 * The markup tags supported by the Entry are defined by the theme, but
10844 * even when writing new themes or extensions it's a good idea to stick to
10845 * a sane default, to maintain coherency and avoid application breakages.
10846 * Currently defined by the default theme are the following tags:
10847 * @li \<br\>: Inserts a line break.
10848 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10850 * @li \<tab\>: Inserts a tab.
10851 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10853 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10854 * @li \<link\>...\</link\>: Underlines the enclosed text.
10855 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10857 * @section entry-special Special markups
10859 * Besides those used to format text, entries support two special markup
10860 * tags used to insert clickable portions of text or items inlined within
10863 * @subsection entry-anchors Anchors
10865 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10866 * \</a\> tags and an event will be generated when this text is clicked,
10870 * This text is outside <a href=anc-01>but this one is an anchor</a>
10873 * The @c href attribute in the opening tag gives the name that will be
10874 * used to identify the anchor and it can be any valid utf8 string.
10876 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10877 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10878 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10879 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10882 * @subsection entry-items Items
10884 * Inlined in the text, any other @c Evas_Object can be inserted by using
10885 * \<item\> tags this way:
10888 * <item size=16x16 vsize=full href=emoticon/haha></item>
10891 * Just like with anchors, the @c href identifies each item, but these need,
10892 * in addition, to indicate their size, which is done using any one of
10893 * @c size, @c absize or @c relsize attributes. These attributes take their
10894 * value in the WxH format, where W is the width and H the height of the
10897 * @li absize: Absolute pixel size for the item. Whatever value is set will
10898 * be the item's size regardless of any scale value the object may have
10899 * been set to. The final line height will be adjusted to fit larger items.
10900 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10902 * @li relsize: Size is adjusted for the item to fit within the current
10905 * Besides their size, items are specificed a @c vsize value that affects
10906 * how their final size and position are calculated. The possible values
10908 * @li ascent: Item will be placed within the line's baseline and its
10909 * ascent. That is, the height between the line where all characters are
10910 * positioned and the highest point in the line. For @c size and @c absize
10911 * items, the descent value will be added to the total line height to make
10912 * them fit. @c relsize items will be adjusted to fit within this space.
10913 * @li full: Items will be placed between the descent and ascent, or the
10914 * lowest point in the line and its highest.
10916 * The next image shows different configurations of items and how
10917 * the previously mentioned options affect their sizes. In all cases,
10918 * the green line indicates the ascent, blue for the baseline and red for
10921 * @image html entry_item.png
10922 * @image latex entry_item.eps width=\textwidth
10924 * And another one to show how size differs from absize. In the first one,
10925 * the scale value is set to 1.0, while the second one is using one of 2.0.
10927 * @image html entry_item_scale.png
10928 * @image latex entry_item_scale.eps width=\textwidth
10930 * After the size for an item is calculated, the entry will request an
10931 * object to place in its space. For this, the functions set with
10932 * elm_entry_item_provider_append() and related functions will be called
10933 * in order until one of them returns a @c non-NULL value. If no providers
10934 * are available, or all of them return @c NULL, then the entry falls back
10935 * to one of the internal defaults, provided the name matches with one of
10938 * All of the following are currently supported:
10941 * - emoticon/angry-shout
10942 * - emoticon/crazy-laugh
10943 * - emoticon/evil-laugh
10945 * - emoticon/goggle-smile
10946 * - emoticon/grumpy
10947 * - emoticon/grumpy-smile
10948 * - emoticon/guilty
10949 * - emoticon/guilty-smile
10951 * - emoticon/half-smile
10952 * - emoticon/happy-panting
10954 * - emoticon/indifferent
10956 * - emoticon/knowing-grin
10958 * - emoticon/little-bit-sorry
10959 * - emoticon/love-lots
10961 * - emoticon/minimal-smile
10962 * - emoticon/not-happy
10963 * - emoticon/not-impressed
10965 * - emoticon/opensmile
10968 * - emoticon/squint-laugh
10969 * - emoticon/surprised
10970 * - emoticon/suspicious
10971 * - emoticon/tongue-dangling
10972 * - emoticon/tongue-poke
10974 * - emoticon/unhappy
10975 * - emoticon/very-sorry
10978 * - emoticon/worried
10981 * Alternatively, an item may reference an image by its path, using
10982 * the URI form @c file:///path/to/an/image.png and the entry will then
10983 * use that image for the item.
10985 * @section entry-files Loading and saving files
10987 * Entries have convinience functions to load text from a file and save
10988 * changes back to it after a short delay. The automatic saving is enabled
10989 * by default, but can be disabled with elm_entry_autosave_set() and files
10990 * can be loaded directly as plain text or have any markup in them
10991 * recognized. See elm_entry_file_set() for more details.
10993 * @section entry-signals Emitted signals
10995 * This widget emits the following signals:
10997 * @li "changed": The text within the entry was changed.
10998 * @li "changed,user": The text within the entry was changed because of user interaction.
10999 * @li "activated": The enter key was pressed on a single line entry.
11000 * @li "press": A mouse button has been pressed on the entry.
11001 * @li "longpressed": A mouse button has been pressed and held for a couple
11003 * @li "clicked": The entry has been clicked (mouse press and release).
11004 * @li "clicked,double": The entry has been double clicked.
11005 * @li "clicked,triple": The entry has been triple clicked.
11006 * @li "focused": The entry has received focus.
11007 * @li "unfocused": The entry has lost focus.
11008 * @li "selection,paste": A paste of the clipboard contents was requested.
11009 * @li "selection,copy": A copy of the selected text into the clipboard was
11011 * @li "selection,cut": A cut of the selected text into the clipboard was
11013 * @li "selection,start": A selection has begun and no previous selection
11015 * @li "selection,changed": The current selection has changed.
11016 * @li "selection,cleared": The current selection has been cleared.
11017 * @li "cursor,changed": The cursor has changed position.
11018 * @li "anchor,clicked": An anchor has been clicked. The event_info
11019 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11020 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11021 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11022 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11023 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11024 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11025 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11026 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11027 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11028 * @li "preedit,changed": The preedit string has changed.
11029 * @li "language,changed": Program language changed.
11031 * @section entry-examples
11033 * An overview of the Entry API can be seen in @ref entry_example_01
11038 * @typedef Elm_Entry_Anchor_Info
11040 * The info sent in the callback for the "anchor,clicked" signals emitted
11043 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11045 * @struct _Elm_Entry_Anchor_Info
11047 * The info sent in the callback for the "anchor,clicked" signals emitted
11050 struct _Elm_Entry_Anchor_Info
11052 const char *name; /**< The name of the anchor, as stated in its href */
11053 int button; /**< The mouse button used to click on it */
11054 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11055 y, /**< Anchor geometry, relative to canvas */
11056 w, /**< Anchor geometry, relative to canvas */
11057 h; /**< Anchor geometry, relative to canvas */
11060 * @typedef Elm_Entry_Filter_Cb
11061 * This callback type is used by entry filters to modify text.
11062 * @param data The data specified as the last param when adding the filter
11063 * @param entry The entry object
11064 * @param text A pointer to the location of the text being filtered. This data can be modified,
11065 * but any additional allocations must be managed by the user.
11066 * @see elm_entry_text_filter_append
11067 * @see elm_entry_text_filter_prepend
11069 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11072 * This adds an entry to @p parent object.
11074 * By default, entries are:
11078 * @li autosave is enabled
11080 * @param parent The parent object
11081 * @return The new object or NULL if it cannot be created
11083 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11085 * Sets the entry to single line mode.
11087 * In single line mode, entries don't ever wrap when the text reaches the
11088 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11089 * key will generate an @c "activate" event instead of adding a new line.
11091 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11092 * and pressing enter will break the text into a different line
11093 * without generating any events.
11095 * @param obj The entry object
11096 * @param single_line If true, the text in the entry
11097 * will be on a single line.
11099 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11101 * Gets whether the entry is set to be single line.
11103 * @param obj The entry object
11104 * @return single_line If true, the text in the entry is set to display
11105 * on a single line.
11107 * @see elm_entry_single_line_set()
11109 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11111 * Sets the entry to password mode.
11113 * In password mode, entries are implicitly single line and the display of
11114 * any text in them is replaced with asterisks (*).
11116 * @param obj The entry object
11117 * @param password If true, password mode is enabled.
11119 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11121 * Gets whether the entry is set to password mode.
11123 * @param obj The entry object
11124 * @return If true, the entry is set to display all characters
11125 * as asterisks (*).
11127 * @see elm_entry_password_set()
11129 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11131 * This sets the text displayed within the entry to @p entry.
11133 * @param obj The entry object
11134 * @param entry The text to be displayed
11136 * @deprecated Use elm_object_text_set() instead.
11137 * @note Using this function bypasses text filters
11139 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11141 * This returns the text currently shown in object @p entry.
11142 * See also elm_entry_entry_set().
11144 * @param obj The entry object
11145 * @return The currently displayed text or NULL on failure
11147 * @deprecated Use elm_object_text_get() instead.
11149 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11151 * Appends @p entry to the text of the entry.
11153 * Adds the text in @p entry to the end of any text already present in the
11156 * The appended text is subject to any filters set for the widget.
11158 * @param obj The entry object
11159 * @param entry The text to be displayed
11161 * @see elm_entry_text_filter_append()
11163 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11165 * Gets whether the entry is empty.
11167 * Empty means no text at all. If there are any markup tags, like an item
11168 * tag for which no provider finds anything, and no text is displayed, this
11169 * function still returns EINA_FALSE.
11171 * @param obj The entry object
11172 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11174 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11176 * Gets any selected text within the entry.
11178 * If there's any selected text in the entry, this function returns it as
11179 * a string in markup format. NULL is returned if no selection exists or
11180 * if an error occurred.
11182 * The returned value points to an internal string and should not be freed
11183 * or modified in any way. If the @p entry object is deleted or its
11184 * contents are changed, the returned pointer should be considered invalid.
11186 * @param obj The entry object
11187 * @return The selected text within the entry or NULL on failure
11189 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11191 * Returns the actual textblock object of the entry.
11193 * This function exposes the internal textblock object that actually
11194 * contains and draws the text. This should be used for low-level
11195 * manipulations that are otherwise not possible.
11197 * Changing the textblock directly from here will not notify edje/elm to
11198 * recalculate the textblock size automatically, so any modifications
11199 * done to the textblock returned by this function should be followed by
11200 * a call to elm_entry_calc_force().
11202 * The return value is marked as const as an additional warning.
11203 * One should not use the returned object with any of the generic evas
11204 * functions (geometry_get/resize/move and etc), but only with the textblock
11205 * functions; The former will either not work at all, or break the correct
11208 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11209 * the internal textblock object. Do NOT cache the returned object, and try
11210 * not to mix calls on this object with regular elm_entry calls (which may
11211 * change the internal textblock object). This applies to all cursors
11212 * returned from textblock calls, and all the other derivative values.
11214 * @param obj The entry object
11215 * @return The textblock object.
11217 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11219 * Forces calculation of the entry size and text layouting.
11221 * This should be used after modifying the textblock object directly. See
11222 * elm_entry_textblock_get() for more information.
11224 * @param obj The entry object
11226 * @see elm_entry_textblock_get()
11228 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11230 * Inserts the given text into the entry at the current cursor position.
11232 * This inserts text at the cursor position as if it was typed
11233 * by the user (note that this also allows markup which a user
11234 * can't just "type" as it would be converted to escaped text, so this
11235 * call can be used to insert things like emoticon items or bold push/pop
11236 * tags, other font and color change tags etc.)
11238 * If any selection exists, it will be replaced by the inserted text.
11240 * The inserted text is subject to any filters set for the widget.
11242 * @param obj The entry object
11243 * @param entry The text to insert
11245 * @see elm_entry_text_filter_append()
11247 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11249 * Set the line wrap type to use on multi-line entries.
11251 * Sets the wrap type used by the entry to any of the specified in
11252 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11253 * line (without inserting a line break or paragraph separator) when it
11254 * reaches the far edge of the widget.
11256 * Note that this only makes sense for multi-line entries. A widget set
11257 * to be single line will never wrap.
11259 * @param obj The entry object
11260 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11262 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11263 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11265 * Gets the wrap mode the entry was set to use.
11267 * @param obj The entry object
11268 * @return Wrap type
11270 * @see also elm_entry_line_wrap_set()
11272 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11274 * Sets if the entry is to be editable or not.
11276 * By default, entries are editable and when focused, any text input by the
11277 * user will be inserted at the current cursor position. But calling this
11278 * function with @p editable as EINA_FALSE will prevent the user from
11279 * inputting text into the entry.
11281 * The only way to change the text of a non-editable entry is to use
11282 * elm_object_text_set(), elm_entry_entry_insert() and other related
11285 * @param obj The entry object
11286 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11287 * if not, the entry is read-only and no user input is allowed.
11289 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11291 * Gets whether the entry is editable or not.
11293 * @param obj The entry object
11294 * @return If true, the entry is editable by the user.
11295 * If false, it is not editable by the user
11297 * @see elm_entry_editable_set()
11299 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11301 * This drops any existing text selection within the entry.
11303 * @param obj The entry object
11305 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11307 * This selects all text within the entry.
11309 * @param obj The entry object
11311 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11313 * This moves the cursor one place to the right within the entry.
11315 * @param obj The entry object
11316 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11318 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11320 * This moves the cursor one place to the left within the entry.
11322 * @param obj The entry object
11323 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11325 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11327 * This moves the cursor one line up within the entry.
11329 * @param obj The entry object
11330 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11332 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11334 * This moves the cursor one line down within the entry.
11336 * @param obj The entry object
11337 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11339 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11341 * This moves the cursor to the beginning of the entry.
11343 * @param obj The entry object
11345 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11347 * This moves the cursor to the end of the entry.
11349 * @param obj The entry object
11351 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11353 * This moves the cursor to the beginning of the current line.
11355 * @param obj The entry object
11357 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11359 * This moves the cursor to the end of the current line.
11361 * @param obj The entry object
11363 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11365 * This begins a selection within the entry as though
11366 * the user were holding down the mouse button to make a selection.
11368 * @param obj The entry object
11370 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11372 * This ends a selection within the entry as though
11373 * the user had just released the mouse button while making a selection.
11375 * @param obj The entry object
11377 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11379 * Gets whether a format node exists at the current cursor position.
11381 * A format node is anything that defines how the text is rendered. It can
11382 * be a visible format node, such as a line break or a paragraph separator,
11383 * or an invisible one, such as bold begin or end tag.
11384 * This function returns whether any format node exists at the current
11387 * @param obj The entry object
11388 * @return EINA_TRUE if the current cursor position contains a format node,
11389 * EINA_FALSE otherwise.
11391 * @see elm_entry_cursor_is_visible_format_get()
11393 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11395 * Gets if the current cursor position holds a visible format node.
11397 * @param obj The entry object
11398 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11399 * if it's an invisible one or no format exists.
11401 * @see elm_entry_cursor_is_format_get()
11403 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11405 * Gets the character pointed by the cursor at its current position.
11407 * This function returns a string with the utf8 character stored at the
11408 * current cursor position.
11409 * Only the text is returned, any format that may exist will not be part
11410 * of the return value.
11412 * @param obj The entry object
11413 * @return The text pointed by the cursors.
11415 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11417 * This function returns the geometry of the cursor.
11419 * It's useful if you want to draw something on the cursor (or where it is),
11420 * or for example in the case of scrolled entry where you want to show the
11423 * @param obj The entry object
11424 * @param x returned geometry
11425 * @param y returned geometry
11426 * @param w returned geometry
11427 * @param h returned geometry
11428 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11430 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);
11432 * Sets the cursor position in the entry to the given value
11434 * The value in @p pos is the index of the character position within the
11435 * contents of the string as returned by elm_entry_cursor_pos_get().
11437 * @param obj The entry object
11438 * @param pos The position of the cursor
11440 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11442 * Retrieves the current position of the cursor in the entry
11444 * @param obj The entry object
11445 * @return The cursor position
11447 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11449 * This executes a "cut" action on the selected text in the entry.
11451 * @param obj The entry object
11453 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11455 * This executes a "copy" action on the selected text in the entry.
11457 * @param obj The entry object
11459 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11461 * This executes a "paste" action in the entry.
11463 * @param obj The entry object
11465 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11467 * This clears and frees the items in a entry's contextual (longpress)
11470 * @param obj The entry object
11472 * @see elm_entry_context_menu_item_add()
11474 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11476 * This adds an item to the entry's contextual menu.
11478 * A longpress on an entry will make the contextual menu show up, if this
11479 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11480 * By default, this menu provides a few options like enabling selection mode,
11481 * which is useful on embedded devices that need to be explicit about it,
11482 * and when a selection exists it also shows the copy and cut actions.
11484 * With this function, developers can add other options to this menu to
11485 * perform any action they deem necessary.
11487 * @param obj The entry object
11488 * @param label The item's text label
11489 * @param icon_file The item's icon file
11490 * @param icon_type The item's icon type
11491 * @param func The callback to execute when the item is clicked
11492 * @param data The data to associate with the item for related functions
11494 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);
11496 * This disables the entry's contextual (longpress) menu.
11498 * @param obj The entry object
11499 * @param disabled If true, the menu is disabled
11501 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11503 * This returns whether the entry's contextual (longpress) menu is
11506 * @param obj The entry object
11507 * @return If true, the menu is disabled
11509 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11511 * This disables the entry's magnifer feature.
11513 * @param obj The entry object
11514 * @param disabled If true, the magnifier is not displayed
11516 EAPI void elm_entry_magnifier_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11518 * This returns whether the entry's magnifier feature is disabled.
11520 * @param obj The entry object
11521 * @return If true, the feature is disabled
11523 EAPI Eina_Bool elm_entry_magnifier_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11525 * This appends a custom item provider to the list for that entry
11527 * This appends the given callback. The list is walked from beginning to end
11528 * with each function called given the item href string in the text. If the
11529 * function returns an object handle other than NULL (it should create an
11530 * object to do this), then this object is used to replace that item. If
11531 * not the next provider is called until one provides an item object, or the
11532 * default provider in entry does.
11534 * @param obj The entry object
11535 * @param func The function called to provide the item object
11536 * @param data The data passed to @p func
11538 * @see @ref entry-items
11540 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);
11542 * This prepends a custom item provider to the list for that entry
11544 * This prepends the given callback. See elm_entry_item_provider_append() for
11547 * @param obj The entry object
11548 * @param func The function called to provide the item object
11549 * @param data The data passed to @p func
11551 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);
11553 * This removes a custom item provider to the list for that entry
11555 * This removes the given callback. See elm_entry_item_provider_append() for
11558 * @param obj The entry object
11559 * @param func The function called to provide the item object
11560 * @param data The data passed to @p func
11562 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);
11564 * Append a filter function for text inserted in the entry
11566 * Append the given callback to the list. This functions will be called
11567 * whenever any text is inserted into the entry, with the text to be inserted
11568 * as a parameter. The callback function is free to alter the text in any way
11569 * it wants, but it must remember to free the given pointer and update it.
11570 * If the new text is to be discarded, the function can free it and set its
11571 * text parameter to NULL. This will also prevent any following filters from
11574 * @param obj The entry object
11575 * @param func The function to use as text filter
11576 * @param data User data to pass to @p func
11578 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11580 * Prepend a filter function for text insdrted in the entry
11582 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11583 * for more information
11585 * @param obj The entry object
11586 * @param func The function to use as text filter
11587 * @param data User data to pass to @p func
11589 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11591 * Remove a filter from the list
11593 * Removes the given callback from the filter list. See
11594 * elm_entry_text_filter_append() for more information.
11596 * @param obj The entry object
11597 * @param func The filter function to remove
11598 * @param data The user data passed when adding the function
11600 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11602 * This converts a markup (HTML-like) string into UTF-8.
11604 * The returned string is a malloc'ed buffer and it should be freed when
11605 * not needed anymore.
11607 * @param s The string (in markup) to be converted
11608 * @return The converted string (in UTF-8). It should be freed.
11610 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11612 * This converts a UTF-8 string into markup (HTML-like).
11614 * The returned string is a malloc'ed buffer and it should be freed when
11615 * not needed anymore.
11617 * @param s The string (in UTF-8) to be converted
11618 * @return The converted string (in markup). It should be freed.
11620 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11622 * This sets the file (and implicitly loads it) for the text to display and
11623 * then edit. All changes are written back to the file after a short delay if
11624 * the entry object is set to autosave (which is the default).
11626 * If the entry had any other file set previously, any changes made to it
11627 * will be saved if the autosave feature is enabled, otherwise, the file
11628 * will be silently discarded and any non-saved changes will be lost.
11630 * @param obj The entry object
11631 * @param file The path to the file to load and save
11632 * @param format The file format
11634 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11636 * Gets the file being edited by the entry.
11638 * This function can be used to retrieve any file set on the entry for
11639 * edition, along with the format used to load and save it.
11641 * @param obj The entry object
11642 * @param file The path to the file to load and save
11643 * @param format The file format
11645 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11647 * This function writes any changes made to the file set with
11648 * elm_entry_file_set()
11650 * @param obj The entry object
11652 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11654 * This sets the entry object to 'autosave' the loaded text file or not.
11656 * @param obj The entry object
11657 * @param autosave Autosave the loaded file or not
11659 * @see elm_entry_file_set()
11661 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11663 * This gets the entry object's 'autosave' status.
11665 * @param obj The entry object
11666 * @return Autosave the loaded file or not
11668 * @see elm_entry_file_set()
11670 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11673 * @enum _Elm_CNP_Mode
11674 * @typedef Elm_CNP_Mode
11675 * Enum of entry's copy & paste policy.
11677 * @see elm_entry_cnp_mode_set()
11678 * @see elm_entry_cnp_mode_get()
11680 typedef enum _Elm_CNP_Mode {
11681 ELM_CNP_MODE_MARKUP = 0, /**< copy & paste text with markup tag */
11682 ELM_CNP_MODE_NO_IMAGE = 1, /**< copy & paste text without item(image) tag */
11683 ELM_CNP_MODE_PLAINTEXT = 2 /**< copy & paste text without markup tag */
11687 * Control pasting of text and images for the widget.
11689 * Normally the entry allows both text and images to be pasted.
11690 * By setting textonly to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
11691 * By setting textonly to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
11693 * @note this only changes the behaviour of text.
11695 * @param obj The entry object
11696 * @param mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11697 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11699 EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_CNP_Mode cnp_mode) EINA_ARG_NONNULL(1);
11701 * Getting elm_entry text paste/drop mode.
11703 * Normally the entry allows both text and images to be pasted.
11704 * This gets the copy & paste mode of the entry.
11706 * @param obj The entry object
11707 * @return mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11708 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11710 EAPI Elm_CNP_Mode elm_entry_cnp_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11713 * Control pasting of text and images for the widget.
11715 * Normally the entry allows both text and images to be pasted. By setting
11716 * textonly to be true, this prevents images from being pasted.
11718 * Note this only changes the behaviour of text.
11720 * @param obj The entry object
11721 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11722 * text+image+other.
11724 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11726 * Getting elm_entry text paste/drop mode.
11728 * In textonly mode, only text may be pasted or dropped into the widget.
11730 * @param obj The entry object
11731 * @return If the widget only accepts text from pastes.
11733 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11735 * Enable or disable scrolling in entry
11737 * Normally the entry is not scrollable unless you enable it with this call.
11739 * @param obj The entry object
11740 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11742 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11744 * Get the scrollable state of the entry
11746 * Normally the entry is not scrollable. This gets the scrollable state
11747 * of the entry. See elm_entry_scrollable_set() for more information.
11749 * @param obj The entry object
11750 * @return The scrollable state
11752 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11754 * This sets a widget to be displayed to the left of a scrolled entry.
11756 * @param obj The scrolled entry object
11757 * @param icon The widget to display on the left side of the scrolled
11760 * @note A previously set widget will be destroyed.
11761 * @note If the object being set does not have minimum size hints set,
11762 * it won't get properly displayed.
11764 * @see elm_entry_end_set()
11766 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11768 * Gets the leftmost widget of the scrolled entry. This object is
11769 * owned by the scrolled entry and should not be modified.
11771 * @param obj The scrolled entry object
11772 * @return the left widget inside the scroller
11774 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11776 * Unset the leftmost widget of the scrolled entry, unparenting and
11779 * @param obj The scrolled entry object
11780 * @return the previously set icon sub-object of this entry, on
11783 * @see elm_entry_icon_set()
11785 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11787 * Sets the visibility of the left-side widget of the scrolled entry,
11788 * set by elm_entry_icon_set().
11790 * @param obj The scrolled entry object
11791 * @param setting EINA_TRUE if the object should be displayed,
11792 * EINA_FALSE if not.
11794 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11796 * This sets a widget to be displayed to the end of a scrolled entry.
11798 * @param obj The scrolled entry object
11799 * @param end The widget to display on the right side of the scrolled
11802 * @note A previously set widget will be destroyed.
11803 * @note If the object being set does not have minimum size hints set,
11804 * it won't get properly displayed.
11806 * @see elm_entry_icon_set
11808 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11810 * Gets the endmost widget of the scrolled entry. This object is owned
11811 * by the scrolled entry and should not be modified.
11813 * @param obj The scrolled entry object
11814 * @return the right widget inside the scroller
11816 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11818 * Unset the endmost widget of the scrolled entry, unparenting and
11821 * @param obj The scrolled entry object
11822 * @return the previously set icon sub-object of this entry, on
11825 * @see elm_entry_icon_set()
11827 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11829 * Sets the visibility of the end widget of the scrolled entry, set by
11830 * elm_entry_end_set().
11832 * @param obj The scrolled entry object
11833 * @param setting EINA_TRUE if the object should be displayed,
11834 * EINA_FALSE if not.
11836 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11838 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11841 * Setting an entry to single-line mode with elm_entry_single_line_set()
11842 * will automatically disable the display of scrollbars when the entry
11843 * moves inside its scroller.
11845 * @param obj The scrolled entry object
11846 * @param h The horizontal scrollbar policy to apply
11847 * @param v The vertical scrollbar policy to apply
11849 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11851 * This enables/disables bouncing within the entry.
11853 * This function sets whether the entry will bounce when scrolling reaches
11854 * the end of the contained entry.
11856 * @param obj The scrolled entry object
11857 * @param h The horizontal bounce state
11858 * @param v The vertical bounce state
11860 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11862 * Get the bounce mode
11864 * @param obj The Entry object
11865 * @param h_bounce Allow bounce horizontally
11866 * @param v_bounce Allow bounce vertically
11868 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11870 /* pre-made filters for entries */
11872 * @typedef Elm_Entry_Filter_Limit_Size
11874 * Data for the elm_entry_filter_limit_size() entry filter.
11876 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11878 * @struct _Elm_Entry_Filter_Limit_Size
11880 * Data for the elm_entry_filter_limit_size() entry filter.
11882 struct _Elm_Entry_Filter_Limit_Size
11884 int max_char_count; /**< The maximum number of characters allowed. */
11885 int max_byte_count; /**< The maximum number of bytes allowed*/
11888 * Filter inserted text based on user defined character and byte limits
11890 * Add this filter to an entry to limit the characters that it will accept
11891 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11892 * The funtion works on the UTF-8 representation of the string, converting
11893 * it from the set markup, thus not accounting for any format in it.
11895 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11896 * it as data when setting the filter. In it, it's possible to set limits
11897 * by character count or bytes (any of them is disabled if 0), and both can
11898 * be set at the same time. In that case, it first checks for characters,
11901 * The function will cut the inserted text in order to allow only the first
11902 * number of characters that are still allowed. The cut is made in
11903 * characters, even when limiting by bytes, in order to always contain
11904 * valid ones and avoid half unicode characters making it in.
11906 * This filter, like any others, does not apply when setting the entry text
11907 * directly with elm_object_text_set() (or the deprecated
11908 * elm_entry_entry_set()).
11910 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11912 * @typedef Elm_Entry_Filter_Accept_Set
11914 * Data for the elm_entry_filter_accept_set() entry filter.
11916 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11918 * @struct _Elm_Entry_Filter_Accept_Set
11920 * Data for the elm_entry_filter_accept_set() entry filter.
11922 struct _Elm_Entry_Filter_Accept_Set
11924 const char *accepted; /**< Set of characters accepted in the entry. */
11925 const char *rejected; /**< Set of characters rejected from the entry. */
11928 * Filter inserted text based on accepted or rejected sets of characters
11930 * Add this filter to an entry to restrict the set of accepted characters
11931 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11932 * This structure contains both accepted and rejected sets, but they are
11933 * mutually exclusive.
11935 * The @c accepted set takes preference, so if it is set, the filter will
11936 * only work based on the accepted characters, ignoring anything in the
11937 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11939 * In both cases, the function filters by matching utf8 characters to the
11940 * raw markup text, so it can be used to remove formatting tags.
11942 * This filter, like any others, does not apply when setting the entry text
11943 * directly with elm_object_text_set() (or the deprecated
11944 * elm_entry_entry_set()).
11946 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11948 * Set the input panel layout of the entry
11950 * @param obj The entry object
11951 * @param layout layout type
11953 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11955 * Get the input panel layout of the entry
11957 * @param obj The entry object
11958 * @return layout type
11960 * @see elm_entry_input_panel_layout_set
11962 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11964 * Set the autocapitalization type on the immodule.
11966 * @param obj The entry object
11967 * @param autocapital_type The type of autocapitalization
11969 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11971 * Retrieve the autocapitalization type on the immodule.
11973 * @param obj The entry object
11974 * @return autocapitalization type
11976 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11978 * Sets the attribute to show the input panel automatically.
11980 * @param obj The entry object
11981 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11983 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11985 * Retrieve the attribute to show the input panel automatically.
11987 * @param obj The entry object
11988 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11990 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11992 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11993 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11994 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11995 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11996 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11997 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
12003 /* composite widgets - these basically put together basic widgets above
12004 * in convenient packages that do more than basic stuff */
12008 * @defgroup Anchorview Anchorview
12010 * @image html img/widget/anchorview/preview-00.png
12011 * @image latex img/widget/anchorview/preview-00.eps
12013 * Anchorview is for displaying text that contains markup with anchors
12014 * like <c>\<a href=1234\>something\</\></c> in it.
12016 * Besides being styled differently, the anchorview widget provides the
12017 * necessary functionality so that clicking on these anchors brings up a
12018 * popup with user defined content such as "call", "add to contacts" or
12019 * "open web page". This popup is provided using the @ref Hover widget.
12021 * This widget is very similar to @ref Anchorblock, so refer to that
12022 * widget for an example. The only difference Anchorview has is that the
12023 * widget is already provided with scrolling functionality, so if the
12024 * text set to it is too large to fit in the given space, it will scroll,
12025 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12026 * text can be displayed.
12028 * This widget emits the following signals:
12029 * @li "anchor,clicked": will be called when an anchor is clicked. The
12030 * @p event_info parameter on the callback will be a pointer of type
12031 * ::Elm_Entry_Anchorview_Info.
12033 * See @ref Anchorblock for an example on how to use both of them.
12042 * @typedef Elm_Entry_Anchorview_Info
12044 * The info sent in the callback for "anchor,clicked" signals emitted by
12045 * the Anchorview widget.
12047 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12049 * @struct _Elm_Entry_Anchorview_Info
12051 * The info sent in the callback for "anchor,clicked" signals emitted by
12052 * the Anchorview widget.
12054 struct _Elm_Entry_Anchorview_Info
12056 const char *name; /**< Name of the anchor, as indicated in its href
12058 int button; /**< The mouse button used to click on it */
12059 Evas_Object *hover; /**< The hover object to use for the popup */
12061 Evas_Coord x, y, w, h;
12062 } anchor, /**< Geometry selection of text used as anchor */
12063 hover_parent; /**< Geometry of the object used as parent by the
12065 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12066 for content on the left side of
12067 the hover. Before calling the
12068 callback, the widget will make the
12069 necessary calculations to check
12070 which sides are fit to be set with
12071 content, based on the position the
12072 hover is activated and its distance
12073 to the edges of its parent object
12075 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12076 the right side of the hover.
12077 See @ref hover_left */
12078 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12079 of the hover. See @ref hover_left */
12080 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12081 below the hover. See @ref
12085 * Add a new Anchorview object
12087 * @param parent The parent object
12088 * @return The new object or NULL if it cannot be created
12090 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12092 * Set the text to show in the anchorview
12094 * Sets the text of the anchorview to @p text. This text can include markup
12095 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12096 * text that will be specially styled and react to click events, ended with
12097 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12098 * "anchor,clicked" signal that you can attach a callback to with
12099 * evas_object_smart_callback_add(). The name of the anchor given in the
12100 * event info struct will be the one set in the href attribute, in this
12101 * case, anchorname.
12103 * Other markup can be used to style the text in different ways, but it's
12104 * up to the style defined in the theme which tags do what.
12105 * @deprecated use elm_object_text_set() instead.
12107 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12109 * Get the markup text set for the anchorview
12111 * Retrieves the text set on the anchorview, with markup tags included.
12113 * @param obj The anchorview object
12114 * @return The markup text set or @c NULL if nothing was set or an error
12116 * @deprecated use elm_object_text_set() instead.
12118 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12120 * Set the parent of the hover popup
12122 * Sets the parent object to use by the hover created by the anchorview
12123 * when an anchor is clicked. See @ref Hover for more details on this.
12124 * If no parent is set, the same anchorview object will be used.
12126 * @param obj The anchorview object
12127 * @param parent The object to use as parent for the hover
12129 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12131 * Get the parent of the hover popup
12133 * Get the object used as parent for the hover created by the anchorview
12134 * widget. See @ref Hover for more details on this.
12136 * @param obj The anchorview object
12137 * @return The object used as parent for the hover, NULL if none is set.
12139 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12141 * Set the style that the hover should use
12143 * When creating the popup hover, anchorview will request that it's
12144 * themed according to @p style.
12146 * @param obj The anchorview object
12147 * @param style The style to use for the underlying hover
12149 * @see elm_object_style_set()
12151 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12153 * Get the style that the hover should use
12155 * Get the style the hover created by anchorview will use.
12157 * @param obj The anchorview object
12158 * @return The style to use by the hover. NULL means the default is used.
12160 * @see elm_object_style_set()
12162 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12164 * Ends the hover popup in the anchorview
12166 * When an anchor is clicked, the anchorview widget will create a hover
12167 * object to use as a popup with user provided content. This function
12168 * terminates this popup, returning the anchorview to its normal state.
12170 * @param obj The anchorview object
12172 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12174 * Set bouncing behaviour when the scrolled content reaches an edge
12176 * Tell the internal scroller object whether it should bounce or not
12177 * when it reaches the respective edges for each axis.
12179 * @param obj The anchorview object
12180 * @param h_bounce Whether to bounce or not in the horizontal axis
12181 * @param v_bounce Whether to bounce or not in the vertical axis
12183 * @see elm_scroller_bounce_set()
12185 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12187 * Get the set bouncing behaviour of the internal scroller
12189 * Get whether the internal scroller should bounce when the edge of each
12190 * axis is reached scrolling.
12192 * @param obj The anchorview object
12193 * @param h_bounce Pointer where to store the bounce state of the horizontal
12195 * @param v_bounce Pointer where to store the bounce state of the vertical
12198 * @see elm_scroller_bounce_get()
12200 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12202 * Appends a custom item provider to the given anchorview
12204 * Appends the given function to the list of items providers. This list is
12205 * called, one function at a time, with the given @p data pointer, the
12206 * anchorview object and, in the @p item parameter, the item name as
12207 * referenced in its href string. Following functions in the list will be
12208 * called in order until one of them returns something different to NULL,
12209 * which should be an Evas_Object which will be used in place of the item
12212 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12213 * href=item/name\>\</item\>
12215 * @param obj The anchorview object
12216 * @param func The function to add to the list of providers
12217 * @param data User data that will be passed to the callback function
12219 * @see elm_entry_item_provider_append()
12221 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);
12223 * Prepend a custom item provider to the given anchorview
12225 * Like elm_anchorview_item_provider_append(), but it adds the function
12226 * @p func to the beginning of the list, instead of the end.
12228 * @param obj The anchorview object
12229 * @param func The function to add to the list of providers
12230 * @param data User data that will be passed to the callback function
12232 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);
12234 * Remove a custom item provider from the list of the given anchorview
12236 * Removes the function and data pairing that matches @p func and @p data.
12237 * That is, unless the same function and same user data are given, the
12238 * function will not be removed from the list. This allows us to add the
12239 * same callback several times, with different @p data pointers and be
12240 * able to remove them later without conflicts.
12242 * @param obj The anchorview object
12243 * @param func The function to remove from the list
12244 * @param data The data matching the function to remove from the list
12246 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);
12253 * @defgroup Anchorblock Anchorblock
12255 * @image html img/widget/anchorblock/preview-00.png
12256 * @image latex img/widget/anchorblock/preview-00.eps
12258 * Anchorblock is for displaying text that contains markup with anchors
12259 * like <c>\<a href=1234\>something\</\></c> in it.
12261 * Besides being styled differently, the anchorblock widget provides the
12262 * necessary functionality so that clicking on these anchors brings up a
12263 * popup with user defined content such as "call", "add to contacts" or
12264 * "open web page". This popup is provided using the @ref Hover widget.
12266 * This widget emits the following signals:
12267 * @li "anchor,clicked": will be called when an anchor is clicked. The
12268 * @p event_info parameter on the callback will be a pointer of type
12269 * ::Elm_Entry_Anchorblock_Info.
12275 * Since examples are usually better than plain words, we might as well
12276 * try @ref tutorial_anchorblock_example "one".
12279 * @addtogroup Anchorblock
12283 * @typedef Elm_Entry_Anchorblock_Info
12285 * The info sent in the callback for "anchor,clicked" signals emitted by
12286 * the Anchorblock widget.
12288 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12290 * @struct _Elm_Entry_Anchorblock_Info
12292 * The info sent in the callback for "anchor,clicked" signals emitted by
12293 * the Anchorblock widget.
12295 struct _Elm_Entry_Anchorblock_Info
12297 const char *name; /**< Name of the anchor, as indicated in its href
12299 int button; /**< The mouse button used to click on it */
12300 Evas_Object *hover; /**< The hover object to use for the popup */
12302 Evas_Coord x, y, w, h;
12303 } anchor, /**< Geometry selection of text used as anchor */
12304 hover_parent; /**< Geometry of the object used as parent by the
12306 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12307 for content on the left side of
12308 the hover. Before calling the
12309 callback, the widget will make the
12310 necessary calculations to check
12311 which sides are fit to be set with
12312 content, based on the position the
12313 hover is activated and its distance
12314 to the edges of its parent object
12316 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12317 the right side of the hover.
12318 See @ref hover_left */
12319 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12320 of the hover. See @ref hover_left */
12321 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12322 below the hover. See @ref
12326 * Add a new Anchorblock object
12328 * @param parent The parent object
12329 * @return The new object or NULL if it cannot be created
12331 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12333 * Set the text to show in the anchorblock
12335 * Sets the text of the anchorblock to @p text. This text can include markup
12336 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12337 * of text that will be specially styled and react to click events, ended
12338 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12339 * "anchor,clicked" signal that you can attach a callback to with
12340 * evas_object_smart_callback_add(). The name of the anchor given in the
12341 * event info struct will be the one set in the href attribute, in this
12342 * case, anchorname.
12344 * Other markup can be used to style the text in different ways, but it's
12345 * up to the style defined in the theme which tags do what.
12346 * @deprecated use elm_object_text_set() instead.
12348 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12350 * Get the markup text set for the anchorblock
12352 * Retrieves the text set on the anchorblock, with markup tags included.
12354 * @param obj The anchorblock object
12355 * @return The markup text set or @c NULL if nothing was set or an error
12357 * @deprecated use elm_object_text_set() instead.
12359 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12361 * Set the parent of the hover popup
12363 * Sets the parent object to use by the hover created by the anchorblock
12364 * when an anchor is clicked. See @ref Hover for more details on this.
12366 * @param obj The anchorblock object
12367 * @param parent The object to use as parent for the hover
12369 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12371 * Get the parent of the hover popup
12373 * Get the object used as parent for the hover created by the anchorblock
12374 * widget. See @ref Hover for more details on this.
12375 * If no parent is set, the same anchorblock object will be used.
12377 * @param obj The anchorblock object
12378 * @return The object used as parent for the hover, NULL if none is set.
12380 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12382 * Set the style that the hover should use
12384 * When creating the popup hover, anchorblock will request that it's
12385 * themed according to @p style.
12387 * @param obj The anchorblock object
12388 * @param style The style to use for the underlying hover
12390 * @see elm_object_style_set()
12392 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12394 * Get the style that the hover should use
12396 * Get the style, the hover created by anchorblock will use.
12398 * @param obj The anchorblock object
12399 * @return The style to use by the hover. NULL means the default is used.
12401 * @see elm_object_style_set()
12403 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12405 * Ends the hover popup in the anchorblock
12407 * When an anchor is clicked, the anchorblock widget will create a hover
12408 * object to use as a popup with user provided content. This function
12409 * terminates this popup, returning the anchorblock to its normal state.
12411 * @param obj The anchorblock object
12413 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12415 * Appends a custom item provider to the given anchorblock
12417 * Appends the given function to the list of items providers. This list is
12418 * called, one function at a time, with the given @p data pointer, the
12419 * anchorblock object and, in the @p item parameter, the item name as
12420 * referenced in its href string. Following functions in the list will be
12421 * called in order until one of them returns something different to NULL,
12422 * which should be an Evas_Object which will be used in place of the item
12425 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12426 * href=item/name\>\</item\>
12428 * @param obj The anchorblock object
12429 * @param func The function to add to the list of providers
12430 * @param data User data that will be passed to the callback function
12432 * @see elm_entry_item_provider_append()
12434 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);
12436 * Prepend a custom item provider to the given anchorblock
12438 * Like elm_anchorblock_item_provider_append(), but it adds the function
12439 * @p func to the beginning of the list, instead of the end.
12441 * @param obj The anchorblock object
12442 * @param func The function to add to the list of providers
12443 * @param data User data that will be passed to the callback function
12445 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);
12447 * Remove a custom item provider from the list of the given anchorblock
12449 * Removes the function and data pairing that matches @p func and @p data.
12450 * That is, unless the same function and same user data are given, the
12451 * function will not be removed from the list. This allows us to add the
12452 * same callback several times, with different @p data pointers and be
12453 * able to remove them later without conflicts.
12455 * @param obj The anchorblock object
12456 * @param func The function to remove from the list
12457 * @param data The data matching the function to remove from the list
12459 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);
12465 * @defgroup Bubble Bubble
12467 * @image html img/widget/bubble/preview-00.png
12468 * @image latex img/widget/bubble/preview-00.eps
12469 * @image html img/widget/bubble/preview-01.png
12470 * @image latex img/widget/bubble/preview-01.eps
12471 * @image html img/widget/bubble/preview-02.png
12472 * @image latex img/widget/bubble/preview-02.eps
12474 * @brief The Bubble is a widget to show text similar to how speech is
12475 * represented in comics.
12477 * The bubble widget contains 5 important visual elements:
12478 * @li The frame is a rectangle with rounded edjes and an "arrow".
12479 * @li The @p icon is an image to which the frame's arrow points to.
12480 * @li The @p label is a text which appears to the right of the icon if the
12481 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12483 * @li The @p info is a text which appears to the right of the label. Info's
12484 * font is of a ligther color than label.
12485 * @li The @p content is an evas object that is shown inside the frame.
12487 * The position of the arrow, icon, label and info depends on which corner is
12488 * selected. The four available corners are:
12489 * @li "top_left" - Default
12491 * @li "bottom_left"
12492 * @li "bottom_right"
12494 * Signals that you can add callbacks for are:
12495 * @li "clicked" - This is called when a user has clicked the bubble.
12497 * Default contents parts of the bubble that you can use for are:
12498 * @li "default" - A content of the bubble
12499 * @li "icon" - An icon of the bubble
12501 * Default text parts of the button widget that you can use for are:
12502 * @li NULL - Label of the bubble
12504 * For an example of using a buble see @ref bubble_01_example_page "this".
12510 * Add a new bubble to the parent
12512 * @param parent The parent object
12513 * @return The new object or NULL if it cannot be created
12515 * This function adds a text bubble to the given parent evas object.
12517 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12519 * Set the label of the bubble
12521 * @param obj The bubble object
12522 * @param label The string to set in the label
12524 * This function sets the title of the bubble. Where this appears depends on
12525 * the selected corner.
12526 * @deprecated use elm_object_text_set() instead.
12528 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12530 * Get the label of the bubble
12532 * @param obj The bubble object
12533 * @return The string of set in the label
12535 * This function gets the title of the bubble.
12536 * @deprecated use elm_object_text_get() instead.
12538 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12540 * Set the info of the bubble
12542 * @param obj The bubble object
12543 * @param info The given info about the bubble
12545 * This function sets the info of the bubble. Where this appears depends on
12546 * the selected corner.
12547 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12549 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12551 * Get the info of the bubble
12553 * @param obj The bubble object
12555 * @return The "info" string of the bubble
12557 * This function gets the info text.
12558 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12560 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12562 * Set the content to be shown in the bubble
12564 * Once the content object is set, a previously set one will be deleted.
12565 * If you want to keep the old content object, use the
12566 * elm_bubble_content_unset() function.
12568 * @param obj The bubble object
12569 * @param content The given content of the bubble
12571 * This function sets the content shown on the middle of the bubble.
12573 * @deprecated use elm_object_content_set() instead
12576 WILL_DEPRECATE EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12578 * Get the content shown in the bubble
12580 * Return the content object which is set for this widget.
12582 * @param obj The bubble object
12583 * @return The content that is being used
12585 * @deprecated use elm_object_content_get() instead
12588 WILL_DEPRECATE EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12590 * Unset the content shown in the bubble
12592 * Unparent and return the content object which was set for this widget.
12594 * @param obj The bubble object
12595 * @return The content that was being used
12597 * @deprecated use elm_object_content_unset() instead
12600 WILL_DEPRECATE EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12602 * Set the icon of the bubble
12604 * Once the icon object is set, a previously set one will be deleted.
12605 * If you want to keep the old content object, use the
12606 * elm_icon_content_unset() function.
12608 * @param obj The bubble object
12609 * @param icon The given icon for the bubble
12611 * @deprecated use elm_object_part_content_set() instead
12614 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12616 * Get the icon of the bubble
12618 * @param obj The bubble object
12619 * @return The icon for the bubble
12621 * This function gets the icon shown on the top left of bubble.
12623 * @deprecated use elm_object_part_content_get() instead
12626 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12628 * Unset the icon of the bubble
12630 * Unparent and return the icon object which was set for this widget.
12632 * @param obj The bubble object
12633 * @return The icon that was being used
12635 * @deprecated use elm_object_part_content_unset() instead
12638 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12640 * Set the corner of the bubble
12642 * @param obj The bubble object.
12643 * @param corner The given corner for the bubble.
12645 * This function sets the corner of the bubble. The corner will be used to
12646 * determine where the arrow in the frame points to and where label, icon and
12649 * Possible values for corner are:
12650 * @li "top_left" - Default
12652 * @li "bottom_left"
12653 * @li "bottom_right"
12655 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12657 * Get the corner of the bubble
12659 * @param obj The bubble object.
12660 * @return The given corner for the bubble.
12662 * This function gets the selected corner of the bubble.
12664 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12671 * @defgroup Photo Photo
12673 * For displaying the photo of a person (contact). Simple, yet
12674 * with a very specific purpose.
12676 * Signals that you can add callbacks for are:
12678 * "clicked" - This is called when a user has clicked the photo
12679 * "drag,start" - Someone started dragging the image out of the object
12680 * "drag,end" - Dragged item was dropped (somewhere)
12686 * Add a new photo to the parent
12688 * @param parent The parent object
12689 * @return The new object or NULL if it cannot be created
12693 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12696 * Set the file that will be used as photo
12698 * @param obj The photo object
12699 * @param file The path to file that will be used as photo
12701 * @return (1 = success, 0 = error)
12705 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12708 * Set the file that will be used as thumbnail in the photo.
12710 * @param obj The photo object.
12711 * @param file The path to file that will be used as thumb.
12712 * @param group The key used in case of an EET file.
12716 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12719 * Set the size that will be used on the photo
12721 * @param obj The photo object
12722 * @param size The size that the photo will be
12726 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12729 * Set if the photo should be completely visible or not.
12731 * @param obj The photo object
12732 * @param fill if true the photo will be completely visible
12736 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12739 * Set editability of the photo.
12741 * An editable photo can be dragged to or from, and can be cut or
12742 * pasted too. Note that pasting an image or dropping an item on
12743 * the image will delete the existing content.
12745 * @param obj The photo object.
12746 * @param set To set of clear editablity.
12748 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12754 /* gesture layer */
12756 * @defgroup Elm_Gesture_Layer Gesture Layer
12757 * Gesture Layer Usage:
12759 * Use Gesture Layer to detect gestures.
12760 * The advantage is that you don't have to implement
12761 * gesture detection, just set callbacks of gesture state.
12762 * By using gesture layer we make standard interface.
12764 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12765 * with a parent object parameter.
12766 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12767 * call. Usually with same object as target (2nd parameter).
12769 * Now you need to tell gesture layer what gestures you follow.
12770 * This is done with @ref elm_gesture_layer_cb_set call.
12771 * By setting the callback you actually saying to gesture layer:
12772 * I would like to know when the gesture @ref Elm_Gesture_Types
12773 * switches to state @ref Elm_Gesture_State.
12775 * Next, you need to implement the actual action that follows the input
12776 * in your callback.
12778 * Note that if you like to stop being reported about a gesture, just set
12779 * all callbacks referring this gesture to NULL.
12780 * (again with @ref elm_gesture_layer_cb_set)
12782 * The information reported by gesture layer to your callback is depending
12783 * on @ref Elm_Gesture_Types:
12784 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12785 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12786 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12788 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12789 * @ref ELM_GESTURE_MOMENTUM.
12791 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12792 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12793 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12794 * Note that we consider a flick as a line-gesture that should be completed
12795 * in flick-time-limit as defined in @ref Config.
12797 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12799 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12802 * Gesture Layer Tweaks:
12804 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12805 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12807 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12808 * so gesture starts when user touches (a *DOWN event) touch-surface
12809 * and ends when no fingers touches surface (a *UP event).
12813 * @enum _Elm_Gesture_Types
12814 * Enum of supported gesture types.
12815 * @ingroup Elm_Gesture_Layer
12817 enum _Elm_Gesture_Types
12819 ELM_GESTURE_FIRST = 0,
12821 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12822 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12823 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12824 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12826 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12828 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12829 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12831 ELM_GESTURE_ZOOM, /**< Zoom */
12832 ELM_GESTURE_ROTATE, /**< Rotate */
12838 * @typedef Elm_Gesture_Types
12839 * gesture types enum
12840 * @ingroup Elm_Gesture_Layer
12842 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12845 * @enum _Elm_Gesture_State
12846 * Enum of gesture states.
12847 * @ingroup Elm_Gesture_Layer
12849 enum _Elm_Gesture_State
12851 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12852 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12853 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12854 ELM_GESTURE_STATE_END, /**< Gesture completed */
12855 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12859 * @typedef Elm_Gesture_State
12860 * gesture states enum
12861 * @ingroup Elm_Gesture_Layer
12863 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12866 * @struct _Elm_Gesture_Taps_Info
12867 * Struct holds taps info for user
12868 * @ingroup Elm_Gesture_Layer
12870 struct _Elm_Gesture_Taps_Info
12872 Evas_Coord x, y; /**< Holds center point between fingers */
12873 unsigned int n; /**< Number of fingers tapped */
12874 unsigned int timestamp; /**< event timestamp */
12878 * @typedef Elm_Gesture_Taps_Info
12879 * holds taps info for user
12880 * @ingroup Elm_Gesture_Layer
12882 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12885 * @struct _Elm_Gesture_Momentum_Info
12886 * Struct holds momentum info for user
12887 * x1 and y1 are not necessarily in sync
12888 * x1 holds x value of x direction starting point
12889 * and same holds for y1.
12890 * This is noticeable when doing V-shape movement
12891 * @ingroup Elm_Gesture_Layer
12893 struct _Elm_Gesture_Momentum_Info
12894 { /* Report line ends, timestamps, and momentum computed */
12895 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12896 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12897 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12898 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12900 unsigned int tx; /**< Timestamp of start of final x-swipe */
12901 unsigned int ty; /**< Timestamp of start of final y-swipe */
12903 Evas_Coord mx; /**< Momentum on X */
12904 Evas_Coord my; /**< Momentum on Y */
12906 unsigned int n; /**< Number of fingers */
12910 * @typedef Elm_Gesture_Momentum_Info
12911 * holds momentum info for user
12912 * @ingroup Elm_Gesture_Layer
12914 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12917 * @struct _Elm_Gesture_Line_Info
12918 * Struct holds line info for user
12919 * @ingroup Elm_Gesture_Layer
12921 struct _Elm_Gesture_Line_Info
12922 { /* Report line ends, timestamps, and momentum computed */
12923 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12924 double angle; /**< Angle (direction) of lines */
12928 * @typedef Elm_Gesture_Line_Info
12929 * Holds line info for user
12930 * @ingroup Elm_Gesture_Layer
12932 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12935 * @struct _Elm_Gesture_Zoom_Info
12936 * Struct holds zoom info for user
12937 * @ingroup Elm_Gesture_Layer
12939 struct _Elm_Gesture_Zoom_Info
12941 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12942 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12943 double zoom; /**< Zoom value: 1.0 means no zoom */
12944 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12948 * @typedef Elm_Gesture_Zoom_Info
12949 * Holds zoom info for user
12950 * @ingroup Elm_Gesture_Layer
12952 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12955 * @struct _Elm_Gesture_Rotate_Info
12956 * Struct holds rotation info for user
12957 * @ingroup Elm_Gesture_Layer
12959 struct _Elm_Gesture_Rotate_Info
12961 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12962 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12963 double base_angle; /**< Holds start-angle */
12964 double angle; /**< Rotation value: 0.0 means no rotation */
12965 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12969 * @typedef Elm_Gesture_Rotate_Info
12970 * Holds rotation info for user
12971 * @ingroup Elm_Gesture_Layer
12973 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12976 * @typedef Elm_Gesture_Event_Cb
12977 * User callback used to stream gesture info from gesture layer
12978 * @param data user data
12979 * @param event_info gesture report info
12980 * Returns a flag field to be applied on the causing event.
12981 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12982 * upon the event, in an irreversible way.
12984 * @ingroup Elm_Gesture_Layer
12986 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12989 * Use function to set callbacks to be notified about
12990 * change of state of gesture.
12991 * When a user registers a callback with this function
12992 * this means this gesture has to be tested.
12994 * When ALL callbacks for a gesture are set to NULL
12995 * it means user isn't interested in gesture-state
12996 * and it will not be tested.
12998 * @param obj Pointer to gesture-layer.
12999 * @param idx The gesture you would like to track its state.
13000 * @param cb callback function pointer.
13001 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13002 * @param data user info to be sent to callback (usually, Smart Data)
13004 * @ingroup Elm_Gesture_Layer
13006 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);
13009 * Call this function to get repeat-events settings.
13011 * @param obj Pointer to gesture-layer.
13013 * @return repeat events settings.
13014 * @see elm_gesture_layer_hold_events_set()
13015 * @ingroup Elm_Gesture_Layer
13017 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13020 * This function called in order to make gesture-layer repeat events.
13021 * Set this of you like to get the raw events only if gestures were not detected.
13022 * Clear this if you like gesture layer to fwd events as testing gestures.
13024 * @param obj Pointer to gesture-layer.
13025 * @param r Repeat: TRUE/FALSE
13027 * @ingroup Elm_Gesture_Layer
13029 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13032 * This function sets step-value for zoom action.
13033 * Set step to any positive value.
13034 * Cancel step setting by setting to 0.0
13036 * @param obj Pointer to gesture-layer.
13037 * @param s new zoom step value.
13039 * @ingroup Elm_Gesture_Layer
13041 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13044 * This function sets step-value for rotate action.
13045 * Set step to any positive value.
13046 * Cancel step setting by setting to 0.0
13048 * @param obj Pointer to gesture-layer.
13049 * @param s new roatate step value.
13051 * @ingroup Elm_Gesture_Layer
13053 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13056 * This function called to attach gesture-layer to an Evas_Object.
13057 * @param obj Pointer to gesture-layer.
13058 * @param t Pointer to underlying object (AKA Target)
13060 * @return TRUE, FALSE on success, failure.
13062 * @ingroup Elm_Gesture_Layer
13064 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13067 * Call this function to construct a new gesture-layer object.
13068 * This does not activate the gesture layer. You have to
13069 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13071 * @param parent the parent object.
13073 * @return Pointer to new gesture-layer object.
13075 * @ingroup Elm_Gesture_Layer
13077 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13080 * @defgroup Thumb Thumb
13082 * @image html img/widget/thumb/preview-00.png
13083 * @image latex img/widget/thumb/preview-00.eps
13085 * A thumb object is used for displaying the thumbnail of an image or video.
13086 * You must have compiled Elementary with Ethumb_Client support and the DBus
13087 * service must be present and auto-activated in order to have thumbnails to
13090 * Once the thumbnail object becomes visible, it will check if there is a
13091 * previously generated thumbnail image for the file set on it. If not, it
13092 * will start generating this thumbnail.
13094 * Different config settings will cause different thumbnails to be generated
13095 * even on the same file.
13097 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13098 * Ethumb documentation to change this path, and to see other configuration
13101 * Signals that you can add callbacks for are:
13103 * - "clicked" - This is called when a user has clicked the thumb without dragging
13105 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13106 * - "press" - This is called when a user has pressed down the thumb.
13107 * - "generate,start" - The thumbnail generation started.
13108 * - "generate,stop" - The generation process stopped.
13109 * - "generate,error" - The generation failed.
13110 * - "load,error" - The thumbnail image loading failed.
13112 * available styles:
13116 * An example of use of thumbnail:
13118 * - @ref thumb_example_01
13122 * @addtogroup Thumb
13127 * @enum _Elm_Thumb_Animation_Setting
13128 * @typedef Elm_Thumb_Animation_Setting
13130 * Used to set if a video thumbnail is animating or not.
13134 typedef enum _Elm_Thumb_Animation_Setting
13136 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13137 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13138 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13139 ELM_THUMB_ANIMATION_LAST
13140 } Elm_Thumb_Animation_Setting;
13143 * Add a new thumb object to the parent.
13145 * @param parent The parent object.
13146 * @return The new object or NULL if it cannot be created.
13148 * @see elm_thumb_file_set()
13149 * @see elm_thumb_ethumb_client_get()
13153 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13155 * Reload thumbnail if it was generated before.
13157 * @param obj The thumb object to reload
13159 * This is useful if the ethumb client configuration changed, like its
13160 * size, aspect or any other property one set in the handle returned
13161 * by elm_thumb_ethumb_client_get().
13163 * If the options didn't change, the thumbnail won't be generated again, but
13164 * the old one will still be used.
13166 * @see elm_thumb_file_set()
13170 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13172 * Set the file that will be used as thumbnail.
13174 * @param obj The thumb object.
13175 * @param file The path to file that will be used as thumb.
13176 * @param key The key used in case of an EET file.
13178 * The file can be an image or a video (in that case, acceptable extensions are:
13179 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13180 * function elm_thumb_animate().
13182 * @see elm_thumb_file_get()
13183 * @see elm_thumb_reload()
13184 * @see elm_thumb_animate()
13188 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13190 * Get the image or video path and key used to generate the thumbnail.
13192 * @param obj The thumb object.
13193 * @param file Pointer to filename.
13194 * @param key Pointer to key.
13196 * @see elm_thumb_file_set()
13197 * @see elm_thumb_path_get()
13201 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13203 * Get the path and key to the image or video generated by ethumb.
13205 * One just need to make sure that the thumbnail was generated before getting
13206 * its path; otherwise, the path will be NULL. One way to do that is by asking
13207 * for the path when/after the "generate,stop" smart callback is called.
13209 * @param obj The thumb object.
13210 * @param file Pointer to thumb path.
13211 * @param key Pointer to thumb key.
13213 * @see elm_thumb_file_get()
13217 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13219 * Set the animation state for the thumb object. If its content is an animated
13220 * video, you may start/stop the animation or tell it to play continuously and
13223 * @param obj The thumb object.
13224 * @param setting The animation setting.
13226 * @see elm_thumb_file_set()
13230 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13232 * Get the animation state for the thumb object.
13234 * @param obj The thumb object.
13235 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13238 * @see elm_thumb_animate_set()
13242 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13244 * Get the ethumb_client handle so custom configuration can be made.
13246 * @return Ethumb_Client instance or NULL.
13248 * This must be called before the objects are created to be sure no object is
13249 * visible and no generation started.
13251 * Example of usage:
13254 * #include <Elementary.h>
13255 * #ifndef ELM_LIB_QUICKLAUNCH
13257 * elm_main(int argc, char **argv)
13259 * Ethumb_Client *client;
13261 * elm_need_ethumb();
13265 * client = elm_thumb_ethumb_client_get();
13268 * ERR("could not get ethumb_client");
13271 * ethumb_client_size_set(client, 100, 100);
13272 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13275 * // Create elm_thumb objects here
13285 * @note There's only one client handle for Ethumb, so once a configuration
13286 * change is done to it, any other request for thumbnails (for any thumbnail
13287 * object) will use that configuration. Thus, this configuration is global.
13291 EAPI void *elm_thumb_ethumb_client_get(void);
13293 * Get the ethumb_client connection state.
13295 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13298 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13300 * Make the thumbnail 'editable'.
13302 * @param obj Thumb object.
13303 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13305 * This means the thumbnail is a valid drag target for drag and drop, and can be
13306 * cut or pasted too.
13308 * @see elm_thumb_editable_get()
13312 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13313 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13315 * Make the thumbnail 'editable'.
13317 * @param obj Thumb object.
13318 * @return Editability.
13320 * This means the thumbnail is a valid drag target for drag and drop, and can be
13321 * cut or pasted too.
13323 * @see elm_thumb_editable_set()
13327 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13334 * @defgroup Web Web
13336 * @image html img/widget/web/preview-00.png
13337 * @image latex img/widget/web/preview-00.eps
13339 * A web object is used for displaying web pages (HTML/CSS/JS)
13340 * using WebKit-EFL. You must have compiled Elementary with
13343 * Signals that you can add callbacks for are:
13344 * @li "download,request": A file download has been requested. Event info is
13345 * a pointer to a Elm_Web_Download
13346 * @li "editorclient,contents,changed": Editor client's contents changed
13347 * @li "editorclient,selection,changed": Editor client's selection changed
13348 * @li "frame,created": A new frame was created. Event info is an
13349 * Evas_Object which can be handled with WebKit's ewk_frame API
13350 * @li "icon,received": An icon was received by the main frame
13351 * @li "inputmethod,changed": Input method changed. Event info is an
13352 * Eina_Bool indicating whether it's enabled or not
13353 * @li "js,windowobject,clear": JS window object has been cleared
13354 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13355 * is a char *link[2], where the first string contains the URL the link
13356 * points to, and the second one the title of the link
13357 * @li "link,hover,out": Mouse cursor left the link
13358 * @li "load,document,finished": Loading of a document finished. Event info
13359 * is the frame that finished loading
13360 * @li "load,error": Load failed. Event info is a pointer to
13361 * Elm_Web_Frame_Load_Error
13362 * @li "load,finished": Load finished. Event info is NULL on success, on
13363 * error it's a pointer to Elm_Web_Frame_Load_Error
13364 * @li "load,newwindow,show": A new window was created and is ready to be
13366 * @li "load,progress": Overall load progress. Event info is a pointer to
13367 * a double containing a value between 0.0 and 1.0
13368 * @li "load,provisional": Started provisional load
13369 * @li "load,started": Loading of a document started
13370 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13371 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13372 * the menubar is visible, or EINA_FALSE in case it's not
13373 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13374 * an Eina_Bool indicating the visibility
13375 * @li "popup,created": A dropdown widget was activated, requesting its
13376 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13377 * @li "popup,willdelete": The web object is ready to destroy the popup
13378 * object created. Event info is a pointer to Elm_Web_Menu
13379 * @li "ready": Page is fully loaded
13380 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13381 * info is a pointer to Eina_Bool where the visibility state should be set
13382 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13383 * is an Eina_Bool with the visibility state set
13384 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13385 * a string with the new text
13386 * @li "statusbar,visible,get": Queries visibility of the status bar.
13387 * Event info is a pointer to Eina_Bool where the visibility state should be
13389 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13390 * an Eina_Bool with the visibility value
13391 * @li "title,changed": Title of the main frame changed. Event info is a
13392 * string with the new title
13393 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13394 * is a pointer to Eina_Bool where the visibility state should be set
13395 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13396 * info is an Eina_Bool with the visibility state
13397 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13398 * a string with the text to show
13399 * @li "uri,changed": URI of the main frame changed. Event info is a string
13401 * @li "view,resized": The web object internal's view changed sized
13402 * @li "windows,close,request": A JavaScript request to close the current
13403 * window was requested
13404 * @li "zoom,animated,end": Animated zoom finished
13406 * available styles:
13409 * An example of use of web:
13411 * - @ref web_example_01 TBD
13420 * Structure used to report load errors.
13422 * Load errors are reported as signal by elm_web. All the strings are
13423 * temporary references and should @b not be used after the signal
13424 * callback returns. If it's required, make copies with strdup() or
13425 * eina_stringshare_add() (they are not even guaranteed to be
13426 * stringshared, so must use eina_stringshare_add() and not
13427 * eina_stringshare_ref()).
13429 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13431 * Structure used to report load errors.
13433 * Load errors are reported as signal by elm_web. All the strings are
13434 * temporary references and should @b not be used after the signal
13435 * callback returns. If it's required, make copies with strdup() or
13436 * eina_stringshare_add() (they are not even guaranteed to be
13437 * stringshared, so must use eina_stringshare_add() and not
13438 * eina_stringshare_ref()).
13440 struct _Elm_Web_Frame_Load_Error
13442 int code; /**< Numeric error code */
13443 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13444 const char *domain; /**< Error domain name */
13445 const char *description; /**< Error description (already localized) */
13446 const char *failing_url; /**< The URL that failed to load */
13447 Evas_Object *frame; /**< Frame object that produced the error */
13451 * The possibles types that the items in a menu can be
13453 typedef enum _Elm_Web_Menu_Item_Type
13455 ELM_WEB_MENU_SEPARATOR,
13456 ELM_WEB_MENU_GROUP,
13457 ELM_WEB_MENU_OPTION
13458 } Elm_Web_Menu_Item_Type;
13461 * Structure describing the items in a menu
13463 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13465 * Structure describing the items in a menu
13467 struct _Elm_Web_Menu_Item
13469 const char *text; /**< The text for the item */
13470 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13474 * Structure describing the menu of a popup
13476 * This structure will be passed as the @c event_info for the "popup,create"
13477 * signal, which is emitted when a dropdown menu is opened. Users wanting
13478 * to handle these popups by themselves should listen to this signal and
13479 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13480 * property as @c EINA_FALSE means that the user will not handle the popup
13481 * and the default implementation will be used.
13483 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13484 * will be emitted to notify the user that it can destroy any objects and
13485 * free all data related to it.
13487 * @see elm_web_popup_selected_set()
13488 * @see elm_web_popup_destroy()
13490 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13492 * Structure describing the menu of a popup
13494 * This structure will be passed as the @c event_info for the "popup,create"
13495 * signal, which is emitted when a dropdown menu is opened. Users wanting
13496 * to handle these popups by themselves should listen to this signal and
13497 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13498 * property as @c EINA_FALSE means that the user will not handle the popup
13499 * and the default implementation will be used.
13501 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13502 * will be emitted to notify the user that it can destroy any objects and
13503 * free all data related to it.
13505 * @see elm_web_popup_selected_set()
13506 * @see elm_web_popup_destroy()
13508 struct _Elm_Web_Menu
13510 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13511 int x; /**< The X position of the popup, relative to the elm_web object */
13512 int y; /**< The Y position of the popup, relative to the elm_web object */
13513 int width; /**< Width of the popup menu */
13514 int height; /**< Height of the popup menu */
13516 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. */
13519 typedef struct _Elm_Web_Download Elm_Web_Download;
13520 struct _Elm_Web_Download
13526 * Types of zoom available.
13528 typedef enum _Elm_Web_Zoom_Mode
13530 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13531 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13532 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13533 ELM_WEB_ZOOM_MODE_LAST
13534 } Elm_Web_Zoom_Mode;
13536 * Opaque handler containing the features (such as statusbar, menubar, etc)
13537 * that are to be set on a newly requested window.
13539 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13541 * Callback type for the create_window hook.
13543 * The function parameters are:
13544 * @li @p data User data pointer set when setting the hook function
13545 * @li @p obj The elm_web object requesting the new window
13546 * @li @p js Set to @c EINA_TRUE if the request was originated from
13547 * JavaScript. @c EINA_FALSE otherwise.
13548 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13549 * the features requested for the new window.
13551 * The returned value of the function should be the @c elm_web widget where
13552 * the request will be loaded. That is, if a new window or tab is created,
13553 * the elm_web widget in it should be returned, and @b NOT the window
13555 * Returning @c NULL should cancel the request.
13557 * @see elm_web_window_create_hook_set()
13559 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13561 * Callback type for the JS alert hook.
13563 * The function parameters are:
13564 * @li @p data User data pointer set when setting the hook function
13565 * @li @p obj The elm_web object requesting the new window
13566 * @li @p message The message to show in the alert dialog
13568 * The function should return the object representing the alert dialog.
13569 * Elm_Web will run a second main loop to handle the dialog and normal
13570 * flow of the application will be restored when the object is deleted, so
13571 * the user should handle the popup properly in order to delete the object
13572 * when the action is finished.
13573 * If the function returns @c NULL the popup will be ignored.
13575 * @see elm_web_dialog_alert_hook_set()
13577 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13579 * Callback type for the JS confirm hook.
13581 * The function parameters are:
13582 * @li @p data User data pointer set when setting the hook function
13583 * @li @p obj The elm_web object requesting the new window
13584 * @li @p message The message to show in the confirm dialog
13585 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13586 * the user selected @c Ok, @c EINA_FALSE otherwise.
13588 * The function should return the object representing the confirm dialog.
13589 * Elm_Web will run a second main loop to handle the dialog and normal
13590 * flow of the application will be restored when the object is deleted, so
13591 * the user should handle the popup properly in order to delete the object
13592 * when the action is finished.
13593 * If the function returns @c NULL the popup will be ignored.
13595 * @see elm_web_dialog_confirm_hook_set()
13597 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13599 * Callback type for the JS prompt hook.
13601 * The function parameters are:
13602 * @li @p data User data pointer set when setting the hook function
13603 * @li @p obj The elm_web object requesting the new window
13604 * @li @p message The message to show in the prompt dialog
13605 * @li @p def_value The default value to present the user in the entry
13606 * @li @p value Pointer where to store the value given by the user. Must
13607 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13608 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13609 * the user selected @c Ok, @c EINA_FALSE otherwise.
13611 * The function should return the object representing the prompt dialog.
13612 * Elm_Web will run a second main loop to handle the dialog and normal
13613 * flow of the application will be restored when the object is deleted, so
13614 * the user should handle the popup properly in order to delete the object
13615 * when the action is finished.
13616 * If the function returns @c NULL the popup will be ignored.
13618 * @see elm_web_dialog_prompt_hook_set()
13620 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13622 * Callback type for the JS file selector hook.
13624 * The function parameters are:
13625 * @li @p data User data pointer set when setting the hook function
13626 * @li @p obj The elm_web object requesting the new window
13627 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13628 * @li @p accept_types Mime types accepted
13629 * @li @p selected Pointer where to store the list of malloc'ed strings
13630 * containing the path to each file selected. Must be @c NULL if the file
13631 * dialog is cancelled
13632 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13633 * the user selected @c Ok, @c EINA_FALSE otherwise.
13635 * The function should return the object representing the file selector
13637 * Elm_Web will run a second main loop to handle the dialog and normal
13638 * flow of the application will be restored when the object is deleted, so
13639 * the user should handle the popup properly in order to delete the object
13640 * when the action is finished.
13641 * If the function returns @c NULL the popup will be ignored.
13643 * @see elm_web_dialog_file selector_hook_set()
13645 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);
13647 * Callback type for the JS console message hook.
13649 * When a console message is added from JavaScript, any set function to the
13650 * console message hook will be called for the user to handle. There is no
13651 * default implementation of this hook.
13653 * The function parameters are:
13654 * @li @p data User data pointer set when setting the hook function
13655 * @li @p obj The elm_web object that originated the message
13656 * @li @p message The message sent
13657 * @li @p line_number The line number
13658 * @li @p source_id Source id
13660 * @see elm_web_console_message_hook_set()
13662 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13664 * Add a new web object to the parent.
13666 * @param parent The parent object.
13667 * @return The new object or NULL if it cannot be created.
13669 * @see elm_web_uri_set()
13670 * @see elm_web_webkit_view_get()
13672 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13675 * Get internal ewk_view object from web object.
13677 * Elementary may not provide some low level features of EWebKit,
13678 * instead of cluttering the API with proxy methods we opted to
13679 * return the internal reference. Be careful using it as it may
13680 * interfere with elm_web behavior.
13682 * @param obj The web object.
13683 * @return The internal ewk_view object or NULL if it does not
13684 * exist. (Failure to create or Elementary compiled without
13687 * @see elm_web_add()
13689 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13692 * Sets the function to call when a new window is requested
13694 * This hook will be called when a request to create a new window is
13695 * issued from the web page loaded.
13696 * There is no default implementation for this feature, so leaving this
13697 * unset or passing @c NULL in @p func will prevent new windows from
13700 * @param obj The web object where to set the hook function
13701 * @param func The hook function to be called when a window is requested
13702 * @param data User data
13704 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13706 * Sets the function to call when an alert dialog
13708 * This hook will be called when a JavaScript alert dialog is requested.
13709 * If no function is set or @c NULL is passed in @p func, the default
13710 * implementation will take place.
13712 * @param obj The web object where to set the hook function
13713 * @param func The callback function to be used
13714 * @param data User data
13716 * @see elm_web_inwin_mode_set()
13718 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13720 * Sets the function to call when an confirm dialog
13722 * This hook will be called when a JavaScript confirm dialog is requested.
13723 * If no function is set or @c NULL is passed in @p func, the default
13724 * implementation will take place.
13726 * @param obj The web object where to set the hook function
13727 * @param func The callback function to be used
13728 * @param data User data
13730 * @see elm_web_inwin_mode_set()
13732 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13734 * Sets the function to call when an prompt dialog
13736 * This hook will be called when a JavaScript prompt dialog is requested.
13737 * If no function is set or @c NULL is passed in @p func, the default
13738 * implementation will take place.
13740 * @param obj The web object where to set the hook function
13741 * @param func The callback function to be used
13742 * @param data User data
13744 * @see elm_web_inwin_mode_set()
13746 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13748 * Sets the function to call when an file selector dialog
13750 * This hook will be called when a JavaScript file selector dialog is
13752 * If no function is set or @c NULL is passed in @p func, the default
13753 * implementation will take place.
13755 * @param obj The web object where to set the hook function
13756 * @param func The callback function to be used
13757 * @param data User data
13759 * @see elm_web_inwin_mode_set()
13761 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13763 * Sets the function to call when a console message is emitted from JS
13765 * This hook will be called when a console message is emitted from
13766 * JavaScript. There is no default implementation for this feature.
13768 * @param obj The web object where to set the hook function
13769 * @param func The callback function to be used
13770 * @param data User data
13772 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13774 * Gets the status of the tab propagation
13776 * @param obj The web object to query
13777 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13779 * @see elm_web_tab_propagate_set()
13781 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13783 * Sets whether to use tab propagation
13785 * If tab propagation is enabled, whenever the user presses the Tab key,
13786 * Elementary will handle it and switch focus to the next widget.
13787 * The default value is disabled, where WebKit will handle the Tab key to
13788 * cycle focus though its internal objects, jumping to the next widget
13789 * only when that cycle ends.
13791 * @param obj The web object
13792 * @param propagate Whether to propagate Tab keys to Elementary or not
13794 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13796 * Sets the URI for the web object
13798 * It must be a full URI, with resource included, in the form
13799 * http://www.enlightenment.org or file:///tmp/something.html
13801 * @param obj The web object
13802 * @param uri The URI to set
13803 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13805 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13807 * Gets the current URI for the object
13809 * The returned string must not be freed and is guaranteed to be
13812 * @param obj The web object
13813 * @return A stringshared internal string with the current URI, or NULL on
13816 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13818 * Gets the current title
13820 * The returned string must not be freed and is guaranteed to be
13823 * @param obj The web object
13824 * @return A stringshared internal string with the current title, or NULL on
13827 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13829 * Sets the background color to be used by the web object
13831 * This is the color that will be used by default when the loaded page
13832 * does not set it's own. Color values are pre-multiplied.
13834 * @param obj The web object
13835 * @param r Red component
13836 * @param g Green component
13837 * @param b Blue component
13838 * @param a Alpha component
13840 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13842 * Gets the background color to be used by the web object
13844 * This is the color that will be used by default when the loaded page
13845 * does not set it's own. Color values are pre-multiplied.
13847 * @param obj The web object
13848 * @param r Red component
13849 * @param g Green component
13850 * @param b Blue component
13851 * @param a Alpha component
13853 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13855 * Gets a copy of the currently selected text
13857 * The string returned must be freed by the user when it's done with it.
13859 * @param obj The web object
13860 * @return A newly allocated string, or NULL if nothing is selected or an
13863 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13865 * Tells the web object which index in the currently open popup was selected
13867 * When the user handles the popup creation from the "popup,created" signal,
13868 * it needs to tell the web object which item was selected by calling this
13869 * function with the index corresponding to the item.
13871 * @param obj The web object
13872 * @param index The index selected
13874 * @see elm_web_popup_destroy()
13876 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13878 * Dismisses an open dropdown popup
13880 * When the popup from a dropdown widget is to be dismissed, either after
13881 * selecting an option or to cancel it, this function must be called, which
13882 * will later emit an "popup,willdelete" signal to notify the user that
13883 * any memory and objects related to this popup can be freed.
13885 * @param obj The web object
13886 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13887 * if there was no menu to destroy
13889 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13891 * Searches the given string in a document.
13893 * @param obj The web object where to search the text
13894 * @param string String to search
13895 * @param case_sensitive If search should be case sensitive or not
13896 * @param forward If search is from cursor and on or backwards
13897 * @param wrap If search should wrap at the end
13899 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13902 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13904 * Marks matches of the given string in a document.
13906 * @param obj The web object where to search text
13907 * @param string String to match
13908 * @param case_sensitive If match should be case sensitive or not
13909 * @param highlight If matches should be highlighted
13910 * @param limit Maximum amount of matches, or zero to unlimited
13912 * @return number of matched @a string
13914 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13916 * Clears all marked matches in the document
13918 * @param obj The web object
13920 * @return EINA_TRUE on success, EINA_FALSE otherwise
13922 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13924 * Sets whether to highlight the matched marks
13926 * If enabled, marks set with elm_web_text_matches_mark() will be
13929 * @param obj The web object
13930 * @param highlight Whether to highlight the marks or not
13932 * @return EINA_TRUE on success, EINA_FALSE otherwise
13934 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13936 * Gets whether highlighting marks is enabled
13938 * @param The web object
13940 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13943 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13945 * Gets the overall loading progress of the page
13947 * Returns the estimated loading progress of the page, with a value between
13948 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13949 * included in the page.
13951 * @param The web object
13953 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13956 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13958 * Stops loading the current page
13960 * Cancels the loading of the current page in the web object. This will
13961 * cause a "load,error" signal to be emitted, with the is_cancellation
13962 * flag set to EINA_TRUE.
13964 * @param obj The web object
13966 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13968 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13970 * Requests a reload of the current document in the object
13972 * @param obj The web object
13974 * @return EINA_TRUE on success, EINA_FALSE otherwise
13976 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13978 * Requests a reload of the current document, avoiding any existing caches
13980 * @param obj The web object
13982 * @return EINA_TRUE on success, EINA_FALSE otherwise
13984 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13986 * Goes back one step in the browsing history
13988 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13990 * @param obj The web object
13992 * @return EINA_TRUE on success, EINA_FALSE otherwise
13994 * @see elm_web_history_enable_set()
13995 * @see elm_web_back_possible()
13996 * @see elm_web_forward()
13997 * @see elm_web_navigate()
13999 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14001 * Goes forward one step in the browsing history
14003 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14005 * @param obj The web object
14007 * @return EINA_TRUE on success, EINA_FALSE otherwise
14009 * @see elm_web_history_enable_set()
14010 * @see elm_web_forward_possible()
14011 * @see elm_web_back()
14012 * @see elm_web_navigate()
14014 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14016 * Jumps the given number of steps in the browsing history
14018 * The @p steps value can be a negative integer to back in history, or a
14019 * positive to move forward.
14021 * @param obj The web object
14022 * @param steps The number of steps to jump
14024 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14025 * history exists to jump the given number of steps
14027 * @see elm_web_history_enable_set()
14028 * @see elm_web_navigate_possible()
14029 * @see elm_web_back()
14030 * @see elm_web_forward()
14032 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14034 * Queries whether it's possible to go back in history
14036 * @param obj The web object
14038 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14041 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14043 * Queries whether it's possible to go forward in history
14045 * @param obj The web object
14047 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14050 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14052 * Queries whether it's possible to jump the given number of steps
14054 * The @p steps value can be a negative integer to back in history, or a
14055 * positive to move forward.
14057 * @param obj The web object
14058 * @param steps The number of steps to check for
14060 * @return EINA_TRUE if enough history exists to perform the given jump,
14061 * EINA_FALSE otherwise
14063 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14065 * Gets whether browsing history is enabled for the given object
14067 * @param obj The web object
14069 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14071 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14073 * Enables or disables the browsing history
14075 * @param obj The web object
14076 * @param enable Whether to enable or disable the browsing history
14078 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14080 * Sets the zoom level of the web object
14082 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14083 * values meaning zoom in and lower meaning zoom out. This function will
14084 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14085 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14087 * @param obj The web object
14088 * @param zoom The zoom level to set
14090 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14092 * Gets the current zoom level set on the web object
14094 * Note that this is the zoom level set on the web object and not that
14095 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14096 * the two zoom levels should match, but for the other two modes the
14097 * Webkit zoom is calculated internally to match the chosen mode without
14098 * changing the zoom level set for the web object.
14100 * @param obj The web object
14102 * @return The zoom level set on the object
14104 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14106 * Sets the zoom mode to use
14108 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14109 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14111 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14112 * with the elm_web_zoom_set() function.
14113 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14114 * make sure the entirety of the web object's contents are shown.
14115 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14116 * fit the contents in the web object's size, without leaving any space
14119 * @param obj The web object
14120 * @param mode The mode to set
14122 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14124 * Gets the currently set zoom mode
14126 * @param obj The web object
14128 * @return The current zoom mode set for the object, or
14129 * ::ELM_WEB_ZOOM_MODE_LAST on error
14131 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14133 * Shows the given region in the web object
14135 * @param obj The web object
14136 * @param x The x coordinate of the region to show
14137 * @param y The y coordinate of the region to show
14138 * @param w The width of the region to show
14139 * @param h The height of the region to show
14141 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14143 * Brings in the region to the visible area
14145 * Like elm_web_region_show(), but it animates the scrolling of the object
14148 * @param obj The web object
14149 * @param x The x coordinate of the region to show
14150 * @param y The y coordinate of the region to show
14151 * @param w The width of the region to show
14152 * @param h The height of the region to show
14154 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14156 * Sets the default dialogs to use an Inwin instead of a normal window
14158 * If set, then the default implementation for the JavaScript dialogs and
14159 * file selector will be opened in an Inwin. Otherwise they will use a
14160 * normal separated window.
14162 * @param obj The web object
14163 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14165 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14167 * Gets whether Inwin mode is set for the current object
14169 * @param obj The web object
14171 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14173 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14175 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14176 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14177 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);
14178 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14185 * @defgroup Hoversel Hoversel
14187 * @image html img/widget/hoversel/preview-00.png
14188 * @image latex img/widget/hoversel/preview-00.eps
14190 * A hoversel is a button that pops up a list of items (automatically
14191 * choosing the direction to display) that have a label and, optionally, an
14192 * icon to select from. It is a convenience widget to avoid the need to do
14193 * all the piecing together yourself. It is intended for a small number of
14194 * items in the hoversel menu (no more than 8), though is capable of many
14197 * Signals that you can add callbacks for are:
14198 * "clicked" - the user clicked the hoversel button and popped up the sel
14199 * "selected" - an item in the hoversel list is selected. event_info is the item
14200 * "dismissed" - the hover is dismissed
14202 * See @ref tutorial_hoversel for an example.
14205 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14207 * @brief Add a new Hoversel object
14209 * @param parent The parent object
14210 * @return The new object or NULL if it cannot be created
14212 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14214 * @brief This sets the hoversel to expand horizontally.
14216 * @param obj The hoversel object
14217 * @param horizontal If true, the hover will expand horizontally to the
14220 * @note The initial button will display horizontally regardless of this
14223 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14225 * @brief This returns whether the hoversel is set to expand horizontally.
14227 * @param obj The hoversel object
14228 * @return If true, the hover will expand horizontally to the right.
14230 * @see elm_hoversel_horizontal_set()
14232 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14234 * @brief Set the Hover parent
14236 * @param obj The hoversel object
14237 * @param parent The parent to use
14239 * Sets the hover parent object, the area that will be darkened when the
14240 * hoversel is clicked. Should probably be the window that the hoversel is
14241 * in. See @ref Hover objects for more information.
14243 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14245 * @brief Get the Hover parent
14247 * @param obj The hoversel object
14248 * @return The used parent
14250 * Gets the hover parent object.
14252 * @see elm_hoversel_hover_parent_set()
14254 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14256 * @brief Set the hoversel button label
14258 * @param obj The hoversel object
14259 * @param label The label text.
14261 * This sets the label of the button that is always visible (before it is
14262 * clicked and expanded).
14264 * @deprecated elm_object_text_set()
14266 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14268 * @brief Get the hoversel button label
14270 * @param obj The hoversel object
14271 * @return The label text.
14273 * @deprecated elm_object_text_get()
14275 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14277 * @brief Set the icon of the hoversel button
14279 * @param obj The hoversel object
14280 * @param icon The icon object
14282 * Sets the icon of the button that is always visible (before it is clicked
14283 * and expanded). Once the icon object is set, a previously set one will be
14284 * deleted, if you want to keep that old content object, use the
14285 * elm_hoversel_icon_unset() function.
14287 * @see elm_object_content_set() for the button widget
14289 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14291 * @brief Get the icon of the hoversel button
14293 * @param obj The hoversel object
14294 * @return The icon object
14296 * Get the icon of the button that is always visible (before it is clicked
14297 * and expanded). Also see elm_object_content_get() for the button widget.
14299 * @see elm_hoversel_icon_set()
14301 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14303 * @brief Get and unparent the icon of the hoversel button
14305 * @param obj The hoversel object
14306 * @return The icon object that was being used
14308 * Unparent and return the icon of the button that is always visible
14309 * (before it is clicked and expanded).
14311 * @see elm_hoversel_icon_set()
14312 * @see elm_object_content_unset() for the button widget
14314 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14316 * @brief This triggers the hoversel popup from code, the same as if the user
14317 * had clicked the button.
14319 * @param obj The hoversel object
14321 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14323 * @brief This dismisses the hoversel popup as if the user had clicked
14324 * outside the hover.
14326 * @param obj The hoversel object
14328 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14330 * @brief Returns whether the hoversel is expanded.
14332 * @param obj The hoversel object
14333 * @return This will return EINA_TRUE if the hoversel is expanded or
14334 * EINA_FALSE if it is not expanded.
14336 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14338 * @brief This will remove all the children items from the hoversel.
14340 * @param obj The hoversel object
14342 * @warning Should @b not be called while the hoversel is active; use
14343 * elm_hoversel_expanded_get() to check first.
14345 * @see elm_hoversel_item_del_cb_set()
14346 * @see elm_hoversel_item_del()
14348 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14350 * @brief Get the list of items within the given hoversel.
14352 * @param obj The hoversel object
14353 * @return Returns a list of Elm_Hoversel_Item*
14355 * @see elm_hoversel_item_add()
14357 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14359 * @brief Add an item to the hoversel button
14361 * @param obj The hoversel object
14362 * @param label The text label to use for the item (NULL if not desired)
14363 * @param icon_file An image file path on disk to use for the icon or standard
14364 * icon name (NULL if not desired)
14365 * @param icon_type The icon type if relevant
14366 * @param func Convenience function to call when this item is selected
14367 * @param data Data to pass to item-related functions
14368 * @return A handle to the item added.
14370 * This adds an item to the hoversel to show when it is clicked. Note: if you
14371 * need to use an icon from an edje file then use
14372 * elm_hoversel_item_icon_set() right after the this function, and set
14373 * icon_file to NULL here.
14375 * For more information on what @p icon_file and @p icon_type are see the
14376 * @ref Icon "icon documentation".
14378 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);
14380 * @brief Delete an item from the hoversel
14382 * @param item The item to delete
14384 * This deletes the item from the hoversel (should not be called while the
14385 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14387 * @see elm_hoversel_item_add()
14388 * @see elm_hoversel_item_del_cb_set()
14390 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14392 * @brief Set the function to be called when an item from the hoversel is
14395 * @param item The item to set the callback on
14396 * @param func The function called
14398 * That function will receive these parameters:
14399 * @li void *item_data
14400 * @li Evas_Object *the_item_object
14401 * @li Elm_Hoversel_Item *the_object_struct
14403 * @see elm_hoversel_item_add()
14405 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14407 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14408 * that will be passed to associated function callbacks.
14410 * @param item The item to get the data from
14411 * @return The data pointer set with elm_hoversel_item_add()
14413 * @see elm_hoversel_item_add()
14415 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14417 * @brief This returns the label text of the given hoversel item.
14419 * @param item The item to get the label
14420 * @return The label text of the hoversel item
14422 * @see elm_hoversel_item_add()
14424 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14426 * @brief This sets the icon for the given hoversel item.
14428 * @param item The item to set the icon
14429 * @param icon_file An image file path on disk to use for the icon or standard
14431 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14432 * to NULL if the icon is not an edje file
14433 * @param icon_type The icon type
14435 * The icon can be loaded from the standard set, from an image file, or from
14438 * @see elm_hoversel_item_add()
14440 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);
14442 * @brief Get the icon object of the hoversel item
14444 * @param item The item to get the icon from
14445 * @param icon_file The image file path on disk used for the icon or standard
14447 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14448 * if the icon is not an edje file
14449 * @param icon_type The icon type
14451 * @see elm_hoversel_item_icon_set()
14452 * @see elm_hoversel_item_add()
14454 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);
14460 * @defgroup Toolbar Toolbar
14461 * @ingroup Elementary
14463 * @image html img/widget/toolbar/preview-00.png
14464 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14466 * @image html img/toolbar.png
14467 * @image latex img/toolbar.eps width=\textwidth
14469 * A toolbar is a widget that displays a list of items inside
14470 * a box. It can be scrollable, show a menu with items that don't fit
14471 * to toolbar size or even crop them.
14473 * Only one item can be selected at a time.
14475 * Items can have multiple states, or show menus when selected by the user.
14477 * Smart callbacks one can listen to:
14478 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14479 * - "language,changed" - when the program language changes
14481 * Available styles for it:
14483 * - @c "transparent" - no background or shadow, just show the content
14485 * List of examples:
14486 * @li @ref toolbar_example_01
14487 * @li @ref toolbar_example_02
14488 * @li @ref toolbar_example_03
14492 * @addtogroup Toolbar
14497 * @enum _Elm_Toolbar_Shrink_Mode
14498 * @typedef Elm_Toolbar_Shrink_Mode
14500 * Set toolbar's items display behavior, it can be scrollabel,
14501 * show a menu with exceeding items, or simply hide them.
14503 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14506 * Values <b> don't </b> work as bitmask, only one can be choosen.
14508 * @see elm_toolbar_mode_shrink_set()
14509 * @see elm_toolbar_mode_shrink_get()
14513 typedef enum _Elm_Toolbar_Shrink_Mode
14515 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14516 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14517 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14518 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14519 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14520 } Elm_Toolbar_Shrink_Mode;
14522 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(). */
14524 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(). */
14527 * Add a new toolbar widget to the given parent Elementary
14528 * (container) object.
14530 * @param parent The parent object.
14531 * @return a new toolbar widget handle or @c NULL, on errors.
14533 * This function inserts a new toolbar widget on the canvas.
14537 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14540 * Set the icon size, in pixels, to be used by toolbar items.
14542 * @param obj The toolbar object
14543 * @param icon_size The icon size in pixels
14545 * @note Default value is @c 32. It reads value from elm config.
14547 * @see elm_toolbar_icon_size_get()
14551 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14554 * Get the icon size, in pixels, to be used by toolbar items.
14556 * @param obj The toolbar object.
14557 * @return The icon size in pixels.
14559 * @see elm_toolbar_icon_size_set() for details.
14563 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14566 * Sets icon lookup order, for toolbar items' icons.
14568 * @param obj The toolbar object.
14569 * @param order The icon lookup order.
14571 * Icons added before calling this function will not be affected.
14572 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14574 * @see elm_toolbar_icon_order_lookup_get()
14578 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14581 * Gets the icon lookup order.
14583 * @param obj The toolbar object.
14584 * @return The icon lookup order.
14586 * @see elm_toolbar_icon_order_lookup_set() for details.
14590 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14593 * Set whether the toolbar should always have an item selected.
14595 * @param obj The toolbar object.
14596 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14599 * This will cause the toolbar to always have an item selected, and clicking
14600 * the selected item will not cause a selected event to be emitted. Enabling this mode
14601 * will immediately select the first toolbar item.
14603 * Always-selected is disabled by default.
14605 * @see elm_toolbar_always_select_mode_get().
14609 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14612 * Get whether the toolbar should always have an item selected.
14614 * @param obj The toolbar object.
14615 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14616 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14618 * @see elm_toolbar_always_select_mode_set() for details.
14622 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14625 * Set whether the toolbar items' should be selected by the user or not.
14627 * @param obj The toolbar object.
14628 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14631 * This will turn off the ability to select items entirely and they will
14632 * neither appear selected nor emit selected signals. The clicked
14633 * callback function will still be called.
14635 * Selection is enabled by default.
14637 * @see elm_toolbar_no_select_mode_get().
14641 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14644 * Set whether the toolbar items' should be selected by the user or not.
14646 * @param obj The toolbar object.
14647 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14648 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14650 * @see elm_toolbar_no_select_mode_set() for details.
14654 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14657 * Append item to the toolbar.
14659 * @param obj The toolbar object.
14660 * @param icon A string with icon name or the absolute path of an image file.
14661 * @param label The label of the item.
14662 * @param func The function to call when the item is clicked.
14663 * @param data The data to associate with the item for related callbacks.
14664 * @return The created item or @c NULL upon failure.
14666 * A new item will be created and appended to the toolbar, i.e., will
14667 * be set as @b last item.
14669 * Items created with this method can be deleted with
14670 * elm_toolbar_item_del().
14672 * Associated @p data can be properly freed when item is deleted if a
14673 * callback function is set with elm_toolbar_item_del_cb_set().
14675 * If a function is passed as argument, it will be called everytime this item
14676 * is selected, i.e., the user clicks over an unselected item.
14677 * If such function isn't needed, just passing
14678 * @c NULL as @p func is enough. The same should be done for @p data.
14680 * Toolbar will load icon image from fdo or current theme.
14681 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14682 * If an absolute path is provided it will load it direct from a file.
14684 * @see elm_toolbar_item_icon_set()
14685 * @see elm_toolbar_item_del()
14686 * @see elm_toolbar_item_del_cb_set()
14690 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);
14693 * Prepend item to the toolbar.
14695 * @param obj The toolbar object.
14696 * @param icon A string with icon name or the absolute path of an image file.
14697 * @param label The label of the item.
14698 * @param func The function to call when the item is clicked.
14699 * @param data The data to associate with the item for related callbacks.
14700 * @return The created item or @c NULL upon failure.
14702 * A new item will be created and prepended to the toolbar, i.e., will
14703 * be set as @b first item.
14705 * Items created with this method can be deleted with
14706 * elm_toolbar_item_del().
14708 * Associated @p data can be properly freed when item is deleted if a
14709 * callback function is set with elm_toolbar_item_del_cb_set().
14711 * If a function is passed as argument, it will be called everytime this item
14712 * is selected, i.e., the user clicks over an unselected item.
14713 * If such function isn't needed, just passing
14714 * @c NULL as @p func is enough. The same should be done for @p data.
14716 * Toolbar will load icon image from fdo or current theme.
14717 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14718 * If an absolute path is provided it will load it direct from a file.
14720 * @see elm_toolbar_item_icon_set()
14721 * @see elm_toolbar_item_del()
14722 * @see elm_toolbar_item_del_cb_set()
14726 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);
14729 * Insert a new item into the toolbar object before item @p before.
14731 * @param obj The toolbar object.
14732 * @param before The toolbar item to insert before.
14733 * @param icon A string with icon name or the absolute path of an image file.
14734 * @param label The label of the item.
14735 * @param func The function to call when the item is clicked.
14736 * @param data The data to associate with the item for related callbacks.
14737 * @return The created item or @c NULL upon failure.
14739 * A new item will be created and added to the toolbar. Its position in
14740 * this toolbar will be just before item @p before.
14742 * Items created with this method can be deleted with
14743 * elm_toolbar_item_del().
14745 * Associated @p data can be properly freed when item is deleted if a
14746 * callback function is set with elm_toolbar_item_del_cb_set().
14748 * If a function is passed as argument, it will be called everytime this item
14749 * is selected, i.e., the user clicks over an unselected item.
14750 * If such function isn't needed, just passing
14751 * @c NULL as @p func is enough. The same should be done for @p data.
14753 * Toolbar will load icon image from fdo or current theme.
14754 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14755 * If an absolute path is provided it will load it direct from a file.
14757 * @see elm_toolbar_item_icon_set()
14758 * @see elm_toolbar_item_del()
14759 * @see elm_toolbar_item_del_cb_set()
14763 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);
14766 * Insert a new item into the toolbar object after item @p after.
14768 * @param obj The toolbar object.
14769 * @param after The toolbar item to insert after.
14770 * @param icon A string with icon name or the absolute path of an image file.
14771 * @param label The label of the item.
14772 * @param func The function to call when the item is clicked.
14773 * @param data The data to associate with the item for related callbacks.
14774 * @return The created item or @c NULL upon failure.
14776 * A new item will be created and added to the toolbar. Its position in
14777 * this toolbar will be just after item @p after.
14779 * Items created with this method can be deleted with
14780 * elm_toolbar_item_del().
14782 * Associated @p data can be properly freed when item is deleted if a
14783 * callback function is set with elm_toolbar_item_del_cb_set().
14785 * If a function is passed as argument, it will be called everytime this item
14786 * is selected, i.e., the user clicks over an unselected item.
14787 * If such function isn't needed, just passing
14788 * @c NULL as @p func is enough. The same should be done for @p data.
14790 * Toolbar will load icon image from fdo or current theme.
14791 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14792 * If an absolute path is provided it will load it direct from a file.
14794 * @see elm_toolbar_item_icon_set()
14795 * @see elm_toolbar_item_del()
14796 * @see elm_toolbar_item_del_cb_set()
14800 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);
14803 * Get the first item in the given toolbar widget's list of
14806 * @param obj The toolbar object
14807 * @return The first item or @c NULL, if it has no items (and on
14810 * @see elm_toolbar_item_append()
14811 * @see elm_toolbar_last_item_get()
14815 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14818 * Get the last item in the given toolbar widget's list of
14821 * @param obj The toolbar object
14822 * @return The last item or @c NULL, if it has no items (and on
14825 * @see elm_toolbar_item_prepend()
14826 * @see elm_toolbar_first_item_get()
14830 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14833 * Get the item after @p item in toolbar.
14835 * @param item The toolbar item.
14836 * @return The item after @p item, or @c NULL if none or on failure.
14838 * @note If it is the last item, @c NULL will be returned.
14840 * @see elm_toolbar_item_append()
14844 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14847 * Get the item before @p item in toolbar.
14849 * @param item The toolbar item.
14850 * @return The item before @p item, or @c NULL if none or on failure.
14852 * @note If it is the first item, @c NULL will be returned.
14854 * @see elm_toolbar_item_prepend()
14858 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14861 * Get the toolbar object from an item.
14863 * @param item The item.
14864 * @return The toolbar object.
14866 * This returns the toolbar object itself that an item belongs to.
14870 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14873 * Set the priority of a toolbar item.
14875 * @param item The toolbar item.
14876 * @param priority The item priority. The default is zero.
14878 * This is used only when the toolbar shrink mode is set to
14879 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14880 * When space is less than required, items with low priority
14881 * will be removed from the toolbar and added to a dynamically-created menu,
14882 * while items with higher priority will remain on the toolbar,
14883 * with the same order they were added.
14885 * @see elm_toolbar_item_priority_get()
14889 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14892 * Get the priority of a toolbar item.
14894 * @param item The toolbar item.
14895 * @return The @p item priority, or @c 0 on failure.
14897 * @see elm_toolbar_item_priority_set() for details.
14901 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14904 * Get the label of item.
14906 * @param item The item of toolbar.
14907 * @return The label of item.
14909 * The return value is a pointer to the label associated to @p item when
14910 * it was created, with function elm_toolbar_item_append() or similar,
14912 * with function elm_toolbar_item_label_set. If no label
14913 * was passed as argument, it will return @c NULL.
14915 * @see elm_toolbar_item_label_set() for more details.
14916 * @see elm_toolbar_item_append()
14920 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14923 * Set the label of item.
14925 * @param item The item of toolbar.
14926 * @param text The label of item.
14928 * The label to be displayed by the item.
14929 * Label will be placed at icons bottom (if set).
14931 * If a label was passed as argument on item creation, with function
14932 * elm_toolbar_item_append() or similar, it will be already
14933 * displayed by the item.
14935 * @see elm_toolbar_item_label_get()
14936 * @see elm_toolbar_item_append()
14940 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14943 * Return the data associated with a given toolbar widget item.
14945 * @param item The toolbar widget item handle.
14946 * @return The data associated with @p item.
14948 * @see elm_toolbar_item_data_set()
14952 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14955 * Set the data associated with a given toolbar widget item.
14957 * @param item The toolbar widget item handle.
14958 * @param data The new data pointer to set to @p item.
14960 * This sets new item data on @p item.
14962 * @warning The old data pointer won't be touched by this function, so
14963 * the user had better to free that old data himself/herself.
14967 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14970 * Returns a pointer to a toolbar item by its label.
14972 * @param obj The toolbar object.
14973 * @param label The label of the item to find.
14975 * @return The pointer to the toolbar item matching @p label or @c NULL
14980 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14983 * Get whether the @p item is selected or not.
14985 * @param item The toolbar item.
14986 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14987 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14989 * @see elm_toolbar_selected_item_set() for details.
14990 * @see elm_toolbar_item_selected_get()
14994 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14997 * Set the selected state of an item.
14999 * @param item The toolbar item
15000 * @param selected The selected state
15002 * This sets the selected state of the given item @p it.
15003 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15005 * If a new item is selected the previosly selected will be unselected.
15006 * Previoulsy selected item can be get with function
15007 * elm_toolbar_selected_item_get().
15009 * Selected items will be highlighted.
15011 * @see elm_toolbar_item_selected_get()
15012 * @see elm_toolbar_selected_item_get()
15016 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15019 * Get the selected item.
15021 * @param obj The toolbar object.
15022 * @return The selected toolbar item.
15024 * The selected item can be unselected with function
15025 * elm_toolbar_item_selected_set().
15027 * The selected item always will be highlighted on toolbar.
15029 * @see elm_toolbar_selected_items_get()
15033 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15036 * Set the icon associated with @p item.
15038 * @param obj The parent of this item.
15039 * @param item The toolbar item.
15040 * @param icon A string with icon name or the absolute path of an image file.
15042 * Toolbar will load icon image from fdo or current theme.
15043 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15044 * If an absolute path is provided it will load it direct from a file.
15046 * @see elm_toolbar_icon_order_lookup_set()
15047 * @see elm_toolbar_icon_order_lookup_get()
15051 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15054 * Get the string used to set the icon of @p item.
15056 * @param item The toolbar item.
15057 * @return The string associated with the icon object.
15059 * @see elm_toolbar_item_icon_set() for details.
15063 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15066 * Get the object of @p item.
15068 * @param item The toolbar item.
15069 * @return The object
15073 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15076 * Get the icon object of @p item.
15078 * @param item The toolbar item.
15079 * @return The icon object
15081 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15085 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15088 * Set the icon associated with @p item to an image in a binary buffer.
15090 * @param item The toolbar item.
15091 * @param img The binary data that will be used as an image
15092 * @param size The size of binary data @p img
15093 * @param format Optional format of @p img to pass to the image loader
15094 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15096 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15098 * @note The icon image set by this function can be changed by
15099 * elm_toolbar_item_icon_set().
15103 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);
15106 * Delete them item from the toolbar.
15108 * @param item The item of toolbar to be deleted.
15110 * @see elm_toolbar_item_append()
15111 * @see elm_toolbar_item_del_cb_set()
15115 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15118 * Set the function called when a toolbar item is freed.
15120 * @param item The item to set the callback on.
15121 * @param func The function called.
15123 * If there is a @p func, then it will be called prior item's memory release.
15124 * That will be called with the following arguments:
15126 * @li item's Evas object;
15129 * This way, a data associated to a toolbar item could be properly freed.
15133 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15136 * Get a value whether toolbar item is disabled or not.
15138 * @param item The item.
15139 * @return The disabled state.
15141 * @see elm_toolbar_item_disabled_set() for more details.
15145 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15148 * Sets the disabled/enabled state of a toolbar item.
15150 * @param item The item.
15151 * @param disabled The disabled state.
15153 * A disabled item cannot be selected or unselected. It will also
15154 * change its appearance (generally greyed out). This sets the
15155 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15160 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15163 * Set or unset item as a separator.
15165 * @param item The toolbar item.
15166 * @param setting @c EINA_TRUE to set item @p item as separator or
15167 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15169 * Items aren't set as separator by default.
15171 * If set as separator it will display separator theme, so won't display
15174 * @see elm_toolbar_item_separator_get()
15178 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15181 * Get a value whether item is a separator or not.
15183 * @param item The toolbar item.
15184 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15185 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15187 * @see elm_toolbar_item_separator_set() for details.
15191 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15194 * Set the shrink state of toolbar @p obj.
15196 * @param obj The toolbar object.
15197 * @param shrink_mode Toolbar's items display behavior.
15199 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15200 * but will enforce a minimun size so all the items will fit, won't scroll
15201 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15202 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15203 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15207 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15210 * Get the shrink mode of toolbar @p obj.
15212 * @param obj The toolbar object.
15213 * @return Toolbar's items display behavior.
15215 * @see elm_toolbar_mode_shrink_set() for details.
15219 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15222 * Enable/disable homogenous mode.
15224 * @param obj The toolbar object
15225 * @param homogeneous Assume the items within the toolbar are of the
15226 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15228 * This will enable the homogeneous mode where items are of the same size.
15229 * @see elm_toolbar_homogeneous_get()
15233 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15236 * Get whether the homogenous mode is enabled.
15238 * @param obj The toolbar object.
15239 * @return Assume the items within the toolbar are of the same height
15240 * and width (EINA_TRUE = on, EINA_FALSE = off).
15242 * @see elm_toolbar_homogeneous_set()
15246 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15249 * Enable/disable homogenous mode.
15251 * @param obj The toolbar object
15252 * @param homogeneous Assume the items within the toolbar are of the
15253 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15255 * This will enable the homogeneous mode where items are of the same size.
15256 * @see elm_toolbar_homogeneous_get()
15258 * @deprecated use elm_toolbar_homogeneous_set() instead.
15262 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15265 * Get whether the homogenous mode is enabled.
15267 * @param obj The toolbar object.
15268 * @return Assume the items within the toolbar are of the same height
15269 * and width (EINA_TRUE = on, EINA_FALSE = off).
15271 * @see elm_toolbar_homogeneous_set()
15272 * @deprecated use elm_toolbar_homogeneous_get() instead.
15276 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15279 * Set the parent object of the toolbar items' menus.
15281 * @param obj The toolbar object.
15282 * @param parent The parent of the menu objects.
15284 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15286 * For more details about setting the parent for toolbar menus, see
15287 * elm_menu_parent_set().
15289 * @see elm_menu_parent_set() for details.
15290 * @see elm_toolbar_item_menu_set() for details.
15294 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15297 * Get the parent object of the toolbar items' menus.
15299 * @param obj The toolbar object.
15300 * @return The parent of the menu objects.
15302 * @see elm_toolbar_menu_parent_set() for details.
15306 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15309 * Set the alignment of the items.
15311 * @param obj The toolbar object.
15312 * @param align The new alignment, a float between <tt> 0.0 </tt>
15313 * and <tt> 1.0 </tt>.
15315 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15316 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15319 * Centered items by default.
15321 * @see elm_toolbar_align_get()
15325 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15328 * Get the alignment of the items.
15330 * @param obj The toolbar object.
15331 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15334 * @see elm_toolbar_align_set() for details.
15338 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15341 * Set whether the toolbar item opens a menu.
15343 * @param item The toolbar item.
15344 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15346 * A toolbar item can be set to be a menu, using this function.
15348 * Once it is set to be a menu, it can be manipulated through the
15349 * menu-like function elm_toolbar_menu_parent_set() and the other
15350 * elm_menu functions, using the Evas_Object @c menu returned by
15351 * elm_toolbar_item_menu_get().
15353 * So, items to be displayed in this item's menu should be added with
15354 * elm_menu_item_add().
15356 * The following code exemplifies the most basic usage:
15358 * tb = elm_toolbar_add(win)
15359 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15360 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15361 * elm_toolbar_menu_parent_set(tb, win);
15362 * menu = elm_toolbar_item_menu_get(item);
15363 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15364 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15368 * @see elm_toolbar_item_menu_get()
15372 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15375 * Get toolbar item's menu.
15377 * @param item The toolbar item.
15378 * @return Item's menu object or @c NULL on failure.
15380 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15381 * this function will set it.
15383 * @see elm_toolbar_item_menu_set() for details.
15387 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15390 * Add a new state to @p item.
15392 * @param item The item.
15393 * @param icon A string with icon name or the absolute path of an image file.
15394 * @param label The label of the new state.
15395 * @param func The function to call when the item is clicked when this
15396 * state is selected.
15397 * @param data The data to associate with the state.
15398 * @return The toolbar item state, or @c NULL upon failure.
15400 * Toolbar will load icon image from fdo or current theme.
15401 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15402 * If an absolute path is provided it will load it direct from a file.
15404 * States created with this function can be removed with
15405 * elm_toolbar_item_state_del().
15407 * @see elm_toolbar_item_state_del()
15408 * @see elm_toolbar_item_state_sel()
15409 * @see elm_toolbar_item_state_get()
15413 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);
15416 * Delete a previoulsy added state to @p item.
15418 * @param item The toolbar item.
15419 * @param state The state to be deleted.
15420 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15422 * @see elm_toolbar_item_state_add()
15424 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15427 * Set @p state as the current state of @p it.
15429 * @param it The item.
15430 * @param state The state to use.
15431 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15433 * If @p state is @c NULL, it won't select any state and the default item's
15434 * icon and label will be used. It's the same behaviour than
15435 * elm_toolbar_item_state_unser().
15437 * @see elm_toolbar_item_state_unset()
15441 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15444 * Unset the state of @p it.
15446 * @param it The item.
15448 * The default icon and label from this item will be displayed.
15450 * @see elm_toolbar_item_state_set() for more details.
15454 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15457 * Get the current state of @p it.
15459 * @param item The item.
15460 * @return The selected state or @c NULL if none is selected or on failure.
15462 * @see elm_toolbar_item_state_set() for details.
15463 * @see elm_toolbar_item_state_unset()
15464 * @see elm_toolbar_item_state_add()
15468 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15471 * Get the state after selected state in toolbar's @p item.
15473 * @param it The toolbar item to change state.
15474 * @return The state after current state, or @c NULL on failure.
15476 * If last state is selected, this function will return first state.
15478 * @see elm_toolbar_item_state_set()
15479 * @see elm_toolbar_item_state_add()
15483 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15486 * Get the state before selected state in toolbar's @p item.
15488 * @param it The toolbar item to change state.
15489 * @return The state before current state, or @c NULL on failure.
15491 * If first state is selected, this function will return last state.
15493 * @see elm_toolbar_item_state_set()
15494 * @see elm_toolbar_item_state_add()
15498 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15501 * Set the text to be shown in a given toolbar item's tooltips.
15503 * @param item Target item.
15504 * @param text The text to set in the content.
15506 * Setup the text as tooltip to object. The item can have only one tooltip,
15507 * so any previous tooltip data - set with this function or
15508 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15510 * @see elm_object_tooltip_text_set() for more details.
15514 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15517 * Set the content to be shown in the tooltip item.
15519 * Setup the tooltip to item. The item can have only one tooltip,
15520 * so any previous tooltip data is removed. @p func(with @p data) will
15521 * be called every time that need show the tooltip and it should
15522 * return a valid Evas_Object. This object is then managed fully by
15523 * tooltip system and is deleted when the tooltip is gone.
15525 * @param item the toolbar item being attached a tooltip.
15526 * @param func the function used to create the tooltip contents.
15527 * @param data what to provide to @a func as callback data/context.
15528 * @param del_cb called when data is not needed anymore, either when
15529 * another callback replaces @a func, the tooltip is unset with
15530 * elm_toolbar_item_tooltip_unset() or the owner @a item
15531 * dies. This callback receives as the first parameter the
15532 * given @a data, and @c event_info is the item.
15534 * @see elm_object_tooltip_content_cb_set() for more details.
15538 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);
15541 * Unset tooltip from item.
15543 * @param item toolbar item to remove previously set tooltip.
15545 * Remove tooltip from item. The callback provided as del_cb to
15546 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15547 * it is not used anymore.
15549 * @see elm_object_tooltip_unset() for more details.
15550 * @see elm_toolbar_item_tooltip_content_cb_set()
15554 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15557 * Sets a different style for this item tooltip.
15559 * @note before you set a style you should define a tooltip with
15560 * elm_toolbar_item_tooltip_content_cb_set() or
15561 * elm_toolbar_item_tooltip_text_set()
15563 * @param item toolbar item with tooltip already set.
15564 * @param style the theme style to use (default, transparent, ...)
15566 * @see elm_object_tooltip_style_set() for more details.
15570 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15573 * Get the style for this item tooltip.
15575 * @param item toolbar item with tooltip already set.
15576 * @return style the theme style in use, defaults to "default". If the
15577 * object does not have a tooltip set, then NULL is returned.
15579 * @see elm_object_tooltip_style_get() for more details.
15580 * @see elm_toolbar_item_tooltip_style_set()
15584 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15587 * Set the type of mouse pointer/cursor decoration to be shown,
15588 * when the mouse pointer is over the given toolbar widget item
15590 * @param item toolbar item to customize cursor on
15591 * @param cursor the cursor type's name
15593 * This function works analogously as elm_object_cursor_set(), but
15594 * here the cursor's changing area is restricted to the item's
15595 * area, and not the whole widget's. Note that that item cursors
15596 * have precedence over widget cursors, so that a mouse over an
15597 * item with custom cursor set will always show @b that cursor.
15599 * If this function is called twice for an object, a previously set
15600 * cursor will be unset on the second call.
15602 * @see elm_object_cursor_set()
15603 * @see elm_toolbar_item_cursor_get()
15604 * @see elm_toolbar_item_cursor_unset()
15608 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15611 * Get the type of mouse pointer/cursor decoration set to be shown,
15612 * when the mouse pointer is over the given toolbar widget item
15614 * @param item toolbar item with custom cursor set
15615 * @return the cursor type's name or @c NULL, if no custom cursors
15616 * were set to @p item (and on errors)
15618 * @see elm_object_cursor_get()
15619 * @see elm_toolbar_item_cursor_set()
15620 * @see elm_toolbar_item_cursor_unset()
15624 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15627 * Unset any custom mouse pointer/cursor decoration set to be
15628 * shown, when the mouse pointer is over the given toolbar widget
15629 * item, thus making it show the @b default cursor again.
15631 * @param item a toolbar item
15633 * Use this call to undo any custom settings on this item's cursor
15634 * decoration, bringing it back to defaults (no custom style set).
15636 * @see elm_object_cursor_unset()
15637 * @see elm_toolbar_item_cursor_set()
15641 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15644 * Set a different @b style for a given custom cursor set for a
15647 * @param item toolbar item with custom cursor set
15648 * @param style the <b>theme style</b> to use (e.g. @c "default",
15649 * @c "transparent", etc)
15651 * This function only makes sense when one is using custom mouse
15652 * cursor decorations <b>defined in a theme file</b>, which can have,
15653 * given a cursor name/type, <b>alternate styles</b> on it. It
15654 * works analogously as elm_object_cursor_style_set(), but here
15655 * applyed only to toolbar item objects.
15657 * @warning Before you set a cursor style you should have definen a
15658 * custom cursor previously on the item, with
15659 * elm_toolbar_item_cursor_set()
15661 * @see elm_toolbar_item_cursor_engine_only_set()
15662 * @see elm_toolbar_item_cursor_style_get()
15666 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15669 * Get the current @b style set for a given toolbar item's custom
15672 * @param item toolbar item with custom cursor set.
15673 * @return style the cursor style in use. If the object does not
15674 * have a cursor set, then @c NULL is returned.
15676 * @see elm_toolbar_item_cursor_style_set() for more details
15680 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15683 * Set if the (custom)cursor for a given toolbar item should be
15684 * searched in its theme, also, or should only rely on the
15685 * rendering engine.
15687 * @param item item with custom (custom) cursor already set on
15688 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15689 * only on those provided by the rendering engine, @c EINA_FALSE to
15690 * have them searched on the widget's theme, as well.
15692 * @note This call is of use only if you've set a custom cursor
15693 * for toolbar items, with elm_toolbar_item_cursor_set().
15695 * @note By default, cursors will only be looked for between those
15696 * provided by the rendering engine.
15700 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15703 * Get if the (custom) cursor for a given toolbar item is being
15704 * searched in its theme, also, or is only relying on the rendering
15707 * @param item a toolbar item
15708 * @return @c EINA_TRUE, if cursors are being looked for only on
15709 * those provided by the rendering engine, @c EINA_FALSE if they
15710 * are being searched on the widget's theme, as well.
15712 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15716 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15719 * Change a toolbar's orientation
15720 * @param obj The toolbar object
15721 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15722 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15724 * @deprecated use elm_toolbar_horizontal_set() instead.
15726 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15729 * Change a toolbar's orientation
15730 * @param obj The toolbar object
15731 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15732 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15735 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15738 * Get a toolbar's orientation
15739 * @param obj The toolbar object
15740 * @return If @c EINA_TRUE, the toolbar is vertical
15741 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15743 * @deprecated use elm_toolbar_horizontal_get() instead.
15745 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15748 * Get a toolbar's orientation
15749 * @param obj The toolbar object
15750 * @return If @c EINA_TRUE, the toolbar is horizontal
15751 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15754 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15760 * @defgroup Tooltips Tooltips
15762 * The Tooltip is an (internal, for now) smart object used to show a
15763 * content in a frame on mouse hover of objects(or widgets), with
15764 * tips/information about them.
15769 EAPI double elm_tooltip_delay_get(void);
15770 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15771 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15772 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15773 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15774 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15775 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15776 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);
15777 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15778 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15779 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15780 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15781 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15788 * @defgroup Cursors Cursors
15790 * The Elementary cursor is an internal smart object used to
15791 * customize the mouse cursor displayed over objects (or
15792 * widgets). In the most common scenario, the cursor decoration
15793 * comes from the graphical @b engine Elementary is running
15794 * on. Those engines may provide different decorations for cursors,
15795 * and Elementary provides functions to choose them (think of X11
15796 * cursors, as an example).
15798 * There's also the possibility of, besides using engine provided
15799 * cursors, also use ones coming from Edje theming files. Both
15800 * globally and per widget, Elementary makes it possible for one to
15801 * make the cursors lookup to be held on engines only or on
15802 * Elementary's theme file, too. To set cursor's hot spot,
15803 * two data items should be added to cursor's theme: "hot_x" and
15804 * "hot_y", that are the offset from upper-left corner of the cursor
15805 * (coordinates 0,0).
15811 * Set the cursor to be shown when mouse is over the object
15813 * Set the cursor that will be displayed when mouse is over the
15814 * object. The object can have only one cursor set to it, so if
15815 * this function is called twice for an object, the previous set
15817 * If using X cursors, a definition of all the valid cursor names
15818 * is listed on Elementary_Cursors.h. If an invalid name is set
15819 * the default cursor will be used.
15821 * @param obj the object being set a cursor.
15822 * @param cursor the cursor name to be used.
15826 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15829 * Get the cursor to be shown when mouse is over the object
15831 * @param obj an object with cursor already set.
15832 * @return the cursor name.
15836 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15839 * Unset cursor for object
15841 * Unset cursor for object, and set the cursor to default if the mouse
15842 * was over this object.
15844 * @param obj Target object
15845 * @see elm_object_cursor_set()
15849 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15852 * Sets a different style for this object cursor.
15854 * @note before you set a style you should define a cursor with
15855 * elm_object_cursor_set()
15857 * @param obj an object with cursor already set.
15858 * @param style the theme style to use (default, transparent, ...)
15862 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15865 * Get the style for this object cursor.
15867 * @param obj an object with cursor already set.
15868 * @return style the theme style in use, defaults to "default". If the
15869 * object does not have a cursor set, then NULL is returned.
15873 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15876 * Set if the cursor set should be searched on the theme or should use
15877 * the provided by the engine, only.
15879 * @note before you set if should look on theme you should define a cursor
15880 * with elm_object_cursor_set(). By default it will only look for cursors
15881 * provided by the engine.
15883 * @param obj an object with cursor already set.
15884 * @param engine_only boolean to define it cursors should be looked only
15885 * between the provided by the engine or searched on widget's theme as well.
15889 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15892 * Get the cursor engine only usage for this object cursor.
15894 * @param obj an object with cursor already set.
15895 * @return engine_only boolean to define it cursors should be
15896 * looked only between the provided by the engine or searched on
15897 * widget's theme as well. If the object does not have a cursor
15898 * set, then EINA_FALSE is returned.
15902 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15905 * Get the configured cursor engine only usage
15907 * This gets the globally configured exclusive usage of engine cursors.
15909 * @return 1 if only engine cursors should be used
15912 EAPI int elm_cursor_engine_only_get(void);
15915 * Set the configured cursor engine only usage
15917 * This sets the globally configured exclusive usage of engine cursors.
15918 * It won't affect cursors set before changing this value.
15920 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15921 * look for them on theme before.
15922 * @return EINA_TRUE if value is valid and setted (0 or 1)
15925 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15932 * @defgroup Menu Menu
15934 * @image html img/widget/menu/preview-00.png
15935 * @image latex img/widget/menu/preview-00.eps
15937 * A menu is a list of items displayed above its parent. When the menu is
15938 * showing its parent is darkened. Each item can have a sub-menu. The menu
15939 * object can be used to display a menu on a right click event, in a toolbar,
15942 * Signals that you can add callbacks for are:
15943 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15944 * event_info is NULL.
15946 * @see @ref tutorial_menu
15949 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15951 * @brief Add a new menu to the parent
15953 * @param parent The parent object.
15954 * @return The new object or NULL if it cannot be created.
15956 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15958 * @brief Set the parent for the given menu widget
15960 * @param obj The menu object.
15961 * @param parent The new parent.
15963 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15965 * @brief Get the parent for the given menu widget
15967 * @param obj The menu object.
15968 * @return The parent.
15970 * @see elm_menu_parent_set()
15972 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15974 * @brief Move the menu to a new position
15976 * @param obj The menu object.
15977 * @param x The new position.
15978 * @param y The new position.
15980 * Sets the top-left position of the menu to (@p x,@p y).
15982 * @note @p x and @p y coordinates are relative to parent.
15984 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15986 * @brief Close a opened menu
15988 * @param obj the menu object
15991 * Hides the menu and all it's sub-menus.
15993 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15995 * @brief Returns a list of @p item's items.
15997 * @param obj The menu object
15998 * @return An Eina_List* of @p item's items
16000 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16002 * @brief Get the Evas_Object of an Elm_Menu_Item
16004 * @param item The menu item object.
16005 * @return The edje object containing the swallowed content
16007 * @warning Don't manipulate this object!
16009 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16011 * @brief Add an item at the end of the given menu widget
16013 * @param obj The menu object.
16014 * @param parent The parent menu item (optional)
16015 * @param icon A icon display on the item. The icon will be destryed by the menu.
16016 * @param label The label of the item.
16017 * @param func Function called when the user select the item.
16018 * @param data Data sent by the callback.
16019 * @return Returns the new item.
16021 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);
16023 * @brief Add an object swallowed in an item at the end of the given menu
16026 * @param obj The menu object.
16027 * @param parent The parent menu item (optional)
16028 * @param subobj The object to swallow
16029 * @param func Function called when the user select the item.
16030 * @param data Data sent by the callback.
16031 * @return Returns the new item.
16033 * Add an evas object as an item to the menu.
16035 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);
16037 * @brief Set the label of a menu item
16039 * @param item The menu item object.
16040 * @param label The label to set for @p item
16042 * @warning Don't use this funcion on items created with
16043 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16045 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16047 * @brief Get the label of a menu item
16049 * @param item The menu item object.
16050 * @return The label of @p item
16052 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16054 * @brief Set the icon of a menu item to the standard icon with name @p icon
16056 * @param item The menu item object.
16057 * @param icon The icon object to set for the content of @p item
16059 * Once this icon is set, any previously set icon will be deleted.
16061 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16063 * @brief Get the string representation from the icon of a menu item
16065 * @param item The menu item object.
16066 * @return The string representation of @p item's icon or NULL
16068 * @see elm_menu_item_object_icon_name_set()
16070 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16072 * @brief Set the content object of a menu item
16074 * @param item The menu item object
16075 * @param The content object or NULL
16076 * @return EINA_TRUE on success, else EINA_FALSE
16078 * Use this function to change the object swallowed by a menu item, deleting
16079 * any previously swallowed object.
16081 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16083 * @brief Get the content object of a menu item
16085 * @param item The menu item object
16086 * @return The content object or NULL
16087 * @note If @p item was added with elm_menu_item_add_object, this
16088 * function will return the object passed, else it will return the
16091 * @see elm_menu_item_object_content_set()
16093 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16095 * @brief Set the selected state of @p item.
16097 * @param item The menu item object.
16098 * @param selected The selected/unselected state of the item
16100 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16102 * @brief Get the selected state of @p item.
16104 * @param item The menu item object.
16105 * @return The selected/unselected state of the item
16107 * @see elm_menu_item_selected_set()
16109 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16111 * @brief Set the disabled state of @p item.
16113 * @param item The menu item object.
16114 * @param disabled The enabled/disabled state of the item
16116 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16118 * @brief Get the disabled state of @p item.
16120 * @param item The menu item object.
16121 * @return The enabled/disabled state of the item
16123 * @see elm_menu_item_disabled_set()
16125 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16127 * @brief Add a separator item to menu @p obj under @p parent.
16129 * @param obj The menu object
16130 * @param parent The item to add the separator under
16131 * @return The created item or NULL on failure
16133 * This is item is a @ref Separator.
16135 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16137 * @brief Returns whether @p item is a separator.
16139 * @param item The item to check
16140 * @return If true, @p item is a separator
16142 * @see elm_menu_item_separator_add()
16144 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16146 * @brief Deletes an item from the menu.
16148 * @param item The item to delete.
16150 * @see elm_menu_item_add()
16152 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16154 * @brief Set the function called when a menu item is deleted.
16156 * @param item The item to set the callback on
16157 * @param func The function called
16159 * @see elm_menu_item_add()
16160 * @see elm_menu_item_del()
16162 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16164 * @brief Returns the data associated with menu item @p item.
16166 * @param item The item
16167 * @return The data associated with @p item or NULL if none was set.
16169 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16171 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16173 * @brief Sets the data to be associated with menu item @p item.
16175 * @param item The item
16176 * @param data The data to be associated with @p item
16178 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16180 * @brief Returns a list of @p item's subitems.
16182 * @param item The item
16183 * @return An Eina_List* of @p item's subitems
16185 * @see elm_menu_add()
16187 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16189 * @brief Get the position of a menu item
16191 * @param item The menu item
16192 * @return The item's index
16194 * This function returns the index position of a menu item in a menu.
16195 * For a sub-menu, this number is relative to the first item in the sub-menu.
16197 * @note Index values begin with 0
16199 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16201 * @brief @brief Return a menu item's owner menu
16203 * @param item The menu item
16204 * @return The menu object owning @p item, or NULL on failure
16206 * Use this function to get the menu object owning an item.
16208 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16210 * @brief Get the selected item in the menu
16212 * @param obj The menu object
16213 * @return The selected item, or NULL if none
16215 * @see elm_menu_item_selected_get()
16216 * @see elm_menu_item_selected_set()
16218 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16220 * @brief Get the last item in the menu
16222 * @param obj The menu object
16223 * @return The last item, or NULL if none
16225 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16227 * @brief Get the first item in the menu
16229 * @param obj The menu object
16230 * @return The first item, or NULL if none
16232 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16234 * @brief Get the next item in the menu.
16236 * @param item The menu item object.
16237 * @return The item after it, or NULL if none
16239 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16241 * @brief Get the previous item in the menu.
16243 * @param item The menu item object.
16244 * @return The item before it, or NULL if none
16246 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16252 * @defgroup List List
16253 * @ingroup Elementary
16255 * @image html img/widget/list/preview-00.png
16256 * @image latex img/widget/list/preview-00.eps width=\textwidth
16258 * @image html img/list.png
16259 * @image latex img/list.eps width=\textwidth
16261 * A list widget is a container whose children are displayed vertically or
16262 * horizontally, in order, and can be selected.
16263 * The list can accept only one or multiple items selection. Also has many
16264 * modes of items displaying.
16266 * A list is a very simple type of list widget. For more robust
16267 * lists, @ref Genlist should probably be used.
16269 * Smart callbacks one can listen to:
16270 * - @c "activated" - The user has double-clicked or pressed
16271 * (enter|return|spacebar) on an item. The @c event_info parameter
16272 * is the item that was activated.
16273 * - @c "clicked,double" - The user has double-clicked an item.
16274 * The @c event_info parameter is the item that was double-clicked.
16275 * - "selected" - when the user selected an item
16276 * - "unselected" - when the user unselected an item
16277 * - "longpressed" - an item in the list is long-pressed
16278 * - "edge,top" - the list is scrolled until the top edge
16279 * - "edge,bottom" - the list is scrolled until the bottom edge
16280 * - "edge,left" - the list is scrolled until the left edge
16281 * - "edge,right" - the list is scrolled until the right edge
16282 * - "language,changed" - the program's language changed
16284 * Available styles for it:
16287 * List of examples:
16288 * @li @ref list_example_01
16289 * @li @ref list_example_02
16290 * @li @ref list_example_03
16299 * @enum _Elm_List_Mode
16300 * @typedef Elm_List_Mode
16302 * Set list's resize behavior, transverse axis scroll and
16303 * items cropping. See each mode's description for more details.
16305 * @note Default value is #ELM_LIST_SCROLL.
16307 * Values <b> don't </b> work as bitmask, only one can be choosen.
16309 * @see elm_list_mode_set()
16310 * @see elm_list_mode_get()
16314 typedef enum _Elm_List_Mode
16316 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. */
16317 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). */
16318 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. */
16319 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. */
16320 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16323 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(). */
16326 * Add a new list widget to the given parent Elementary
16327 * (container) object.
16329 * @param parent The parent object.
16330 * @return a new list widget handle or @c NULL, on errors.
16332 * This function inserts a new list widget on the canvas.
16336 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16341 * @param obj The list object
16343 * @note Call before running show() on the list object.
16344 * @warning If not called, it won't display the list properly.
16347 * li = elm_list_add(win);
16348 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16349 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16351 * evas_object_show(li);
16356 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16359 * Enable or disable multiple items selection on the list object.
16361 * @param obj The list object
16362 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16365 * Disabled by default. If disabled, the user can select a single item of
16366 * the list each time. Selected items are highlighted on list.
16367 * If enabled, many items can be selected.
16369 * If a selected item is selected again, it will be unselected.
16371 * @see elm_list_multi_select_get()
16375 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16378 * Get a value whether multiple items selection is enabled or not.
16380 * @see elm_list_multi_select_set() for details.
16382 * @param obj The list object.
16383 * @return @c EINA_TRUE means multiple items selection is enabled.
16384 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16385 * @c EINA_FALSE is returned.
16389 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16392 * Set which mode to use for the list object.
16394 * @param obj The list object
16395 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16396 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16398 * Set list's resize behavior, transverse axis scroll and
16399 * items cropping. See each mode's description for more details.
16401 * @note Default value is #ELM_LIST_SCROLL.
16403 * Only one can be set, if a previous one was set, it will be changed
16404 * by the new mode set. Bitmask won't work as well.
16406 * @see elm_list_mode_get()
16410 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16413 * Get the mode the list is at.
16415 * @param obj The list object
16416 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16417 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16419 * @note see elm_list_mode_set() for more information.
16423 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16426 * Enable or disable horizontal mode on the list object.
16428 * @param obj The list object.
16429 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16430 * disable it, i.e., to enable vertical mode.
16432 * @note Vertical mode is set by default.
16434 * On horizontal mode items are displayed on list from left to right,
16435 * instead of from top to bottom. Also, the list will scroll horizontally.
16436 * Each item will presents left icon on top and right icon, or end, at
16439 * @see elm_list_horizontal_get()
16443 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16446 * Get a value whether horizontal mode is enabled or not.
16448 * @param obj The list object.
16449 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16450 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16451 * @c EINA_FALSE is returned.
16453 * @see elm_list_horizontal_set() for details.
16457 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16460 * Enable or disable always select mode on the list object.
16462 * @param obj The list object
16463 * @param always_select @c EINA_TRUE to enable always select mode or
16464 * @c EINA_FALSE to disable it.
16466 * @note Always select mode is disabled by default.
16468 * Default behavior of list items is to only call its callback function
16469 * the first time it's pressed, i.e., when it is selected. If a selected
16470 * item is pressed again, and multi-select is disabled, it won't call
16471 * this function (if multi-select is enabled it will unselect the item).
16473 * If always select is enabled, it will call the callback function
16474 * everytime a item is pressed, so it will call when the item is selected,
16475 * and again when a selected item is pressed.
16477 * @see elm_list_always_select_mode_get()
16478 * @see elm_list_multi_select_set()
16482 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16485 * Get a value whether always select mode is enabled or not, meaning that
16486 * an item will always call its callback function, even if already selected.
16488 * @param obj The list object
16489 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16490 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16491 * @c EINA_FALSE is returned.
16493 * @see elm_list_always_select_mode_set() for details.
16497 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16500 * Set bouncing behaviour when the scrolled content reaches an edge.
16502 * Tell the internal scroller object whether it should bounce or not
16503 * when it reaches the respective edges for each axis.
16505 * @param obj The list object
16506 * @param h_bounce Whether to bounce or not in the horizontal axis.
16507 * @param v_bounce Whether to bounce or not in the vertical axis.
16509 * @see elm_scroller_bounce_set()
16513 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16516 * Get the bouncing behaviour of the internal scroller.
16518 * Get whether the internal scroller should bounce when the edge of each
16519 * axis is reached scrolling.
16521 * @param obj The list object.
16522 * @param h_bounce Pointer where to store the bounce state of the horizontal
16524 * @param v_bounce Pointer where to store the bounce state of the vertical
16527 * @see elm_scroller_bounce_get()
16528 * @see elm_list_bounce_set()
16532 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16535 * Set the scrollbar policy.
16537 * @param obj The list object
16538 * @param policy_h Horizontal scrollbar policy.
16539 * @param policy_v Vertical scrollbar policy.
16541 * This sets the scrollbar visibility policy for the given scroller.
16542 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16543 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16544 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16545 * This applies respectively for the horizontal and vertical scrollbars.
16547 * The both are disabled by default, i.e., are set to
16548 * #ELM_SCROLLER_POLICY_OFF.
16552 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16555 * Get the scrollbar policy.
16557 * @see elm_list_scroller_policy_get() for details.
16559 * @param obj The list object.
16560 * @param policy_h Pointer where to store horizontal scrollbar policy.
16561 * @param policy_v Pointer where to store vertical scrollbar policy.
16565 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);
16568 * Append a new item to the list object.
16570 * @param obj The list object.
16571 * @param label The label of the list item.
16572 * @param icon The icon object to use for the left side of the item. An
16573 * icon can be any Evas object, but usually it is an icon created
16574 * with elm_icon_add().
16575 * @param end The icon object to use for the right side of the item. An
16576 * icon can be any Evas object.
16577 * @param func The function to call when the item is clicked.
16578 * @param data The data to associate with the item for related callbacks.
16580 * @return The created item or @c NULL upon failure.
16582 * A new item will be created and appended to the list, i.e., will
16583 * be set as @b last item.
16585 * Items created with this method can be deleted with
16586 * elm_list_item_del().
16588 * Associated @p data can be properly freed when item is deleted if a
16589 * callback function is set with elm_list_item_del_cb_set().
16591 * If a function is passed as argument, it will be called everytime this item
16592 * is selected, i.e., the user clicks over an unselected item.
16593 * If always select is enabled it will call this function every time
16594 * user clicks over an item (already selected or not).
16595 * If such function isn't needed, just passing
16596 * @c NULL as @p func is enough. The same should be done for @p data.
16598 * Simple example (with no function callback or data associated):
16600 * li = elm_list_add(win);
16601 * ic = elm_icon_add(win);
16602 * elm_icon_file_set(ic, "path/to/image", NULL);
16603 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16604 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16606 * evas_object_show(li);
16609 * @see elm_list_always_select_mode_set()
16610 * @see elm_list_item_del()
16611 * @see elm_list_item_del_cb_set()
16612 * @see elm_list_clear()
16613 * @see elm_icon_add()
16617 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);
16620 * Prepend a new item to the list object.
16622 * @param obj The list object.
16623 * @param label The label of the list item.
16624 * @param icon The icon object to use for the left side of the item. An
16625 * icon can be any Evas object, but usually it is an icon created
16626 * with elm_icon_add().
16627 * @param end The icon object to use for the right side of the item. An
16628 * icon can be any Evas object.
16629 * @param func The function to call when the item is clicked.
16630 * @param data The data to associate with the item for related callbacks.
16632 * @return The created item or @c NULL upon failure.
16634 * A new item will be created and prepended to the list, i.e., will
16635 * be set as @b first item.
16637 * Items created with this method can be deleted with
16638 * elm_list_item_del().
16640 * Associated @p data can be properly freed when item is deleted if a
16641 * callback function is set with elm_list_item_del_cb_set().
16643 * If a function is passed as argument, it will be called everytime this item
16644 * is selected, i.e., the user clicks over an unselected item.
16645 * If always select is enabled it will call this function every time
16646 * user clicks over an item (already selected or not).
16647 * If such function isn't needed, just passing
16648 * @c NULL as @p func is enough. The same should be done for @p data.
16650 * @see elm_list_item_append() for a simple code example.
16651 * @see elm_list_always_select_mode_set()
16652 * @see elm_list_item_del()
16653 * @see elm_list_item_del_cb_set()
16654 * @see elm_list_clear()
16655 * @see elm_icon_add()
16659 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);
16662 * Insert a new item into the list object before item @p before.
16664 * @param obj The list object.
16665 * @param before The list item to insert before.
16666 * @param label The label of the list item.
16667 * @param icon The icon object to use for the left side of the item. An
16668 * icon can be any Evas object, but usually it is an icon created
16669 * with elm_icon_add().
16670 * @param end The icon object to use for the right side of the item. An
16671 * icon can be any Evas object.
16672 * @param func The function to call when the item is clicked.
16673 * @param data The data to associate with the item for related callbacks.
16675 * @return The created item or @c NULL upon failure.
16677 * A new item will be created and added to the list. Its position in
16678 * this list will be just before item @p before.
16680 * Items created with this method can be deleted with
16681 * elm_list_item_del().
16683 * Associated @p data can be properly freed when item is deleted if a
16684 * callback function is set with elm_list_item_del_cb_set().
16686 * If a function is passed as argument, it will be called everytime this item
16687 * is selected, i.e., the user clicks over an unselected item.
16688 * If always select is enabled it will call this function every time
16689 * user clicks over an item (already selected or not).
16690 * If such function isn't needed, just passing
16691 * @c NULL as @p func is enough. The same should be done for @p data.
16693 * @see elm_list_item_append() for a simple code example.
16694 * @see elm_list_always_select_mode_set()
16695 * @see elm_list_item_del()
16696 * @see elm_list_item_del_cb_set()
16697 * @see elm_list_clear()
16698 * @see elm_icon_add()
16702 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);
16705 * Insert a new item into the list object after item @p after.
16707 * @param obj The list object.
16708 * @param after The list item to insert after.
16709 * @param label The label of the list item.
16710 * @param icon The icon object to use for the left side of the item. An
16711 * icon can be any Evas object, but usually it is an icon created
16712 * with elm_icon_add().
16713 * @param end The icon object to use for the right side of the item. An
16714 * icon can be any Evas object.
16715 * @param func The function to call when the item is clicked.
16716 * @param data The data to associate with the item for related callbacks.
16718 * @return The created item or @c NULL upon failure.
16720 * A new item will be created and added to the list. Its position in
16721 * this list will be just after item @p after.
16723 * Items created with this method can be deleted with
16724 * elm_list_item_del().
16726 * Associated @p data can be properly freed when item is deleted if a
16727 * callback function is set with elm_list_item_del_cb_set().
16729 * If a function is passed as argument, it will be called everytime this item
16730 * is selected, i.e., the user clicks over an unselected item.
16731 * If always select is enabled it will call this function every time
16732 * user clicks over an item (already selected or not).
16733 * If such function isn't needed, just passing
16734 * @c NULL as @p func is enough. The same should be done for @p data.
16736 * @see elm_list_item_append() for a simple code example.
16737 * @see elm_list_always_select_mode_set()
16738 * @see elm_list_item_del()
16739 * @see elm_list_item_del_cb_set()
16740 * @see elm_list_clear()
16741 * @see elm_icon_add()
16745 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);
16748 * Insert a new item into the sorted list object.
16750 * @param obj The list object.
16751 * @param label The label of the list item.
16752 * @param icon The icon object to use for the left side of the item. An
16753 * icon can be any Evas object, but usually it is an icon created
16754 * with elm_icon_add().
16755 * @param end The icon object to use for the right side of the item. An
16756 * icon can be any Evas object.
16757 * @param func The function to call when the item is clicked.
16758 * @param data The data to associate with the item for related callbacks.
16759 * @param cmp_func The comparing function to be used to sort list
16760 * items <b>by #Elm_List_Item item handles</b>. This function will
16761 * receive two items and compare them, returning a non-negative integer
16762 * if the second item should be place after the first, or negative value
16763 * if should be placed before.
16765 * @return The created item or @c NULL upon failure.
16767 * @note This function inserts values into a list object assuming it was
16768 * sorted and the result will be sorted.
16770 * A new item will be created and added to the list. Its position in
16771 * this list will be found comparing the new item with previously inserted
16772 * items using function @p cmp_func.
16774 * Items created with this method can be deleted with
16775 * elm_list_item_del().
16777 * Associated @p data can be properly freed when item is deleted if a
16778 * callback function is set with elm_list_item_del_cb_set().
16780 * If a function is passed as argument, it will be called everytime this item
16781 * is selected, i.e., the user clicks over an unselected item.
16782 * If always select is enabled it will call this function every time
16783 * user clicks over an item (already selected or not).
16784 * If such function isn't needed, just passing
16785 * @c NULL as @p func is enough. The same should be done for @p data.
16787 * @see elm_list_item_append() for a simple code example.
16788 * @see elm_list_always_select_mode_set()
16789 * @see elm_list_item_del()
16790 * @see elm_list_item_del_cb_set()
16791 * @see elm_list_clear()
16792 * @see elm_icon_add()
16796 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);
16799 * Remove all list's items.
16801 * @param obj The list object
16803 * @see elm_list_item_del()
16804 * @see elm_list_item_append()
16808 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16811 * Get a list of all the list items.
16813 * @param obj The list object
16814 * @return An @c Eina_List of list items, #Elm_List_Item,
16815 * or @c NULL on failure.
16817 * @see elm_list_item_append()
16818 * @see elm_list_item_del()
16819 * @see elm_list_clear()
16823 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16826 * Get the selected item.
16828 * @param obj The list object.
16829 * @return The selected list item.
16831 * The selected item can be unselected with function
16832 * elm_list_item_selected_set().
16834 * The selected item always will be highlighted on list.
16836 * @see elm_list_selected_items_get()
16840 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16843 * Return a list of the currently selected list items.
16845 * @param obj The list object.
16846 * @return An @c Eina_List of list items, #Elm_List_Item,
16847 * or @c NULL on failure.
16849 * Multiple items can be selected if multi select is enabled. It can be
16850 * done with elm_list_multi_select_set().
16852 * @see elm_list_selected_item_get()
16853 * @see elm_list_multi_select_set()
16857 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16860 * Set the selected state of an item.
16862 * @param item The list item
16863 * @param selected The selected state
16865 * This sets the selected state of the given item @p it.
16866 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16868 * If a new item is selected the previosly selected will be unselected,
16869 * unless multiple selection is enabled with elm_list_multi_select_set().
16870 * Previoulsy selected item can be get with function
16871 * elm_list_selected_item_get().
16873 * Selected items will be highlighted.
16875 * @see elm_list_item_selected_get()
16876 * @see elm_list_selected_item_get()
16877 * @see elm_list_multi_select_set()
16881 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16884 * Get whether the @p item is selected or not.
16886 * @param item The list item.
16887 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16888 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16890 * @see elm_list_selected_item_set() for details.
16891 * @see elm_list_item_selected_get()
16895 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16898 * Set or unset item as a separator.
16900 * @param it The list item.
16901 * @param setting @c EINA_TRUE to set item @p it as separator or
16902 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16904 * Items aren't set as separator by default.
16906 * If set as separator it will display separator theme, so won't display
16909 * @see elm_list_item_separator_get()
16913 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16916 * Get a value whether item is a separator or not.
16918 * @see elm_list_item_separator_set() for details.
16920 * @param it The list item.
16921 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16922 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16926 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16929 * Show @p item in the list view.
16931 * @param item The list item to be shown.
16933 * It won't animate list until item is visible. If such behavior is wanted,
16934 * use elm_list_bring_in() intead.
16938 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16941 * Bring in the given item to list view.
16943 * @param item The item.
16945 * This causes list to jump to the given item @p item and show it
16946 * (by scrolling), if it is not fully visible.
16948 * This may use animation to do so and take a period of time.
16950 * If animation isn't wanted, elm_list_item_show() can be used.
16954 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16957 * Delete them item from the list.
16959 * @param item The item of list to be deleted.
16961 * If deleting all list items is required, elm_list_clear()
16962 * should be used instead of getting items list and deleting each one.
16964 * @see elm_list_clear()
16965 * @see elm_list_item_append()
16966 * @see elm_list_item_del_cb_set()
16970 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16973 * Set the function called when a list item is freed.
16975 * @param item The item to set the callback on
16976 * @param func The function called
16978 * If there is a @p func, then it will be called prior item's memory release.
16979 * That will be called with the following arguments:
16981 * @li item's Evas object;
16984 * This way, a data associated to a list item could be properly freed.
16988 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16991 * Get the data associated to the item.
16993 * @param item The list item
16994 * @return The data associated to @p item
16996 * The return value is a pointer to data associated to @p item when it was
16997 * created, with function elm_list_item_append() or similar. If no data
16998 * was passed as argument, it will return @c NULL.
17000 * @see elm_list_item_append()
17004 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17007 * Get the left side icon associated to the item.
17009 * @param item The list item
17010 * @return The left side icon associated to @p item
17012 * The return value is a pointer to the icon associated to @p item when
17014 * created, with function elm_list_item_append() or similar, or later
17015 * with function elm_list_item_icon_set(). If no icon
17016 * was passed as argument, it will return @c NULL.
17018 * @see elm_list_item_append()
17019 * @see elm_list_item_icon_set()
17023 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17026 * Set the left side icon associated to the item.
17028 * @param item The list item
17029 * @param icon The left side icon object to associate with @p item
17031 * The icon object to use at left side of the item. An
17032 * icon can be any Evas object, but usually it is an icon created
17033 * with elm_icon_add().
17035 * Once the icon object is set, a previously set one will be deleted.
17036 * @warning Setting the same icon for two items will cause the icon to
17037 * dissapear from the first item.
17039 * If an icon was passed as argument on item creation, with function
17040 * elm_list_item_append() or similar, it will be already
17041 * associated to the item.
17043 * @see elm_list_item_append()
17044 * @see elm_list_item_icon_get()
17048 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17051 * Get the right side icon associated to the item.
17053 * @param item The list item
17054 * @return The right side icon associated to @p item
17056 * The return value is a pointer to the icon associated to @p item when
17058 * created, with function elm_list_item_append() or similar, or later
17059 * with function elm_list_item_icon_set(). If no icon
17060 * was passed as argument, it will return @c NULL.
17062 * @see elm_list_item_append()
17063 * @see elm_list_item_icon_set()
17067 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17070 * Set the right side icon associated to the item.
17072 * @param item The list item
17073 * @param end The right side icon object to associate with @p item
17075 * The icon object to use at right side of the item. An
17076 * icon can be any Evas object, but usually it is an icon created
17077 * with elm_icon_add().
17079 * Once the icon object is set, a previously set one will be deleted.
17080 * @warning Setting the same icon for two items will cause the icon to
17081 * dissapear from the first item.
17083 * If an icon was passed as argument on item creation, with function
17084 * elm_list_item_append() or similar, it will be already
17085 * associated to the item.
17087 * @see elm_list_item_append()
17088 * @see elm_list_item_end_get()
17092 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17095 * Gets the base object of the item.
17097 * @param item The list item
17098 * @return The base object associated with @p item
17100 * Base object is the @c Evas_Object that represents that item.
17104 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17105 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17108 * Get the label of item.
17110 * @param item The item of list.
17111 * @return The label of item.
17113 * The return value is a pointer to the label associated to @p item when
17114 * it was created, with function elm_list_item_append(), or later
17115 * with function elm_list_item_label_set. If no label
17116 * was passed as argument, it will return @c NULL.
17118 * @see elm_list_item_label_set() for more details.
17119 * @see elm_list_item_append()
17123 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17126 * Set the label of item.
17128 * @param item The item of list.
17129 * @param text The label of item.
17131 * The label to be displayed by the item.
17132 * Label will be placed between left and right side icons (if set).
17134 * If a label was passed as argument on item creation, with function
17135 * elm_list_item_append() or similar, it will be already
17136 * displayed by the item.
17138 * @see elm_list_item_label_get()
17139 * @see elm_list_item_append()
17143 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17147 * Get the item before @p it in list.
17149 * @param it The list item.
17150 * @return The item before @p it, or @c NULL if none or on failure.
17152 * @note If it is the first item, @c NULL will be returned.
17154 * @see elm_list_item_append()
17155 * @see elm_list_items_get()
17159 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17162 * Get the item after @p it in list.
17164 * @param it The list item.
17165 * @return The item after @p it, or @c NULL if none or on failure.
17167 * @note If it is the last item, @c NULL will be returned.
17169 * @see elm_list_item_append()
17170 * @see elm_list_items_get()
17174 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17177 * Sets the disabled/enabled state of a list item.
17179 * @param it The item.
17180 * @param disabled The disabled state.
17182 * A disabled item cannot be selected or unselected. It will also
17183 * change its appearance (generally greyed out). This sets the
17184 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17189 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17192 * Get a value whether list item is disabled or not.
17194 * @param it The item.
17195 * @return The disabled state.
17197 * @see elm_list_item_disabled_set() for more details.
17201 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17204 * Set the text to be shown in a given list item's tooltips.
17206 * @param item Target item.
17207 * @param text The text to set in the content.
17209 * Setup the text as tooltip to object. The item can have only one tooltip,
17210 * so any previous tooltip data - set with this function or
17211 * elm_list_item_tooltip_content_cb_set() - is removed.
17213 * @see elm_object_tooltip_text_set() for more details.
17217 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17221 * @brief Disable size restrictions on an object's tooltip
17222 * @param item The tooltip's anchor object
17223 * @param disable If EINA_TRUE, size restrictions are disabled
17224 * @return EINA_FALSE on failure, EINA_TRUE on success
17226 * This function allows a tooltip to expand beyond its parant window's canvas.
17227 * It will instead be limited only by the size of the display.
17229 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17231 * @brief Retrieve size restriction state of an object's tooltip
17232 * @param obj The tooltip's anchor object
17233 * @return If EINA_TRUE, size restrictions are disabled
17235 * This function returns whether a tooltip is allowed to expand beyond
17236 * its parant window's canvas.
17237 * It will instead be limited only by the size of the display.
17239 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17242 * Set the content to be shown in the tooltip item.
17244 * Setup the tooltip to item. The item can have only one tooltip,
17245 * so any previous tooltip data is removed. @p func(with @p data) will
17246 * be called every time that need show the tooltip and it should
17247 * return a valid Evas_Object. This object is then managed fully by
17248 * tooltip system and is deleted when the tooltip is gone.
17250 * @param item the list item being attached a tooltip.
17251 * @param func the function used to create the tooltip contents.
17252 * @param data what to provide to @a func as callback data/context.
17253 * @param del_cb called when data is not needed anymore, either when
17254 * another callback replaces @a func, the tooltip is unset with
17255 * elm_list_item_tooltip_unset() or the owner @a item
17256 * dies. This callback receives as the first parameter the
17257 * given @a data, and @c event_info is the item.
17259 * @see elm_object_tooltip_content_cb_set() for more details.
17263 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);
17266 * Unset tooltip from item.
17268 * @param item list item to remove previously set tooltip.
17270 * Remove tooltip from item. The callback provided as del_cb to
17271 * elm_list_item_tooltip_content_cb_set() will be called to notify
17272 * it is not used anymore.
17274 * @see elm_object_tooltip_unset() for more details.
17275 * @see elm_list_item_tooltip_content_cb_set()
17279 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17282 * Sets a different style for this item tooltip.
17284 * @note before you set a style you should define a tooltip with
17285 * elm_list_item_tooltip_content_cb_set() or
17286 * elm_list_item_tooltip_text_set()
17288 * @param item list item with tooltip already set.
17289 * @param style the theme style to use (default, transparent, ...)
17291 * @see elm_object_tooltip_style_set() for more details.
17295 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17298 * Get the style for this item tooltip.
17300 * @param item list item with tooltip already set.
17301 * @return style the theme style in use, defaults to "default". If the
17302 * object does not have a tooltip set, then NULL is returned.
17304 * @see elm_object_tooltip_style_get() for more details.
17305 * @see elm_list_item_tooltip_style_set()
17309 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17312 * Set the type of mouse pointer/cursor decoration to be shown,
17313 * when the mouse pointer is over the given list widget item
17315 * @param item list item to customize cursor on
17316 * @param cursor the cursor type's name
17318 * This function works analogously as elm_object_cursor_set(), but
17319 * here the cursor's changing area is restricted to the item's
17320 * area, and not the whole widget's. Note that that item cursors
17321 * have precedence over widget cursors, so that a mouse over an
17322 * item with custom cursor set will always show @b that cursor.
17324 * If this function is called twice for an object, a previously set
17325 * cursor will be unset on the second call.
17327 * @see elm_object_cursor_set()
17328 * @see elm_list_item_cursor_get()
17329 * @see elm_list_item_cursor_unset()
17333 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17336 * Get the type of mouse pointer/cursor decoration set to be shown,
17337 * when the mouse pointer is over the given list widget item
17339 * @param item list item with custom cursor set
17340 * @return the cursor type's name or @c NULL, if no custom cursors
17341 * were set to @p item (and on errors)
17343 * @see elm_object_cursor_get()
17344 * @see elm_list_item_cursor_set()
17345 * @see elm_list_item_cursor_unset()
17349 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17352 * Unset any custom mouse pointer/cursor decoration set to be
17353 * shown, when the mouse pointer is over the given list widget
17354 * item, thus making it show the @b default cursor again.
17356 * @param item a list item
17358 * Use this call to undo any custom settings on this item's cursor
17359 * decoration, bringing it back to defaults (no custom style set).
17361 * @see elm_object_cursor_unset()
17362 * @see elm_list_item_cursor_set()
17366 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17369 * Set a different @b style for a given custom cursor set for a
17372 * @param item list item with custom cursor set
17373 * @param style the <b>theme style</b> to use (e.g. @c "default",
17374 * @c "transparent", etc)
17376 * This function only makes sense when one is using custom mouse
17377 * cursor decorations <b>defined in a theme file</b>, which can have,
17378 * given a cursor name/type, <b>alternate styles</b> on it. It
17379 * works analogously as elm_object_cursor_style_set(), but here
17380 * applyed only to list item objects.
17382 * @warning Before you set a cursor style you should have definen a
17383 * custom cursor previously on the item, with
17384 * elm_list_item_cursor_set()
17386 * @see elm_list_item_cursor_engine_only_set()
17387 * @see elm_list_item_cursor_style_get()
17391 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17394 * Get the current @b style set for a given list item's custom
17397 * @param item list item with custom cursor set.
17398 * @return style the cursor style in use. If the object does not
17399 * have a cursor set, then @c NULL is returned.
17401 * @see elm_list_item_cursor_style_set() for more details
17405 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17408 * Set if the (custom)cursor for a given list item should be
17409 * searched in its theme, also, or should only rely on the
17410 * rendering engine.
17412 * @param item item with custom (custom) cursor already set on
17413 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17414 * only on those provided by the rendering engine, @c EINA_FALSE to
17415 * have them searched on the widget's theme, as well.
17417 * @note This call is of use only if you've set a custom cursor
17418 * for list items, with elm_list_item_cursor_set().
17420 * @note By default, cursors will only be looked for between those
17421 * provided by the rendering engine.
17425 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17428 * Get if the (custom) cursor for a given list item is being
17429 * searched in its theme, also, or is only relying on the rendering
17432 * @param item a list item
17433 * @return @c EINA_TRUE, if cursors are being looked for only on
17434 * those provided by the rendering engine, @c EINA_FALSE if they
17435 * are being searched on the widget's theme, as well.
17437 * @see elm_list_item_cursor_engine_only_set(), for more details
17441 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17448 * @defgroup Slider Slider
17449 * @ingroup Elementary
17451 * @image html img/widget/slider/preview-00.png
17452 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17454 * The slider adds a dragable āsliderā widget for selecting the value of
17455 * something within a range.
17457 * A slider can be horizontal or vertical. It can contain an Icon and has a
17458 * primary label as well as a units label (that is formatted with floating
17459 * point values and thus accepts a printf-style format string, like
17460 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17461 * else (like on the slider itself) that also accepts a format string like
17462 * units. Label, Icon Unit and Indicator strings/objects are optional.
17464 * A slider may be inverted which means values invert, with high vales being
17465 * on the left or top and low values on the right or bottom (as opposed to
17466 * normally being low on the left or top and high on the bottom and right).
17468 * The slider should have its minimum and maximum values set by the
17469 * application with elm_slider_min_max_set() and value should also be set by
17470 * the application before use with elm_slider_value_set(). The span of the
17471 * slider is its length (horizontally or vertically). This will be scaled by
17472 * the object or applications scaling factor. At any point code can query the
17473 * slider for its value with elm_slider_value_get().
17475 * Smart callbacks one can listen to:
17476 * - "changed" - Whenever the slider value is changed by the user.
17477 * - "slider,drag,start" - dragging the slider indicator around has started.
17478 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17479 * - "delay,changed" - A short time after the value is changed by the user.
17480 * This will be called only when the user stops dragging for
17481 * a very short period or when they release their
17482 * finger/mouse, so it avoids possibly expensive reactions to
17483 * the value change.
17485 * Available styles for it:
17488 * Default contents parts of the slider widget that you can use for are:
17489 * @li "icon" - A icon of the slider
17490 * @li "end" - A end part content of the slider
17492 * Default text parts of the silder widget that you can use for are:
17493 * @li "default" - Label of the silder
17494 * Here is an example on its usage:
17495 * @li @ref slider_example
17499 * @addtogroup Slider
17504 * Add a new slider widget to the given parent Elementary
17505 * (container) object.
17507 * @param parent The parent object.
17508 * @return a new slider widget handle or @c NULL, on errors.
17510 * This function inserts a new slider widget on the canvas.
17514 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17517 * Set the label of a given slider widget
17519 * @param obj The progress bar object
17520 * @param label The text label string, in UTF-8
17523 * @deprecated use elm_object_text_set() instead.
17525 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17528 * Get the label of a given slider widget
17530 * @param obj The progressbar object
17531 * @return The text label string, in UTF-8
17534 * @deprecated use elm_object_text_get() instead.
17536 WILL_DEPRECATE EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17539 * Set the icon object of the slider object.
17541 * @param obj The slider object.
17542 * @param icon The icon object.
17544 * On horizontal mode, icon is placed at left, and on vertical mode,
17547 * @note Once the icon object is set, a previously set one will be deleted.
17548 * If you want to keep that old content object, use the
17549 * elm_slider_icon_unset() function.
17551 * @warning If the object being set does not have minimum size hints set,
17552 * it won't get properly displayed.
17555 * @deprecated use elm_object_part_content_set() instead.
17557 WILL_DEPRECATE EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17560 * Unset an icon set on a given slider widget.
17562 * @param obj The slider object.
17563 * @return The icon object that was being used, if any was set, or
17564 * @c NULL, otherwise (and on errors).
17566 * On horizontal mode, icon is placed at left, and on vertical mode,
17569 * This call will unparent and return the icon object which was set
17570 * for this widget, previously, on success.
17572 * @see elm_slider_icon_set() for more details
17573 * @see elm_slider_icon_get()
17574 * @deprecated use elm_object_part_content_unset() instead.
17578 WILL_DEPRECATE EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17581 * Retrieve the icon object set for a given slider widget.
17583 * @param obj The slider object.
17584 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17585 * otherwise (and on errors).
17587 * On horizontal mode, icon is placed at left, and on vertical mode,
17590 * @see elm_slider_icon_set() for more details
17591 * @see elm_slider_icon_unset()
17593 * @deprecated use elm_object_part_content_get() instead.
17597 WILL_DEPRECATE EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17600 * Set the end object of the slider object.
17602 * @param obj The slider object.
17603 * @param end The end object.
17605 * On horizontal mode, end is placed at left, and on vertical mode,
17606 * placed at bottom.
17608 * @note Once the icon object is set, a previously set one will be deleted.
17609 * If you want to keep that old content object, use the
17610 * elm_slider_end_unset() function.
17612 * @warning If the object being set does not have minimum size hints set,
17613 * it won't get properly displayed.
17615 * @deprecated use elm_object_part_content_set() instead.
17619 WILL_DEPRECATE EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17622 * Unset an end object set on a given slider widget.
17624 * @param obj The slider object.
17625 * @return The end object that was being used, if any was set, or
17626 * @c NULL, otherwise (and on errors).
17628 * On horizontal mode, end is placed at left, and on vertical mode,
17629 * placed at bottom.
17631 * This call will unparent and return the icon object which was set
17632 * for this widget, previously, on success.
17634 * @see elm_slider_end_set() for more details.
17635 * @see elm_slider_end_get()
17637 * @deprecated use elm_object_part_content_unset() instead
17642 WILL_DEPRECATE EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17645 * Retrieve the end object set for a given slider widget.
17647 * @param obj The slider object.
17648 * @return The end object's handle, if @p obj had one set, or @c NULL,
17649 * otherwise (and on errors).
17651 * On horizontal mode, icon is placed at right, and on vertical mode,
17652 * placed at bottom.
17654 * @see elm_slider_end_set() for more details.
17655 * @see elm_slider_end_unset()
17658 * @deprecated use elm_object_part_content_get() instead
17663 WILL_DEPRECATE EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17666 * Set the (exact) length of the bar region of a given slider widget.
17668 * @param obj The slider object.
17669 * @param size The length of the slider's bar region.
17671 * This sets the minimum width (when in horizontal mode) or height
17672 * (when in vertical mode) of the actual bar area of the slider
17673 * @p obj. This in turn affects the object's minimum size. Use
17674 * this when you're not setting other size hints expanding on the
17675 * given direction (like weight and alignment hints) and you would
17676 * like it to have a specific size.
17678 * @note Icon, end, label, indicator and unit text around @p obj
17679 * will require their
17680 * own space, which will make @p obj to require more the @p size,
17683 * @see elm_slider_span_size_get()
17687 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17690 * Get the length set for the bar region of a given slider widget
17692 * @param obj The slider object.
17693 * @return The length of the slider's bar region.
17695 * If that size was not set previously, with
17696 * elm_slider_span_size_set(), this call will return @c 0.
17700 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17703 * Set the format string for the unit label.
17705 * @param obj The slider object.
17706 * @param format The format string for the unit display.
17708 * Unit label is displayed all the time, if set, after slider's bar.
17709 * In horizontal mode, at right and in vertical mode, at bottom.
17711 * If @c NULL, unit label won't be visible. If not it sets the format
17712 * string for the label text. To the label text is provided a floating point
17713 * value, so the label text can display up to 1 floating point value.
17714 * Note that this is optional.
17716 * Use a format string such as "%1.2f meters" for example, and it will
17717 * display values like: "3.14 meters" for a value equal to 3.14159.
17719 * Default is unit label disabled.
17721 * @see elm_slider_indicator_format_get()
17725 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17728 * Get the unit label format of the slider.
17730 * @param obj The slider object.
17731 * @return The unit label format string in UTF-8.
17733 * Unit label is displayed all the time, if set, after slider's bar.
17734 * In horizontal mode, at right and in vertical mode, at bottom.
17736 * @see elm_slider_unit_format_set() for more
17737 * information on how this works.
17741 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17744 * Set the format string for the indicator label.
17746 * @param obj The slider object.
17747 * @param indicator The format string for the indicator display.
17749 * The slider may display its value somewhere else then unit label,
17750 * for example, above the slider knob that is dragged around. This function
17751 * sets the format string used for this.
17753 * If @c NULL, indicator label won't be visible. If not it sets the format
17754 * string for the label text. To the label text is provided a floating point
17755 * value, so the label text can display up to 1 floating point value.
17756 * Note that this is optional.
17758 * Use a format string such as "%1.2f meters" for example, and it will
17759 * display values like: "3.14 meters" for a value equal to 3.14159.
17761 * Default is indicator label disabled.
17763 * @see elm_slider_indicator_format_get()
17767 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17770 * Get the indicator label format of the slider.
17772 * @param obj The slider object.
17773 * @return The indicator label format string in UTF-8.
17775 * The slider may display its value somewhere else then unit label,
17776 * for example, above the slider knob that is dragged around. This function
17777 * gets the format string used for this.
17779 * @see elm_slider_indicator_format_set() for more
17780 * information on how this works.
17784 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17787 * Set the format function pointer for the indicator label
17789 * @param obj The slider object.
17790 * @param func The indicator format function.
17791 * @param free_func The freeing function for the format string.
17793 * Set the callback function to format the indicator string.
17795 * @see elm_slider_indicator_format_set() for more info on how this works.
17799 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);
17802 * Set the format function pointer for the units label
17804 * @param obj The slider object.
17805 * @param func The units format function.
17806 * @param free_func The freeing function for the format string.
17808 * Set the callback function to format the indicator string.
17810 * @see elm_slider_units_format_set() for more info on how this works.
17814 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);
17817 * Set the orientation of a given slider widget.
17819 * @param obj The slider object.
17820 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17821 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17823 * Use this function to change how your slider is to be
17824 * disposed: vertically or horizontally.
17826 * By default it's displayed horizontally.
17828 * @see elm_slider_horizontal_get()
17832 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17835 * Retrieve the orientation of a given slider widget
17837 * @param obj The slider object.
17838 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17839 * @c EINA_FALSE if it's @b vertical (and on errors).
17841 * @see elm_slider_horizontal_set() for more details.
17845 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17848 * Set the minimum and maximum values for the slider.
17850 * @param obj The slider object.
17851 * @param min The minimum value.
17852 * @param max The maximum value.
17854 * Define the allowed range of values to be selected by the user.
17856 * If actual value is less than @p min, it will be updated to @p min. If it
17857 * is bigger then @p max, will be updated to @p max. Actual value can be
17858 * get with elm_slider_value_get().
17860 * By default, min is equal to 0.0, and max is equal to 1.0.
17862 * @warning Maximum must be greater than minimum, otherwise behavior
17865 * @see elm_slider_min_max_get()
17869 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17872 * Get the minimum and maximum values of the slider.
17874 * @param obj The slider object.
17875 * @param min Pointer where to store the minimum value.
17876 * @param max Pointer where to store the maximum value.
17878 * @note If only one value is needed, the other pointer can be passed
17881 * @see elm_slider_min_max_set() for details.
17885 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17888 * Set the value the slider displays.
17890 * @param obj The slider object.
17891 * @param val The value to be displayed.
17893 * Value will be presented on the unit label following format specified with
17894 * elm_slider_unit_format_set() and on indicator with
17895 * elm_slider_indicator_format_set().
17897 * @warning The value must to be between min and max values. This values
17898 * are set by elm_slider_min_max_set().
17900 * @see elm_slider_value_get()
17901 * @see elm_slider_unit_format_set()
17902 * @see elm_slider_indicator_format_set()
17903 * @see elm_slider_min_max_set()
17907 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17910 * Get the value displayed by the spinner.
17912 * @param obj The spinner object.
17913 * @return The value displayed.
17915 * @see elm_spinner_value_set() for details.
17919 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17922 * Invert a given slider widget's displaying values order
17924 * @param obj The slider object.
17925 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17926 * @c EINA_FALSE to bring it back to default, non-inverted values.
17928 * A slider may be @b inverted, in which state it gets its
17929 * values inverted, with high vales being on the left or top and
17930 * low values on the right or bottom, as opposed to normally have
17931 * the low values on the former and high values on the latter,
17932 * respectively, for horizontal and vertical modes.
17934 * @see elm_slider_inverted_get()
17938 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17941 * Get whether a given slider widget's displaying values are
17944 * @param obj The slider object.
17945 * @return @c EINA_TRUE, if @p obj has inverted values,
17946 * @c EINA_FALSE otherwise (and on errors).
17948 * @see elm_slider_inverted_set() for more details.
17952 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17955 * Set whether to enlarge slider indicator (augmented knob) or not.
17957 * @param obj The slider object.
17958 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17959 * let the knob always at default size.
17961 * By default, indicator will be bigger while dragged by the user.
17963 * @warning It won't display values set with
17964 * elm_slider_indicator_format_set() if you disable indicator.
17968 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17971 * Get whether a given slider widget's enlarging indicator or not.
17973 * @param obj The slider object.
17974 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17975 * @c EINA_FALSE otherwise (and on errors).
17977 * @see elm_slider_indicator_show_set() for details.
17981 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17988 * @addtogroup Actionslider Actionslider
17990 * @image html img/widget/actionslider/preview-00.png
17991 * @image latex img/widget/actionslider/preview-00.eps
17993 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17994 * properties. The user drags and releases the indicator, to choose a label.
17996 * Labels occupy the following positions.
18001 * Positions can be enabled or disabled.
18003 * Magnets can be set on the above positions.
18005 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18007 * @note By default all positions are set as enabled.
18009 * Signals that you can add callbacks for are:
18011 * "selected" - when user selects an enabled position (the label is passed
18014 * "pos_changed" - when the indicator reaches any of the positions("left",
18015 * "right" or "center").
18017 * See an example of actionslider usage @ref actionslider_example_page "here"
18021 typedef enum _Elm_Actionslider_Indicator_Pos
18023 ELM_ACTIONSLIDER_INDICATOR_NONE,
18024 ELM_ACTIONSLIDER_INDICATOR_LEFT,
18025 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18026 ELM_ACTIONSLIDER_INDICATOR_CENTER
18027 } Elm_Actionslider_Indicator_Pos;
18029 typedef enum _Elm_Actionslider_Magnet_Pos
18031 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18032 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18033 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18034 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18035 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18036 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18037 } Elm_Actionslider_Magnet_Pos;
18039 typedef enum _Elm_Actionslider_Label_Pos
18041 ELM_ACTIONSLIDER_LABEL_LEFT,
18042 ELM_ACTIONSLIDER_LABEL_RIGHT,
18043 ELM_ACTIONSLIDER_LABEL_CENTER,
18044 ELM_ACTIONSLIDER_LABEL_BUTTON
18045 } Elm_Actionslider_Label_Pos;
18047 /* smart callbacks called:
18048 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18052 * Add a new actionslider to the parent.
18054 * @param parent The parent object
18055 * @return The new actionslider object or NULL if it cannot be created
18057 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18060 * Set actionslider label.
18062 * @param[in] obj The actionslider object
18063 * @param[in] pos The position of the label.
18064 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18065 * @param label The label which is going to be set.
18067 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18069 * Get actionslider labels.
18071 * @param obj The actionslider object
18072 * @param left_label A char** to place the left_label of @p obj into.
18073 * @param center_label A char** to place the center_label of @p obj into.
18074 * @param right_label A char** to place the right_label of @p obj into.
18076 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);
18078 * Get actionslider selected label.
18080 * @param obj The actionslider object
18081 * @return The selected label
18083 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18085 * Set actionslider indicator position.
18087 * @param obj The actionslider object.
18088 * @param pos The position of the indicator.
18090 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18092 * Get actionslider indicator position.
18094 * @param obj The actionslider object.
18095 * @return The position of the indicator.
18097 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18099 * Set actionslider magnet position. To make multiple positions magnets @c or
18100 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18102 * @param obj The actionslider object.
18103 * @param pos Bit mask indicating the magnet positions.
18105 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18107 * Get actionslider magnet position.
18109 * @param obj The actionslider object.
18110 * @return The positions with magnet property.
18112 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18114 * Set actionslider enabled position. To set multiple positions as enabled @c or
18115 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18117 * @note All the positions are enabled by default.
18119 * @param obj The actionslider object.
18120 * @param pos Bit mask indicating the enabled positions.
18122 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18124 * Get actionslider enabled position.
18126 * @param obj The actionslider object.
18127 * @return The enabled positions.
18129 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18131 * Set the label used on the indicator.
18133 * @param obj The actionslider object
18134 * @param label The label to be set on the indicator.
18135 * @deprecated use elm_object_text_set() instead.
18137 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18139 * Get the label used on the indicator object.
18141 * @param obj The actionslider object
18142 * @return The indicator label
18143 * @deprecated use elm_object_text_get() instead.
18145 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18148 * Hold actionslider object movement.
18150 * @param[in] obj The actionslider object
18151 * @param[in] flag Actionslider hold/release
18152 * (EINA_TURE = hold/EIN_FALSE = release)
18154 * @ingroup Actionslider
18156 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18164 * @defgroup Genlist Genlist
18166 * @image html img/widget/genlist/preview-00.png
18167 * @image latex img/widget/genlist/preview-00.eps
18168 * @image html img/genlist.png
18169 * @image latex img/genlist.eps
18171 * This widget aims to have more expansive list than the simple list in
18172 * Elementary that could have more flexible items and allow many more entries
18173 * while still being fast and low on memory usage. At the same time it was
18174 * also made to be able to do tree structures. But the price to pay is more
18175 * complexity when it comes to usage. If all you want is a simple list with
18176 * icons and a single label, use the normal @ref List object.
18178 * Genlist has a fairly large API, mostly because it's relatively complex,
18179 * trying to be both expansive, powerful and efficient. First we will begin
18180 * an overview on the theory behind genlist.
18182 * @section Genlist_Item_Class Genlist item classes - creating items
18184 * In order to have the ability to add and delete items on the fly, genlist
18185 * implements a class (callback) system where the application provides a
18186 * structure with information about that type of item (genlist may contain
18187 * multiple different items with different classes, states and styles).
18188 * Genlist will call the functions in this struct (methods) when an item is
18189 * "realized" (i.e., created dynamically, while the user is scrolling the
18190 * grid). All objects will simply be deleted when no longer needed with
18191 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18192 * following members:
18193 * - @c item_style - This is a constant string and simply defines the name
18194 * of the item style. It @b must be specified and the default should be @c
18197 * - @c func - A struct with pointers to functions that will be called when
18198 * an item is going to be actually created. All of them receive a @c data
18199 * parameter that will point to the same data passed to
18200 * elm_genlist_item_append() and related item creation functions, and a @c
18201 * obj parameter that points to the genlist object itself.
18203 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18204 * state_get and @c del. The 3 first functions also receive a @c part
18205 * parameter described below. A brief description of these functions follows:
18207 * - @c label_get - The @c part parameter is the name string of one of the
18208 * existing text parts in the Edje group implementing the item's theme.
18209 * This function @b must return a strdup'()ed string, as the caller will
18210 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18211 * - @c content_get - The @c part parameter is the name string of one of the
18212 * existing (content) swallow parts in the Edje group implementing the item's
18213 * theme. It must return @c NULL, when no content is desired, or a valid
18214 * object handle, otherwise. The object will be deleted by the genlist on
18215 * its deletion or when the item is "unrealized". See
18216 * #Elm_Genlist_Item_Content_Get_Cb.
18217 * - @c func.state_get - The @c part parameter is the name string of one of
18218 * the state parts in the Edje group implementing the item's theme. Return
18219 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18220 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18221 * and @c "elm" as "emission" and "source" arguments, respectively, when
18222 * the state is true (the default is false), where @c XXX is the name of
18223 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18224 * - @c func.del - This is intended for use when genlist items are deleted,
18225 * so any data attached to the item (e.g. its data parameter on creation)
18226 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18228 * available item styles:
18230 * - default_style - The text part is a textblock
18232 * @image html img/widget/genlist/preview-04.png
18233 * @image latex img/widget/genlist/preview-04.eps
18237 * @image html img/widget/genlist/preview-01.png
18238 * @image latex img/widget/genlist/preview-01.eps
18240 * - icon_top_text_bottom
18242 * @image html img/widget/genlist/preview-02.png
18243 * @image latex img/widget/genlist/preview-02.eps
18247 * @image html img/widget/genlist/preview-03.png
18248 * @image latex img/widget/genlist/preview-03.eps
18250 * @section Genlist_Items Structure of items
18252 * An item in a genlist can have 0 or more text labels (they can be regular
18253 * text or textblock Evas objects - that's up to the style to determine), 0
18254 * or more contents (which are simply objects swallowed into the genlist item's
18255 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18256 * behavior left to the user to define. The Edje part names for each of
18257 * these properties will be looked up, in the theme file for the genlist,
18258 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18259 * "states", respectively. For each of those properties, if more than one
18260 * part is provided, they must have names listed separated by spaces in the
18261 * data fields. For the default genlist item theme, we have @b one label
18262 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18263 * "elm.swallow.end") and @b no state parts.
18265 * A genlist item may be at one of several styles. Elementary provides one
18266 * by default - "default", but this can be extended by system or application
18267 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18270 * @section Genlist_Manipulation Editing and Navigating
18272 * Items can be added by several calls. All of them return a @ref
18273 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18274 * They all take a data parameter that is meant to be used for a handle to
18275 * the applications internal data (eg the struct with the original item
18276 * data). The parent parameter is the parent genlist item this belongs to if
18277 * it is a tree or an indexed group, and NULL if there is no parent. The
18278 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18279 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18280 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18281 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18282 * is set then this item is group index item that is displayed at the top
18283 * until the next group comes. The func parameter is a convenience callback
18284 * that is called when the item is selected and the data parameter will be
18285 * the func_data parameter, obj be the genlist object and event_info will be
18286 * the genlist item.
18288 * elm_genlist_item_append() adds an item to the end of the list, or if
18289 * there is a parent, to the end of all the child items of the parent.
18290 * elm_genlist_item_prepend() is the same but adds to the beginning of
18291 * the list or children list. elm_genlist_item_insert_before() inserts at
18292 * item before another item and elm_genlist_item_insert_after() inserts after
18293 * the indicated item.
18295 * The application can clear the list with elm_gen_clear() which deletes
18296 * all the items in the list and elm_genlist_item_del() will delete a specific
18297 * item. elm_genlist_item_subitems_clear() will clear all items that are
18298 * children of the indicated parent item.
18300 * To help inspect list items you can jump to the item at the top of the list
18301 * with elm_genlist_first_item_get() which will return the item pointer, and
18302 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18303 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18304 * and previous items respectively relative to the indicated item. Using
18305 * these calls you can walk the entire item list/tree. Note that as a tree
18306 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18307 * let you know which item is the parent (and thus know how to skip them if
18310 * @section Genlist_Muti_Selection Multi-selection
18312 * If the application wants multiple items to be able to be selected,
18313 * elm_genlist_multi_select_set() can enable this. If the list is
18314 * single-selection only (the default), then elm_genlist_selected_item_get()
18315 * will return the selected item, if any, or NULL if none is selected. If the
18316 * list is multi-select then elm_genlist_selected_items_get() will return a
18317 * list (that is only valid as long as no items are modified (added, deleted,
18318 * selected or unselected)).
18320 * @section Genlist_Usage_Hints Usage hints
18322 * There are also convenience functions. elm_gen_item_genlist_get() will
18323 * return the genlist object the item belongs to. elm_genlist_item_show()
18324 * will make the scroller scroll to show that specific item so its visible.
18325 * elm_genlist_item_data_get() returns the data pointer set by the item
18326 * creation functions.
18328 * If an item changes (state of boolean changes, label or contents change),
18329 * then use elm_genlist_item_update() to have genlist update the item with
18330 * the new state. Genlist will re-realize the item thus call the functions
18331 * in the _Elm_Genlist_Item_Class for that item.
18333 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18334 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18335 * to expand/contract an item and get its expanded state, use
18336 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18337 * again to make an item disabled (unable to be selected and appear
18338 * differently) use elm_genlist_item_disabled_set() to set this and
18339 * elm_genlist_item_disabled_get() to get the disabled state.
18341 * In general to indicate how the genlist should expand items horizontally to
18342 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18343 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18344 * mode means that if items are too wide to fit, the scroller will scroll
18345 * horizontally. Otherwise items are expanded to fill the width of the
18346 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18347 * to the viewport width and limited to that size. This can be combined with
18348 * a different style that uses edjes' ellipsis feature (cutting text off like
18351 * Items will only call their selection func and callback when first becoming
18352 * selected. Any further clicks will do nothing, unless you enable always
18353 * select with elm_gen_always_select_mode_set(). This means even if
18354 * selected, every click will make the selected callbacks be called.
18355 * elm_genlist_no_select_mode_set() will turn off the ability to select
18356 * items entirely and they will neither appear selected nor call selected
18357 * callback functions.
18359 * Remember that you can create new styles and add your own theme augmentation
18360 * per application with elm_theme_extension_add(). If you absolutely must
18361 * have a specific style that overrides any theme the user or system sets up
18362 * you can use elm_theme_overlay_add() to add such a file.
18364 * @section Genlist_Implementation Implementation
18366 * Evas tracks every object you create. Every time it processes an event
18367 * (mouse move, down, up etc.) it needs to walk through objects and find out
18368 * what event that affects. Even worse every time it renders display updates,
18369 * in order to just calculate what to re-draw, it needs to walk through many
18370 * many many objects. Thus, the more objects you keep active, the more
18371 * overhead Evas has in just doing its work. It is advisable to keep your
18372 * active objects to the minimum working set you need. Also remember that
18373 * object creation and deletion carries an overhead, so there is a
18374 * middle-ground, which is not easily determined. But don't keep massive lists
18375 * of objects you can't see or use. Genlist does this with list objects. It
18376 * creates and destroys them dynamically as you scroll around. It groups them
18377 * into blocks so it can determine the visibility etc. of a whole block at
18378 * once as opposed to having to walk the whole list. This 2-level list allows
18379 * for very large numbers of items to be in the list (tests have used up to
18380 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18381 * may be different sizes, every item added needs to be calculated as to its
18382 * size and thus this presents a lot of overhead on populating the list, this
18383 * genlist employs a queue. Any item added is queued and spooled off over
18384 * time, actually appearing some time later, so if your list has many members
18385 * you may find it takes a while for them to all appear, with your process
18386 * consuming a lot of CPU while it is busy spooling.
18388 * Genlist also implements a tree structure, but it does so with callbacks to
18389 * the application, with the application filling in tree structures when
18390 * requested (allowing for efficient building of a very deep tree that could
18391 * even be used for file-management). See the above smart signal callbacks for
18394 * @section Genlist_Smart_Events Genlist smart events
18396 * Signals that you can add callbacks for are:
18397 * - @c "activated" - The user has double-clicked or pressed
18398 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18399 * item that was activated.
18400 * - @c "clicked,double" - The user has double-clicked an item. The @c
18401 * event_info parameter is the item that was double-clicked.
18402 * - @c "selected" - This is called when a user has made an item selected.
18403 * The event_info parameter is the genlist item that was selected.
18404 * - @c "unselected" - This is called when a user has made an item
18405 * unselected. The event_info parameter is the genlist item that was
18407 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18408 * called and the item is now meant to be expanded. The event_info
18409 * parameter is the genlist item that was indicated to expand. It is the
18410 * job of this callback to then fill in the child items.
18411 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18412 * called and the item is now meant to be contracted. The event_info
18413 * parameter is the genlist item that was indicated to contract. It is the
18414 * job of this callback to then delete the child items.
18415 * - @c "expand,request" - This is called when a user has indicated they want
18416 * to expand a tree branch item. The callback should decide if the item can
18417 * expand (has any children) and then call elm_genlist_item_expanded_set()
18418 * appropriately to set the state. The event_info parameter is the genlist
18419 * item that was indicated to expand.
18420 * - @c "contract,request" - This is called when a user has indicated they
18421 * want to contract a tree branch item. The callback should decide if the
18422 * item can contract (has any children) and then call
18423 * elm_genlist_item_expanded_set() appropriately to set the state. The
18424 * event_info parameter is the genlist item that was indicated to contract.
18425 * - @c "realized" - This is called when the item in the list is created as a
18426 * real evas object. event_info parameter is the genlist item that was
18427 * created. The object may be deleted at any time, so it is up to the
18428 * caller to not use the object pointer from elm_genlist_item_object_get()
18429 * in a way where it may point to freed objects.
18430 * - @c "unrealized" - This is called just before an item is unrealized.
18431 * After this call content objects provided will be deleted and the item
18432 * object itself delete or be put into a floating cache.
18433 * - @c "drag,start,up" - This is called when the item in the list has been
18434 * dragged (not scrolled) up.
18435 * - @c "drag,start,down" - This is called when the item in the list has been
18436 * dragged (not scrolled) down.
18437 * - @c "drag,start,left" - This is called when the item in the list has been
18438 * dragged (not scrolled) left.
18439 * - @c "drag,start,right" - This is called when the item in the list has
18440 * been dragged (not scrolled) right.
18441 * - @c "drag,stop" - This is called when the item in the list has stopped
18443 * - @c "drag" - This is called when the item in the list is being dragged.
18444 * - @c "longpressed" - This is called when the item is pressed for a certain
18445 * amount of time. By default it's 1 second.
18446 * - @c "scroll,anim,start" - This is called when scrolling animation has
18448 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18450 * - @c "scroll,drag,start" - This is called when dragging the content has
18452 * - @c "scroll,drag,stop" - This is called when dragging the content has
18454 * - @c "edge,top" - This is called when the genlist is scrolled until
18456 * - @c "edge,bottom" - This is called when the genlist is scrolled
18457 * until the bottom edge.
18458 * - @c "edge,left" - This is called when the genlist is scrolled
18459 * until the left edge.
18460 * - @c "edge,right" - This is called when the genlist is scrolled
18461 * until the right edge.
18462 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18464 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18466 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18468 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18470 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18471 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18472 * multi-touch pinched in.
18473 * - @c "swipe" - This is called when the genlist is swiped.
18474 * - @c "moved" - This is called when a genlist item is moved.
18475 * - @c "language,changed" - This is called when the program's language is
18478 * @section Genlist_Examples Examples
18480 * Here is a list of examples that use the genlist, trying to show some of
18481 * its capabilities:
18482 * - @ref genlist_example_01
18483 * - @ref genlist_example_02
18484 * - @ref genlist_example_03
18485 * - @ref genlist_example_04
18486 * - @ref genlist_example_05
18490 * @addtogroup Genlist
18495 * @enum _Elm_Genlist_Item_Flags
18496 * @typedef Elm_Genlist_Item_Flags
18498 * Defines if the item is of any special type (has subitems or it's the
18499 * index of a group), or is just a simple item.
18503 typedef enum _Elm_Genlist_Item_Flags
18505 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18506 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18507 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18508 } Elm_Genlist_Item_Flags;
18509 typedef enum _Elm_Genlist_Item_Field_Flags
18511 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18512 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18513 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18514 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18515 } Elm_Genlist_Item_Field_Flags;
18516 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18517 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18518 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18519 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18520 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
18521 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18522 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
18523 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18526 * @struct _Elm_Genlist_Item_Class
18528 * Genlist item class definition structs.
18530 * This struct contains the style and fetching functions that will define the
18531 * contents of each item.
18533 * @see @ref Genlist_Item_Class
18535 struct _Elm_Genlist_Item_Class
18537 const char *item_style;
18539 GenlistItemLabelGetFunc label_get;
18540 GenlistItemIconGetFunc icon_get;
18541 GenlistItemStateGetFunc state_get;
18542 GenlistItemDelFunc del;
18543 GenlistItemMovedFunc moved;
18545 const char *edit_item_style;
18546 const char *mode_item_style;
18548 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18550 * Add a new genlist widget to the given parent Elementary
18551 * (container) object
18553 * @param parent The parent object
18554 * @return a new genlist widget handle or @c NULL, on errors
18556 * This function inserts a new genlist widget on the canvas.
18558 * @see elm_genlist_item_append()
18559 * @see elm_genlist_item_del()
18560 * @see elm_gen_clear()
18564 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18566 * Remove all items from a given genlist widget.
18568 * @param obj The genlist object
18570 * This removes (and deletes) all items in @p obj, leaving it empty.
18572 * This is deprecated. Please use elm_gen_clear() instead.
18574 * @see elm_genlist_item_del(), to remove just one item.
18578 WILL_DEPRECATE EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18580 * Enable or disable multi-selection in the genlist
18582 * @param obj The genlist object
18583 * @param multi Multi-select enable/disable. Default is disabled.
18585 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18586 * the list. This allows more than 1 item to be selected. To retrieve the list
18587 * of selected items, use elm_genlist_selected_items_get().
18589 * @see elm_genlist_selected_items_get()
18590 * @see elm_genlist_multi_select_get()
18594 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18596 * Gets if multi-selection in genlist is enabled or disabled.
18598 * @param obj The genlist object
18599 * @return Multi-select enabled/disabled
18600 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18602 * @see elm_genlist_multi_select_set()
18606 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18608 * This sets the horizontal stretching mode.
18610 * @param obj The genlist object
18611 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18613 * This sets the mode used for sizing items horizontally. Valid modes
18614 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18615 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18616 * the scroller will scroll horizontally. Otherwise items are expanded
18617 * to fill the width of the viewport of the scroller. If it is
18618 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18619 * limited to that size.
18621 * @see elm_genlist_horizontal_get()
18625 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18627 * Gets the horizontal stretching mode.
18629 * @param obj The genlist object
18630 * @return The mode to use
18631 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18633 * @see elm_genlist_horizontal_set()
18637 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18639 * Set the always select mode.
18641 * @param obj The genlist object
18642 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18643 * EINA_FALSE = off). Default is @c EINA_FALSE.
18645 * Items will only call their selection func and callback when first
18646 * becoming selected. Any further clicks will do nothing, unless you
18647 * enable always select with elm_gen_always_select_mode_set().
18648 * This means that, even if selected, every click will make the selected
18649 * callbacks be called.
18651 * This function is deprecated. please see elm_gen_always_select_mode_set()
18653 * @see elm_genlist_always_select_mode_get()
18657 WILL_DEPRECATE EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18659 * Get the always select mode.
18661 * @param obj The genlist object
18662 * @return The always select mode
18663 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18665 * @see elm_genlist_always_select_mode_set()
18669 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18671 * Enable/disable the no select mode.
18673 * @param obj The genlist object
18674 * @param no_select The no select mode
18675 * (EINA_TRUE = on, EINA_FALSE = off)
18677 * This will turn off the ability to select items entirely and they
18678 * will neither appear selected nor call selected callback functions.
18680 * @see elm_genlist_no_select_mode_get()
18684 WILL_DEPRECATE EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18686 * Gets whether the no select mode is enabled.
18688 * @param obj The genlist object
18689 * @return The no select mode
18690 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18692 * @see elm_genlist_no_select_mode_set()
18696 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18698 * Enable/disable compress mode.
18700 * @param obj The genlist object
18701 * @param compress The compress mode
18702 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18704 * This will enable the compress mode where items are "compressed"
18705 * horizontally to fit the genlist scrollable viewport width. This is
18706 * special for genlist. Do not rely on
18707 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18708 * work as genlist needs to handle it specially.
18710 * @see elm_genlist_compress_mode_get()
18714 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18716 * Get whether the compress mode is enabled.
18718 * @param obj The genlist object
18719 * @return The compress mode
18720 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18722 * @see elm_genlist_compress_mode_set()
18726 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18728 * Enable/disable height-for-width mode.
18730 * @param obj The genlist object
18731 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18732 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18734 * With height-for-width mode the item width will be fixed (restricted
18735 * to a minimum of) to the list width when calculating its size in
18736 * order to allow the height to be calculated based on it. This allows,
18737 * for instance, text block to wrap lines if the Edje part is
18738 * configured with "text.min: 0 1".
18740 * @note This mode will make list resize slower as it will have to
18741 * recalculate every item height again whenever the list width
18744 * @note When height-for-width mode is enabled, it also enables
18745 * compress mode (see elm_genlist_compress_mode_set()) and
18746 * disables homogeneous (see elm_genlist_homogeneous_set()).
18750 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18752 * Get whether the height-for-width mode is enabled.
18754 * @param obj The genlist object
18755 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18760 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18762 * Enable/disable horizontal and vertical bouncing effect.
18764 * @param obj The genlist object
18765 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18766 * EINA_FALSE = off). Default is @c EINA_FALSE.
18767 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18768 * EINA_FALSE = off). Default is @c EINA_TRUE.
18770 * This will enable or disable the scroller bouncing effect for the
18771 * genlist. See elm_scroller_bounce_set() for details.
18773 * @see elm_scroller_bounce_set()
18774 * @see elm_genlist_bounce_get()
18778 WILL_DEPRECATE EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18780 * Get whether the horizontal and vertical bouncing effect is enabled.
18782 * @param obj The genlist object
18783 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18785 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18788 * @see elm_genlist_bounce_set()
18792 WILL_DEPRECATE EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18794 * Enable/disable homogenous mode.
18796 * @param obj The genlist object
18797 * @param homogeneous Assume the items within the genlist are of the
18798 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18801 * This will enable the homogeneous mode where items are of the same
18802 * height and width so that genlist may do the lazy-loading at its
18803 * maximum (which increases the performance for scrolling the list). This
18804 * implies 'compressed' mode.
18806 * @see elm_genlist_compress_mode_set()
18807 * @see elm_genlist_homogeneous_get()
18811 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18813 * Get whether the homogenous mode is enabled.
18815 * @param obj The genlist object
18816 * @return Assume the items within the genlist are of the same height
18817 * and width (EINA_TRUE = on, EINA_FALSE = off)
18819 * @see elm_genlist_homogeneous_set()
18823 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18825 * Set the maximum number of items within an item block
18827 * @param obj The genlist object
18828 * @param n Maximum number of items within an item block. Default is 32.
18830 * This will configure the block count to tune to the target with
18831 * particular performance matrix.
18833 * A block of objects will be used to reduce the number of operations due to
18834 * many objects in the screen. It can determine the visibility, or if the
18835 * object has changed, it theme needs to be updated, etc. doing this kind of
18836 * calculation to the entire block, instead of per object.
18838 * The default value for the block count is enough for most lists, so unless
18839 * you know you will have a lot of objects visible in the screen at the same
18840 * time, don't try to change this.
18842 * @see elm_genlist_block_count_get()
18843 * @see @ref Genlist_Implementation
18847 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18849 * Get the maximum number of items within an item block
18851 * @param obj The genlist object
18852 * @return Maximum number of items within an item block
18854 * @see elm_genlist_block_count_set()
18858 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18860 * Set the timeout in seconds for the longpress event.
18862 * @param obj The genlist object
18863 * @param timeout timeout in seconds. Default is 1.
18865 * This option will change how long it takes to send an event "longpressed"
18866 * after the mouse down signal is sent to the list. If this event occurs, no
18867 * "clicked" event will be sent.
18869 * @see elm_genlist_longpress_timeout_set()
18873 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18875 * Get the timeout in seconds for the longpress event.
18877 * @param obj The genlist object
18878 * @return timeout in seconds
18880 * @see elm_genlist_longpress_timeout_get()
18884 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18886 * Append a new item in a given genlist widget.
18888 * @param obj The genlist object
18889 * @param itc The item class for the item
18890 * @param data The item data
18891 * @param parent The parent item, or NULL if none
18892 * @param flags Item flags
18893 * @param func Convenience function called when the item is selected
18894 * @param func_data Data passed to @p func above.
18895 * @return A handle to the item added or @c NULL if not possible
18897 * This adds the given item to the end of the list or the end of
18898 * the children list if the @p parent is given.
18900 * @see elm_genlist_item_prepend()
18901 * @see elm_genlist_item_insert_before()
18902 * @see elm_genlist_item_insert_after()
18903 * @see elm_genlist_item_del()
18907 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);
18909 * Prepend a new item in a given genlist widget.
18911 * @param obj The genlist object
18912 * @param itc The item class for the item
18913 * @param data The item data
18914 * @param parent The parent item, or NULL if none
18915 * @param flags Item flags
18916 * @param func Convenience function called when the item is selected
18917 * @param func_data Data passed to @p func above.
18918 * @return A handle to the item added or NULL if not possible
18920 * This adds an item to the beginning of the list or beginning of the
18921 * children of the parent if given.
18923 * @see elm_genlist_item_append()
18924 * @see elm_genlist_item_insert_before()
18925 * @see elm_genlist_item_insert_after()
18926 * @see elm_genlist_item_del()
18930 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);
18932 * Insert an item before another in a genlist widget
18934 * @param obj The genlist object
18935 * @param itc The item class for the item
18936 * @param data The item data
18937 * @param before The item to place this new one before.
18938 * @param flags Item flags
18939 * @param func Convenience function called when the item is selected
18940 * @param func_data Data passed to @p func above.
18941 * @return A handle to the item added or @c NULL if not possible
18943 * This inserts an item before another in the list. It will be in the
18944 * same tree level or group as the item it is inserted before.
18946 * @see elm_genlist_item_append()
18947 * @see elm_genlist_item_prepend()
18948 * @see elm_genlist_item_insert_after()
18949 * @see elm_genlist_item_del()
18953 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);
18955 * Insert an item after another in a genlist widget
18957 * @param obj The genlist object
18958 * @param itc The item class for the item
18959 * @param data The item data
18960 * @param after The item to place this new one after.
18961 * @param flags Item flags
18962 * @param func Convenience function called when the item is selected
18963 * @param func_data Data passed to @p func above.
18964 * @return A handle to the item added or @c NULL if not possible
18966 * This inserts an item after another in the list. It will be in the
18967 * same tree level or group as the item it is inserted after.
18969 * @see elm_genlist_item_append()
18970 * @see elm_genlist_item_prepend()
18971 * @see elm_genlist_item_insert_before()
18972 * @see elm_genlist_item_del()
18976 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);
18978 * Insert a new item into the sorted genlist object
18980 * @param obj The genlist object
18981 * @param itc The item class for the item
18982 * @param data The item data
18983 * @param parent The parent item, or NULL if none
18984 * @param flags Item flags
18985 * @param comp The function called for the sort
18986 * @param func Convenience function called when item selected
18987 * @param func_data Data passed to @p func above.
18988 * @return A handle to the item added or NULL if not possible
18992 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);
18993 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);
18994 /* operations to retrieve existing items */
18996 * Get the selectd item in the genlist.
18998 * @param obj The genlist object
18999 * @return The selected item, or NULL if none is selected.
19001 * This gets the selected item in the list (if multi-selection is enabled, only
19002 * the item that was first selected in the list is returned - which is not very
19003 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19006 * If no item is selected, NULL is returned.
19008 * @see elm_genlist_selected_items_get()
19012 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19014 * Get a list of selected items in the genlist.
19016 * @param obj The genlist object
19017 * @return The list of selected items, or NULL if none are selected.
19019 * It returns a list of the selected items. This list pointer is only valid so
19020 * long as the selection doesn't change (no items are selected or unselected, or
19021 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19022 * pointers. The order of the items in this list is the order which they were
19023 * selected, i.e. the first item in this list is the first item that was
19024 * selected, and so on.
19026 * @note If not in multi-select mode, consider using function
19027 * elm_genlist_selected_item_get() instead.
19029 * @see elm_genlist_multi_select_set()
19030 * @see elm_genlist_selected_item_get()
19034 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19036 * Get the mode item style of items in the genlist
19037 * @param obj The genlist object
19038 * @return The mode item style string, or NULL if none is specified
19040 * This is a constant string and simply defines the name of the
19041 * style that will be used for mode animations. It can be
19042 * @c NULL if you don't plan to use Genlist mode. See
19043 * elm_genlist_item_mode_set() for more info.
19047 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19049 * Set the mode item style of items in the genlist
19050 * @param obj The genlist object
19051 * @param style The mode item style string, or NULL if none is desired
19053 * This is a constant string and simply defines the name of the
19054 * style that will be used for mode animations. It can be
19055 * @c NULL if you don't plan to use Genlist mode. See
19056 * elm_genlist_item_mode_set() for more info.
19060 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19062 * Get a list of realized items in genlist
19064 * @param obj The genlist object
19065 * @return The list of realized items, nor NULL if none are realized.
19067 * This returns a list of the realized items in the genlist. The list
19068 * contains Elm_Genlist_Item pointers. The list must be freed by the
19069 * caller when done with eina_list_free(). The item pointers in the
19070 * list are only valid so long as those items are not deleted or the
19071 * genlist is not deleted.
19073 * @see elm_genlist_realized_items_update()
19077 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19079 * Get the item that is at the x, y canvas coords.
19081 * @param obj The gelinst object.
19082 * @param x The input x coordinate
19083 * @param y The input y coordinate
19084 * @param posret The position relative to the item returned here
19085 * @return The item at the coordinates or NULL if none
19087 * This returns the item at the given coordinates (which are canvas
19088 * relative, not object-relative). If an item is at that coordinate,
19089 * that item handle is returned, and if @p posret is not NULL, the
19090 * integer pointed to is set to a value of -1, 0 or 1, depending if
19091 * the coordinate is on the upper portion of that item (-1), on the
19092 * middle section (0) or on the lower part (1). If NULL is returned as
19093 * an item (no item found there), then posret may indicate -1 or 1
19094 * based if the coordinate is above or below all items respectively in
19099 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);
19101 * Get the first item in the genlist
19103 * This returns the first item in the list.
19105 * @param obj The genlist object
19106 * @return The first item, or NULL if none
19110 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19112 * Get the last item in the genlist
19114 * This returns the last item in the list.
19116 * @return The last item, or NULL if none
19120 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19122 * Set the scrollbar policy
19124 * @param obj The genlist object
19125 * @param policy_h Horizontal scrollbar policy.
19126 * @param policy_v Vertical scrollbar policy.
19128 * This sets the scrollbar visibility policy for the given genlist
19129 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19130 * made visible if it is needed, and otherwise kept hidden.
19131 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19132 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19133 * respectively for the horizontal and vertical scrollbars. Default is
19134 * #ELM_SMART_SCROLLER_POLICY_AUTO
19136 * @see elm_genlist_scroller_policy_get()
19140 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19142 * Get the scrollbar policy
19144 * @param obj The genlist object
19145 * @param policy_h Pointer to store the horizontal scrollbar policy.
19146 * @param policy_v Pointer to store the vertical scrollbar policy.
19148 * @see elm_genlist_scroller_policy_set()
19152 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);
19154 * Get the @b next item in a genlist widget's internal list of items,
19155 * given a handle to one of those items.
19157 * @param item The genlist item to fetch next from
19158 * @return The item after @p item, or @c NULL if there's none (and
19161 * This returns the item placed after the @p item, on the container
19164 * @see elm_genlist_item_prev_get()
19168 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19170 * Get the @b previous item in a genlist widget's internal list of items,
19171 * given a handle to one of those items.
19173 * @param item The genlist item to fetch previous from
19174 * @return The item before @p item, or @c NULL if there's none (and
19177 * This returns the item placed before the @p item, on the container
19180 * @see elm_genlist_item_next_get()
19184 WILL_DEPRECATE EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19186 * Get the genlist object's handle which contains a given genlist
19189 * @param item The item to fetch the container from
19190 * @return The genlist (parent) object
19192 * This returns the genlist object itself that an item belongs to.
19194 * This function is deprecated. Please use elm_gen_item_widget_get()
19198 WILL_DEPRECATE EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19200 * Get the parent item of the given item
19202 * @param it The item
19203 * @return The parent of the item or @c NULL if it has no parent.
19205 * This returns the item that was specified as parent of the item @p it on
19206 * elm_genlist_item_append() and insertion related functions.
19210 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19212 * Remove all sub-items (children) of the given item
19214 * @param it The item
19216 * This removes all items that are children (and their descendants) of the
19217 * given item @p it.
19219 * @see elm_genlist_clear()
19220 * @see elm_genlist_item_del()
19224 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19226 * Set whether a given genlist item is selected or not
19228 * @param it The item
19229 * @param selected Use @c EINA_TRUE, to make it selected, @c
19230 * EINA_FALSE to make it unselected
19232 * This sets the selected state of an item. If multi selection is
19233 * not enabled on the containing genlist and @p selected is @c
19234 * EINA_TRUE, any other previously selected items will get
19235 * unselected in favor of this new one.
19237 * @see elm_genlist_item_selected_get()
19241 WILL_DEPRECATE EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19243 * Get whether a given genlist item is selected or not
19245 * @param it The item
19246 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19248 * @see elm_genlist_item_selected_set() for more details
19252 WILL_DEPRECATE EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19254 * Sets the expanded state of an item.
19256 * @param it The item
19257 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19259 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19262 * The theme will respond to this change visually, and a signal "expanded" or
19263 * "contracted" will be sent from the genlist with a pointer to the item that
19264 * has been expanded/contracted.
19266 * Calling this function won't show or hide any child of this item (if it is
19267 * a parent). You must manually delete and create them on the callbacks fo
19268 * the "expanded" or "contracted" signals.
19270 * @see elm_genlist_item_expanded_get()
19274 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19276 * Get the expanded state of an item
19278 * @param it The item
19279 * @return The expanded state
19281 * This gets the expanded state of an item.
19283 * @see elm_genlist_item_expanded_set()
19287 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19289 * Get the depth of expanded item
19291 * @param it The genlist item object
19292 * @return The depth of expanded item
19296 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19298 * Set whether a given genlist item is disabled or not.
19300 * @param it The item
19301 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19302 * to enable it back.
19304 * A disabled item cannot be selected or unselected. It will also
19305 * change its appearance, to signal the user it's disabled.
19307 * @see elm_genlist_item_disabled_get()
19311 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19313 * Get whether a given genlist item is disabled or not.
19315 * @param it The item
19316 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19319 * @see elm_genlist_item_disabled_set() for more details
19323 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19325 * Sets the display only state of an item.
19327 * @param it The item
19328 * @param display_only @c EINA_TRUE if the item is display only, @c
19329 * EINA_FALSE otherwise.
19331 * A display only item cannot be selected or unselected. It is for
19332 * display only and not selecting or otherwise clicking, dragging
19333 * etc. by the user, thus finger size rules will not be applied to
19336 * It's good to set group index items to display only state.
19338 * @see elm_genlist_item_display_only_get()
19342 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19344 * Get the display only state of an item
19346 * @param it The item
19347 * @return @c EINA_TRUE if the item is display only, @c
19348 * EINA_FALSE otherwise.
19350 * @see elm_genlist_item_display_only_set()
19354 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19356 * Show the portion of a genlist's internal list containing a given
19357 * item, immediately.
19359 * @param it The item to display
19361 * This causes genlist to jump to the given item @p it and show it (by
19362 * immediately scrolling to that position), if it is not fully visible.
19364 * @see elm_genlist_item_bring_in()
19365 * @see elm_genlist_item_top_show()
19366 * @see elm_genlist_item_middle_show()
19370 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19372 * Animatedly bring in, to the visible are of a genlist, a given
19375 * @param it The item to display
19377 * This causes genlist to jump to the given item @p it and show it (by
19378 * animatedly scrolling), if it is not fully visible. This may use animation
19379 * to do so and take a period of time
19381 * @see elm_genlist_item_show()
19382 * @see elm_genlist_item_top_bring_in()
19383 * @see elm_genlist_item_middle_bring_in()
19387 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19389 * Show the portion of a genlist's internal list containing a given
19390 * item, immediately.
19392 * @param it The item to display
19394 * This causes genlist to jump to the given item @p it and show it (by
19395 * immediately scrolling to that position), if it is not fully visible.
19397 * The item will be positioned at the top of the genlist viewport.
19399 * @see elm_genlist_item_show()
19400 * @see elm_genlist_item_top_bring_in()
19404 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19406 * Animatedly bring in, to the visible are of a genlist, a given
19409 * @param it The item
19411 * This causes genlist to jump to the given item @p it and show it (by
19412 * animatedly scrolling), if it is not fully visible. This may use animation
19413 * to do so and take a period of time
19415 * The item will be positioned at the top of the genlist viewport.
19417 * @see elm_genlist_item_bring_in()
19418 * @see elm_genlist_item_top_show()
19422 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19424 * Show the portion of a genlist's internal list containing a given
19425 * item, immediately.
19427 * @param it The item to display
19429 * This causes genlist to jump to the given item @p it and show it (by
19430 * immediately scrolling to that position), if it is not fully visible.
19432 * The item will be positioned at the middle of the genlist viewport.
19434 * @see elm_genlist_item_show()
19435 * @see elm_genlist_item_middle_bring_in()
19439 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19441 * Animatedly bring in, to the visible are of a genlist, a given
19444 * @param it The item
19446 * This causes genlist to jump to the given item @p it and show it (by
19447 * animatedly scrolling), if it is not fully visible. This may use animation
19448 * to do so and take a period of time
19450 * The item will be positioned at the middle of the genlist viewport.
19452 * @see elm_genlist_item_bring_in()
19453 * @see elm_genlist_item_middle_show()
19457 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19459 * Remove a genlist item from the its parent, deleting it.
19461 * @param item The item to be removed.
19462 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19464 * @see elm_genlist_clear(), to remove all items in a genlist at
19469 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19471 * Return the data associated to a given genlist item
19473 * @param item The genlist item.
19474 * @return the data associated to this item.
19476 * This returns the @c data value passed on the
19477 * elm_genlist_item_append() and related item addition calls.
19479 * @see elm_genlist_item_append()
19480 * @see elm_genlist_item_data_set()
19484 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19486 * Set the data associated to a given genlist item
19488 * @param item The genlist item
19489 * @param data The new data pointer to set on it
19491 * This @b overrides the @c data value passed on the
19492 * elm_genlist_item_append() and related item addition calls. This
19493 * function @b won't call elm_genlist_item_update() automatically,
19494 * so you'd issue it afterwards if you want to hove the item
19495 * updated to reflect the that new data.
19497 * @see elm_genlist_item_data_get()
19501 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19503 * Tells genlist to "orphan" icons fetchs by the item class
19505 * @param it The item
19507 * This instructs genlist to release references to icons in the item,
19508 * meaning that they will no longer be managed by genlist and are
19509 * floating "orphans" that can be re-used elsewhere if the user wants
19514 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19515 WILL_DEPRECATE EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19517 * Get the real Evas object created to implement the view of a
19518 * given genlist item
19520 * @param item The genlist item.
19521 * @return the Evas object implementing this item's view.
19523 * This returns the actual Evas object used to implement the
19524 * specified genlist item's view. This may be @c NULL, as it may
19525 * not have been created or may have been deleted, at any time, by
19526 * the genlist. <b>Do not modify this object</b> (move, resize,
19527 * show, hide, etc.), as the genlist is controlling it. This
19528 * function is for querying, emitting custom signals or hooking
19529 * lower level callbacks for events on that object. Do not delete
19530 * this object under any circumstances.
19532 * @see elm_genlist_item_data_get()
19536 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19538 * Update the contents of an item
19540 * @param it The item
19542 * This updates an item by calling all the item class functions again
19543 * to get the icons, labels and states. Use this when the original
19544 * item data has changed and the changes are desired to be reflected.
19546 * Use elm_genlist_realized_items_update() to update all already realized
19549 * @see elm_genlist_realized_items_update()
19553 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19554 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19556 * Update the item class of an item
19558 * @param it The item
19559 * @param itc The item class for the item
19561 * This sets another class fo the item, changing the way that it is
19562 * displayed. After changing the item class, elm_genlist_item_update() is
19563 * called on the item @p it.
19567 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19568 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19570 * Set the text to be shown in a given genlist item's tooltips.
19572 * @param item The genlist item
19573 * @param text The text to set in the content
19575 * This call will setup the text to be used as tooltip to that item
19576 * (analogous to elm_object_tooltip_text_set(), but being item
19577 * tooltips with higher precedence than object tooltips). It can
19578 * have only one tooltip at a time, so any previous tooltip data
19579 * will get removed.
19581 * In order to set an icon or something else as a tooltip, look at
19582 * elm_genlist_item_tooltip_content_cb_set().
19586 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19588 * Set the content to be shown in a given genlist item's tooltips
19590 * @param item The genlist item.
19591 * @param func The function returning the tooltip contents.
19592 * @param data What to provide to @a func as callback data/context.
19593 * @param del_cb Called when data is not needed anymore, either when
19594 * another callback replaces @p func, the tooltip is unset with
19595 * elm_genlist_item_tooltip_unset() or the owner @p item
19596 * dies. This callback receives as its first parameter the
19597 * given @p data, being @c event_info the item handle.
19599 * This call will setup the tooltip's contents to @p item
19600 * (analogous to elm_object_tooltip_content_cb_set(), but being
19601 * item tooltips with higher precedence than object tooltips). It
19602 * can have only one tooltip at a time, so any previous tooltip
19603 * content will get removed. @p func (with @p data) will be called
19604 * every time Elementary needs to show the tooltip and it should
19605 * return a valid Evas object, which will be fully managed by the
19606 * tooltip system, getting deleted when the tooltip is gone.
19608 * In order to set just a text as a tooltip, look at
19609 * elm_genlist_item_tooltip_text_set().
19613 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);
19615 * Unset a tooltip from a given genlist item
19617 * @param item genlist item to remove a previously set tooltip from.
19619 * This call removes any tooltip set on @p item. The callback
19620 * provided as @c del_cb to
19621 * elm_genlist_item_tooltip_content_cb_set() will be called to
19622 * notify it is not used anymore (and have resources cleaned, if
19625 * @see elm_genlist_item_tooltip_content_cb_set()
19629 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19631 * Set a different @b style for a given genlist item's tooltip.
19633 * @param item genlist item with tooltip set
19634 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19635 * "default", @c "transparent", etc)
19637 * Tooltips can have <b>alternate styles</b> to be displayed on,
19638 * which are defined by the theme set on Elementary. This function
19639 * works analogously as elm_object_tooltip_style_set(), but here
19640 * applied only to genlist item objects. The default style for
19641 * tooltips is @c "default".
19643 * @note before you set a style you should define a tooltip with
19644 * elm_genlist_item_tooltip_content_cb_set() or
19645 * elm_genlist_item_tooltip_text_set()
19647 * @see elm_genlist_item_tooltip_style_get()
19651 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19653 * Get the style set a given genlist item's tooltip.
19655 * @param item genlist item with tooltip already set on.
19656 * @return style the theme style in use, which defaults to
19657 * "default". If the object does not have a tooltip set,
19658 * then @c NULL is returned.
19660 * @see elm_genlist_item_tooltip_style_set() for more details
19664 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19666 * @brief Disable size restrictions on an object's tooltip
19667 * @param item The tooltip's anchor object
19668 * @param disable If EINA_TRUE, size restrictions are disabled
19669 * @return EINA_FALSE on failure, EINA_TRUE on success
19671 * This function allows a tooltip to expand beyond its parant window's canvas.
19672 * It will instead be limited only by the size of the display.
19674 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19676 * @brief Retrieve size restriction state of an object's tooltip
19677 * @param item The tooltip's anchor object
19678 * @return If EINA_TRUE, size restrictions are disabled
19680 * This function returns whether a tooltip is allowed to expand beyond
19681 * its parant window's canvas.
19682 * It will instead be limited only by the size of the display.
19684 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19686 * Set the type of mouse pointer/cursor decoration to be shown,
19687 * when the mouse pointer is over the given genlist widget item
19689 * @param item genlist item to customize cursor on
19690 * @param cursor the cursor type's name
19692 * This function works analogously as elm_object_cursor_set(), but
19693 * here the cursor's changing area is restricted to the item's
19694 * area, and not the whole widget's. Note that that item cursors
19695 * have precedence over widget cursors, so that a mouse over @p
19696 * item will always show cursor @p type.
19698 * If this function is called twice for an object, a previously set
19699 * cursor will be unset on the second call.
19701 * @see elm_object_cursor_set()
19702 * @see elm_genlist_item_cursor_get()
19703 * @see elm_genlist_item_cursor_unset()
19707 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19709 * Get the type of mouse pointer/cursor decoration set to be shown,
19710 * when the mouse pointer is over the given genlist widget item
19712 * @param item genlist item with custom cursor set
19713 * @return the cursor type's name or @c NULL, if no custom cursors
19714 * were set to @p item (and on errors)
19716 * @see elm_object_cursor_get()
19717 * @see elm_genlist_item_cursor_set() for more details
19718 * @see elm_genlist_item_cursor_unset()
19722 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19724 * Unset any custom mouse pointer/cursor decoration set to be
19725 * shown, when the mouse pointer is over the given genlist widget
19726 * item, thus making it show the @b default cursor again.
19728 * @param item a genlist item
19730 * Use this call to undo any custom settings on this item's cursor
19731 * decoration, bringing it back to defaults (no custom style set).
19733 * @see elm_object_cursor_unset()
19734 * @see elm_genlist_item_cursor_set() for more details
19738 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19740 * Set a different @b style for a given custom cursor set for a
19743 * @param item genlist item with custom cursor set
19744 * @param style the <b>theme style</b> to use (e.g. @c "default",
19745 * @c "transparent", etc)
19747 * This function only makes sense when one is using custom mouse
19748 * cursor decorations <b>defined in a theme file</b> , which can
19749 * have, given a cursor name/type, <b>alternate styles</b> on
19750 * it. It works analogously as elm_object_cursor_style_set(), but
19751 * here applied only to genlist item objects.
19753 * @warning Before you set a cursor style you should have defined a
19754 * custom cursor previously on the item, with
19755 * elm_genlist_item_cursor_set()
19757 * @see elm_genlist_item_cursor_engine_only_set()
19758 * @see elm_genlist_item_cursor_style_get()
19762 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19764 * Get the current @b style set for a given genlist item's custom
19767 * @param item genlist item with custom cursor set.
19768 * @return style the cursor style in use. If the object does not
19769 * have a cursor set, then @c NULL is returned.
19771 * @see elm_genlist_item_cursor_style_set() for more details
19775 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19777 * Set if the (custom) cursor for a given genlist item should be
19778 * searched in its theme, also, or should only rely on the
19779 * rendering engine.
19781 * @param item item with custom (custom) cursor already set on
19782 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19783 * only on those provided by the rendering engine, @c EINA_FALSE to
19784 * have them searched on the widget's theme, as well.
19786 * @note This call is of use only if you've set a custom cursor
19787 * for genlist items, with elm_genlist_item_cursor_set().
19789 * @note By default, cursors will only be looked for between those
19790 * provided by the rendering engine.
19794 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19796 * Get if the (custom) cursor for a given genlist item is being
19797 * searched in its theme, also, or is only relying on the rendering
19800 * @param item a genlist item
19801 * @return @c EINA_TRUE, if cursors are being looked for only on
19802 * those provided by the rendering engine, @c EINA_FALSE if they
19803 * are being searched on the widget's theme, as well.
19805 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19809 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19811 * Update the contents of all realized items.
19813 * @param obj The genlist object.
19815 * This updates all realized items by calling all the item class functions again
19816 * to get the icons, labels and states. Use this when the original
19817 * item data has changed and the changes are desired to be reflected.
19819 * To update just one item, use elm_genlist_item_update().
19821 * @see elm_genlist_realized_items_get()
19822 * @see elm_genlist_item_update()
19826 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19828 * Activate a genlist mode on an item
19830 * @param item The genlist item
19831 * @param mode Mode name
19832 * @param mode_set Boolean to define set or unset mode.
19834 * A genlist mode is a different way of selecting an item. Once a mode is
19835 * activated on an item, any other selected item is immediately unselected.
19836 * This feature provides an easy way of implementing a new kind of animation
19837 * for selecting an item, without having to entirely rewrite the item style
19838 * theme. However, the elm_genlist_selected_* API can't be used to get what
19839 * item is activate for a mode.
19841 * The current item style will still be used, but applying a genlist mode to
19842 * an item will select it using a different kind of animation.
19844 * The current active item for a mode can be found by
19845 * elm_genlist_mode_item_get().
19847 * The characteristics of genlist mode are:
19848 * - Only one mode can be active at any time, and for only one item.
19849 * - Genlist handles deactivating other items when one item is activated.
19850 * - A mode is defined in the genlist theme (edc), and more modes can easily
19852 * - A mode style and the genlist item style are different things. They
19853 * can be combined to provide a default style to the item, with some kind
19854 * of animation for that item when the mode is activated.
19856 * When a mode is activated on an item, a new view for that item is created.
19857 * The theme of this mode defines the animation that will be used to transit
19858 * the item from the old view to the new view. This second (new) view will be
19859 * active for that item while the mode is active on the item, and will be
19860 * destroyed after the mode is totally deactivated from that item.
19862 * @see elm_genlist_mode_get()
19863 * @see elm_genlist_mode_item_get()
19867 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19869 * Get the last (or current) genlist mode used.
19871 * @param obj The genlist object
19873 * This function just returns the name of the last used genlist mode. It will
19874 * be the current mode if it's still active.
19876 * @see elm_genlist_item_mode_set()
19877 * @see elm_genlist_mode_item_get()
19881 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19883 * Get active genlist mode item
19885 * @param obj The genlist object
19886 * @return The active item for that current mode. Or @c NULL if no item is
19887 * activated with any mode.
19889 * This function returns the item that was activated with a mode, by the
19890 * function elm_genlist_item_mode_set().
19892 * @see elm_genlist_item_mode_set()
19893 * @see elm_genlist_mode_get()
19897 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19902 * @param obj The genlist object
19903 * @param reorder_mode The reorder mode
19904 * (EINA_TRUE = on, EINA_FALSE = off)
19908 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19911 * Get the reorder mode
19913 * @param obj The genlist object
19914 * @return The reorder mode
19915 * (EINA_TRUE = on, EINA_FALSE = off)
19919 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19921 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19922 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19923 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19924 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19925 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19926 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19927 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19928 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19929 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19930 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19932 EAPI void elm_genlist_item_no_select_mode_set(Elm_Genlist_Item *it, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19933 EAPI Eina_Bool elm_genlist_item_no_select_mode_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19940 * @defgroup Check Check
19942 * @image html img/widget/check/preview-00.png
19943 * @image latex img/widget/check/preview-00.eps
19944 * @image html img/widget/check/preview-01.png
19945 * @image latex img/widget/check/preview-01.eps
19946 * @image html img/widget/check/preview-02.png
19947 * @image latex img/widget/check/preview-02.eps
19949 * @brief The check widget allows for toggling a value between true and
19952 * Check objects are a lot like radio objects in layout and functionality
19953 * except they do not work as a group, but independently and only toggle the
19954 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19955 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19956 * returns the current state. For convenience, like the radio objects, you
19957 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19958 * for it to modify.
19960 * Signals that you can add callbacks for are:
19961 * "changed" - This is called whenever the user changes the state of one of
19962 * the check object(event_info is NULL).
19964 * Default contents parts of the check widget that you can use for are:
19965 * @li "icon" - A icon of the check
19967 * Default text parts of the check widget that you can use for are:
19968 * @li "elm.text" - Label of the check
19970 * @ref tutorial_check should give you a firm grasp of how to use this widget
19975 * @brief Add a new Check object
19977 * @param parent The parent object
19978 * @return The new object or NULL if it cannot be created
19980 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19982 * @brief Set the text label of the check object
19984 * @param obj The check object
19985 * @param label The text label string in UTF-8
19987 * @deprecated use elm_object_text_set() instead.
19989 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19991 * @brief Get the text label of the check object
19993 * @param obj The check object
19994 * @return The text label string in UTF-8
19996 * @deprecated use elm_object_text_get() instead.
19998 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20000 * @brief Set the icon object of the check object
20002 * @param obj The check object
20003 * @param icon The icon object
20005 * Once the icon object is set, a previously set one will be deleted.
20006 * If you want to keep that old content object, use the
20007 * elm_object_content_unset() function.
20009 * @deprecated use elm_object_part_content_set() instead.
20012 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20014 * @brief Get the icon object of the check object
20016 * @param obj The check object
20017 * @return The icon object
20019 * @deprecated use elm_object_part_content_get() instead.
20022 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20024 * @brief Unset the icon used for the check object
20026 * @param obj The check object
20027 * @return The icon object that was being used
20029 * Unparent and return the icon object which was set for this widget.
20031 * @deprecated use elm_object_part_content_unset() instead.
20034 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20036 * @brief Set the on/off state of the check object
20038 * @param obj The check object
20039 * @param state The state to use (1 == on, 0 == off)
20041 * This sets the state of the check. If set
20042 * with elm_check_state_pointer_set() the state of that variable is also
20043 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20045 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20047 * @brief Get the state of the check object
20049 * @param obj The check object
20050 * @return The boolean state
20052 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20054 * @brief Set a convenience pointer to a boolean to change
20056 * @param obj The check object
20057 * @param statep Pointer to the boolean to modify
20059 * This sets a pointer to a boolean, that, in addition to the check objects
20060 * state will also be modified directly. To stop setting the object pointed
20061 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20062 * then when this is called, the check objects state will also be modified to
20063 * reflect the value of the boolean @p statep points to, just like calling
20064 * elm_check_state_set().
20066 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20071 /* compatibility code for toggle controls */
20073 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20077 obj = elm_check_add(parent);
20078 elm_object_style_set(obj, "toggle");
20079 elm_object_part_text_set(obj, "on", "ON");
20080 elm_object_part_text_set(obj, "off", "OFF");
20084 EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20086 elm_object_text_set(obj, label);
20089 EINA_DEPRECATED EAPI extern inline const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20091 return elm_object_text_get(obj);
20094 EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20096 elm_object_content_set(obj, icon);
20099 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20101 return elm_object_content_get(obj);
20104 EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20106 return elm_object_content_unset(obj);
20109 EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20111 elm_object_part_text_set(obj, "on", onlabel);
20112 elm_object_part_text_set(obj, "off", offlabel);
20115 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)
20117 if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20118 if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20121 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20123 elm_check_state_set(obj, state);
20126 EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20128 return elm_check_state_get(obj);
20131 EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20133 elm_check_state_pointer_set(obj, statep);
20137 * @defgroup Radio Radio
20139 * @image html img/widget/radio/preview-00.png
20140 * @image latex img/widget/radio/preview-00.eps
20142 * @brief Radio is a widget that allows for 1 or more options to be displayed
20143 * and have the user choose only 1 of them.
20145 * A radio object contains an indicator, an optional Label and an optional
20146 * icon object. While it's possible to have a group of only one radio they,
20147 * are normally used in groups of 2 or more. To add a radio to a group use
20148 * elm_radio_group_add(). The radio object(s) will select from one of a set
20149 * of integer values, so any value they are configuring needs to be mapped to
20150 * a set of integers. To configure what value that radio object represents,
20151 * use elm_radio_state_value_set() to set the integer it represents. To set
20152 * the value the whole group(which one is currently selected) is to indicate
20153 * use elm_radio_value_set() on any group member, and to get the groups value
20154 * use elm_radio_value_get(). For convenience the radio objects are also able
20155 * to directly set an integer(int) to the value that is selected. To specify
20156 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20157 * The radio objects will modify this directly. That implies the pointer must
20158 * point to valid memory for as long as the radio objects exist.
20160 * Signals that you can add callbacks for are:
20161 * @li changed - This is called whenever the user changes the state of one of
20162 * the radio objects within the group of radio objects that work together.
20164 * Default contents parts of the radio widget that you can use for are:
20165 * @li "icon" - A icon of the radio
20167 * @ref tutorial_radio show most of this API in action.
20171 * @brief Add a new radio to the parent
20173 * @param parent The parent object
20174 * @return The new object or NULL if it cannot be created
20176 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20178 * @brief Set the text label of the radio object
20180 * @param obj The radio object
20181 * @param label The text label string in UTF-8
20183 * @deprecated use elm_object_text_set() instead.
20185 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20187 * @brief Get the text label of the radio object
20189 * @param obj The radio object
20190 * @return The text label string in UTF-8
20192 * @deprecated use elm_object_text_set() instead.
20194 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20196 * @brief Set the icon object of the radio object
20198 * @param obj The radio object
20199 * @param icon The icon object
20201 * Once the icon object is set, a previously set one will be deleted. If you
20202 * want to keep that old content object, use the elm_radio_icon_unset()
20205 * @deprecated use elm_object_part_content_set() instead.
20208 WILL_DEPRECATE EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20210 * @brief Get the icon object of the radio object
20212 * @param obj The radio object
20213 * @return The icon object
20215 * @see elm_radio_icon_set()
20217 * @deprecated use elm_object_part_content_get() instead.
20220 WILL_DEPRECATE EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20222 * @brief Unset the icon used for the radio object
20224 * @param obj The radio object
20225 * @return The icon object that was being used
20227 * Unparent and return the icon object which was set for this widget.
20229 * @see elm_radio_icon_set()
20230 * @deprecated use elm_object_part_content_unset() instead.
20233 WILL_DEPRECATE EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20235 * @brief Add this radio to a group of other radio objects
20237 * @param obj The radio object
20238 * @param group Any object whose group the @p obj is to join.
20240 * Radio objects work in groups. Each member should have a different integer
20241 * value assigned. In order to have them work as a group, they need to know
20242 * about each other. This adds the given radio object to the group of which
20243 * the group object indicated is a member.
20245 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20247 * @brief Set the integer value that this radio object represents
20249 * @param obj The radio object
20250 * @param value The value to use if this radio object is selected
20252 * This sets the value of the radio.
20254 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20256 * @brief Get the integer value that this radio object represents
20258 * @param obj The radio object
20259 * @return The value used if this radio object is selected
20261 * This gets the value of the radio.
20263 * @see elm_radio_value_set()
20265 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20267 * @brief Set the value of the radio.
20269 * @param obj The radio object
20270 * @param value The value to use for the group
20272 * This sets the value of the radio group and will also set the value if
20273 * pointed to, to the value supplied, but will not call any callbacks.
20275 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20277 * @brief Get the state of the radio object
20279 * @param obj The radio object
20280 * @return The integer state
20282 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20284 * @brief Set a convenience pointer to a integer to change
20286 * @param obj The radio object
20287 * @param valuep Pointer to the integer to modify
20289 * This sets a pointer to a integer, that, in addition to the radio objects
20290 * state will also be modified directly. To stop setting the object pointed
20291 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20292 * when this is called, the radio objects state will also be modified to
20293 * reflect the value of the integer valuep points to, just like calling
20294 * elm_radio_value_set().
20296 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20302 * @defgroup Pager Pager
20304 * @image html img/widget/pager/preview-00.png
20305 * @image latex img/widget/pager/preview-00.eps
20307 * @brief Widget that allows flipping between one or more āpagesā
20310 * The flipping between pages of objects is animated. All content
20311 * in the pager is kept in a stack, being the last content added
20312 * (visible one) on the top of that stack.
20314 * Objects can be pushed or popped from the stack or deleted as
20315 * well. Pushes and pops will animate the widget accordingly to its
20316 * style (a pop will also delete the child object once the
20317 * animation is finished). Any object already in the pager can be
20318 * promoted to the top (from its current stacking position) through
20319 * the use of elm_pager_content_promote(). New objects are pushed
20320 * to the top with elm_pager_content_push(). When the top item is
20321 * no longer wanted, simply pop it with elm_pager_content_pop() and
20322 * it will also be deleted. If an object is no longer needed and is
20323 * not the top item, just delete it as normal. You can query which
20324 * objects are the top and bottom with
20325 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20327 * Signals that you can add callbacks for are:
20328 * - @c "show,finished" - when a new page is actually shown on the top
20329 * - @c "hide,finished" - when a previous page is hidden
20331 * Only after the first of that signals the child object is
20332 * guaranteed to be visible, as in @c evas_object_visible_get().
20334 * This widget has the following styles available:
20337 * - @c "fade_translucide"
20338 * - @c "fade_invisible"
20340 * @note These styles affect only the flipping animations on the
20341 * default theme; the appearance when not animating is unaffected
20344 * @ref tutorial_pager gives a good overview of the usage of the API.
20349 * Add a new pager to the parent
20351 * @param parent The parent object
20352 * @return The new object or NULL if it cannot be created
20356 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20359 * @brief Push an object to the top of the pager stack (and show it).
20361 * @param obj The pager object
20362 * @param content The object to push
20364 * The object pushed becomes a child of the pager, it will be controlled and
20365 * deleted when the pager is deleted.
20367 * @note If the content is already in the stack use
20368 * elm_pager_content_promote().
20369 * @warning Using this function on @p content already in the stack results in
20370 * undefined behavior.
20372 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20375 * @brief Pop the object that is on top of the stack
20377 * @param obj The pager object
20379 * This pops the object that is on the top(visible) of the pager, makes it
20380 * disappear, then deletes the object. The object that was underneath it on
20381 * the stack will become visible.
20383 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20386 * @brief Moves an object already in the pager stack to the top of the stack.
20388 * @param obj The pager object
20389 * @param content The object to promote
20391 * This will take the @p content and move it to the top of the stack as
20392 * if it had been pushed there.
20394 * @note If the content isn't already in the stack use
20395 * elm_pager_content_push().
20396 * @warning Using this function on @p content not already in the stack
20397 * results in undefined behavior.
20399 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20402 * @brief Return the object at the bottom of the pager stack
20404 * @param obj The pager object
20405 * @return The bottom object or NULL if none
20407 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20410 * @brief Return the object at the top of the pager stack
20412 * @param obj The pager object
20413 * @return The top object or NULL if none
20415 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20417 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20424 * @defgroup Slideshow Slideshow
20426 * @image html img/widget/slideshow/preview-00.png
20427 * @image latex img/widget/slideshow/preview-00.eps
20429 * This widget, as the name indicates, is a pre-made image
20430 * slideshow panel, with API functions acting on (child) image
20431 * items presentation. Between those actions, are:
20432 * - advance to next/previous image
20433 * - select the style of image transition animation
20434 * - set the exhibition time for each image
20435 * - start/stop the slideshow
20437 * The transition animations are defined in the widget's theme,
20438 * consequently new animations can be added without having to
20439 * update the widget's code.
20441 * @section Slideshow_Items Slideshow items
20443 * For slideshow items, just like for @ref Genlist "genlist" ones,
20444 * the user defines a @b classes, specifying functions that will be
20445 * called on the item's creation and deletion times.
20447 * The #Elm_Slideshow_Item_Class structure contains the following
20450 * - @c func.get - When an item is displayed, this function is
20451 * called, and it's where one should create the item object, de
20452 * facto. For example, the object can be a pure Evas image object
20453 * or an Elementary @ref Photocam "photocam" widget. See
20454 * #SlideshowItemGetFunc.
20455 * - @c func.del - When an item is no more displayed, this function
20456 * is called, where the user must delete any data associated to
20457 * the item. See #SlideshowItemDelFunc.
20459 * @section Slideshow_Caching Slideshow caching
20461 * The slideshow provides facilities to have items adjacent to the
20462 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20463 * you, so that the system does not have to decode image data
20464 * anymore at the time it has to actually switch images on its
20465 * viewport. The user is able to set the numbers of items to be
20466 * cached @b before and @b after the current item, in the widget's
20469 * Smart events one can add callbacks for are:
20471 * - @c "changed" - when the slideshow switches its view to a new
20472 * item. event_info parameter in callback contains the current visible item
20473 * - @c "transition,end" - when a slide transition ends. event_info parameter
20474 * in callback contains the current visible item
20476 * List of examples for the slideshow widget:
20477 * @li @ref slideshow_example
20481 * @addtogroup Slideshow
20485 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20486 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20487 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20488 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20489 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20492 * @struct _Elm_Slideshow_Item_Class
20494 * Slideshow item class definition. See @ref Slideshow_Items for
20497 struct _Elm_Slideshow_Item_Class
20499 struct _Elm_Slideshow_Item_Class_Func
20501 SlideshowItemGetFunc get;
20502 SlideshowItemDelFunc del;
20504 }; /**< #Elm_Slideshow_Item_Class member definitions */
20507 * Add a new slideshow widget to the given parent Elementary
20508 * (container) object
20510 * @param parent The parent object
20511 * @return A new slideshow widget handle or @c NULL, on errors
20513 * This function inserts a new slideshow widget on the canvas.
20515 * @ingroup Slideshow
20517 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20520 * Add (append) a new item in a given slideshow widget.
20522 * @param obj The slideshow object
20523 * @param itc The item class for the item
20524 * @param data The item's data
20525 * @return A handle to the item added or @c NULL, on errors
20527 * Add a new item to @p obj's internal list of items, appending it.
20528 * The item's class must contain the function really fetching the
20529 * image object to show for this item, which could be an Evas image
20530 * object or an Elementary photo, for example. The @p data
20531 * parameter is going to be passed to both class functions of the
20534 * @see #Elm_Slideshow_Item_Class
20535 * @see elm_slideshow_item_sorted_insert()
20537 * @ingroup Slideshow
20539 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20542 * Insert a new item into the given slideshow widget, using the @p func
20543 * function to sort items (by item handles).
20545 * @param obj The slideshow object
20546 * @param itc The item class for the item
20547 * @param data The item's data
20548 * @param func The comparing function to be used to sort slideshow
20549 * items <b>by #Elm_Slideshow_Item item handles</b>
20550 * @return Returns The slideshow item handle, on success, or
20551 * @c NULL, on errors
20553 * Add a new item to @p obj's internal list of items, in a position
20554 * determined by the @p func comparing function. The item's class
20555 * must contain the function really fetching the image object to
20556 * show for this item, which could be an Evas image object or an
20557 * Elementary photo, for example. The @p data parameter is going to
20558 * be passed to both class functions of the item.
20560 * @see #Elm_Slideshow_Item_Class
20561 * @see elm_slideshow_item_add()
20563 * @ingroup Slideshow
20565 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);
20568 * Display a given slideshow widget's item, programmatically.
20570 * @param obj The slideshow object
20571 * @param item The item to display on @p obj's viewport
20573 * The change between the current item and @p item will use the
20574 * transition @p obj is set to use (@see
20575 * elm_slideshow_transition_set()).
20577 * @ingroup Slideshow
20579 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20582 * Slide to the @b next item, in a given slideshow widget
20584 * @param obj The slideshow object
20586 * The sliding animation @p obj is set to use will be the
20587 * transition effect used, after this call is issued.
20589 * @note If the end of the slideshow's internal list of items is
20590 * reached, it'll wrap around to the list's beginning, again.
20592 * @ingroup Slideshow
20594 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20597 * Slide to the @b previous item, in a given slideshow widget
20599 * @param obj The slideshow object
20601 * The sliding animation @p obj is set to use will be the
20602 * transition effect used, after this call is issued.
20604 * @note If the beginning of the slideshow's internal list of items
20605 * is reached, it'll wrap around to the list's end, again.
20607 * @ingroup Slideshow
20609 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20612 * Returns the list of sliding transition/effect names available, for a
20613 * given slideshow widget.
20615 * @param obj The slideshow object
20616 * @return The list of transitions (list of @b stringshared strings
20619 * The transitions, which come from @p obj's theme, must be an EDC
20620 * data item named @c "transitions" on the theme file, with (prefix)
20621 * names of EDC programs actually implementing them.
20623 * The available transitions for slideshows on the default theme are:
20624 * - @c "fade" - the current item fades out, while the new one
20625 * fades in to the slideshow's viewport.
20626 * - @c "black_fade" - the current item fades to black, and just
20627 * then, the new item will fade in.
20628 * - @c "horizontal" - the current item slides horizontally, until
20629 * it gets out of the slideshow's viewport, while the new item
20630 * comes from the left to take its place.
20631 * - @c "vertical" - the current item slides vertically, until it
20632 * gets out of the slideshow's viewport, while the new item comes
20633 * from the bottom to take its place.
20634 * - @c "square" - the new item starts to appear from the middle of
20635 * the current one, but with a tiny size, growing until its
20636 * target (full) size and covering the old one.
20638 * @warning The stringshared strings get no new references
20639 * exclusive to the user grabbing the list, here, so if you'd like
20640 * to use them out of this call's context, you'd better @c
20641 * eina_stringshare_ref() them.
20643 * @see elm_slideshow_transition_set()
20645 * @ingroup Slideshow
20647 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20650 * Set the current slide transition/effect in use for a given
20653 * @param obj The slideshow object
20654 * @param transition The new transition's name string
20656 * If @p transition is implemented in @p obj's theme (i.e., is
20657 * contained in the list returned by
20658 * elm_slideshow_transitions_get()), this new sliding effect will
20659 * be used on the widget.
20661 * @see elm_slideshow_transitions_get() for more details
20663 * @ingroup Slideshow
20665 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20668 * Get the current slide transition/effect in use for a given
20671 * @param obj The slideshow object
20672 * @return The current transition's name
20674 * @see elm_slideshow_transition_set() for more details
20676 * @ingroup Slideshow
20678 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20681 * Set the interval between each image transition on a given
20682 * slideshow widget, <b>and start the slideshow, itself</b>
20684 * @param obj The slideshow object
20685 * @param timeout The new displaying timeout for images
20687 * After this call, the slideshow widget will start cycling its
20688 * view, sequentially and automatically, with the images of the
20689 * items it has. The time between each new image displayed is going
20690 * to be @p timeout, in @b seconds. If a different timeout was set
20691 * previously and an slideshow was in progress, it will continue
20692 * with the new time between transitions, after this call.
20694 * @note A value less than or equal to 0 on @p timeout will disable
20695 * the widget's internal timer, thus halting any slideshow which
20696 * could be happening on @p obj.
20698 * @see elm_slideshow_timeout_get()
20700 * @ingroup Slideshow
20702 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20705 * Get the interval set for image transitions on a given slideshow
20708 * @param obj The slideshow object
20709 * @return Returns the timeout set on it
20711 * @see elm_slideshow_timeout_set() for more details
20713 * @ingroup Slideshow
20715 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20718 * Set if, after a slideshow is started, for a given slideshow
20719 * widget, its items should be displayed cyclically or not.
20721 * @param obj The slideshow object
20722 * @param loop Use @c EINA_TRUE to make it cycle through items or
20723 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20726 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20727 * ignore what is set by this functions, i.e., they'll @b always
20728 * cycle through items. This affects only the "automatic"
20729 * slideshow, as set by elm_slideshow_timeout_set().
20731 * @see elm_slideshow_loop_get()
20733 * @ingroup Slideshow
20735 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20738 * Get if, after a slideshow is started, for a given slideshow
20739 * widget, its items are to be displayed cyclically or not.
20741 * @param obj The slideshow object
20742 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20743 * through or @c EINA_FALSE, otherwise
20745 * @see elm_slideshow_loop_set() for more details
20747 * @ingroup Slideshow
20749 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20752 * Remove all items from a given slideshow widget
20754 * @param obj The slideshow object
20756 * This removes (and deletes) all items in @p obj, leaving it
20759 * @see elm_slideshow_item_del(), to remove just one item.
20761 * @ingroup Slideshow
20763 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20766 * Get the internal list of items in a given slideshow widget.
20768 * @param obj The slideshow object
20769 * @return The list of items (#Elm_Slideshow_Item as data) or
20770 * @c NULL on errors.
20772 * This list is @b not to be modified in any way and must not be
20773 * freed. Use the list members with functions like
20774 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20776 * @warning This list is only valid until @p obj object's internal
20777 * items list is changed. It should be fetched again with another
20778 * call to this function when changes happen.
20780 * @ingroup Slideshow
20782 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20785 * Delete a given item from a slideshow widget.
20787 * @param item The slideshow item
20789 * @ingroup Slideshow
20791 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20794 * Return the data associated with a given slideshow item
20796 * @param item The slideshow item
20797 * @return Returns the data associated to this item
20799 * @ingroup Slideshow
20801 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20804 * Returns the currently displayed item, in a given slideshow widget
20806 * @param obj The slideshow object
20807 * @return A handle to the item being displayed in @p obj or
20808 * @c NULL, if none is (and on errors)
20810 * @ingroup Slideshow
20812 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20815 * Get the real Evas object created to implement the view of a
20816 * given slideshow item
20818 * @param item The slideshow item.
20819 * @return the Evas object implementing this item's view.
20821 * This returns the actual Evas object used to implement the
20822 * specified slideshow item's view. This may be @c NULL, as it may
20823 * not have been created or may have been deleted, at any time, by
20824 * the slideshow. <b>Do not modify this object</b> (move, resize,
20825 * show, hide, etc.), as the slideshow is controlling it. This
20826 * function is for querying, emitting custom signals or hooking
20827 * lower level callbacks for events on that object. Do not delete
20828 * this object under any circumstances.
20830 * @see elm_slideshow_item_data_get()
20832 * @ingroup Slideshow
20834 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20837 * Get the the item, in a given slideshow widget, placed at
20838 * position @p nth, in its internal items list
20840 * @param obj The slideshow object
20841 * @param nth The number of the item to grab a handle to (0 being
20843 * @return The item stored in @p obj at position @p nth or @c NULL,
20844 * if there's no item with that index (and on errors)
20846 * @ingroup Slideshow
20848 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20851 * Set the current slide layout in use for a given slideshow widget
20853 * @param obj The slideshow object
20854 * @param layout The new layout's name string
20856 * If @p layout is implemented in @p obj's theme (i.e., is contained
20857 * in the list returned by elm_slideshow_layouts_get()), this new
20858 * images layout will be used on the widget.
20860 * @see elm_slideshow_layouts_get() for more details
20862 * @ingroup Slideshow
20864 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20867 * Get the current slide layout in use for a given slideshow widget
20869 * @param obj The slideshow object
20870 * @return The current layout's name
20872 * @see elm_slideshow_layout_set() for more details
20874 * @ingroup Slideshow
20876 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20879 * Returns the list of @b layout names available, for a given
20880 * slideshow widget.
20882 * @param obj The slideshow object
20883 * @return The list of layouts (list of @b stringshared strings
20886 * Slideshow layouts will change how the widget is to dispose each
20887 * image item in its viewport, with regard to cropping, scaling,
20890 * The layouts, which come from @p obj's theme, must be an EDC
20891 * data item name @c "layouts" on the theme file, with (prefix)
20892 * names of EDC programs actually implementing them.
20894 * The available layouts for slideshows on the default theme are:
20895 * - @c "fullscreen" - item images with original aspect, scaled to
20896 * touch top and down slideshow borders or, if the image's heigh
20897 * is not enough, left and right slideshow borders.
20898 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20899 * one, but always leaving 10% of the slideshow's dimensions of
20900 * distance between the item image's borders and the slideshow
20901 * borders, for each axis.
20903 * @warning The stringshared strings get no new references
20904 * exclusive to the user grabbing the list, here, so if you'd like
20905 * to use them out of this call's context, you'd better @c
20906 * eina_stringshare_ref() them.
20908 * @see elm_slideshow_layout_set()
20910 * @ingroup Slideshow
20912 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20915 * Set the number of items to cache, on a given slideshow widget,
20916 * <b>before the current item</b>
20918 * @param obj The slideshow object
20919 * @param count Number of items to cache before the current one
20921 * The default value for this property is @c 2. See
20922 * @ref Slideshow_Caching "slideshow caching" for more details.
20924 * @see elm_slideshow_cache_before_get()
20926 * @ingroup Slideshow
20928 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20931 * Retrieve the number of items to cache, on a given slideshow widget,
20932 * <b>before the current item</b>
20934 * @param obj The slideshow object
20935 * @return The number of items set to be cached before the current one
20937 * @see elm_slideshow_cache_before_set() for more details
20939 * @ingroup Slideshow
20941 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20944 * Set the number of items to cache, on a given slideshow widget,
20945 * <b>after the current item</b>
20947 * @param obj The slideshow object
20948 * @param count Number of items to cache after the current one
20950 * The default value for this property is @c 2. See
20951 * @ref Slideshow_Caching "slideshow caching" for more details.
20953 * @see elm_slideshow_cache_after_get()
20955 * @ingroup Slideshow
20957 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20960 * Retrieve the number of items to cache, on a given slideshow widget,
20961 * <b>after the current item</b>
20963 * @param obj The slideshow object
20964 * @return The number of items set to be cached after the current one
20966 * @see elm_slideshow_cache_after_set() for more details
20968 * @ingroup Slideshow
20970 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20973 * Get the number of items stored in a given slideshow widget
20975 * @param obj The slideshow object
20976 * @return The number of items on @p obj, at the moment of this call
20978 * @ingroup Slideshow
20980 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20987 * @defgroup Fileselector File Selector
20989 * @image html img/widget/fileselector/preview-00.png
20990 * @image latex img/widget/fileselector/preview-00.eps
20992 * A file selector is a widget that allows a user to navigate
20993 * through a file system, reporting file selections back via its
20996 * It contains shortcut buttons for home directory (@c ~) and to
20997 * jump one directory upwards (..), as well as cancel/ok buttons to
20998 * confirm/cancel a given selection. After either one of those two
20999 * former actions, the file selector will issue its @c "done" smart
21002 * There's a text entry on it, too, showing the name of the current
21003 * selection. There's the possibility of making it editable, so it
21004 * is useful on file saving dialogs on applications, where one
21005 * gives a file name to save contents to, in a given directory in
21006 * the system. This custom file name will be reported on the @c
21007 * "done" smart callback (explained in sequence).
21009 * Finally, it has a view to display file system items into in two
21014 * If Elementary is built with support of the Ethumb thumbnailing
21015 * library, the second form of view will display preview thumbnails
21016 * of files which it supports.
21018 * Smart callbacks one can register to:
21020 * - @c "selected" - the user has clicked on a file (when not in
21021 * folders-only mode) or directory (when in folders-only mode)
21022 * - @c "directory,open" - the list has been populated with new
21023 * content (@c event_info is a pointer to the directory's
21024 * path, a @b stringshared string)
21025 * - @c "done" - the user has clicked on the "ok" or "cancel"
21026 * buttons (@c event_info is a pointer to the selection's
21027 * path, a @b stringshared string)
21029 * Here is an example on its usage:
21030 * @li @ref fileselector_example
21034 * @addtogroup Fileselector
21039 * Defines how a file selector widget is to layout its contents
21040 * (file system entries).
21042 typedef enum _Elm_Fileselector_Mode
21044 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21045 ELM_FILESELECTOR_GRID, /**< layout as a grid */
21046 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21047 } Elm_Fileselector_Mode;
21050 * Add a new file selector widget to the given parent Elementary
21051 * (container) object
21053 * @param parent The parent object
21054 * @return a new file selector widget handle or @c NULL, on errors
21056 * This function inserts a new file selector widget on the canvas.
21058 * @ingroup Fileselector
21060 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21063 * Enable/disable the file name entry box where the user can type
21064 * in a name for a file, in a given file selector widget
21066 * @param obj The file selector object
21067 * @param is_save @c EINA_TRUE to make the file selector a "saving
21068 * dialog", @c EINA_FALSE otherwise
21070 * Having the entry editable is useful on file saving dialogs on
21071 * applications, where one gives a file name to save contents to,
21072 * in a given directory in the system. This custom file name will
21073 * be reported on the @c "done" smart callback.
21075 * @see elm_fileselector_is_save_get()
21077 * @ingroup Fileselector
21079 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21082 * Get whether the given file selector is in "saving dialog" mode
21084 * @param obj The file selector object
21085 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21086 * mode, @c EINA_FALSE otherwise (and on errors)
21088 * @see elm_fileselector_is_save_set() for more details
21090 * @ingroup Fileselector
21092 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21095 * Enable/disable folder-only view for a given file selector widget
21097 * @param obj The file selector object
21098 * @param only @c EINA_TRUE to make @p obj only display
21099 * directories, @c EINA_FALSE to make files to be displayed in it
21102 * If enabled, the widget's view will only display folder items,
21105 * @see elm_fileselector_folder_only_get()
21107 * @ingroup Fileselector
21109 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21112 * Get whether folder-only view is set for a given file selector
21115 * @param obj The file selector object
21116 * @return only @c EINA_TRUE if @p obj is only displaying
21117 * directories, @c EINA_FALSE if files are being displayed in it
21118 * too (and on errors)
21120 * @see elm_fileselector_folder_only_get()
21122 * @ingroup Fileselector
21124 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21127 * Enable/disable the "ok" and "cancel" buttons on a given file
21130 * @param obj The file selector object
21131 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21133 * @note A file selector without those buttons will never emit the
21134 * @c "done" smart event, and is only usable if one is just hooking
21135 * to the other two events.
21137 * @see elm_fileselector_buttons_ok_cancel_get()
21139 * @ingroup Fileselector
21141 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21144 * Get whether the "ok" and "cancel" buttons on a given file
21145 * selector widget are being shown.
21147 * @param obj The file selector object
21148 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21149 * otherwise (and on errors)
21151 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21153 * @ingroup Fileselector
21155 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21158 * Enable/disable a tree view in the given file selector widget,
21159 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21161 * @param obj The file selector object
21162 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21165 * In a tree view, arrows are created on the sides of directories,
21166 * allowing them to expand in place.
21168 * @note If it's in other mode, the changes made by this function
21169 * will only be visible when one switches back to "list" mode.
21171 * @see elm_fileselector_expandable_get()
21173 * @ingroup Fileselector
21175 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21178 * Get whether tree view is enabled for the given file selector
21181 * @param obj The file selector object
21182 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21183 * otherwise (and or errors)
21185 * @see elm_fileselector_expandable_set() for more details
21187 * @ingroup Fileselector
21189 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21192 * Set, programmatically, the @b directory that a given file
21193 * selector widget will display contents from
21195 * @param obj The file selector object
21196 * @param path The path to display in @p obj
21198 * This will change the @b directory that @p obj is displaying. It
21199 * will also clear the text entry area on the @p obj object, which
21200 * displays select files' names.
21202 * @see elm_fileselector_path_get()
21204 * @ingroup Fileselector
21206 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21209 * Get the parent directory's path that a given file selector
21210 * widget is displaying
21212 * @param obj The file selector object
21213 * @return The (full) path of the directory the file selector is
21214 * displaying, a @b stringshared string
21216 * @see elm_fileselector_path_set()
21218 * @ingroup Fileselector
21220 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21223 * Set, programmatically, the currently selected file/directory in
21224 * the given file selector widget
21226 * @param obj The file selector object
21227 * @param path The (full) path to a file or directory
21228 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21229 * latter case occurs if the directory or file pointed to do not
21232 * @see elm_fileselector_selected_get()
21234 * @ingroup Fileselector
21236 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21239 * Get the currently selected item's (full) path, in the given file
21242 * @param obj The file selector object
21243 * @return The absolute path of the selected item, a @b
21244 * stringshared string
21246 * @note Custom editions on @p obj object's text entry, if made,
21247 * will appear on the return string of this function, naturally.
21249 * @see elm_fileselector_selected_set() for more details
21251 * @ingroup Fileselector
21253 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21256 * Set the mode in which a given file selector widget will display
21257 * (layout) file system entries in its view
21259 * @param obj The file selector object
21260 * @param mode The mode of the fileselector, being it one of
21261 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21262 * first one, naturally, will display the files in a list. The
21263 * latter will make the widget to display its entries in a grid
21266 * @note By using elm_fileselector_expandable_set(), the user may
21267 * trigger a tree view for that list.
21269 * @note If Elementary is built with support of the Ethumb
21270 * thumbnailing library, the second form of view will display
21271 * preview thumbnails of files which it supports. You must have
21272 * elm_need_ethumb() called in your Elementary for thumbnailing to
21275 * @see elm_fileselector_expandable_set().
21276 * @see elm_fileselector_mode_get().
21278 * @ingroup Fileselector
21280 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21283 * Get the mode in which a given file selector widget is displaying
21284 * (layouting) file system entries in its view
21286 * @param obj The fileselector object
21287 * @return The mode in which the fileselector is at
21289 * @see elm_fileselector_mode_set() for more details
21291 * @ingroup Fileselector
21293 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21300 * @defgroup Progressbar Progress bar
21302 * The progress bar is a widget for visually representing the
21303 * progress status of a given job/task.
21305 * A progress bar may be horizontal or vertical. It may display an
21306 * icon besides it, as well as primary and @b units labels. The
21307 * former is meant to label the widget as a whole, while the
21308 * latter, which is formatted with floating point values (and thus
21309 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21310 * units"</c>), is meant to label the widget's <b>progress
21311 * value</b>. Label, icon and unit strings/objects are @b optional
21312 * for progress bars.
21314 * A progress bar may be @b inverted, in which state it gets its
21315 * values inverted, with high values being on the left or top and
21316 * low values on the right or bottom, as opposed to normally have
21317 * the low values on the former and high values on the latter,
21318 * respectively, for horizontal and vertical modes.
21320 * The @b span of the progress, as set by
21321 * elm_progressbar_span_size_set(), is its length (horizontally or
21322 * vertically), unless one puts size hints on the widget to expand
21323 * on desired directions, by any container. That length will be
21324 * scaled by the object or applications scaling factor. At any
21325 * point code can query the progress bar for its value with
21326 * elm_progressbar_value_get().
21328 * Available widget styles for progress bars:
21330 * - @c "wheel" (simple style, no text, no progression, only
21331 * "pulse" effect is available)
21333 * Default contents parts of the progressbar widget that you can use for are:
21334 * @li "icon" - A icon of the progressbar
21336 * Here is an example on its usage:
21337 * @li @ref progressbar_example
21341 * Add a new progress bar widget to the given parent Elementary
21342 * (container) object
21344 * @param parent The parent object
21345 * @return a new progress bar widget handle or @c NULL, on errors
21347 * This function inserts a new progress bar widget on the canvas.
21349 * @ingroup Progressbar
21351 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21354 * Set whether a given progress bar widget is at "pulsing mode" or
21357 * @param obj The progress bar object
21358 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21359 * @c EINA_FALSE to put it back to its default one
21361 * By default, progress bars will display values from the low to
21362 * high value boundaries. There are, though, contexts in which the
21363 * state of progression of a given task is @b unknown. For those,
21364 * one can set a progress bar widget to a "pulsing state", to give
21365 * the user an idea that some computation is being held, but
21366 * without exact progress values. In the default theme it will
21367 * animate its bar with the contents filling in constantly and back
21368 * to non-filled, in a loop. To start and stop this pulsing
21369 * animation, one has to explicitly call elm_progressbar_pulse().
21371 * @see elm_progressbar_pulse_get()
21372 * @see elm_progressbar_pulse()
21374 * @ingroup Progressbar
21376 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21379 * Get whether a given progress bar widget is at "pulsing mode" or
21382 * @param obj The progress bar object
21383 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21384 * if it's in the default one (and on errors)
21386 * @ingroup Progressbar
21388 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21391 * Start/stop a given progress bar "pulsing" animation, if its
21394 * @param obj The progress bar object
21395 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21396 * @c EINA_FALSE to @b stop it
21398 * @note This call won't do anything if @p obj is not under "pulsing mode".
21400 * @see elm_progressbar_pulse_set() for more details.
21402 * @ingroup Progressbar
21404 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21407 * Set the progress value (in percentage) on a given progress bar
21410 * @param obj The progress bar object
21411 * @param val The progress value (@b must be between @c 0.0 and @c
21414 * Use this call to set progress bar levels.
21416 * @note If you passes a value out of the specified range for @p
21417 * val, it will be interpreted as the @b closest of the @b boundary
21418 * values in the range.
21420 * @ingroup Progressbar
21422 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21425 * Get the progress value (in percentage) on a given progress bar
21428 * @param obj The progress bar object
21429 * @return The value of the progressbar
21431 * @see elm_progressbar_value_set() for more details
21433 * @ingroup Progressbar
21435 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21438 * Set the label of a given progress bar widget
21440 * @param obj The progress bar object
21441 * @param label The text label string, in UTF-8
21443 * @ingroup Progressbar
21444 * @deprecated use elm_object_text_set() instead.
21446 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21449 * Get the label of a given progress bar widget
21451 * @param obj The progressbar object
21452 * @return The text label string, in UTF-8
21454 * @ingroup Progressbar
21455 * @deprecated use elm_object_text_set() instead.
21457 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21460 * Set the icon object of a given progress bar widget
21462 * @param obj The progress bar object
21463 * @param icon The icon object
21465 * Use this call to decorate @p obj with an icon next to it.
21467 * @note Once the icon object is set, a previously set one will be
21468 * deleted. If you want to keep that old content object, use the
21469 * elm_progressbar_icon_unset() function.
21471 * @see elm_progressbar_icon_get()
21472 * @deprecated use elm_object_part_content_set() instead.
21474 * @ingroup Progressbar
21476 WILL_DEPRECATE EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21479 * Retrieve the icon object set for a given progress bar widget
21481 * @param obj The progress bar object
21482 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21483 * otherwise (and on errors)
21485 * @see elm_progressbar_icon_set() for more details
21486 * @deprecated use elm_object_part_content_get() instead.
21488 * @ingroup Progressbar
21490 WILL_DEPRECATE EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21493 * Unset an icon set on a given progress bar widget
21495 * @param obj The progress bar object
21496 * @return The icon object that was being used, if any was set, or
21497 * @c NULL, otherwise (and on errors)
21499 * This call will unparent and return the icon object which was set
21500 * for this widget, previously, on success.
21502 * @see elm_progressbar_icon_set() for more details
21503 * @deprecated use elm_object_part_content_unset() instead.
21505 * @ingroup Progressbar
21507 WILL_DEPRECATE EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21510 * Set the (exact) length of the bar region of a given progress bar
21513 * @param obj The progress bar object
21514 * @param size The length of the progress bar's bar region
21516 * This sets the minimum width (when in horizontal mode) or height
21517 * (when in vertical mode) of the actual bar area of the progress
21518 * bar @p obj. This in turn affects the object's minimum size. Use
21519 * this when you're not setting other size hints expanding on the
21520 * given direction (like weight and alignment hints) and you would
21521 * like it to have a specific size.
21523 * @note Icon, label and unit text around @p obj will require their
21524 * own space, which will make @p obj to require more the @p size,
21527 * @see elm_progressbar_span_size_get()
21529 * @ingroup Progressbar
21531 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21534 * Get the length set for the bar region of a given progress bar
21537 * @param obj The progress bar object
21538 * @return The length of the progress bar's bar region
21540 * If that size was not set previously, with
21541 * elm_progressbar_span_size_set(), this call will return @c 0.
21543 * @ingroup Progressbar
21545 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21548 * Set the format string for a given progress bar widget's units
21551 * @param obj The progress bar object
21552 * @param format The format string for @p obj's units label
21554 * If @c NULL is passed on @p format, it will make @p obj's units
21555 * area to be hidden completely. If not, it'll set the <b>format
21556 * string</b> for the units label's @b text. The units label is
21557 * provided a floating point value, so the units text is up display
21558 * at most one floating point falue. Note that the units label is
21559 * optional. Use a format string such as "%1.2f meters" for
21562 * @note The default format string for a progress bar is an integer
21563 * percentage, as in @c "%.0f %%".
21565 * @see elm_progressbar_unit_format_get()
21567 * @ingroup Progressbar
21569 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21572 * Retrieve the format string set for a given progress bar widget's
21575 * @param obj The progress bar object
21576 * @return The format set string for @p obj's units label or
21577 * @c NULL, if none was set (and on errors)
21579 * @see elm_progressbar_unit_format_set() for more details
21581 * @ingroup Progressbar
21583 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21586 * Set the orientation of a given progress bar widget
21588 * @param obj The progress bar object
21589 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21590 * @b horizontal, @c EINA_FALSE to make it @b vertical
21592 * Use this function to change how your progress bar is to be
21593 * disposed: vertically or horizontally.
21595 * @see elm_progressbar_horizontal_get()
21597 * @ingroup Progressbar
21599 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21602 * Retrieve the orientation of a given progress bar widget
21604 * @param obj The progress bar object
21605 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21606 * @c EINA_FALSE if it's @b vertical (and on errors)
21608 * @see elm_progressbar_horizontal_set() for more details
21610 * @ingroup Progressbar
21612 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21615 * Invert a given progress bar widget's displaying values order
21617 * @param obj The progress bar object
21618 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21619 * @c EINA_FALSE to bring it back to default, non-inverted values.
21621 * A progress bar may be @b inverted, in which state it gets its
21622 * values inverted, with high values being on the left or top and
21623 * low values on the right or bottom, as opposed to normally have
21624 * the low values on the former and high values on the latter,
21625 * respectively, for horizontal and vertical modes.
21627 * @see elm_progressbar_inverted_get()
21629 * @ingroup Progressbar
21631 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21634 * Get whether a given progress bar widget's displaying values are
21637 * @param obj The progress bar object
21638 * @return @c EINA_TRUE, if @p obj has inverted values,
21639 * @c EINA_FALSE otherwise (and on errors)
21641 * @see elm_progressbar_inverted_set() for more details
21643 * @ingroup Progressbar
21645 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21648 * @defgroup Separator Separator
21650 * @brief Separator is a very thin object used to separate other objects.
21652 * A separator can be vertical or horizontal.
21654 * @ref tutorial_separator is a good example of how to use a separator.
21658 * @brief Add a separator object to @p parent
21660 * @param parent The parent object
21662 * @return The separator object, or NULL upon failure
21664 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21666 * @brief Set the horizontal mode of a separator object
21668 * @param obj The separator object
21669 * @param horizontal If true, the separator is horizontal
21671 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21673 * @brief Get the horizontal mode of a separator object
21675 * @param obj The separator object
21676 * @return If true, the separator is horizontal
21678 * @see elm_separator_horizontal_set()
21680 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21686 * @defgroup Spinner Spinner
21687 * @ingroup Elementary
21689 * @image html img/widget/spinner/preview-00.png
21690 * @image latex img/widget/spinner/preview-00.eps
21692 * A spinner is a widget which allows the user to increase or decrease
21693 * numeric values using arrow buttons, or edit values directly, clicking
21694 * over it and typing the new value.
21696 * By default the spinner will not wrap and has a label
21697 * of "%.0f" (just showing the integer value of the double).
21699 * A spinner has a label that is formatted with floating
21700 * point values and thus accepts a printf-style format string, like
21701 * ā%1.2f unitsā.
21703 * It also allows specific values to be replaced by pre-defined labels.
21705 * Smart callbacks one can register to:
21707 * - "changed" - Whenever the spinner value is changed.
21708 * - "delay,changed" - A short time after the value is changed by the user.
21709 * This will be called only when the user stops dragging for a very short
21710 * period or when they release their finger/mouse, so it avoids possibly
21711 * expensive reactions to the value change.
21713 * Available styles for it:
21715 * - @c "vertical": up/down buttons at the right side and text left aligned.
21717 * Here is an example on its usage:
21718 * @ref spinner_example
21722 * @addtogroup Spinner
21727 * Add a new spinner widget to the given parent Elementary
21728 * (container) object.
21730 * @param parent The parent object.
21731 * @return a new spinner widget handle or @c NULL, on errors.
21733 * This function inserts a new spinner widget on the canvas.
21738 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21741 * Set the format string of the displayed label.
21743 * @param obj The spinner object.
21744 * @param fmt The format string for the label display.
21746 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21747 * string for the label text. The label text is provided a floating point
21748 * value, so the label text can display up to 1 floating point value.
21749 * Note that this is optional.
21751 * Use a format string such as "%1.2f meters" for example, and it will
21752 * display values like: "3.14 meters" for a value equal to 3.14159.
21754 * Default is "%0.f".
21756 * @see elm_spinner_label_format_get()
21760 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21763 * Get the label format of the spinner.
21765 * @param obj The spinner object.
21766 * @return The text label format string in UTF-8.
21768 * @see elm_spinner_label_format_set() for details.
21772 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21775 * Set the minimum and maximum values for the spinner.
21777 * @param obj The spinner object.
21778 * @param min The minimum value.
21779 * @param max The maximum value.
21781 * Define the allowed range of values to be selected by the user.
21783 * If actual value is less than @p min, it will be updated to @p min. If it
21784 * is bigger then @p max, will be updated to @p max. Actual value can be
21785 * get with elm_spinner_value_get().
21787 * By default, min is equal to 0, and max is equal to 100.
21789 * @warning Maximum must be greater than minimum.
21791 * @see elm_spinner_min_max_get()
21795 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21798 * Get the minimum and maximum values of the spinner.
21800 * @param obj The spinner object.
21801 * @param min Pointer where to store the minimum value.
21802 * @param max Pointer where to store the maximum value.
21804 * @note If only one value is needed, the other pointer can be passed
21807 * @see elm_spinner_min_max_set() for details.
21811 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21814 * Set the step used to increment or decrement the spinner value.
21816 * @param obj The spinner object.
21817 * @param step The step value.
21819 * This value will be incremented or decremented to the displayed value.
21820 * It will be incremented while the user keep right or top arrow pressed,
21821 * and will be decremented while the user keep left or bottom arrow pressed.
21823 * The interval to increment / decrement can be set with
21824 * elm_spinner_interval_set().
21826 * By default step value is equal to 1.
21828 * @see elm_spinner_step_get()
21832 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21835 * Get the step used to increment or decrement the spinner value.
21837 * @param obj The spinner object.
21838 * @return The step value.
21840 * @see elm_spinner_step_get() for more details.
21844 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21847 * Set the value the spinner displays.
21849 * @param obj The spinner object.
21850 * @param val The value to be displayed.
21852 * Value will be presented on the label following format specified with
21853 * elm_spinner_format_set().
21855 * @warning The value must to be between min and max values. This values
21856 * are set by elm_spinner_min_max_set().
21858 * @see elm_spinner_value_get().
21859 * @see elm_spinner_format_set().
21860 * @see elm_spinner_min_max_set().
21864 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21867 * Get the value displayed by the spinner.
21869 * @param obj The spinner object.
21870 * @return The value displayed.
21872 * @see elm_spinner_value_set() for details.
21876 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21879 * Set whether the spinner should wrap when it reaches its
21880 * minimum or maximum value.
21882 * @param obj The spinner object.
21883 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21886 * Disabled by default. If disabled, when the user tries to increment the
21888 * but displayed value plus step value is bigger than maximum value,
21890 * won't allow it. The same happens when the user tries to decrement it,
21891 * but the value less step is less than minimum value.
21893 * When wrap is enabled, in such situations it will allow these changes,
21894 * but will get the value that would be less than minimum and subtracts
21895 * from maximum. Or add the value that would be more than maximum to
21899 * @li min value = 10
21900 * @li max value = 50
21901 * @li step value = 20
21902 * @li displayed value = 20
21904 * When the user decrement value (using left or bottom arrow), it will
21905 * displays @c 40, because max - (min - (displayed - step)) is
21906 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21908 * @see elm_spinner_wrap_get().
21912 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21915 * Get whether the spinner should wrap when it reaches its
21916 * minimum or maximum value.
21918 * @param obj The spinner object
21919 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21920 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21922 * @see elm_spinner_wrap_set() for details.
21926 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21929 * Set whether the spinner can be directly edited by the user or not.
21931 * @param obj The spinner object.
21932 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21933 * don't allow users to edit it directly.
21935 * Spinner objects can have edition @b disabled, in which state they will
21936 * be changed only by arrows.
21937 * Useful for contexts
21938 * where you don't want your users to interact with it writting the value.
21940 * when using special values, the user can see real value instead
21941 * of special label on edition.
21943 * It's enabled by default.
21945 * @see elm_spinner_editable_get()
21949 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21952 * Get whether the spinner can be directly edited by the user or not.
21954 * @param obj The spinner object.
21955 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21956 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21958 * @see elm_spinner_editable_set() for details.
21962 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21965 * Set a special string to display in the place of the numerical value.
21967 * @param obj The spinner object.
21968 * @param value The value to be replaced.
21969 * @param label The label to be used.
21971 * It's useful for cases when a user should select an item that is
21972 * better indicated by a label than a value. For example, weekdays or months.
21976 * sp = elm_spinner_add(win);
21977 * elm_spinner_min_max_set(sp, 1, 3);
21978 * elm_spinner_special_value_add(sp, 1, "January");
21979 * elm_spinner_special_value_add(sp, 2, "February");
21980 * elm_spinner_special_value_add(sp, 3, "March");
21981 * evas_object_show(sp);
21986 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21989 * Set the interval on time updates for an user mouse button hold
21990 * on spinner widgets' arrows.
21992 * @param obj The spinner object.
21993 * @param interval The (first) interval value in seconds.
21995 * This interval value is @b decreased while the user holds the
21996 * mouse pointer either incrementing or decrementing spinner's value.
21998 * This helps the user to get to a given value distant from the
21999 * current one easier/faster, as it will start to change quicker and
22000 * quicker on mouse button holds.
22002 * The calculation for the next change interval value, starting from
22003 * the one set with this call, is the previous interval divided by
22004 * @c 1.05, so it decreases a little bit.
22006 * The default starting interval value for automatic changes is
22009 * @see elm_spinner_interval_get()
22013 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22016 * Get the interval on time updates for an user mouse button hold
22017 * on spinner widgets' arrows.
22019 * @param obj The spinner object.
22020 * @return The (first) interval value, in seconds, set on it.
22022 * @see elm_spinner_interval_set() for more details.
22026 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22033 * @defgroup Index Index
22035 * @image html img/widget/index/preview-00.png
22036 * @image latex img/widget/index/preview-00.eps
22038 * An index widget gives you an index for fast access to whichever
22039 * group of other UI items one might have. It's a list of text
22040 * items (usually letters, for alphabetically ordered access).
22042 * Index widgets are by default hidden and just appear when the
22043 * user clicks over it's reserved area in the canvas. In its
22044 * default theme, it's an area one @ref Fingers "finger" wide on
22045 * the right side of the index widget's container.
22047 * When items on the index are selected, smart callbacks get
22048 * called, so that its user can make other container objects to
22049 * show a given area or child object depending on the index item
22050 * selected. You'd probably be using an index together with @ref
22051 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22054 * Smart events one can add callbacks for are:
22055 * - @c "changed" - When the selected index item changes. @c
22056 * event_info is the selected item's data pointer.
22057 * - @c "delay,changed" - When the selected index item changes, but
22058 * after a small idling period. @c event_info is the selected
22059 * item's data pointer.
22060 * - @c "selected" - When the user releases a mouse button and
22061 * selects an item. @c event_info is the selected item's data
22063 * - @c "level,up" - when the user moves a finger from the first
22064 * level to the second level
22065 * - @c "level,down" - when the user moves a finger from the second
22066 * level to the first level
22068 * The @c "delay,changed" event is so that it'll wait a small time
22069 * before actually reporting those events and, moreover, just the
22070 * last event happening on those time frames will actually be
22073 * Here are some examples on its usage:
22074 * @li @ref index_example_01
22075 * @li @ref index_example_02
22079 * @addtogroup Index
22083 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22086 * Add a new index widget to the given parent Elementary
22087 * (container) object
22089 * @param parent The parent object
22090 * @return a new index widget handle or @c NULL, on errors
22092 * This function inserts a new index widget on the canvas.
22096 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22099 * Set whether a given index widget is or not visible,
22102 * @param obj The index object
22103 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22105 * Not to be confused with visible as in @c evas_object_show() --
22106 * visible with regard to the widget's auto hiding feature.
22108 * @see elm_index_active_get()
22112 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22115 * Get whether a given index widget is currently visible or not.
22117 * @param obj The index object
22118 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22120 * @see elm_index_active_set() for more details
22124 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22127 * Set the items level for a given index widget.
22129 * @param obj The index object.
22130 * @param level @c 0 or @c 1, the currently implemented levels.
22132 * @see elm_index_item_level_get()
22136 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22139 * Get the items level set for a given index widget.
22141 * @param obj The index object.
22142 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22144 * @see elm_index_item_level_set() for more information
22148 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22151 * Returns the last selected item's data, for a given index widget.
22153 * @param obj The index object.
22154 * @return The item @b data associated to the last selected item on
22155 * @p obj (or @c NULL, on errors).
22157 * @warning The returned value is @b not an #Elm_Index_Item item
22158 * handle, but the data associated to it (see the @c item parameter
22159 * in elm_index_item_append(), as an example).
22163 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22166 * Append a new item on a given index widget.
22168 * @param obj The index object.
22169 * @param letter Letter under which the item should be indexed
22170 * @param item The item data to set for the index's item
22172 * Despite the most common usage of the @p letter argument is for
22173 * single char strings, one could use arbitrary strings as index
22176 * @c item will be the pointer returned back on @c "changed", @c
22177 * "delay,changed" and @c "selected" smart events.
22181 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22184 * Prepend a new item on a given index widget.
22186 * @param obj The index object.
22187 * @param letter Letter under which the item should be indexed
22188 * @param item The item data to set for the index's item
22190 * Despite the most common usage of the @p letter argument is for
22191 * single char strings, one could use arbitrary strings as index
22194 * @c item will be the pointer returned back on @c "changed", @c
22195 * "delay,changed" and @c "selected" smart events.
22199 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22202 * Append a new item, on a given index widget, <b>after the item
22203 * having @p relative as data</b>.
22205 * @param obj The index object.
22206 * @param letter Letter under which the item should be indexed
22207 * @param item The item data to set for the index's item
22208 * @param relative The item data of the index item to be the
22209 * predecessor of this new one
22211 * Despite the most common usage of the @p letter argument is for
22212 * single char strings, one could use arbitrary strings as index
22215 * @c item will be the pointer returned back on @c "changed", @c
22216 * "delay,changed" and @c "selected" smart events.
22218 * @note If @p relative is @c NULL or if it's not found to be data
22219 * set on any previous item on @p obj, this function will behave as
22220 * elm_index_item_append().
22224 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22227 * Prepend a new item, on a given index widget, <b>after the item
22228 * having @p relative as data</b>.
22230 * @param obj The index object.
22231 * @param letter Letter under which the item should be indexed
22232 * @param item The item data to set for the index's item
22233 * @param relative The item data of the index item to be the
22234 * successor of this new one
22236 * Despite the most common usage of the @p letter argument is for
22237 * single char strings, one could use arbitrary strings as index
22240 * @c item will be the pointer returned back on @c "changed", @c
22241 * "delay,changed" and @c "selected" smart events.
22243 * @note If @p relative is @c NULL or if it's not found to be data
22244 * set on any previous item on @p obj, this function will behave as
22245 * elm_index_item_prepend().
22249 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22252 * Insert a new item into the given index widget, using @p cmp_func
22253 * function to sort items (by item handles).
22255 * @param obj The index object.
22256 * @param letter Letter under which the item should be indexed
22257 * @param item The item data to set for the index's item
22258 * @param cmp_func The comparing function to be used to sort index
22259 * items <b>by #Elm_Index_Item item handles</b>
22260 * @param cmp_data_func A @b fallback function to be called for the
22261 * sorting of index items <b>by item data</b>). It will be used
22262 * when @p cmp_func returns @c 0 (equality), which means an index
22263 * item with provided item data already exists. To decide which
22264 * data item should be pointed to by the index item in question, @p
22265 * cmp_data_func will be used. If @p cmp_data_func returns a
22266 * non-negative value, the previous index item data will be
22267 * replaced by the given @p item pointer. If the previous data need
22268 * to be freed, it should be done by the @p cmp_data_func function,
22269 * because all references to it will be lost. If this function is
22270 * not provided (@c NULL is given), index items will be @b
22271 * duplicated, if @p cmp_func returns @c 0.
22273 * Despite the most common usage of the @p letter argument is for
22274 * single char strings, one could use arbitrary strings as index
22277 * @c item will be the pointer returned back on @c "changed", @c
22278 * "delay,changed" and @c "selected" smart events.
22282 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);
22285 * Remove an item from a given index widget, <b>to be referenced by
22286 * it's data value</b>.
22288 * @param obj The index object
22289 * @param item The item's data pointer for the item to be removed
22292 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22293 * that callback function will be called by this one.
22295 * @warning The item to be removed from @p obj will be found via
22296 * its item data pointer, and not by an #Elm_Index_Item handle.
22300 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22303 * Find a given index widget's item, <b>using item data</b>.
22305 * @param obj The index object
22306 * @param item The item data pointed to by the desired index item
22307 * @return The index item handle, if found, or @c NULL otherwise
22311 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22314 * Removes @b all items from a given index widget.
22316 * @param obj The index object.
22318 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22319 * that callback function will be called for each item in @p obj.
22323 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22326 * Go to a given items level on a index widget
22328 * @param obj The index object
22329 * @param level The index level (one of @c 0 or @c 1)
22333 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22336 * Return the data associated with a given index widget item
22338 * @param it The index widget item handle
22339 * @return The data associated with @p it
22341 * @see elm_index_item_data_set()
22345 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22348 * Set the data associated with a given index widget item
22350 * @param it The index widget item handle
22351 * @param data The new data pointer to set to @p it
22353 * This sets new item data on @p it.
22355 * @warning The old data pointer won't be touched by this function, so
22356 * the user had better to free that old data himself/herself.
22360 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22363 * Set the function to be called when a given index widget item is freed.
22365 * @param it The item to set the callback on
22366 * @param func The function to call on the item's deletion
22368 * When called, @p func will have both @c data and @c event_info
22369 * arguments with the @p it item's data value and, naturally, the
22370 * @c obj argument with a handle to the parent index widget.
22374 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22377 * Get the letter (string) set on a given index widget item.
22379 * @param it The index item handle
22380 * @return The letter string set on @p it
22384 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22388 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22395 * @defgroup Photocam Photocam
22397 * @image html img/widget/photocam/preview-00.png
22398 * @image latex img/widget/photocam/preview-00.eps
22400 * This is a widget specifically for displaying high-resolution digital
22401 * camera photos giving speedy feedback (fast load), low memory footprint
22402 * and zooming and panning as well as fitting logic. It is entirely focused
22403 * on jpeg images, and takes advantage of properties of the jpeg format (via
22404 * evas loader features in the jpeg loader).
22406 * Signals that you can add callbacks for are:
22407 * @li "clicked" - This is called when a user has clicked the photo without
22409 * @li "press" - This is called when a user has pressed down on the photo.
22410 * @li "longpressed" - This is called when a user has pressed down on the
22411 * photo for a long time without dragging around.
22412 * @li "clicked,double" - This is called when a user has double-clicked the
22414 * @li "load" - Photo load begins.
22415 * @li "loaded" - This is called when the image file load is complete for the
22416 * first view (low resolution blurry version).
22417 * @li "load,detail" - Photo detailed data load begins.
22418 * @li "loaded,detail" - This is called when the image file load is complete
22419 * for the detailed image data (full resolution needed).
22420 * @li "zoom,start" - Zoom animation started.
22421 * @li "zoom,stop" - Zoom animation stopped.
22422 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22423 * @li "scroll" - the content has been scrolled (moved)
22424 * @li "scroll,anim,start" - scrolling animation has started
22425 * @li "scroll,anim,stop" - scrolling animation has stopped
22426 * @li "scroll,drag,start" - dragging the contents around has started
22427 * @li "scroll,drag,stop" - dragging the contents around has stopped
22429 * @ref tutorial_photocam shows the API in action.
22433 * @brief Types of zoom available.
22435 typedef enum _Elm_Photocam_Zoom_Mode
22437 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22438 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22439 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22440 ELM_PHOTOCAM_ZOOM_MODE_LAST
22441 } Elm_Photocam_Zoom_Mode;
22443 * @brief Add a new Photocam object
22445 * @param parent The parent object
22446 * @return The new object or NULL if it cannot be created
22448 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22450 * @brief Set the photo file to be shown
22452 * @param obj The photocam object
22453 * @param file The photo file
22454 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22456 * This sets (and shows) the specified file (with a relative or absolute
22457 * path) and will return a load error (same error that
22458 * evas_object_image_load_error_get() will return). The image will change and
22459 * adjust its size at this point and begin a background load process for this
22460 * photo that at some time in the future will be displayed at the full
22463 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22465 * @brief Returns the path of the current image file
22467 * @param obj The photocam object
22468 * @return Returns the path
22470 * @see elm_photocam_file_set()
22472 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22474 * @brief Set the zoom level of the photo
22476 * @param obj The photocam object
22477 * @param zoom The zoom level to set
22479 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22480 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22481 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22482 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22485 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22487 * @brief Get the zoom level of the photo
22489 * @param obj The photocam object
22490 * @return The current zoom level
22492 * This returns the current zoom level of the photocam object. Note that if
22493 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22494 * (which is the default), the zoom level may be changed at any time by the
22495 * photocam object itself to account for photo size and photocam viewpoer
22498 * @see elm_photocam_zoom_set()
22499 * @see elm_photocam_zoom_mode_set()
22501 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22503 * @brief Set the zoom mode
22505 * @param obj The photocam object
22506 * @param mode The desired mode
22508 * This sets the zoom mode to manual or one of several automatic levels.
22509 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22510 * elm_photocam_zoom_set() and will stay at that level until changed by code
22511 * or until zoom mode is changed. This is the default mode. The Automatic
22512 * modes will allow the photocam object to automatically adjust zoom mode
22513 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22514 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22515 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22516 * pixels within the frame are left unfilled.
22518 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22520 * @brief Get the zoom mode
22522 * @param obj The photocam object
22523 * @return The current zoom mode
22525 * This gets the current zoom mode of the photocam object.
22527 * @see elm_photocam_zoom_mode_set()
22529 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22531 * @brief Get the current image pixel width and height
22533 * @param obj The photocam object
22534 * @param w A pointer to the width return
22535 * @param h A pointer to the height return
22537 * This gets the current photo pixel width and height (for the original).
22538 * The size will be returned in the integers @p w and @p h that are pointed
22541 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22543 * @brief Get the area of the image that is currently shown
22546 * @param x A pointer to the X-coordinate of region
22547 * @param y A pointer to the Y-coordinate of region
22548 * @param w A pointer to the width
22549 * @param h A pointer to the height
22551 * @see elm_photocam_image_region_show()
22552 * @see elm_photocam_image_region_bring_in()
22554 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22556 * @brief Set the viewed portion of the image
22558 * @param obj The photocam object
22559 * @param x X-coordinate of region in image original pixels
22560 * @param y Y-coordinate of region in image original pixels
22561 * @param w Width of region in image original pixels
22562 * @param h Height of region in image original pixels
22564 * This shows the region of the image without using animation.
22566 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22568 * @brief Bring in the viewed portion of the image
22570 * @param obj The photocam object
22571 * @param x X-coordinate of region in image original pixels
22572 * @param y Y-coordinate of region in image original pixels
22573 * @param w Width of region in image original pixels
22574 * @param h Height of region in image original pixels
22576 * This shows the region of the image using animation.
22578 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22580 * @brief Set the paused state for photocam
22582 * @param obj The photocam object
22583 * @param paused The pause state to set
22585 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22586 * photocam. The default is off. This will stop zooming using animation on
22587 * zoom levels changes and change instantly. This will stop any existing
22588 * animations that are running.
22590 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22592 * @brief Get the paused state for photocam
22594 * @param obj The photocam object
22595 * @return The current paused state
22597 * This gets the current paused state for the photocam object.
22599 * @see elm_photocam_paused_set()
22601 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22603 * @brief Get the internal low-res image used for photocam
22605 * @param obj The photocam object
22606 * @return The internal image object handle, or NULL if none exists
22608 * This gets the internal image object inside photocam. Do not modify it. It
22609 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22610 * deleted at any time as well.
22612 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22614 * @brief Set the photocam scrolling bouncing.
22616 * @param obj The photocam object
22617 * @param h_bounce bouncing for horizontal
22618 * @param v_bounce bouncing for vertical
22620 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22622 * @brief Get the photocam scrolling bouncing.
22624 * @param obj The photocam object
22625 * @param h_bounce bouncing for horizontal
22626 * @param v_bounce bouncing for vertical
22628 * @see elm_photocam_bounce_set()
22630 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22636 * @defgroup Map Map
22637 * @ingroup Elementary
22639 * @image html img/widget/map/preview-00.png
22640 * @image latex img/widget/map/preview-00.eps
22642 * This is a widget specifically for displaying a map. It uses basically
22643 * OpenStreetMap provider http://www.openstreetmap.org/,
22644 * but custom providers can be added.
22646 * It supports some basic but yet nice features:
22647 * @li zoom and scroll
22648 * @li markers with content to be displayed when user clicks over it
22649 * @li group of markers
22652 * Smart callbacks one can listen to:
22654 * - "clicked" - This is called when a user has clicked the map without
22656 * - "press" - This is called when a user has pressed down on the map.
22657 * - "longpressed" - This is called when a user has pressed down on the map
22658 * for a long time without dragging around.
22659 * - "clicked,double" - This is called when a user has double-clicked
22661 * - "load,detail" - Map detailed data load begins.
22662 * - "loaded,detail" - This is called when all currently visible parts of
22663 * the map are loaded.
22664 * - "zoom,start" - Zoom animation started.
22665 * - "zoom,stop" - Zoom animation stopped.
22666 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22667 * - "scroll" - the content has been scrolled (moved).
22668 * - "scroll,anim,start" - scrolling animation has started.
22669 * - "scroll,anim,stop" - scrolling animation has stopped.
22670 * - "scroll,drag,start" - dragging the contents around has started.
22671 * - "scroll,drag,stop" - dragging the contents around has stopped.
22672 * - "downloaded" - This is called when all currently required map images
22674 * - "route,load" - This is called when route request begins.
22675 * - "route,loaded" - This is called when route request ends.
22676 * - "name,load" - This is called when name request begins.
22677 * - "name,loaded- This is called when name request ends.
22679 * Available style for map widget:
22682 * Available style for markers:
22687 * Available style for marker bubble:
22690 * List of examples:
22691 * @li @ref map_example_01
22692 * @li @ref map_example_02
22693 * @li @ref map_example_03
22702 * @enum _Elm_Map_Zoom_Mode
22703 * @typedef Elm_Map_Zoom_Mode
22705 * Set map's zoom behavior. It can be set to manual or automatic.
22707 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22709 * Values <b> don't </b> work as bitmask, only one can be choosen.
22711 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22712 * than the scroller view.
22714 * @see elm_map_zoom_mode_set()
22715 * @see elm_map_zoom_mode_get()
22719 typedef enum _Elm_Map_Zoom_Mode
22721 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22722 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22723 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22724 ELM_MAP_ZOOM_MODE_LAST
22725 } Elm_Map_Zoom_Mode;
22728 * @enum _Elm_Map_Route_Sources
22729 * @typedef Elm_Map_Route_Sources
22731 * Set route service to be used. By default used source is
22732 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22734 * @see elm_map_route_source_set()
22735 * @see elm_map_route_source_get()
22739 typedef enum _Elm_Map_Route_Sources
22741 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22742 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. */
22743 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22744 ELM_MAP_ROUTE_SOURCE_LAST
22745 } Elm_Map_Route_Sources;
22747 typedef enum _Elm_Map_Name_Sources
22749 ELM_MAP_NAME_SOURCE_NOMINATIM,
22750 ELM_MAP_NAME_SOURCE_LAST
22751 } Elm_Map_Name_Sources;
22754 * @enum _Elm_Map_Route_Type
22755 * @typedef Elm_Map_Route_Type
22757 * Set type of transport used on route.
22759 * @see elm_map_route_add()
22763 typedef enum _Elm_Map_Route_Type
22765 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22766 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22767 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22768 ELM_MAP_ROUTE_TYPE_LAST
22769 } Elm_Map_Route_Type;
22772 * @enum _Elm_Map_Route_Method
22773 * @typedef Elm_Map_Route_Method
22775 * Set the routing method, what should be priorized, time or distance.
22777 * @see elm_map_route_add()
22781 typedef enum _Elm_Map_Route_Method
22783 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22784 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22785 ELM_MAP_ROUTE_METHOD_LAST
22786 } Elm_Map_Route_Method;
22788 typedef enum _Elm_Map_Name_Method
22790 ELM_MAP_NAME_METHOD_SEARCH,
22791 ELM_MAP_NAME_METHOD_REVERSE,
22792 ELM_MAP_NAME_METHOD_LAST
22793 } Elm_Map_Name_Method;
22795 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(). */
22796 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(). */
22797 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(). */
22798 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(). */
22799 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22800 typedef struct _Elm_Map_Track Elm_Map_Track;
22802 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. */
22803 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22804 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22805 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22807 typedef char *(*ElmMapModuleSourceFunc) (void);
22808 typedef int (*ElmMapModuleZoomMinFunc) (void);
22809 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22810 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22811 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22812 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22813 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22814 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22815 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22818 * Add a new map widget to the given parent Elementary (container) object.
22820 * @param parent The parent object.
22821 * @return a new map widget handle or @c NULL, on errors.
22823 * This function inserts a new map widget on the canvas.
22827 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22830 * Set the zoom level of the map.
22832 * @param obj The map object.
22833 * @param zoom The zoom level to set.
22835 * This sets the zoom level.
22837 * It will respect limits defined by elm_map_source_zoom_min_set() and
22838 * elm_map_source_zoom_max_set().
22840 * By default these values are 0 (world map) and 18 (maximum zoom).
22842 * This function should be used when zoom mode is set to
22843 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22844 * with elm_map_zoom_mode_set().
22846 * @see elm_map_zoom_mode_set().
22847 * @see elm_map_zoom_get().
22851 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22854 * Get the zoom level of the map.
22856 * @param obj The map object.
22857 * @return The current zoom level.
22859 * This returns the current zoom level of the map object.
22861 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22862 * (which is the default), the zoom level may be changed at any time by the
22863 * map object itself to account for map size and map viewport size.
22865 * @see elm_map_zoom_set() for details.
22869 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22872 * Set the zoom mode used by the map object.
22874 * @param obj The map object.
22875 * @param mode The zoom mode of the map, being it one of
22876 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22877 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22879 * This sets the zoom mode to manual or one of the automatic levels.
22880 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22881 * elm_map_zoom_set() and will stay at that level until changed by code
22882 * or until zoom mode is changed. This is the default mode.
22884 * The Automatic modes will allow the map object to automatically
22885 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22886 * adjust zoom so the map fits inside the scroll frame with no pixels
22887 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22888 * ensure no pixels within the frame are left unfilled. Do not forget that
22889 * the valid sizes are 2^zoom, consequently the map may be smaller than
22890 * the scroller view.
22892 * @see elm_map_zoom_set()
22896 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22899 * Get the zoom mode used by the map object.
22901 * @param obj The map object.
22902 * @return The zoom mode of the map, being it one of
22903 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22904 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22906 * This function returns the current zoom mode used by the map object.
22908 * @see elm_map_zoom_mode_set() for more details.
22912 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22915 * Get the current coordinates of the map.
22917 * @param obj The map object.
22918 * @param lon Pointer where to store longitude.
22919 * @param lat Pointer where to store latitude.
22921 * This gets the current center coordinates of the map object. It can be
22922 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22924 * @see elm_map_geo_region_bring_in()
22925 * @see elm_map_geo_region_show()
22929 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22932 * Animatedly bring in given coordinates to the center of the map.
22934 * @param obj The map object.
22935 * @param lon Longitude to center at.
22936 * @param lat Latitude to center at.
22938 * This causes map to jump to the given @p lat and @p lon coordinates
22939 * and show it (by scrolling) in the center of the viewport, if it is not
22940 * already centered. This will use animation to do so and take a period
22941 * of time to complete.
22943 * @see elm_map_geo_region_show() for a function to avoid animation.
22944 * @see elm_map_geo_region_get()
22948 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22951 * Show the given coordinates at the center of the map, @b immediately.
22953 * @param obj The map object.
22954 * @param lon Longitude to center at.
22955 * @param lat Latitude to center at.
22957 * This causes map to @b redraw its viewport's contents to the
22958 * region contining the given @p lat and @p lon, that will be moved to the
22959 * center of the map.
22961 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22962 * @see elm_map_geo_region_get()
22966 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22969 * Pause or unpause the map.
22971 * @param obj The map object.
22972 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22975 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22978 * The default is off.
22980 * This will stop zooming using animation, changing zoom levels will
22981 * change instantly. This will stop any existing animations that are running.
22983 * @see elm_map_paused_get()
22987 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22990 * Get a value whether map is paused or not.
22992 * @param obj The map object.
22993 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22994 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22996 * This gets the current paused state for the map object.
22998 * @see elm_map_paused_set() for details.
23002 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23005 * Set to show markers during zoom level changes or not.
23007 * @param obj The map object.
23008 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23011 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23014 * The default is off.
23016 * This will stop zooming using animation, changing zoom levels will
23017 * change instantly. This will stop any existing animations that are running.
23019 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23022 * The default is off.
23024 * Enabling it will force the map to stop displaying the markers during
23025 * zoom level changes. Set to on if you have a large number of markers.
23027 * @see elm_map_paused_markers_get()
23031 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23034 * Get a value whether markers will be displayed on zoom level changes or not
23036 * @param obj The map object.
23037 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23038 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23040 * This gets the current markers paused state for the map object.
23042 * @see elm_map_paused_markers_set() for details.
23046 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23049 * Get the information of downloading status.
23051 * @param obj The map object.
23052 * @param try_num Pointer where to store number of tiles being downloaded.
23053 * @param finish_num Pointer where to store number of tiles successfully
23056 * This gets the current downloading status for the map object, the number
23057 * of tiles being downloaded and the number of tiles already downloaded.
23061 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23064 * Convert a pixel coordinate (x,y) into a geographic coordinate
23065 * (longitude, latitude).
23067 * @param obj The map object.
23068 * @param x the coordinate.
23069 * @param y the coordinate.
23070 * @param size the size in pixels of the map.
23071 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23072 * @param lon Pointer where to store the longitude that correspond to x.
23073 * @param lat Pointer where to store the latitude that correspond to y.
23075 * @note Origin pixel point is the top left corner of the viewport.
23076 * Map zoom and size are taken on account.
23078 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23082 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);
23085 * Convert a geographic coordinate (longitude, latitude) into a pixel
23086 * coordinate (x, y).
23088 * @param obj The map object.
23089 * @param lon the longitude.
23090 * @param lat the latitude.
23091 * @param size the size in pixels of the map. The map is a square
23092 * and generally his size is : pow(2.0, zoom)*256.
23093 * @param x Pointer where to store the horizontal pixel coordinate that
23094 * correspond to the longitude.
23095 * @param y Pointer where to store the vertical pixel coordinate that
23096 * correspond to the latitude.
23098 * @note Origin pixel point is the top left corner of the viewport.
23099 * Map zoom and size are taken on account.
23101 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23105 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);
23108 * Convert a geographic coordinate (longitude, latitude) into a name
23111 * @param obj The map object.
23112 * @param lon the longitude.
23113 * @param lat the latitude.
23114 * @return name A #Elm_Map_Name handle for this coordinate.
23116 * To get the string for this address, elm_map_name_address_get()
23119 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23123 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23126 * Convert a name (address) into a geographic coordinate
23127 * (longitude, latitude).
23129 * @param obj The map object.
23130 * @param name The address.
23131 * @return name A #Elm_Map_Name handle for this address.
23133 * To get the longitude and latitude, elm_map_name_region_get()
23136 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23140 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23143 * Convert a pixel coordinate into a rotated pixel coordinate.
23145 * @param obj The map object.
23146 * @param x horizontal coordinate of the point to rotate.
23147 * @param y vertical coordinate of the point to rotate.
23148 * @param cx rotation's center horizontal position.
23149 * @param cy rotation's center vertical position.
23150 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23151 * @param xx Pointer where to store rotated x.
23152 * @param yy Pointer where to store rotated y.
23156 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);
23159 * Add a new marker to the map object.
23161 * @param obj The map object.
23162 * @param lon The longitude of the marker.
23163 * @param lat The latitude of the marker.
23164 * @param clas The class, to use when marker @b isn't grouped to others.
23165 * @param clas_group The class group, to use when marker is grouped to others
23166 * @param data The data passed to the callbacks.
23168 * @return The created marker or @c NULL upon failure.
23170 * A marker will be created and shown in a specific point of the map, defined
23171 * by @p lon and @p lat.
23173 * It will be displayed using style defined by @p class when this marker
23174 * is displayed alone (not grouped). A new class can be created with
23175 * elm_map_marker_class_new().
23177 * If the marker is grouped to other markers, it will be displayed with
23178 * style defined by @p class_group. Markers with the same group are grouped
23179 * if they are close. A new group class can be created with
23180 * elm_map_marker_group_class_new().
23182 * Markers created with this method can be deleted with
23183 * elm_map_marker_remove().
23185 * A marker can have associated content to be displayed by a bubble,
23186 * when a user click over it, as well as an icon. These objects will
23187 * be fetch using class' callback functions.
23189 * @see elm_map_marker_class_new()
23190 * @see elm_map_marker_group_class_new()
23191 * @see elm_map_marker_remove()
23195 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);
23198 * Set the maximum numbers of markers' content to be displayed in a group.
23200 * @param obj The map object.
23201 * @param max The maximum numbers of items displayed in a bubble.
23203 * A bubble will be displayed when the user clicks over the group,
23204 * and will place the content of markers that belong to this group
23207 * A group can have a long list of markers, consequently the creation
23208 * of the content of the bubble can be very slow.
23210 * In order to avoid this, a maximum number of items is displayed
23213 * By default this number is 30.
23215 * Marker with the same group class are grouped if they are close.
23217 * @see elm_map_marker_add()
23221 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23224 * Remove a marker from the map.
23226 * @param marker The marker to remove.
23228 * @see elm_map_marker_add()
23232 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23235 * Get the current coordinates of the marker.
23237 * @param marker marker.
23238 * @param lat Pointer where to store the marker's latitude.
23239 * @param lon Pointer where to store the marker's longitude.
23241 * These values are set when adding markers, with function
23242 * elm_map_marker_add().
23244 * @see elm_map_marker_add()
23248 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23251 * Animatedly bring in given marker to the center of the map.
23253 * @param marker The marker to center at.
23255 * This causes map to jump to the given @p marker's coordinates
23256 * and show it (by scrolling) in the center of the viewport, if it is not
23257 * already centered. This will use animation to do so and take a period
23258 * of time to complete.
23260 * @see elm_map_marker_show() for a function to avoid animation.
23261 * @see elm_map_marker_region_get()
23265 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23268 * Show the given marker at the center of the map, @b immediately.
23270 * @param marker The marker to center at.
23272 * This causes map to @b redraw its viewport's contents to the
23273 * region contining the given @p marker's coordinates, that will be
23274 * moved to the center of the map.
23276 * @see elm_map_marker_bring_in() for a function to move with animation.
23277 * @see elm_map_markers_list_show() if more than one marker need to be
23279 * @see elm_map_marker_region_get()
23283 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23286 * Move and zoom the map to display a list of markers.
23288 * @param markers A list of #Elm_Map_Marker handles.
23290 * The map will be centered on the center point of the markers in the list.
23291 * Then the map will be zoomed in order to fit the markers using the maximum
23292 * zoom which allows display of all the markers.
23294 * @warning All the markers should belong to the same map object.
23296 * @see elm_map_marker_show() to show a single marker.
23297 * @see elm_map_marker_bring_in()
23301 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23304 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23306 * @param marker The marker wich content should be returned.
23307 * @return Return the evas object if it exists, else @c NULL.
23309 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23310 * elm_map_marker_class_get_cb_set() should be used.
23312 * This content is what will be inside the bubble that will be displayed
23313 * when an user clicks over the marker.
23315 * This returns the actual Evas object used to be placed inside
23316 * the bubble. This may be @c NULL, as it may
23317 * not have been created or may have been deleted, at any time, by
23318 * the map. <b>Do not modify this object</b> (move, resize,
23319 * show, hide, etc.), as the map is controlling it. This
23320 * function is for querying, emitting custom signals or hooking
23321 * lower level callbacks for events on that object. Do not delete
23322 * this object under any circumstances.
23326 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23329 * Update the marker
23331 * @param marker The marker to be updated.
23333 * If a content is set to this marker, it will call function to delete it,
23334 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23335 * #ElmMapMarkerGetFunc.
23337 * These functions are set for the marker class with
23338 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23342 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23345 * Close all the bubbles opened by the user.
23347 * @param obj The map object.
23349 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23350 * when the user clicks on a marker.
23352 * This functions is set for the marker class with
23353 * elm_map_marker_class_get_cb_set().
23357 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23360 * Create a new group class.
23362 * @param obj The map object.
23363 * @return Returns the new group class.
23365 * Each marker must be associated to a group class. Markers in the same
23366 * group are grouped if they are close.
23368 * The group class defines the style of the marker when a marker is grouped
23369 * to others markers. When it is alone, another class will be used.
23371 * A group class will need to be provided when creating a marker with
23372 * elm_map_marker_add().
23374 * Some properties and functions can be set by class, as:
23375 * - style, with elm_map_group_class_style_set()
23376 * - data - to be associated to the group class. It can be set using
23377 * elm_map_group_class_data_set().
23378 * - min zoom to display markers, set with
23379 * elm_map_group_class_zoom_displayed_set().
23380 * - max zoom to group markers, set using
23381 * elm_map_group_class_zoom_grouped_set().
23382 * - visibility - set if markers will be visible or not, set with
23383 * elm_map_group_class_hide_set().
23384 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23385 * It can be set using elm_map_group_class_icon_cb_set().
23387 * @see elm_map_marker_add()
23388 * @see elm_map_group_class_style_set()
23389 * @see elm_map_group_class_data_set()
23390 * @see elm_map_group_class_zoom_displayed_set()
23391 * @see elm_map_group_class_zoom_grouped_set()
23392 * @see elm_map_group_class_hide_set()
23393 * @see elm_map_group_class_icon_cb_set()
23397 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23400 * Set the marker's style of a group class.
23402 * @param clas The group class.
23403 * @param style The style to be used by markers.
23405 * Each marker must be associated to a group class, and will use the style
23406 * defined by such class when grouped to other markers.
23408 * The following styles are provided by default theme:
23409 * @li @c radio - blue circle
23410 * @li @c radio2 - green circle
23413 * @see elm_map_group_class_new() for more details.
23414 * @see elm_map_marker_add()
23418 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23421 * Set the icon callback function of a group class.
23423 * @param clas The group class.
23424 * @param icon_get The callback function that will return the icon.
23426 * Each marker must be associated to a group class, and it can display a
23427 * custom icon. The function @p icon_get must return this icon.
23429 * @see elm_map_group_class_new() for more details.
23430 * @see elm_map_marker_add()
23434 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23437 * Set the data associated to the group class.
23439 * @param clas The group class.
23440 * @param data The new user data.
23442 * This data will be passed for callback functions, like icon get callback,
23443 * that can be set with elm_map_group_class_icon_cb_set().
23445 * If a data was previously set, the object will lose the pointer for it,
23446 * so if needs to be freed, you must do it yourself.
23448 * @see elm_map_group_class_new() for more details.
23449 * @see elm_map_group_class_icon_cb_set()
23450 * @see elm_map_marker_add()
23454 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23457 * Set the minimum zoom from where the markers are displayed.
23459 * @param clas The group class.
23460 * @param zoom The minimum zoom.
23462 * Markers only will be displayed when the map is displayed at @p zoom
23465 * @see elm_map_group_class_new() for more details.
23466 * @see elm_map_marker_add()
23470 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23473 * Set the zoom from where the markers are no more grouped.
23475 * @param clas The group class.
23476 * @param zoom The maximum zoom.
23478 * Markers only will be grouped when the map is displayed at
23479 * less than @p zoom.
23481 * @see elm_map_group_class_new() for more details.
23482 * @see elm_map_marker_add()
23486 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23489 * Set if the markers associated to the group class @clas are hidden or not.
23491 * @param clas The group class.
23492 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23495 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23500 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23503 * Create a new marker class.
23505 * @param obj The map object.
23506 * @return Returns the new group class.
23508 * Each marker must be associated to a class.
23510 * The marker class defines the style of the marker when a marker is
23511 * displayed alone, i.e., not grouped to to others markers. When grouped
23512 * it will use group class style.
23514 * A marker class will need to be provided when creating a marker with
23515 * elm_map_marker_add().
23517 * Some properties and functions can be set by class, as:
23518 * - style, with elm_map_marker_class_style_set()
23519 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23520 * It can be set using elm_map_marker_class_icon_cb_set().
23521 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23522 * Set using elm_map_marker_class_get_cb_set().
23523 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23524 * Set using elm_map_marker_class_del_cb_set().
23526 * @see elm_map_marker_add()
23527 * @see elm_map_marker_class_style_set()
23528 * @see elm_map_marker_class_icon_cb_set()
23529 * @see elm_map_marker_class_get_cb_set()
23530 * @see elm_map_marker_class_del_cb_set()
23534 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23537 * Set the marker's style of a marker class.
23539 * @param clas The marker class.
23540 * @param style The style to be used by markers.
23542 * Each marker must be associated to a marker class, and will use the style
23543 * defined by such class when alone, i.e., @b not grouped to other markers.
23545 * The following styles are provided by default theme:
23550 * @see elm_map_marker_class_new() for more details.
23551 * @see elm_map_marker_add()
23555 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23558 * Set the icon callback function of a marker class.
23560 * @param clas The marker class.
23561 * @param icon_get The callback function that will return the icon.
23563 * Each marker must be associated to a marker class, and it can display a
23564 * custom icon. The function @p icon_get must return this icon.
23566 * @see elm_map_marker_class_new() for more details.
23567 * @see elm_map_marker_add()
23571 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23574 * Set the bubble content callback function of a marker class.
23576 * @param clas The marker class.
23577 * @param get The callback function that will return the content.
23579 * Each marker must be associated to a marker class, and it can display a
23580 * a content on a bubble that opens when the user click over the marker.
23581 * The function @p get must return this content object.
23583 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23586 * @see elm_map_marker_class_new() for more details.
23587 * @see elm_map_marker_class_del_cb_set()
23588 * @see elm_map_marker_add()
23592 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23595 * Set the callback function used to delete bubble content of a marker class.
23597 * @param clas The marker class.
23598 * @param del The callback function that will delete the content.
23600 * Each marker must be associated to a marker class, and it can display a
23601 * a content on a bubble that opens when the user click over the marker.
23602 * The function to return such content can be set with
23603 * elm_map_marker_class_get_cb_set().
23605 * If this content must be freed, a callback function need to be
23606 * set for that task with this function.
23608 * If this callback is defined it will have to delete (or not) the
23609 * object inside, but if the callback is not defined the object will be
23610 * destroyed with evas_object_del().
23612 * @see elm_map_marker_class_new() for more details.
23613 * @see elm_map_marker_class_get_cb_set()
23614 * @see elm_map_marker_add()
23618 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23621 * Get the list of available sources.
23623 * @param obj The map object.
23624 * @return The source names list.
23626 * It will provide a list with all available sources, that can be set as
23627 * current source with elm_map_source_name_set(), or get with
23628 * elm_map_source_name_get().
23630 * Available sources:
23636 * @see elm_map_source_name_set() for more details.
23637 * @see elm_map_source_name_get()
23641 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23644 * Set the source of the map.
23646 * @param obj The map object.
23647 * @param source The source to be used.
23649 * Map widget retrieves images that composes the map from a web service.
23650 * This web service can be set with this method.
23652 * A different service can return a different maps with different
23653 * information and it can use different zoom values.
23655 * The @p source_name need to match one of the names provided by
23656 * elm_map_source_names_get().
23658 * The current source can be get using elm_map_source_name_get().
23660 * @see elm_map_source_names_get()
23661 * @see elm_map_source_name_get()
23666 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23669 * Get the name of currently used source.
23671 * @param obj The map object.
23672 * @return Returns the name of the source in use.
23674 * @see elm_map_source_name_set() for more details.
23678 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23681 * Set the source of the route service to be used by the map.
23683 * @param obj The map object.
23684 * @param source The route service to be used, being it one of
23685 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23686 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23688 * Each one has its own algorithm, so the route retrieved may
23689 * differ depending on the source route. Now, only the default is working.
23691 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23692 * http://www.yournavigation.org/.
23694 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23695 * assumptions. Its routing core is based on Contraction Hierarchies.
23697 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23699 * @see elm_map_route_source_get().
23703 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23706 * Get the current route source.
23708 * @param obj The map object.
23709 * @return The source of the route service used by the map.
23711 * @see elm_map_route_source_set() for details.
23715 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23718 * Set the minimum zoom of the source.
23720 * @param obj The map object.
23721 * @param zoom New minimum zoom value to be used.
23723 * By default, it's 0.
23727 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23730 * Get the minimum zoom of the source.
23732 * @param obj The map object.
23733 * @return Returns the minimum zoom of the source.
23735 * @see elm_map_source_zoom_min_set() for details.
23739 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23742 * Set the maximum zoom of the source.
23744 * @param obj The map object.
23745 * @param zoom New maximum zoom value to be used.
23747 * By default, it's 18.
23751 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23754 * Get the maximum zoom of the source.
23756 * @param obj The map object.
23757 * @return Returns the maximum zoom of the source.
23759 * @see elm_map_source_zoom_min_set() for details.
23763 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23766 * Set the user agent used by the map object to access routing services.
23768 * @param obj The map object.
23769 * @param user_agent The user agent to be used by the map.
23771 * User agent is a client application implementing a network protocol used
23772 * in communications within a clientāserver distributed computing system
23774 * The @p user_agent identification string will transmitted in a header
23775 * field @c User-Agent.
23777 * @see elm_map_user_agent_get()
23781 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23784 * Get the user agent used by the map object.
23786 * @param obj The map object.
23787 * @return The user agent identification string used by the map.
23789 * @see elm_map_user_agent_set() for details.
23793 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23796 * Add a new route to the map object.
23798 * @param obj The map object.
23799 * @param type The type of transport to be considered when tracing a route.
23800 * @param method The routing method, what should be priorized.
23801 * @param flon The start longitude.
23802 * @param flat The start latitude.
23803 * @param tlon The destination longitude.
23804 * @param tlat The destination latitude.
23806 * @return The created route or @c NULL upon failure.
23808 * A route will be traced by point on coordinates (@p flat, @p flon)
23809 * to point on coordinates (@p tlat, @p tlon), using the route service
23810 * set with elm_map_route_source_set().
23812 * It will take @p type on consideration to define the route,
23813 * depending if the user will be walking or driving, the route may vary.
23814 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23815 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23817 * Another parameter is what the route should priorize, the minor distance
23818 * or the less time to be spend on the route. So @p method should be one
23819 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23821 * Routes created with this method can be deleted with
23822 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23823 * and distance can be get with elm_map_route_distance_get().
23825 * @see elm_map_route_remove()
23826 * @see elm_map_route_color_set()
23827 * @see elm_map_route_distance_get()
23828 * @see elm_map_route_source_set()
23832 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);
23835 * Remove a route from the map.
23837 * @param route The route to remove.
23839 * @see elm_map_route_add()
23843 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23846 * Set the route color.
23848 * @param route The route object.
23849 * @param r Red channel value, from 0 to 255.
23850 * @param g Green channel value, from 0 to 255.
23851 * @param b Blue channel value, from 0 to 255.
23852 * @param a Alpha channel value, from 0 to 255.
23854 * It uses an additive color model, so each color channel represents
23855 * how much of each primary colors must to be used. 0 represents
23856 * ausence of this color, so if all of the three are set to 0,
23857 * the color will be black.
23859 * These component values should be integers in the range 0 to 255,
23860 * (single 8-bit byte).
23862 * This sets the color used for the route. By default, it is set to
23863 * solid red (r = 255, g = 0, b = 0, a = 255).
23865 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23867 * @see elm_map_route_color_get()
23871 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23874 * Get the route color.
23876 * @param route The route object.
23877 * @param r Pointer where to store the red channel value.
23878 * @param g Pointer where to store the green channel value.
23879 * @param b Pointer where to store the blue channel value.
23880 * @param a Pointer where to store the alpha channel value.
23882 * @see elm_map_route_color_set() for details.
23886 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23889 * Get the route distance in kilometers.
23891 * @param route The route object.
23892 * @return The distance of route (unit : km).
23896 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23899 * Get the information of route nodes.
23901 * @param route The route object.
23902 * @return Returns a string with the nodes of route.
23906 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23909 * Get the information of route waypoint.
23911 * @param route the route object.
23912 * @return Returns a string with information about waypoint of route.
23916 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23919 * Get the address of the name.
23921 * @param name The name handle.
23922 * @return Returns the address string of @p name.
23924 * This gets the coordinates of the @p name, created with one of the
23925 * conversion functions.
23927 * @see elm_map_utils_convert_name_into_coord()
23928 * @see elm_map_utils_convert_coord_into_name()
23932 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23935 * Get the current coordinates of the name.
23937 * @param name The name handle.
23938 * @param lat Pointer where to store the latitude.
23939 * @param lon Pointer where to store The longitude.
23941 * This gets the coordinates of the @p name, created with one of the
23942 * conversion functions.
23944 * @see elm_map_utils_convert_name_into_coord()
23945 * @see elm_map_utils_convert_coord_into_name()
23949 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23952 * Remove a name from the map.
23954 * @param name The name to remove.
23956 * Basically the struct handled by @p name will be freed, so convertions
23957 * between address and coordinates will be lost.
23959 * @see elm_map_utils_convert_name_into_coord()
23960 * @see elm_map_utils_convert_coord_into_name()
23964 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23969 * @param obj The map object.
23970 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23971 * @param cx Rotation's center horizontal position.
23972 * @param cy Rotation's center vertical position.
23974 * @see elm_map_rotate_get()
23978 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23981 * Get the rotate degree of the map
23983 * @param obj The map object
23984 * @param degree Pointer where to store degrees from 0.0 to 360.0
23985 * to rotate arount Z axis.
23986 * @param cx Pointer where to store rotation's center horizontal position.
23987 * @param cy Pointer where to store rotation's center vertical position.
23989 * @see elm_map_rotate_set() to set map rotation.
23993 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);
23996 * Enable or disable mouse wheel to be used to zoom in / out the map.
23998 * @param obj The map object.
23999 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24002 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24004 * It's disabled by default.
24006 * @see elm_map_wheel_disabled_get()
24010 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24013 * Get a value whether mouse wheel is enabled or not.
24015 * @param obj The map object.
24016 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24017 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24019 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24021 * @see elm_map_wheel_disabled_set() for details.
24025 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24029 * Add a track on the map
24031 * @param obj The map object.
24032 * @param emap The emap route object.
24033 * @return The route object. This is an elm object of type Route.
24035 * @see elm_route_add() for details.
24039 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24043 * Remove a track from the map
24045 * @param obj The map object.
24046 * @param route The track to remove.
24050 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24057 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24059 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24061 EAPI double elm_route_lon_min_get(Evas_Object *obj);
24062 EAPI double elm_route_lat_min_get(Evas_Object *obj);
24063 EAPI double elm_route_lon_max_get(Evas_Object *obj);
24064 EAPI double elm_route_lat_max_get(Evas_Object *obj);
24068 * @defgroup Panel Panel
24070 * @image html img/widget/panel/preview-00.png
24071 * @image latex img/widget/panel/preview-00.eps
24073 * @brief A panel is a type of animated container that contains subobjects.
24074 * It can be expanded or contracted by clicking the button on it's edge.
24076 * Orientations are as follows:
24077 * @li ELM_PANEL_ORIENT_TOP
24078 * @li ELM_PANEL_ORIENT_LEFT
24079 * @li ELM_PANEL_ORIENT_RIGHT
24081 * Default contents parts of the panel widget that you can use for are:
24082 * @li "default" - A content of the panel
24084 * @ref tutorial_panel shows one way to use this widget.
24087 typedef enum _Elm_Panel_Orient
24089 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24090 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24091 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24092 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24093 } Elm_Panel_Orient;
24095 * @brief Adds a panel object
24097 * @param parent The parent object
24099 * @return The panel object, or NULL on failure
24101 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24103 * @brief Sets the orientation of the panel
24105 * @param parent The parent object
24106 * @param orient The panel orientation. Can be one of the following:
24107 * @li ELM_PANEL_ORIENT_TOP
24108 * @li ELM_PANEL_ORIENT_LEFT
24109 * @li ELM_PANEL_ORIENT_RIGHT
24111 * Sets from where the panel will (dis)appear.
24113 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24115 * @brief Get the orientation of the panel.
24117 * @param obj The panel object
24118 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24120 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24122 * @brief Set the content of the panel.
24124 * @param obj The panel object
24125 * @param content The panel content
24127 * Once the content object is set, a previously set one will be deleted.
24128 * If you want to keep that old content object, use the
24129 * elm_panel_content_unset() function.
24131 * @deprecated use elm_object_content_set() instead
24134 WILL_DEPRECATE EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24136 * @brief Get the content of the panel.
24138 * @param obj The panel object
24139 * @return The content that is being used
24141 * Return the content object which is set for this widget.
24143 * @see elm_panel_content_set()
24145 * @deprecated use elm_object_content_get() instead
24148 WILL_DEPRECATE EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 * @brief Unset the content of the panel.
24152 * @param obj The panel object
24153 * @return The content that was being used
24155 * Unparent and return the content object which was set for this widget.
24157 * @see elm_panel_content_set()
24159 * @deprecated use elm_object_content_unset() instead
24162 WILL_DEPRECATE EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24164 * @brief Set the state of the panel.
24166 * @param obj The panel object
24167 * @param hidden If true, the panel will run the animation to contract
24169 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24171 * @brief Get the state of the panel.
24173 * @param obj The panel object
24174 * @param hidden If true, the panel is in the "hide" state
24176 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24178 * @brief Toggle the hidden state of the panel from code
24180 * @param obj The panel object
24182 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24188 * @defgroup Panes Panes
24189 * @ingroup Elementary
24191 * @image html img/widget/panes/preview-00.png
24192 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24194 * @image html img/panes.png
24195 * @image latex img/panes.eps width=\textwidth
24197 * The panes adds a dragable bar between two contents. When dragged
24198 * this bar will resize contents size.
24200 * Panes can be displayed vertically or horizontally, and contents
24201 * size proportion can be customized (homogeneous by default).
24203 * Smart callbacks one can listen to:
24204 * - "press" - The panes has been pressed (button wasn't released yet).
24205 * - "unpressed" - The panes was released after being pressed.
24206 * - "clicked" - The panes has been clicked>
24207 * - "clicked,double" - The panes has been double clicked
24209 * Available styles for it:
24212 * Default contents parts of the panes widget that you can use for are:
24213 * @li "left" - A leftside content of the panes
24214 * @li "right" - A rightside content of the panes
24216 * If panes is displayed vertically, left content will be displayed at
24219 * Here is an example on its usage:
24220 * @li @ref panes_example
24224 * @addtogroup Panes
24229 * Add a new panes widget to the given parent Elementary
24230 * (container) object.
24232 * @param parent The parent object.
24233 * @return a new panes widget handle or @c NULL, on errors.
24235 * This function inserts a new panes widget on the canvas.
24239 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24242 * Set the left content of the panes widget.
24244 * @param obj The panes object.
24245 * @param content The new left content object.
24247 * Once the content object is set, a previously set one will be deleted.
24248 * If you want to keep that old content object, use the
24249 * elm_panes_content_left_unset() function.
24251 * If panes is displayed vertically, left content will be displayed at
24254 * @see elm_panes_content_left_get()
24255 * @see elm_panes_content_right_set() to set content on the other side.
24257 * @deprecated use elm_object_part_content_set() instead
24261 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24264 * Set the right content of the panes widget.
24266 * @param obj The panes object.
24267 * @param content The new right content object.
24269 * Once the content object is set, a previously set one will be deleted.
24270 * If you want to keep that old content object, use the
24271 * elm_panes_content_right_unset() function.
24273 * If panes is displayed vertically, left content will be displayed at
24276 * @see elm_panes_content_right_get()
24277 * @see elm_panes_content_left_set() to set content on the other side.
24279 * @deprecated use elm_object_part_content_set() instead
24283 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24286 * Get the left content of the panes.
24288 * @param obj The panes object.
24289 * @return The left content object that is being used.
24291 * Return the left content object which is set for this widget.
24293 * @see elm_panes_content_left_set() for details.
24295 * @deprecated use elm_object_part_content_get() instead
24299 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24302 * Get the right content of the panes.
24304 * @param obj The panes object
24305 * @return The right content object that is being used
24307 * Return the right content object which is set for this widget.
24309 * @see elm_panes_content_right_set() for details.
24311 * @deprecated use elm_object_part_content_get() instead
24315 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24318 * Unset the left content used for the panes.
24320 * @param obj The panes object.
24321 * @return The left content object that was being used.
24323 * Unparent and return the left content object which was set for this widget.
24325 * @see elm_panes_content_left_set() for details.
24326 * @see elm_panes_content_left_get().
24328 * @deprecated use elm_object_part_content_unset() instead
24332 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24335 * Unset the right content used for the panes.
24337 * @param obj The panes object.
24338 * @return The right content object that was being used.
24340 * Unparent and return the right content object which was set for this
24343 * @see elm_panes_content_right_set() for details.
24344 * @see elm_panes_content_right_get().
24346 * @deprecated use elm_object_part_content_unset() instead
24350 WILL_DEPRECATE EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24353 * Get the size proportion of panes widget's left side.
24355 * @param obj The panes object.
24356 * @return float value between 0.0 and 1.0 representing size proportion
24359 * @see elm_panes_content_left_size_set() for more details.
24363 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24366 * Set the size proportion of panes widget's left side.
24368 * @param obj The panes object.
24369 * @param size Value between 0.0 and 1.0 representing size proportion
24372 * By default it's homogeneous, i.e., both sides have the same size.
24374 * If something different is required, it can be set with this function.
24375 * For example, if the left content should be displayed over
24376 * 75% of the panes size, @p size should be passed as @c 0.75.
24377 * This way, right content will be resized to 25% of panes size.
24379 * If displayed vertically, left content is displayed at top, and
24380 * right content at bottom.
24382 * @note This proportion will change when user drags the panes bar.
24384 * @see elm_panes_content_left_size_get()
24388 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24391 * Set the orientation of a given panes widget.
24393 * @param obj The panes object.
24394 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24395 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24397 * Use this function to change how your panes is to be
24398 * disposed: vertically or horizontally.
24400 * By default it's displayed horizontally.
24402 * @see elm_panes_horizontal_get()
24406 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24409 * Retrieve the orientation of a given panes widget.
24411 * @param obj The panes object.
24412 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24413 * @c EINA_FALSE if it's @b vertical (and on errors).
24415 * @see elm_panes_horizontal_set() for more details.
24419 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24420 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24421 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24428 * @defgroup Flip Flip
24430 * @image html img/widget/flip/preview-00.png
24431 * @image latex img/widget/flip/preview-00.eps
24433 * This widget holds 2 content objects(Evas_Object): one on the front and one
24434 * on the back. It allows you to flip from front to back and vice-versa using
24435 * various animations.
24437 * If either the front or back contents are not set the flip will treat that
24438 * as transparent. So if you wore to set the front content but not the back,
24439 * and then call elm_flip_go() you would see whatever is below the flip.
24441 * For a list of supported animations see elm_flip_go().
24443 * Signals that you can add callbacks for are:
24444 * "animate,begin" - when a flip animation was started
24445 * "animate,done" - when a flip animation is finished
24447 * @ref tutorial_flip show how to use most of the API.
24451 typedef enum _Elm_Flip_Mode
24453 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24454 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24455 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24456 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24457 ELM_FLIP_CUBE_LEFT,
24458 ELM_FLIP_CUBE_RIGHT,
24460 ELM_FLIP_CUBE_DOWN,
24461 ELM_FLIP_PAGE_LEFT,
24462 ELM_FLIP_PAGE_RIGHT,
24466 typedef enum _Elm_Flip_Interaction
24468 ELM_FLIP_INTERACTION_NONE,
24469 ELM_FLIP_INTERACTION_ROTATE,
24470 ELM_FLIP_INTERACTION_CUBE,
24471 ELM_FLIP_INTERACTION_PAGE
24472 } Elm_Flip_Interaction;
24473 typedef enum _Elm_Flip_Direction
24475 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24476 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24477 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24478 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24479 } Elm_Flip_Direction;
24481 * @brief Add a new flip to the parent
24483 * @param parent The parent object
24484 * @return The new object or NULL if it cannot be created
24486 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24488 * @brief Set the front content of the flip widget.
24490 * @param obj The flip object
24491 * @param content The new front content object
24493 * Once the content object is set, a previously set one will be deleted.
24494 * If you want to keep that old content object, use the
24495 * elm_flip_content_front_unset() function.
24497 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24499 * @brief Set the back content of the flip widget.
24501 * @param obj The flip object
24502 * @param content The new back content object
24504 * Once the content object is set, a previously set one will be deleted.
24505 * If you want to keep that old content object, use the
24506 * elm_flip_content_back_unset() function.
24508 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24510 * @brief Get the front content used for the flip
24512 * @param obj The flip object
24513 * @return The front content object that is being used
24515 * Return the front content object which is set for this widget.
24517 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24519 * @brief Get the back content used for the flip
24521 * @param obj The flip object
24522 * @return The back content object that is being used
24524 * Return the back content object which is set for this widget.
24526 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24528 * @brief Unset the front content used for the flip
24530 * @param obj The flip object
24531 * @return The front content object that was being used
24533 * Unparent and return the front content object which was set for this widget.
24535 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24537 * @brief Unset the back content used for the flip
24539 * @param obj The flip object
24540 * @return The back content object that was being used
24542 * Unparent and return the back content object which was set for this widget.
24544 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24546 * @brief Get flip front visibility state
24548 * @param obj The flip objct
24549 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24552 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24554 * @brief Set flip perspective
24556 * @param obj The flip object
24557 * @param foc The coordinate to set the focus on
24558 * @param x The X coordinate
24559 * @param y The Y coordinate
24561 * @warning This function currently does nothing.
24563 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24565 * @brief Runs the flip animation
24567 * @param obj The flip object
24568 * @param mode The mode type
24570 * Flips the front and back contents using the @p mode animation. This
24571 * efectively hides the currently visible content and shows the hidden one.
24573 * There a number of possible animations to use for the flipping:
24574 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24575 * around a horizontal axis in the middle of its height, the other content
24576 * is shown as the other side of the flip.
24577 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24578 * around a vertical axis in the middle of its width, the other content is
24579 * shown as the other side of the flip.
24580 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24581 * around a diagonal axis in the middle of its width, the other content is
24582 * shown as the other side of the flip.
24583 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24584 * around a diagonal axis in the middle of its height, the other content is
24585 * shown as the other side of the flip.
24586 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24587 * as if the flip was a cube, the other content is show as the right face of
24589 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24590 * right as if the flip was a cube, the other content is show as the left
24591 * face of the cube.
24592 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24593 * flip was a cube, the other content is show as the bottom face of the cube.
24594 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24595 * the flip was a cube, the other content is show as the upper face of the
24597 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24598 * if the flip was a book, the other content is shown as the page below that.
24599 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24600 * as if the flip was a book, the other content is shown as the page below
24602 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24603 * flip was a book, the other content is shown as the page below that.
24604 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24605 * flip was a book, the other content is shown as the page below that.
24607 * @image html elm_flip.png
24608 * @image latex elm_flip.eps width=\textwidth
24610 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24612 * @brief Set the interactive flip mode
24614 * @param obj The flip object
24615 * @param mode The interactive flip mode to use
24617 * This sets if the flip should be interactive (allow user to click and
24618 * drag a side of the flip to reveal the back page and cause it to flip).
24619 * By default a flip is not interactive. You may also need to set which
24620 * sides of the flip are "active" for flipping and how much space they use
24621 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24622 * and elm_flip_interacton_direction_hitsize_set()
24624 * The four avilable mode of interaction are:
24625 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24626 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24627 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24628 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24630 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24631 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24632 * happen, those can only be acheived with elm_flip_go();
24634 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24636 * @brief Get the interactive flip mode
24638 * @param obj The flip object
24639 * @return The interactive flip mode
24641 * Returns the interactive flip mode set by elm_flip_interaction_set()
24643 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24645 * @brief Set which directions of the flip respond to interactive flip
24647 * @param obj The flip object
24648 * @param dir The direction to change
24649 * @param enabled If that direction is enabled or not
24651 * By default all directions are disabled, so you may want to enable the
24652 * desired directions for flipping if you need interactive flipping. You must
24653 * call this function once for each direction that should be enabled.
24655 * @see elm_flip_interaction_set()
24657 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24659 * @brief Get the enabled state of that flip direction
24661 * @param obj The flip object
24662 * @param dir The direction to check
24663 * @return If that direction is enabled or not
24665 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24667 * @see elm_flip_interaction_set()
24669 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24671 * @brief Set the amount of the flip that is sensitive to interactive flip
24673 * @param obj The flip object
24674 * @param dir The direction to modify
24675 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24677 * Set the amount of the flip that is sensitive to interactive flip, with 0
24678 * representing no area in the flip and 1 representing the entire flip. There
24679 * is however a consideration to be made in that the area will never be
24680 * smaller than the finger size set(as set in your Elementary configuration).
24682 * @see elm_flip_interaction_set()
24684 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24686 * @brief Get the amount of the flip that is sensitive to interactive flip
24688 * @param obj The flip object
24689 * @param dir The direction to check
24690 * @return The size set for that direction
24692 * Returns the amount os sensitive area set by
24693 * elm_flip_interacton_direction_hitsize_set().
24695 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24700 /* scrolledentry */
24701 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24702 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24703 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24704 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24705 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24706 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24707 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24708 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24709 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24710 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24711 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24712 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24713 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24714 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24715 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24716 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24717 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24718 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24719 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24720 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24721 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24722 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24723 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24724 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24725 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24726 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24727 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24728 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24729 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24730 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24731 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24732 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24733 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24734 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24735 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24736 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);
24737 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24738 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24739 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);
24740 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24741 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);
24742 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24743 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24744 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24745 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24746 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24747 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24748 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24749 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24750 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);
24751 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);
24752 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);
24753 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);
24754 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);
24755 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);
24756 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24757 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24758 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24759 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24760 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24761 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24762 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24765 * @defgroup Conformant Conformant
24766 * @ingroup Elementary
24768 * @image html img/widget/conformant/preview-00.png
24769 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24771 * @image html img/conformant.png
24772 * @image latex img/conformant.eps width=\textwidth
24774 * The aim is to provide a widget that can be used in elementary apps to
24775 * account for space taken up by the indicator, virtual keypad & softkey
24776 * windows when running the illume2 module of E17.
24778 * So conformant content will be sized and positioned considering the
24779 * space required for such stuff, and when they popup, as a keyboard
24780 * shows when an entry is selected, conformant content won't change.
24782 * Available styles for it:
24785 * Default contents parts of the conformant widget that you can use for are:
24786 * @li "default" - A content of the conformant
24788 * See how to use this widget in this example:
24789 * @ref conformant_example
24793 * @addtogroup Conformant
24798 * Add a new conformant widget to the given parent Elementary
24799 * (container) object.
24801 * @param parent The parent object.
24802 * @return A new conformant widget handle or @c NULL, on errors.
24804 * This function inserts a new conformant widget on the canvas.
24806 * @ingroup Conformant
24808 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24811 * Set the content of the conformant widget.
24813 * @param obj The conformant object.
24814 * @param content The content to be displayed by the conformant.
24816 * Content will be sized and positioned considering the space required
24817 * to display a virtual keyboard. So it won't fill all the conformant
24818 * size. This way is possible to be sure that content won't resize
24819 * or be re-positioned after the keyboard is displayed.
24821 * Once the content object is set, a previously set one will be deleted.
24822 * If you want to keep that old content object, use the
24823 * elm_object_content_unset() function.
24825 * @see elm_object_content_unset()
24826 * @see elm_object_content_get()
24828 * @deprecated use elm_object_content_set() instead
24830 * @ingroup Conformant
24832 WILL_DEPRECATE EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24835 * Get the content of the conformant widget.
24837 * @param obj The conformant object.
24838 * @return The content that is being used.
24840 * Return the content object which is set for this widget.
24841 * It won't be unparent from conformant. For that, use
24842 * elm_object_content_unset().
24844 * @see elm_object_content_set().
24845 * @see elm_object_content_unset()
24847 * @deprecated use elm_object_content_get() instead
24849 * @ingroup Conformant
24851 WILL_DEPRECATE EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24854 * Unset the content of the conformant widget.
24856 * @param obj The conformant object.
24857 * @return The content that was being used.
24859 * Unparent and return the content object which was set for this widget.
24861 * @see elm_object_content_set().
24863 * @deprecated use elm_object_content_unset() instead
24865 * @ingroup Conformant
24867 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24870 * Returns the Evas_Object that represents the content area.
24872 * @param obj The conformant object.
24873 * @return The content area of the widget.
24875 * @ingroup Conformant
24877 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24884 * @defgroup Mapbuf Mapbuf
24885 * @ingroup Elementary
24887 * @image html img/widget/mapbuf/preview-00.png
24888 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24890 * This holds one content object and uses an Evas Map of transformation
24891 * points to be later used with this content. So the content will be
24892 * moved, resized, etc as a single image. So it will improve performance
24893 * when you have a complex interafce, with a lot of elements, and will
24894 * need to resize or move it frequently (the content object and its
24897 * Default contents parts of the mapbuf widget that you can use for are:
24898 * @li "default" - A content of the mapbuf
24900 * To enable map, elm_mapbuf_enabled_set() should be used.
24902 * See how to use this widget in this example:
24903 * @ref mapbuf_example
24907 * @addtogroup Mapbuf
24912 * Add a new mapbuf widget to the given parent Elementary
24913 * (container) object.
24915 * @param parent The parent object.
24916 * @return A new mapbuf widget handle or @c NULL, on errors.
24918 * This function inserts a new mapbuf widget on the canvas.
24922 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24925 * Set the content of the mapbuf.
24927 * @param obj The mapbuf object.
24928 * @param content The content that will be filled in this mapbuf object.
24930 * Once the content object is set, a previously set one will be deleted.
24931 * If you want to keep that old content object, use the
24932 * elm_mapbuf_content_unset() function.
24934 * To enable map, elm_mapbuf_enabled_set() should be used.
24936 * @deprecated use elm_object_content_set() instead
24940 WILL_DEPRECATE EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24943 * Get the content of the mapbuf.
24945 * @param obj The mapbuf object.
24946 * @return The content that is being used.
24948 * Return the content object which is set for this widget.
24950 * @see elm_mapbuf_content_set() for details.
24952 * @deprecated use elm_object_content_get() instead
24956 WILL_DEPRECATE EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24959 * Unset the content of the mapbuf.
24961 * @param obj The mapbuf object.
24962 * @return The content that was being used.
24964 * Unparent and return the content object which was set for this widget.
24966 * @see elm_mapbuf_content_set() for details.
24968 * @deprecated use elm_object_content_unset() instead
24972 WILL_DEPRECATE EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24975 * Enable or disable the map.
24977 * @param obj The mapbuf object.
24978 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24980 * This enables the map that is set or disables it. On enable, the object
24981 * geometry will be saved, and the new geometry will change (position and
24982 * size) to reflect the map geometry set.
24984 * Also, when enabled, alpha and smooth states will be used, so if the
24985 * content isn't solid, alpha should be enabled, for example, otherwise
24986 * a black retangle will fill the content.
24988 * When disabled, the stored map will be freed and geometry prior to
24989 * enabling the map will be restored.
24991 * It's disabled by default.
24993 * @see elm_mapbuf_alpha_set()
24994 * @see elm_mapbuf_smooth_set()
24998 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25001 * Get a value whether map is enabled or not.
25003 * @param obj The mapbuf object.
25004 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25005 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25007 * @see elm_mapbuf_enabled_set() for details.
25011 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25014 * Enable or disable smooth map rendering.
25016 * @param obj The mapbuf object.
25017 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25020 * This sets smoothing for map rendering. If the object is a type that has
25021 * its own smoothing settings, then both the smooth settings for this object
25022 * and the map must be turned off.
25024 * By default smooth maps are enabled.
25028 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25031 * Get a value whether smooth map rendering is enabled or not.
25033 * @param obj The mapbuf object.
25034 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25035 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25037 * @see elm_mapbuf_smooth_set() for details.
25041 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25044 * Set or unset alpha flag for map rendering.
25046 * @param obj The mapbuf object.
25047 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25050 * This sets alpha flag for map rendering. If the object is a type that has
25051 * its own alpha settings, then this will take precedence. Only image objects
25052 * have this currently. It stops alpha blending of the map area, and is
25053 * useful if you know the object and/or all sub-objects is 100% solid.
25055 * Alpha is enabled by default.
25059 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25062 * Get a value whether alpha blending is enabled or not.
25064 * @param obj The mapbuf object.
25065 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25066 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25068 * @see elm_mapbuf_alpha_set() for details.
25072 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25079 * @defgroup Flipselector Flip Selector
25081 * @image html img/widget/flipselector/preview-00.png
25082 * @image latex img/widget/flipselector/preview-00.eps
25084 * A flip selector is a widget to show a set of @b text items, one
25085 * at a time, with the same sheet switching style as the @ref Clock
25086 * "clock" widget, when one changes the current displaying sheet
25087 * (thus, the "flip" in the name).
25089 * User clicks to flip sheets which are @b held for some time will
25090 * make the flip selector to flip continuosly and automatically for
25091 * the user. The interval between flips will keep growing in time,
25092 * so that it helps the user to reach an item which is distant from
25093 * the current selection.
25095 * Smart callbacks one can register to:
25096 * - @c "selected" - when the widget's selected text item is changed
25097 * - @c "overflowed" - when the widget's current selection is changed
25098 * from the first item in its list to the last
25099 * - @c "underflowed" - when the widget's current selection is changed
25100 * from the last item in its list to the first
25102 * Available styles for it:
25105 * To set/get the label of the flipselector item, you can use
25106 * elm_object_item_text_set/get APIs.
25107 * Once the text is set, a previously set one will be deleted.
25109 * Here is an example on its usage:
25110 * @li @ref flipselector_example
25114 * @addtogroup Flipselector
25119 * Add a new flip selector widget to the given parent Elementary
25120 * (container) widget
25122 * @param parent The parent object
25123 * @return a new flip selector widget handle or @c NULL, on errors
25125 * This function inserts a new flip selector widget on the canvas.
25127 * @ingroup Flipselector
25129 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25132 * Programmatically select the next item of a flip selector widget
25134 * @param obj The flipselector object
25136 * @note The selection will be animated. Also, if it reaches the
25137 * end of its list of member items, it will continue with the first
25140 * @ingroup Flipselector
25142 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25145 * Programmatically select the previous item of a flip selector
25148 * @param obj The flipselector object
25150 * @note The selection will be animated. Also, if it reaches the
25151 * beginning of its list of member items, it will continue with the
25152 * last one backwards.
25154 * @ingroup Flipselector
25156 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25159 * Append a (text) item to a flip selector widget
25161 * @param obj The flipselector object
25162 * @param label The (text) label of the new item
25163 * @param func Convenience callback function to take place when
25165 * @param data Data passed to @p func, above
25166 * @return A handle to the item added or @c NULL, on errors
25168 * The widget's list of labels to show will be appended with the
25169 * given value. If the user wishes so, a callback function pointer
25170 * can be passed, which will get called when this same item is
25173 * @note The current selection @b won't be modified by appending an
25174 * element to the list.
25176 * @note The maximum length of the text label is going to be
25177 * determined <b>by the widget's theme</b>. Strings larger than
25178 * that value are going to be @b truncated.
25180 * @ingroup Flipselector
25182 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25185 * Prepend a (text) item to a flip selector widget
25187 * @param obj The flipselector object
25188 * @param label The (text) label of the new item
25189 * @param func Convenience callback function to take place when
25191 * @param data Data passed to @p func, above
25192 * @return A handle to the item added or @c NULL, on errors
25194 * The widget's list of labels to show will be prepended with the
25195 * given value. If the user wishes so, a callback function pointer
25196 * can be passed, which will get called when this same item is
25199 * @note The current selection @b won't be modified by prepending
25200 * an element to the list.
25202 * @note The maximum length of the text label is going to be
25203 * determined <b>by the widget's theme</b>. Strings larger than
25204 * that value are going to be @b truncated.
25206 * @ingroup Flipselector
25208 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25211 * Get the internal list of items in a given flip selector widget.
25213 * @param obj The flipselector object
25214 * @return The list of items (#Elm_Object_Item as data) or
25215 * @c NULL on errors.
25217 * This list is @b not to be modified in any way and must not be
25218 * freed. Use the list members with functions like
25219 * elm_object_item_text_set(),
25220 * elm_object_item_text_get(),
25221 * elm_flipselector_item_del(),
25222 * elm_flipselector_item_selected_get(),
25223 * elm_flipselector_item_selected_set().
25225 * @warning This list is only valid until @p obj object's internal
25226 * items list is changed. It should be fetched again with another
25227 * call to this function when changes happen.
25229 * @ingroup Flipselector
25231 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25234 * Get the first item in the given flip selector widget's list of
25237 * @param obj The flipselector object
25238 * @return The first item or @c NULL, if it has no items (and on
25241 * @see elm_flipselector_item_append()
25242 * @see elm_flipselector_last_item_get()
25244 * @ingroup Flipselector
25246 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25249 * Get the last item in the given flip selector widget's list of
25252 * @param obj The flipselector object
25253 * @return The last item or @c NULL, if it has no items (and on
25256 * @see elm_flipselector_item_prepend()
25257 * @see elm_flipselector_first_item_get()
25259 * @ingroup Flipselector
25261 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25264 * Get the currently selected item in a flip selector widget.
25266 * @param obj The flipselector object
25267 * @return The selected item or @c NULL, if the widget has no items
25270 * @ingroup Flipselector
25272 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25275 * Set whether a given flip selector widget's item should be the
25276 * currently selected one.
25278 * @param it The flip selector item
25279 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25281 * This sets whether @p item is or not the selected (thus, under
25282 * display) one. If @p item is different than one under display,
25283 * the latter will be unselected. If the @p item is set to be
25284 * unselected, on the other hand, the @b first item in the widget's
25285 * internal members list will be the new selected one.
25287 * @see elm_flipselector_item_selected_get()
25289 * @ingroup Flipselector
25291 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25294 * Get whether a given flip selector widget's item is the currently
25297 * @param it The flip selector item
25298 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25301 * @see elm_flipselector_item_selected_set()
25303 * @ingroup Flipselector
25305 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25308 * Delete a given item from a flip selector widget.
25310 * @param it The item to delete
25312 * @ingroup Flipselector
25314 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25317 * Get the label of a given flip selector widget's item.
25319 * @param it The item to get label from
25320 * @return The text label of @p item or @c NULL, on errors
25322 * @see elm_object_item_text_set()
25324 * @deprecated see elm_object_item_text_get() instead
25325 * @ingroup Flipselector
25327 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25330 * Set the label of a given flip selector widget's item.
25332 * @param it The item to set label on
25333 * @param label The text label string, in UTF-8 encoding
25335 * @see elm_object_item_text_get()
25337 * @deprecated see elm_object_item_text_set() instead
25338 * @ingroup Flipselector
25340 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25343 * Gets the item before @p item in a flip selector widget's
25344 * internal list of items.
25346 * @param it The item to fetch previous from
25347 * @return The item before the @p item, in its parent's list. If
25348 * there is no previous item for @p item or there's an
25349 * error, @c NULL is returned.
25351 * @see elm_flipselector_item_next_get()
25353 * @ingroup Flipselector
25355 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25358 * Gets the item after @p item in a flip selector widget's
25359 * internal list of items.
25361 * @param it The item to fetch next from
25362 * @return The item after the @p item, in its parent's list. If
25363 * there is no next item for @p item or there's an
25364 * error, @c NULL is returned.
25366 * @see elm_flipselector_item_next_get()
25368 * @ingroup Flipselector
25370 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25373 * Set the interval on time updates for an user mouse button hold
25374 * on a flip selector widget.
25376 * @param obj The flip selector object
25377 * @param interval The (first) interval value in seconds
25379 * This interval value is @b decreased while the user holds the
25380 * mouse pointer either flipping up or flipping doww a given flip
25383 * This helps the user to get to a given item distant from the
25384 * current one easier/faster, as it will start to flip quicker and
25385 * quicker on mouse button holds.
25387 * The calculation for the next flip interval value, starting from
25388 * the one set with this call, is the previous interval divided by
25389 * 1.05, so it decreases a little bit.
25391 * The default starting interval value for automatic flips is
25394 * @see elm_flipselector_interval_get()
25396 * @ingroup Flipselector
25398 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25401 * Get the interval on time updates for an user mouse button hold
25402 * on a flip selector widget.
25404 * @param obj The flip selector object
25405 * @return The (first) interval value, in seconds, set on it
25407 * @see elm_flipselector_interval_set() for more details
25409 * @ingroup Flipselector
25411 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25417 * @addtogroup Calendar
25422 * @enum _Elm_Calendar_Mark_Repeat
25423 * @typedef Elm_Calendar_Mark_Repeat
25425 * Event periodicity, used to define if a mark should be repeated
25426 * @b beyond event's day. It's set when a mark is added.
25428 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25429 * there will be marks every week after this date. Marks will be displayed
25430 * at 13th, 20th, 27th, 3rd June ...
25432 * Values don't work as bitmask, only one can be choosen.
25434 * @see elm_calendar_mark_add()
25436 * @ingroup Calendar
25438 typedef enum _Elm_Calendar_Mark_Repeat
25440 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25441 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25442 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25443 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*/
25444 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. */
25445 } Elm_Calendar_Mark_Repeat;
25447 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(). */
25450 * Add a new calendar widget to the given parent Elementary
25451 * (container) object.
25453 * @param parent The parent object.
25454 * @return a new calendar widget handle or @c NULL, on errors.
25456 * This function inserts a new calendar widget on the canvas.
25458 * @ref calendar_example_01
25460 * @ingroup Calendar
25462 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25465 * Get weekdays names displayed by the calendar.
25467 * @param obj The calendar object.
25468 * @return Array of seven strings to be used as weekday names.
25470 * By default, weekdays abbreviations get from system are displayed:
25471 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25472 * The first string is related to Sunday, the second to Monday...
25474 * @see elm_calendar_weekdays_name_set()
25476 * @ref calendar_example_05
25478 * @ingroup Calendar
25480 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25483 * Set weekdays names to be displayed by the calendar.
25485 * @param obj The calendar object.
25486 * @param weekdays Array of seven strings to be used as weekday names.
25487 * @warning It must have 7 elements, or it will access invalid memory.
25488 * @warning The strings must be NULL terminated ('@\0').
25490 * By default, weekdays abbreviations get from system are displayed:
25491 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25493 * The first string should be related to Sunday, the second to Monday...
25495 * The usage should be like this:
25497 * const char *weekdays[] =
25499 * "Sunday", "Monday", "Tuesday", "Wednesday",
25500 * "Thursday", "Friday", "Saturday"
25502 * elm_calendar_weekdays_names_set(calendar, weekdays);
25505 * @see elm_calendar_weekdays_name_get()
25507 * @ref calendar_example_02
25509 * @ingroup Calendar
25511 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25514 * Set the minimum and maximum values for the year
25516 * @param obj The calendar object
25517 * @param min The minimum year, greater than 1901;
25518 * @param max The maximum year;
25520 * Maximum must be greater than minimum, except if you don't wan't to set
25522 * Default values are 1902 and -1.
25524 * If the maximum year is a negative value, it will be limited depending
25525 * on the platform architecture (year 2037 for 32 bits);
25527 * @see elm_calendar_min_max_year_get()
25529 * @ref calendar_example_03
25531 * @ingroup Calendar
25533 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25536 * Get the minimum and maximum values for the year
25538 * @param obj The calendar object.
25539 * @param min The minimum year.
25540 * @param max The maximum year.
25542 * Default values are 1902 and -1.
25544 * @see elm_calendar_min_max_year_get() for more details.
25546 * @ref calendar_example_05
25548 * @ingroup Calendar
25550 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25553 * Enable or disable day selection
25555 * @param obj The calendar object.
25556 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25559 * Enabled by default. If disabled, the user still can select months,
25560 * but not days. Selected days are highlighted on calendar.
25561 * It should be used if you won't need such selection for the widget usage.
25563 * When a day is selected, or month is changed, smart callbacks for
25564 * signal "changed" will be called.
25566 * @see elm_calendar_day_selection_enable_get()
25568 * @ref calendar_example_04
25570 * @ingroup Calendar
25572 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25575 * Get a value whether day selection is enabled or not.
25577 * @see elm_calendar_day_selection_enable_set() for details.
25579 * @param obj The calendar object.
25580 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25581 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25583 * @ref calendar_example_05
25585 * @ingroup Calendar
25587 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25591 * Set selected date to be highlighted on calendar.
25593 * @param obj The calendar object.
25594 * @param selected_time A @b tm struct to represent the selected date.
25596 * Set the selected date, changing the displayed month if needed.
25597 * Selected date changes when the user goes to next/previous month or
25598 * select a day pressing over it on calendar.
25600 * @see elm_calendar_selected_time_get()
25602 * @ref calendar_example_04
25604 * @ingroup Calendar
25606 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25609 * Get selected date.
25611 * @param obj The calendar object
25612 * @param selected_time A @b tm struct to point to selected date
25613 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25616 * Get date selected by the user or set by function
25617 * elm_calendar_selected_time_set().
25618 * Selected date changes when the user goes to next/previous month or
25619 * select a day pressing over it on calendar.
25621 * @see elm_calendar_selected_time_get()
25623 * @ref calendar_example_05
25625 * @ingroup Calendar
25627 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25630 * Set a function to format the string that will be used to display
25633 * @param obj The calendar object
25634 * @param format_function Function to set the month-year string given
25635 * the selected date
25637 * By default it uses strftime with "%B %Y" format string.
25638 * It should allocate the memory that will be used by the string,
25639 * that will be freed by the widget after usage.
25640 * A pointer to the string and a pointer to the time struct will be provided.
25645 * _format_month_year(struct tm *selected_time)
25648 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25649 * return strdup(buf);
25652 * elm_calendar_format_function_set(calendar, _format_month_year);
25655 * @ref calendar_example_02
25657 * @ingroup Calendar
25659 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25662 * Add a new mark to the calendar
25664 * @param obj The calendar object
25665 * @param mark_type A string used to define the type of mark. It will be
25666 * emitted to the theme, that should display a related modification on these
25667 * days representation.
25668 * @param mark_time A time struct to represent the date of inclusion of the
25669 * mark. For marks that repeats it will just be displayed after the inclusion
25670 * date in the calendar.
25671 * @param repeat Repeat the event following this periodicity. Can be a unique
25672 * mark (that don't repeat), daily, weekly, monthly or annually.
25673 * @return The created mark or @p NULL upon failure.
25675 * Add a mark that will be drawn in the calendar respecting the insertion
25676 * time and periodicity. It will emit the type as signal to the widget theme.
25677 * Default theme supports "holiday" and "checked", but it can be extended.
25679 * It won't immediately update the calendar, drawing the marks.
25680 * For this, call elm_calendar_marks_draw(). However, when user selects
25681 * next or previous month calendar forces marks drawn.
25683 * Marks created with this method can be deleted with
25684 * elm_calendar_mark_del().
25688 * struct tm selected_time;
25689 * time_t current_time;
25691 * current_time = time(NULL) + 5 * 84600;
25692 * localtime_r(¤t_time, &selected_time);
25693 * elm_calendar_mark_add(cal, "holiday", selected_time,
25694 * ELM_CALENDAR_ANNUALLY);
25696 * current_time = time(NULL) + 1 * 84600;
25697 * localtime_r(¤t_time, &selected_time);
25698 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25700 * elm_calendar_marks_draw(cal);
25703 * @see elm_calendar_marks_draw()
25704 * @see elm_calendar_mark_del()
25706 * @ref calendar_example_06
25708 * @ingroup Calendar
25710 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);
25713 * Delete mark from the calendar.
25715 * @param mark The mark to be deleted.
25717 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25718 * should be used instead of getting marks list and deleting each one.
25720 * @see elm_calendar_mark_add()
25722 * @ref calendar_example_06
25724 * @ingroup Calendar
25726 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25729 * Remove all calendar's marks
25731 * @param obj The calendar object.
25733 * @see elm_calendar_mark_add()
25734 * @see elm_calendar_mark_del()
25736 * @ingroup Calendar
25738 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25742 * Get a list of all the calendar marks.
25744 * @param obj The calendar object.
25745 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25747 * @see elm_calendar_mark_add()
25748 * @see elm_calendar_mark_del()
25749 * @see elm_calendar_marks_clear()
25751 * @ingroup Calendar
25753 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25756 * Draw calendar marks.
25758 * @param obj The calendar object.
25760 * Should be used after adding, removing or clearing marks.
25761 * It will go through the entire marks list updating the calendar.
25762 * If lots of marks will be added, add all the marks and then call
25765 * When the month is changed, i.e. user selects next or previous month,
25766 * marks will be drawed.
25768 * @see elm_calendar_mark_add()
25769 * @see elm_calendar_mark_del()
25770 * @see elm_calendar_marks_clear()
25772 * @ref calendar_example_06
25774 * @ingroup Calendar
25776 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25779 * Set a day text color to the same that represents Saturdays.
25781 * @param obj The calendar object.
25782 * @param pos The text position. Position is the cell counter, from left
25783 * to right, up to down. It starts on 0 and ends on 41.
25785 * @deprecated use elm_calendar_mark_add() instead like:
25788 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25789 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25792 * @see elm_calendar_mark_add()
25794 * @ingroup Calendar
25796 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25799 * Set a day text color to the same that represents Sundays.
25801 * @param obj The calendar object.
25802 * @param pos The text position. Position is the cell counter, from left
25803 * to right, up to down. It starts on 0 and ends on 41.
25805 * @deprecated use elm_calendar_mark_add() instead like:
25808 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25809 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25812 * @see elm_calendar_mark_add()
25814 * @ingroup Calendar
25816 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25819 * Set a day text color to the same that represents Weekdays.
25821 * @param obj The calendar object
25822 * @param pos The text position. Position is the cell counter, from left
25823 * to right, up to down. It starts on 0 and ends on 41.
25825 * @deprecated use elm_calendar_mark_add() instead like:
25828 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25830 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25831 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25832 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25833 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25834 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25835 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25836 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25837 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25838 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25841 * @see elm_calendar_mark_add()
25843 * @ingroup Calendar
25845 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25848 * Set the interval on time updates for an user mouse button hold
25849 * on calendar widgets' month selection.
25851 * @param obj The calendar object
25852 * @param interval The (first) interval value in seconds
25854 * This interval value is @b decreased while the user holds the
25855 * mouse pointer either selecting next or previous month.
25857 * This helps the user to get to a given month distant from the
25858 * current one easier/faster, as it will start to change quicker and
25859 * quicker on mouse button holds.
25861 * The calculation for the next change interval value, starting from
25862 * the one set with this call, is the previous interval divided by
25863 * 1.05, so it decreases a little bit.
25865 * The default starting interval value for automatic changes is
25868 * @see elm_calendar_interval_get()
25870 * @ingroup Calendar
25872 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25875 * Get the interval on time updates for an user mouse button hold
25876 * on calendar widgets' month selection.
25878 * @param obj The calendar object
25879 * @return The (first) interval value, in seconds, set on it
25881 * @see elm_calendar_interval_set() for more details
25883 * @ingroup Calendar
25885 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25892 * @defgroup Diskselector Diskselector
25893 * @ingroup Elementary
25895 * @image html img/widget/diskselector/preview-00.png
25896 * @image latex img/widget/diskselector/preview-00.eps
25898 * A diskselector is a kind of list widget. It scrolls horizontally,
25899 * and can contain label and icon objects. Three items are displayed
25900 * with the selected one in the middle.
25902 * It can act like a circular list with round mode and labels can be
25903 * reduced for a defined length for side items.
25905 * Smart callbacks one can listen to:
25906 * - "selected" - when item is selected, i.e. scroller stops.
25908 * Available styles for it:
25911 * List of examples:
25912 * @li @ref diskselector_example_01
25913 * @li @ref diskselector_example_02
25917 * @addtogroup Diskselector
25921 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(). */
25924 * Add a new diskselector widget to the given parent Elementary
25925 * (container) object.
25927 * @param parent The parent object.
25928 * @return a new diskselector widget handle or @c NULL, on errors.
25930 * This function inserts a new diskselector widget on the canvas.
25932 * @ingroup Diskselector
25934 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25937 * Enable or disable round mode.
25939 * @param obj The diskselector object.
25940 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25943 * Disabled by default. If round mode is enabled the items list will
25944 * work like a circle list, so when the user reaches the last item,
25945 * the first one will popup.
25947 * @see elm_diskselector_round_get()
25949 * @ingroup Diskselector
25951 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25954 * Get a value whether round mode is enabled or not.
25956 * @see elm_diskselector_round_set() for details.
25958 * @param obj The diskselector object.
25959 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25960 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25962 * @ingroup Diskselector
25964 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25967 * Get the side labels max length.
25969 * @deprecated use elm_diskselector_side_label_length_get() instead:
25971 * @param obj The diskselector object.
25972 * @return The max length defined for side labels, or 0 if not a valid
25975 * @ingroup Diskselector
25977 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25980 * Set the side labels max length.
25982 * @deprecated use elm_diskselector_side_label_length_set() instead:
25984 * @param obj The diskselector object.
25985 * @param len The max length defined for side labels.
25987 * @ingroup Diskselector
25989 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25992 * Get the side labels max length.
25994 * @see elm_diskselector_side_label_length_set() for details.
25996 * @param obj The diskselector object.
25997 * @return The max length defined for side labels, or 0 if not a valid
26000 * @ingroup Diskselector
26002 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26005 * Set the side labels max length.
26007 * @param obj The diskselector object.
26008 * @param len The max length defined for side labels.
26010 * Length is the number of characters of items' label that will be
26011 * visible when it's set on side positions. It will just crop
26012 * the string after defined size. E.g.:
26014 * An item with label "January" would be displayed on side position as
26015 * "Jan" if max length is set to 3, or "Janu", if this property
26018 * When it's selected, the entire label will be displayed, except for
26019 * width restrictions. In this case label will be cropped and "..."
26020 * will be concatenated.
26022 * Default side label max length is 3.
26024 * This property will be applyed over all items, included before or
26025 * later this function call.
26027 * @ingroup Diskselector
26029 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26032 * Set the number of items to be displayed.
26034 * @param obj The diskselector object.
26035 * @param num The number of items the diskselector will display.
26037 * Default value is 3, and also it's the minimun. If @p num is less
26038 * than 3, it will be set to 3.
26040 * Also, it can be set on theme, using data item @c display_item_num
26041 * on group "elm/diskselector/item/X", where X is style set.
26044 * group { name: "elm/diskselector/item/X";
26046 * item: "display_item_num" "5";
26049 * @ingroup Diskselector
26051 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26054 * Get the number of items in the diskselector object.
26056 * @param obj The diskselector object.
26058 * @ingroup Diskselector
26060 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26063 * Set bouncing behaviour when the scrolled content reaches an edge.
26065 * Tell the internal scroller object whether it should bounce or not
26066 * when it reaches the respective edges for each axis.
26068 * @param obj The diskselector object.
26069 * @param h_bounce Whether to bounce or not in the horizontal axis.
26070 * @param v_bounce Whether to bounce or not in the vertical axis.
26072 * @see elm_scroller_bounce_set()
26074 * @ingroup Diskselector
26076 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26079 * Get the bouncing behaviour of the internal scroller.
26081 * Get whether the internal scroller should bounce when the edge of each
26082 * axis is reached scrolling.
26084 * @param obj The diskselector object.
26085 * @param h_bounce Pointer where to store the bounce state of the horizontal
26087 * @param v_bounce Pointer where to store the bounce state of the vertical
26090 * @see elm_scroller_bounce_get()
26091 * @see elm_diskselector_bounce_set()
26093 * @ingroup Diskselector
26095 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26098 * Get the scrollbar policy.
26100 * @see elm_diskselector_scroller_policy_get() for details.
26102 * @param obj The diskselector object.
26103 * @param policy_h Pointer where to store horizontal scrollbar policy.
26104 * @param policy_v Pointer where to store vertical scrollbar policy.
26106 * @ingroup Diskselector
26108 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);
26111 * Set the scrollbar policy.
26113 * @param obj The diskselector object.
26114 * @param policy_h Horizontal scrollbar policy.
26115 * @param policy_v Vertical scrollbar policy.
26117 * This sets the scrollbar visibility policy for the given scroller.
26118 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26119 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26120 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26121 * This applies respectively for the horizontal and vertical scrollbars.
26123 * The both are disabled by default, i.e., are set to
26124 * #ELM_SCROLLER_POLICY_OFF.
26126 * @ingroup Diskselector
26128 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26131 * Remove all diskselector's items.
26133 * @param obj The diskselector object.
26135 * @see elm_diskselector_item_del()
26136 * @see elm_diskselector_item_append()
26138 * @ingroup Diskselector
26140 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26143 * Get a list of all the diskselector items.
26145 * @param obj The diskselector object.
26146 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26147 * or @c NULL on failure.
26149 * @see elm_diskselector_item_append()
26150 * @see elm_diskselector_item_del()
26151 * @see elm_diskselector_clear()
26153 * @ingroup Diskselector
26155 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26158 * Appends a new item to the diskselector object.
26160 * @param obj The diskselector object.
26161 * @param label The label of the diskselector item.
26162 * @param icon The icon object to use at left side of the item. An
26163 * icon can be any Evas object, but usually it is an icon created
26164 * with elm_icon_add().
26165 * @param func The function to call when the item is selected.
26166 * @param data The data to associate with the item for related callbacks.
26168 * @return The created item or @c NULL upon failure.
26170 * A new item will be created and appended to the diskselector, i.e., will
26171 * be set as last item. Also, if there is no selected item, it will
26172 * be selected. This will always happens for the first appended item.
26174 * If no icon is set, label will be centered on item position, otherwise
26175 * the icon will be placed at left of the label, that will be shifted
26178 * Items created with this method can be deleted with
26179 * elm_diskselector_item_del().
26181 * Associated @p data can be properly freed when item is deleted if a
26182 * callback function is set with elm_diskselector_item_del_cb_set().
26184 * If a function is passed as argument, it will be called everytime this item
26185 * is selected, i.e., the user stops the diskselector with this
26186 * item on center position. If such function isn't needed, just passing
26187 * @c NULL as @p func is enough. The same should be done for @p data.
26189 * Simple example (with no function callback or data associated):
26191 * disk = elm_diskselector_add(win);
26192 * ic = elm_icon_add(win);
26193 * elm_icon_file_set(ic, "path/to/image", NULL);
26194 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26195 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26198 * @see elm_diskselector_item_del()
26199 * @see elm_diskselector_item_del_cb_set()
26200 * @see elm_diskselector_clear()
26201 * @see elm_icon_add()
26203 * @ingroup Diskselector
26205 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);
26209 * Delete them item from the diskselector.
26211 * @param it The item of diskselector to be deleted.
26213 * If deleting all diskselector items is required, elm_diskselector_clear()
26214 * should be used instead of getting items list and deleting each one.
26216 * @see elm_diskselector_clear()
26217 * @see elm_diskselector_item_append()
26218 * @see elm_diskselector_item_del_cb_set()
26220 * @ingroup Diskselector
26222 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26225 * Set the function called when a diskselector item is freed.
26227 * @param it The item to set the callback on
26228 * @param func The function called
26230 * If there is a @p func, then it will be called prior item's memory release.
26231 * That will be called with the following arguments:
26233 * @li item's Evas object;
26236 * This way, a data associated to a diskselector item could be properly
26239 * @ingroup Diskselector
26241 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26244 * Get the data associated to the item.
26246 * @param it The diskselector item
26247 * @return The data associated to @p it
26249 * The return value is a pointer to data associated to @p item when it was
26250 * created, with function elm_diskselector_item_append(). If no data
26251 * was passed as argument, it will return @c NULL.
26253 * @see elm_diskselector_item_append()
26255 * @ingroup Diskselector
26257 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26260 * Set the icon associated to the item.
26262 * @param it The diskselector item
26263 * @param icon The icon object to associate with @p it
26265 * The icon object to use at left side of the item. An
26266 * icon can be any Evas object, but usually it is an icon created
26267 * with elm_icon_add().
26269 * Once the icon object is set, a previously set one will be deleted.
26270 * @warning Setting the same icon for two items will cause the icon to
26271 * dissapear from the first item.
26273 * If an icon was passed as argument on item creation, with function
26274 * elm_diskselector_item_append(), it will be already
26275 * associated to the item.
26277 * @see elm_diskselector_item_append()
26278 * @see elm_diskselector_item_icon_get()
26280 * @ingroup Diskselector
26282 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26285 * Get the icon associated to the item.
26287 * @param it The diskselector item
26288 * @return The icon associated to @p it
26290 * The return value is a pointer to the icon associated to @p item when it was
26291 * created, with function elm_diskselector_item_append(), or later
26292 * with function elm_diskselector_item_icon_set. If no icon
26293 * was passed as argument, it will return @c NULL.
26295 * @see elm_diskselector_item_append()
26296 * @see elm_diskselector_item_icon_set()
26298 * @ingroup Diskselector
26300 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26303 * Set the label of item.
26305 * @param it The item of diskselector.
26306 * @param label The label of item.
26308 * The label to be displayed by the item.
26310 * If no icon is set, label will be centered on item position, otherwise
26311 * the icon will be placed at left of the label, that will be shifted
26314 * An item with label "January" would be displayed on side position as
26315 * "Jan" if max length is set to 3 with function
26316 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26319 * When this @p item is selected, the entire label will be displayed,
26320 * except for width restrictions.
26321 * In this case label will be cropped and "..." will be concatenated,
26322 * but only for display purposes. It will keep the entire string, so
26323 * if diskselector is resized the remaining characters will be displayed.
26325 * If a label was passed as argument on item creation, with function
26326 * elm_diskselector_item_append(), it will be already
26327 * displayed by the item.
26329 * @see elm_diskselector_side_label_lenght_set()
26330 * @see elm_diskselector_item_label_get()
26331 * @see elm_diskselector_item_append()
26333 * @ingroup Diskselector
26335 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26338 * Get the label of item.
26340 * @param it The item of diskselector.
26341 * @return The label of item.
26343 * The return value is a pointer to the label associated to @p item when it was
26344 * created, with function elm_diskselector_item_append(), or later
26345 * with function elm_diskselector_item_label_set. If no label
26346 * was passed as argument, it will return @c NULL.
26348 * @see elm_diskselector_item_label_set() for more details.
26349 * @see elm_diskselector_item_append()
26351 * @ingroup Diskselector
26353 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26356 * Get the selected item.
26358 * @param obj The diskselector object.
26359 * @return The selected diskselector item.
26361 * The selected item can be unselected with function
26362 * elm_diskselector_item_selected_set(), and the first item of
26363 * diskselector will be selected.
26365 * The selected item always will be centered on diskselector, with
26366 * full label displayed, i.e., max lenght set to side labels won't
26367 * apply on the selected item. More details on
26368 * elm_diskselector_side_label_length_set().
26370 * @ingroup Diskselector
26372 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26375 * Set the selected state of an item.
26377 * @param it The diskselector item
26378 * @param selected The selected state
26380 * This sets the selected state of the given item @p it.
26381 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26383 * If a new item is selected the previosly selected will be unselected.
26384 * Previoulsy selected item can be get with function
26385 * elm_diskselector_selected_item_get().
26387 * If the item @p it is unselected, the first item of diskselector will
26390 * Selected items will be visible on center position of diskselector.
26391 * So if it was on another position before selected, or was invisible,
26392 * diskselector will animate items until the selected item reaches center
26395 * @see elm_diskselector_item_selected_get()
26396 * @see elm_diskselector_selected_item_get()
26398 * @ingroup Diskselector
26400 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26403 * Get whether the @p item is selected or not.
26405 * @param it The diskselector item.
26406 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26407 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26409 * @see elm_diskselector_selected_item_set() for details.
26410 * @see elm_diskselector_item_selected_get()
26412 * @ingroup Diskselector
26414 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26417 * Get the first item of the diskselector.
26419 * @param obj The diskselector object.
26420 * @return The first item, or @c NULL if none.
26422 * The list of items follows append order. So it will return the first
26423 * item appended to the widget that wasn't deleted.
26425 * @see elm_diskselector_item_append()
26426 * @see elm_diskselector_items_get()
26428 * @ingroup Diskselector
26430 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26433 * Get the last item of the diskselector.
26435 * @param obj The diskselector object.
26436 * @return The last item, or @c NULL if none.
26438 * The list of items follows append order. So it will return last first
26439 * item appended to the widget that wasn't deleted.
26441 * @see elm_diskselector_item_append()
26442 * @see elm_diskselector_items_get()
26444 * @ingroup Diskselector
26446 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26449 * Get the item before @p item in diskselector.
26451 * @param it The diskselector item.
26452 * @return The item before @p item, or @c NULL if none or on failure.
26454 * The list of items follows append order. So it will return item appended
26455 * just before @p item and that wasn't deleted.
26457 * If it is the first item, @c NULL will be returned.
26458 * First item can be get by elm_diskselector_first_item_get().
26460 * @see elm_diskselector_item_append()
26461 * @see elm_diskselector_items_get()
26463 * @ingroup Diskselector
26465 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26468 * Get the item after @p item in diskselector.
26470 * @param it The diskselector item.
26471 * @return The item after @p item, or @c NULL if none or on failure.
26473 * The list of items follows append order. So it will return item appended
26474 * just after @p item and that wasn't deleted.
26476 * If it is the last item, @c NULL will be returned.
26477 * Last item can be get by elm_diskselector_last_item_get().
26479 * @see elm_diskselector_item_append()
26480 * @see elm_diskselector_items_get()
26482 * @ingroup Diskselector
26484 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26487 * Set the text to be shown in the diskselector item.
26489 * @param item Target item
26490 * @param text The text to set in the content
26492 * Setup the text as tooltip to object. The item can have only one tooltip,
26493 * so any previous tooltip data is removed.
26495 * @see elm_object_tooltip_text_set() for more details.
26497 * @ingroup Diskselector
26499 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26502 * Set the content to be shown in the tooltip item.
26504 * Setup the tooltip to item. The item can have only one tooltip,
26505 * so any previous tooltip data is removed. @p func(with @p data) will
26506 * be called every time that need show the tooltip and it should
26507 * return a valid Evas_Object. This object is then managed fully by
26508 * tooltip system and is deleted when the tooltip is gone.
26510 * @param item the diskselector item being attached a tooltip.
26511 * @param func the function used to create the tooltip contents.
26512 * @param data what to provide to @a func as callback data/context.
26513 * @param del_cb called when data is not needed anymore, either when
26514 * another callback replaces @p func, the tooltip is unset with
26515 * elm_diskselector_item_tooltip_unset() or the owner @a item
26516 * dies. This callback receives as the first parameter the
26517 * given @a data, and @c event_info is the item.
26519 * @see elm_object_tooltip_content_cb_set() for more details.
26521 * @ingroup Diskselector
26523 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);
26526 * Unset tooltip from item.
26528 * @param item diskselector item to remove previously set tooltip.
26530 * Remove tooltip from item. The callback provided as del_cb to
26531 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26532 * it is not used anymore.
26534 * @see elm_object_tooltip_unset() for more details.
26535 * @see elm_diskselector_item_tooltip_content_cb_set()
26537 * @ingroup Diskselector
26539 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26543 * Sets a different style for this item tooltip.
26545 * @note before you set a style you should define a tooltip with
26546 * elm_diskselector_item_tooltip_content_cb_set() or
26547 * elm_diskselector_item_tooltip_text_set()
26549 * @param item diskselector item with tooltip already set.
26550 * @param style the theme style to use (default, transparent, ...)
26552 * @see elm_object_tooltip_style_set() for more details.
26554 * @ingroup Diskselector
26556 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26559 * Get the style for this item tooltip.
26561 * @param item diskselector item with tooltip already set.
26562 * @return style the theme style in use, defaults to "default". If the
26563 * object does not have a tooltip set, then NULL is returned.
26565 * @see elm_object_tooltip_style_get() for more details.
26566 * @see elm_diskselector_item_tooltip_style_set()
26568 * @ingroup Diskselector
26570 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26573 * Set the cursor to be shown when mouse is over the diskselector item
26575 * @param item Target item
26576 * @param cursor the cursor name to be used.
26578 * @see elm_object_cursor_set() for more details.
26580 * @ingroup Diskselector
26582 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26585 * Get the cursor to be shown when mouse is over the diskselector item
26587 * @param item diskselector item with cursor already set.
26588 * @return the cursor name.
26590 * @see elm_object_cursor_get() for more details.
26591 * @see elm_diskselector_cursor_set()
26593 * @ingroup Diskselector
26595 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26599 * Unset the cursor to be shown when mouse is over the diskselector item
26601 * @param item Target item
26603 * @see elm_object_cursor_unset() for more details.
26604 * @see elm_diskselector_cursor_set()
26606 * @ingroup Diskselector
26608 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26611 * Sets a different style for this item cursor.
26613 * @note before you set a style you should define a cursor with
26614 * elm_diskselector_item_cursor_set()
26616 * @param item diskselector item with cursor already set.
26617 * @param style the theme style to use (default, transparent, ...)
26619 * @see elm_object_cursor_style_set() for more details.
26621 * @ingroup Diskselector
26623 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26627 * Get the style for this item cursor.
26629 * @param item diskselector item with cursor already set.
26630 * @return style the theme style in use, defaults to "default". If the
26631 * object does not have a cursor set, then @c NULL is returned.
26633 * @see elm_object_cursor_style_get() for more details.
26634 * @see elm_diskselector_item_cursor_style_set()
26636 * @ingroup Diskselector
26638 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26642 * Set if the cursor set should be searched on the theme or should use
26643 * the provided by the engine, only.
26645 * @note before you set if should look on theme you should define a cursor
26646 * with elm_diskselector_item_cursor_set().
26647 * By default it will only look for cursors provided by the engine.
26649 * @param item widget item with cursor already set.
26650 * @param engine_only boolean to define if cursors set with
26651 * elm_diskselector_item_cursor_set() should be searched only
26652 * between cursors provided by the engine or searched on widget's
26655 * @see elm_object_cursor_engine_only_set() for more details.
26657 * @ingroup Diskselector
26659 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26662 * Get the cursor engine only usage for this item cursor.
26664 * @param item widget item with cursor already set.
26665 * @return engine_only boolean to define it cursors should be looked only
26666 * between the provided by the engine or searched on widget's theme as well.
26667 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26669 * @see elm_object_cursor_engine_only_get() for more details.
26670 * @see elm_diskselector_item_cursor_engine_only_set()
26672 * @ingroup Diskselector
26674 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26681 * @defgroup Colorselector Colorselector
26685 * @image html img/widget/colorselector/preview-00.png
26686 * @image latex img/widget/colorselector/preview-00.eps
26688 * @brief Widget for user to select a color.
26690 * Signals that you can add callbacks for are:
26691 * "changed" - When the color value changes(event_info is NULL).
26693 * See @ref tutorial_colorselector.
26696 * @brief Add a new colorselector to the parent
26698 * @param parent The parent object
26699 * @return The new object or NULL if it cannot be created
26701 * @ingroup Colorselector
26703 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26705 * Set a color for the colorselector
26707 * @param obj Colorselector object
26708 * @param r r-value of color
26709 * @param g g-value of color
26710 * @param b b-value of color
26711 * @param a a-value of color
26713 * @ingroup Colorselector
26715 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26717 * Get a color from the colorselector
26719 * @param obj Colorselector object
26720 * @param r integer pointer for r-value of color
26721 * @param g integer pointer for g-value of color
26722 * @param b integer pointer for b-value of color
26723 * @param a integer pointer for a-value of color
26725 * @ingroup Colorselector
26727 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26733 * @defgroup Ctxpopup Ctxpopup
26735 * @image html img/widget/ctxpopup/preview-00.png
26736 * @image latex img/widget/ctxpopup/preview-00.eps
26738 * @brief Context popup widet.
26740 * A ctxpopup is a widget that, when shown, pops up a list of items.
26741 * It automatically chooses an area inside its parent object's view
26742 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26743 * optimally fit into it. In the default theme, it will also point an
26744 * arrow to it's top left position at the time one shows it. Ctxpopup
26745 * items have a label and/or an icon. It is intended for a small
26746 * number of items (hence the use of list, not genlist).
26748 * @note Ctxpopup is a especialization of @ref Hover.
26750 * Signals that you can add callbacks for are:
26751 * "dismissed" - the ctxpopup was dismissed
26753 * Default contents parts of the ctxpopup widget that you can use for are:
26754 * @li "default" - A content of the ctxpopup
26756 * Default contents parts of the naviframe items that you can use for are:
26757 * @li "icon" - A icon in the title area
26759 * Default text parts of the naviframe items that you can use for are:
26760 * @li "default" - Title label in the title area
26762 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26765 typedef enum _Elm_Ctxpopup_Direction
26767 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26769 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26770 the clicked area */
26771 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26772 the clicked area */
26773 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26775 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26776 } Elm_Ctxpopup_Direction;
26777 #define Elm_Ctxpopup_Item Elm_Object_Item
26780 * @brief Add a new Ctxpopup object to the parent.
26782 * @param parent Parent object
26783 * @return New object or @c NULL, if it cannot be created
26785 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26787 * @brief Set the Ctxpopup's parent
26789 * @param obj The ctxpopup object
26790 * @param area The parent to use
26792 * Set the parent object.
26794 * @note elm_ctxpopup_add() will automatically call this function
26795 * with its @c parent argument.
26797 * @see elm_ctxpopup_add()
26798 * @see elm_hover_parent_set()
26800 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26802 * @brief Get the Ctxpopup's parent
26804 * @param obj The ctxpopup object
26806 * @see elm_ctxpopup_hover_parent_set() for more information
26808 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26810 * @brief Clear all items in the given ctxpopup object.
26812 * @param obj Ctxpopup object
26814 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26816 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26818 * @param obj Ctxpopup object
26819 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26821 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26823 * @brief Get the value of current ctxpopup object's orientation.
26825 * @param obj Ctxpopup object
26826 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26828 * @see elm_ctxpopup_horizontal_set()
26830 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26832 * @brief Add a new item to a ctxpopup object.
26834 * @param obj Ctxpopup object
26835 * @param icon Icon to be set on new item
26836 * @param label The Label of the new item
26837 * @param func Convenience function called when item selected
26838 * @param data Data passed to @p func
26839 * @return A handle to the item added or @c NULL, on errors
26841 * @warning Ctxpopup can't hold both an item list and a content at the same
26842 * time. When an item is added, any previous content will be removed.
26844 * @see elm_ctxpopup_content_set()
26846 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);
26848 * @brief Delete the given item in a ctxpopup object.
26850 * @param it Ctxpopup item to be deleted
26852 * @see elm_ctxpopup_item_append()
26854 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26856 * @brief Set the ctxpopup item's state as disabled or enabled.
26858 * @param it Ctxpopup item to be enabled/disabled
26859 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26861 * When disabled the item is greyed out to indicate it's state.
26862 * @deprecated use elm_object_item_disabled_set() instead
26864 WILL_DEPRECATE EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26866 * @brief Get the ctxpopup item's disabled/enabled state.
26868 * @param it Ctxpopup item to be enabled/disabled
26869 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26871 * @see elm_ctxpopup_item_disabled_set()
26872 * @deprecated use elm_object_item_disabled_get() instead
26874 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26876 * @brief Get the icon object for the given ctxpopup item.
26878 * @param it Ctxpopup item
26879 * @return icon object or @c NULL, if the item does not have icon or an error
26882 * @see elm_ctxpopup_item_append()
26883 * @see elm_ctxpopup_item_icon_set()
26885 * @deprecated use elm_object_item_part_content_get() instead
26887 WILL_DEPRECATE EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26889 * @brief Sets the side icon associated with the ctxpopup item
26891 * @param it Ctxpopup item
26892 * @param icon Icon object to be set
26894 * Once the icon object is set, a previously set one will be deleted.
26895 * @warning Setting the same icon for two items will cause the icon to
26896 * dissapear from the first item.
26898 * @see elm_ctxpopup_item_append()
26900 * @deprecated use elm_object_item_part_content_set() instead
26903 WILL_DEPRECATE EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26905 * @brief Get the label for the given ctxpopup item.
26907 * @param it Ctxpopup item
26908 * @return label string or @c NULL, if the item does not have label or an
26911 * @see elm_ctxpopup_item_append()
26912 * @see elm_ctxpopup_item_label_set()
26914 * @deprecated use elm_object_item_text_get() instead
26916 WILL_DEPRECATE EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26918 * @brief (Re)set the label on the given ctxpopup item.
26920 * @param it Ctxpopup item
26921 * @param label String to set as label
26923 * @deprecated use elm_object_item_text_set() instead
26925 WILL_DEPRECATE EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26927 * @brief Set an elm widget as the content of the ctxpopup.
26929 * @param obj Ctxpopup object
26930 * @param content Content to be swallowed
26932 * If the content object is already set, a previous one will bedeleted. If
26933 * you want to keep that old content object, use the
26934 * elm_ctxpopup_content_unset() function.
26936 * @warning Ctxpopup can't hold both a item list and a content at the same
26937 * time. When a content is set, any previous items will be removed.
26939 * @deprecated use elm_object_content_set() instead
26942 WILL_DEPRECATE EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26944 * @brief Unset the ctxpopup content
26946 * @param obj Ctxpopup object
26947 * @return The content that was being used
26949 * Unparent and return the content object which was set for this widget.
26951 * @deprecated use elm_object_content_unset()
26953 * @see elm_ctxpopup_content_set()
26955 * @deprecated use elm_object_content_unset() instead
26958 WILL_DEPRECATE EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26960 * @brief Set the direction priority of a ctxpopup.
26962 * @param obj Ctxpopup object
26963 * @param first 1st priority of direction
26964 * @param second 2nd priority of direction
26965 * @param third 3th priority of direction
26966 * @param fourth 4th priority of direction
26968 * This functions gives a chance to user to set the priority of ctxpopup
26969 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26970 * requested direction.
26972 * @see Elm_Ctxpopup_Direction
26974 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);
26976 * @brief Get the direction priority of a ctxpopup.
26978 * @param obj Ctxpopup object
26979 * @param first 1st priority of direction to be returned
26980 * @param second 2nd priority of direction to be returned
26981 * @param third 3th priority of direction to be returned
26982 * @param fourth 4th priority of direction to be returned
26984 * @see elm_ctxpopup_direction_priority_set() for more information.
26986 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);
26989 * @brief Get the current direction of a ctxpopup.
26991 * @param obj Ctxpopup object
26992 * @return current direction of a ctxpopup
26994 * @warning Once the ctxpopup showed up, the direction would be determined
26996 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27005 * @defgroup Transit Transit
27006 * @ingroup Elementary
27008 * Transit is designed to apply various animated transition effects to @c
27009 * Evas_Object, such like translation, rotation, etc. For using these
27010 * effects, create an @ref Elm_Transit and add the desired transition effects.
27012 * Once the effects are added into transit, they will be automatically
27013 * managed (their callback will be called until the duration is ended, and
27014 * they will be deleted on completion).
27018 * Elm_Transit *trans = elm_transit_add();
27019 * elm_transit_object_add(trans, obj);
27020 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27021 * elm_transit_duration_set(transit, 1);
27022 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27023 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27024 * elm_transit_repeat_times_set(transit, 3);
27027 * Some transition effects are used to change the properties of objects. They
27029 * @li @ref elm_transit_effect_translation_add
27030 * @li @ref elm_transit_effect_color_add
27031 * @li @ref elm_transit_effect_rotation_add
27032 * @li @ref elm_transit_effect_wipe_add
27033 * @li @ref elm_transit_effect_zoom_add
27034 * @li @ref elm_transit_effect_resizing_add
27036 * Other transition effects are used to make one object disappear and another
27037 * object appear on its old place. These effects are:
27039 * @li @ref elm_transit_effect_flip_add
27040 * @li @ref elm_transit_effect_resizable_flip_add
27041 * @li @ref elm_transit_effect_fade_add
27042 * @li @ref elm_transit_effect_blend_add
27044 * It's also possible to make a transition chain with @ref
27045 * elm_transit_chain_transit_add.
27047 * @warning We strongly recommend to use elm_transit just when edje can not do
27048 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27049 * animations can be manipulated inside the theme.
27051 * List of examples:
27052 * @li @ref transit_example_01_explained
27053 * @li @ref transit_example_02_explained
27054 * @li @ref transit_example_03_c
27055 * @li @ref transit_example_04_c
27061 * @enum Elm_Transit_Tween_Mode
27063 * The type of acceleration used in the transition.
27067 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27068 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27069 over time, then decrease again
27071 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27073 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27075 } Elm_Transit_Tween_Mode;
27078 * @enum Elm_Transit_Effect_Flip_Axis
27080 * The axis where flip effect should be applied.
27084 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27085 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27086 } Elm_Transit_Effect_Flip_Axis;
27088 * @enum Elm_Transit_Effect_Wipe_Dir
27090 * The direction where the wipe effect should occur.
27094 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27095 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27096 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27097 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27098 } Elm_Transit_Effect_Wipe_Dir;
27099 /** @enum Elm_Transit_Effect_Wipe_Type
27101 * Whether the wipe effect should show or hide the object.
27105 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27107 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27109 } Elm_Transit_Effect_Wipe_Type;
27112 * @typedef Elm_Transit
27114 * The Transit created with elm_transit_add(). This type has the information
27115 * about the objects which the transition will be applied, and the
27116 * transition effects that will be used. It also contains info about
27117 * duration, number of repetitions, auto-reverse, etc.
27119 typedef struct _Elm_Transit Elm_Transit;
27120 typedef void Elm_Transit_Effect;
27122 * @typedef Elm_Transit_Effect_Transition_Cb
27124 * Transition callback called for this effect on each transition iteration.
27126 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27128 * Elm_Transit_Effect_End_Cb
27130 * Transition callback called for this effect when the transition is over.
27132 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27135 * Elm_Transit_Del_Cb
27137 * A callback called when the transit is deleted.
27139 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27144 * @note Is not necessary to delete the transit object, it will be deleted at
27145 * the end of its operation.
27146 * @note The transit will start playing when the program enter in the main loop, is not
27147 * necessary to give a start to the transit.
27149 * @return The transit object.
27153 EAPI Elm_Transit *elm_transit_add(void);
27156 * Stops the animation and delete the @p transit object.
27158 * Call this function if you wants to stop the animation before the duration
27159 * time. Make sure the @p transit object is still alive with
27160 * elm_transit_del_cb_set() function.
27161 * All added effects will be deleted, calling its repective data_free_cb
27162 * functions. The function setted by elm_transit_del_cb_set() will be called.
27164 * @see elm_transit_del_cb_set()
27166 * @param transit The transit object to be deleted.
27169 * @warning Just call this function if you are sure the transit is alive.
27171 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27174 * Add a new effect to the transit.
27176 * @note The cb function and the data are the key to the effect. If you try to
27177 * add an already added effect, nothing is done.
27178 * @note After the first addition of an effect in @p transit, if its
27179 * effect list become empty again, the @p transit will be killed by
27180 * elm_transit_del(transit) function.
27184 * Elm_Transit *transit = elm_transit_add();
27185 * elm_transit_effect_add(transit,
27186 * elm_transit_effect_blend_op,
27187 * elm_transit_effect_blend_context_new(),
27188 * elm_transit_effect_blend_context_free);
27191 * @param transit The transit object.
27192 * @param transition_cb The operation function. It is called when the
27193 * animation begins, it is the function that actually performs the animation.
27194 * It is called with the @p data, @p transit and the time progression of the
27195 * animation (a double value between 0.0 and 1.0).
27196 * @param effect The context data of the effect.
27197 * @param end_cb The function to free the context data, it will be called
27198 * at the end of the effect, it must finalize the animation and free the
27202 * @warning The transit free the context data at the and of the transition with
27203 * the data_free_cb function, do not use the context data in another transit.
27205 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);
27208 * Delete an added effect.
27210 * This function will remove the effect from the @p transit, calling the
27211 * data_free_cb to free the @p data.
27213 * @see elm_transit_effect_add()
27215 * @note If the effect is not found, nothing is done.
27216 * @note If the effect list become empty, this function will call
27217 * elm_transit_del(transit), that is, it will kill the @p transit.
27219 * @param transit The transit object.
27220 * @param transition_cb The operation function.
27221 * @param effect The context data of the effect.
27225 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);
27228 * Add new object to apply the effects.
27230 * @note After the first addition of an object in @p transit, if its
27231 * object list become empty again, the @p transit will be killed by
27232 * elm_transit_del(transit) function.
27233 * @note If the @p obj belongs to another transit, the @p obj will be
27234 * removed from it and it will only belong to the @p transit. If the old
27235 * transit stays without objects, it will die.
27236 * @note When you add an object into the @p transit, its state from
27237 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27238 * transit ends, if you change this state whith evas_object_pass_events_set()
27239 * after add the object, this state will change again when @p transit stops to
27242 * @param transit The transit object.
27243 * @param obj Object to be animated.
27246 * @warning It is not allowed to add a new object after transit begins to go.
27248 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27251 * Removes an added object from the transit.
27253 * @note If the @p obj is not in the @p transit, nothing is done.
27254 * @note If the list become empty, this function will call
27255 * elm_transit_del(transit), that is, it will kill the @p transit.
27257 * @param transit The transit object.
27258 * @param obj Object to be removed from @p transit.
27261 * @warning It is not allowed to remove objects after transit begins to go.
27263 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27266 * Get the objects of the transit.
27268 * @param transit The transit object.
27269 * @return a Eina_List with the objects from the transit.
27273 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27276 * Enable/disable keeping up the objects states.
27277 * If it is not kept, the objects states will be reset when transition ends.
27279 * @note @p transit can not be NULL.
27280 * @note One state includes geometry, color, map data.
27282 * @param transit The transit object.
27283 * @param state_keep Keeping or Non Keeping.
27287 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27290 * Get a value whether the objects states will be reset or not.
27292 * @note @p transit can not be NULL
27294 * @see elm_transit_objects_final_state_keep_set()
27296 * @param transit The transit object.
27297 * @return EINA_TRUE means the states of the objects will be reset.
27298 * If @p transit is NULL, EINA_FALSE is returned
27302 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27305 * Set the event enabled when transit is operating.
27307 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27308 * events from mouse and keyboard during the animation.
27309 * @note When you add an object with elm_transit_object_add(), its state from
27310 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27311 * transit ends, if you change this state with evas_object_pass_events_set()
27312 * after adding the object, this state will change again when @p transit stops
27315 * @param transit The transit object.
27316 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27317 * ignored otherwise.
27321 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27324 * Get the value of event enabled status.
27326 * @see elm_transit_event_enabled_set()
27328 * @param transit The Transit object
27329 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27330 * EINA_FALSE is returned
27334 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27337 * Set the user-callback function when the transit is deleted.
27339 * @note Using this function twice will overwrite the first function setted.
27340 * @note the @p transit object will be deleted after call @p cb function.
27342 * @param transit The transit object.
27343 * @param cb Callback function pointer. This function will be called before
27344 * the deletion of the transit.
27345 * @param data Callback funtion user data. It is the @p op parameter.
27349 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27352 * Set reverse effect automatically.
27354 * If auto reverse is setted, after running the effects with the progress
27355 * parameter from 0 to 1, it will call the effecs again with the progress
27356 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27357 * where the duration was setted with the function elm_transit_add and
27358 * the repeat with the function elm_transit_repeat_times_set().
27360 * @param transit The transit object.
27361 * @param reverse EINA_TRUE means the auto_reverse is on.
27365 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27368 * Get if the auto reverse is on.
27370 * @see elm_transit_auto_reverse_set()
27372 * @param transit The transit object.
27373 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27374 * EINA_FALSE is returned
27378 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27381 * Set the transit repeat count. Effect will be repeated by repeat count.
27383 * This function sets the number of repetition the transit will run after
27384 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27385 * If the @p repeat is a negative number, it will repeat infinite times.
27387 * @note If this function is called during the transit execution, the transit
27388 * will run @p repeat times, ignoring the times it already performed.
27390 * @param transit The transit object
27391 * @param repeat Repeat count
27395 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27398 * Get the transit repeat count.
27400 * @see elm_transit_repeat_times_set()
27402 * @param transit The Transit object.
27403 * @return The repeat count. If @p transit is NULL
27408 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27411 * Set the transit animation acceleration type.
27413 * This function sets the tween mode of the transit that can be:
27414 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27415 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27416 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27417 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27419 * @param transit The transit object.
27420 * @param tween_mode The tween type.
27424 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27427 * Get the transit animation acceleration type.
27429 * @note @p transit can not be NULL
27431 * @param transit The transit object.
27432 * @return The tween type. If @p transit is NULL
27433 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27437 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27440 * Set the transit animation time
27442 * @note @p transit can not be NULL
27444 * @param transit The transit object.
27445 * @param duration The animation time.
27449 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27452 * Get the transit animation time
27454 * @note @p transit can not be NULL
27456 * @param transit The transit object.
27458 * @return The transit animation time.
27462 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27465 * Starts the transition.
27466 * Once this API is called, the transit begins to measure the time.
27468 * @note @p transit can not be NULL
27470 * @param transit The transit object.
27474 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27477 * Pause/Resume the transition.
27479 * If you call elm_transit_go again, the transit will be started from the
27480 * beginning, and will be unpaused.
27482 * @note @p transit can not be NULL
27484 * @param transit The transit object.
27485 * @param paused Whether the transition should be paused or not.
27489 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27492 * Get the value of paused status.
27494 * @see elm_transit_paused_set()
27496 * @note @p transit can not be NULL
27498 * @param transit The transit object.
27499 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27500 * EINA_FALSE is returned
27504 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27507 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27509 * The value returned is a fraction (current time / total time). It
27510 * represents the progression position relative to the total.
27512 * @note @p transit can not be NULL
27514 * @param transit The transit object.
27516 * @return The time progression value. If @p transit is NULL
27521 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27524 * Makes the chain relationship between two transits.
27526 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27527 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27529 * @param transit The transit object.
27530 * @param chain_transit The chain transit object. This transit will be operated
27531 * after transit is done.
27533 * This function adds @p chain_transit transition to a chain after the @p
27534 * transit, and will be started as soon as @p transit ends. See @ref
27535 * transit_example_02_explained for a full example.
27539 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27542 * Cut off the chain relationship between two transits.
27544 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27545 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27547 * @param transit The transit object.
27548 * @param chain_transit The chain transit object.
27550 * This function remove the @p chain_transit transition from the @p transit.
27554 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27557 * Get the current chain transit list.
27559 * @note @p transit can not be NULL.
27561 * @param transit The transit object.
27562 * @return chain transit list.
27566 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27569 * Add the Resizing Effect to Elm_Transit.
27571 * @note This API is one of the facades. It creates resizing effect context
27572 * and add it's required APIs to elm_transit_effect_add.
27574 * @see elm_transit_effect_add()
27576 * @param transit Transit object.
27577 * @param from_w Object width size when effect begins.
27578 * @param from_h Object height size when effect begins.
27579 * @param to_w Object width size when effect ends.
27580 * @param to_h Object height size when effect ends.
27581 * @return Resizing effect context data.
27585 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);
27588 * Add the Translation Effect to Elm_Transit.
27590 * @note This API is one of the facades. It creates translation effect context
27591 * and add it's required APIs to elm_transit_effect_add.
27593 * @see elm_transit_effect_add()
27595 * @param transit Transit object.
27596 * @param from_dx X Position variation when effect begins.
27597 * @param from_dy Y Position variation when effect begins.
27598 * @param to_dx X Position variation when effect ends.
27599 * @param to_dy Y Position variation when effect ends.
27600 * @return Translation effect context data.
27603 * @warning It is highly recommended just create a transit with this effect when
27604 * the window that the objects of the transit belongs has already been created.
27605 * This is because this effect needs the geometry information about the objects,
27606 * and if the window was not created yet, it can get a wrong information.
27608 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);
27611 * Add the Zoom Effect to Elm_Transit.
27613 * @note This API is one of the facades. It creates zoom effect context
27614 * and add it's required APIs to elm_transit_effect_add.
27616 * @see elm_transit_effect_add()
27618 * @param transit Transit object.
27619 * @param from_rate Scale rate when effect begins (1 is current rate).
27620 * @param to_rate Scale rate when effect ends.
27621 * @return Zoom effect context data.
27624 * @warning It is highly recommended just create a transit with this effect when
27625 * the window that the objects of the transit belongs has already been created.
27626 * This is because this effect needs the geometry information about the objects,
27627 * and if the window was not created yet, it can get a wrong information.
27629 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27632 * Add the Flip Effect to Elm_Transit.
27634 * @note This API is one of the facades. It creates flip effect context
27635 * and add it's required APIs to elm_transit_effect_add.
27636 * @note This effect is applied to each pair of objects in the order they are listed
27637 * in the transit list of objects. The first object in the pair will be the
27638 * "front" object and the second will be the "back" object.
27640 * @see elm_transit_effect_add()
27642 * @param transit Transit object.
27643 * @param axis Flipping Axis(X or Y).
27644 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27645 * @return Flip effect context data.
27648 * @warning It is highly recommended just create a transit with this effect when
27649 * the window that the objects of the transit belongs has already been created.
27650 * This is because this effect needs the geometry information about the objects,
27651 * and if the window was not created yet, it can get a wrong information.
27653 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27656 * Add the Resizable Flip Effect to Elm_Transit.
27658 * @note This API is one of the facades. It creates resizable flip effect context
27659 * and add it's required APIs to elm_transit_effect_add.
27660 * @note This effect is applied to each pair of objects in the order they are listed
27661 * in the transit list of objects. The first object in the pair will be the
27662 * "front" object and the second will be the "back" object.
27664 * @see elm_transit_effect_add()
27666 * @param transit Transit object.
27667 * @param axis Flipping Axis(X or Y).
27668 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27669 * @return Resizable flip effect context data.
27672 * @warning It is highly recommended just create a transit with this effect when
27673 * the window that the objects of the transit belongs has already been created.
27674 * This is because this effect needs the geometry information about the objects,
27675 * and if the window was not created yet, it can get a wrong information.
27677 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27680 * Add the Wipe Effect to Elm_Transit.
27682 * @note This API is one of the facades. It creates wipe effect context
27683 * and add it's required APIs to elm_transit_effect_add.
27685 * @see elm_transit_effect_add()
27687 * @param transit Transit object.
27688 * @param type Wipe type. Hide or show.
27689 * @param dir Wipe Direction.
27690 * @return Wipe effect context data.
27693 * @warning It is highly recommended just create a transit with this effect when
27694 * the window that the objects of the transit belongs has already been created.
27695 * This is because this effect needs the geometry information about the objects,
27696 * and if the window was not created yet, it can get a wrong information.
27698 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27701 * Add the Color Effect to Elm_Transit.
27703 * @note This API is one of the facades. It creates color effect context
27704 * and add it's required APIs to elm_transit_effect_add.
27706 * @see elm_transit_effect_add()
27708 * @param transit Transit object.
27709 * @param from_r RGB R when effect begins.
27710 * @param from_g RGB G when effect begins.
27711 * @param from_b RGB B when effect begins.
27712 * @param from_a RGB A when effect begins.
27713 * @param to_r RGB R when effect ends.
27714 * @param to_g RGB G when effect ends.
27715 * @param to_b RGB B when effect ends.
27716 * @param to_a RGB A when effect ends.
27717 * @return Color effect context data.
27721 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);
27724 * Add the Fade Effect to Elm_Transit.
27726 * @note This API is one of the facades. It creates fade effect context
27727 * and add it's required APIs to elm_transit_effect_add.
27728 * @note This effect is applied to each pair of objects in the order they are listed
27729 * in the transit list of objects. The first object in the pair will be the
27730 * "before" object and the second will be the "after" object.
27732 * @see elm_transit_effect_add()
27734 * @param transit Transit object.
27735 * @return Fade effect context data.
27738 * @warning It is highly recommended just create a transit with this effect when
27739 * the window that the objects of the transit belongs has already been created.
27740 * This is because this effect needs the color information about the objects,
27741 * and if the window was not created yet, it can get a wrong information.
27743 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27746 * Add the Blend Effect to Elm_Transit.
27748 * @note This API is one of the facades. It creates blend effect context
27749 * and add it's required APIs to elm_transit_effect_add.
27750 * @note This effect is applied to each pair of objects in the order they are listed
27751 * in the transit list of objects. The first object in the pair will be the
27752 * "before" object and the second will be the "after" object.
27754 * @see elm_transit_effect_add()
27756 * @param transit Transit object.
27757 * @return Blend 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 color 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_blend_add(Elm_Transit *transit);
27768 * Add the Rotation Effect to Elm_Transit.
27770 * @note This API is one of the facades. It creates rotation 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_degree Degree when effect begins.
27777 * @param to_degree Degree when effect is ends.
27778 * @return Rotation effect context data.
27781 * @warning It is highly recommended just create a transit with this effect when
27782 * the window that the objects of the transit belongs has already been created.
27783 * This is because this effect needs the geometry information about the objects,
27784 * and if the window was not created yet, it can get a wrong information.
27786 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27789 * Add the ImageAnimation Effect to Elm_Transit.
27791 * @note This API is one of the facades. It creates image animation effect context
27792 * and add it's required APIs to elm_transit_effect_add.
27793 * The @p images parameter is a list images paths. This list and
27794 * its contents will be deleted at the end of the effect by
27795 * elm_transit_effect_image_animation_context_free() function.
27799 * char buf[PATH_MAX];
27800 * Eina_List *images = NULL;
27801 * Elm_Transit *transi = elm_transit_add();
27803 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27804 * images = eina_list_append(images, eina_stringshare_add(buf));
27806 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27807 * images = eina_list_append(images, eina_stringshare_add(buf));
27808 * elm_transit_effect_image_animation_add(transi, images);
27812 * @see elm_transit_effect_add()
27814 * @param transit Transit object.
27815 * @param images Eina_List of images file paths. This list and
27816 * its contents will be deleted at the end of the effect by
27817 * elm_transit_effect_image_animation_context_free() function.
27818 * @return Image Animation effect context data.
27822 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27828 typedef struct _Elm_Store Elm_Store;
27829 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
27830 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27831 typedef struct _Elm_Store_Item Elm_Store_Item;
27832 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
27833 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27834 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27835 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27836 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27837 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27838 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27839 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27840 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27842 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27843 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27844 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27845 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27846 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27847 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27848 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27852 ELM_STORE_ITEM_MAPPING_NONE = 0,
27853 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27854 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27855 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27856 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27857 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27858 // can add more here as needed by common apps
27859 ELM_STORE_ITEM_MAPPING_LAST
27860 } Elm_Store_Item_Mapping_Type;
27862 struct _Elm_Store_Item_Mapping_Icon
27864 // FIXME: allow edje file icons
27866 Elm_Icon_Lookup_Order lookup_order;
27867 Eina_Bool standard_name : 1;
27868 Eina_Bool no_scale : 1;
27869 Eina_Bool smooth : 1;
27870 Eina_Bool scale_up : 1;
27871 Eina_Bool scale_down : 1;
27874 struct _Elm_Store_Item_Mapping_Empty
27879 struct _Elm_Store_Item_Mapping_Photo
27884 struct _Elm_Store_Item_Mapping_Custom
27886 Elm_Store_Item_Mapping_Cb func;
27889 struct _Elm_Store_Item_Mapping
27891 Elm_Store_Item_Mapping_Type type;
27896 Elm_Store_Item_Mapping_Empty empty;
27897 Elm_Store_Item_Mapping_Icon icon;
27898 Elm_Store_Item_Mapping_Photo photo;
27899 Elm_Store_Item_Mapping_Custom custom;
27900 // add more types here
27904 struct _Elm_Store_Item_Info
27909 Eina_Bool rec_item;
27910 int pre_group_index;
27912 Elm_Genlist_Item_Class *item_class;
27913 const Elm_Store_Item_Mapping *mapping;
27918 struct _Elm_Store_Item_Info_Filesystem
27920 Elm_Store_Item_Info base;
27924 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27925 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27928 * dbsystem Store object
27930 * @addtogroup DBStore
27933 * @return The new object or NULL if it cannot be created
27935 EAPI Elm_Store *elm_store_dbsystem_new(void);
27937 * Sets the item count of a store
27939 * @param st The store object
27940 * @param count The item count of an store
27942 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27944 * Set the select func that select the state of a list item whether true or false
27946 * @param st The store object
27947 * @param func The select cb function of an store
27948 * @param data The new data pointer to set
27950 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27952 * Sets the sort func that sort the item with a next in the list
27954 * @param st The store object
27955 * @param func The sort cb function of an store
27956 * @param data The new data pointer to set
27958 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27960 * Set the store item free func
27962 * @param st The store object
27963 * @param func The free cb function of an store
27964 * @param data The new data pointer to set
27966 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27968 * Get the item index that included header items
27970 * @param sti The store item object
27971 * @return The item index in genlist
27973 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27975 * Get the DB pointer of an item
27977 * @param sti The store item object
27978 * @return The DB pointer of item
27980 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27982 * Set the DB pointer of an item
27984 * @param sti The store item object
27985 * @parm p_db The DB pointer of item
27987 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27990 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27992 * Append the item to the genlist
27994 * @param st The store object
27995 * @param info The store item info dbsystem object
27996 * @return The item of store
27998 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
28000 * Realize the visible items to the screen
28002 * @param st The store object
28004 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28006 * Realize the item to the screen
28008 * @param sti The store item object
28010 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
28012 * Delete the item of genlist
28014 * @param sti The store item object
28016 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28017 EAPI void elm_store_free(Elm_Store *st);
28018 EAPI Elm_Store *elm_store_filesystem_new(void);
28019 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28020 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28021 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28023 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28025 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28026 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28027 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28028 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28029 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28030 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28032 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28033 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28034 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28035 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28036 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28037 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28038 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28044 * @defgroup SegmentControl SegmentControl
28045 * @ingroup Elementary
28047 * @image html img/widget/segment_control/preview-00.png
28048 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
28050 * @image html img/segment_control.png
28051 * @image latex img/segment_control.eps width=\textwidth
28053 * Segment control widget is a horizontal control made of multiple segment
28054 * items, each segment item functioning similar to discrete two state button.
28055 * A segment control groups the items together and provides compact
28056 * single button with multiple equal size segments.
28058 * Segment item size is determined by base widget
28059 * size and the number of items added.
28060 * Only one segment item can be at selected state. A segment item can display
28061 * combination of Text and any Evas_Object like Images or other widget.
28063 * Smart callbacks one can listen to:
28064 * - "changed" - When the user clicks on a segment item which is not
28065 * previously selected and get selected. The event_info parameter is the
28066 * segment item pointer.
28068 * Available styles for it:
28071 * Here is an example on its usage:
28072 * @li @ref segment_control_example
28076 * @addtogroup SegmentControl
28080 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28083 * Add a new segment control widget to the given parent Elementary
28084 * (container) object.
28086 * @param parent The parent object.
28087 * @return a new segment control widget handle or @c NULL, on errors.
28089 * This function inserts a new segment control widget on the canvas.
28091 * @ingroup SegmentControl
28093 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28096 * Append a new item to the segment control object.
28098 * @param obj The segment control object.
28099 * @param icon The icon object to use for the left side of the item. An
28100 * icon can be any Evas object, but usually it is an icon created
28101 * with elm_icon_add().
28102 * @param label The label of the item.
28103 * Note that, NULL is different from empty string "".
28104 * @return The created item or @c NULL upon failure.
28106 * A new item will be created and appended to the segment control, i.e., will
28107 * be set as @b last item.
28109 * If it should be inserted at another position,
28110 * elm_segment_control_item_insert_at() should be used instead.
28112 * Items created with this function can be deleted with function
28113 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28115 * @note @p label set to @c NULL is different from empty string "".
28117 * only has icon, it will be displayed bigger and centered. If it has
28118 * icon and label, even that an empty string, icon will be smaller and
28119 * positioned at left.
28123 * sc = elm_segment_control_add(win);
28124 * ic = elm_icon_add(win);
28125 * elm_icon_file_set(ic, "path/to/image", NULL);
28126 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28127 * elm_segment_control_item_add(sc, ic, "label");
28128 * evas_object_show(sc);
28131 * @see elm_segment_control_item_insert_at()
28132 * @see elm_segment_control_item_del()
28134 * @ingroup SegmentControl
28136 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28139 * Insert a new item to the segment control object at specified position.
28141 * @param obj The segment control object.
28142 * @param icon The icon object to use for the left side of the item. An
28143 * icon can be any Evas object, but usually it is an icon created
28144 * with elm_icon_add().
28145 * @param label The label of the item.
28146 * @param index Item position. Value should be between 0 and items count.
28147 * @return The created item or @c NULL upon failure.
28149 * Index values must be between @c 0, when item will be prepended to
28150 * segment control, and items count, that can be get with
28151 * elm_segment_control_item_count_get(), case when item will be appended
28152 * to segment control, just like elm_segment_control_item_add().
28154 * Items created with this function can be deleted with function
28155 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28157 * @note @p label set to @c NULL is different from empty string "".
28159 * only has icon, it will be displayed bigger and centered. If it has
28160 * icon and label, even that an empty string, icon will be smaller and
28161 * positioned at left.
28163 * @see elm_segment_control_item_add()
28164 * @see elm_segment_control_item_count_get()
28165 * @see elm_segment_control_item_del()
28167 * @ingroup SegmentControl
28169 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);
28172 * Remove a segment control item from its parent, deleting it.
28174 * @param it The item to be removed.
28176 * Items can be added with elm_segment_control_item_add() or
28177 * elm_segment_control_item_insert_at().
28179 * @ingroup SegmentControl
28181 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28184 * Remove a segment control item at given index from its parent,
28187 * @param obj The segment control object.
28188 * @param index The position of the segment control item to be deleted.
28190 * Items can be added with elm_segment_control_item_add() or
28191 * elm_segment_control_item_insert_at().
28193 * @ingroup SegmentControl
28195 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28198 * Get the Segment items count from segment control.
28200 * @param obj The segment control object.
28201 * @return Segment items count.
28203 * It will just return the number of items added to segment control @p obj.
28205 * @ingroup SegmentControl
28207 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28210 * Get the item placed at specified index.
28212 * @param obj The segment control object.
28213 * @param index The index of the segment item.
28214 * @return The segment control item or @c NULL on failure.
28216 * Index is the position of an item in segment control widget. Its
28217 * range is from @c 0 to <tt> count - 1 </tt>.
28218 * Count is the number of items, that can be get with
28219 * elm_segment_control_item_count_get().
28221 * @ingroup SegmentControl
28223 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28226 * Get the label of item.
28228 * @param obj The segment control object.
28229 * @param index The index of the segment item.
28230 * @return The label of the item at @p index.
28232 * The return value is a pointer to the label associated to the item when
28233 * it was created, with function elm_segment_control_item_add(), or later
28234 * with function elm_segment_control_item_label_set. If no label
28235 * was passed as argument, it will return @c NULL.
28237 * @see elm_segment_control_item_label_set() for more details.
28238 * @see elm_segment_control_item_add()
28240 * @ingroup SegmentControl
28242 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28245 * Set the label of item.
28247 * @param it The item of segment control.
28248 * @param text The label of item.
28250 * The label to be displayed by the item.
28251 * Label will be at right of the icon (if set).
28253 * If a label was passed as argument on item creation, with function
28254 * elm_control_segment_item_add(), it will be already
28255 * displayed by the item.
28257 * @see elm_segment_control_item_label_get()
28258 * @see elm_segment_control_item_add()
28260 * @ingroup SegmentControl
28262 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28265 * Get the icon associated to the item.
28267 * @param obj The segment control object.
28268 * @param index The index of the segment item.
28269 * @return The left side icon associated to the item at @p index.
28271 * The return value is a pointer to the icon associated to the item when
28272 * it was created, with function elm_segment_control_item_add(), or later
28273 * with function elm_segment_control_item_icon_set(). If no icon
28274 * was passed as argument, it will return @c NULL.
28276 * @see elm_segment_control_item_add()
28277 * @see elm_segment_control_item_icon_set()
28279 * @ingroup SegmentControl
28281 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28284 * Set the icon associated to the item.
28286 * @param it The segment control item.
28287 * @param icon The icon object to associate with @p it.
28289 * The icon object to use at left side of the item. An
28290 * icon can be any Evas object, but usually it is an icon created
28291 * with elm_icon_add().
28293 * Once the icon object is set, a previously set one will be deleted.
28294 * @warning Setting the same icon for two items will cause the icon to
28295 * dissapear from the first item.
28297 * If an icon was passed as argument on item creation, with function
28298 * elm_segment_control_item_add(), it will be already
28299 * associated to the item.
28301 * @see elm_segment_control_item_add()
28302 * @see elm_segment_control_item_icon_get()
28304 * @ingroup SegmentControl
28306 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28309 * Get the index of an item.
28311 * @param it The segment control item.
28312 * @return The position of item in segment control widget.
28314 * Index is the position of an item in segment control widget. Its
28315 * range is from @c 0 to <tt> count - 1 </tt>.
28316 * Count is the number of items, that can be get with
28317 * elm_segment_control_item_count_get().
28319 * @ingroup SegmentControl
28321 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28324 * Get the base object of the item.
28326 * @param it The segment control item.
28327 * @return The base object associated with @p it.
28329 * Base object is the @c Evas_Object that represents that item.
28331 * @ingroup SegmentControl
28333 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28336 * Get the selected item.
28338 * @param obj The segment control object.
28339 * @return The selected item or @c NULL if none of segment items is
28342 * The selected item can be unselected with function
28343 * elm_segment_control_item_selected_set().
28345 * The selected item always will be highlighted on segment control.
28347 * @ingroup SegmentControl
28349 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28352 * Set the selected state of an item.
28354 * @param it The segment control item
28355 * @param select The selected state
28357 * This sets the selected state of the given item @p it.
28358 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28360 * If a new item is selected the previosly selected will be unselected.
28361 * Previoulsy selected item can be get with function
28362 * elm_segment_control_item_selected_get().
28364 * The selected item always will be highlighted on segment control.
28366 * @see elm_segment_control_item_selected_get()
28368 * @ingroup SegmentControl
28370 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28377 * @defgroup Grid Grid
28379 * The grid is a grid layout widget that lays out a series of children as a
28380 * fixed "grid" of widgets using a given percentage of the grid width and
28381 * height each using the child object.
28383 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28384 * widgets size itself. The default is 100 x 100, so that means the
28385 * position and sizes of children will effectively be percentages (0 to 100)
28386 * of the width or height of the grid widget
28392 * Add a new grid to the parent
28394 * @param parent The parent object
28395 * @return The new object or NULL if it cannot be created
28399 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28402 * Set the virtual size of the grid
28404 * @param obj The grid object
28405 * @param w The virtual width of the grid
28406 * @param h The virtual height of the grid
28410 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28413 * Get the virtual size of the grid
28415 * @param obj The grid object
28416 * @param w Pointer to integer to store the virtual width of the grid
28417 * @param h Pointer to integer to store the virtual height of the grid
28421 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28424 * Pack child at given position and size
28426 * @param obj The grid object
28427 * @param subobj The child to pack
28428 * @param x The virtual x coord at which to pack it
28429 * @param y The virtual y coord at which to pack it
28430 * @param w The virtual width at which to pack it
28431 * @param h The virtual height at which to pack it
28435 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28438 * Unpack a child from a grid object
28440 * @param obj The grid object
28441 * @param subobj The child to unpack
28445 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28448 * Faster way to remove all child objects from a grid object.
28450 * @param obj The grid object
28451 * @param clear If true, it will delete just removed children
28455 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28458 * Set packing of an existing child at to position and size
28460 * @param subobj The child to set packing of
28461 * @param x The virtual x coord at which to pack it
28462 * @param y The virtual y coord at which to pack it
28463 * @param w The virtual width at which to pack it
28464 * @param h The virtual height at which to pack it
28468 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28471 * get packing of a child
28473 * @param subobj The child to query
28474 * @param x Pointer to integer to store the virtual x coord
28475 * @param y Pointer to integer to store the virtual y coord
28476 * @param w Pointer to integer to store the virtual width
28477 * @param h Pointer to integer to store the virtual height
28481 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28487 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28488 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28489 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28490 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28491 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28492 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28495 * @defgroup Video Video
28497 * @addtogroup Video
28500 * Elementary comes with two object that help design application that need
28501 * to display video. The main one, Elm_Video, display a video by using Emotion.
28502 * It does embedded the video inside an Edje object, so you can do some
28503 * animation depending on the video state change. It does also implement a
28504 * ressource management policy to remove this burden from the application writer.
28506 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28507 * It take care of updating its content according to Emotion event and provide a
28508 * way to theme itself. It also does automatically raise the priority of the
28509 * linked Elm_Video so it will use the video decoder if available. It also does
28510 * activate the remember function on the linked Elm_Video object.
28512 * Signals that you can add callback for are :
28514 * "forward,clicked" - the user clicked the forward button.
28515 * "info,clicked" - the user clicked the info button.
28516 * "next,clicked" - the user clicked the next button.
28517 * "pause,clicked" - the user clicked the pause button.
28518 * "play,clicked" - the user clicked the play button.
28519 * "prev,clicked" - the user clicked the prev button.
28520 * "rewind,clicked" - the user clicked the rewind button.
28521 * "stop,clicked" - the user clicked the stop button.
28523 * Default contents parts of the player widget that you can use for are:
28524 * @li "video" - A video of the player
28529 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28531 * @param parent The parent object
28532 * @return a new player widget handle or @c NULL, on errors.
28534 * This function inserts a new player widget on the canvas.
28536 * @see elm_object_part_content_set()
28540 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28543 * @brief Link a Elm_Payer with an Elm_Video object.
28545 * @param player the Elm_Player object.
28546 * @param video The Elm_Video object.
28548 * This mean that action on the player widget will affect the
28549 * video object and the state of the video will be reflected in
28550 * the player itself.
28552 * @see elm_player_add()
28553 * @see elm_video_add()
28554 * @deprecated use elm_object_part_content_set() instead
28558 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28561 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28563 * @param parent The parent object
28564 * @return a new video widget handle or @c NULL, on errors.
28566 * This function inserts a new video widget on the canvas.
28568 * @seeelm_video_file_set()
28569 * @see elm_video_uri_set()
28573 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28576 * @brief Define the file that will be the video source.
28578 * @param video The video object to define the file for.
28579 * @param filename The file to target.
28581 * This function will explicitly define a filename as a source
28582 * for the video of the Elm_Video object.
28584 * @see elm_video_uri_set()
28585 * @see elm_video_add()
28586 * @see elm_player_add()
28590 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28593 * @brief Define the uri that will be the video source.
28595 * @param video The video object to define the file for.
28596 * @param uri The uri to target.
28598 * This function will define an uri as a source for the video of the
28599 * Elm_Video object. URI could be remote source of video, like http:// or local source
28600 * like for example WebCam who are most of the time v4l2:// (but that depend and
28601 * you should use Emotion API to request and list the available Webcam on your system).
28603 * @see elm_video_file_set()
28604 * @see elm_video_add()
28605 * @see elm_player_add()
28609 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28612 * @brief Get the underlying Emotion object.
28614 * @param video The video object to proceed the request on.
28615 * @return the underlying Emotion object.
28619 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28622 * @brief Start to play the video
28624 * @param video The video object to proceed the request on.
28626 * Start to play the video and cancel all suspend state.
28630 EAPI void elm_video_play(Evas_Object *video);
28633 * @brief Pause the video
28635 * @param video The video object to proceed the request on.
28637 * Pause the video and start a timer to trigger suspend mode.
28641 EAPI void elm_video_pause(Evas_Object *video);
28644 * @brief Stop the video
28646 * @param video The video object to proceed the request on.
28648 * Stop the video and put the emotion in deep sleep mode.
28652 EAPI void elm_video_stop(Evas_Object *video);
28655 * @brief Is the video actually playing.
28657 * @param video The video object to proceed the request on.
28658 * @return EINA_TRUE if the video is actually playing.
28660 * You should consider watching event on the object instead of polling
28661 * the object state.
28665 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28668 * @brief Is it possible to seek inside the video.
28670 * @param video The video object to proceed the request on.
28671 * @return EINA_TRUE if is possible to seek inside the video.
28675 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28678 * @brief Is the audio muted.
28680 * @param video The video object to proceed the request on.
28681 * @return EINA_TRUE if the audio is muted.
28685 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28688 * @brief Change the mute state of the Elm_Video object.
28690 * @param video The video object to proceed the request on.
28691 * @param mute The new mute state.
28695 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28698 * @brief Get the audio level of the current video.
28700 * @param video The video object to proceed the request on.
28701 * @return the current audio level.
28705 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28708 * @brief Set the audio level of anElm_Video object.
28710 * @param video The video object to proceed the request on.
28711 * @param volume The new audio volume.
28715 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28717 EAPI double elm_video_play_position_get(const Evas_Object *video);
28718 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28719 EAPI double elm_video_play_length_get(const Evas_Object *video);
28720 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28721 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28722 EAPI const char *elm_video_title_get(const Evas_Object *video);
28727 // FIXME: incomplete - carousel. don't use this until this comment is removed
28728 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28729 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
28730 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28731 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
28732 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
28733 /* smart callbacks called:
28734 * "clicked" - when the user clicks on a carousel item and becomes selected
28739 typedef enum _Elm_Datefield_ItemType
28741 ELM_DATEFIELD_YEAR = 0,
28742 ELM_DATEFIELD_MONTH,
28743 ELM_DATEFIELD_DATE,
28744 ELM_DATEFIELD_HOUR,
28745 ELM_DATEFIELD_MINUTE,
28747 } Elm_Datefield_ItemType;
28749 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28750 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28751 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
28752 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28753 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28754 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28755 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28756 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28757 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28758 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28759 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28760 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28761 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28763 /* smart callbacks called:
28764 * "changed" - when datefield value is changed, this signal is sent.
28768 typedef enum _Elm_Popup_Response
28770 ELM_POPUP_RESPONSE_NONE = -1,
28771 ELM_POPUP_RESPONSE_TIMEOUT = -2,
28772 ELM_POPUP_RESPONSE_OK = -3,
28773 ELM_POPUP_RESPONSE_CANCEL = -4,
28774 ELM_POPUP_RESPONSE_CLOSE = -5
28775 } Elm_Popup_Response;
28777 typedef enum _Elm_Popup_Mode
28779 ELM_POPUP_TYPE_NONE = 0,
28780 ELM_POPUP_TYPE_ALERT = (1 << 0)
28783 typedef enum _Elm_Popup_Orient
28785 ELM_POPUP_ORIENT_TOP,
28786 ELM_POPUP_ORIENT_CENTER,
28787 ELM_POPUP_ORIENT_BOTTOM,
28788 ELM_POPUP_ORIENT_LEFT,
28789 ELM_POPUP_ORIENT_RIGHT,
28790 ELM_POPUP_ORIENT_TOP_LEFT,
28791 ELM_POPUP_ORIENT_TOP_RIGHT,
28792 ELM_POPUP_ORIENT_BOTTOM_LEFT,
28793 ELM_POPUP_ORIENT_BOTTOM_RIGHT
28794 } Elm_Popup_Orient;
28796 /* smart callbacks called:
28797 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28800 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28801 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
28802 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
28803 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
28804 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
28805 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28806 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28807 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28808 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28809 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
28810 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, ... );
28811 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
28812 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28813 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
28814 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28815 EAPI int elm_popup_run(Evas_Object *obj);
28818 * @defgroup Naviframe Naviframe
28819 * @ingroup Elementary
28821 * @brief Naviframe is a kind of view manager for the applications.
28823 * Naviframe provides functions to switch different pages with stack
28824 * mechanism. It means if one page(item) needs to be changed to the new one,
28825 * then naviframe would push the new page to it's internal stack. Of course,
28826 * it can be back to the previous page by popping the top page. Naviframe
28827 * provides some transition effect while the pages are switching (same as
28830 * Since each item could keep the different styles, users could keep the
28831 * same look & feel for the pages or different styles for the items in it's
28834 * Signals that you can add callback for are:
28835 * @li "transition,finished" - When the transition is finished in changing
28837 * @li "title,clicked" - User clicked title area
28839 * Default contents parts of the naviframe items that you can use for are:
28840 * @li "default" - A main content of the page
28841 * @li "icon" - An icon in the title area
28842 * @li "prev_btn" - A button to go to the previous page
28843 * @li "next_btn" - A button to go to the next page
28845 * Default text parts of the naviframe items that you can use for are:
28846 * @li "default" - Title label in the title area
28847 * @li "subtitle" - Sub-title label in the title area
28849 * Supported elm_object common APIs.
28850 * @li elm_object_signal_emit
28852 * Supported elm_object_item common APIs.
28853 * @li elm_object_item_text_set
28854 * @li elm_object_item_part_text_set
28855 * @li elm_object_item_text_get
28856 * @li elm_object_item_part_text_get
28857 * @li elm_object_item_content_set
28858 * @li elm_object_item_part_content_set
28859 * @li elm_object_item_content_get
28860 * @li elm_object_item_part_content_get
28861 * @li elm_object_item_content_unset
28862 * @li elm_object_item_part_content_unset
28863 * @li elm_object_item_signal_emit
28865 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28868 //Available commonly
28869 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28870 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28871 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28872 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28873 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28874 #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28875 #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28876 #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28877 #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28878 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28879 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28880 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28881 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28882 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28883 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28884 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28885 #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28887 //Available only in a style - "2line"
28888 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28890 //Available only in a style - "segment"
28891 #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28892 #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28895 * @addtogroup Naviframe
28900 * @brief Add a new Naviframe object to the parent.
28902 * @param parent Parent object
28903 * @return New object or @c NULL, if it cannot be created
28905 * @ingroup Naviframe
28907 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28910 * @brief Push a new item to the top of the naviframe stack (and show it).
28912 * @param obj The naviframe object
28913 * @param title_label The label in the title area. The name of the title
28914 * label part is "elm.text.title"
28915 * @param prev_btn The button to go to the previous item. If it is NULL,
28916 * then naviframe will create a back button automatically. The name of
28917 * the prev_btn part is "elm.swallow.prev_btn"
28918 * @param next_btn The button to go to the next item. Or It could be just an
28919 * extra function button. The name of the next_btn part is
28920 * "elm.swallow.next_btn"
28921 * @param content The main content object. The name of content part is
28922 * "elm.swallow.content"
28923 * @param item_style The current item style name. @c NULL would be default.
28924 * @return The created item or @c NULL upon failure.
28926 * The item pushed becomes one page of the naviframe, this item will be
28927 * deleted when it is popped.
28929 * @see also elm_naviframe_item_style_set()
28930 * @see also elm_naviframe_item_insert_before()
28931 * @see also elm_naviframe_item_insert_after()
28933 * The following styles are available for this item:
28936 * @ingroup Naviframe
28938 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);
28941 * @brief Insert a new item into the naviframe before item @p before.
28943 * @param before The naviframe item to insert before.
28944 * @param title_label The label in the title area. The name of the title
28945 * label part is "elm.text.title"
28946 * @param prev_btn The button to go to the previous item. If it is NULL,
28947 * then naviframe will create a back button automatically. The name of
28948 * the prev_btn part is "elm.swallow.prev_btn"
28949 * @param next_btn The button to go to the next item. Or It could be just an
28950 * extra function button. The name of the next_btn part is
28951 * "elm.swallow.next_btn"
28952 * @param content The main content object. The name of content part is
28953 * "elm.swallow.content"
28954 * @param item_style The current item style name. @c NULL would be default.
28955 * @return The created item or @c NULL upon failure.
28957 * The item is inserted into the naviframe straight away without any
28958 * transition operations. This item will be deleted when it is popped.
28960 * @see also elm_naviframe_item_style_set()
28961 * @see also elm_naviframe_item_push()
28962 * @see also elm_naviframe_item_insert_after()
28964 * The following styles are available for this item:
28967 * @ingroup Naviframe
28969 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);
28972 * @brief Insert a new item into the naviframe after item @p after.
28974 * @param after The naviframe item to insert after.
28975 * @param title_label The label in the title area. The name of the title
28976 * label part is "elm.text.title"
28977 * @param prev_btn The button to go to the previous item. If it is NULL,
28978 * then naviframe will create a back button automatically. The name of
28979 * the prev_btn part is "elm.swallow.prev_btn"
28980 * @param next_btn The button to go to the next item. Or It could be just an
28981 * extra function button. The name of the next_btn part is
28982 * "elm.swallow.next_btn"
28983 * @param content The main content object. The name of content part is
28984 * "elm.swallow.content"
28985 * @param item_style The current item style name. @c NULL would be default.
28986 * @return The created item or @c NULL upon failure.
28988 * The item is inserted into the naviframe straight away without any
28989 * transition operations. This item will be deleted when it is popped.
28991 * @see also elm_naviframe_item_style_set()
28992 * @see also elm_naviframe_item_push()
28993 * @see also elm_naviframe_item_insert_before()
28995 * The following styles are available for this item:
28998 * @ingroup Naviframe
29000 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);
29003 * @brief Pop an item that is on top of the stack
29005 * @param obj The naviframe object
29006 * @return @c NULL or the content object(if the
29007 * elm_naviframe_content_preserve_on_pop_get is true).
29009 * This pops an item that is on the top(visible) of the naviframe, makes it
29010 * disappear, then deletes the item. The item that was underneath it on the
29011 * stack will become visible.
29013 * @see also elm_naviframe_content_preserve_on_pop_get()
29015 * @ingroup Naviframe
29017 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29020 * @brief Pop the items between the top and the above one on the given item.
29022 * @param it The naviframe item
29024 * @ingroup Naviframe
29026 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29029 * Promote an item already in the naviframe stack to the top of the stack
29031 * @param it The naviframe item
29033 * This will take the indicated item and promote it to the top of the stack
29034 * as if it had been pushed there. The item must already be inside the
29035 * naviframe stack to work.
29038 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29041 * @brief Delete the given item instantly.
29043 * @param it The naviframe item
29045 * This just deletes the given item from the naviframe item list instantly.
29046 * So this would not emit any signals for view transitions but just change
29047 * the current view if the given item is a top one.
29049 * @ingroup Naviframe
29051 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29054 * @brief preserve the content objects when items are popped.
29056 * @param obj The naviframe object
29057 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29059 * @see also elm_naviframe_content_preserve_on_pop_get()
29061 * @ingroup Naviframe
29063 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29066 * @brief Get a value whether preserve mode is enabled or not.
29068 * @param obj The naviframe object
29069 * @return If @c EINA_TRUE, preserve mode is enabled
29071 * @see also elm_naviframe_content_preserve_on_pop_set()
29073 * @ingroup Naviframe
29075 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29078 * @brief Get a top item on the naviframe stack
29080 * @param obj The naviframe object
29081 * @return The top item on the naviframe stack or @c NULL, if the stack is
29084 * @ingroup Naviframe
29086 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29089 * @brief Get a bottom item on the naviframe stack
29091 * @param obj The naviframe object
29092 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29095 * @ingroup Naviframe
29097 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29100 * @brief Set an item style
29102 * @param obj The naviframe item
29103 * @param item_style The current item style name. @c NULL would be default
29105 * The following styles are available for this item:
29108 * @see also elm_naviframe_item_style_get()
29110 * @ingroup Naviframe
29112 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29115 * @brief Get an item style
29117 * @param obj The naviframe item
29118 * @return The current item style name
29120 * @see also elm_naviframe_item_style_set()
29122 * @ingroup Naviframe
29124 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29127 * @brief Show/Hide the title area
29129 * @param it The naviframe item
29130 * @param visible If @c EINA_TRUE, title area will be visible, hidden
29133 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
29135 * @see also elm_naviframe_item_title_visible_get()
29137 * @ingroup Naviframe
29139 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29142 * @brief Get a value whether title area is visible or not.
29144 * @param it The naviframe item
29145 * @return If @c EINA_TRUE, title area is visible
29147 * @see also elm_naviframe_item_title_visible_set()
29149 * @ingroup Naviframe
29151 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29154 * @brief Set creating prev button automatically or not
29156 * @param obj The naviframe object
29157 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29158 * be created internally when you pass the @c NULL to the prev_btn
29159 * parameter in elm_naviframe_item_push
29161 * @see also elm_naviframe_item_push()
29163 * @ingroup Naviframe
29165 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29168 * @brief Get a value whether prev button(back button) will be auto pushed or
29171 * @param obj The naviframe object
29172 * @return If @c EINA_TRUE, prev button will be auto pushed.
29174 * @see also elm_naviframe_item_push()
29175 * elm_naviframe_prev_btn_auto_pushed_set()
29177 * @ingroup Naviframe
29179 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29182 * @brief Get a list of all the naviframe items.
29184 * @param obj The naviframe object
29185 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29186 * or @c NULL on failure.
29188 * @ingroup Naviframe
29190 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29193 * @brief Set the event enabled when pushing/popping items
29195 * If @c enabled is EINA_TRUE, the contents of the naviframe item will
29196 * receives events from mouse and keyboard during view changing such as
29199 * @param obj The naviframe object
29200 * @param enabled Events are received when enabled is @c EINA_TRUE, and
29201 * ignored otherwise.
29203 * @warning Events will be blocked by calling evas_object_freeze_events_set()
29204 * internally. So don't call the API whiling pushing/popping items.
29206 * @see elm_naviframe_event_enabled_get()
29207 * @see evas_object_freeze_events_set()
29209 * @ingroup Naviframe
29211 EAPI void elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
29214 * @brief Get the value of event enabled status.
29216 * @param obj The naviframe object
29217 * @return EINA_TRUE, when event is enabled
29219 * @see elm_naviframe_event_enabled_set()
29221 * @ingroup Naviframe
29223 EAPI Eina_Bool elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29230 * @defgroup Controlbar Controlbar
29231 * @ingroup Elementary
29232 * @addtogroup Controlbar
29235 * This is a Controlbar. It can contain label and icon objects.
29236 * In edit mode, you can change the location of items.
29241 typedef enum _Elm_Controlbar_Mode_Type
29243 ELM_CONTROLBAR_MODE_DEFAULT = 0,
29244 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29245 ELM_CONTROLBAR_MODE_TRANSPARENCY,
29246 ELM_CONTROLBAR_MODE_LARGE,
29247 ELM_CONTROLBAR_MODE_SMALL,
29248 ELM_CONTROLBAR_MODE_LEFT,
29249 ELM_CONTROLBAR_MODE_RIGHT
29250 } Elm_Controlbar_Mode_Type;
29252 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29254 * Add a new controlbar object
29256 * @param parent The parent object
29257 * @return The new object or NULL if it cannot be created
29259 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29261 * Append new tab item
29263 * @param obj The controlbar object
29264 * @param icon_path The icon path of item
29265 * @param label The label of item
29266 * @param view The view of item
29267 * @return The item of controlbar
29269 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29271 * Prepend new tab item
29273 * @param obj The controlbar object
29274 * @param icon_path The icon path of item
29275 * @param label The label of item
29276 * @param view The view of item
29277 * @return The item of controlbar
29279 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29281 * Insert new tab item before given item
29283 * @param obj The controlbar object
29284 * @param before The given item
29285 * @param icon_path The icon path of item
29286 * @param label The label of item
29287 * @param view The view of item
29288 * @return The item of controlbar
29290 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);
29292 * Insert new tab item after given item
29294 * @param obj The controlbar object
29295 * @param after The given item
29296 * @param icon_path The icon path of item
29297 * @param label The label of item
29298 * @param view The view of item
29299 * @return The item of controlbar
29301 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);
29303 * Append new tool item
29305 * @param obj The controlbar object
29306 * @param icon_path The icon path of item
29307 * @param label The label of item
29308 * @param func Callback function of item
29309 * @param data The data of callback function
29310 * @return The item of controlbar
29312 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);
29314 * Prepend new tool item
29316 * @param obj The controlbar object
29317 * @param icon_path The icon path of item
29318 * @param label The label of item
29319 * @param func Callback function of item
29320 * @param data The data of callback function
29321 * @return The item of controlbar
29323 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);
29325 * Insert new tool item before given item
29327 * @param obj The controlbar object
29328 * @param before The given item
29329 * @param icon_path The icon path of item
29330 * @param label The label of item
29331 * @param func Callback function of item
29332 * @param data The data of callback function
29333 * @return The item of controlbar
29335 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);
29337 * Insert new tool item after given item
29339 * @param obj The controlbar object
29340 * @param after The given item
29341 * @param icon_path The icon path of item
29342 * @param label The label of item
29343 * @param func Callback function of item
29344 * @param data The data of callback function
29345 * @return The item of controlbar
29347 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);
29349 * Append new object item
29351 * @param obj The controlbar object
29352 * @param obj_item The object of item
29353 * @param sel The number of sel occupied
29354 * @return The item of controlbar
29356 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29358 * Prepend new object item
29360 * @param obj The controlbar object
29361 * @param obj_item The object of item
29362 * @param sel The number of sel occupied
29363 * @return The item of controlbar
29365 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29367 * Insert new object item before given item
29369 * @param obj The controlbar object
29370 * @param before The given item
29371 * @param obj_item The object of item
29372 * @param sel The number of sel occupied
29373 * @return The item of controlbar
29375 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29377 * Insert new object item after given item
29379 * @param obj The controlbar object
29380 * @param after The given item
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_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29387 * Get the object of the object item
29389 * @param it The item of controlbar
29390 * @return The object of the object item
29392 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29394 * Delete item from controlbar
29396 * @param it The item of controlbar
29398 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
29400 * Select item in controlbar
29402 * @param it The item of controlbar
29404 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
29406 * Set the visible status of item in bar
29408 * @param it The item of controlbar
29409 * @param bar EINA_TRUE or EINA_FALSE
29411 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29413 * Get the result which or not item is visible in bar
29415 * @param it The item of controlbar
29416 * @return EINA_TRUE or EINA_FALSE
29418 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29422 * @param it The item of controlbar
29423 * @param bar EINA_TRUE or EINA_FALSE
29425 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29429 * @param it The item of controlbar
29430 * @return EINA_TRUE or EINA_FALSE
29432 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29434 * Set the icon of item
29436 * @param it The item of controlbar
29437 * @param icon_path The icon path of the item
29438 * @return The icon object
29440 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29442 * Get the icon of item
29444 * @param it The item of controlbar
29445 * @return The icon object
29447 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29449 * Set the label of item
29451 * @param it The item of controlbar
29452 * @param label The label of item
29454 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29456 * Get the label of item
29458 * @param it The item of controlbar
29459 * @return The label of item
29461 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29463 * Get the selected item
29465 * @param obj The controlbar object
29466 * @return The item of controlbar
29468 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29470 * Get the first item
29472 * @param obj The controlbar object
29473 * @return The item of controlbar
29475 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29477 * Get the last item
29479 * @param obj The controlbar object
29480 * @return The item of controlbar
29482 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29486 * @param obj The controlbar object
29487 * @return The list of the items
29489 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
29491 * Get the previous item
29493 * @param it The item of controlbar
29494 * @return The previous item of the parameter item
29496 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29498 * Get the next item
29500 * @param obj The controlbar object
29501 * @return The next item of the parameter item
29503 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29505 * Set the view of the item
29507 * @param it The item of controlbar
29508 * @param view The view for the item
29510 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29512 * Get the view of the item
29514 * @param it The item of controlbar
29515 * @return The view for the item
29517 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29519 * Unset the view of the item
29521 * @param it The item of controlbar
29522 * @return The view for the item
29524 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29526 * Set the vertical mode of the controlbar
29528 * @param obj The object of the controlbar
29529 * @param vertical The vertical mode of the controlbar (TRUE = vertical, FALSE = horizontal)
29531 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29533 * Set the mode of the controlbar
29535 * @param obj The object of the controlbar
29536 * @param mode The mode of the controlbar
29538 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
29540 * Set the alpha of the controlbar
29542 * @param obj The object of the controlbar
29543 * @param alpha The alpha value of the controlbar (0-100)
29545 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29547 * Set auto-align mode of the controlbar(It's not prepared yet)
29548 * If you set the auto-align and add items more than 5,
29549 * the "more" item will be made and the items more than 5 will be unvisible.
29551 * @param obj The object of the controlbar
29552 * @param auto_align The dicision that the controlbar use the auto-align
29554 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29556 * Get the button object of the item
29558 * @param it The item of controlbar
29559 * @return button object of the item
29561 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29568 * @defgroup Searchbar Searchbar
29569 * @addtogroup Searchbar
29571 * @ingroup Elementary
29573 * This is Searchbar.
29574 * It can contain a simple entry and button object.
29578 * Add a new searchbar to the parent
29579 * @param parent The parent object
29580 * @return The new object or NULL if it cannot be created
29582 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29584 * set the text of entry
29586 * @param obj The searchbar object
29589 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29591 * get the text of entry
29593 * @param obj The searchbar object
29594 * @return string pointer of entry
29596 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
29598 * get the pointer of entry
29600 * @param obj The searchbar object
29601 * @return the entry object
29603 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29605 * get the pointer of editfield
29607 * @param obj The searchbar object
29608 * @return the editfield object
29610 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29612 * set the cancel button animation flag
29614 * @param obj The searchbar object
29615 * @param cancel_btn_ani_flag The flag of animating cancen button or not
29618 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29620 * set the cancel button show mode
29622 * @param obj The searchbar object
29623 * @param visible The flag of cancen button show or not
29626 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29628 * clear searchbar status
29630 * @param obj The searchbar object
29633 EAPI void elm_searchbar_clear(Evas_Object *obj);
29635 * set the searchbar boundary rect mode(with bg rect) set
29637 * @param obj The searchbar object
29638 * @param boundary The present flag of boundary rect or not
29641 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29646 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29647 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29648 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29649 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29652 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29653 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
29654 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
29655 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29656 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29659 * @defgroup TickerNoti TickerNoti
29660 * @ingroup Elementary
29662 * This is a notification widget which can be used to display some short information.
29664 * Signals that you can add callback for are:
29665 * @li "clicked" - tickernoti object has been clicked, except at the
29666 * swallow/button region
29667 * @li "hide" - tickernoti is completely hidden. In case of
29668 * any hide animation, this signal is emitted after the animation.
29670 * Default contents parts of a tickernoti object that you can use for are:
29671 * @li "icon" - The icon in tickernoti object
29672 * @li "button" - The button in tickernoti object
29674 * Default text parts of the tickernoti object that you can use for are:
29675 * @li "default" - textual content in the tickernoti object
29677 * Supported elm_object common APIs.
29678 * @li elm_object_text_set
29679 * @li elm_object_part_text_set
29680 * @li elm_object_part_content_set
29685 * @addtogroup Tickernoti
29690 ELM_TICKERNOTI_ORIENT_TOP = 0,
29691 ELM_TICKERNOTI_ORIENT_BOTTOM,
29692 ELM_TICKERNOTI_ORIENT_LAST
29693 } Elm_Tickernoti_Orient;
29696 * Add a tickernoti object to @p parent
29698 * @param parent The parent object
29700 * @return The tickernoti object, or NULL upon failure
29702 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
29704 * Set the orientation of the tickernoti object
29706 * @param obj The tickernoti object
29707 * @param orient The orientation of tickernoti object
29709 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29711 * Get the orientation of the tickernoti object
29713 * @param obj The tickernotil object
29714 * @return The orientation of tickernotil object
29716 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29718 * Get the rotation of tickernoti object
29720 * @param obj The tickernotil object
29721 * @return The rotation angle
29723 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29725 * Set the rotation angle for the tickernoti object
29727 * @param obj The tickernoti object
29728 * @param angle The rotation angle(in degree) will be used on the tickernoti object
29730 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29732 * Get the view window(elm_win) on the tickernoti object
29734 * @param obj The tickernotil object
29735 * @return internal view window(elm_win) object
29737 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29738 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29744 ELM_TICKERNOTI_DEFAULT,
29745 ELM_TICKERNOTI_DETAILVIEW
29746 } Elm_Tickernoti_Mode;
29748 * Set the detail label on the tickernoti object
29750 * @param obj The tickernoti object
29751 * @param label The label will be used on the tickernoti object
29752 * @deprecated use elm_object_text_set() instead
29754 EINA_DEPRECATED EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29756 * Get the detail label used on the tickernoti object
29758 * @param obj The tickernotil object
29759 * @return The string inside the label
29760 * @deprecated use elm_object_text_get() instead
29762 EINA_DEPRECATED EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29764 * Set the button object used on the tickernoti object
29766 * @param obj The tickernotil object
29767 * @param button The button object will be used on the tickernoti object
29768 * @deprecated use elm_object_part_content_set() instead with "button" as part name
29770 EINA_DEPRECATED EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29772 * Get the button object used on the tickernoti object
29774 * @param obj The tickernotil object
29775 * @return The button object inside the tickernoti
29776 * @deprecated use elm_object_part_content_get() instead with "button" as part name
29778 EINA_DEPRECATED EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29780 * Set the detail icon object used on the tickernoti object
29782 * @param obj The tickernotil object
29783 * @param icon The icon object will be used on the tickernoti object
29784 * @deprecated use elm_object_part_content_set() instead with "icon" as part name
29786 EINA_DEPRECATED EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29788 * Get the detail icon object used on the tickernoti object
29790 * @param obj The tickernotil object
29791 * @return The icon object inside the tickernoti
29792 * @deprecated use elm_object_part_content_get() instead with "icon" as part name
29794 EINA_DEPRECATED EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29796 * Get the view mode on the tickernoti object
29798 * @param obj The tickernotil object
29799 * @return The internal window used
29800 * @deprecated use elm_tickernoti_win_get instead when internal window object is needed
29802 EINA_DEPRECATED EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29804 * Set the view mode used on the tickernoti object
29806 * @param obj The tickernotil object
29807 * @param mode The view mode will be used on the tickernoti object
29808 * @deprecated removed as now styles are used. Use elm_object_style_set instead.
29810 EINA_DEPRECATED EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29812 * Get the current mode of the tickernoti object
29814 * @param obj The tickernotil object
29815 * @return the mode of the object. Can be ELM_TICKERNOTI_DEFAULT/ELM_TICKERNOTI_DETAILVIEW
29817 EINA_DEPRECATED EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29819 * Set the orientation of the tickernoti object
29821 * @param obj The tickernoti object
29822 * @param orient The orientation of tickernoti object
29823 * @deprecated use elm_tickernoti_orient_set() instead
29825 EINA_DEPRECATED EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29827 * Get the orientation of the tickernoti object
29829 * @param obj The tickernotil object
29830 * @return The orientation of tickernotil object
29831 * @deprecated use elm_tickernoti_orient_get() instead
29833 EINA_DEPRECATED EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29835 * Set the label on the tickernoti object
29837 * @param obj The tickernoti object
29838 * @param label The label will be used on the tickernoti object
29839 * @deprecated use elm_object_text_set()
29841 EINA_DEPRECATED EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29843 * Get the label used on the tickernoti object
29845 * @param obj The tickernotil object
29846 * @return The string inside the label
29847 * @deprecated use elm_object_text_get() instead
29849 EINA_DEPRECATED EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29851 * Set the icon object of the tickernoti object
29853 * @param obj The tickernotil object
29854 * @param icon The icon object will be used on the tickernoti object
29855 * @deprecated use elm_object_part_content_set() instead with "icon" as part name
29857 EINA_DEPRECATED EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29859 * Get the icon object of the tickernoti object
29861 * @param obj The tickernotil object
29862 * @return The icon object inside the tickernoti
29863 * @deprecated use elm_object_part_content_get() instead with "icon" as part name
29865 EINA_DEPRECATED EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29867 * Set the action button object used on the tickernoti object
29869 * @param obj The tickernotil object
29870 * @param button The button object will be used on the tickernoti object
29871 * @deprecated use elm_object_part_content_set() instead with "button" as part name
29873 EINA_DEPRECATED EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29875 * Get the action button object used on the tickernoti object
29877 * @param obj The tickernotil object
29878 * @return The button object inside the tickernoti
29879 * @deprecated use elm_object_part_content_get() instead with "button" as part name
29881 EINA_DEPRECATED EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29887 * @defgroup Colorpalette Colorpalette
29888 * @ingroup Elementary
29889 * @addtogroup Colorpalette
29892 * Using colorpalette, you can select a color by clicking
29893 * a color rectangle on the colorpalette.
29895 * Smart callbacks that you can add are:
29897 * clicked - This signal is sent when a color rectangle is clicked.
29899 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29900 struct _Colorpalette_Color
29902 unsigned int r, g, b;
29906 * Add a new colorpalette to the parent.
29908 * @param parent The parent object
29909 * @return The new object or NULL if it cannot be created
29911 * @ingroup Colorpalette
29913 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29915 * Set colors to the colorpalette.
29917 * @param obj Colorpalette object
29918 * @param color_num number of the colors on the colorpalette
29919 * @param color Color lists
29921 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29923 * Set row/column value for the colorpalette.
29925 * @param obj Colorpalette object
29926 * @param row row value for the colorpalette
29927 * @param col column value for the colorpalette
29929 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29936 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29937 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
29938 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
29939 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29940 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
29941 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29942 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29943 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
29944 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29945 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
29946 /* smart callbacks called:
29947 * "clicked" - when an editfield is clicked
29948 * "unfocused" - when an editfield is unfocused
29953 * @defgroup Multibuttonentry Multibuttonentry
29955 * @image html img/widget/Multibuttonentry/preview-00.png
29956 * @image latex img/widget/Multibuttonentry/preview-00.eps
29958 * A Multibuttonentry is a widget to allow a user to insert a text button.
29959 * The text button is inserted by pressing the "return" key. If there is no space in the current row,
29960 * a new button is entered in the next row. If the button is pressed, it will get a focus.
29961 * The focused button can be removed by pressing the "backspace" key.
29962 * when items are added over 1 lines, if Multibuttonentry lost focus, it becomes a shrink mode. ( made it as 1 line.)
29964 * Smart callbacks one can register to:
29965 * - @c "item,selected" - when item is selected . it can be called by backspace key.
29966 * - @c "item,added" - when a new multibuttonentry item is added.
29967 * - @c "item,deleted" -when a multibuttonentry item is deleted.
29968 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
29969 * - @c "clicked" - when multibuttonentry is clicked.
29970 * - @c "focused" - when multibuttonentry is focused.
29971 * - @c "unfocused" - when multibuttonentry is unfocused.
29972 * - @c "expanded" - when multibuttonentry is expanded .
29973 * - @c "shrank" - when multibuttonentry is shrank.
29974 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
29976 * Here is an example on its usage:
29977 * @li @ref multibuttonentry_example
29980 * @addtogroup Multibuttonentry
29984 /* multibuttonentry */
29985 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29986 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29989 * @brief Add a new multibuttonentry to the parent
29991 * @param parent The parent object
29992 * @return The new object or NULL if it cannot be created
29994 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
29998 * @param obj The multibuttonentry object
29999 * @return The label, or NULL if none
30001 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
30005 * @param obj The multibuttonentry object
30006 * @param label The text label string
30008 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
30010 * Get the entry of the multibuttonentry object
30012 * @param obj The multibuttonentry object
30013 * @return The entry object, or NULL if none
30015 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
30017 * Get the guide text
30019 * @param obj The multibuttonentry object
30020 * @return The guide text, or NULL if none
30022 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
30024 * Set the guide text
30026 * @param obj The multibuttonentry object
30027 * @param guidetext The guide text string
30029 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
30031 * Get the value of shrink_mode state.
30033 * @param obj The multibuttonentry object
30034 * @param the value of shrink mode state.
30036 EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
30038 * Set/Unset the multibuttonentry to shrink mode state of single line
30040 * @param obj The multibuttonentry object
30041 * @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.
30043 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
30045 * Prepend a new item to the multibuttonentry
30047 * @param obj The multibuttonentry object
30048 * @param label The label of new item
30049 * @param data The ponter to the data to be attached
30050 * @return A handle to the item added or NULL if not possible
30052 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
30054 * Append a new item to the multibuttonentry
30056 * @param obj The multibuttonentry object
30057 * @param label The label of new item
30058 * @param data The ponter to the data to be attached
30059 * @return A handle to the item added or NULL if not possible
30061 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
30063 * Add a new item to the multibuttonentry before the indicated object
30066 * @param obj The multibuttonentry object
30067 * @param before The item before which to add it
30068 * @param label The label of new item
30069 * @param data The ponter to the data to be attached
30070 * @return A handle to the item added or NULL if not possible
30072 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
30074 * Add a new item to the multibuttonentry after the indicated object
30076 * @param obj The multibuttonentry object
30077 * @param after The item after which to add it
30078 * @param label The label of new item
30079 * @param data The ponter to the data to be attached
30080 * @return A handle to the item added or NULL if not possible
30082 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
30084 * Get a list of items in the multibuttonentry
30086 * @param obj The multibuttonentry object
30087 * @return The list of items, or NULL if none
30089 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
30091 * Get the first item in the multibuttonentry
30093 * @param obj The multibuttonentry object
30094 * @return The first item, or NULL if none
30096 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
30098 * Get the last item in the multibuttonentry
30100 * @param obj The multibuttonentry object
30101 * @return The last item, or NULL if none
30103 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
30105 * Get the selected item in the multibuttonentry
30107 * @param obj The multibuttonentry object
30108 * @return The selected item, or NULL if none
30110 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
30112 * Set the selected state of an item
30114 * @param item The item
30115 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30117 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
30119 * unselect all of items.
30121 * @param obj The multibuttonentry object
30123 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
30125 * Delete a given item
30127 * @param item The item
30129 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
30131 * Remove all items in the multibuttonentry.
30133 * @param obj The multibuttonentry object
30135 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
30137 * Get the label of a given item
30139 * @param item The item
30140 * @return The label of a given item, or NULL if none
30142 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
30144 * Set the label of a given item
30146 * @param item The item
30147 * @param label The text label string
30149 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
30151 * Get the previous item in the multibuttonentry
30153 * @param item The item
30154 * @return The item before the item @p item
30156 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
30158 * Get the next item in the multibuttonentry
30160 * @param item The item
30161 * @return The item after the item @p item
30163 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
30165 EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
30166 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
30167 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
30174 * @defgroup Stackedicon Stackedicon
30175 * @ingroup Elementary
30176 * @addtogroup Stackedicon
30179 * This is a Stackedicon.
30180 * smart callback called:
30181 * "expanded" - This signal is emitted when a stackedicon is expanded.
30182 * "clicked" - This signal is emitted when a stackedicon is clicked.
30184 * available styles:
30187 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
30189 * Add a new stackedicon to the parent
30191 * @param parent The parent object
30192 * @return The new object or NULL if it cannot be created
30194 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
30196 * This appends a path to the stackedicon
30198 * @param obj The stackedicon object
30199 * @param path The image full path
30200 * @return The new item or NULL if it cannot be created
30202 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
30204 * This prepends a path to the stackedicon
30206 * @param obj The stackedicon object
30207 * @param path The image full path
30208 * @return The new item or NULL if it cannot be created
30210 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
30212 * This delete a path at the stackedicon
30214 * @param Elm_Stackedicon_Item The delete item
30216 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
30218 * Get item list from the stackedicon
30220 * @param obj The stackedicon object
30221 * @return The item list or NULL if it cannot be created
30223 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
30231 ELM_DAYSELECTOR_SUN,
30232 ELM_DAYSELECTOR_MON,
30233 ELM_DAYSELECTOR_TUE,
30234 ELM_DAYSELECTOR_WED,
30235 ELM_DAYSELECTOR_THU,
30236 ELM_DAYSELECTOR_FRI,
30237 ELM_DAYSELECTOR_SAT
30238 } Elm_DaySelector_Day;
30240 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
30241 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
30242 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
30245 * @defgroup Imageslider Imageslider
30246 * @ingroup Elementary
30247 * @addtogroup Imageslider
30250 * By flicking images on the screen,
30251 * you can see the images in specific path.
30253 typedef struct _Imageslider_Item Elm_Imageslider_Item;
30254 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
30257 * Add an Image Slider widget
30259 * @param parent The parent object
30260 * @return The new Image slider object or NULL if it cannot be created
30262 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30264 * Append an Image Slider item
30266 * @param obj The Image Slider object
30267 * @param photo_file photo file path
30268 * @param func callback function
30269 * @param data callback data
30270 * @return The Image Slider item handle or NULL
30272 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);
30274 * Insert an Image Slider item into the Image Slider Widget by using the given index.
30276 * @param obj The Image Slider object
30277 * @param photo_file photo file path
30278 * @param func callback function
30279 * @param index required position
30280 * @param data callback data
30281 * @return The Image Slider item handle or NULL
30283 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);
30285 * Prepend Image Slider item
30287 * @param obj The Image Slider object
30288 * @param photo_file photo file path
30289 * @param func callback function
30290 * @param data callback data
30291 * @return The imageslider item handle or NULL
30293 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);
30295 * Delete the selected Image Slider item
30297 * @param it The selected Image Slider item handle
30299 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30301 * Get the selected Image Slider item
30303 * @param obj The Image Slider object
30304 * @return The selected Image Slider item or NULL
30306 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
30308 * Get whether an Image Slider item is selected or not
30310 * @param it the selected Image Slider item
30311 * @return EINA_TRUE or EINA_FALSE
30313 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30315 * Set the selected Image Slider item
30317 * @param it The Imaga Slider item
30319 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30321 * Get the photo file path of given Image Slider item
30323 * @param it The Image Slider item
30324 * @return The photo file path or NULL;
30326 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30328 * Sets the photo file path of given Image Slider item
30330 * @param it The Image Slider item
30331 * @param photo_file The photo file path or NULL;
30333 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30335 * Get the previous Image Slider item
30337 * @param it The Image Slider item
30338 * @return The previous Image Slider item or NULL
30340 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30342 * Get the next Image Slider item
30344 * @param it The Image Slider item
30345 * @return The next Image Slider item or NULL
30347 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
30349 * Move to the previous Image Slider item
30351 * @param obj The Image Slider object
30353 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
30355 * Move to the next Image Slider item
30357 * @param obj The Image Slider object
30359 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
30361 * Updates an Image Slider item
30363 * @param it The Image Slider item
30365 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);