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
14 @version @PACKAGE_VERSION@
15 @author Carsten Haitzler <raster@@rasterman.com>
16 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
17 @author Cedric Bail <cedric.bail@@free.fr>
18 @author Vincent Torri <vtorri@@univ-evry.fr>
19 @author Daniel Kolesa <quaker66@@gmail.com>
20 @author Jaime Thomas <avi.thomas@@gmail.com>
21 @author Swisscom - http://www.swisscom.ch/
22 @author Christopher Michael <devilhorns@@comcast.net>
23 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
24 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
25 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
26 @author Brian Wang <brian.wang.0721@@gmail.com>
27 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
28 @author Samsung Electronics <tbd>
29 @author Samsung SAIT <tbd>
30 @author Brett Nash <nash@@nash.id.au>
31 @author Bruno Dilly <bdilly@@profusion.mobi>
32 @author Rafael Fonseca <rfonseca@@profusion.mobi>
33 @author Chuneon Park <hermet@@hermet.pe.kr>
34 @author Woohyun Jung <wh0705.jung@@samsung.com>
35 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
36 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
37 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
38 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
39 @author Gustavo Lima Chaves <glima@@profusion.mobi>
40 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
41 @author Tiago Falcão <tiago@@profusion.mobi>
42 @author Otavio Pontes <otavio@@profusion.mobi>
43 @author Viktor Kojouharov <vkojouharov@@gmail.com>
44 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
45 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
46 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
47 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
48 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
49 @author Jihoon Kim <jihoon48.kim@@samsung.com>
50 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
51 @author Tom Hacohen <tom@@stosb.com>
52 @author Aharon Hillel <a.hillel@@partner.samsung.com>
53 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
54 @author Shinwoo Kim <kimcinoo@@gmail.com>
55 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
56 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
59 @section intro What is Elementary?
61 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
62 applications (yet). Small simple ones with simple needs.
64 It is meant to make the programmers work almost brainless but give them lots
67 License: LGPL v2 (see COPYING in the base of Elementary's source). This
68 applies to all files in the source here.
70 Acknowledgements: There is a lot that goes into making a widget set, and
71 they don't happen out of nothing. It's like trying to make everyone
72 everywhere happy, regardless of age, gender, race or nationality - and
73 that is really tough. So thanks to people and organisations behind this,
74 aslisted in the Authors section above.
86 * @brief Elementary's API
91 @ELM_UNIX_DEF@ ELM_UNIX
92 @ELM_WIN32_DEF@ ELM_WIN32
93 @ELM_WINCE_DEF@ ELM_WINCE
94 @ELM_EDBUS_DEF@ ELM_EDBUS
95 @ELM_EFREET_DEF@ ELM_EFREET
96 @ELM_ETHUMB_DEF@ ELM_ETHUMB
97 @ELM_EMAP_DEF@ ELM_EMAP
98 @ELM_DEBUG_DEF@ ELM_DEBUG
99 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
100 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
102 /* Standard headers for standard system calls etc. */
107 #include <sys/types.h>
108 #include <sys/stat.h>
109 #include <sys/time.h>
110 #include <sys/param.h>
123 # ifdef ELM_LIBINTL_H
124 # include <libintl.h>
135 #if defined (ELM_WIN32) || defined (ELM_WINCE)
138 # define alloca _alloca
149 #include <Ecore_Evas.h>
150 #include <Ecore_File.h>
151 #include <Ecore_IMF.h>
160 # include <Efreet_Mime.h>
161 # include <Efreet_Trash.h>
165 # include <Ethumb_Client.h>
177 # ifdef ELEMENTARY_BUILD
179 # define EAPI __declspec(dllexport)
182 # endif /* ! DLL_EXPORT */
184 # define EAPI __declspec(dllimport)
185 # endif /* ! EFL_EVAS_BUILD */
189 # define EAPI __attribute__ ((visibility("default")))
196 #endif /* ! _WIN32 */
199 /* allow usage from c++ */
204 #define ELM_VERSION_MAJOR @VMAJ@
205 #define ELM_VERSION_MINOR @VMIN@
207 typedef struct _Elm_Version
215 EAPI extern Elm_Version *elm_version;
218 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
219 #define ELM_PI 3.14159265358979323846
222 * @defgroup General General
224 * @brief General Elementary API. Functions that don't relate to
225 * Elementary objects specifically.
227 * Here are documented functions which init/shutdown the library,
228 * that apply to generic Elementary objects, that deal with
229 * configuration, et cetera.
231 * @ref general_functions_example_page "This" example contemplates
232 * some of these functions.
236 * @addtogroup General
241 * Defines couple of standard Evas_Object layers to be used
242 * with evas_object_layer_set().
244 * @note whenever extending with new values, try to keep some padding
245 * to siblings so there is room for further extensions.
247 typedef enum _Elm_Object_Layer
249 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
250 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
251 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
252 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
253 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
254 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
257 /**************************************************************************/
258 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
261 * Emitted when any Elementary's policy value is changed.
263 EAPI extern int ELM_EVENT_POLICY_CHANGED;
266 * @typedef Elm_Event_Policy_Changed
268 * Data on the event when an Elementary policy has changed
270 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
273 * @struct _Elm_Event_Policy_Changed
275 * Data on the event when an Elementary policy has changed
277 struct _Elm_Event_Policy_Changed
279 unsigned int policy; /**< the policy identifier */
280 int new_value; /**< value the policy had before the change */
281 int old_value; /**< new value the policy got */
285 * Policy identifiers.
287 typedef enum _Elm_Policy
289 ELM_POLICY_QUIT, /**< under which circunstances the application
290 * should quit automatically. @see
294 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
297 typedef enum _Elm_Policy_Quit
299 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
301 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
303 * window is closed */
304 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
306 typedef enum _Elm_Focus_Direction
310 } Elm_Focus_Direction;
312 typedef enum _Elm_Text_Format
314 ELM_TEXT_FORMAT_PLAIN_UTF8,
315 ELM_TEXT_FORMAT_MARKUP_UTF8
319 * Line wrapping types.
321 typedef enum _Elm_Wrap_Type
323 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
324 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
325 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
326 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
332 * Called back when a widget's tooltip is activated and needs content.
333 * @param data user-data given to elm_object_tooltip_content_cb_set()
334 * @param obj owner widget.
336 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
339 * Called back when a widget's item tooltip is activated and needs content.
340 * @param data user-data given to elm_object_tooltip_content_cb_set()
341 * @param obj owner widget.
342 * @param item context dependent item. As an example, if tooltip was
343 * set on Elm_List_Item, then it is of this type.
345 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
347 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
349 #ifndef ELM_LIB_QUICKLAUNCH
350 #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 */
352 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
355 /**************************************************************************/
359 * Initialize Elementary
361 * @param[in] argc System's argument count value
362 * @param[in] argv System's pointer to array of argument strings
363 * @return The init counter value.
365 * This function initializes Elementary and increments a counter of
366 * the number of calls to it. It returs the new counter's value.
368 * @warning This call is exported only for use by the @c ELM_MAIN()
369 * macro. There is no need to use this if you use this macro (which
370 * is highly advisable). An elm_main() should contain the entry
371 * point code for your application, having the same prototype as
372 * elm_init(), and @b not being static (putting the @c EAPI symbol
373 * in front of its type declaration is advisable). The @c
374 * ELM_MAIN() call should be placed just after it.
377 * @dontinclude bg_example_01.c
381 * See the full @ref bg_example_01_c "example".
383 * @see elm_shutdown().
386 EAPI int elm_init(int argc, char **argv);
389 * Shut down Elementary
391 * @return The init counter value.
393 * This should be called at the end of your application, just
394 * before it ceases to do any more processing. This will clean up
395 * any permanent resources your application may have allocated via
396 * Elementary that would otherwise persist.
398 * @see elm_init() for an example
402 EAPI int elm_shutdown(void);
405 * Run Elementary's main loop
407 * This call should be issued just after all initialization is
408 * completed. This function will not return until elm_exit() is
409 * called. It will keep looping, running the main
410 * (event/processing) loop for Elementary.
412 * @see elm_init() for an example
416 EAPI void elm_run(void);
419 * Exit Elementary's main loop
421 * If this call is issued, it will flag the main loop to cease
422 * processing and return back to its parent function (usually your
423 * elm_main() function).
425 * @see elm_init() for an example. There, just after a request to
426 * close the window comes, the main loop will be left.
428 * @note By using the #ELM_POLICY_QUIT on your Elementary
429 * applications, you'll this function called automatically for you.
433 EAPI void elm_exit(void);
436 * Provide information in order to make Elementary determine the @b
437 * run time location of the software in question, so other data files
438 * such as images, sound files, executable utilities, libraries,
439 * modules and locale files can be found.
441 * @param mainfunc This is your application's main function name,
442 * whose binary's location is to be found. Providing @c NULL
443 * will make Elementary not to use it
444 * @param dom This will be used as the application's "domain", in the
445 * form of a prefix to any environment variables that may
446 * override prefix detection and the directory name, inside the
447 * standard share or data directories, where the software's
448 * data files will be looked for.
449 * @param checkfile This is an (optional) magic file's path to check
450 * for existence (and it must be located in the data directory,
451 * under the share directory provided above). Its presence will
452 * help determine the prefix found was correct. Pass @c NULL if
453 * the check is not to be done.
455 * This function allows one to re-locate the application somewhere
456 * else after compilation, if the developer wishes for easier
457 * distribution of pre-compiled binaries.
459 * The prefix system is designed to locate where the given software is
460 * installed (under a common path prefix) at run time and then report
461 * specific locations of this prefix and common directories inside
462 * this prefix like the binary, library, data and locale directories,
463 * through the @c elm_app_*_get() family of functions.
465 * Call elm_app_info_set() early on before you change working
466 * directory or anything about @c argv[0], so it gets accurate
469 * It will then try and trace back which file @p mainfunc comes from,
470 * if provided, to determine the application's prefix directory.
472 * The @p dom parameter provides a string prefix to prepend before
473 * environment variables, allowing a fallback to @b specific
474 * environment variables to locate the software. You would most
475 * probably provide a lowercase string there, because it will also
476 * serve as directory domain, explained next. For environment
477 * variables purposes, this string is made uppercase. For example if
478 * @c "myapp" is provided as the prefix, then the program would expect
479 * @c "MYAPP_PREFIX" as a master environment variable to specify the
480 * exact install prefix for the software, or more specific environment
481 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
482 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
483 * the user or scripts before launching. If not provided (@c NULL),
484 * environment variables will not be used to override compiled-in
485 * defaults or auto detections.
487 * The @p dom string also provides a subdirectory inside the system
488 * shared data directory for data files. For example, if the system
489 * directory is @c /usr/local/share, then this directory name is
490 * appended, creating @c /usr/local/share/myapp, if it @p was @c
491 * "myapp". It is expected the application installs data files in
494 * The @p checkfile is a file name or path of something inside the
495 * share or data directory to be used to test that the prefix
496 * detection worked. For example, your app will install a wallpaper
497 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
498 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
501 * @see elm_app_compile_bin_dir_set()
502 * @see elm_app_compile_lib_dir_set()
503 * @see elm_app_compile_data_dir_set()
504 * @see elm_app_compile_locale_set()
505 * @see elm_app_prefix_dir_get()
506 * @see elm_app_bin_dir_get()
507 * @see elm_app_lib_dir_get()
508 * @see elm_app_data_dir_get()
509 * @see elm_app_locale_dir_get()
511 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
514 * Provide information on the @b fallback application's binaries
515 * directory, on scenarios where they get overriden by
516 * elm_app_info_set().
518 * @param dir The path to the default binaries directory (compile time
521 * @note Elementary will as well use this path to determine actual
522 * names of binaries' directory paths, maybe changing it to be @c
523 * something/local/bin instead of @c something/bin, only, for
526 * @warning You should call this function @b before
527 * elm_app_info_set().
529 EAPI void elm_app_compile_bin_dir_set(const char *dir);
532 * Provide information on the @b fallback application's libraries
533 * directory, on scenarios where they get overriden by
534 * elm_app_info_set().
536 * @param dir The path to the default libraries directory (compile
539 * @note Elementary will as well use this path to determine actual
540 * names of libraries' directory paths, maybe changing it to be @c
541 * something/lib32 or @c something/lib64 instead of @c something/lib,
544 * @warning You should call this function @b before
545 * elm_app_info_set().
547 EAPI void elm_app_compile_lib_dir_set(const char *dir);
550 * Provide information on the @b fallback application's data
551 * directory, on scenarios where they get overriden by
552 * elm_app_info_set().
554 * @param dir The path to the default data directory (compile time
557 * @note Elementary will as well use this path to determine actual
558 * names of data directory paths, maybe changing it to be @c
559 * something/local/share instead of @c something/share, only, for
562 * @warning You should call this function @b before
563 * elm_app_info_set().
565 EAPI void elm_app_compile_data_dir_set(const char *dir);
568 * Provide information on the @b fallback application's locale
569 * directory, on scenarios where they get overriden by
570 * elm_app_info_set().
572 * @param dir The path to the default locale directory (compile time
575 * @warning You should call this function @b before
576 * elm_app_info_set().
578 EAPI void elm_app_compile_locale_set(const char *dir);
581 * Retrieve the application's run time prefix directory, as set by
582 * elm_app_info_set() and the way (environment) the application was
585 * @return The directory prefix the application is actually using
587 EAPI const char *elm_app_prefix_dir_get(void);
590 * Retrieve the application's run time binaries prefix directory, as
591 * set by elm_app_info_set() and the way (environment) the application
594 * @return The binaries directory prefix the application is actually
597 EAPI const char *elm_app_bin_dir_get(void);
600 * Retrieve the application's run time libraries prefix directory, as
601 * set by elm_app_info_set() and the way (environment) the application
604 * @return The libraries directory prefix the application is actually
607 EAPI const char *elm_app_lib_dir_get(void);
610 * Retrieve the application's run time data prefix directory, as
611 * set by elm_app_info_set() and the way (environment) the application
614 * @return The data directory prefix the application is actually
617 EAPI const char *elm_app_data_dir_get(void);
620 * Retrieve the application's run time locale prefix directory, as
621 * set by elm_app_info_set() and the way (environment) the application
624 * @return The locale directory prefix the application is actually
627 EAPI const char *elm_app_locale_dir_get(void);
629 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
630 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
631 EAPI int elm_quicklaunch_init(int argc, char **argv);
632 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
633 EAPI int elm_quicklaunch_sub_shutdown(void);
634 EAPI int elm_quicklaunch_shutdown(void);
635 EAPI void elm_quicklaunch_seed(void);
636 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
637 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
638 EAPI void elm_quicklaunch_cleanup(void);
639 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
640 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
642 EAPI Eina_Bool elm_need_efreet(void);
643 EAPI Eina_Bool elm_need_e_dbus(void);
644 EAPI Eina_Bool elm_need_ethumb(void);
647 * Set a new policy's value (for a given policy group/identifier).
649 * @param policy policy identifier, as in @ref Elm_Policy.
650 * @param value policy value, which depends on the identifier
652 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
654 * Elementary policies define applications' behavior,
655 * somehow. These behaviors are divided in policy groups (see
656 * #Elm_Policy enumeration). This call will emit the Ecore event
657 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
658 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
661 * @note Currently, we have only one policy identifier/group
662 * (#ELM_POLICY_QUIT), which has two possible values.
666 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
669 * Gets the policy value set for given policy identifier.
671 * @param policy policy identifier, as in #Elm_Policy.
672 * @return The currently set policy value, for that
673 * identifier. Will be @c 0 if @p policy passed is invalid.
677 EAPI int elm_policy_get(unsigned int policy);
680 * Set a label of an object
682 * @param obj The Elementary object
683 * @param item The label id to set (NULL for the default label)
684 * @param label The new text of the label
686 * @note Elementary objects may have many labels (e.g. Action Slider)
690 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
692 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
695 * Get a label of an object
697 * @param obj The Elementary object
698 * @param item The label id to get (NULL for the default label)
699 * @return text of the label or
702 * @note Elementary objects may have many labels (e.g. Action Slider)
706 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *item);
708 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
714 EAPI void elm_all_flush(void);
715 EAPI int elm_cache_flush_interval_get(void);
716 EAPI void elm_cache_flush_interval_set(int size);
717 EAPI void elm_cache_flush_interval_all_set(int size);
718 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
719 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
720 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
721 EAPI int elm_font_cache_get(void);
722 EAPI void elm_font_cache_set(int size);
723 EAPI void elm_font_cache_all_set(int size);
724 EAPI int elm_image_cache_get(void);
725 EAPI void elm_image_cache_set(int size);
726 EAPI void elm_image_cache_all_set(int size);
727 EAPI int elm_edje_file_cache_get(void);
728 EAPI void elm_edje_file_cache_set(int size);
729 EAPI void elm_edje_file_cache_all_set(int size);
730 EAPI int elm_edje_collection_cache_get(void);
731 EAPI void elm_edje_collection_cache_set(int size);
732 EAPI void elm_edje_collection_cache_all_set(int size);
735 * @defgroup Scaling Selective Widget Scaling
737 * Different widgets can be scaled independently. These functions
738 * allow you to manipulate this scaling on a per-widget basis. The
739 * object and all its children get their scaling factors multiplied
740 * by the scale factor set. This is multiplicative, in that if a
741 * child also has a scale size set it is in turn multiplied by its
742 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
743 * double size, @c 0.5 is half, etc.
745 * @ref general_functions_example_page "This" example contemplates
746 * some of these functions.
750 * Set the scaling factor for a given Elementary object
752 * @param obj The Elementary to operate on
753 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
758 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
761 * Get the scaling factor for a given Elementary object
763 * @param obj The object
764 * @return The scaling factor set by elm_object_scale_set()
768 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
769 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
770 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
771 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
772 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
774 * Set the style to use by a widget
776 * Sets the style name that will define the appearance of a widget. Styles
777 * vary from widget to widget and may also be defined by other themes
778 * by means of extensions and overlays.
780 * @param obj The Elementary widget to style
781 * @param style The style name to use
783 * @see elm_theme_extension_add()
784 * @see elm_theme_overlay_add()
788 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
790 * Get the style used by the widget
792 * This gets the style being used for that widget. Note that the string
793 * pointer is only valid as longas the object is valid and the style doesn't
796 * @param obj The Elementary widget to query for its style
797 * @return The style name used
799 * @see elm_object_style_set()
803 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
806 * @defgroup Styles Styles
808 * Widgets can have different styles of look. These generic API's
809 * set styles of widgets, if they support them (and if the theme(s)
812 * @ref general_functions_example_page "This" example contemplates
813 * some of these functions.
817 * Set the disabled state of an Elementary object.
819 * @param obj The Elementary object to operate on
820 * @param disabled The state to put in in: @c EINA_TRUE for
821 * disabled, @c EINA_FALSE for enabled
823 * Elementary objects can be @b disabled, in which state they won't
824 * receive input and, in general, will be themed differently from
825 * their normal state, usually greyed out. Useful for contexts
826 * where you don't want your users to interact with some of the
827 * parts of you interface.
829 * This sets the state for the widget, either disabling it or
834 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
837 * Get the disabled state of an Elementary object.
839 * @param obj The Elementary object to operate on
840 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
841 * if it's enabled (or on errors)
843 * This gets the state of the widget, which might be enabled or disabled.
847 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
850 * @defgroup WidgetNavigation Widget Tree Navigation.
852 * How to check if an Evas Object is an Elementary widget? How to
853 * get the first elementary widget that is parent of the given
854 * object? These are all covered in widget tree navigation.
856 * @ref general_functions_example_page "This" example contemplates
857 * some of these functions.
860 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
863 * Get the first parent of the given object that is an Elementary
866 * @param obj the Elementary object to query parent from.
867 * @return the parent object that is an Elementary widget, or @c
868 * NULL, if it was not found.
870 * Use this to query for an object's parent widget.
872 * @note Most of Elementary users wouldn't be mixing non-Elementary
873 * smart objects in the objects tree of an application, as this is
874 * an advanced usage of Elementary with Evas. So, except for the
875 * application's window, which is the root of that tree, all other
876 * objects would have valid Elementary widget parents.
878 * @ingroup WidgetNavigation
880 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
881 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
882 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
884 EAPI double elm_scale_get(void);
885 EAPI void elm_scale_set(double scale);
886 EAPI void elm_scale_all_set(double scale);
888 EAPI Eina_Bool elm_mirrored_get(void);
889 EAPI void elm_mirrored_set(Eina_Bool mirrored);
891 EAPI Eina_Bool elm_config_save(void);
892 EAPI void elm_config_reload(void);
894 EAPI const char *elm_profile_current_get(void);
895 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
896 EAPI void elm_profile_dir_free(const char *p_dir);
897 EAPI Eina_List *elm_profile_list_get(void);
898 EAPI void elm_profile_list_free(Eina_List *l);
899 EAPI void elm_profile_set(const char *profile);
900 EAPI void elm_profile_all_set(const char *profile);
902 EAPI const char *elm_engine_current_get(void);
903 EAPI void elm_engine_set(const char *engine);
905 typedef struct _Elm_Text_Class
911 typedef struct _Elm_Font_Overlay
913 const char *text_class;
918 typedef struct _Elm_Font_Properties
922 } Elm_Font_Properties;
924 EAPI const Eina_List *elm_text_classes_list_get(void);
925 EAPI void elm_text_classes_list_free(const Eina_List *list);
927 EAPI const Eina_List *elm_font_overlay_list_get(void);
928 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
929 EAPI void elm_font_overlay_unset(const char *text_class);
930 EAPI void elm_font_overlay_apply(void);
931 EAPI void elm_font_overlay_all_apply(void);
933 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
934 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
935 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
936 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
937 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
938 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
941 * @defgroup Fingers Fingers
943 * Elementary is designed to be finger-friendly for touchscreens,
944 * and so in addition to scaling for display resolution, it can
945 * also scale based on finger "resolution" (or size). You can then
946 * customize the granularity of the areas meant to receive clicks
949 * Different profiles may have pre-set values for finger sizes.
951 * @ref general_functions_example_page "This" example contemplates
952 * some of these functions.
956 * Get the configured "finger size"
958 * @return The finger size
960 * This gets the globally configured finger size, <b>in pixels</b>
964 EAPI Evas_Coord elm_finger_size_get(void);
965 EAPI void elm_finger_size_set(Evas_Coord size);
966 EAPI void elm_finger_size_all_set(Evas_Coord size);
969 * @defgroup Focus Focus
971 * An Elementary application has, at all times, one (and only one)
972 * @b focused object. This is what determines where the input
973 * events go to within the application's window. Also, focused
974 * objects can be decorated differently, in order to signal to the
975 * user where the input is, at a given moment.
977 * Elementary applications also have the concept of <b>focus
978 * chain</b>: one can cycle through all the windows' focusable
979 * objects by input (tab key) or programmatically. The default
980 * focus chain for an application is the one define by the order in
981 * which the widgets where added in code. One will cycle through
982 * top level widgets, and, for each one containg sub-objects, cycle
983 * through them all, before returning to the level
984 * above. Elementary also allows one to set @b custom focus chains
985 * for their applications.
987 * Besides the focused decoration a widget may exhibit, when it
988 * gets focus, Elementary has a @b global focus highlight object
989 * that can be enabled for a window. If one chooses to do so, this
990 * extra highlight effect will surround the current focused object,
993 * @note Some Elementary widgets are @b unfocusable, after
994 * creation, by their very nature: they are not meant to be
995 * interacted with input events, but are there just for visual
998 * @ref general_functions_example_page "This" example contemplates
999 * some of these functions.
1002 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1003 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1004 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1005 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1008 * Get the whether an Elementary object has the focus or not.
1010 * @param obj The Elementary object to get the information from
1011 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1012 * not (and on errors).
1014 * @see elm_object_focus()
1018 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1021 * Make a given Elementary object the focused one.
1023 * @param obj The Elementary object to make focused.
1025 * @note This object, if it can handle focus, will take the focus
1026 * away from the one who had it previously and will, for now on, be
1027 * the one receiving input events.
1029 * @see elm_object_focus_get()
1033 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1036 * Remove the focus from an Elementary object
1038 * @param obj The Elementary to take focus from
1040 * This removes the focus from @p obj, passing it back to the
1041 * previous element in the focus chain list.
1043 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1047 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1050 * Set the ability for an Element object to be focused
1052 * @param obj The Elementary object to operate on
1053 * @param enable @c EINA_TRUE if the object can be focused, @c
1054 * EINA_FALSE if not (and on errors)
1056 * This sets whether the object @p obj is able to take focus or
1057 * not. Unfocusable objects do nothing when programmatically
1058 * focused, being the nearest focusable parent object the one
1059 * really getting focus. Also, when they receive mouse input, they
1060 * will get the event, but not take away the focus from where it
1065 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1068 * Get whether an Elementary object is focusable or not
1070 * @param obj The Elementary object to operate on
1071 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1072 * EINA_FALSE if not (and on errors)
1074 * @note Objects which are meant to be interacted with by input
1075 * events are created able to be focused, by default. All the
1080 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1082 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1083 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1084 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1085 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1086 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1087 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1088 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1090 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1091 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1092 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1093 EAPI double elm_scroll_bounce_friction_get(void);
1094 EAPI void elm_scroll_bounce_friction_set(double friction);
1095 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1096 EAPI double elm_scroll_page_scroll_friction_get(void);
1097 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1098 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1099 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1100 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1101 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1102 EAPI double elm_scroll_zoom_friction_get(void);
1103 EAPI void elm_scroll_zoom_friction_set(double friction);
1104 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1105 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1106 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1107 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1108 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1109 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1110 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1111 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1112 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1113 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1114 EAPI double elm_scroll_thumbscroll_friction_get(void);
1115 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1116 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1117 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1118 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1119 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1121 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1122 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1123 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1124 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1125 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1126 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1127 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1128 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1130 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1131 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
1132 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
1134 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1135 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1138 * Adjust size of an element for finger usage.
1140 * @param times_w How many fingers should fit horizontally
1141 * @param w Pointer to the width size to adjust
1142 * @param times_h How many fingers should fit vertically
1143 * @param h Pointer to the height size to adjust
1145 * This takes width and height sizes (in pixels) as input and a
1146 * size multiple (which is how many fingers you want to place
1147 * within the area, being "finger" the size set by
1148 * elm_finger_size_set()), and adjusts the size to be large enough
1149 * to accommodate the resulting size -- if it doesn't already
1150 * accommodate it. On return the @p w and @p h sizes pointed to by
1151 * these parameters will be modified, on those conditions.
1153 * @note This is kind of a low level Elementary call, most useful
1154 * on size evaluation times for widgets. An external user wouldn't
1155 * be calling, most of the time.
1159 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1161 EAPI double elm_longpress_timeout_get(void);
1162 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1165 * don't use it unless you are sure
1167 EAPI void elm_object_tree_dump(const Evas_Object *top);
1168 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1173 * @defgroup Theme Theme
1175 * Elementary uses Edje to theme its widgets, naturally. But for the most
1176 * part this is hidden behind a simpler interface that lets the user set
1177 * extensions and choose the style of widgets in a much easier way.
1179 * Instead of thinking in terms of paths to Edje files and their groups
1180 * each time you want to change the appearance of a widget, Elementary
1181 * works so you can add any theme file with extensions or replace the
1182 * main theme at one point in the application, and then just set the style
1183 * of widgets with elm_object_style_set() and related functions. Elementary
1184 * will then look in its list of themes for a matching group and apply it,
1185 * and when the theme changes midway through the application, all widgets
1186 * will be updated accordingly.
1188 * There are three concepts you need to know to understand how Elementary
1189 * theming works: default theme, extensions and overlays.
1191 * Default theme, obviously enough, is the one that provides the default
1192 * look of all widgets. End users can change the theme used by Elementary
1193 * by setting the @c ELM_THEME environment variable before running an
1194 * application, or globally for all programs using the @c elementary_config
1195 * utility. Applications can change the default theme using elm_theme_set(),
1196 * but this can go against the user wishes, so it's not an adviced practice.
1198 * Ideally, applications should find everything they need in the already
1199 * provided theme, but there may be occasions when that's not enough and
1200 * custom styles are required to correctly express the idea. For this
1201 * cases, Elementary has extensions.
1203 * Extensions allow the application developer to write styles of its own
1204 * to apply to some widgets. This requires knowledge of how each widget
1205 * is themed, as extensions will always replace the entire group used by
1206 * the widget, so important signals and parts need to be there for the
1207 * object to behave properly (see documentation of Edje for details).
1208 * Once the theme for the extension is done, the application needs to add
1209 * it to the list of themes Elementary will look into, using
1210 * elm_theme_extension_add(), and set the style of the desired widgets as
1211 * he would normally with elm_object_style_set().
1213 * Overlays, on the other hand, can replace the look of all widgets by
1214 * overriding the default style. Like extensions, it's up to the application
1215 * developer to write the theme for the widgets it wants, the difference
1216 * being that when looking for the theme, Elementary will check first the
1217 * list of overlays, then the set theme and lastly the list of extensions,
1218 * so with overlays it's possible to replace the default view and every
1219 * widget will be affected. This is very much alike to setting the whole
1220 * theme for the application and will probably clash with the end user
1221 * options, not to mention the risk of ending up with not matching styles
1222 * across the program. Unless there's a very special reason to use them,
1223 * overlays should be avoided for the resons exposed before.
1225 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1226 * keeps one default internally and every function that receives one of
1227 * these can be called with NULL to refer to this default (except for
1228 * elm_theme_free()). It's possible to create a new instance of a
1229 * ::Elm_Theme to set other theme for a specific widget (and all of its
1230 * children), but this is as discouraged, if not even more so, than using
1231 * overlays. Don't use this unless you really know what you are doing.
1233 * But to be less negative about things, you can look at the following
1235 * @li @ref theme_example_01 "Using extensions"
1236 * @li @ref theme_example_02 "Using overlays"
1241 * @typedef Elm_Theme
1243 * Opaque handler for the list of themes Elementary looks for when
1244 * rendering widgets.
1246 * Stay out of this unless you really know what you are doing. For most
1247 * cases, sticking to the default is all a developer needs.
1249 typedef struct _Elm_Theme Elm_Theme;
1252 * Create a new specific theme
1254 * This creates an empty specific theme that only uses the default theme. A
1255 * specific theme has its own private set of extensions and overlays too
1256 * (which are empty by default). Specific themes do not fall back to themes
1257 * of parent objects. They are not intended for this use. Use styles, overlays
1258 * and extensions when needed, but avoid specific themes unless there is no
1259 * other way (example: you want to have a preview of a new theme you are
1260 * selecting in a "theme selector" window. The preview is inside a scroller
1261 * and should display what the theme you selected will look like, but not
1262 * actually apply it yet. The child of the scroller will have a specific
1263 * theme set to show this preview before the user decides to apply it to all
1266 EAPI Elm_Theme *elm_theme_new(void);
1268 * Free a specific theme
1270 * @param th The theme to free
1272 * This frees a theme created with elm_theme_new().
1274 EAPI void elm_theme_free(Elm_Theme *th);
1276 * Copy the theme fom the source to the destination theme
1278 * @param th The source theme to copy from
1279 * @param thdst The destination theme to copy data to
1281 * This makes a one-time static copy of all the theme config, extensions
1282 * and overlays from @p th to @p thdst. If @p th references a theme, then
1283 * @p thdst is also set to reference it, with all the theme settings,
1284 * overlays and extensions that @p th had.
1286 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1288 * Tell the source theme to reference the ref theme
1290 * @param th The theme that will do the referencing
1291 * @param thref The theme that is the reference source
1293 * This clears @p th to be empty and then sets it to refer to @p thref
1294 * so @p th acts as an override to @p thref, but where its overrides
1295 * don't apply, it will fall through to @pthref for configuration.
1297 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1299 * Return the theme referred to
1301 * @param th The theme to get the reference from
1302 * @return The referenced theme handle
1304 * This gets the theme set as the reference theme by elm_theme_ref_set().
1305 * If no theme is set as a reference, NULL is returned.
1307 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1309 * Return the default theme
1311 * @return The default theme handle
1313 * This returns the internal default theme setup handle that all widgets
1314 * use implicitly unless a specific theme is set. This is also often use
1315 * as a shorthand of NULL.
1317 EAPI Elm_Theme *elm_theme_default_get(void);
1319 * Prepends a theme overlay to the list of overlays
1321 * @param th The theme to add to, or if NULL, the default theme
1322 * @param item The Edje file path to be used
1324 * Use this if your application needs to provide some custom overlay theme
1325 * (An Edje file that replaces some default styles of widgets) where adding
1326 * new styles, or changing system theme configuration is not possible. Do
1327 * NOT use this instead of a proper system theme configuration. Use proper
1328 * configuration files, profiles, environment variables etc. to set a theme
1329 * so that the theme can be altered by simple confiugration by a user. Using
1330 * this call to achieve that effect is abusing the API and will create lots
1333 * @see elm_theme_extension_add()
1335 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1337 * Delete a theme overlay from the list of overlays
1339 * @param th The theme to delete from, or if NULL, the default theme
1340 * @param item The name of the theme overlay
1342 * @see elm_theme_overlay_add()
1344 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1346 * Appends a theme extension to the list of extensions.
1348 * @param th The theme to add to, or if NULL, the default theme
1349 * @param item The Edje file path to be used
1351 * This is intended when an application needs more styles of widgets or new
1352 * widget themes that the default does not provide (or may not provide). The
1353 * application has "extended" usage by coming up with new custom style names
1354 * for widgets for specific uses, but as these are not "standard", they are
1355 * not guaranteed to be provided by a default theme. This means the
1356 * application is required to provide these extra elements itself in specific
1357 * Edje files. This call adds one of those Edje files to the theme search
1358 * path to be search after the default theme. The use of this call is
1359 * encouraged when default styles do not meet the needs of the application.
1360 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1362 * @see elm_object_style_set()
1364 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1366 * Deletes a theme extension from the list of extensions.
1368 * @param th The theme to delete from, or if NULL, the default theme
1369 * @param item The name of the theme extension
1371 * @see elm_theme_extension_add()
1373 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1375 * Set the theme search order for the given theme
1377 * @param th The theme to set the search order, or if NULL, the default theme
1378 * @param theme Theme search string
1380 * This sets the search string for the theme in path-notation from first
1381 * theme to search, to last, delimited by the : character. Example:
1383 * "shiny:/path/to/file.edj:default"
1385 * See the ELM_THEME environment variable for more information.
1387 * @see elm_theme_get()
1388 * @see elm_theme_list_get()
1390 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1392 * Return the theme search order
1394 * @param th The theme to get the search order, or if NULL, the default theme
1395 * @return The internal search order path
1397 * This function returns a colon separated string of theme elements as
1398 * returned by elm_theme_list_get().
1400 * @see elm_theme_set()
1401 * @see elm_theme_list_get()
1403 EAPI const char *elm_theme_get(Elm_Theme *th);
1405 * Return a list of theme elements to be used in a theme.
1407 * @param th Theme to get the list of theme elements from.
1408 * @return The internal list of theme elements
1410 * This returns the internal list of theme elements (will only be valid as
1411 * long as the theme is not modified by elm_theme_set() or theme is not
1412 * freed by elm_theme_free(). This is a list of strings which must not be
1413 * altered as they are also internal. If @p th is NULL, then the default
1414 * theme element list is returned.
1416 * A theme element can consist of a full or relative path to a .edj file,
1417 * or a name, without extension, for a theme to be searched in the known
1418 * theme paths for Elemementary.
1420 * @see elm_theme_set()
1421 * @see elm_theme_get()
1423 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1425 * Return the full patrh for a theme element
1427 * @param f The theme element name
1428 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1429 * @return The full path to the file found.
1431 * This returns a string you should free with free() on success, NULL on
1432 * failure. This will search for the given theme element, and if it is a
1433 * full or relative path element or a simple searchable name. The returned
1434 * path is the full path to the file, if searched, and the file exists, or it
1435 * is simply the full path given in the element or a resolved path if
1436 * relative to home. The @p in_search_path boolean pointed to is set to
1437 * EINA_TRUE if the file was a searchable file andis in the search path,
1438 * and EINA_FALSE otherwise.
1440 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1442 * Flush the current theme.
1444 * @param th Theme to flush
1446 * This flushes caches that let elementary know where to find theme elements
1447 * in the given theme. If @p th is NULL, then the default theme is flushed.
1448 * Call this function if source theme data has changed in such a way as to
1449 * make any caches Elementary kept invalid.
1451 EAPI void elm_theme_flush(Elm_Theme *th);
1453 * This flushes all themes (default and specific ones).
1455 * This will flush all themes in the current application context, by calling
1456 * elm_theme_flush() on each of them.
1458 EAPI void elm_theme_full_flush(void);
1460 * Set the theme for all elementary using applications on the current display
1462 * @param theme The name of the theme to use. Format same as the ELM_THEME
1463 * environment variable.
1465 EAPI void elm_theme_all_set(const char *theme);
1467 * Return a list of theme elements in the theme search path
1469 * @return A list of strings that are the theme element names.
1471 * This lists all available theme files in the standard Elementary search path
1472 * for theme elements, and returns them in alphabetical order as theme
1473 * element names in a list of strings. Free this with
1474 * elm_theme_name_available_list_free() when you are done with the list.
1476 EAPI Eina_List *elm_theme_name_available_list_new(void);
1478 * Free the list returned by elm_theme_name_available_list_new()
1480 * This frees the list of themes returned by
1481 * elm_theme_name_available_list_new(). Once freed the list should no longer
1482 * be used. a new list mys be created.
1484 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1486 * Set a specific theme to be used for this object and its children
1488 * @param obj The object to set the theme on
1489 * @param th The theme to set
1491 * This sets a specific theme that will be used for the given object and any
1492 * child objects it has. If @p th is NULL then the theme to be used is
1493 * cleared and the object will inherit its theme from its parent (which
1494 * ultimately will use the default theme if no specific themes are set).
1496 * Use special themes with great care as this will annoy users and make
1497 * configuration difficult. Avoid any custom themes at all if it can be
1500 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1502 * Get the specific theme to be used
1504 * @param obj The object to get the specific theme from
1505 * @return The specifc theme set.
1507 * This will return a specific theme set, or NULL if no specific theme is
1508 * set on that object. It will not return inherited themes from parents, only
1509 * the specific theme set for that specific object. See elm_object_theme_set()
1510 * for more information.
1512 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1518 typedef enum _Elm_Win_Type
1521 ELM_WIN_DIALOG_BASIC,
1528 ELM_WIN_DROPDOWN_MENU,
1531 ELM_WIN_NOTIFICATION,
1534 ELM_WIN_INLINED_IMAGE,
1537 typedef enum _Elm_Win_Keyboard_Mode
1539 ELM_WIN_KEYBOARD_UNKNOWN,
1540 ELM_WIN_KEYBOARD_OFF,
1541 ELM_WIN_KEYBOARD_ON,
1542 ELM_WIN_KEYBOARD_ALPHA,
1543 ELM_WIN_KEYBOARD_NUMERIC,
1544 ELM_WIN_KEYBOARD_PIN,
1545 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1546 ELM_WIN_KEYBOARD_HEX,
1547 ELM_WIN_KEYBOARD_TERMINAL,
1548 ELM_WIN_KEYBOARD_PASSWORD,
1549 ELM_WIN_KEYBOARD_IP,
1550 ELM_WIN_KEYBOARD_HOST,
1551 ELM_WIN_KEYBOARD_FILE,
1552 ELM_WIN_KEYBOARD_URL,
1553 ELM_WIN_KEYBOARD_KEYPAD,
1554 ELM_WIN_KEYBOARD_J2ME
1555 } Elm_Win_Keyboard_Mode;
1557 typedef enum _Elm_Illume_Command
1559 ELM_ILLUME_COMMAND_FOCUS_BACK,
1560 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1561 ELM_ILLUME_COMMAND_FOCUS_HOME,
1562 ELM_ILLUME_COMMAND_CLOSE
1563 } Elm_Illume_Command;
1565 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1566 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1567 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1568 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1569 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1570 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1571 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1572 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1573 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1574 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1575 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1576 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1578 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1580 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1581 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1582 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1583 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1584 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1585 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1586 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1587 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1588 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1589 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1590 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1592 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1593 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1594 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1595 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1596 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1597 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1598 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1599 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1600 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1601 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1602 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1603 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1604 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1605 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1606 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1607 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1608 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1609 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1610 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1611 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1612 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1613 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1614 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1616 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1617 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1618 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1619 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1620 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1621 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1622 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1624 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1625 * (blank mouse, private mouse obj, defaultmouse)
1628 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1629 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1630 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1631 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1633 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1635 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1636 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1637 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1638 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1639 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1640 /* available styles:
1645 /* X specific calls - won't work on non-x engines (return 0) */
1646 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1647 /* smart callbacks called:
1648 * "delete,request" - the user requested to delete the window
1649 * "focus,in" - window got focus
1650 * "focus,out" - window lost focus
1651 * "moved" - window that holds the canvas was moved
1657 * @brief Background object, used for setting a solid color, image or Edje
1658 * group as background to a window or any container object.
1660 * The bg object is used for setting a solid background to a window or
1661 * packing into any container object. It works just like an image, but has
1662 * some properties useful to a background, like setting it to tiled,
1663 * centered, scaled or stretched.
1665 * Here is some sample code using it:
1666 * @li @ref bg_01_example_page
1667 * @li @ref bg_02_example_page
1668 * @li @ref bg_03_example_page
1672 typedef enum _Elm_Bg_Option
1674 ELM_BG_OPTION_CENTER, /**< center the background */
1675 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1676 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1677 ELM_BG_OPTION_TILE /**< tile background at its original size */
1681 * Add a new background to the parent
1683 * @param parent The parent object
1684 * @return The new object or NULL if it cannot be created
1688 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1691 * Set the file (image or edje) used for the background
1693 * @param obj The bg object
1694 * @param file The file path
1695 * @param group Optional key (group in Edje) within the file
1697 * This sets the image file used in the background object. The image (or edje)
1698 * will be stretched (retaining aspect if its an image file) to completely fill
1699 * the bg object. This may mean some parts are not visible.
1701 * @note Once the image of @p obj is set, a previously set one will be deleted,
1702 * even if @p file is NULL.
1706 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1709 * Get the file (image or edje) used for the background
1711 * @param obj The bg object
1712 * @param file The file path
1713 * @param group Optional key (group in Edje) within the file
1717 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1720 * Set the option used for the background image
1722 * @param obj The bg object
1723 * @param option The desired background option (TILE, SCALE)
1725 * This sets the option used for manipulating the display of the background
1726 * image. The image can be tiled or scaled.
1730 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1733 * Get the option used for the background image
1735 * @param obj The bg object
1736 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1740 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1742 * Set the option used for the background color
1744 * @param obj The bg object
1749 * This sets the color used for the background rectangle. Its range goes
1754 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1756 * Get the option used for the background color
1758 * @param obj The bg object
1765 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1768 * Set the overlay object used for the background object.
1770 * @param obj The bg object
1771 * @param overlay The overlay object
1773 * This provides a way for elm_bg to have an 'overlay' that will be on top
1774 * of the bg. Once the over object is set, a previously set one will be
1775 * deleted, even if you set the new one to NULL. If you want to keep that
1776 * old content object, use the elm_bg_overlay_unset() function.
1781 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1784 * Get the overlay object used for the background object.
1786 * @param obj The bg object
1787 * @return The content that is being used
1789 * Return the content object which is set for this widget
1793 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1796 * Get the overlay object used for the background object.
1798 * @param obj The bg object
1799 * @return The content that was being used
1801 * Unparent and return the overlay object which was set for this widget
1805 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1808 * Set the size of the pixmap representation of the image.
1810 * This option just makes sense if an image is going to be set in the bg.
1812 * @param obj The bg object
1813 * @param w The new width of the image pixmap representation.
1814 * @param h The new height of the image pixmap representation.
1816 * This function sets a new size for pixmap representation of the given bg
1817 * image. It allows the image to be loaded already in the specified size,
1818 * reducing the memory usage and load time when loading a big image with load
1819 * size set to a smaller size.
1821 * NOTE: this is just a hint, the real size of the pixmap may differ
1822 * depending on the type of image being loaded, being bigger than requested.
1826 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1827 /* smart callbacks called:
1831 typedef enum _Elm_Icon_Lookup_Order
1833 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1834 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1835 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1836 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1837 } Elm_Icon_Lookup_Order;
1839 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1840 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1841 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1842 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1843 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1844 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1845 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1846 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1847 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1848 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1849 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1850 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1851 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1852 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1853 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1854 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1855 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
1856 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1857 /* smart callbacks called:
1858 * "clicked" - the user clicked the icon
1862 * @defgroup Image Image
1864 * An object that allows one to load an image file to it. It can be used
1865 * anywhere like any other elementary widget.
1867 * This widget provides most of the functionality provided from @ref Bg or @ref
1868 * Icon, but with a slightly different API (use the one that fits better your
1871 * The features not provided by those two other image widgets are:
1872 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
1873 * @li change the object orientation with elm_image_orient_set();
1874 * @li and turning the image editable with elm_image_editable_set().
1876 * Signals that you can add callbacks for are:
1878 * @li @c "clicked" - This is called when a user has clicked the image
1880 * An example of usage for this API follows:
1881 * @li @ref tutorial_image
1890 * @enum _Elm_Image_Orient
1891 * @typedef Elm_Image_Orient
1893 * Possible orientation options for elm_image_orient_set().
1895 * @image html elm_image_orient_set.png
1896 * @image latex elm_image_orient_set.eps width=\textwidth
1900 typedef enum _Elm_Image_Orient
1902 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
1903 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
1904 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
1905 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
1906 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
1907 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
1908 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
1909 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
1913 * Add a new image to the parent.
1915 * @param parent The parent object
1916 * @return The new object or NULL if it cannot be created
1918 * @see elm_image_file_set()
1922 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1924 * Set the file that will be used as image.
1926 * @param obj The image object
1927 * @param file The path to file that will be used as image
1928 * @param group The group that the image belongs in edje file (if it's an
1931 * @return (#EINA_TRUE = success, #EINA_FALSE = error)
1933 * @see elm_image_file_get()
1937 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1939 * Get the file that will be used as image.
1941 * @param obj The image object
1942 * @param file The path to file
1943 * @param group The group that the image belongs in edje file
1945 * @see elm_image_file_set()
1949 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1951 * Set the smooth effect for a image.
1953 * @param obj The image object
1954 * @param smooth #EINA_TRUE if smooth scaling should be used, #EINA_FALSE
1955 * otherwise. Default is #EINA_TRUE.
1957 * Set the scaling algorithm to be used when scaling the image. Smooth
1958 * scaling provides a better resulting image, but is slower.
1960 * The smooth scaling should be disabled when making animations that change
1961 * the image size, since it will be faster. Animations that don't require
1962 * resizing of the image can keep the smooth scaling enabled (even if the
1963 * image is already scaled, since the scaled image will be cached).
1965 * @see elm_image_smooth_get()
1969 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1971 * Get the smooth effect for a image.
1973 * @param obj The image object
1974 * @return #EINA_TRUE if smooth scaling is enabled, #EINA_FALSE otherwise.
1976 * @see elm_image_smooth_get()
1980 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1982 * Gets the current size of the image.
1984 * @param obj The image object.
1985 * @param w Pointer to store width, or NULL.
1986 * @param h Pointer to store height, or NULL.
1988 * This is the real size of the image, not the size of the object.
1990 * On error, neither w or h will be written.
1994 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1996 * Disable scaling of this object.
1998 * @param obj The image object.
1999 * @param no_scale #EINA_TRUE if the object is not scalable, #EINA_FALSE
2000 * otherwise. Default is #EINA_FALSE.
2002 * This function disables scaling of the elm_image widget through the
2003 * function elm_object_scale_set(). However, this does not affect the widget
2004 * size/resize in any way. For that effect, take a look at
2005 * elm_image_scale_set().
2007 * @see elm_image_no_scale_get()
2008 * @see elm_image_scale_set()
2009 * @see elm_object_scale_set()
2013 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2015 * Get whether scaling is disabled on the object.
2017 * @param obj The image object
2018 * @return #EINA_TRUE if scaling is disabled, #EINA_FALSE otherwise
2020 * @see elm_image_no_scale_set()
2024 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2026 * Set if the object is (up/down) resizeable.
2028 * @param obj The image object
2029 * @param scale_up A bool to set if the object is resizeable up. Default is
2031 * @param scale_down A bool to set if the object is resizeable down. Default
2034 * This function limits the image resize ability. If @p scale_up is set to
2035 * #EINA_FALSE, the object can't have its height or width resized to a value
2036 * higher than the original image size. Same is valid for @p scale_down.
2038 * @see elm_image_scale_get()
2042 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2044 * Get if the object is (up/down) resizeable.
2046 * @param obj The image object
2047 * @param scale_up A bool to set if the object is resizeable up
2048 * @param scale_down A bool to set if the object is resizeable down
2050 * @see elm_image_scale_set()
2054 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2056 * Set if the image fill the entire object area when keeping the aspect ratio.
2058 * @param obj The image object
2059 * @param fill_outside #EINA_TRUE if the object is filled outside,
2060 * #EINA_FALSE otherwise. Default is #EINA_FALSE.
2062 * When the image should keep its aspect ratio even if resized to another
2063 * aspect ratio, there are two possibilities to resize it: keep the entire
2064 * image inside the limits of height and width of the object (@p fill_outside
2065 * is #EINA_FALSE) or let the extra width or height go outside of the object,
2066 * and the image will fill the entire object (@p fill_outside is #EINA_TRUE).
2068 * @note This option will have no effect if
2069 * elm_image_aspect_ratio_retained_set() is set to #EINA_FALSE.
2071 * @see elm_image_fill_outside_get()
2072 * @see elm_image_aspect_ratio_retained_set()
2076 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2078 * Get if the object is filled outside
2080 * @param obj The image object
2081 * @return #EINA_TRUE if the object is filled outside, #EINA_FALSE otherwise.
2083 * @see elm_image_fill_outside_set()
2087 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2089 * Set the prescale size for the image
2091 * @param obj The image object
2092 * @param size The prescale size. This value is used for both width and
2095 * This function sets a new size for pixmap representation of the given
2096 * image. It allows the image to be loaded already in the specified size,
2097 * reducing the memory usage and load time when loading a big image with load
2098 * size set to a smaller size.
2100 * It's equivalent to the elm_bg_load_size_set() function for bg.
2102 * @note this is just a hint, the real size of the pixmap may differ
2103 * depending on the type of image being loaded, being bigger than requested.
2105 * @see elm_image_prescale_get()
2106 * @see elm_bg_load_size_set()
2110 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2112 * Get the prescale size for the image
2114 * @param obj The image object
2115 * @return The prescale size
2117 * @see elm_image_prescale_set()
2121 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2123 * Set the image orientation.
2125 * @param obj The image object
2126 * @param orient The image orientation
2127 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2128 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2129 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2130 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
2131 * Default is #ELM_IMAGE_ORIENT_NONE.
2133 * This function allows to rotate or flip the given image.
2135 * @see elm_image_orient_get()
2136 * @see @ref Elm_Image_Orient
2140 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2142 * Get the image orientation.
2144 * @param obj The image object
2145 * @return The image orientation
2146 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2147 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2148 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2149 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
2151 * @see elm_image_orient_set()
2152 * @see @ref Elm_Image_Orient
2156 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2158 * Make the image 'editable'.
2160 * @param obj Image object.
2161 * @param set Turn on or off editability. Default is #EINA_FALSE.
2163 * This means the image is a valid drag target for drag and drop, and can be
2164 * cut or pasted too.
2168 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2170 * Make the image 'editable'.
2172 * @param obj Image object.
2173 * @return Editability.
2175 * This means the image is a valid drag target for drag and drop, and can be
2176 * cut or pasted too.
2180 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2182 * Get the basic Evas_Image object from this object (widget).
2184 * @param obj The image object to get the inlined image from
2185 * @return The inlined image object, or NULL if none exists
2187 * This function allows one to get the underlying @c Evas_Object of type
2188 * Image from this elementary widget. It can be useful to do things like get
2189 * the pixel data, save the image to a file, etc.
2191 * @note Be careful to not manipulate it, as it is under control of
2196 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2198 * Set whether the original aspect ratio of the image should be kept on resize.
2200 * @param obj The image object.
2201 * @param retained #EINA_TRUE if the image should retain the aspect,
2202 * #EINA_FALSE otherwise.
2204 * The original aspect ratio (width / height) of the image is usually
2205 * distorted to match the object's size. Enabling this option will retain
2206 * this original aspect, and the way that the image is fit into the object's
2207 * area depends on the option set by elm_image_fill_outside_set().
2209 * @see elm_image_aspect_ratio_retained_get()
2210 * @see elm_image_fill_outside_set()
2214 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2216 * Get if the object retains the original aspect ratio.
2218 * @param obj The image object.
2219 * @return #EINA_TRUE if the object keeps the original aspect, #EINA_FALSE
2224 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2226 /* smart callbacks called:
2227 * "clicked" - the user clicked the image
2235 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2237 typedef enum _Elm_GLView_Mode
2239 ELM_GLVIEW_ALPHA = 1,
2240 ELM_GLVIEW_DEPTH = 2,
2241 ELM_GLVIEW_STENCIL = 4
2245 * Defines a policy for the glview resizing.
2247 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2249 typedef enum _Elm_GLView_Resize_Policy
2251 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2252 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2253 } Elm_GLView_Resize_Policy;
2255 typedef enum _Elm_GLView_Render_Policy
2257 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2258 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2259 } Elm_GLView_Render_Policy;
2262 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2263 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2264 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2265 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2266 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2267 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2268 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2269 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2270 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2271 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2272 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2273 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2279 * A box arranges objects in a linear fashion, governed by a layout function
2280 * that defines the details of this arrangement.
2282 * By default, the box will use an internal function to set the layout to
2283 * a single row, either vertical or horizontal. This layout is affected
2284 * by a number of parameters, such as the homogeneous flag set by
2285 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2286 * elm_box_align_set() and the hints set to each object in the box.
2288 * For this default layout, it's possible to change the orientation with
2289 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2290 * placing its elements ordered from top to bottom. When horizontal is set,
2291 * the order will go from left to right. If the box is set to be
2292 * homogeneous, every object in it will be assigned the same space, that
2293 * of the largest object. Padding can be used to set some spacing between
2294 * the cell given to each object. The alignment of the box, set with
2295 * elm_box_align_set(), determines how the bounding box of all the elements
2296 * will be placed within the space given to the box widget itself.
2298 * The size hints of each object also affect how they are placed and sized
2299 * within the box. evas_object_size_hint_min_set() will give the minimum
2300 * size the object can have, and the box will use it as the basis for all
2301 * latter calculations. Elementary widgets set their own minimum size as
2302 * needed, so there's rarely any need to use it manually.
2304 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2305 * used to tell whether the object will be allocated the minimum size it
2306 * needs or if the space given to it should be expanded. It's important
2307 * to realize that expanding the size given to the object is not the same
2308 * thing as resizing the object. It could very well end being a small
2309 * widget floating in a much larger empty space. If not set, the weight
2310 * for objects will normally be 0.0 for both axis, meaning the widget will
2311 * not be expanded. To take as much space possible, set the weight to
2312 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2314 * Besides how much space each object is allocated, it's possible to control
2315 * how the widget will be placed within that space using
2316 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2317 * for both axis, meaning the object will be centered, but any value from
2318 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2319 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2320 * is -1.0, means the object will be resized to fill the entire space it
2323 * In addition, customized functions to define the layout can be set, which
2324 * allow the application developer to organize the objects within the box
2325 * in any number of ways.
2327 * The special elm_box_layout_transition() function can be used
2328 * to switch from one layout to another, animating the motion of the
2329 * children of the box.
2331 * @note Objects should not be added to box objects using _add() calls.
2333 * Some examples on how to use boxes follow:
2334 * @li @ref box_example_01
2335 * @li @ref box_example_02
2340 * @typedef Elm_Box_Transition
2342 * Opaque handler containing the parameters to perform an animated
2343 * transition of the layout the box uses.
2345 * @see elm_box_transition_new()
2346 * @see elm_box_layout_set()
2347 * @see elm_box_layout_transition()
2349 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2352 * Add a new box to the parent
2354 * By default, the box will be in vertical mode and non-homogeneous.
2356 * @param parent The parent object
2357 * @return The new object or NULL if it cannot be created
2359 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2361 * Set the horizontal orientation
2363 * By default, box object arranges their contents vertically from top to
2365 * By calling this function with @p horizontal as EINA_TRUE, the box will
2366 * become horizontal, arranging contents from left to right.
2368 * @note This flag is ignored if a custom layout function is set.
2370 * @param obj The box object
2371 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2372 * EINA_FALSE = vertical)
2374 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2376 * Get the horizontal orientation
2378 * @param obj The box object
2379 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2381 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2383 * Set the box to arrange its children homogeneously
2385 * If enabled, homogeneous layout makes all items the same size, according
2386 * to the size of the largest of its children.
2388 * @note This flag is ignored if a custom layout function is set.
2390 * @param obj The box object
2391 * @param homogeneous The homogeneous flag
2393 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2395 * Get whether the box is using homogeneous mode or not
2397 * @param obj The box object
2398 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2400 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2401 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2402 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2404 * Add an object to the beginning of the pack list
2406 * Pack @p subobj into the box @p obj, placing it first in the list of
2407 * children objects. The actual position the object will get on screen
2408 * depends on the layout used. If no custom layout is set, it will be at
2409 * the top or left, depending if the box is vertical or horizontal,
2412 * @param obj The box object
2413 * @param subobj The object to add to the box
2415 * @see elm_box_pack_end()
2416 * @see elm_box_pack_before()
2417 * @see elm_box_pack_after()
2418 * @see elm_box_unpack()
2419 * @see elm_box_unpack_all()
2420 * @see elm_box_clear()
2422 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2424 * Add an object at the end of the pack list
2426 * Pack @p subobj into the box @p obj, placing it last in the list of
2427 * children objects. The actual position the object will get on screen
2428 * depends on the layout used. If no custom layout is set, it will be at
2429 * the bottom or right, depending if the box is vertical or horizontal,
2432 * @param obj The box object
2433 * @param subobj The object to add to the box
2435 * @see elm_box_pack_start()
2436 * @see elm_box_pack_before()
2437 * @see elm_box_pack_after()
2438 * @see elm_box_unpack()
2439 * @see elm_box_unpack_all()
2440 * @see elm_box_clear()
2442 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2444 * Adds an object to the box before the indicated object
2446 * This will add the @p subobj to the box indicated before the object
2447 * indicated with @p before. If @p before is not already in the box, results
2448 * are undefined. Before means either to the left of the indicated object or
2449 * above it depending on orientation.
2451 * @param obj The box object
2452 * @param subobj The object to add to the box
2453 * @param before The object before which to add it
2455 * @see elm_box_pack_start()
2456 * @see elm_box_pack_end()
2457 * @see elm_box_pack_after()
2458 * @see elm_box_unpack()
2459 * @see elm_box_unpack_all()
2460 * @see elm_box_clear()
2462 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2464 * Adds an object to the box after the indicated object
2466 * This will add the @p subobj to the box indicated after the object
2467 * indicated with @p after. If @p after is not already in the box, results
2468 * are undefined. After means either to the right of the indicated object or
2469 * below it depending on orientation.
2471 * @param obj The box object
2472 * @param subobj The object to add to the box
2473 * @param after The object after which to add it
2475 * @see elm_box_pack_start()
2476 * @see elm_box_pack_end()
2477 * @see elm_box_pack_before()
2478 * @see elm_box_unpack()
2479 * @see elm_box_unpack_all()
2480 * @see elm_box_clear()
2482 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2484 * Clear the box of all children
2486 * Remove all the elements contained by the box, deleting the respective
2489 * @param obj The box object
2491 * @see elm_box_unpack()
2492 * @see elm_box_unpack_all()
2494 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2498 * Remove the object given by @p subobj from the box @p obj without
2501 * @param obj The box object
2503 * @see elm_box_unpack_all()
2504 * @see elm_box_clear()
2506 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2508 * Remove all items from the box, without deleting them
2510 * Clear the box from all children, but don't delete the respective objects.
2511 * If no other references of the box children exist, the objects will never
2512 * be deleted, and thus the application will leak the memory. Make sure
2513 * when using this function that you hold a reference to all the objects
2514 * in the box @p obj.
2516 * @param obj The box object
2518 * @see elm_box_clear()
2519 * @see elm_box_unpack()
2521 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2523 * Retrieve a list of the objects packed into the box
2525 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2526 * The order of the list corresponds to the packing order the box uses.
2528 * You must free this list with eina_list_free() once you are done with it.
2530 * @param obj The box object
2532 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2534 * Set the space (padding) between the box's elements.
2536 * Extra space in pixels that will be added between a box child and its
2537 * neighbors after its containing cell has been calculated. This padding
2538 * is set for all elements in the box, besides any possible padding that
2539 * individual elements may have through their size hints.
2541 * @param obj The box object
2542 * @param horizontal The horizontal space between elements
2543 * @param vertical The vertical space between elements
2545 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2547 * Get the space (padding) between the box's elements.
2549 * @param obj The box object
2550 * @param horizontal The horizontal space between elements
2551 * @param vertical The vertical space between elements
2553 * @see elm_box_padding_set()
2555 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2557 * Set the alignment of the whole bouding box of contents.
2559 * Sets how the bounding box containing all the elements of the box, after
2560 * their sizes and position has been calculated, will be aligned within
2561 * the space given for the whole box widget.
2563 * @param obj The box object
2564 * @param horizontal The horizontal alignment of elements
2565 * @param vertical The vertical alignment of elements
2567 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2569 * Get the alignment of the whole bouding box of contents.
2571 * @param obj The box object
2572 * @param horizontal The horizontal alignment of elements
2573 * @param vertical The vertical alignment of elements
2575 * @see elm_box_align_set()
2577 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2580 * Set the layout defining function to be used by the box
2582 * Whenever anything changes that requires the box in @p obj to recalculate
2583 * the size and position of its elements, the function @p cb will be called
2584 * to determine what the layout of the children will be.
2586 * Once a custom function is set, everything about the children layout
2587 * is defined by it. The flags set by elm_box_horizontal_set() and
2588 * elm_box_homogeneous_set() no longer have any meaning, and the values
2589 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2590 * layout function to decide if they are used and how. These last two
2591 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2592 * passed to @p cb. The @c Evas_Object the function receives is not the
2593 * Elementary widget, but the internal Evas Box it uses, so none of the
2594 * functions described here can be used on it.
2596 * Any of the layout functions in @c Evas can be used here, as well as the
2597 * special elm_box_layout_transition().
2599 * The final @p data argument received by @p cb is the same @p data passed
2600 * here, and the @p free_data function will be called to free it
2601 * whenever the box is destroyed or another layout function is set.
2603 * Setting @p cb to NULL will revert back to the default layout function.
2605 * @param obj The box object
2606 * @param cb The callback function used for layout
2607 * @param data Data that will be passed to layout function
2608 * @param free_data Function called to free @p data
2610 * @see elm_box_layout_transition()
2612 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);
2614 * Special layout function that animates the transition from one layout to another
2616 * Normally, when switching the layout function for a box, this will be
2617 * reflected immediately on screen on the next render, but it's also
2618 * possible to do this through an animated transition.
2620 * This is done by creating an ::Elm_Box_Transition and setting the box
2621 * layout to this function.
2625 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2626 * evas_object_box_layout_vertical, // start
2627 * NULL, // data for initial layout
2628 * NULL, // free function for initial data
2629 * evas_object_box_layout_horizontal, // end
2630 * NULL, // data for final layout
2631 * NULL, // free function for final data
2632 * anim_end, // will be called when animation ends
2633 * NULL); // data for anim_end function\
2634 * elm_box_layout_set(box, elm_box_layout_transition, t,
2635 * elm_box_transition_free);
2638 * @note This function can only be used with elm_box_layout_set(). Calling
2639 * it directly will not have the expected results.
2641 * @see elm_box_transition_new
2642 * @see elm_box_transition_free
2643 * @see elm_box_layout_set
2645 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2647 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2649 * If you want to animate the change from one layout to another, you need
2650 * to set the layout function of the box to elm_box_layout_transition(),
2651 * passing as user data to it an instance of ::Elm_Box_Transition with the
2652 * necessary information to perform this animation. The free function to
2653 * set for the layout is elm_box_transition_free().
2655 * The parameters to create an ::Elm_Box_Transition sum up to how long
2656 * will it be, in seconds, a layout function to describe the initial point,
2657 * another for the final position of the children and one function to be
2658 * called when the whole animation ends. This last function is useful to
2659 * set the definitive layout for the box, usually the same as the end
2660 * layout for the animation, but could be used to start another transition.
2662 * @param start_layout The layout function that will be used to start the animation
2663 * @param start_layout_data The data to be passed the @p start_layout function
2664 * @param start_layout_free_data Function to free @p start_layout_data
2665 * @param end_layout The layout function that will be used to end the animation
2666 * @param end_layout_free_data The data to be passed the @p end_layout function
2667 * @param end_layout_free_data Function to free @p end_layout_data
2668 * @param transition_end_cb Callback function called when animation ends
2669 * @param transition_end_data Data to be passed to @p transition_end_cb
2670 * @return An instance of ::Elm_Box_Transition
2672 * @see elm_box_transition_new
2673 * @see elm_box_layout_transition
2675 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);
2677 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2679 * This function is mostly useful as the @c free_data parameter in
2680 * elm_box_layout_set() when elm_box_layout_transition().
2682 * @param data The Elm_Box_Transition instance to be freed.
2684 * @see elm_box_transition_new
2685 * @see elm_box_layout_transition
2687 EAPI void elm_box_transition_free(void *data);
2694 * @defgroup Button Button
2696 * @image html widget/button/preview-00.png
2697 * @image html widget/button/preview-01.png
2698 * @image html widget/button/preview-02.png
2700 * This is a push-button. Press it and run some function. It can contain
2701 * a simple label and icon object and it also has an autorepeat feature.
2703 * This widgets emits the following signals:
2704 * @li "clicked": the user clicked the button (press/release).
2705 * @li "repeated": the user pressed the button without releasing it.
2706 * @li "pressed": button was pressed.
2707 * @li "unpressed": button was released after being pressed.
2708 * In all three cases, the @c event parameter of the callback will be
2711 * Also, defined in the default theme, the button has the following styles
2713 * @li default: a normal button.
2714 * @li anchor: Like default, but the button fades away when the mouse is not
2715 * over it, leaving only the text or icon.
2716 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2717 * continuous look across its options.
2718 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2720 * Follow through a complete example @ref button_example_01 "here".
2724 * Add a new button to the parent's canvas
2726 * @param parent The parent object
2727 * @return The new object or NULL if it cannot be created
2729 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2731 * Set the label used in the button
2733 * The passed @p label can be NULL to clean any existing text in it and
2734 * leave the button as an icon only object.
2736 * @param obj The button object
2737 * @param label The text will be written on the button
2738 * @deprecated use elm_object_text_set() instead.
2740 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2742 * Get the label set for the button
2744 * The string returned is an internal pointer and should not be freed or
2745 * altered. It will also become invalid when the button is destroyed.
2746 * The string returned, if not NULL, is a stringshare, so if you need to
2747 * keep it around even after the button is destroyed, you can use
2748 * eina_stringshare_ref().
2750 * @param obj The button object
2751 * @return The text set to the label, or NULL if nothing is set
2752 * @deprecated use elm_object_text_set() instead.
2754 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2756 * Set the icon used for the button
2758 * Setting a new icon will delete any other that was previously set, making
2759 * any reference to them invalid. If you need to maintain the previous
2760 * object alive, unset it first with elm_button_icon_unset().
2762 * @param obj The button object
2763 * @param icon The icon object for the button
2765 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2767 * Get the icon used for the button
2769 * Return the icon object which is set for this widget. If the button is
2770 * destroyed or another icon is set, the returned object will be deleted
2771 * and any reference to it will be invalid.
2773 * @param obj The button object
2774 * @return The icon object that is being used
2776 * @see elm_button_icon_unset()
2778 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2780 * Remove the icon set without deleting it and return the object
2782 * This function drops the reference the button holds of the icon object
2783 * and returns this last object. It is used in case you want to remove any
2784 * icon, or set another one, without deleting the actual object. The button
2785 * will be left without an icon set.
2787 * @param obj The button object
2788 * @return The icon object that was being used
2790 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2792 * Turn on/off the autorepeat event generated when the button is kept pressed
2794 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2795 * signal when they are clicked.
2797 * When on, keeping a button pressed will continuously emit a @c repeated
2798 * signal until the button is released. The time it takes until it starts
2799 * emitting the signal is given by
2800 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2801 * new emission by elm_button_autorepeat_gap_timeout_set().
2803 * @param obj The button object
2804 * @param on A bool to turn on/off the event
2806 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2808 * Get whether the autorepeat feature is enabled
2810 * @param obj The button object
2811 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2813 * @see elm_button_autorepeat_set()
2815 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2817 * Set the initial timeout before the autorepeat event is generated
2819 * Sets the timeout, in seconds, since the button is pressed until the
2820 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2821 * won't be any delay and the even will be fired the moment the button is
2824 * @param obj The button object
2825 * @param t Timeout in seconds
2827 * @see elm_button_autorepeat_set()
2828 * @see elm_button_autorepeat_gap_timeout_set()
2830 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2832 * Get the initial timeout before the autorepeat event is generated
2834 * @param obj The button object
2835 * @return Timeout in seconds
2837 * @see elm_button_autorepeat_initial_timeout_set()
2839 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2841 * Set the interval between each generated autorepeat event
2843 * After the first @c repeated event is fired, all subsequent ones will
2844 * follow after a delay of @p t seconds for each.
2846 * @param obj The button object
2847 * @param t Interval in seconds
2849 * @see elm_button_autorepeat_initial_timeout_set()
2851 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2853 * Get the interval between each generated autorepeat event
2855 * @param obj The button object
2856 * @return Interval in seconds
2858 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2864 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2865 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2866 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2867 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2868 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2869 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2870 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2871 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2872 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2873 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2874 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2875 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2876 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2877 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2878 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2879 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2880 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2881 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2882 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2883 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2884 /* available styles:
2888 * hoversel_vertical_entry
2890 /* smart callbacks called:
2891 * "file,chosen" - the user has selected a path, whose string pointer comes
2895 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2896 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2897 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2898 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2899 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2900 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2901 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2902 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2903 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2904 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2905 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2906 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2907 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2908 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2909 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2910 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2911 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2912 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2913 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2914 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2915 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2916 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2918 /* scroller policy */
2919 typedef enum _Elm_Scroller_Policy
2921 ELM_SCROLLER_POLICY_AUTO = 0,
2922 ELM_SCROLLER_POLICY_ON,
2923 ELM_SCROLLER_POLICY_OFF,
2924 ELM_SCROLLER_POLICY_LAST
2925 } Elm_Scroller_Policy;
2927 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2928 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2929 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2930 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2931 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2932 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2933 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);
2934 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2935 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2936 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);
2937 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2938 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2939 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2940 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2941 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2942 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);
2943 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2944 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2945 /* smart callbacks called:
2946 * "edge,left" - the left edge of the content has been reached
2947 * "edge,right" - the right edge of the content has been reached
2948 * "edge,top" - the top edge of the content has been reached
2949 * "edge,bottom" - the bottom edge of the content has been reached
2950 * "scroll" - the content has been scrolled (moved)
2951 * "scroll,anim,start" - scrolling animation has started
2952 * "scroll,anim,stop" - scrolling animation has stopped
2953 * "scroll,drag,start" - dragging the contents around has started
2954 * "scroll,drag,stop" - dragging the contents around has stopped
2958 * @defgroup Label Label
2960 * @brief Widget to display text, with simple html-like markup.
2962 * The Label widget @b doesn't allow text to overflow its boundaries, if the
2963 * text doesn't fit the geometry of the label it will be ellipsized or be
2964 * cut. Elementary provides several themes for this widget:
2965 * @li default - No animation
2966 * @li marker - Centers the text in the label and make it bold by default
2967 * @li slide_long - The entire text appears from the right of the screen and
2968 * slides until it disappears in the left of the screen(reappering on the
2970 * @li slide_short - The text appears in the left of the label and slides to
2971 * the right to show the overflow. When all of the text has been shown the
2972 * position is reset.
2973 * @li slide_bounce - The text appears in the left of the label and slides to
2974 * the right to show the overflow. When all of the text has been shown the
2975 * animation reverses, moving the text to the left.
2977 * Custom themes can of course invent new markup tags and style them any way
2980 * See @ref tutorial_label for a demonstration of how to use a label widget.
2984 * @brief Add a new label to the parent
2986 * @param parent The parent object
2987 * @return The new object or NULL if it cannot be created
2989 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2991 * @brief Set the label on the label object
2993 * @param obj The label object
2994 * @param label The label will be used on the label object
2995 * @deprecated See elm_object_text_set()
2997 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 */
2999 * @brief Get the label used on the label object
3001 * @param obj The label object
3002 * @return The string inside the label
3003 * @deprecated See elm_object_text_get()
3005 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3007 * @brief Set the wrapping behavior of the label
3009 * @param obj The label object
3010 * @param wrap To wrap text or not
3012 * By default no wrapping is done. Possible values for @p wrap are:
3013 * @li ELM_WRAP_NONE - No wrapping
3014 * @li ELM_WRAP_CHAR - wrap between characters
3015 * @li ELM_WRAP_WORD - wrap between words
3016 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
3018 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3020 * @brief Get the wrapping behavior of the label
3022 * @param obj The label object
3025 * @see elm_label_line_wrap_set()
3027 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3029 * @brief Set wrap width of the label
3031 * @param obj The label object
3032 * @param w The wrap width in pixels at a minimum where words need to wrap
3034 * This function sets the maximum width size hint of the label.
3036 * @warning This is only relevant if the label is inside a container.
3038 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3040 * @brief Get wrap width of the label
3042 * @param obj The label object
3043 * @return The wrap width in pixels at a minimum where words need to wrap
3045 * @see elm_label_wrap_width_set()
3047 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3049 * @brief Set wrap height of the label
3051 * @param obj The label object
3052 * @param h The wrap height in pixels at a minimum where words need to wrap
3054 * This function sets the maximum height size hint of the label.
3056 * @warning This is only relevant if the label is inside a container.
3058 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
3060 * @brief get wrap width of the label
3062 * @param obj The label object
3063 * @return The wrap height in pixels at a minimum where words need to wrap
3065 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3067 * @brief Set the font size on the label object.
3069 * @param obj The label object
3070 * @param size font size
3072 * @warning NEVER use this. It is for hyper-special cases only. use styles
3073 * instead. e.g. "big", "medium", "small" - or better name them by use:
3074 * "title", "footnote", "quote" etc.
3076 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
3078 * @brief Set the text color on the label object
3080 * @param obj The label object
3081 * @param r Red property background color of The label object
3082 * @param g Green property background color of The label object
3083 * @param b Blue property background color of The label object
3084 * @param a Alpha property background color of The label object
3086 * @warning NEVER use this. It is for hyper-special cases only. use styles
3087 * instead. e.g. "big", "medium", "small" - or better name them by use:
3088 * "title", "footnote", "quote" etc.
3090 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);
3092 * @brief Set the text align on the label object
3094 * @param obj The label object
3095 * @param align align mode ("left", "center", "right")
3097 * @warning NEVER use this. It is for hyper-special cases only. use styles
3098 * instead. e.g. "big", "medium", "small" - or better name them by use:
3099 * "title", "footnote", "quote" etc.
3101 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
3103 * @brief Set background color of the label
3105 * @param obj The label object
3106 * @param r Red property background color of The label object
3107 * @param g Green property background color of The label object
3108 * @param b Blue property background color of The label object
3109 * @param a Alpha property background alpha of The label object
3111 * @warning NEVER use this. It is for hyper-special cases only. use styles
3112 * instead. e.g. "big", "medium", "small" - or better name them by use:
3113 * "title", "footnote", "quote" etc.
3115 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);
3117 * @brief Set the ellipsis behavior of the label
3119 * @param obj The label object
3120 * @param ellipsis To ellipsis text or not
3122 * If set to true and the text doesn't fit in the label an ellipsis("...")
3123 * will be shown at the end of the widget.
3125 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
3126 * choosen wrap method was ELM_WRAP_WORD.
3128 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
3130 * @brief Set the text slide of the label
3132 * @param obj The label object
3133 * @param slide To start slide or stop
3135 * If set to true the text of the label will slide throught the length of
3138 * @warning This must be called before elm_label_slide_set().
3139 * @warning This only work with the themes "slide_short", "slide_long" and
3142 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
3144 * @brief Get the text slide mode of the label
3146 * @param obj The label object
3147 * @return slide slide mode value
3149 * @see elm_label_slide_set()
3151 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3153 * @brief Set the slide duration(speed) of the label
3155 * @param obj The label object
3156 * @return The duration in seconds in moving text from slide begin position
3157 * to slide end position
3159 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
3161 * @brief Get the slide duration(speed) of the label
3163 * @param obj The label object
3164 * @return The duration time in moving text from slide begin position to slide end position
3166 * @see elm_label_slide_duration_set()
3168 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3174 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3175 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3176 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3177 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3178 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3179 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3180 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
3181 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
3182 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3183 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3184 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
3185 /* smart callbacks called:
3186 * "changed" - Whenever the toggle value has been changed. Is not called
3187 * until the toggle is released by the cursor (assuming it has been triggered
3188 * by the cursor in the first place).
3192 * @page tutorial_frame Frame example
3193 * @dontinclude frame_example_01.c
3195 * In this example we are going to create 4 Frames with different styles and
3196 * add a rectangle of different color in each.
3198 * We start we the usual setup code:
3201 * And then create one rectangle:
3204 * To add it in our first frame, which since it doesn't have it's style
3205 * specifically set uses the default style:
3208 * And then create another rectangle:
3211 * To add it in our second frame, which uses the "pad_small" style, note that
3212 * even tough we are setting a text for this frame it won't be show, only the
3213 * default style shows the Frame's title:
3215 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3216 * very similar, their only difference is the size of the empty area around
3217 * the content of the frame.
3219 * And then create yet another rectangle:
3222 * To add it in our third frame, which uses the "outdent_top" style, note
3223 * that even tough we are setting a text for this frame it won't be show,
3224 * only the default style shows the Frame's title:
3227 * And then create one last rectangle:
3230 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3231 * style, note that even tough we are setting a text for this frame it won't
3232 * be show, only the default style shows the Frame's title:
3235 * And now we are left with just some more setup code:
3238 * Our example will look like this:
3239 * @image html screenshots/frame_example_01.png
3240 * @image latex screenshots/frame_example_01.eps
3242 * @example frame_example_01.c
3245 * @defgroup Frame Frame
3247 * @brief Frame is a widget that holds some content and has a title.
3249 * The default look is a frame with a title, but Frame supports multple
3257 * @li outdent_bottom
3259 * Of all this styles only default shows the title. Frame emits no signals.
3261 * For a detailed example see the @ref tutorial_frame.
3266 * @brief Add a new frame to the parent
3268 * @param parent The parent object
3269 * @return The new object or NULL if it cannot be created
3271 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3273 * @brief Set the frame label
3275 * @param obj The frame object
3276 * @param label The label of this frame object
3278 * @deprecated use elm_object_text_set() instead.
3280 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3282 * @brief Get the frame label
3284 * @param obj The frame object
3286 * @return The label of this frame objet or NULL if unable to get frame
3288 * @deprecated use elm_object_text_get() instead.
3290 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3292 * @brief Set the content of the frame widget
3294 * Once the content object is set, a previously set one will be deleted.
3295 * If you want to keep that old content object, use the
3296 * elm_frame_content_unset() function.
3298 * @param obj The frame object
3299 * @param content The content will be filled in this frame object
3301 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3303 * @brief Get the content of the frame widget
3305 * Return the content object which is set for this widget
3307 * @param obj The frame object
3308 * @return The content that is being used
3310 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3312 * @brief Unset the content of the frame widget
3314 * Unparent and return the content object which was set for this widget
3316 * @param obj The frame object
3317 * @return The content that was being used
3319 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3325 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3326 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3327 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3328 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3329 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3330 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3331 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3332 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3333 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3334 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3335 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3336 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3339 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3340 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3341 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3342 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3343 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3344 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3345 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3347 struct _Elm_Gengrid_Item_Class
3349 const char *item_style;
3350 struct _Elm_Gengrid_Item_Class_Func
3352 GridItemLabelGetFunc label_get;
3353 GridItemIconGetFunc icon_get;
3354 GridItemStateGetFunc state_get;
3355 GridItemDelFunc del;
3359 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3360 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3361 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3362 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3363 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3365 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3366 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3367 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3368 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3369 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3370 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3371 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3372 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3373 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3374 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3375 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3376 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3377 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3378 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3379 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3381 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3382 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3384 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3385 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3386 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3387 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3388 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3389 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3390 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3391 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3392 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3393 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3394 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3395 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3396 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3397 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3398 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3399 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3400 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3402 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3403 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);
3404 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3405 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3406 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3407 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3408 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3409 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3410 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3411 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3412 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3413 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3415 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3416 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3417 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3419 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);
3420 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);
3421 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);
3422 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);
3423 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);
3424 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);
3425 /* smart callbacks called:
3427 * selected - User has selected an item.
3428 * unselected - User has unselected an item.
3429 * clicked,double - User has double-clicked or pressed enter on an item.
3430 * realized - An evas object for an item was built.
3431 * unrealized - An evas object for an item was deleted.
3432 * changed - An item has been added, removed, resized or moved,
3433 * or gengrid has been resized or horizontal property has been changed.
3434 * scroll - the content has been scrolled (moved).
3435 * "scroll,drag,start" - dragging the contents around has started.
3436 * "scroll,drag,stop" - dragging the contents around has stopped.
3437 * drag - Gengrid is being dragged.
3438 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3439 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3440 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3441 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3442 * "drag,stop" - Gengrid is not being dragged.
3446 * @defgroup Clock Clock
3448 * This is a @b digital clock widget. In its default theme, it has a
3449 * vintage "flipping numbers clock" appearance, which will animate
3450 * sheets of individual algarisms individually as time goes by.
3452 * A newly created clock will fetch system's time (already
3453 * considering local time adjustments) to start with, and will tick
3454 * accondingly. It may or may not show seconds.
3456 * Clocks have an @b edition mode. When in it, the sheets will
3457 * display extra arrow indications on the top and bottom and the
3458 * user may click on them to raise or lower the time values. After
3459 * it's told to exit edition mode, it will keep ticking with that
3460 * new time set (it keeps the difference from local time).
3462 * Also, when under edition mode, user clicks on the cited arrows
3463 * which are @b held for some time will make the clock to flip the
3464 * sheet, thus editing the time, continuosly and automatically for
3465 * the user. The interval between sheet flips will keep growing in
3466 * time, so that it helps the user to reach a time which is distant
3469 * The time display is, by default, in military mode (24h), but an
3470 * am/pm indicator may be optionally shown, too, when it will
3473 * Smart callbacks one can register to:
3474 * - "changed" - the clock's user changed the time
3476 * Here is an example on its usage:
3477 * @li @ref clock_example
3486 * Identifiers for which clock digits should be editable, when a
3487 * clock widget is in edition mode. Values may be ORed together to
3488 * make a mask, naturally.
3490 * @see elm_clock_edit_set()
3491 * @see elm_clock_digit_edit_set()
3493 typedef enum _Elm_Clock_Digedit
3495 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3496 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3497 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3498 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3499 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3500 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3501 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3502 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3503 } Elm_Clock_Digedit;
3506 * Add a new clock widget to the given parent Elementary
3507 * (container) object
3509 * @param parent The parent object
3510 * @return a new clock widget handle or @c NULL, on errors
3512 * This function inserts a new clock widget on the canvas.
3516 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3519 * Set a clock widget's time, programmatically
3521 * @param obj The clock widget object
3522 * @param hrs The hours to set
3523 * @param min The minutes to set
3524 * @param sec The secondes to set
3526 * This function updates the time that is showed by the clock
3529 * Values @b must be set within the following ranges:
3530 * - 0 - 23, for hours
3531 * - 0 - 59, for minutes
3532 * - 0 - 59, for seconds,
3534 * even if the clock is not in "military" mode.
3536 * @warning The behavior for values set out of those ranges is @b
3541 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3544 * Get a clock widget's time values
3546 * @param obj The clock object
3547 * @param[out] hrs Pointer to the variable to get the hours value
3548 * @param[out] min Pointer to the variable to get the minutes value
3549 * @param[out] sec Pointer to the variable to get the seconds value
3551 * This function gets the time set for @p obj, returning
3552 * it on the variables passed as the arguments to function
3554 * @note Use @c NULL pointers on the time values you're not
3555 * interested in: they'll be ignored by the function.
3559 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3562 * Set whether a given clock widget is under <b>edition mode</b> or
3563 * under (default) displaying-only mode.
3565 * @param obj The clock object
3566 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3567 * put it back to "displaying only" mode
3569 * This function makes a clock's time to be editable or not <b>by
3570 * user interaction</b>. When in edition mode, clocks @b stop
3571 * ticking, until one brings them back to canonical mode. The
3572 * elm_clock_digit_edit_set() function will influence which digits
3573 * of the clock will be editable. By default, all of them will be
3574 * (#ELM_CLOCK_NONE).
3576 * @note am/pm sheets, if being shown, will @b always be editable
3577 * under edition mode.
3579 * @see elm_clock_edit_get()
3583 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3586 * Retrieve whether a given clock widget is under <b>edition
3587 * mode</b> or under (default) displaying-only mode.
3589 * @param obj The clock object
3590 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3593 * This function retrieves whether the clock's time can be edited
3594 * or not by user interaction.
3596 * @see elm_clock_edit_set() for more details
3600 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3603 * Set what digits of the given clock widget should be editable
3604 * when in edition mode.
3606 * @param obj The clock object
3607 * @param digedit Bit mask indicating the digits to be editable
3608 * (values in #Elm_Clock_Digedit).
3610 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3611 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3614 * @see elm_clock_digit_edit_get()
3618 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3621 * Retrieve what digits of the given clock widget should be
3622 * editable when in edition mode.
3624 * @param obj The clock object
3625 * @return Bit mask indicating the digits to be editable
3626 * (values in #Elm_Clock_Digedit).
3628 * @see elm_clock_digit_edit_set() for more details
3632 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3635 * Set if the given clock widget must show hours in military or
3638 * @param obj The clock object
3639 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3642 * This function sets if the clock must show hours in military or
3643 * am/pm mode. In some countries like Brazil the military mode
3644 * (00-24h-format) is used, in opposition to the USA, where the
3645 * am/pm mode is more commonly used.
3647 * @see elm_clock_show_am_pm_get()
3651 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3654 * Get if the given clock widget shows hours in military or am/pm
3657 * @param obj The clock object
3658 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3661 * This function gets if the clock shows hours in military or am/pm
3664 * @see elm_clock_show_am_pm_set() for more details
3668 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3671 * Set if the given clock widget must show time with seconds or not
3673 * @param obj The clock object
3674 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3676 * This function sets if the given clock must show or not elapsed
3677 * seconds. By default, they are @b not shown.
3679 * @see elm_clock_show_seconds_get()
3683 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3686 * Get whether the given clock widget is showing time with seconds
3689 * @param obj The clock object
3690 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3692 * This function gets whether @p obj is showing or not the elapsed
3695 * @see elm_clock_show_seconds_set()
3699 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3702 * Set the interval on time updates for an user mouse button hold
3703 * on clock widgets' time edition.
3705 * @param obj The clock object
3706 * @param interval The (first) interval value in seconds
3708 * This interval value is @b decreased while the user holds the
3709 * mouse pointer either incrementing or decrementing a given the
3710 * clock digit's value.
3712 * This helps the user to get to a given time distant from the
3713 * current one easier/faster, as it will start to flip quicker and
3714 * quicker on mouse button holds.
3716 * The calculation for the next flip interval value, starting from
3717 * the one set with this call, is the previous interval divided by
3718 * 1.05, so it decreases a little bit.
3720 * The default starting interval value for automatic flips is
3723 * @see elm_clock_interval_get()
3727 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3730 * Get the interval on time updates for an user mouse button hold
3731 * on clock widgets' time edition.
3733 * @param obj The clock object
3734 * @return The (first) interval value, in seconds, set on it
3736 * @see elm_clock_interval_set() for more details
3740 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3747 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3748 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3749 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3750 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3751 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3752 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3753 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3754 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3755 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3756 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3757 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3758 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3759 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3760 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3761 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);
3762 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3763 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3764 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3765 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3766 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3767 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3768 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3769 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3770 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3771 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3772 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);
3773 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3775 * @def elm_layout_icon_set
3776 * Convienience macro to set the icon object in a layout that follows the
3777 * Elementary naming convention for its parts.
3781 #define elm_layout_icon_set(_ly, _obj) \
3784 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3785 if ((_obj)) sig = "elm,state,icon,visible"; \
3786 else sig = "elm,state,icon,hidden"; \
3787 elm_object_signal_emit((_ly), sig, "elm"); \
3791 * @def elm_layout_icon_get
3792 * Convienience macro to get the icon object from a layout that follows the
3793 * Elementary naming convention for its parts.
3797 #define elm_layout_icon_get(_ly) \
3798 elm_layout_content_get((_ly), "elm.swallow.icon")
3801 * @def elm_layout_end_set
3802 * Convienience macro to set the end object in a layout that follows the
3803 * Elementary naming convention for its parts.
3807 #define elm_layout_end_set(_ly, _obj) \
3810 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3811 if ((_obj)) sig = "elm,state,end,visible"; \
3812 else sig = "elm,state,end,hidden"; \
3813 elm_object_signal_emit((_ly), sig, "elm"); \
3817 * @def elm_layout_end_get
3818 * Convienience macro to get the end object in a layout that follows the
3819 * Elementary naming convention for its parts.
3823 #define elm_layout_end_get(_ly) \
3824 elm_layout_content_get((_ly), "elm.swallow.end")
3827 * @def elm_layout_label_set
3828 * Convienience macro to set the label in a layout that follows the
3829 * Elementary naming convention for its parts.
3832 * @deprecate use elm_object_text_* instead.
3834 #define elm_layout_label_set(_ly, _txt) \
3835 elm_layout_text_set((_ly), "elm.text", (_txt))
3838 * @def elm_layout_label_get
3839 * Convienience macro to get the label in a layout that follows the
3840 * Elementary naming convention for its parts.
3843 * @deprecate use elm_object_text_* instead.
3845 #define elm_layout_label_get(_ly) \
3846 elm_layout_text_get((_ly), "elm.text")
3848 /* smart callbacks called:
3852 typedef enum _Elm_Notify_Orient
3854 ELM_NOTIFY_ORIENT_TOP,
3855 ELM_NOTIFY_ORIENT_CENTER,
3856 ELM_NOTIFY_ORIENT_BOTTOM,
3857 ELM_NOTIFY_ORIENT_LEFT,
3858 ELM_NOTIFY_ORIENT_RIGHT,
3859 ELM_NOTIFY_ORIENT_TOP_LEFT,
3860 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3861 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3862 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3863 ELM_NOTIFY_ORIENT_LAST
3864 } Elm_Notify_Orient;
3865 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3866 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3867 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3868 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3870 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3871 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3872 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3873 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3874 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3875 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3876 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3877 /* smart callbacks called:
3878 * "timeout" - when timeout happens on notify and it's hidden
3879 * "block,clicked" - when it's hidden by a click outside of the notify's view
3883 * @defgroup Hover Hover
3885 * A Hover object will hover over its @p parent object at the @p target
3886 * location. Anything in the background will be given a darker coloring to
3887 * indicate that the hover object is on top (at the default theme). When the
3888 * hover is clicked it is dismissed(hidden), if the contents of the hover are
3889 * clicked that @b doesn't cause the hover to be dismissed.
3891 * @note The hover object will take up the entire space of @p target
3894 * Elementary has the following styles for the hover widget:
3898 * @li hoversel_vertical
3900 * The following are the available position for content:
3912 * Signals that you can add callbacks for are:
3913 * @li "clicked" - the user clicked the empty space in the hover to dismiss
3914 * @li "smart,changed" - a content object placed under the "smart"
3915 * policy was replaced to a new slot direction.
3917 * See @ref tutorial_hover for more information.
3921 typedef enum _Elm_Hover_Axis
3923 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
3924 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
3925 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
3926 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
3929 * @brief Adds a hover object to @p parent
3931 * @param parent The parent object
3932 * @return The hover object or NULL if one could not be created
3934 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3936 * @brief Sets the target object for the hover.
3938 * @param obj The hover object
3939 * @param target The object to center the hover onto. The hover
3941 * This function will cause the hover to be centered on the target object.
3943 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3945 * @brief Gets the target object for the hover.
3947 * @param obj The hover object
3948 * @param parent The object to locate the hover over.
3950 * @see elm_hover_target_set()
3952 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3954 * @brief Sets the parent object for the hover.
3956 * @param obj The hover object
3957 * @param parent The object to locate the hover over.
3959 * This function will cause the hover to take up the entire space that the
3960 * parent object fills.
3962 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3964 * @brief Gets the parent object for the hover.
3966 * @param obj The hover object
3967 * @return The parent object to locate the hover over.
3969 * @see elm_hover_parent_set()
3971 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3973 * @brief Sets the content of the hover object and the direction in which it
3976 * @param obj The hover object
3977 * @param swallow The direction that the object will be displayed
3978 * at. Accepted values are "left", "top-left", "top", "top-right",
3979 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
3981 * @param content The content to place at @p swallow
3983 * Once the content object is set for a given direction, a previously
3984 * set one (on the same direction) will be deleted. If you want to
3985 * keep that old content object, use the elm_hover_content_unset()
3988 * All directions may have contents at the same time, except for
3989 * "smart". This is a special placement hint and its use case
3990 * independs of the calculations coming from
3991 * elm_hover_best_content_location_get(). Its use is for cases when
3992 * one desires only one hover content, but with a dinamic special
3993 * placement within the hover area. The content's geometry, whenever
3994 * it changes, will be used to decide on a best location not
3995 * extrapolating the hover's parent object view to show it in (still
3996 * being the hover's target determinant of its medium part -- move and
3997 * resize it to simulate finger sizes, for example). If one of the
3998 * directions other than "smart" are used, a previously content set
3999 * using it will be deleted, and vice-versa.
4001 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4003 * @brief Get the content of the hover object, in a given direction.
4005 * Return the content object which was set for this widget in the
4006 * @p swallow direction.
4008 * @param obj The hover object
4009 * @param swallow The direction that the object was display at.
4010 * @return The content that was being used
4012 * @see elm_hover_content_set()
4014 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4016 * @brief Unset the content of the hover object, in a given direction.
4018 * Unparent and return the content object set at @p swallow direction.
4020 * @param obj The hover object
4021 * @param swallow The direction that the object was display at.
4022 * @return The content that was being used.
4024 * @see elm_hover_content_set()
4026 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4028 * @brief Returns the best swallow location for content in the hover.
4030 * @param obj The hover object
4031 * @param pref_axis The preferred orientation axis for the hover object to use
4032 * @return The edje location to place content into the hover or @c
4035 * Best is defined here as the location at which there is the most available
4038 * @p pref_axis may be one of
4039 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
4040 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
4041 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
4042 * - @c ELM_HOVER_AXIS_BOTH -- both
4044 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
4045 * nescessarily be along the horizontal axis("left" or "right"). If
4046 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
4047 * be along the vertical axis("top" or "bottom"). Chossing
4048 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
4049 * returned position may be in either axis.
4051 * @see elm_hover_content_set()
4053 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
4059 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
4060 struct _Elm_Entry_Anchor_Info
4064 Evas_Coord x, y, w, h;
4066 typedef enum _Elm_Icon_Type
4072 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
4074 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4075 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
4076 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4077 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
4078 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4080 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4081 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4082 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4084 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4085 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4086 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4087 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4088 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
4090 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4091 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4092 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4093 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
4094 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
4095 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4096 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4097 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4098 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4099 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4100 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4101 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4102 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4103 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4104 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);
4105 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4106 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4107 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
4108 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
4109 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4111 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);
4112 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4113 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4114 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);
4115 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);
4116 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);
4117 EAPI void elm_entry_text_filter_append(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
4118 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
4119 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
4120 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4121 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4122 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
4123 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
4124 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
4125 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
4126 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4127 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
4128 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4129 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
4130 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
4131 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
4132 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
4133 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
4134 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
4135 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
4136 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
4137 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
4138 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
4139 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
4140 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
4141 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
4143 /* pre-made filters for entries */
4144 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
4145 struct _Elm_Entry_Filter_Limit_Size
4150 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
4151 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
4152 struct _Elm_Entry_Filter_Accept_Set
4154 const char *accepted;
4155 const char *rejected;
4157 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
4158 /* smart callbacks called:
4159 * "changed" - the text content changed
4160 * "selection,start" - the user started selecting text
4161 * "selection,changed" - the user modified the selection size/location
4162 * "selection,cleared" - the user cleared the selection
4163 * "selection,paste" - the user requested a paste of text
4164 * "selection,copy" - the user copied the text
4165 * "selection,cut" - the user cut the text
4166 * "cursor,changed" - the cursor changed position
4167 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
4168 * "activated" - when the enter key is pressed (useful for single line)
4169 * "press" - when finger/mouse is pressed down
4170 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
4171 * "clicked,double" - when finger/mouse is double-pressed
4172 * "longpressed" - the entry has been longpressed
4173 * "focused" - the entry has received keyboard focus
4174 * "unfocused" - keyboard focus is gone
4177 /* composite widgets - these basically put together basic widgets above
4178 * in convenient packages that do more than basic stuff */
4182 * @defgroup Anchorview Anchorview
4184 * Anchorview is for displaying text that contains markup with anchors
4185 * like <c>\<a href=1234\>something\</\></c> in it.
4187 * Besides being styled differently, the anchorview widget provides the
4188 * necessary functionality so that clicking on these anchors brings up a
4189 * popup with user defined content such as "call", "add to contacts" or
4190 * "open web page". This popup is provided using the @ref Hover widget.
4192 * This widget is very similar to @ref Anchorblock, so refer to that
4193 * widget for an example. The only difference Anchorview has is that the
4194 * widget is already provided with scrolling functionality, so if the
4195 * text set to it is too large to fit in the given space, it will scroll,
4196 * whereas the @ref Anchorblock widget will keep growing to ensure all the
4197 * text can be displayed.
4199 * This widget emits the following signals:
4200 * @li "anchor,clicked": will be called when an anchor is clicked. The
4201 * @p event_info parameter on the callback will be a pointer of type
4202 * ::Elm_Entry_Anchorview_Info.
4204 * See @ref Anchorblock for an example on how to use both of them.
4213 * @typedef Elm_Entry_Anchorview_Info
4215 * The info sent in the callback for "anchor,clicked" signals emitted by
4216 * the Anchorview widget.
4218 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
4220 * @struct _Elm_Entry_Anchorview_Info
4222 * The info sent in the callback for "anchor,clicked" signals emitted by
4223 * the Anchorview widget.
4225 struct _Elm_Entry_Anchorview_Info
4227 const char *name; /**< Name of the anchor, as indicated in its href
4229 int button; /**< The mouse button used to click on it */
4230 Evas_Object *hover; /**< The hover object to use for the popup */
4232 Evas_Coord x, y, w, h;
4233 } anchor, /**< Geometry selection of text used as anchor */
4234 hover_parent; /**< Geometry of the object used as parent by the
4236 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4237 for content on the left side of
4238 the hover. Before calling the
4239 callback, the widget will make the
4240 necessary calculations to check
4241 which sides are fit to be set with
4242 content, based on the position the
4243 hover is activated and its distance
4244 to the edges of its parent object
4246 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4247 the right side of the hover.
4248 See @ref hover_left */
4249 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4250 of the hover. See @ref hover_left */
4251 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4252 below the hover. See @ref
4256 * Add a new Anchorview object
4258 * @param parent The parent object
4259 * @return The new object or NULL if it cannot be created
4261 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4263 * Set the text to show in the anchorview
4265 * Sets the text of the anchorview to @p text. This text can include markup
4266 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
4267 * text that will be specially styled and react to click events, ended with
4268 * either of \</a\> or \</\>. When clicked, the anchor will emit an
4269 * "anchor,clicked" signal that you can attach a callback to with
4270 * evas_object_smart_callback_add(). The name of the anchor given in the
4271 * event info struct will be the one set in the href attribute, in this
4274 * Other markup can be used to style the text in different ways, but it's
4275 * up to the style defined in the theme which tags do what.
4276 * @deprecated use elm_object_text_set() instead.
4278 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4280 * Get the markup text set for the anchorview
4282 * Retrieves the text set on the anchorview, with markup tags included.
4284 * @param obj The anchorview object
4285 * @return The markup text set or @c NULL if nothing was set or an error
4287 * @deprecated use elm_object_text_set() instead.
4289 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4291 * Set the parent of the hover popup
4293 * Sets the parent object to use by the hover created by the anchorview
4294 * when an anchor is clicked. See @ref Hover for more details on this.
4295 * If no parent is set, the same anchorview object will be used.
4297 * @param obj The anchorview object
4298 * @param parent The object to use as parent for the hover
4300 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4302 * Get the parent of the hover popup
4304 * Get the object used as parent for the hover created by the anchorview
4305 * widget. See @ref Hover for more details on this.
4307 * @param obj The anchorview object
4308 * @return The object used as parent for the hover, NULL if none is set.
4310 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4312 * Set the style that the hover should use
4314 * When creating the popup hover, anchorview will request that it's
4315 * themed according to @p style.
4317 * @param obj The anchorview object
4318 * @param style The style to use for the underlying hover
4320 * @see elm_object_style_set()
4322 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4324 * Get the style that the hover should use
4326 * Get the style the hover created by anchorview will use.
4328 * @param obj The anchorview object
4329 * @return The style to use by the hover. NULL means the default is used.
4331 * @see elm_object_style_set()
4333 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4335 * Ends the hover popup in the anchorview
4337 * When an anchor is clicked, the anchorview widget will create a hover
4338 * object to use as a popup with user provided content. This function
4339 * terminates this popup, returning the anchorview to its normal state.
4341 * @param obj The anchorview object
4343 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4345 * Set bouncing behaviour when the scrolled content reaches an edge
4347 * Tell the internal scroller object whether it should bounce or not
4348 * when it reaches the respective edges for each axis.
4350 * @param obj The anchorview object
4351 * @param h_bounce Whether to bounce or not in the horizontal axis
4352 * @param v_bounce Whether to bounce or not in the vertical axis
4354 * @see elm_scroller_bounce_set()
4356 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4358 * Get the set bouncing behaviour of the internal scroller
4360 * Get whether the internal scroller should bounce when the edge of each
4361 * axis is reached scrolling.
4363 * @param obj The anchorview object
4364 * @param h_bounce Pointer where to store the bounce state of the horizontal
4366 * @param v_bounce Pointer where to store the bounce state of the vertical
4369 * @see elm_scroller_bounce_get()
4371 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4373 * Appends a custom item provider to the given anchorview
4375 * Appends the given function to the list of items providers. This list is
4376 * called, one function at a time, with the given @p data pointer, the
4377 * anchorview object and, in the @p item parameter, the item name as
4378 * referenced in its href string. Following functions in the list will be
4379 * called in order until one of them returns something different to NULL,
4380 * which should be an Evas_Object which will be used in place of the item
4383 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4384 * href=item/name\>\</item\>
4386 * @param obj The anchorview object
4387 * @param func The function to add to the list of providers
4388 * @param data User data that will be passed to the callback function
4390 * @see elm_entry_item_provider_append()
4392 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);
4394 * Prepend a custom item provider to the given anchorview
4396 * Like elm_anchorview_item_provider_append(), but it adds the function
4397 * @p func to the beginning of the list, instead of the end.
4399 * @param obj The anchorview object
4400 * @param func The function to add to the list of providers
4401 * @param data User data that will be passed to the callback function
4403 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);
4405 * Remove a custom item provider from the list of the given anchorview
4407 * Removes the function and data pairing that matches @p func and @p data.
4408 * That is, unless the same function and same user data are given, the
4409 * function will not be removed from the list. This allows us to add the
4410 * same callback several times, with different @p data pointers and be
4411 * able to remove them later without conflicts.
4413 * @param obj The anchorview object
4414 * @param func The function to remove from the list
4415 * @param data The data matching the function to remove from the list
4417 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);
4424 * @defgroup Anchorblock Anchorblock
4426 * Anchorblock is for displaying text that contains markup with anchors
4427 * like <c>\<a href=1234\>something\</\></c> in it.
4429 * Besides being styled differently, the anchorblock widget provides the
4430 * necessary functionality so that clicking on these anchors brings up a
4431 * popup with user defined content such as "call", "add to contacts" or
4432 * "open web page". This popup is provided using the @ref Hover widget.
4434 * This widget emits the following signals:
4435 * @li "anchor,clicked": will be called when an anchor is clicked. The
4436 * @p event_info parameter on the callback will be a pointer of type
4437 * ::Elm_Entry_Anchorblock_Info.
4443 * Since examples are usually better than plain words, we might as well
4444 * try @ref tutorial_anchorblock_example "one".
4447 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4448 * This exampel will show both Anchorblock and @ref Anchorview,
4449 * since both are very similar and it's easier to show them once and side
4450 * by side, so the difference is more clear.
4452 * We'll show the relevant snippets of the code here, but the full example
4453 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4455 * As for the actual example, it's just a simple window with an anchorblock
4456 * and an anchorview, both containing the same text. After including
4457 * Elementary.h and declaring some functions we'll need, we jump to our
4458 * elm_main (see ELM_MAIN) and create our window.
4459 * @dontinclude anchorblock_example_01.c
4464 * With the needed variables declared, we'll create the window and a box to
4465 * hold our widgets, but we don't need to go through that here.
4467 * In order to make clear where the anchorblock ends and the anchorview
4468 * begins, they'll be each inside a @ref Frame. After creating the frame,
4469 * the anchorblock follows.
4470 * @skip elm_frame_add
4471 * @until elm_frame_content_set
4473 * Nothing out of the ordinary there. What's worth mentioning is the call
4474 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4475 * when an anchor is clicked, the hover for the popup will cover the entire
4476 * window. This affects the area that will be obscured by the hover and
4477 * where clicking will dismiss it, as well as the calculations it does to
4478 * inform the best locations where to insert the popups content.
4479 * Other than that, the code is pretty standard. We also need to set our
4480 * callback for when an anchor is clicked, since it's our task to populate
4481 * the popup. There's no default for it.
4483 * The anchorview is no different, we only change a few things so it looks
4485 * @until elm_frame_content_set
4487 * Then we run, so stuff works and close our main function in the usual way.
4490 * Now, a little note. Normally you would use either one of anchorblock or
4491 * anchorview, set your one callback to clicks and do your stuff in there.
4492 * In this example, however, there are a few tricks to make it easier to
4493 * show both widgets in one go (and to save me some typing). So we have
4494 * two callbacks, one per widget, that will call a common function to do
4495 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4496 * anchorview too, since both are equal, and passing a callback to use
4497 * for our buttons to end the hover, because each widget has a different
4499 * @until _anchorview_clicked_cb
4502 * The meat of our popup is in the following function. We check what kind
4503 * of menu we need to show, based on the name set to the anchor in the
4504 * markup text. If there's no type (something went wrong, no valid contact
4505 * in the address list) we are just putting a button that does nothing, but
4506 * it's perfectly reasonable to just end the hover and call it quits.
4508 * Our popup will consist of one main button in the middle of our hover,
4509 * and possibly a secondary button and a list of other options. We'll create
4510 * first our main button and check what kind of popup we need afterwards.
4513 * @until eina_stringshare_add
4516 * Each button has two callbacks, one is our hack to close the hover
4517 * properly based on which widget it belongs to, the other a simple
4518 * printf that will show the action with the anchors own data. This is
4519 * not how you would usually do it. Instead, the common case is to have
4520 * one callback for the button that will know which function to call to end
4521 * things, but since we are doing it this way it's worth noting that
4522 * smart callbacks will be called in reverse in respect to the order they
4523 * were added, and since our @c btn_end_cb will close the hover, and thus
4524 * delete our buttons, the other callback wouldn't be called if we had
4527 * After our telephone popup, there are a few others that are practically
4528 * the same, so they won't be shown here.
4530 * Once we are done with that, it's time to place our actions into our
4531 * hover. Main button goes in the middle without much questioning, and then
4532 * we see if we have a secondary button and a box of extra options.
4533 * Because I said so, secondary button goes on either side and box of
4534 * options either on top or below the main one, but to choose which
4535 * exactly, we use the hints our callback info has, which saves us from
4536 * having to do the math and see which side has more space available, with
4537 * a little special case where we delete our extra stuff if there's nowhere
4541 * @skip evas_object_smart
4542 * @until evas_object_del(box)
4546 * The example will look like this:
4547 * @image html screenshots/anchorblock_01.png
4548 * @image latex screenshots/anchorblock_01.eps
4550 * @example anchorblock_example_01.c
4553 * @addtogroup Anchorblock
4557 * @typedef Elm_Entry_Anchorblock_Info
4559 * The info sent in the callback for "anchor,clicked" signals emitted by
4560 * the Anchorblock widget.
4562 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4564 * @struct _Elm_Entry_Anchorblock_Info
4566 * The info sent in the callback for "anchor,clicked" signals emitted by
4567 * the Anchorblock widget.
4569 struct _Elm_Entry_Anchorblock_Info
4571 const char *name; /**< Name of the anchor, as indicated in its href
4573 int button; /**< The mouse button used to click on it */
4574 Evas_Object *hover; /**< The hover object to use for the popup */
4576 Evas_Coord x, y, w, h;
4577 } anchor, /**< Geometry selection of text used as anchor */
4578 hover_parent; /**< Geometry of the object used as parent by the
4580 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4581 for content on the left side of
4582 the hover. Before calling the
4583 callback, the widget will make the
4584 necessary calculations to check
4585 which sides are fit to be set with
4586 content, based on the position the
4587 hover is activated and its distance
4588 to the edges of its parent object
4590 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4591 the right side of the hover.
4592 See @ref hover_left */
4593 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4594 of the hover. See @ref hover_left */
4595 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4596 below the hover. See @ref
4600 * Add a new Anchorblock object
4602 * @param parent The parent object
4603 * @return The new object or NULL if it cannot be created
4605 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4607 * Set the text to show in the anchorblock
4609 * Sets the text of the anchorblock to @p text. This text can include markup
4610 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4611 * of text that will be specially styled and react to click events, ended
4612 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4613 * "anchor,clicked" signal that you can attach a callback to with
4614 * evas_object_smart_callback_add(). The name of the anchor given in the
4615 * event info struct will be the one set in the href attribute, in this
4618 * Other markup can be used to style the text in different ways, but it's
4619 * up to the style defined in the theme which tags do what.
4620 * @deprecated use elm_object_text_set() instead.
4622 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4624 * Get the markup text set for the anchorblock
4626 * Retrieves the text set on the anchorblock, with markup tags included.
4628 * @param obj The anchorblock object
4629 * @return The markup text set or @c NULL if nothing was set or an error
4631 * @deprecated use elm_object_text_set() instead.
4633 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4635 * Set the parent of the hover popup
4637 * Sets the parent object to use by the hover created by the anchorblock
4638 * when an anchor is clicked. See @ref Hover for more details on this.
4640 * @param obj The anchorblock object
4641 * @param parent The object to use as parent for the hover
4643 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4645 * Get the parent of the hover popup
4647 * Get the object used as parent for the hover created by the anchorblock
4648 * widget. See @ref Hover for more details on this.
4649 * If no parent is set, the same anchorblock object will be used.
4651 * @param obj The anchorblock object
4652 * @return The object used as parent for the hover, NULL if none is set.
4654 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4656 * Set the style that the hover should use
4658 * When creating the popup hover, anchorblock will request that it's
4659 * themed according to @p style.
4661 * @param obj The anchorblock object
4662 * @param style The style to use for the underlying hover
4664 * @see elm_object_style_set()
4666 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4668 * Get the style that the hover should use
4670 * Get the style the hover created by anchorblock will use.
4672 * @param obj The anchorblock object
4673 * @return The style to use by the hover. NULL means the default is used.
4675 * @see elm_object_style_set()
4677 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4679 * Ends the hover popup in the anchorblock
4681 * When an anchor is clicked, the anchorblock widget will create a hover
4682 * object to use as a popup with user provided content. This function
4683 * terminates this popup, returning the anchorblock to its normal state.
4685 * @param obj The anchorblock object
4687 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4689 * Appends a custom item provider to the given anchorblock
4691 * Appends the given function to the list of items providers. This list is
4692 * called, one function at a time, with the given @p data pointer, the
4693 * anchorblock object and, in the @p item parameter, the item name as
4694 * referenced in its href string. Following functions in the list will be
4695 * called in order until one of them returns something different to NULL,
4696 * which should be an Evas_Object which will be used in place of the item
4699 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4700 * href=item/name\>\</item\>
4702 * @param obj The anchorblock object
4703 * @param func The function to add to the list of providers
4704 * @param data User data that will be passed to the callback function
4706 * @see elm_entry_item_provider_append()
4708 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);
4710 * Prepend a custom item provider to the given anchorblock
4712 * Like elm_anchorblock_item_provider_append(), but it adds the function
4713 * @p func to the beginning of the list, instead of the end.
4715 * @param obj The anchorblock object
4716 * @param func The function to add to the list of providers
4717 * @param data User data that will be passed to the callback function
4719 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);
4721 * Remove a custom item provider from the list of the given anchorblock
4723 * Removes the function and data pairing that matches @p func and @p data.
4724 * That is, unless the same function and same user data are given, the
4725 * function will not be removed from the list. This allows us to add the
4726 * same callback several times, with different @p data pointers and be
4727 * able to remove them later without conflicts.
4729 * @param obj The anchorblock object
4730 * @param func The function to remove from the list
4731 * @param data The data matching the function to remove from the list
4733 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);
4739 * @defgroup Bubble Bubble
4741 * @brief The Bubble is a widget to show text similarly to how speech is
4742 * represented in comics.
4744 * The bubble widget contains 5 important visual elements:
4745 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4746 * @li The @p icon is an image to which the frame's arrow points to.
4747 * @li The @p label is a text which appears to the right of the icon if the
4748 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4750 * @li The @p info is a text which appears to the right of the label. Info's
4751 * font is of a ligther color than label.
4752 * @li The @p content is an evas object that is shown inside the frame.
4754 * The position of the arrow, icon, label and info depends on which corner is
4755 * selected. The four available corners are:
4756 * @li "top_left" - Default
4759 * @li "bottom_right"
4761 * Signals that you can add callbacks for are:
4762 * @li "clicked" - This is called when a user has clicked the bubble.
4764 * For an example of using a buble see @ref bubble_01_example_page "this".
4769 * Add a new bubble to the parent
4771 * @param parent The parent object
4772 * @return The new object or NULL if it cannot be created
4774 * This function adds a text bubble to the given parent evas object.
4776 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4778 * Set the label of the bubble
4780 * @param obj The bubble object
4781 * @param label The string to set in the label
4783 * This function sets the title of the bubble. Where this appears depends on
4784 * the selected corner.
4785 * @deprecated use elm_object_text_set() instead.
4787 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4789 * Get the label of the bubble
4791 * @param obj The bubble object
4792 * @return The string of set in the label
4794 * This function gets the title of the bubble.
4795 * @deprecated use elm_object_text_set() instead.
4797 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4799 * Set the info of the bubble
4801 * @param obj The bubble object
4802 * @param info The given info about the bubble
4804 * This function sets the info of the bubble. Where this appears depends on
4805 * the selected corner.
4806 * @deprecated use elm_object_text_set() instead.
4808 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4810 * Get the info of the bubble
4812 * @param obj The bubble object
4814 * @return The "info" string of the bubble
4816 * This function gets the info text.
4817 * @deprecated use elm_object_text_set() instead.
4819 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4821 * Set the content to be shown in the bubble
4823 * Once the content object is set, a previously set one will be deleted.
4824 * If you want to keep the old content object, use the
4825 * elm_bubble_content_unset() function.
4827 * @param obj The bubble object
4828 * @param content The given content of the bubble
4830 * This function sets the content shown on the middle of the bubble.
4832 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4834 * Get the content shown in the bubble
4836 * Return the content object which is set for this widget.
4838 * @param obj The bubble object
4839 * @return The content that is being used
4841 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4843 * Unset the content shown in the bubble
4845 * Unparent and return the content object which was set for this widget.
4847 * @param obj The bubble object
4848 * @return The content that was being used
4850 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4852 * Set the icon of the bubble
4854 * Once the icon object is set, a previously set one will be deleted.
4855 * If you want to keep the old content object, use the
4856 * elm_icon_content_unset() function.
4858 * @param obj The bubble object
4859 * @param icon The given icon for the bubble
4861 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4863 * Get the icon of the bubble
4865 * @param obj The bubble object
4866 * @return The icon for the bubble
4868 * This function gets the icon shown on the top left of bubble.
4870 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4872 * Unset the icon of the bubble
4874 * Unparent and return the icon object which was set for this widget.
4876 * @param obj The bubble object
4877 * @return The icon that was being used
4879 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4881 * Set the corner of the bubble
4883 * @param obj The bubble object.
4884 * @param corner The given corner for the bubble.
4886 * This function sets the corner of the bubble. The corner will be used to
4887 * determine where the arrow in the frame points to and where label, icon and
4890 * Possible values for corner are:
4891 * @li "top_left" - Default
4894 * @li "bottom_right"
4896 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4898 * Get the corner of the bubble
4900 * @param obj The bubble object.
4901 * @return The given corner for the bubble.
4903 * This function gets the selected corner of the bubble.
4905 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4911 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4912 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4913 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4914 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4915 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4916 /* smart callbacks called:
4917 * "clicked" - the user clicked the icon
4918 * "drag,start" - Someone started dragging the image out of the object
4919 * "drag,end" - Dragged item was dropped (somewhere)
4923 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4925 * @enum _Elm_Gesture_Types
4926 * Emum of supported gesture types.
4927 * @ingroup Elm_Gesture_Layer
4929 enum _Elm_Gesture_Types
4931 ELM_GESTURE_FIRST = 0,
4933 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4934 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4935 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4937 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4939 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4940 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4942 ELM_GESTURE_ZOOM, /**< Zoom */
4943 ELM_GESTURE_ROTATE, /**< Rotate */
4949 * @typedef Elm_Gesture_Types
4950 * Type for Emum of supported gesture types.
4951 * @ingroup Elm_Gesture_Layer
4953 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4956 * @enum _Elm_Gesture_State
4957 * Emum of gesture states.
4958 * @ingroup Elm_Gesture_Layer
4960 enum _Elm_Gesture_State
4962 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4963 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4964 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4965 ELM_GESTURE_STATE_END, /**< Gesture completed */
4966 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4969 * @typedef Elm_Gesture_State
4971 * @ingroup Elm_Gesture_Layer
4973 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4976 * @struct _Elm_Gesture_Taps_Info
4977 * Struct holds taps info for user
4978 * @ingroup Elm_Gesture_Layer
4980 struct _Elm_Gesture_Taps_Info
4982 Evas_Coord x, y; /**< Holds center point between fingers */
4983 unsigned int n; /**< Number of fingers tapped */
4984 unsigned int timestamp; /**< event timestamp */
4988 * @typedef Elm_Gesture_Taps_Info
4989 * holds taps info for user
4990 * @ingroup Elm_Gesture_Layer
4992 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4995 * @struct _Elm_Gesture_Momentum_Info
4996 * Struct holds momentum info for user
4997 * x1 and y1 are not necessarily in sync
4998 * x1 holds x value of x direction starting point
4999 * and same holds for y1.
5000 * This is noticeable when doing V-shape movement
5001 * @ingroup Elm_Gesture_Layer
5003 struct _Elm_Gesture_Momentum_Info
5004 { /* Report line ends, timestamps, and momentum computed */
5005 Evas_Coord x1; /**< Final-swipe direction starting point on X */
5006 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
5007 Evas_Coord x2; /**< Final-swipe direction ending point on X */
5008 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
5010 unsigned int tx; /**< Timestamp of start of final x-swipe */
5011 unsigned int ty; /**< Timestamp of start of final y-swipe */
5013 Evas_Coord mx; /**< Momentum on X */
5014 Evas_Coord my; /**< Momentum on Y */
5018 * @typedef Elm_Gesture_Momentum_Info
5019 * holds momentum info for user
5020 * @ingroup Elm_Gesture_Layer
5022 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
5025 * @struct _Elm_Gesture_Line_Info
5026 * Struct holds line info for user
5027 * @ingroup Elm_Gesture_Layer
5029 struct _Elm_Gesture_Line_Info
5030 { /* Report line ends, timestamps, and momentum computed */
5031 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
5032 unsigned int n; /**< Number of fingers (lines) */
5033 /* FIXME should be radians, bot degrees */
5034 double angle; /**< Angle (direction) of lines */
5038 * @typedef _Elm_Gesture_Line_Info
5039 * Holds line info for user
5040 * @ingroup Elm_Gesture_Layer
5042 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
5045 * @struct _Elm_Gesture_Zoom_Info
5046 * Struct holds zoom info for user
5047 * @ingroup Elm_Gesture_Layer
5049 struct _Elm_Gesture_Zoom_Info
5051 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5052 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5053 float zoom; /**< Zoom value: 1.0 means no zoom */
5054 float momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
5058 * @typedef Elm_Gesture_Zoom_Info
5059 * Holds zoom info for user
5060 * @ingroup Elm_Gesture_Layer
5062 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
5065 * @struct _Elm_Gesture_Rotate_Info
5066 * Struct holds rotation info for user
5067 * @ingroup Elm_Gesture_Layer
5069 struct _Elm_Gesture_Rotate_Info
5071 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5072 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5073 double base_angle; /**< Holds start-angle */
5074 double angle; /**< Rotation value: 0.0 means no rotation */
5075 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
5079 * @typedef Elm_Gesture_Rotate_Info
5080 * Holds rotation info for user
5081 * @ingroup Elm_Gesture_Layer
5083 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
5086 * @typedef Elm_Gesture_Event_Cb
5087 * User callback used to stream gesture info from gesture layer
5088 * @param data user data
5089 * @param event_info gesture report info
5090 * Returns a flag field to be applied on the causing event.
5091 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
5092 * upon the event, in an irreversible way.
5094 * @ingroup Elm_Gesture_Layer
5096 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
5099 * Use function to set callbacks to be notified about
5100 * change of state of gesture.
5101 * When a user registers a callback with this function
5102 * this means this gesture has to be tested.
5104 * When ALL callbacks for a gesture are set to NULL
5105 * it means user isn't interested in gesture-state
5106 * and it will not be tested.
5108 * @param obj Pointer to gesture-layer.
5109 * @param idx The gesture you would like to track its state.
5110 * @param cb callback function pointer.
5111 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
5112 * @param data user info to be sent to callback (usually, Smart Data)
5114 * @ingroup Elm_Gesture_Layer
5116 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);
5119 * Call this function to get repeat-events settings.
5121 * @param obj Pointer to gesture-layer.
5123 * @return repeat events settings.
5124 * @see elm_gesture_layer_hold_events_set()
5125 * @ingroup Elm_Gesture_Layer
5127 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5130 * This function called in order to make gesture-layer repeat events.
5131 * Set this of you like to get the raw events only if gestures were not detected.
5132 * Clear this if you like gesture layer to fwd events as testing gestures.
5134 * @param obj Pointer to gesture-layer.
5135 * @param r Repeat: TRUE/FALSE
5137 * @ingroup Elm_Gesture_Layer
5139 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
5142 * This function sets step-value for zoom action.
5143 * Set step to any positive value.
5144 * Cancel step setting by setting to 0.0
5146 * @param obj Pointer to gesture-layer.
5147 * @param s new zoom step value.
5149 * @ingroup Elm_Gesture_Layer
5151 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5154 * This function sets step-value for rotate action.
5155 * Set step to any positive value.
5156 * Cancel step setting by setting to 0.0
5158 * @param obj Pointer to gesture-layer.
5159 * @param s new roatate step value.
5161 * @ingroup Elm_Gesture_Layer
5163 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5166 * This function called to attach gesture-layer to an Evas_Object.
5167 * @param obj Pointer to gesture-layer.
5168 * @param t Pointer to underlying object (AKA Target)
5170 * @return TRUE, FALSE on success, failure.
5172 * @ingroup Elm_Gesture_Layer
5174 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
5177 * Call this function to construct a new gesture-layer object.
5178 * This does not activate the gesture layer. You have to
5179 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
5181 * @param parent the parent object.
5183 * @return Pointer to new gesture-layer object.
5185 * @ingroup Elm_Gesture_Layer
5187 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5190 typedef enum _Elm_Thumb_Animation_Setting
5192 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
5193 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
5194 ELM_THUMB_ANIMATION_STOP,
5195 ELM_THUMB_ANIMATION_LAST
5196 } Elm_Thumb_Animation_Setting;
5198 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5199 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
5200 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
5201 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5202 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5203 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
5204 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5205 EAPI void *elm_thumb_ethumb_client_get(void);
5206 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
5207 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5208 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5209 /* available styles:
5213 /* smart callbacks called:
5214 * "clicked" - This is called when a user has clicked the thumb without dragging around.
5215 * "clicked,double" - This is called when a user has double-clicked the thumb.
5216 * "press" - This is called when a user has pressed down the thumb.
5217 * "generate,start" - The thumbnail generation started.
5218 * "generate,stop" - The generation process stopped.
5219 * "generate,error" - The generation failed.
5220 * "load,error" - The thumbnail image loading failed.
5224 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5225 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5226 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5227 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5228 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5229 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5230 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5231 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5232 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5233 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5234 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5235 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5236 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5237 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5238 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5239 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);
5240 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
5241 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5242 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5243 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5244 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);
5245 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);
5246 /* smart callbacks called:
5247 * "clicked" - the user clicked the hoversel button and popped up the sel
5248 * "selected" - an item in the hoversel list is selected
5249 * "dismissed" - the hover is dismissed
5253 typedef enum _Elm_Toolbar_Shrink_Mode
5255 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
5256 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
5257 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
5258 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
5259 } Elm_Toolbar_Shrink_Mode;
5261 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
5262 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
5264 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5265 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
5266 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5267 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5268 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5269 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5270 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5271 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);
5272 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);
5273 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);
5274 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);
5275 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5276 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5277 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5278 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5279 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5280 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
5281 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5282 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5283 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5284 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
5285 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5286 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
5287 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5288 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5289 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5290 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5291 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
5292 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5293 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5294 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5295 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5296 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
5297 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5298 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
5299 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5300 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5301 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5302 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5303 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5304 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5305 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5306 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5307 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5308 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5309 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5310 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);
5311 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5312 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5313 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5314 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5315 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5316 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5317 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5318 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);
5319 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5320 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5321 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5322 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5323 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5324 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5325 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5326 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5327 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5328 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5329 /* smart callbacks called:
5330 * "clicked" - when the user clicks on a toolbar item and becomes selected
5332 /* available styles:
5334 * transparent (no background or shadow, just show the provided content)
5338 EAPI double elm_tooltip_delay_get(void);
5339 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5340 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5341 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5342 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5343 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);
5344 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5345 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5346 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5347 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5348 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5349 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5350 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5351 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5352 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5353 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5356 EAPI int elm_cursor_engine_only_get(void);
5357 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5360 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5361 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5362 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5363 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5364 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5365 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5366 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5367 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5368 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);
5369 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5370 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5371 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5372 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5373 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5374 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5375 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5376 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5377 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5378 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5379 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5380 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5381 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5382 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5383 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5384 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5385 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5386 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5387 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5388 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5389 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5391 /* smart callbacks called:
5392 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5396 typedef enum _Elm_List_Mode
5398 ELM_LIST_COMPRESS = 0,
5404 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5405 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5406 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);
5407 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);
5408 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);
5409 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);
5410 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);
5411 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5412 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5413 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5414 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5415 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5416 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5417 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5418 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5419 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5420 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5421 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5423 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5424 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5425 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5426 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5427 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5428 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5429 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5430 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5431 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5432 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5433 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5434 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5435 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5436 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5437 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5438 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5439 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5440 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5441 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5442 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5443 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);
5444 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5445 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5446 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5447 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5448 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5449 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5450 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5451 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5452 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5453 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5454 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5455 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5456 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5457 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5458 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5459 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);
5460 /* smart callbacks called:
5461 * "clicked,double" - when the user double-clicked an item
5462 * "selected" - when the user selected an item
5463 * "unselected" - when the user selected an item
5464 * "longpressed" - an item in the hoversel list is long-pressed
5465 * "scroll,edge,top" - the list is scrolled until the top edge
5466 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5467 * "scroll,edge,left" - the list is scrolled until the left edge
5468 * "scroll,edge,right" - the list is scrolled until the right edge
5472 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5473 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5474 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5475 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5476 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5477 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5478 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5479 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5480 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5482 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5483 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5484 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5485 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5486 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5487 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);
5488 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);
5489 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5490 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5491 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5492 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5493 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5494 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5495 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5496 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5497 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5498 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5499 /* smart callbacks called:
5500 * "changed" - Whenever the slider value is changed by the user.
5501 * "slider,drag,start" - dragging the slider indicator around has started
5502 * "slider,drag,stop" - dragging the slider indicator around has stopped
5503 * "delay,changed" - A short time after the value is changed by the user.
5504 * This will be called only when the user stops dragging for a very short
5505 * period or when they release their finger/mouse, so it avoids possibly
5506 * expensive reactions to the value change.
5510 * @addtogroup Actionslider Actionslider
5512 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5513 * properties. The indicator is the element the user drags to choose a label.
5514 * When the position is set with magnet, when released the indicator will be
5515 * moved to it if it's nearest the magnetized position.
5517 * @note By default all positions are set as enabled.
5519 * Signals that you can add callbacks for are:
5521 * "selected" - when user selects an enabled position (the label is passed
5524 * "pos_changed" - when the indicator reaches any of the positions("left",
5525 * "right" or "center").
5527 * See an example of actionslider usage @ref actionslider_example_page "here"
5530 typedef enum _Elm_Actionslider_Pos
5532 ELM_ACTIONSLIDER_NONE = 0,
5533 ELM_ACTIONSLIDER_LEFT = 1 << 0,
5534 ELM_ACTIONSLIDER_CENTER = 1 << 1,
5535 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
5536 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
5537 } Elm_Actionslider_Pos;
5540 * Add a new actionslider to the parent.
5542 * @param parent The parent object
5543 * @return The new actionslider object or NULL if it cannot be created
5545 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5547 * Set actionslider labels.
5549 * @param obj The actionslider object
5550 * @param left_label The label to be set on the left.
5551 * @param center_label The label to be set on the center.
5552 * @param right_label The label to be set on the right.
5553 * @deprecated use elm_object_text_set() instead.
5555 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
5557 * Get actionslider labels.
5559 * @param obj The actionslider object
5560 * @param left_label A char** to place the left_label of @p obj into.
5561 * @param center_label A char** to place the center_label of @p obj into.
5562 * @param right_label A char** to place the right_label of @p obj into.
5563 * @deprecated use elm_object_text_set() instead.
5565 EINA_DEPRECATED EAPI void elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
5567 * Get actionslider selected label.
5569 * @param obj The actionslider object
5570 * @return The selected label
5572 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5574 * Set actionslider indicator position.
5576 * @param obj The actionslider object.
5577 * @param pos The position of the indicator.
5579 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
5581 * Get actionslider indicator position.
5583 * @param obj The actionslider object.
5584 * @return The position of the indicator.
5586 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5588 * Set actionslider magnet position. To make multiple positions magnets @c or
5589 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
5591 * @param obj The actionslider object.
5592 * @param pos Bit mask indicating the magnet positions.
5594 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
5596 * Get actionslider magnet position.
5598 * @param obj The actionslider object.
5599 * @return The positions with magnet property.
5601 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5603 * Set actionslider enabled position. To set multiple positions as enabled @c or
5604 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
5606 * @note All the positions are enabled by default.
5608 * @param obj The actionslider object.
5609 * @param pos Bit mask indicating the enabled positions.
5611 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
5613 * Get actionslider enabled position.
5615 * @param obj The actionslider object.
5616 * @return The enabled positions.
5618 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5620 * Set the label used on the indicator.
5622 * @param obj The actionslider object
5623 * @param label The label to be set on the indicator.
5624 * @deprecated use elm_object_text_set() instead.
5626 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5628 * Get the label used on the indicator object.
5630 * @param obj The actionslider object
5631 * @return The indicator label
5632 * @deprecated use elm_object_text_set() instead.
5634 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5640 typedef enum _Elm_Genlist_Item_Flags
5642 ELM_GENLIST_ITEM_NONE = 0,
5643 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5644 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5645 } Elm_Genlist_Item_Flags;
5646 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5647 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5648 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5649 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5650 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5651 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5652 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5653 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5655 struct _Elm_Genlist_Item_Class
5657 const char *item_style;
5660 GenlistItemLabelGetFunc label_get;
5661 GenlistItemIconGetFunc icon_get;
5662 GenlistItemStateGetFunc state_get;
5663 GenlistItemDelFunc del;
5664 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
5666 const char *mode_item_style;
5669 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5670 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5671 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5672 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5673 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5674 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5675 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5676 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5677 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5678 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5679 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5680 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5681 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5682 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5683 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5684 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5685 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5686 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5687 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5688 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5689 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5690 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5691 /* operations to add items */
5692 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);
5693 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);
5694 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);
5695 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);
5696 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);
5697 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);
5698 /* operations to retrieve existing items */
5699 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5700 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5701 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5702 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);
5703 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5704 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5705 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5706 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);
5707 /* available item styles:
5709 * default_style - The text part is a textblock
5711 * icon_top_text_bottom
5713 /* Genlist Item operation */
5714 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5715 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5716 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5717 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5718 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5719 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5720 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5721 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5722 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5723 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5724 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5725 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5726 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5727 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5728 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5729 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5730 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5731 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5732 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5733 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5734 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5735 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5736 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5737 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5738 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5739 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5740 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5741 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5742 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5743 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);
5744 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5745 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5746 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5747 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5748 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5749 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5750 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5751 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5752 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5753 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5754 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5755 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5756 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5757 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5758 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5759 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5760 /* Signals that you can add callbacks for are:
5761 * "clicked,double" - This is called when a user has double-clicked an item.
5762 * The event_info parameter is the genlist item that was
5764 * "selected" - This is called when a user has made an item selected. The
5765 * event_info parameter is the genlist item that was selected.
5766 * "unselected" - This is called when a user has made an item unselected. The
5767 * event_info parameter is the genlist item that was
5769 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5770 * and the item is now meant to be expanded. The event_info
5771 * parameter is the genlist item that was indicated to expand.
5772 * It is the job of this callback to then fill in the child
5774 * "contracted" - This is called when elm_genlist_item_expanded_set() is
5775 * called and the item is now meant to be contracted. The
5776 * event_info parameter is the genlist item that was indicated
5777 * to contract. It is the job of this callback to then delete
5779 * "expand,request" - This is called when a user has indicated they want to
5780 * expand a tree branch item. The callback should decide
5781 * if the item can expand (has any children) and then call
5782 * elm_genlist_item_expanded_set() appropriately to set
5783 * the state. The event_info parameter is the genlist item
5784 * that was indicated to expand.
5785 * "contract,request" - This is called when a user has indicated they want to
5786 * contract a tree branch item. The callback should
5787 * decide if the item can contract (has any children)
5788 * and then call elm_genlist_item_expanded_set()
5789 * appropriately to set the state. The event_info
5790 * parameter is the genlist item that was indicated to
5792 * "realized" - This is called when the item in the list is created as a real
5793 * evas object. event_info parameter is the genlist item that
5794 * was created. The object may be deleted at any time, so it is
5795 * up to the caller to not use the object pointer from
5796 * elm_genlist_item_object_get() in a way where it may point to
5798 * "unrealized" - This is called just before an item is unrealized. After
5799 * this call icon objects provided will be deleted and the
5800 * item object itself delete or be put into a floating cache.
5801 * "drag,start,up" - This is called when the item in the list has been
5802 * dragged (not scrolled) up.
5803 * "drag,start,down" - This is called when the item in the list has been
5804 * dragged (not scrolled) down.
5805 * "drag,start,left" - This is called when the item in the list has been
5806 * dragged (not scrolled) left.
5807 * "drag,start,right" - This is called when the item in the list has been
5808 * dragged (not scrolled) right.
5809 * "drag,stop" - This is called when the item in the list has stopped being
5811 * "drag" - This is called when the item in the list is being dragged.
5812 * "longpressed" - This is called when the item is pressed for a certain
5813 * amount of time. By default it's 1 second.
5814 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5816 * "scroll,edge,bottom" - This is called when the genlist is scrolled until
5818 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5820 * "scroll,edge,right" - This is called when the genlist is scrolled until
5822 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5824 * "multi,swipe,right" - This is called when the genlist is multi-touch
5826 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
5828 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5830 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5832 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
5834 * "swipe" - This is called when the genlist is swiped.
5838 * @page tutorial_check Check example
5839 * @dontinclude check_example_01.c
5841 * This example will show 2 checkboxes, one with just a label and the second
5842 * one with both a label and an icon. This example also ilustrates how to
5843 * have the checkbox change the value of a variable and how to react to those
5846 * We will start with the usual setup code:
5849 * And now we create our first checkbox, set its label, tell it to change
5850 * the value of @p value when the checkbox stats is changed and ask to be
5851 * notified of state changes:
5854 * For our second checkbox we are going to set an icon so we need to create
5857 * @note For simplicity we are using a rectangle as icon, but any evas object
5860 * And for our second checkbox we set the label, icon and state to true:
5863 * We now do some more setup:
5866 * And finally implement the callback that will be called when the first
5867 * checkbox's state changes. This callback will use @p data to print a
5870 * @note This work because @p data is @p value(from the main function) and @p
5871 * value is changed when the checkbox is changed.
5873 * Our example will look like this:
5874 * @image html screenshots/check_example_01.png
5875 * @image latex screenshots/check_example_01.eps
5877 * @example check_example_01.c
5880 * @defgroup Check Check
5882 * @brief The check widget allows for toggling a value between true and
5885 * Check objects are a lot like radio objects in layout and functionality
5886 * except they do not work as a group, but independently and only toggle the
5887 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5888 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5889 * returns the current state. For convenience, like the radio objects, you
5890 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5893 * Signals that you can add callbacks for are:
5894 * "changed" - This is called whenever the user changes the state of one of
5895 * the check object(event_info is NULL).
5897 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5901 * @brief Add a new Check object
5903 * @param parent The parent object
5904 * @return The new object or NULL if it cannot be created
5906 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5908 * @brief Set the text label of the check object
5910 * @param obj The check object
5911 * @param label The text label string in UTF-8
5913 * @deprecated use elm_object_text_set() instead.
5915 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5917 * @brief Get the text label of the check object
5919 * @param obj The check object
5920 * @return The text label string in UTF-8
5922 * @deprecated use elm_object_text_get() instead.
5924 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5926 * @brief Set the icon object of the check object
5928 * @param obj The check object
5929 * @param icon The icon object
5931 * Once the icon object is set, a previously set one will be deleted.
5932 * If you want to keep that old content object, use the
5933 * elm_check_icon_unset() function.
5935 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5937 * @brief Get the icon object of the check object
5939 * @param obj The check object
5940 * @return The icon object
5942 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5944 * @brief Unset the icon used for the check object
5946 * @param obj The check object
5947 * @return The icon object that was being used
5949 * Unparent and return the icon object which was set for this widget.
5951 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5953 * @brief Set the on/off state of the check object
5955 * @param obj The check object
5956 * @param state The state to use (1 == on, 0 == off)
5958 * This sets the state of the check. If set
5959 * with elm_check_state_pointer_set() the state of that variable is also
5960 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5962 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5964 * @brief Get the state of the check object
5966 * @param obj The check object
5967 * @return The boolean state
5969 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5971 * @brief Set a convenience pointer to a boolean to change
5973 * @param obj The check object
5974 * @param statep Pointer to the boolean to modify
5976 * This sets a pointer to a boolean, that, in addition to the check objects
5977 * state will also be modified directly. To stop setting the object pointed
5978 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5979 * then when this is called, the check objects state will also be modified to
5980 * reflect the value of the boolean @p statep points to, just like calling
5981 * elm_check_state_set().
5983 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5989 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5990 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5991 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5992 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5993 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5994 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5996 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5997 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5998 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5999 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6000 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
6001 /* smart callbacks called:
6002 * "changed" - when the radio status is changed
6006 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6007 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6008 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
6009 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6010 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6011 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6012 /* available item styles:
6018 /* smart callbacks called:
6019 * "hide,finished" - when the previous page is hided
6022 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
6023 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
6024 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
6025 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
6026 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
6028 struct _Elm_Slideshow_Item_Class
6030 struct _Elm_Slideshow_Item_Class_Func
6032 SlideshowItemGetFunc get;
6033 SlideshowItemDelFunc del;
6037 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6038 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
6039 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);
6040 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6041 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6042 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
6043 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6044 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
6045 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6046 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6047 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6048 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
6049 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6050 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6051 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6052 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6053 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6054 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6055 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
6056 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
6057 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6058 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
6059 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6060 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6061 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6062 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6063 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6064 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6065 /* smart callbacks called:
6066 * "changed" - when the slideshow switch to another item
6070 typedef enum _Elm_Fileselector_Mode
6072 ELM_FILESELECTOR_LIST = 0,
6073 ELM_FILESELECTOR_GRID,
6074 ELM_FILESELECTOR_LAST
6075 } Elm_Fileselector_Mode;
6077 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6078 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
6079 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6080 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
6081 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6082 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
6083 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6084 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6085 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
6086 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6087 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6088 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6089 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6090 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
6091 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6092 /* smart callbacks called:
6093 * "selected" - the user click on a file
6094 * "directory,open" - the list is populate with a new content. event_info is a directory.
6095 * "done" - the user click on the ok or cancel buttons
6099 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6100 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
6101 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6102 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6103 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6104 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6105 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6106 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6107 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6108 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6110 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
6111 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6112 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
6113 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6114 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6115 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6116 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
6117 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6118 /* smart callbacks called:
6120 /* available item styles:
6122 * wheel (simple style, no text, no progression, only pulse is available)
6126 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6127 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6128 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6129 /* smart callbacks called:
6133 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6134 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
6135 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6136 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
6137 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
6138 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
6139 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6140 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6141 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6142 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6143 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6144 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6145 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6146 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
6147 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6148 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6149 /* smart callbacks called:
6150 * "changed" - when the spinner value changes
6151 * "delay,changed" - when the spinner value changed, but a small time after a change (use this if you only want to respond to a change once the spinner is held still for a short while).
6153 /* available item styles:
6155 * vertical (two up/down buttons at the right side and text left aligned)
6159 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
6161 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6162 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
6163 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6164 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6165 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6166 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6167 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6168 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6169 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6170 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6171 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);
6172 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6173 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6174 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6175 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6176 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6177 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
6178 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6179 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6180 /* smart callbacks called:
6181 * "changed" - when the selected index item changes
6182 * "delay,changed" - when the selected index item changes, but after some small idle period
6183 * "selected" - when the user releases a finger and selects an item
6184 * "level,up" - when the user moves a finger from the first level to the second level
6185 * "level,down" - when the user moves a finger from the second level to the first level
6189 typedef enum _Elm_Photocam_Zoom_Mode
6191 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
6192 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
6193 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
6194 ELM_PHOTOCAM_ZOOM_MODE_LAST
6195 } Elm_Photocam_Zoom_Mode;
6197 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6198 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
6199 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6200 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
6201 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6202 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6203 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6204 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
6205 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
6206 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6207 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6208 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6209 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6210 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6211 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6212 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6213 /* smart callbacks called:
6214 * "clicked" - when image clicked
6215 * "press" - when mouse/finger held down initially on image
6216 * "longpressed" - when mouse/finger held for long time on image
6217 * "clicked,double" - when mouse/finger double-clicked
6218 * "load" - when photo load begins
6219 * "loaded" - when photo load done
6220 * "load,detail" - when detailed image load begins
6221 * "loaded,detail" - when detailed image load done
6222 * "zoom,start" - when zooming started
6223 * "zoom,stop" - when zooming stopped
6224 * "zoom,change" - when auto zoom mode changed zoom level
6225 * "scroll - the content has been scrolled (moved)
6226 * "scroll,anim,start" - scrolling animation has started
6227 * "scroll,anim,stop" - scrolling animation has stopped
6228 * "scroll,drag,start" - dragging the contents around has started
6229 * "scroll,drag,stop" - dragging the contents around has stopped
6233 typedef enum _Elm_Map_Zoom_Mode
6235 ELM_MAP_ZOOM_MODE_MANUAL,
6236 ELM_MAP_ZOOM_MODE_AUTO_FIT,
6237 ELM_MAP_ZOOM_MODE_AUTO_FILL,
6238 ELM_MAP_ZOOM_MODE_LAST
6239 } Elm_Map_Zoom_Mode;
6241 typedef enum _Elm_Map_Route_Sources
6243 ELM_MAP_ROUTE_SOURCE_YOURS,
6244 ELM_MAP_ROUTE_SOURCE_MONAV,
6245 ELM_MAP_ROUTE_SOURCE_ORS,
6246 ELM_MAP_ROUTE_SOURCE_LAST
6247 } Elm_Map_Route_Sources;
6249 typedef enum _Elm_Map_Name_Sources
6251 ELM_MAP_NAME_SOURCE_NOMINATIM,
6252 ELM_MAP_NAME_SOURCE_LAST
6253 } Elm_Map_Name_Sources;
6255 typedef enum _Elm_Map_Route_Type
6257 ELM_MAP_ROUTE_TYPE_MOTOCAR,
6258 ELM_MAP_ROUTE_TYPE_BICYCLE,
6259 ELM_MAP_ROUTE_TYPE_FOOT,
6260 ELM_MAP_ROUTE_TYPE_LAST
6261 } Elm_Map_Route_Type;
6263 typedef enum _Elm_Map_Route_Method
6265 ELM_MAP_ROUTE_METHOD_FASTEST,
6266 ELM_MAP_ROUTE_METHOD_SHORTEST,
6267 ELM_MAP_ROUTE_METHOD_LAST
6268 } Elm_Map_Route_Method;
6270 typedef enum _Elm_Map_Name_Method
6272 ELM_MAP_NAME_METHOD_SEARCH,
6273 ELM_MAP_NAME_METHOD_REVERSE,
6274 ELM_MAP_NAME_METHOD_LAST
6275 } Elm_Map_Name_Method;
6277 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6278 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6279 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6280 typedef struct _Elm_Map_Route Elm_Map_Route;
6281 typedef struct _Elm_Map_Name Elm_Map_Name;
6282 typedef struct _Elm_Map_Track Elm_Map_Track;
6284 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6285 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6286 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6287 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6289 typedef char *(*ElmMapModuleSourceFunc) (void);
6290 typedef int (*ElmMapModuleZoomMinFunc) (void);
6291 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6292 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6293 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6294 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6295 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6296 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6297 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6299 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6300 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6301 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6302 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6303 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6304 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6305 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6306 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6307 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6308 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6309 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6310 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6311 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6312 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);
6313 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);
6314 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6315 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6316 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);
6317 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);
6318 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6319 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6320 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6321 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6322 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6323 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6324 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6325 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6326 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6327 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6328 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6329 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6330 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6331 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6332 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6333 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6334 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6335 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6336 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6337 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6338 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6339 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6340 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6341 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6342 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6343 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6344 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6345 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6346 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6347 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6348 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6349 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6350 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);
6351 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6352 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6353 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6354 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6355 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6356 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6357 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6358 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6359 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6360 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6361 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);
6362 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6363 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6365 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6367 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6369 /* smart callbacks called:
6370 * "clicked" - when image clicked
6371 * "press" - when mouse/finger held down initially on image
6372 * "longpressed" - when mouse/finger held for long time on image
6373 * "clicked,double" - when mouse/finger double-clicked
6374 * "load,details" - when detailed image load begins
6375 * "loaded,details" - when detailed image load done
6376 * "zoom,start" - when zooming started
6377 * "zoom,stop" - when zooming stopped
6378 * "zoom,change" - when auto zoom mode changed zoom level
6379 * "scroll - the content has been scrolled (moved)
6380 * "scroll,anim,start" - scrolling animation has started
6381 * "scroll,anim,stop" - scrolling animation has stopped
6382 * "scroll,drag,start" - dragging the contents around has started
6383 * "scroll,drag,stop" - dragging the contents around has stopped
6387 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6389 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6391 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6392 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6393 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6394 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6398 typedef enum _Elm_Panel_Orient
6400 ELM_PANEL_ORIENT_TOP,
6401 ELM_PANEL_ORIENT_BOTTOM,
6402 ELM_PANEL_ORIENT_LEFT,
6403 ELM_PANEL_ORIENT_RIGHT,
6406 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6407 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6408 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6410 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6411 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6412 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6413 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6414 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6420 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6421 * Add events (move, start ...)
6423 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6424 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6425 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6426 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6427 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6428 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6429 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6430 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6431 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6432 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6433 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6436 * @defgroup Flip Flip
6438 * This widget holds 2 content objects(Evas_Object): one on the front and one
6439 * on the back. It allows you to flip from front to back and vice-versa using
6440 * various animations.
6442 * If either the front or back contents are not set the flip will treat that
6443 * as transparent. So if you wore to set the front content but not the back,
6444 * and then call elm_flip_go() you would see whatever is below the flip.
6446 * For a list of supported animations see elm_flip_go().
6448 * Signals that you can add callbacks for are:
6449 * "animate,begin" - when a flip animation was started
6450 * "animate,done" - when a flip animation is finished
6452 * @ref tutorial_flip show how to use most of the API.
6456 typedef enum _Elm_Flip_Mode
6458 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6459 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6460 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6461 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6463 ELM_FLIP_CUBE_RIGHT,
6467 ELM_FLIP_PAGE_RIGHT,
6471 typedef enum _Elm_Flip_Interaction
6473 ELM_FLIP_INTERACTION_NONE,
6474 ELM_FLIP_INTERACTION_ROTATE,
6475 ELM_FLIP_INTERACTION_CUBE,
6476 ELM_FLIP_INTERACTION_PAGE
6477 } Elm_Flip_Interaction;
6478 typedef enum _Elm_Flip_Direction
6480 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
6481 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
6482 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
6483 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
6484 } Elm_Flip_Direction;
6486 * @brief Add a new flip to the parent
6488 * @param parent The parent object
6489 * @return The new object or NULL if it cannot be created
6491 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6493 * @brief Set the front content of the flip widget.
6495 * @param obj The flip object
6496 * @param content The new front content object
6498 * Once the content object is set, a previously set one will be deleted.
6499 * If you want to keep that old content object, use the
6500 * elm_flip_content_front_unset() function.
6502 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6504 * @brief Set the back content of the flip widget.
6506 * @param obj The flip object
6507 * @param content The new back content object
6509 * Once the content object is set, a previously set one will be deleted.
6510 * If you want to keep that old content object, use the
6511 * elm_flip_content_back_unset() function.
6513 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6515 * @brief Get the front content used for the flip
6517 * @param obj The flip object
6518 * @return The front content object that is being used
6520 * Return the front content object which is set for this widget.
6522 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6524 * @brief Get the back content used for the flip
6526 * @param obj The flip object
6527 * @return The back content object that is being used
6529 * Return the back content object which is set for this widget.
6531 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6533 * @brief Unset the front content used for the flip
6535 * @param obj The flip object
6536 * @return The front content object that was being used
6538 * Unparent and return the front content object which was set for this widget.
6540 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6542 * @brief Unset the back content used for the flip
6544 * @param obj The flip object
6545 * @return The back content object that was being used
6547 * Unparent and return the back content object which was set for this widget.
6549 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6551 * @brief Get flip front visibility state
6553 * @param obj The flip objct
6554 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
6557 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 * @brief Set flip perspective
6561 * @param obj The flip object
6562 * @param foc The coordinate to set the focus on
6563 * @param x The X coordinate
6564 * @param y The Y coordinate
6566 * @warning This function currently does nothing.
6568 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6570 * @brief Runs the flip animation
6572 * @param obj The flip object
6573 * @param mode The mode type
6575 * Flips the front and back contents using the @p mode animation. This
6576 * efectively hides the currently visible content and shows the hidden one.
6578 * There a number of possible animations to use for the flipping:
6579 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
6580 * around a horizontal axis in the middle of its height, the other content
6581 * is shown as the other side of the flip.
6582 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
6583 * around a vertical axis in the middle of its width, the other content is
6584 * shown as the other side of the flip.
6585 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
6586 * around a diagonal axis in the middle of its width, the other content is
6587 * shown as the other side of the flip.
6588 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
6589 * around a diagonal axis in the middle of its height, the other content is
6590 * shown as the other side of the flip.
6591 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
6592 * as if the flip was a cube, the other content is show as the right face of
6594 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
6595 * right as if the flip was a cube, the other content is show as the left
6597 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
6598 * flip was a cube, the other content is show as the bottom face of the cube.
6599 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
6600 * the flip was a cube, the other content is show as the upper face of the
6602 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
6603 * if the flip was a book, the other content is shown as the page below that.
6604 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
6605 * as if the flip was a book, the other content is shown as the page below
6607 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
6608 * flip was a book, the other content is shown as the page below that.
6609 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
6610 * flip was a book, the other content is shown as the page below that.
6612 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6614 * @brief Set the interactive flip mode
6616 * @param obj The flip object
6617 * @param mode The interactive flip mode to use
6619 * This sets if the flip should be interactive (allow user to click and
6620 * drag a side of the flip to reveal the back page and cause it to flip).
6621 * By default a flip is not interactive. You may also need to set which
6622 * sides of the flip are "active" for flipping and how much space they use
6623 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
6624 * and elm_flip_interacton_direction_hitsize_set()
6626 * The four avilable mode of interaction are:
6627 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
6628 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
6629 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
6630 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
6632 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
6633 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
6634 * happen, those can only be acheived with elm_flip_go();
6636 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6638 * @brief Get the interactive flip mode
6640 * @param obj The flip object
6641 * @return The interactive flip mode
6643 * Returns the interactive flip mode set by elm_flip_interaction_set()
6645 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6647 * @brief Set which directions of the flip respond to interactive flip
6649 * @param obj The flip object
6650 * @param dir The direction to change
6651 * @param enabled If that direction is enabled or not
6653 * By default all directions are disabled, so you may want to enable the
6654 * desired directions for flipping if you need interactive flipping. You must
6655 * call this function once for each direction that should be enabled.
6657 * @see elm_flip_interaction_set()
6659 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6661 * @brief Get the enabled state of that flip direction
6663 * @param obj The flip object
6664 * @param dir The direction to check
6665 * @return If that direction is enabled or not
6667 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
6669 * @see elm_flip_interaction_set()
6671 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6673 * @brief Set the amount of the flip that is sensitive to interactive flip
6675 * @param obj The flip object
6676 * @param dir The direction to modify
6677 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
6679 * Set the amount of the flip that is sensitive to interactive flip, with 0
6680 * representing no area in the flip and 1 representing the entire flip. There
6681 * is however a consideration to be made in that the area will never be
6682 * smaller than the finger size set(as set in your Elementary configuration).
6684 * @see elm_flip_interaction_set()
6686 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6688 * @brief Get the amount of the flip that is sensitive to interactive flip
6690 * @param obj The flip object
6691 * @param dir The direction to check
6692 * @return The size set for that direction
6694 * Returns the amount os sensitive area set by
6695 * elm_flip_interacton_direction_hitsize_set().
6697 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6703 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6704 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6705 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6706 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6707 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6708 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6709 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6710 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6711 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6712 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6714 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6715 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6716 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6717 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6718 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6719 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6720 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6721 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6722 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6723 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6724 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6725 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6726 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6727 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6728 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6729 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6730 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6731 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6732 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6733 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6734 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6735 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6736 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6738 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);
6739 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6740 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6741 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);
6742 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6743 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);
6744 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6745 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6746 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6747 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6748 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6749 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6750 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6751 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6752 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);
6753 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);
6754 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);
6755 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);
6756 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);
6757 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);
6758 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6759 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6760 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6761 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6762 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6763 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6764 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6767 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6768 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6769 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6770 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6771 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6774 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6775 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6776 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6778 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6779 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6780 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6781 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6782 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6783 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6786 * @defgroup Flipselector Flip Selector
6788 * A flip selector is a widget to show a set of @b text items, one
6789 * at a time, with the same sheet switching style as the @ref Clock
6790 * "clock" widget, when one changes the current displaying sheet
6791 * (thus, the "flip" in the name).
6793 * User clicks to flip sheets which are @b held for some time will
6794 * make the flip selector to flip continuosly and automatically for
6795 * the user. The interval between flips will keep growing in time,
6796 * so that it helps the user to reach an item which is distant from
6797 * the current selection.
6799 * Smart callbacks one can register to:
6800 * - @c "selected" - when the widget's selected text item is changed
6801 * - @c "overflowed" - when the widget's current selection is changed
6802 * from the first item in its list to the last
6803 * - @c "underflowed" - when the widget's current selection is changed
6804 * from the last item in its list to the first
6806 * Available styles for it:
6809 * Here is an example on its usage:
6810 * @li @ref flipselector_example
6814 * @addtogroup Flipselector
6818 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6821 * Add a new flip selector widget to the given parent Elementary
6822 * (container) widget
6824 * @param parent The parent object
6825 * @return a new flip selector widget handle or @c NULL, on errors
6827 * This function inserts a new flip selector widget on the canvas.
6829 * @ingroup Flipselector
6831 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6834 * Programmatically select the next item of a flip selector widget
6836 * @param obj The flipselector object
6838 * @note The selection will be animated. Also, if it reaches the
6839 * end of its list of member items, it will continue with the first
6842 * @ingroup Flipselector
6844 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6847 * Programmatically select the previous item of a flip selector
6850 * @param obj The flipselector object
6852 * @note The selection will be animated. Also, if it reaches the
6853 * beginning of its list of member items, it will continue with the
6854 * last one backwards.
6856 * @ingroup Flipselector
6858 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6861 * Append a (text) item to a flip selector widget
6863 * @param obj The flipselector object
6864 * @param label The (text) label of the new item
6865 * @param func Convenience callback function to take place when
6867 * @param data Data passed to @p func, above
6868 * @return A handle to the item added or @c NULL, on errors
6870 * The widget's list of labels to show will be appended with the
6871 * given value. If the user wishes so, a callback function pointer
6872 * can be passed, which will get called when this same item is
6875 * @note The current selection @b won't be modified by appending an
6876 * element to the list.
6878 * @note The maximum length of the text label is going to be
6879 * determined <b>by the widget's theme</b>. Strings larger than
6880 * that value are going to be @b truncated.
6882 * @ingroup Flipselector
6884 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6887 * Prepend a (text) item to a flip selector widget
6889 * @param obj The flipselector object
6890 * @param label The (text) label of the new item
6891 * @param func Convenience callback function to take place when
6893 * @param data Data passed to @p func, above
6894 * @return A handle to the item added or @c NULL, on errors
6896 * The widget's list of labels to show will be prepended with the
6897 * given value. If the user wishes so, a callback function pointer
6898 * can be passed, which will get called when this same item is
6901 * @note The current selection @b won't be modified by prepending
6902 * an element to the list.
6904 * @note The maximum length of the text label is going to be
6905 * determined <b>by the widget's theme</b>. Strings larger than
6906 * that value are going to be @b truncated.
6908 * @ingroup Flipselector
6910 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6913 * Get the internal list of items in a given flip selector widget.
6915 * @param obj The flipselector object
6916 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6919 * This list is @b not to be modified in any way and must not be
6920 * freed. Use the list members with functions like
6921 * elm_flipselector_item_label_set(),
6922 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6923 * elm_flipselector_item_del(),
6924 * elm_flipselector_item_selected_get(),
6925 * elm_flipselector_item_selected_set().
6927 * @warning This list is only valid until @p obj object's internal
6928 * items list is changed. It should be fetched again with another
6929 * call to this function when changes happen.
6931 * @ingroup Flipselector
6933 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6936 * Get the first item in the given flip selector widget's list of
6939 * @param obj The flipselector object
6940 * @return The first item or @c NULL, if it has no items (and on
6943 * @see elm_flipselector_item_append()
6944 * @see elm_flipselector_last_item_get()
6946 * @ingroup Flipselector
6948 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6951 * Get the last item in the given flip selector widget's list of
6954 * @param obj The flipselector object
6955 * @return The last item or @c NULL, if it has no items (and on
6958 * @see elm_flipselector_item_prepend()
6959 * @see elm_flipselector_first_item_get()
6961 * @ingroup Flipselector
6963 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6966 * Get the currently selected item in a flip selector widget.
6968 * @param obj The flipselector object
6969 * @return The selected item or @c NULL, if the widget has no items
6972 * @ingroup Flipselector
6974 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6977 * Set whether a given flip selector widget's item should be the
6978 * currently selected one.
6980 * @param item The flip selector item
6981 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6983 * This sets whether @p item is or not the selected (thus, under
6984 * display) one. If @p item is different than one under display,
6985 * the latter will be unselected. If the @p item is set to be
6986 * unselected, on the other hand, the @b first item in the widget's
6987 * internal members list will be the new selected one.
6989 * @see elm_flipselector_item_selected_get()
6991 * @ingroup Flipselector
6993 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6996 * Get whether a given flip selector widget's item is the currently
6999 * @param item The flip selector item
7000 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
7003 * @see elm_flipselector_item_selected_set()
7005 * @ingroup Flipselector
7007 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7010 * Delete a given item from a flip selector widget.
7012 * @param item The item to delete
7014 * @ingroup Flipselector
7016 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7019 * Get the label of a given flip selector widget's item.
7021 * @param item The item to get label from
7022 * @return The text label of @p item or @c NULL, on errors
7024 * @see elm_flipselector_item_label_set()
7026 * @ingroup Flipselector
7028 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7031 * Set the label of a given flip selector widget's item.
7033 * @param item The item to set label on
7034 * @param label The text label string, in UTF-8 encoding
7036 * @see elm_flipselector_item_label_get()
7038 * @ingroup Flipselector
7040 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7043 * Gets the item before @p item in a flip selector widget's
7044 * internal list of items.
7046 * @param item The item to fetch previous from
7047 * @return The item before the @p item, in its parent's list. If
7048 * there is no previous item for @p item or there's an
7049 * error, @c NULL is returned.
7051 * @see elm_flipselector_item_next_get()
7053 * @ingroup Flipselector
7055 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7058 * Gets the item after @p item in a flip selector widget's
7059 * internal list of items.
7061 * @param item The item to fetch next from
7062 * @return The item after the @p item, in its parent's list. If
7063 * there is no next item for @p item or there's an
7064 * error, @c NULL is returned.
7066 * @see elm_flipselector_item_next_get()
7068 * @ingroup Flipselector
7070 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7073 * Set the interval on time updates for an user mouse button hold
7074 * on a flip selector widget.
7076 * @param obj The flip selector object
7077 * @param interval The (first) interval value in seconds
7079 * This interval value is @b decreased while the user holds the
7080 * mouse pointer either flipping up or flipping doww a given flip
7083 * This helps the user to get to a given item distant from the
7084 * current one easier/faster, as it will start to flip quicker and
7085 * quicker on mouse button holds.
7087 * The calculation for the next flip interval value, starting from
7088 * the one set with this call, is the previous interval divided by
7089 * 1.05, so it decreases a little bit.
7091 * The default starting interval value for automatic flips is
7094 * @see elm_flipselector_interval_get()
7096 * @ingroup Flipselector
7098 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7101 * Get the interval on time updates for an user mouse button hold
7102 * on a flip selector widget.
7104 * @param obj The flip selector object
7105 * @return The (first) interval value, in seconds, set on it
7107 * @see elm_flipselector_interval_set() for more details
7109 * @ingroup Flipselector
7111 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7118 * @addtogroup Animator Animator
7119 * @ingroup Elementary
7121 * @brief Functions to ease creation of animations.
7123 * elm_animator is designed to provide an easy way to create animations.
7124 * Creating an animation with elm_animator is as simple as setting a
7125 * duration, an operating callback and telling it to run the animation.
7126 * However that is not the full extent of elm_animator's ability, animations
7127 * can be paused and resumed, reversed and the animation need not be linear.
7129 * To run an animation you must specify at least a duration and operation
7130 * callback, not setting any other properties will create a linear animation
7131 * that runs once and is not reversed.
7133 * @ref elm_animator_example_page_01 "This" example should make all of that
7136 * @warning elm_animator is @b not a widget.
7140 * @brief Type of curve desired for animation.
7142 * The speed in which an animation happens doesn't have to be linear, some
7143 * animations will look better if they're accelerating or decelerating, so
7144 * elm_animator provides four options in this regard:
7145 * @image html elm_animator_curve_style.png
7146 * @image latex elm_animator_curve_style.eps width=\textwidth
7147 * As can be seen in the image the speed of the animation will be:
7148 * @li ELM_ANIMATOR_CURVE_LINEAR constant
7149 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
7150 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
7151 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
7155 ELM_ANIMATOR_CURVE_LINEAR,
7156 ELM_ANIMATOR_CURVE_IN_OUT,
7157 ELM_ANIMATOR_CURVE_IN,
7158 ELM_ANIMATOR_CURVE_OUT
7159 } Elm_Animator_Curve_Style;
7160 typedef struct _Elm_Animator Elm_Animator;
7162 * Called back per loop of an elementary animators cycle
7163 * @param data user-data given to elm_animator_operation_callback_set()
7164 * @param animator the animator being run
7165 * @param double the position in the animation
7167 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
7169 * Called back when an elementary animator finishes
7170 * @param data user-data given to elm_animator_completion_callback_set()
7172 typedef void (*Elm_Animator_Completion_Cb) (void *data);
7175 * @brief Create a new animator.
7177 * @param[in] parent Parent object
7179 * The @a parent argument can be set to NULL for no parent. If a parent is set
7180 * there is no need to call elm_animator_del(), when the parent is deleted it
7181 * will delete the animator.
7182 * @deprecated Use @ref Transit instead.
7184 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
7186 * Deletes the animator freeing any resources it used. If the animator was
7187 * created with a NULL parent this must be called, otherwise it will be
7188 * automatically called when the parent is deleted.
7190 * @param[in] animator Animator object
7191 * @deprecated Use @ref Transit instead.
7193 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7195 * Set the duration of the animation.
7197 * @param[in] animator Animator object
7198 * @param[in] duration Duration in second
7199 * @deprecated Use @ref Transit instead.
7201 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
7203 * @brief Set the callback function for animator operation.
7205 * @param[in] animator Animator object
7206 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
7207 * @param[in] data Callback function user argument
7209 * The @p func callback will be called with a frame value in range [0, 1] which
7210 * indicates how far along the animation should be. It is the job of @p func to
7211 * actually change the state of any object(or objects) that are being animated.
7212 * @deprecated Use @ref Transit instead.
7214 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
7216 * Set the callback function for the when the animation ends.
7218 * @param[in] animator Animator object
7219 * @param[in] func Callback function pointe
7220 * @param[in] data Callback function user argument
7222 * @warning @a func will not be executed if elm_animator_stop() is called.
7223 * @deprecated Use @ref Transit instead.
7225 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
7227 * @brief Stop animator.
7229 * @param[in] animator Animator object
7231 * If called before elm_animator_animate() it does nothing. If there is an
7232 * animation in progress the animation will be stopped(the operation callback
7233 * will not be executed again) and it can't be restarted using
7234 * elm_animator_resume().
7235 * @deprecated Use @ref Transit instead.
7237 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7239 * Set the animator repeat count.
7241 * @param[in] animator Animator object
7242 * @param[in] repeat_cnt Repeat count
7243 * @deprecated Use @ref Transit instead.
7245 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
7247 * @brief Start animation.
7249 * @param[in] animator Animator object
7251 * This function starts the animation if the nescessary properties(duration
7252 * and operation callback) have been set. Once started the animation will
7253 * run until complete or elm_animator_stop() is called.
7254 * @deprecated Use @ref Transit instead.
7256 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7258 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7260 * @param[in] animator Animator object
7261 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7262 * @deprecated Use @ref Transit instead.
7264 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
7266 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7268 * @param[in] animator Animator object
7269 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7270 * @deprecated Use @ref Transit instead.
7272 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7274 * @brief Sets wether the animation should be automatically reversed.
7276 * @param[in] animator Animator object
7277 * @param[in] reverse Reverse or not
7279 * This controls wether the animation will be run on reverse imediately after
7280 * running forward. When this is set together with repetition the animation
7281 * will run in reverse once for each time it ran forward.@n
7282 * Runnin an animation in reverse is accomplished by calling the operation
7283 * callback with a frame value starting at 1 and diminshing until 0.
7284 * @deprecated Use @ref Transit instead.
7286 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7288 * Gets wether the animation will automatically reversed
7290 * @param[in] animator Animator object
7291 * @deprecated Use @ref Transit instead.
7293 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7295 * Gets the status for the animator operation. The status of the animator @b
7296 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
7297 * only informs if the animation was started and has not ended(either normally
7298 * or through elm_animator_stop()).
7300 * @param[in] animator Animator object
7301 * @deprecated Use @ref Transit instead.
7303 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7305 * Gets how many times the animation will be repeated
7307 * @param[in] animator Animator object
7308 * @deprecated Use @ref Transit instead.
7310 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7312 * Pause the animator.
7314 * @param[in] animator Animator object
7316 * This causes the animation to be temporarily stopped(the operation callback
7317 * will not be called). If the animation is not yet running this is a no-op.
7318 * Once an animation has been paused with this function it can be resumed
7319 * using elm_animator_resume().
7320 * @deprecated Use @ref Transit instead.
7322 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7324 * @brief Resumes the animator.
7326 * @param[in] animator Animator object
7328 * Resumes an animation that was paused using elm_animator_pause(), after
7329 * calling this function calls to the operation callback will happen
7330 * normally. If an animation is stopped by means of elm_animator_stop it
7331 * @b can't be restarted with this function.@n
7333 * @warning When an animation is resumed it doesn't start from where it was paused, it
7334 * will go to where it would have been if it had not been paused. If an
7335 * animation with a duration of 3 seconds is paused after 1 second for 1 second
7336 * it will resume as if it had ben animating for 2 seconds, the operating
7337 * callback will be called with a frame value of aproximately 2/3.
7338 * @deprecated Use @ref Transit instead.
7340 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7346 * @defgroup Calendar Calendar
7347 * @ingroup Elementary
7349 * A calendar is a widget that displays a regular calendar, one
7350 * month at a time, to the user, and can allows the user to select a date.
7352 * It has support to adding check marks (holidays and checks are supported
7353 * by default theme).
7355 * Weekday names and the function used to format month and year to
7356 * be displayed can be set, giving more flexibility to this widget.
7358 * Smart callbacks one can register to:
7359 * - "changed" - emitted when the user selects a day or changes the
7360 * displayed month, what actually changes the selected day as well.
7362 * Available styles for it:
7366 * @li @ref calendar_example_01
7367 * @li @ref calendar_example_02
7368 * @li @ref calendar_example_03
7369 * @li @ref calendar_example_04
7370 * @li @ref calendar_example_05
7371 * @li @ref calendar_example_06
7375 * @addtogroup Calendar
7380 * Event periodicity, used to define if a mark should be repeated
7381 * @b beyond event's day. It's set when a mark is added.
7383 * So, for a mark added to 13th May with periodicity set to WEEKLY,
7384 * there will be marks every week after this date. Marks will be displayed
7385 * at 13th, 20th, 27th, 3rd June ...
7387 * Values don't work as bitmaks, only one can be choosen.
7389 * @see elm_calendar_mark_add()
7393 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
7394 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
7395 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
7396 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*/
7397 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. */
7398 } Elm_Calendar_Mark_Repeat;
7400 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(). */
7403 * Add a new calendar widget to the given parent Elementary
7404 * (container) object.
7406 * @param parent The parent object.
7407 * @return a new calendar widget handle or @c NULL, on errors.
7409 * This function inserts a new calendar widget on the canvas.
7411 * @ref calendar_example_01
7415 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7418 * Get weekdays names displayed by the calendar.
7420 * @param obj The calendar object.
7421 * @return Array of seven strings to be used as weekday names.
7423 * By default, weekdays abbreviations get from system are displayed:
7424 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
7425 * The first string is related to Sunday, the second to Monday...
7427 * @see elm_calendar_weekdays_name_set()
7429 * @ref calendar_example_05
7433 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7436 * Set weekdays names to be displayed by the calendar.
7438 * @param obj The calendar object.
7439 * @param weedays Array of seven strings to be used as weekday names.
7440 * @warning It must have 7 elements, or it will access invalid memory.
7441 * @warning The strings must be NULL terminated ('@\0').
7443 * By default, weekdays abbreviations get from system are displayed:
7444 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
7446 * The first string should be related to Sunday, the second to Monday...
7448 * The usage should be like this:
7450 * const char *weekdays[] =
7452 * "Sunday", "Monday", "Tuesday", "Wednesday",
7453 * "Thursday", "Friday", "Saturday"
7455 * elm_calendar_weekdays_names_set(calendar, weekdays);
7458 * @see elm_calendar_weekdays_name_get()
7460 * @ref calendar_example_02
7464 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
7467 * Set the minimum and maximum values for the year
7469 * @param obj The calendar object
7470 * @param min The minimum year, greater than 1901;
7471 * @param max The maximum year;
7473 * Maximum must be greater than minimum, except if you don't wan't to set
7475 * Default values are 1902 and -1.
7477 * If the maximum year is a negative value, it will be limited depending
7478 * on the platform architecture (year 2037 for 32 bits);
7480 * @see elm_calendar_min_max_year_get()
7482 * @ref calendar_example_03
7486 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
7489 * Get the minimum and maximum values for the year
7491 * @param obj The calendar object.
7492 * @param min The minimum year.
7493 * @param max The maximum year.
7495 * Default values are 1902 and -1.
7497 * @see elm_calendar_min_max_year_get() for more details.
7499 * @ref calendar_example_05
7503 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
7506 * Enable or disable day selection
7508 * @param obj The calendar object.
7509 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
7512 * Enabled by default. If disabled, the user still can select months,
7513 * but not days. Selected days are highlighted on calendar.
7514 * It should be used if you won't need such selection for the widget usage.
7516 * When a day is selected, or month is changed, smart callbacks for
7517 * signal "changed" will be called.
7519 * @see elm_calendar_day_selection_enable_get()
7521 * @ref calendar_example_04
7525 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7528 * Get a value whether day selection is enabled or not.
7530 * @see elm_calendar_day_selection_enable_set() for details.
7532 * @param obj The calendar object.
7533 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
7534 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
7536 * @ref calendar_example_05
7540 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7544 * Set selected date to be highlighted on calendar.
7546 * @param obj The calendar object.
7547 * @param selected_time A @b tm struct to represent the selected date.
7549 * Set the selected date, changing the displayed month if needed.
7550 * Selected date changes when the user goes to next/previous month or
7551 * select a day pressing over it on calendar.
7553 * @see elm_calendar_selected_time_get()
7555 * @ref calendar_example_04
7559 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
7562 * Get selected date.
7564 * @param obj The calendar object
7565 * @param selected_time A @b tm struct to point to selected date
7566 * @return EINA_FALSE means an error ocurred and returned time shouldn't
7569 * Get date selected by the user or set by function
7570 * elm_calendar_selected_time_set().
7571 * Selected date changes when the user goes to next/previous month or
7572 * select a day pressing over it on calendar.
7574 * @see elm_calendar_selected_time_get()
7576 * @ref calendar_example_05
7580 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
7583 * Set a function to format the string that will be used to display
7586 * @param obj The calendar object
7587 * @param format_function Function to set the month-year string given
7590 * By default it uses strftime with "%B %Y" format string.
7591 * It should allocate the memory that will be used by the string,
7592 * that will be freed by the widget after usage.
7593 * A pointer to the string and a pointer to the time struct will be provided.
7598 * _format_month_year(struct tm *selected_time)
7601 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
7602 * return strdup(buf);
7605 * elm_calendar_format_function_set(calendar, _format_month_year);
7608 * @ref calendar_example_02
7612 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
7615 * Add a new mark to the calendar
7617 * @param obj The calendar object
7618 * @param mark_type A string used to define the type of mark. It will be
7619 * emitted to the theme, that should display a related modification on these
7620 * days representation.
7621 * @param mark_time A time struct to represent the date of inclusion of the
7622 * mark. For marks that repeats it will just be displayed after the inclusion
7623 * date in the calendar.
7624 * @param repeat Repeat the event following this periodicity. Can be a unique
7625 * mark (that don't repeat), daily, weekly, monthly or annually.
7626 * @return The created mark or @NULL upon failure.
7628 * Add a mark that will be drawn in the calendar respecting the insertion
7629 * time and periodicity. It will emit the type as signal to the widget theme.
7630 * Default theme supports "holiday" and "checked", but it can be extended.
7632 * It won't immediately update the calendar, drawing the marks.
7633 * For this, call elm_calendar_marks_draw(). However, when user selects
7634 * next or previous month calendar forces marks drawn.
7636 * Marks created with this method can be deleted with
7637 * elm_calendar_mark_del().
7641 * struct tm selected_time;
7642 * time_t current_time;
7644 * current_time = time(NULL) + 5 * 84600;
7645 * localtime_r(¤t_time, &selected_time);
7646 * elm_calendar_mark_add(cal, "holiday", selected_time,
7647 * ELM_CALENDAR_ANNUALLY);
7649 * current_time = time(NULL) + 1 * 84600;
7650 * localtime_r(¤t_time, &selected_time);
7651 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
7653 * elm_calendar_marks_draw(cal);
7656 * @see elm_calendar_marks_draw()
7657 * @see elm_calendar_mark_del()
7659 * @ref calendar_example_06
7663 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);
7666 * Delete mark from the calendar.
7668 * @param mark The mark to be deleted.
7670 * If deleting all calendar marks is required, elm_calendar_marks_clear()
7671 * should be used instead of getting marks list and deleting each one.
7673 * @see elm_calendar_mark_add()
7675 * @ref calendar_example_06
7679 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
7682 * Remove all calendar's marks
7684 * @param obj The calendar object.
7686 * @see elm_calendar_mark_add()
7687 * @see elm_calendar_mark_del()
7691 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7695 * Get a list of all the calendar marks.
7697 * @param obj The calendar object.
7698 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
7700 * @see elm_calendar_mark_add()
7701 * @see elm_calendar_mark_del()
7702 * @see elm_calendar_marks_clear()
7706 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7709 * Draw calendar marks.
7711 * @param obj The calendar object.
7713 * Should be used after adding, removing or clearing marks.
7714 * It will go through the entire marks list updating the calendar.
7715 * If lots of marks will be added, add all the marks and then call
7718 * When the month is changed, i.e. user selects next or previous month,
7719 * marks will be drawed.
7721 * @see elm_calendar_mark_add()
7722 * @see elm_calendar_mark_del()
7723 * @see elm_calendar_marks_clear()
7725 * @ref calendar_example_06
7729 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
7732 * Set a day text color to the same that represents Saturdays.
7734 * @param obj The calendar object.
7735 * @param pos The text position. Position is the cell counter, from left
7736 * to right, up to down. It starts on 0 and ends on 41.
7738 * @deprecated use elm_calendar_mark_add() instead like:
7741 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
7742 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
7745 * @see elm_calendar_mark_add()
7749 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7752 * Set a day text color to the same that represents Sundays.
7754 * @param obj The calendar object.
7755 * @param pos The text position. Position is the cell counter, from left
7756 * to right, up to down. It starts on 0 and ends on 41.
7758 * @deprecated use elm_calendar_mark_add() instead like:
7761 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
7762 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
7765 * @see elm_calendar_mark_add()
7769 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7772 * Set a day text color to the same that represents Weekdays.
7774 * @param obj The calendar object
7775 * @param pos The text position. Position is the cell counter, from left
7776 * to right, up to down. It starts on 0 and ends on 41.
7778 * @deprecated use elm_calendar_mark_add() instead like:
7781 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
7783 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
7784 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
7785 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
7786 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
7787 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
7788 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
7789 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
7790 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
7791 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
7794 * @see elm_calendar_mark_add()
7798 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7801 * Set the interval on time updates for an user mouse button hold
7802 * on calendar widgets' month selection.
7804 * @param obj The calendar object
7805 * @param interval The (first) interval value in seconds
7807 * This interval value is @b decreased while the user holds the
7808 * mouse pointer either selecting next or previous month.
7810 * This helps the user to get to a given month distant from the
7811 * current one easier/faster, as it will start to change quicker and
7812 * quicker on mouse button holds.
7814 * The calculation for the next change interval value, starting from
7815 * the one set with this call, is the previous interval divided by
7816 * 1.05, so it decreases a little bit.
7818 * The default starting interval value for automatic changes is
7821 * @see elm_calendar_interval_get()
7825 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7828 * Get the interval on time updates for an user mouse button hold
7829 * on calendar widgets' month selection.
7831 * @param obj The calendar object
7832 * @return The (first) interval value, in seconds, set on it
7834 * @see elm_calendar_interval_set() for more details
7838 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7845 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
7847 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7848 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7849 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
7850 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7851 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7852 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7853 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7854 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7855 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7856 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);
7857 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7858 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7859 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7860 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);
7861 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7862 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7863 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7864 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7865 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7866 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7867 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7868 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7869 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7870 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7871 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7872 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7873 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7874 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7875 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
7876 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);
7877 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7878 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7879 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7880 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7881 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7882 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7883 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7884 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7885 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7886 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7887 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
7888 /* smart callbacks called:
7889 * "selected" - when item is selected (scroller stops)
7893 * @page tutorial_colorselector Color selector example
7894 * @dontinclude colorselector_example_01.c
7896 * This example shows how to change the color of a rectangle using a color
7897 * selector. We aren't going to explain a lot of the code since it's the
7901 * Now that we have a window with background and a rectangle we can create
7902 * our color_selector and set it's initial color to fully opaque blue:
7905 * Next we tell ask to be notified whenever the color changes:
7908 * We follow that we some more run of the mill setup code:
7911 * And now get to the callback that sets the color of the rectangle:
7914 * This example will look like this:
7915 * @image html screenshots/colorselector_example_01.png
7916 * @image latex screenshots/colorselector_example_01.eps
7918 * @example colorselector_example_01.c
7921 * @defgroup Colorselector Colorselector
7925 * @brief Widget for user to select a color.
7927 * Signals that you can add callbacks for are:
7928 * "changed" - When the color value changes(event_info is NULL).
7930 * See @ref tutorial_colorselector.
7933 * @brief Add a new colorselector to the parent
7935 * @param parent The parent object
7936 * @return The new object or NULL if it cannot be created
7938 * @ingroup Colorselector
7940 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7942 * Set a color for the colorselector
7944 * @param obj Colorselector object
7945 * @param r r-value of color
7946 * @param g g-value of color
7947 * @param b b-value of color
7948 * @param a a-value of color
7950 * @ingroup Colorselector
7952 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7954 * Get a color from the colorselector
7956 * @param obj Colorselector object
7957 * @param r integer pointer for r-value of color
7958 * @param g integer pointer for g-value of color
7959 * @param b integer pointer for b-value of color
7960 * @param a integer pointer for a-value of color
7962 * @ingroup Colorselector
7964 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7969 /* Contextual Popup */
7970 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7972 typedef enum _Elm_Ctxpopup_Direction
7974 ELM_CTXPOPUP_DIRECTION_DOWN,
7975 ELM_CTXPOPUP_DIRECTION_RIGHT,
7976 ELM_CTXPOPUP_DIRECTION_LEFT,
7977 ELM_CTXPOPUP_DIRECTION_UP,
7978 } Elm_Ctxpopup_Direction;
7980 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7981 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7982 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7983 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7984 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7985 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7986 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7987 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7988 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7989 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7990 Elm_Ctxpopup_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);
7991 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7992 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7993 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7994 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7995 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7996 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);
7997 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);
7998 /* smart callbacks called:
7999 * "dismissed" - the ctxpopup was dismissed
8005 * @defgroup Transit Transit
8006 * @ingroup Elementary
8008 * Transit is designed to apply various animated transition effects to @c
8009 * Evas_Object, such like translation, rotation, etc. For using these
8010 * effects, create an @ref Elm_Transit and add the desired transition effects.
8012 * Once the effects are added into transit, they will be automatically
8013 * managed (their callback will be called until the duration is ended, and
8014 * they will be deleted on completion).
8018 * Elm_Transit *trans = elm_transit_add();
8019 * elm_transit_object_add(trans, obj);
8020 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
8021 * elm_transit_duration_set(transit, 1);
8022 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
8023 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
8024 * elm_transit_repeat_times_set(transit, 3);
8027 * Some transition effects are used to change the properties of objects. They
8029 * @li @ref elm_transit_effect_translation_add
8030 * @li @ref elm_transit_effect_color_add
8031 * @li @ref elm_transit_effect_rotation_add
8032 * @li @ref elm_transit_effect_wipe_add
8033 * @li @ref elm_transit_effect_zoom_add
8034 * @li @ref elm_transit_effect_resizing_add
8036 * Other transition effects are used to make one object disappear and another
8037 * object appear on its old place. These effects are:
8039 * @li @ref elm_transit_effect_flip_add
8040 * @li @ref elm_transit_effect_resizable_flip_add
8041 * @li @ref elm_transit_effect_fade_add
8042 * @li @ref elm_transit_effect_blend_add
8044 * It's also possible to make a transition chain with @ref
8045 * elm_transit_chain_transit_add.
8047 * @warning We strongly recommend to use elm_transit just when edje can not do
8048 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
8049 * animations can be manipulated inside the theme.
8052 * @li @ref transit_example_01_explained
8053 * @li @ref transit_example_02_explained
8054 * @li @ref transit_example_03_c
8055 * @li @ref transit_example_04_c
8061 * @enum Elm_Transit_Tween_Mode
8063 * The type of acceleration used in the transition.
8067 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
8068 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
8069 over time, then decrease again
8071 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
8073 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
8075 } Elm_Transit_Tween_Mode;
8078 * @enum Elm_Transit_Effect_Flip_Axis
8080 * The axis where flip effect should be applied.
8084 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
8085 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
8086 } Elm_Transit_Effect_Flip_Axis;
8088 * @enum Elm_Transit_Effect_Wipe_Dir
8090 * The direction where the wipe effect should occur.
8094 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
8095 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
8096 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
8097 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
8098 } Elm_Transit_Effect_Wipe_Dir;
8099 /** @enum Elm_Transit_Effect_Wipe_Type
8101 * Whether the wipe effect should show or hide the object.
8105 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
8107 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
8109 } Elm_Transit_Effect_Wipe_Type;
8112 * @typedef Elm_Transit
8114 * The Transit created with elm_transit_add(). This type has the information
8115 * about the objects which the transition will be applied, and the
8116 * transition effects that will be used. It also contains info about
8117 * duration, number of repetitions, auto-reverse, etc.
8119 typedef struct _Elm_Transit Elm_Transit;
8120 typedef void Elm_Transit_Effect;
8122 * @typedef Elm_Transit_Effect_Transition_Cb
8124 * Transition callback called for this effect on each transition iteration.
8126 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
8128 * Elm_Transit_Effect_End_Cb
8130 * Transition callback called for this effect when the transition is over.
8132 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
8135 * Elm_Transit_Del_Cb
8137 * A callback called when the transit is deleted.
8139 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
8144 * @note Is not necessary to delete the transit object, it will be deleted at
8145 * the end of its operation.
8146 * @note The transit will start playing when the program enter in the main loop, is not
8147 * necessary to give a start to the transit.
8149 * @return The transit object.
8153 EAPI Elm_Transit *elm_transit_add(void);
8156 * Stops the animation and delete the @p transit object.
8158 * Call this function if you wants to stop the animation before the duration
8159 * time. Make sure the @p transit object is still alive with
8160 * elm_transit_del_cb_set() function.
8161 * All added effects will be deleted, calling its repective data_free_cb
8162 * functions. The function setted by elm_transit_del_cb_set() will be called.
8164 * @see elm_transit_del_cb_set()
8166 * @param transit The transit object to be deleted.
8169 * @warning Just call this function if you are sure the transit is alive.
8171 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
8174 * Add a new effect to the transit.
8176 * @note The cb function and the data are the key to the effect. If you try to
8177 * add an already added effect, nothing is done.
8178 * @note After the first addition of an effect in @p transit, if its
8179 * effect list become empty again, the @p transit will be killed by
8180 * elm_transit_del(transit) function.
8184 * Elm_Transit *transit = elm_transit_add();
8185 * elm_transit_effect_add(transit,
8186 * elm_transit_effect_blend_op,
8187 * elm_transit_effect_blend_context_new(),
8188 * elm_transit_effect_blend_context_free);
8191 * @param transit The transit object.
8192 * @param transition_cb The operation function. It is called when the
8193 * animation begins, it is the function that actually performs the animation.
8194 * It is called with the @p data, @p transit and the time progression of the
8195 * animation (a double value between 0.0 and 1.0).
8196 * @param effect The context data of the effect.
8197 * @param end_cb The function to free the context data, it will be called
8198 * at the end of the effect, it must finalize the animation and free the
8202 * @warning The transit free the context data at the and of the transition with
8203 * the data_free_cb function, do not use the context data in another transit.
8205 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);
8208 * Delete an added effect.
8210 * This function will remove the effect from the @p transit, calling the
8211 * data_free_cb to free the @p data.
8213 * @see elm_transit_effect_add()
8215 * @note If the effect is not found, nothing is done.
8216 * @note If the effect list become empty, this function will call
8217 * elm_transit_del(transit), that is, it will kill the @p transit.
8219 * @param transit The transit object.
8220 * @param transition_cb The operation function.
8221 * @param effect The context data of the effect.
8225 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);
8228 * Add new object to apply the effects.
8230 * @note After the first addition of an object in @p transit, if its
8231 * object list become empty again, the @p transit will be killed by
8232 * elm_transit_del(transit) function.
8233 * @note If the @p obj belongs to another transit, the @p obj will be
8234 * removed from it and it will only belong to the @p transit. If the old
8235 * transit stays without objects, it will die.
8236 * @note When you add an object into the @p transit, its state from
8237 * evas_object_pass_events_get(obj) is saved, and it is applied when the
8238 * transit ends, if you change this state whith evas_object_pass_events_set()
8239 * after add the object, this state will change again when @p transit stops to
8242 * @param transit The transit object.
8243 * @param obj Object to be animated.
8246 * @warning It is not allowed to add a new object after transit begins to go.
8248 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
8251 * Removes an added object from the transit.
8253 * @note If the @p obj is not in the @p transit, nothing is done.
8254 * @note If the list become empty, this function will call
8255 * elm_transit_del(transit), that is, it will kill the @p transit.
8257 * @param transit The transit object.
8258 * @param obj Object to be removed from @p transit.
8261 * @warning It is not allowed to remove objects after transit begins to go.
8263 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
8266 * Get the objects of the transit.
8268 * @param transit The transit object.
8269 * @return a Eina_List with the objects from the transit.
8273 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8276 * Enable/disable keeping up the objects states.
8277 * If it is not kept, the objects states will be reset when transition ends.
8279 * @note @p transit can not be NULL.
8280 * @note One state includes geometry, color, map data.
8282 * @param transit The transit object.
8283 * @param state_keep Keeping or Non Keeping.
8287 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
8290 * Get a value whether the objects states will be reset or not.
8292 * @note @p transit can not be NULL
8294 * @see elm_transit_objects_final_state_keep_set()
8296 * @param transit The transit object.
8297 * @return EINA_TRUE means the states of the objects will be reset.
8298 * If @p transit is NULL, EINA_FALSE is returned
8302 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8305 * Set the event enabled when transit is operating.
8307 * If @p enabled is EINA_TRUE, the objects of the transit will receives
8308 * events from mouse and keyboard during the animation.
8309 * @note When you add an object with elm_transit_object_add(), its state from
8310 * evas_object_pass_events_get(obj) is saved, and it is applied when the
8311 * transit ends, if you change this state with evas_object_pass_events_set()
8312 * after adding the object, this state will change again when @p transit stops
8315 * @param transit The transit object.
8316 * @param enabled Events are received when enabled is @c EINA_TRUE, and
8317 * ignored otherwise.
8321 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
8324 * Get the value of event enabled status.
8326 * @see elm_transit_event_enabled_set()
8328 * @param transit The Transit object
8329 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
8330 * EINA_FALSE is returned
8334 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8337 * Set the user-callback function when the transit is deleted.
8339 * @note Using this function twice will overwrite the first function setted.
8340 * @note the @p transit object will be deleted after call @p cb function.
8342 * @param transit The transit object.
8343 * @param cb Callback function pointer. This function will be called before
8344 * the deletion of the transit.
8345 * @param data Callback funtion user data. It is the @p op parameter.
8349 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
8352 * Set reverse effect automatically.
8354 * If auto reverse is setted, after running the effects with the progress
8355 * parameter from 0 to 1, it will call the effecs again with the progress
8356 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
8357 * where the duration was setted with the function elm_transit_add and
8358 * the repeat with the function elm_transit_repeat_times_set().
8360 * @param transit The transit object.
8361 * @param reverse EINA_TRUE means the auto_reverse is on.
8365 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
8368 * Get if the auto reverse is on.
8370 * @see elm_transit_auto_reverse_set()
8372 * @param transit The transit object.
8373 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
8374 * EINA_FALSE is returned
8378 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8381 * Set the transit repeat count. Effect will be repeated by repeat count.
8383 * This function sets the number of repetition the transit will run after
8384 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
8385 * If the @p repeat is a negative number, it will repeat infinite times.
8387 * @note If this function is called during the transit execution, the transit
8388 * will run @p repeat times, ignoring the times it already performed.
8390 * @param transit The transit object
8391 * @param repeat Repeat count
8395 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
8398 * Get the transit repeat count.
8400 * @see elm_transit_repeat_times_set()
8402 * @param transit The Transit object.
8403 * @return The repeat count. If @p transit is NULL
8408 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8411 * Set the transit animation acceleration type.
8413 * This function sets the tween mode of the transit that can be:
8414 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
8415 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
8416 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
8417 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
8419 * @param transit The transit object.
8420 * @param tween_mode The tween type.
8424 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
8427 * Get the transit animation acceleration type.
8429 * @note @p transit can not be NULL
8431 * @param transit The transit object.
8432 * @return The tween type. If @p transit is NULL
8433 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
8437 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8440 * Set the transit animation time
8442 * @note @p transit can not be NULL
8444 * @param transit The transit object.
8445 * @param duration The animation time.
8449 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
8452 * Get the transit animation time
8454 * @note @p transit can not be NULL
8456 * @param transit The transit object.
8458 * @return The transit animation time.
8462 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8465 * Starts the transition.
8466 * Once this API is called, the transit begins to measure the time.
8468 * @note @p transit can not be NULL
8470 * @param transit The transit object.
8474 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
8477 * Pause/Resume the transition.
8479 * If you call elm_transit_go again, the transit will be started from the
8480 * beginning, and will be unpaused.
8482 * @note @p transit can not be NULL
8484 * @param transit The transit object.
8485 * @param paused Whether the transition should be paused or not.
8489 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
8492 * Get the value of paused status.
8494 * @see elm_transit_paused_set()
8496 * @note @p transit can not be NULL
8498 * @param transit The transit object.
8499 * @return EINA_TRUE means transition is paused. If @p transit is NULL
8500 * EINA_FALSE is returned
8504 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8507 * Get the time progression of the animation (a double value between 0.0 and 1.0).
8509 * The value returned is a fraction (current time / total time). It
8510 * represents the progression position relative to the total.
8512 * @note @p transit can not be NULL
8514 * @param transit The transit object.
8516 * @return The time progression value. If @p transit is NULL
8521 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8524 * Makes the chain relationship between two transits.
8526 * @note @p transit can not be NULL. Transit would have multiple chain transits.
8527 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
8529 * @param transit The transit object.
8530 * @param chain_transit The chain transit object. This transit will be operated
8531 * after transit is done.
8533 * This function adds @p chain_transit transition to a chain after the @p
8534 * transit, and will be started as soon as @p transit ends. See @ref
8535 * transit_example_02_explained for a full example.
8539 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
8542 * Cut off the chain relationship between two transits.
8544 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
8545 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
8547 * @param transit The transit object.
8548 * @param chain_transit The chain transit object.
8550 * This function remove the @p chain_transit transition from the @p transit.
8554 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
8557 * Get the current chain transit list.
8559 * @note @p transit can not be NULL.
8561 * @param transit The transit object.
8562 * @return chain transit list.
8566 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
8569 * Add the Resizing Effect to Elm_Transit.
8571 * @note This API is one of the facades. It creates resizing effect context
8572 * and add it's required APIs to elm_transit_effect_add.
8574 * @see elm_transit_effect_add()
8576 * @param transit Transit object.
8577 * @param from_w Object width size when effect begins.
8578 * @param from_h Object height size when effect begins.
8579 * @param to_w Object width size when effect ends.
8580 * @param to_h Object height size when effect ends.
8581 * @return Resizing effect context data.
8585 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);
8588 * Add the Translation Effect to Elm_Transit.
8590 * @note This API is one of the facades. It creates translation effect context
8591 * and add it's required APIs to elm_transit_effect_add.
8593 * @see elm_transit_effect_add()
8595 * @param transit Transit object.
8596 * @param from_dx X Position variation when effect begins.
8597 * @param from_dy Y Position variation when effect begins.
8598 * @param to_dx X Position variation when effect ends.
8599 * @param to_dy Y Position variation when effect ends.
8600 * @return Translation effect context data.
8603 * @warning It is highly recommended just create a transit with this effect when
8604 * the window that the objects of the transit belongs has already been created.
8605 * This is because this effect needs the geometry information about the objects,
8606 * and if the window was not created yet, it can get a wrong information.
8608 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);
8611 * Add the Zoom Effect to Elm_Transit.
8613 * @note This API is one of the facades. It creates zoom effect context
8614 * and add it's required APIs to elm_transit_effect_add.
8616 * @see elm_transit_effect_add()
8618 * @param transit Transit object.
8619 * @param from_rate Scale rate when effect begins (1 is current rate).
8620 * @param to_rate Scale rate when effect ends.
8621 * @return Zoom effect context data.
8624 * @warning It is highly recommended just create a transit with this effect when
8625 * the window that the objects of the transit belongs has already been created.
8626 * This is because this effect needs the geometry information about the objects,
8627 * and if the window was not created yet, it can get a wrong information.
8629 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
8632 * Add the Flip Effect to Elm_Transit.
8634 * @note This API is one of the facades. It creates flip effect context
8635 * and add it's required APIs to elm_transit_effect_add.
8636 * @note This effect is applied to each pair of objects in the order they are listed
8637 * in the transit list of objects. The first object in the pair will be the
8638 * "front" object and the second will be the "back" object.
8640 * @see elm_transit_effect_add()
8642 * @param transit Transit object.
8643 * @param axis Flipping Axis(X or Y).
8644 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8645 * @return Flip effect context data.
8648 * @warning It is highly recommended just create a transit with this effect when
8649 * the window that the objects of the transit belongs has already been created.
8650 * This is because this effect needs the geometry information about the objects,
8651 * and if the window was not created yet, it can get a wrong information.
8653 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8656 * Add the Resizable Flip Effect to Elm_Transit.
8658 * @note This API is one of the facades. It creates resizable flip effect context
8659 * and add it's required APIs to elm_transit_effect_add.
8660 * @note This effect is applied to each pair of objects in the order they are listed
8661 * in the transit list of objects. The first object in the pair will be the
8662 * "front" object and the second will be the "back" object.
8664 * @see elm_transit_effect_add()
8666 * @param transit Transit object.
8667 * @param axis Flipping Axis(X or Y).
8668 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8669 * @return Resizable flip effect context data.
8672 * @warning It is highly recommended just create a transit with this effect when
8673 * the window that the objects of the transit belongs has already been created.
8674 * This is because this effect needs the geometry information about the objects,
8675 * and if the window was not created yet, it can get a wrong information.
8677 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8680 * Add the Wipe Effect to Elm_Transit.
8682 * @note This API is one of the facades. It creates wipe effect context
8683 * and add it's required APIs to elm_transit_effect_add.
8685 * @see elm_transit_effect_add()
8687 * @param transit Transit object.
8688 * @param type Wipe type. Hide or show.
8689 * @param dir Wipe Direction.
8690 * @return Wipe effect context data.
8693 * @warning It is highly recommended just create a transit with this effect when
8694 * the window that the objects of the transit belongs has already been created.
8695 * This is because this effect needs the geometry information about the objects,
8696 * and if the window was not created yet, it can get a wrong information.
8698 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
8701 * Add the Color Effect to Elm_Transit.
8703 * @note This API is one of the facades. It creates color effect context
8704 * and add it's required APIs to elm_transit_effect_add.
8706 * @see elm_transit_effect_add()
8708 * @param transit Transit object.
8709 * @param from_r RGB R when effect begins.
8710 * @param from_g RGB G when effect begins.
8711 * @param from_b RGB B when effect begins.
8712 * @param from_a RGB A when effect begins.
8713 * @param to_r RGB R when effect ends.
8714 * @param to_g RGB G when effect ends.
8715 * @param to_b RGB B when effect ends.
8716 * @param to_a RGB A when effect ends.
8717 * @return Color effect context data.
8721 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);
8724 * Add the Fade Effect to Elm_Transit.
8726 * @note This API is one of the facades. It creates fade effect context
8727 * and add it's required APIs to elm_transit_effect_add.
8728 * @note This effect is applied to each pair of objects in the order they are listed
8729 * in the transit list of objects. The first object in the pair will be the
8730 * "before" object and the second will be the "after" object.
8732 * @see elm_transit_effect_add()
8734 * @param transit Transit object.
8735 * @return Fade effect context data.
8738 * @warning It is highly recommended just create a transit with this effect when
8739 * the window that the objects of the transit belongs has already been created.
8740 * This is because this effect needs the color information about the objects,
8741 * and if the window was not created yet, it can get a wrong information.
8743 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
8746 * Add the Blend Effect to Elm_Transit.
8748 * @note This API is one of the facades. It creates blend effect context
8749 * and add it's required APIs to elm_transit_effect_add.
8750 * @note This effect is applied to each pair of objects in the order they are listed
8751 * in the transit list of objects. The first object in the pair will be the
8752 * "before" object and the second will be the "after" object.
8754 * @see elm_transit_effect_add()
8756 * @param transit Transit object.
8757 * @return Blend effect context data.
8760 * @warning It is highly recommended just create a transit with this effect when
8761 * the window that the objects of the transit belongs has already been created.
8762 * This is because this effect needs the color information about the objects,
8763 * and if the window was not created yet, it can get a wrong information.
8765 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
8768 * Add the Rotation Effect to Elm_Transit.
8770 * @note This API is one of the facades. It creates rotation effect context
8771 * and add it's required APIs to elm_transit_effect_add.
8773 * @see elm_transit_effect_add()
8775 * @param transit Transit object.
8776 * @param from_degree Degree when effect begins.
8777 * @param to_degree Degree when effect is ends.
8778 * @return Rotation effect context data.
8781 * @warning It is highly recommended just create a transit with this effect when
8782 * the window that the objects of the transit belongs has already been created.
8783 * This is because this effect needs the geometry information about the objects,
8784 * and if the window was not created yet, it can get a wrong information.
8786 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
8789 * Add the ImageAnimation Effect to Elm_Transit.
8791 * @note This API is one of the facades. It creates image animation effect context
8792 * and add it's required APIs to elm_transit_effect_add.
8793 * The @p images parameter is a list images paths. This list and
8794 * its contents will be deleted at the end of the effect by
8795 * elm_transit_effect_image_animation_context_free() function.
8799 * char buf[PATH_MAX];
8800 * Eina_List *images = NULL;
8801 * Elm_Transit *transi = elm_transit_add();
8803 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
8804 * images = eina_list_append(images, eina_stringshare_add(buf));
8806 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
8807 * images = eina_list_append(images, eina_stringshare_add(buf));
8808 * elm_transit_effect_image_animation_add(transi, images);
8812 * @see elm_transit_effect_add()
8814 * @param transit Transit object.
8815 * @param images Eina_List of images file paths. This list and
8816 * its contents will be deleted at the end of the effect by
8817 * elm_transit_effect_image_animation_context_free() function.
8818 * @return Image Animation effect context data.
8822 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
8827 typedef struct _Elm_Store Elm_Store;
8828 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
8829 typedef struct _Elm_Store_Item Elm_Store_Item;
8830 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
8831 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
8832 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
8833 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
8834 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
8835 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
8836 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
8837 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
8839 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
8840 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
8841 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
8842 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
8846 ELM_STORE_ITEM_MAPPING_NONE = 0,
8847 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
8848 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
8849 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
8850 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
8851 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
8852 // can add more here as needed by common apps
8853 ELM_STORE_ITEM_MAPPING_LAST
8854 } Elm_Store_Item_Mapping_Type;
8856 struct _Elm_Store_Item_Mapping_Icon
8858 // FIXME: allow edje file icons
8860 Elm_Icon_Lookup_Order lookup_order;
8861 Eina_Bool standard_name : 1;
8862 Eina_Bool no_scale : 1;
8863 Eina_Bool smooth : 1;
8864 Eina_Bool scale_up : 1;
8865 Eina_Bool scale_down : 1;
8868 struct _Elm_Store_Item_Mapping_Empty
8873 struct _Elm_Store_Item_Mapping_Photo
8878 struct _Elm_Store_Item_Mapping_Custom
8880 Elm_Store_Item_Mapping_Cb func;
8883 struct _Elm_Store_Item_Mapping
8885 Elm_Store_Item_Mapping_Type type;
8890 Elm_Store_Item_Mapping_Empty empty;
8891 Elm_Store_Item_Mapping_Icon icon;
8892 Elm_Store_Item_Mapping_Photo photo;
8893 Elm_Store_Item_Mapping_Custom custom;
8894 // add more types here
8898 struct _Elm_Store_Item_Info
8900 Elm_Genlist_Item_Class *item_class;
8901 const Elm_Store_Item_Mapping *mapping;
8906 struct _Elm_Store_Item_Info_Filesystem
8908 Elm_Store_Item_Info base;
8912 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
8913 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
8915 EAPI void elm_store_free(Elm_Store *st);
8917 EAPI Elm_Store *elm_store_filesystem_new(void);
8918 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8919 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8920 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8922 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8924 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8925 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8926 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8927 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8928 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8929 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8931 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8932 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8933 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8934 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8935 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8936 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8937 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8939 /* SegmentControl */
8940 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8941 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8942 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8943 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);
8944 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8945 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8946 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8947 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8948 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8949 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8950 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8951 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8952 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8953 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8954 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8955 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8956 /* smart callbacks called:
8957 * "changed" -when the user clicks on a segment item which is not previously
8958 * selected and get selected. The event_info parameter is the
8959 * segment item index.
8962 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8963 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8964 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8965 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8966 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8967 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8968 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8969 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8971 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8972 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8974 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8975 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8976 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8977 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8978 EAPI void elm_video_play(Evas_Object *video);
8979 EAPI void elm_video_pause(Evas_Object *video);
8980 EAPI void elm_video_stop(Evas_Object *video);
8981 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8982 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8983 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8984 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8985 EAPI double elm_video_audio_level_get(Evas_Object *video);
8986 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8987 EAPI double elm_video_play_position_get(Evas_Object *video);
8988 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8989 EAPI double elm_video_play_length_get(Evas_Object *video);
8990 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8991 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8992 EAPI const char *elm_video_title_get(Evas_Object *video);
8994 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8995 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8998 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
9002 ELM_NAVIFRAME_PREV_BUTTON,
9003 ELM_NAVIFRAME_NEXT_BUTTON
9004 } Elm_Naviframe_Button_Type;
9006 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9007 EAPI Elm_Naviframe_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);
9008 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
9009 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
9010 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9011 EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
9012 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
9013 EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
9014 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
9015 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
9016 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
9017 EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9018 EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9019 EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
9020 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
9021 EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
9022 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
9023 EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
9024 EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
9025 EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
9026 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);