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 graphmes */
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_label_set(Evas_Object *obj, const char *item, const char *label);
692 #define elm_object_text_set(obj, label) elm_object_label_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_label_get(const Evas_Object *obj, const char *item);
708 #define elm_object_text_get(obj) elm_object_label_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 typedef enum _Elm_Image_Orient
1864 ELM_IMAGE_ORIENT_NONE,
1865 ELM_IMAGE_ROTATE_90_CW,
1866 ELM_IMAGE_ROTATE_180_CW,
1867 ELM_IMAGE_ROTATE_90_CCW,
1868 ELM_IMAGE_FLIP_HORIZONTAL,
1869 ELM_IMAGE_FLIP_VERTICAL,
1870 ELM_IMAGE_FLIP_TRANSPOSE,
1871 ELM_IMAGE_FLIP_TRANSVERSE
1873 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1874 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1875 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1876 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1877 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1878 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1879 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1880 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1881 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1882 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1883 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1884 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1885 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1886 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1887 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
1888 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1889 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
1890 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1891 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1892 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
1893 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1895 /* smart callbacks called:
1896 * "clicked" - the user clicked the image
1900 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
1902 typedef enum _Elm_GLView_Mode
1904 ELM_GLVIEW_ALPHA = 1,
1905 ELM_GLVIEW_DEPTH = 2,
1906 ELM_GLVIEW_STENCIL = 4
1910 * Defines a policy for the glview resizing.
1912 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
1914 typedef enum _Elm_GLView_Resize_Policy
1916 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
1917 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
1918 } Elm_GLView_Resize_Policy;
1920 typedef enum _Elm_GLView_Render_Policy
1922 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
1923 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
1924 } Elm_GLView_Render_Policy;
1927 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1928 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1929 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1930 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1931 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
1932 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
1933 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
1934 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1935 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1936 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1937 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1938 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1944 * A box arranges objects in a linear fashion, governed by a layout function
1945 * that defines the details of this arrangement.
1947 * By default, the box will use an internal function to set the layout to
1948 * a single row, either vertical or horizontal. This layout is affected
1949 * by a number of parameters, such as the homogeneous flag set by
1950 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
1951 * elm_box_align_set() and the hints set to each object in the box.
1953 * For this default layout, it's possible to change the orientation with
1954 * elm_box_horizontal_set(). The box will start in the vertical orientation,
1955 * placing its elements ordered from top to bottom. When horizontal is set,
1956 * the order will go from left to right. If the box is set to be
1957 * homogeneous, every object in it will be assigned the same space, that
1958 * of the largest object. Padding can be used to set some spacing between
1959 * the cell given to each object. The alignment of the box, set with
1960 * elm_box_align_set(), determines how the bounding box of all the elements
1961 * will be placed within the space given to the box widget itself.
1963 * The size hints of each object also affect how they are placed and sized
1964 * within the box. evas_object_size_hint_min_set() will give the minimum
1965 * size the object can have, and the box will use it as the basis for all
1966 * latter calculations. Elementary widgets set their own minimum size as
1967 * needed, so there's rarely any need to use it manually.
1969 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
1970 * used to tell whether the object will be allocated the minimum size it
1971 * needs or if the space given to it should be expanded. It's important
1972 * to realize that expanding the size given to the object is not the same
1973 * thing as resizing the object. It could very well end being a small
1974 * widget floating in a much larger empty space. If not set, the weight
1975 * for objects will normally be 0.0 for both axis, meaning the widget will
1976 * not be expanded. To take as much space possible, set the weight to
1977 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
1979 * Besides how much space each object is allocated, it's possible to control
1980 * how the widget will be placed within that space using
1981 * evas_object_size_hint_align_set(). By default, this value will be 0.5
1982 * for both axis, meaning the object will be centered, but any value from
1983 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
1984 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
1985 * is -1.0, means the object will be resized to fill the entire space it
1988 * In addition, customized functions to define the layout can be set, which
1989 * allow the application developer to organize the objects within the box
1990 * in any number of ways.
1992 * The special elm_box_layout_transition() function can be used
1993 * to switch from one layout to another, animating the motion of the
1994 * children of the box.
1996 * @note Objects should not be added to box objects using _add() calls.
1998 * Some examples on how to use boxes follow:
1999 * @li @ref box_example_01
2000 * @li @ref box_example_02
2005 * @typedef Elm_Box_Transition
2007 * Opaque handler containing the parameters to perform an animated
2008 * transition of the layout the box uses.
2010 * @see elm_box_transition_new()
2011 * @see elm_box_layout_set()
2012 * @see elm_box_layout_transition()
2014 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2017 * Add a new box to the parent
2019 * By default, the box will be in vertical mode and non-homogeneous.
2021 * @param parent The parent object
2022 * @return The new object or NULL if it cannot be created
2024 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2026 * Set the horizontal orientation
2028 * By default, box object arranges their contents vertically from top to
2030 * By calling this function with @p horizontal as EINA_TRUE, the box will
2031 * become horizontal, arranging contents from left to right.
2033 * @note This flag is ignored if a custom layout function is set.
2035 * @param obj The box object
2036 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2037 * EINA_FALSE = vertical)
2039 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2041 * Get the horizontal orientation
2043 * @param obj The box object
2044 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2046 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2048 * Set the box to arrange its children homogeneously
2050 * If enabled, homogeneous layout makes all items the same size, according
2051 * to the size of the largest of its children.
2053 * @note This flag is ignored if a custom layout function is set.
2055 * @param obj The box object
2056 * @param homogeneous The homogeneous flag
2058 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2060 * Get whether the box is using homogeneous mode or not
2062 * @param obj The box object
2063 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2065 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2066 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2067 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2069 * Add an object to the beginning of the pack list
2071 * Pack @p subobj into the box @p obj, placing it first in the list of
2072 * children objects. The actual position the object will get on screen
2073 * depends on the layout used. If no custom layout is set, it will be at
2074 * the top or left, depending if the box is vertical or horizontal,
2077 * @param obj The box object
2078 * @param subobj The object to add to the box
2080 * @see elm_box_pack_end()
2081 * @see elm_box_pack_before()
2082 * @see elm_box_pack_after()
2083 * @see elm_box_unpack()
2084 * @see elm_box_unpack_all()
2085 * @see elm_box_clear()
2087 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2089 * Add an object at the end of the pack list
2091 * Pack @p subobj into the box @p obj, placing it last in the list of
2092 * children objects. The actual position the object will get on screen
2093 * depends on the layout used. If no custom layout is set, it will be at
2094 * the bottom or right, depending if the box is vertical or horizontal,
2097 * @param obj The box object
2098 * @param subobj The object to add to the box
2100 * @see elm_box_pack_start()
2101 * @see elm_box_pack_before()
2102 * @see elm_box_pack_after()
2103 * @see elm_box_unpack()
2104 * @see elm_box_unpack_all()
2105 * @see elm_box_clear()
2107 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2109 * Adds an object to the box before the indicated object
2111 * This will add the @p subobj to the box indicated before the object
2112 * indicated with @p before. If @p before is not already in the box, results
2113 * are undefined. Before means either to the left of the indicated object or
2114 * above it depending on orientation.
2116 * @param obj The box object
2117 * @param subobj The object to add to the box
2118 * @param before The object before which to add it
2120 * @see elm_box_pack_start()
2121 * @see elm_box_pack_end()
2122 * @see elm_box_pack_after()
2123 * @see elm_box_unpack()
2124 * @see elm_box_unpack_all()
2125 * @see elm_box_clear()
2127 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2129 * Adds an object to the box after the indicated object
2131 * This will add the @p subobj to the box indicated after the object
2132 * indicated with @p after. If @p after is not already in the box, results
2133 * are undefined. After means either to the right of the indicated object or
2134 * below it depending on orientation.
2136 * @param obj The box object
2137 * @param subobj The object to add to the box
2138 * @param after The object after which to add it
2140 * @see elm_box_pack_start()
2141 * @see elm_box_pack_end()
2142 * @see elm_box_pack_before()
2143 * @see elm_box_unpack()
2144 * @see elm_box_unpack_all()
2145 * @see elm_box_clear()
2147 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2149 * Clear the box of all children
2151 * Remove all the elements contained by the box, deleting the respective
2154 * @param obj The box object
2156 * @see elm_box_unpack()
2157 * @see elm_box_unpack_all()
2159 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2163 * Remove the object given by @p subobj from the box @p obj without
2166 * @param obj The box object
2168 * @see elm_box_unpack_all()
2169 * @see elm_box_clear()
2171 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2173 * Remove all items from the box, without deleting them
2175 * Clear the box from all children, but don't delete the respective objects.
2176 * If no other references of the box children exist, the objects will never
2177 * be deleted, and thus the application will leak the memory. Make sure
2178 * when using this function that you hold a reference to all the objects
2179 * in the box @p obj.
2181 * @param obj The box object
2183 * @see elm_box_clear()
2184 * @see elm_box_unpack()
2186 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2188 * Retrieve a list of the objects packed into the box
2190 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2191 * The order of the list corresponds to the packing order the box uses.
2193 * You must free this list with eina_list_free() once you are done with it.
2195 * @param obj The box object
2197 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2199 * Set the space (padding) between the box's elements.
2201 * Extra space in pixels that will be added between a box child and its
2202 * neighbors after its containing cell has been calculated. This padding
2203 * is set for all elements in the box, besides any possible padding that
2204 * individual elements may have through their size hints.
2206 * @param obj The box object
2207 * @param horizontal The horizontal space between elements
2208 * @param vertical The vertical space between elements
2210 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2212 * Get the space (padding) between the box's elements.
2214 * @param obj The box object
2215 * @param horizontal The horizontal space between elements
2216 * @param vertical The vertical space between elements
2218 * @see elm_box_padding_set()
2220 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2222 * Set the alignment of the whole bouding box of contents.
2224 * Sets how the bounding box containing all the elements of the box, after
2225 * their sizes and position has been calculated, will be aligned within
2226 * the space given for the whole box widget.
2228 * @param obj The box object
2229 * @param horizontal The horizontal alignment of elements
2230 * @param vertical The vertical alignment of elements
2232 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2234 * Get the alignment of the whole bouding box of contents.
2236 * @param obj The box object
2237 * @param horizontal The horizontal alignment of elements
2238 * @param vertical The vertical alignment of elements
2240 * @see elm_box_align_set()
2242 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2245 * Set the layout defining function to be used by the box
2247 * Whenever anything changes that requires the box in @p obj to recalculate
2248 * the size and position of its elements, the function @p cb will be called
2249 * to determine what the layout of the children will be.
2251 * Once a custom function is set, everything about the children layout
2252 * is defined by it. The flags set by elm_box_horizontal_set() and
2253 * elm_box_homogeneous_set() no longer have any meaning, and the values
2254 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2255 * layout function to decide if they are used and how. These last two
2256 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2257 * passed to @p cb. The @c Evas_Object the function receives is not the
2258 * Elementary widget, but the internal Evas Box it uses, so none of the
2259 * functions described here can be used on it.
2261 * Any of the layout functions in @c Evas can be used here, as well as the
2262 * special elm_box_layout_transition().
2264 * The final @p data argument received by @p cb is the same @p data passed
2265 * here, and the @p free_data function will be called to free it
2266 * whenever the box is destroyed or another layout function is set.
2268 * Setting @p cb to NULL will revert back to the default layout function.
2270 * @param obj The box object
2271 * @param cb The callback function used for layout
2272 * @param data Data that will be passed to layout function
2273 * @param free_data Function called to free @p data
2275 * @see elm_box_layout_transition()
2277 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);
2279 * Special layout function that animates the transition from one layout to another
2281 * Normally, when switching the layout function for a box, this will be
2282 * reflected immediately on screen on the next render, but it's also
2283 * possible to do this through an animated transition.
2285 * This is done by creating an ::Elm_Box_Transition and setting the box
2286 * layout to this function.
2290 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2291 * evas_object_box_layout_vertical, // start
2292 * NULL, // data for initial layout
2293 * NULL, // free function for initial data
2294 * evas_object_box_layout_horizontal, // end
2295 * NULL, // data for final layout
2296 * NULL, // free function for final data
2297 * anim_end, // will be called when animation ends
2298 * NULL); // data for anim_end function\
2299 * elm_box_layout_set(box, elm_box_layout_transition, t,
2300 * elm_box_transition_free);
2303 * @note This function can only be used with elm_box_layout_set(). Calling
2304 * it directly will not have the expected results.
2306 * @see elm_box_transition_new
2307 * @see elm_box_transition_free
2308 * @see elm_box_layout_set
2310 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2312 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2314 * If you want to animate the change from one layout to another, you need
2315 * to set the layout function of the box to elm_box_layout_transition(),
2316 * passing as user data to it an instance of ::Elm_Box_Transition with the
2317 * necessary information to perform this animation. The free function to
2318 * set for the layout is elm_box_transition_free().
2320 * The parameters to create an ::Elm_Box_Transition sum up to how long
2321 * will it be, in seconds, a layout function to describe the initial point,
2322 * another for the final position of the children and one function to be
2323 * called when the whole animation ends. This last function is useful to
2324 * set the definitive layout for the box, usually the same as the end
2325 * layout for the animation, but could be used to start another transition.
2327 * @param start_layout The layout function that will be used to start the animation
2328 * @param start_layout_data The data to be passed the @p start_layout function
2329 * @param start_layout_free_data Function to free @p start_layout_data
2330 * @param end_layout The layout function that will be used to end the animation
2331 * @param end_layout_free_data The data to be passed the @p end_layout function
2332 * @param end_layout_free_data Function to free @p end_layout_data
2333 * @param transition_end_cb Callback function called when animation ends
2334 * @param transition_end_data Data to be passed to @p transition_end_cb
2335 * @return An instance of ::Elm_Box_Transition
2337 * @see elm_box_transition_new
2338 * @see elm_box_layout_transition
2340 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);
2342 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2344 * This function is mostly useful as the @c free_data parameter in
2345 * elm_box_layout_set() when elm_box_layout_transition().
2347 * @param data The Elm_Box_Transition instance to be freed.
2349 * @see elm_box_transition_new
2350 * @see elm_box_layout_transition
2352 EAPI void elm_box_transition_free(void *data);
2359 * @defgroup Button Button
2361 * This is a push-button. Press it and run some function. It can contain
2362 * a simple label and icon object and it also has an autorepeat feature.
2364 * This widgets emits the following signals:
2365 * @li "clicked": the user clicked the button (press/release).
2366 * @li "repeated": the user pressed the button without releasing it.
2367 * @li "unpressed": button was released after being pressed.
2368 * In all three cases, the @c event parameter of the callback will be
2371 * Also, defined in the default theme, the button has the following styles
2373 * @li default: a normal button.
2374 * @li anchor: Like default, but the button fades away when the mouse is not
2375 * over it, leaving only the text or icon.
2376 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2377 * continuous look across its options.
2378 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2380 * Follow through a complete example @ref button_example_01 "here".
2384 * Add a new button to the parent's canvas
2386 * @param parent The parent object
2387 * @return The new object or NULL if it cannot be created
2389 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2391 * Set the label used in the button
2393 * The passed @p label can be NULL to clean any existing text in it and
2394 * leave the button as an icon only object.
2396 * @param obj The button object
2397 * @param label The text will be written on the button
2398 * @deprecated use elm_object_text_set() instead.
2400 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2402 * Get the label set for the button
2404 * The string returned is an internal pointer and should not be freed or
2405 * altered. It will also become invalid when the button is destroyed.
2406 * The string returned, if not NULL, is a stringshare, so if you need to
2407 * keep it around even after the button is destroyed, you can use
2408 * eina_stringshare_ref().
2410 * @param obj The button object
2411 * @return The text set to the label, or NULL if nothing is set
2412 * @deprecated use elm_object_text_set() instead.
2414 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2416 * Set the icon used for the button
2418 * Setting a new icon will delete any other that was previously set, making
2419 * any reference to them invalid. If you need to maintain the previous
2420 * object alive, unset it first with elm_button_icon_unset().
2422 * @param obj The button object
2423 * @param icon The icon object for the button
2425 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2427 * Get the icon used for the button
2429 * Return the icon object which is set for this widget. If the button is
2430 * destroyed or another icon is set, the returned object will be deleted
2431 * and any reference to it will be invalid.
2433 * @param obj The button object
2434 * @return The icon object that is being used
2436 * @see elm_button_icon_unset()
2438 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2440 * Remove the icon set without deleting it and return the object
2442 * This function drops the reference the button holds of the icon object
2443 * and returns this last object. It is used in case you want to remove any
2444 * icon, or set another one, without deleting the actual object. The button
2445 * will be left without an icon set.
2447 * @param obj The button object
2448 * @return The icon object that was being used
2450 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2452 * Turn on/off the autorepeat event generated when the button is kept pressed
2454 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2455 * signal when they are clicked.
2457 * When on, keeping a button pressed will continuously emit a @c repeated
2458 * signal until the button is released. The time it takes until it starts
2459 * emitting the signal is given by
2460 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2461 * new emission by elm_button_autorepeat_gap_timeout_set().
2463 * @param obj The button object
2464 * @param on A bool to turn on/off the event
2466 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2468 * Get whether the autorepeat feature is enabled
2470 * @param obj The button object
2471 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2473 * @see elm_button_autorepeat_set()
2475 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2477 * Set the initial timeout before the autorepeat event is generated
2479 * Sets the timeout, in seconds, since the button is pressed until the
2480 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2481 * won't be any delay and the even will be fired the moment the button is
2484 * @param obj The button object
2485 * @param t Timeout in seconds
2487 * @see elm_button_autorepeat_set()
2488 * @see elm_button_autorepeat_gap_timeout_set()
2490 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2492 * Get the initial timeout before the autorepeat event is generated
2494 * @param obj The button object
2495 * @return Timeout in seconds
2497 * @see elm_button_autorepeat_initial_timeout_set()
2499 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2501 * Set the interval between each generated autorepeat event
2503 * After the first @c repeated event is fired, all subsequent ones will
2504 * follow after a delay of @p t seconds for each.
2506 * @param obj The button object
2507 * @param t Interval in seconds
2509 * @see elm_button_autorepeat_initial_timeout_set()
2511 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2513 * Get the interval between each generated autorepeat event
2515 * @param obj The button object
2516 * @return Interval in seconds
2518 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2524 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2525 EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2526 EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2527 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2528 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2529 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2530 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2531 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2532 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2533 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2534 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2535 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2536 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2537 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2538 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2539 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2540 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2541 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2542 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2543 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2544 /* available styles:
2548 * hoversel_vertical_entry
2550 /* smart callbacks called:
2551 * "file,chosen" - the user has selected a path, whose string pointer comes
2555 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2556 EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2557 EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2558 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2559 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2560 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2561 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2562 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2563 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2564 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2565 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2566 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2567 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2568 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2569 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2570 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2571 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2572 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2573 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2574 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2575 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2576 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2578 /* scroller policy */
2579 typedef enum _Elm_Scroller_Policy
2581 ELM_SCROLLER_POLICY_AUTO = 0,
2582 ELM_SCROLLER_POLICY_ON,
2583 ELM_SCROLLER_POLICY_OFF,
2584 ELM_SCROLLER_POLICY_LAST
2585 } Elm_Scroller_Policy;
2587 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2588 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2589 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2590 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2591 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2592 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2593 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);
2594 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2595 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2596 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);
2597 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2598 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2599 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2600 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2601 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2602 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);
2603 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2604 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2605 /* smart callbacks called:
2606 * "edge,left" - the left edge of the content has been reached
2607 * "edge,right" - the right edge of the content has been reached
2608 * "edge,top" - the top edge of the content has been reached
2609 * "edge,bottom" - the bottom edge of the content has been reached
2610 * "scroll" - the content has been scrolled (moved)
2611 * "scroll,anim,start" - scrolling animation has started
2612 * "scroll,anim,stop" - scrolling animation has stopped
2613 * "scroll,drag,start" - dragging the contents around has started
2614 * "scroll,drag,stop" - dragging the contents around has stopped
2618 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2619 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 */
2620 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2621 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2622 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2623 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2624 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2625 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2626 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2627 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2628 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);
2629 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2630 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);
2631 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2632 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2633 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2634 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2635 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2636 /* available styles:
2640 /* smart callbacks called:
2644 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2645 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2646 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2647 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2648 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2649 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2650 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2651 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2652 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2653 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2654 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2655 /* smart callbacks called:
2656 * "changed" - Whenever the toggle value has been changed. Is not called
2657 * until the toggle is released by the cursor (assuming it has been triggered
2658 * by the cursor in the first place).
2662 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2663 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
2664 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2665 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1)
2666 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2667 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
2668 /* available styles:
2677 /* smart callbacks called:
2681 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2682 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2683 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2684 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2685 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2686 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2687 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2688 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2689 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2690 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
2691 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2692 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
2695 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
2696 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
2697 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
2698 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2699 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
2700 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2701 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
2703 struct _Elm_Gengrid_Item_Class
2705 const char *item_style;
2706 struct _Elm_Gengrid_Item_Class_Func
2708 GridItemLabelGetFunc label_get;
2709 GridItemIconGetFunc icon_get;
2710 GridItemStateGetFunc state_get;
2711 GridItemDelFunc del;
2715 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2716 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2717 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2718 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
2719 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
2721 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2722 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2723 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2724 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2725 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2726 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2727 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2728 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2729 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2730 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2731 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2732 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
2733 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2734 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
2735 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2737 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2738 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2740 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2741 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2742 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2743 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2744 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2745 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2746 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
2747 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2748 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
2749 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
2750 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2751 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2752 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2753 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2754 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2755 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2756 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2758 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
2759 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);
2760 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2761 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2762 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2763 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2764 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2765 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2766 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2767 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2768 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2769 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2771 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2772 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2773 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2775 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);
2776 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);
2777 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);
2778 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);
2779 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);
2780 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);
2781 /* smart callbacks called:
2783 * selected - User has selected an item.
2784 * unselected - User has unselected an item.
2785 * clicked,double - User has double-clicked or pressed enter on an item.
2786 * realized - An evas object for an item was built.
2787 * unrealized - An evas object for an item was deleted.
2788 * changed - An item has been added, removed, resized or moved,
2789 * or gengrid has been resized or horizontal property has been changed.
2790 * scroll - the content has been scrolled (moved).
2791 * "scroll,drag,start" - dragging the contents around has started.
2792 * "scroll,drat,stop" - dragging the contents around has stopped.
2793 * drag - Gengrid is being dragged.
2794 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
2795 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
2796 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
2797 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
2798 * "drag,stop" - Gengrid is not being dragged.
2802 typedef enum _Elm_Clock_Digedit
2805 ELM_CLOCK_HOUR_DECIMAL = 1 << 0,
2806 ELM_CLOCK_HOUR_UNIT = 1 << 1,
2807 ELM_CLOCK_MIN_DECIMAL = 1 << 2,
2808 ELM_CLOCK_MIN_UNIT = 1 << 3,
2809 ELM_CLOCK_SEC_DECIMAL = 1 << 4,
2810 ELM_CLOCK_SEC_UNIT = 1 << 5,
2811 ELM_CLOCK_ALL = (1 << 6) - 1
2812 } Elm_Clock_Digedit;
2814 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2815 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
2816 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
2817 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
2818 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2819 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
2820 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2821 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
2822 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2823 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
2824 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2825 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
2826 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2827 /* smart callbacks called:
2828 * "changed" - the user changed the time
2832 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2833 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2834 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
2835 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
2836 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2837 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2838 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
2839 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
2840 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
2841 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
2842 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
2843 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
2844 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
2845 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
2846 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);
2847 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
2848 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
2849 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2850 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
2851 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
2852 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
2853 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2854 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2855 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
2856 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2857 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);
2858 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2860 * @def elm_layout_icon_set
2861 * Convienience macro to set the icon object in a layout that follows the
2862 * Elementary naming convention for its parts.
2866 #define elm_layout_icon_set(_ly, _obj) \
2869 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
2870 if ((_obj)) sig = "elm,state,icon,visible"; \
2871 else sig = "elm,state,icon,hidden"; \
2872 elm_object_signal_emit((_ly), sig, "elm"); \
2876 * @def elm_layout_icon_get
2877 * Convienience macro to get the icon object from a layout that follows the
2878 * Elementary naming convention for its parts.
2882 #define elm_layout_icon_get(_ly) \
2883 elm_layout_content_get((_ly), "elm.swallow.icon")
2886 * @def elm_layout_end_set
2887 * Convienience macro to set the end object in a layout that follows the
2888 * Elementary naming convention for its parts.
2892 #define elm_layout_end_set(_ly, _obj) \
2895 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
2896 if ((_obj)) sig = "elm,state,end,visible"; \
2897 else sig = "elm,state,end,hidden"; \
2898 elm_object_signal_emit((_ly), sig, "elm"); \
2902 * @def elm_layout_end_get
2903 * Convienience macro to get the end object in a layout that follows the
2904 * Elementary naming convention for its parts.
2908 #define elm_layout_end_get(_ly) \
2909 elm_layout_content_get((_ly), "elm.swallow.end")
2912 * @def elm_layout_label_set
2913 * Convienience macro to set the label in a layout that follows the
2914 * Elementary naming convention for its parts.
2917 * @deprecate use elm_object_text_* instead.
2919 #define elm_layout_label_set(_ly, _txt) \
2920 elm_layout_text_set((_ly), "elm.text", (_txt))
2923 * @def elm_layout_label_get
2924 * Convienience macro to get the label in a layout that follows the
2925 * Elementary naming convention for its parts.
2928 * @deprecate use elm_object_text_* instead.
2930 #define elm_layout_label_get(_ly) \
2931 elm_layout_text_get((_ly), "elm.text")
2933 /* smart callbacks called:
2937 typedef enum _Elm_Notify_Orient
2939 ELM_NOTIFY_ORIENT_TOP,
2940 ELM_NOTIFY_ORIENT_CENTER,
2941 ELM_NOTIFY_ORIENT_BOTTOM,
2942 ELM_NOTIFY_ORIENT_LEFT,
2943 ELM_NOTIFY_ORIENT_RIGHT,
2944 ELM_NOTIFY_ORIENT_TOP_LEFT,
2945 ELM_NOTIFY_ORIENT_TOP_RIGHT,
2946 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
2947 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
2948 ELM_NOTIFY_ORIENT_LAST
2949 } Elm_Notify_Orient;
2950 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2951 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2952 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2953 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2954 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2955 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2956 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
2957 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2958 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
2959 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2960 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
2961 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2962 /* smart callbacks called:
2963 * "timeout" - when timeout happens on notify and it's hidden
2964 * "block,clicked" - when it's hidden by a click outside of the notify's view
2968 typedef enum _Elm_Hover_Axis
2970 ELM_HOVER_AXIS_NONE,
2971 ELM_HOVER_AXIS_HORIZONTAL,
2972 ELM_HOVER_AXIS_VERTICAL,
2975 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2976 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
2977 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2978 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2979 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2980 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
2981 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2982 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2983 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
2984 /* available styles:
2990 /* smart callbacks called:
2991 * "clicked" - the user clicked the empty space in the hover to dismiss
2992 * "smart,changed" - a content object placed under the "smart"
2993 * policy was replaced to a new slot direction.
2997 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
2998 struct _Elm_Entry_Anchor_Info
3002 Evas_Coord x, y, w, h;
3004 typedef enum _Elm_Icon_Type
3010 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3012 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3013 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3014 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3015 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3016 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3017 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3018 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3019 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3020 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3021 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3022 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3023 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3024 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3025 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3026 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3027 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3028 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3029 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3030 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3031 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3032 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3033 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3034 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3035 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3036 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3037 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3038 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3039 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3040 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3041 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);
3042 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3043 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3044 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3045 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3046 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3047 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3048 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);
3049 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3050 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3051 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);
3052 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);
3053 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);
3054 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);
3055 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);
3056 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);
3057 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3058 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3059 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3060 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3061 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3062 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3063 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3064 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3065 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3066 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3067 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
3068 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3069 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3070 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3071 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3072 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3073 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3074 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3075 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3076 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3077 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3078 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3080 /* pre-made filters for entries */
3081 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3082 struct _Elm_Entry_Filter_Limit_Size
3087 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3088 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3089 struct _Elm_Entry_Filter_Accept_Set
3091 const char *accepted;
3092 const char *rejected;
3094 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3095 /* smart callbacks called:
3096 * "changed" - the text content changed
3097 * "selection,start" - the user started selecting text
3098 * "selection,changed" - the user modified the selection size/location
3099 * "selection,cleared" - the user cleared the selection
3100 * "selection,paste" - the user requested a paste of text
3101 * "selection,copy" - the user copied the text
3102 * "selection,cut" - the user cut the text
3103 * "cursor,changed" - the cursor changed position
3104 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3105 * "activated" - when the enter key is pressed (useful for single line)
3106 * "press" - when finger/mouse is pressed down
3107 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3108 * "clicked,double" - when finger/mouse is double-pressed
3109 * "longpressed" - the entry has been longpressed
3110 * "focused" - the entry has received keyboard focus
3111 * "unfocused" - keyboard focus is gone
3114 /* composite widgets - these basically put together basic widgets above
3115 * in convenient packages that do more than basic stuff */
3119 * @defgroup Anchorview Anchorview
3121 * Anchorview is for displaying text that contains markup with anchors
3122 * like <c>\<a href=1234\>something\</\></c> in it.
3124 * Besides being styled differently, the anchorview widget provides the
3125 * necessary functionality so that clicking on these anchors brings up a
3126 * popup with user defined content such as "call", "add to contacts" or
3127 * "open web page". This popup is provided using the @ref Hover widget.
3129 * This widget is very similar to @ref Anchorblock, so refer to that
3130 * widget for an example. The only difference Anchorview has is that the
3131 * widget is already provided with scrolling functionality, so if the
3132 * text set to it is too large to fit in the given space, it will scroll,
3133 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3134 * text can be displayed.
3136 * This widget emits the following signals:
3137 * @li "anchor,clicked": will be called when an anchor is clicked. The
3138 * @p event_info parameter on the callback will be a pointer of type
3139 * ::Elm_Entry_Anchorview_Info.
3141 * See @ref Anchorblock for an example on how to use both of them.
3150 * @typedef Elm_Entry_Anchorview_Info
3152 * The info sent in the callback for "anchor,clicked" signals emitted by
3153 * the Anchorview widget.
3155 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3157 * @struct _Elm_Entry_Anchorview_Info
3159 * The info sent in the callback for "anchor,clicked" signals emitted by
3160 * the Anchorview widget.
3162 struct _Elm_Entry_Anchorview_Info
3164 const char *name; /**< Name of the anchor, as indicated in its href
3166 int button; /**< The mouse button used to click on it */
3167 Evas_Object *hover; /**< The hover object to use for the popup */
3169 Evas_Coord x, y, w, h;
3170 } anchor, /**< Geometry selection of text used as anchor */
3171 hover_parent; /**< Geometry of the object used as parent by the
3173 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3174 for content on the left side of
3175 the hover. Before calling the
3176 callback, the widget will make the
3177 necessary calculations to check
3178 which sides are fit to be set with
3179 content, based on the position the
3180 hover is activated and its distance
3181 to the edges of its parent object
3183 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3184 the right side of the hover.
3185 See @ref hover_left */
3186 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3187 of the hover. See @ref hover_left */
3188 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3189 below the hover. See @ref
3193 * Add a new Anchorview object
3195 * @param parent The parent object
3196 * @return The new object or NULL if it cannot be created
3198 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3200 * Set the text to show in the anchorview
3202 * Sets the text of the anchorview to @p text. This text can include markup
3203 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3204 * text that will be specially styled and react to click events, ended with
3205 * either of \</a\> or \</\>. When clicked, the anchor will emit an
3206 * "anchor,clicked" signal that you can attach a callback to with
3207 * evas_object_smart_callback_add(). The name of the anchor given in the
3208 * event info struct will be the one set in the href attribute, in this
3211 * Other markup can be used to style the text in different ways, but it's
3212 * up to the style defined in the theme which tags do what.
3214 EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3216 * Get the markup text set for the anchorview
3218 * Retrieves the text set on the anchorview, with markup tags included.
3220 * @param obj The anchorview object
3221 * @return The markup text set or @c NULL if nothing was set or an error
3224 EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3226 * Set the parent of the hover popup
3228 * Sets the parent object to use by the hover created by the anchorview
3229 * when an anchor is clicked. See @ref Hover for more details on this.
3230 * If no parent is set, the same anchorview object will be used.
3232 * @param obj The anchorview object
3233 * @param parent The object to use as parent for the hover
3235 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3237 * Get the parent of the hover popup
3239 * Get the object used as parent for the hover created by the anchorview
3240 * widget. See @ref Hover for more details on this.
3242 * @param obj The anchorview object
3243 * @return The object used as parent for the hover, NULL if none is set.
3245 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3247 * Set the style that the hover should use
3249 * When creating the popup hover, anchorview will request that it's
3250 * themed according to @p style.
3252 * @param obj The anchorview object
3253 * @param style The style to use for the underlying hover
3255 * @see elm_object_style_set()
3257 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3259 * Get the style that the hover should use
3261 * Get the style the hover created by anchorview will use.
3263 * @param obj The anchorview object
3264 * @return The style to use by the hover. NULL means the default is used.
3266 * @see elm_object_style_set()
3268 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3270 * Ends the hover popup in the anchorview
3272 * When an anchor is clicked, the anchorview widget will create a hover
3273 * object to use as a popup with user provided content. This function
3274 * terminates this popup, returning the anchorview to its normal state.
3276 * @param obj The anchorview object
3278 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3280 * Set bouncing behaviour when the scrolled content reaches an edge
3282 * Tell the internal scroller object whether it should bounce or not
3283 * when it reaches the respective edges for each axis.
3285 * @param obj The anchorview object
3286 * @param h_bounce Whether to bounce or not in the horizontal axis
3287 * @param v_bounce Whether to bounce or not in the vertical axis
3289 * @see elm_scroller_bounce_set()
3291 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3293 * Get the set bouncing behaviour of the internal scroller
3295 * Get whether the internal scroller should bounce when the edge of each
3296 * axis is reached scrolling.
3298 * @param obj The anchorview object
3299 * @param h_bounce Pointer where to store the bounce state of the horizontal
3301 * @param v_bounce Pointer where to store the bounce state of the vertical
3304 * @see elm_scroller_bounce_get()
3306 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3308 * Appends a custom item provider to the given anchorview
3310 * Appends the given function to the list of items providers. This list is
3311 * called, one function at a time, with the given @p data pointer, the
3312 * anchorview object and, in the @p item parameter, the item name as
3313 * referenced in its href string. Following functions in the list will be
3314 * called in order until one of them returns something different to NULL,
3315 * which should be an Evas_Object which will be used in place of the item
3318 * Items in the markup text take the form \<item relsize=16x16 vsize=full
3319 * href=item/name\>\</item\>
3321 * @param obj The anchorview object
3322 * @param func The function to add to the list of providers
3323 * @param data User data that will be passed to the callback function
3325 * @see elm_entry_item_provider_append()
3327 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);
3329 * Prepend a custom item provider to the given anchorview
3331 * Like elm_anchorview_item_provider_append(), but it adds the function
3332 * @p func to the beginning of the list, instead of the end.
3334 * @param obj The anchorview object
3335 * @param func The function to add to the list of providers
3336 * @param data User data that will be passed to the callback function
3338 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);
3340 * Remove a custom item provider from the list of the given anchorview
3342 * Removes the function and data pairing that matches @p func and @p data.
3343 * That is, unless the same function and same user data are given, the
3344 * function will not be removed from the list. This allows us to add the
3345 * same callback several times, with different @p data pointers and be
3346 * able to remove them later without conflicts.
3348 * @param obj The anchorview object
3349 * @param func The function to remove from the list
3350 * @param data The data matching the function to remove from the list
3352 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);
3359 * @defgroup Anchorblock Anchorblock
3361 * Anchorblock is for displaying text that contains markup with anchors
3362 * like <c>\<a href=1234\>something\</\></c> in it.
3364 * Besides being styled differently, the anchorblock widget provides the
3365 * necessary functionality so that clicking on these anchors brings up a
3366 * popup with user defined content such as "call", "add to contacts" or
3367 * "open web page". This popup is provided using the @ref Hover widget.
3369 * This widget emits the following signals:
3370 * @li "anchor,clicked": will be called when an anchor is clicked. The
3371 * @p event_info parameter on the callback will be a pointer of type
3372 * ::Elm_Entry_Anchorblock_Info.
3378 * Since examples are usually better than plain words, we might as well
3379 * try one. This exampel will show both Anchorblock and @ref Anchorview,
3380 * since both are very similar and it's easier to show them once and side
3381 * by side, so the difference is more clear.
3383 * We'll show the relevant snippets of the code here, but the full example
3384 * can be found here... sorry, @ref anchorblock_example_01.c "here".
3386 * As for the actual example, it's just a simple window with an anchorblock
3387 * and an anchorview, both containing the same text. After including
3388 * Elementary.h and declaring some functions we'll need, we jump to our
3389 * elm_main (see ELM_MAIN) and create our window.
3390 * @dontinclude anchorblock_example_01.c
3395 * With the needed variables declared, we'll create the window and a box to
3396 * hold our widgets, but we don't need to go through that here.
3398 * In order to make clear where the anchorblock ends and the anchorview
3399 * begins, they'll be each inside a @ref Frame. After creating the frame,
3400 * the anchorblock follows.
3401 * @skip elm_frame_add
3402 * @until elm_frame_content_set
3404 * Nothing out of the ordinary there. What's worth mentioning is the call
3405 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
3406 * when an anchor is clicked, the hover for the popup will cover the entire
3407 * window. This affects the area that will be obscured by the hover and
3408 * where clicking will dismiss it, as well as the calculations it does to
3409 * inform the best locations where to insert the popups content.
3410 * Other than that, the code is pretty standard. We also need to set our
3411 * callback for when an anchor is clicked, since it's our task to populate
3412 * the popup. There's no default for it.
3414 * The anchorview is no different, we only change a few things so it looks
3416 * @until elm_frame_content_set
3418 * Then we run, so stuff works and close our main function in the usual way.
3421 * Now, a little note. Normally you would use either one of anchorblock or
3422 * anchorview, set your one callback to clicks and do your stuff in there.
3423 * In this example, however, there are a few tricks to make it easier to
3424 * show both widgets in one go (and to save me some typing). So we have
3425 * two callbacks, one per widget, that will call a common function to do
3426 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
3427 * anchorview too, since both are equal, and passing a callback to use
3428 * for our buttons to end the hover, because each widget has a different
3430 * @until _anchorview_clicked_cb
3433 * The meat of our popup is in the following function. We check what kind
3434 * of menu we need to show, based on the name set to the anchor in the
3435 * markup text. If there's no type (something went wrong, no valid contact
3436 * in the address list) we are just putting a button that does nothing, but
3437 * it's perfectly reasonable to just end the hover and call it quits.
3439 * Our popup will consist of one main button in the middle of our hover,
3440 * and possibly a secondary button and a list of other options. We'll create
3441 * first our main button and check what kind of popup we need afterwards.
3444 * @until eina_stringshare_add
3447 * Each button has two callbacks, one is our hack to close the hover
3448 * properly based on which widget it belongs to, the other a simple
3449 * printf that will show the action with the anchors own data. This is
3450 * not how you would usually do it. Instead, the common case is to have
3451 * one callback for the button that will know which function to call to end
3452 * things, but since we are doing it this way it's worth noting that
3453 * smart callbacks will be called in reverse in respect to the order they
3454 * were added, and since our @c btn_end_cb will close the hover, and thus
3455 * delete our buttons, the other callback wouldn't be called if we had
3458 * After our telephone popup, there are a few others that are practically
3459 * the same, so they won't be shown here.
3461 * Once we are done with that, it's time to place our actions into our
3462 * hover. Main button goes in the middle without much questioning, and then
3463 * we see if we have a secondary button and a box of extra options.
3464 * Because I said so, secondary button goes on either side and box of
3465 * options either on top or below the main one, but to choose which
3466 * exactly, we use the hints our callback info has, which saves us from
3467 * having to do the math and see which side has more space available, with
3468 * a little special case where we delete our extra stuff if there's nowhere
3472 * @skip evas_object_smart
3473 * @until evas_object_del(box)
3478 * @example anchorblock_example_01.c
3481 * @addtogroup Anchorblock
3485 * @typedef Elm_Entry_Anchorblock_Info
3487 * The info sent in the callback for "anchor,clicked" signals emitted by
3488 * the Anchorblock widget.
3490 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
3492 * @struct _Elm_Entry_Anchorblock_Info
3494 * The info sent in the callback for "anchor,clicked" signals emitted by
3495 * the Anchorblock widget.
3497 struct _Elm_Entry_Anchorblock_Info
3499 const char *name; /**< Name of the anchor, as indicated in its href
3501 int button; /**< The mouse button used to click on it */
3502 Evas_Object *hover; /**< The hover object to use for the popup */
3504 Evas_Coord x, y, w, h;
3505 } anchor, /**< Geometry selection of text used as anchor */
3506 hover_parent; /**< Geometry of the object used as parent by the
3508 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3509 for content on the left side of
3510 the hover. Before calling the
3511 callback, the widget will make the
3512 necessary calculations to check
3513 which sides are fit to be set with
3514 content, based on the position the
3515 hover is activated and its distance
3516 to the edges of its parent object
3518 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3519 the right side of the hover.
3520 See @ref hover_left */
3521 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3522 of the hover. See @ref hover_left */
3523 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3524 below the hover. See @ref
3528 * Add a new Anchorblock object
3530 * @param parent The parent object
3531 * @return The new object or NULL if it cannot be created
3533 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3535 * Set the text to show in the anchorblock
3537 * Sets the text of the anchorblock to @p text. This text can include markup
3538 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
3539 * of text that will be specially styled and react to click events, ended
3540 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
3541 * "anchor,clicked" signal that you can attach a callback to with
3542 * evas_object_smart_callback_add(). The name of the anchor given in the
3543 * event info struct will be the one set in the href attribute, in this
3546 * Other markup can be used to style the text in different ways, but it's
3547 * up to the style defined in the theme which tags do what.
3549 EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3551 * Get the markup text set for the anchorblock
3553 * Retrieves the text set on the anchorblock, with markup tags included.
3555 * @param obj The anchorblock object
3556 * @return The markup text set or @c NULL if nothing was set or an error
3559 EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3561 * Set the parent of the hover popup
3563 * Sets the parent object to use by the hover created by the anchorblock
3564 * when an anchor is clicked. See @ref Hover for more details on this.
3566 * @param obj The anchorblock object
3567 * @param parent The object to use as parent for the hover
3569 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3571 * Get the parent of the hover popup
3573 * Get the object used as parent for the hover created by the anchorblock
3574 * widget. See @ref Hover for more details on this.
3575 * If no parent is set, the same anchorblock object will be used.
3577 * @param obj The anchorblock object
3578 * @return The object used as parent for the hover, NULL if none is set.
3580 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3582 * Set the style that the hover should use
3584 * When creating the popup hover, anchorblock will request that it's
3585 * themed according to @p style.
3587 * @param obj The anchorblock object
3588 * @param style The style to use for the underlying hover
3590 * @see elm_object_style_set()
3592 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3594 * Get the style that the hover should use
3596 * Get the style the hover created by anchorblock will use.
3598 * @param obj The anchorblock object
3599 * @return The style to use by the hover. NULL means the default is used.
3601 * @see elm_object_style_set()
3603 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3605 * Ends the hover popup in the anchorblock
3607 * When an anchor is clicked, the anchorblock widget will create a hover
3608 * object to use as a popup with user provided content. This function
3609 * terminates this popup, returning the anchorblock to its normal state.
3611 * @param obj The anchorblock object
3613 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3615 * Appends a custom item provider to the given anchorblock
3617 * Appends the given function to the list of items providers. This list is
3618 * called, one function at a time, with the given @p data pointer, the
3619 * anchorblock object and, in the @p item parameter, the item name as
3620 * referenced in its href string. Following functions in the list will be
3621 * called in order until one of them returns something different to NULL,
3622 * which should be an Evas_Object which will be used in place of the item
3625 * Items in the markup text take the form \<item relsize=16x16 vsize=full
3626 * href=item/name\>\</item\>
3628 * @param obj The anchorblock object
3629 * @param func The function to add to the list of providers
3630 * @param data User data that will be passed to the callback function
3632 * @see elm_entry_item_provider_append()
3634 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);
3636 * Prepend a custom item provider to the given anchorblock
3638 * Like elm_anchorblock_item_provider_append(), but it adds the function
3639 * @p func to the beginning of the list, instead of the end.
3641 * @param obj The anchorblock object
3642 * @param func The function to add to the list of providers
3643 * @param data User data that will be passed to the callback function
3645 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);
3647 * Remove a custom item provider from the list of the given anchorblock
3649 * Removes the function and data pairing that matches @p func and @p data.
3650 * That is, unless the same function and same user data are given, the
3651 * function will not be removed from the list. This allows us to add the
3652 * same callback several times, with different @p data pointers and be
3653 * able to remove them later without conflicts.
3655 * @param obj The anchorblock object
3656 * @param func The function to remove from the list
3657 * @param data The data matching the function to remove from the list
3659 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);
3665 * @defgroup Bubble Bubble
3667 * @brief The Bubble is a widget to show text similarly to how speech is
3668 * represented in comics.
3670 * The bubble widget contains 5 important visual elements:
3671 * @li The frame is a rectangle with rounded rectangles and an "arrow".
3672 * @li The @p icon is an image to which the frame's arrow points to.
3673 * @li The @p label is a text which appears to the right of the icon if the
3674 * corner is "top_left" or "bottom_left" and is right aligned to the frame
3676 * @li The @p info is a text which appears to the right of the label. Info's
3677 * font is of a ligther color than label.
3678 * @li The @p content is an evas object that is shown inside the frame.
3680 * The position of the arrow, icon, label and info depends on which corner is
3681 * selected. The four available corners are:
3682 * @li "top_left" - Default
3685 * @li "bottom_right"
3687 * Signals that you can add callbacks for are:
3688 * @li "clicked" - This is called when a user has clicked the bubble.
3690 * For an example of using a buble see @ref bubble_01_example_page "this".
3695 * Add a new bubble to the parent
3697 * @param parent The parent object
3698 * @return The new object or NULL if it cannot be created
3700 * This function adds a text bubble to the given parent evas object.
3702 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3704 * Set the label of the bubble
3706 * @param obj The bubble object
3707 * @param label The string to set in the label
3709 * This function sets the title of the bubble. Where this appears depends on
3710 * the selected corner.
3712 EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3714 * Get the label of the bubble
3716 * @param obj The bubble object
3717 * @return The string of set in the label
3719 * This function gets the title of the bubble.
3721 EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3723 * Set the info of the bubble
3725 * @param obj The bubble object
3726 * @param info The given info about the bubble
3728 * This function sets the info of the bubble. Where this appears depends on
3729 * the selected corner.
3731 EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
3733 * Get the info of the bubble
3735 * @param obj The bubble object
3737 * @return The "info" string of the bubble
3739 * This function gets the info text.
3741 EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3743 * Set the content to be shown in the bubble
3745 * Once the content object is set, a previously set one will be deleted.
3746 * If you want to keep the old content object, use the
3747 * elm_bubble_content_unset() function.
3749 * @param obj The bubble object
3750 * @param content The given content of the bubble
3752 * This function sets the content shown on the middle of the bubble.
3754 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3756 * Get the content shown in the bubble
3758 * Return the content object which is set for this widget.
3760 * @param obj The bubble object
3761 * @return The content that is being used
3763 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3765 * Unset the content shown in the bubble
3767 * Unparent and return the content object which was set for this widget.
3769 * @param obj The bubble object
3770 * @return The content that was being used
3772 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3774 * Set the icon of the bubble
3776 * Once the icon object is set, a previously set one will be deleted.
3777 * If you want to keep the old content object, use the
3778 * elm_icon_content_unset() function.
3780 * @param obj The bubble object
3781 * @param icon The given icon for the bubble
3783 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3785 * Get the icon of the bubble
3787 * @param obj The bubble object
3788 * @return The icon for the bubble
3790 * This function gets the icon shown on the top left of bubble.
3792 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3794 * Unset the icon of the bubble
3796 * Unparent and return the icon object which was set for this widget.
3798 * @param obj The bubble object
3799 * @return The icon that was being used
3801 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3803 * Set the corner of the bubble
3805 * @param obj The bubble object.
3806 * @param corner The given corner for the bubble.
3808 * This function sets the corner of the bubble. The corner will be used to
3809 * determine where the arrow in the frame points to and where label, icon and
3812 * Possible values for corner are:
3813 * @li "top_left" - Default
3816 * @li "bottom_right"
3818 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
3820 * Get the corner of the bubble
3822 * @param obj The bubble object.
3823 * @return The given corner for the bubble.
3825 * This function gets the selected corner of the bubble.
3827 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3833 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3834 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
3835 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3836 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
3837 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3838 /* smart callbacks called:
3839 * "clicked" - the user clicked the icon
3840 * "drag,start" - Someone started dragging the image out of the object
3841 * "drag,end" - Dragged item was dropped (somewhere)
3845 typedef enum _Elm_Thumb_Animation_Setting
3847 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
3848 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
3849 ELM_THUMB_ANIMATION_STOP,
3850 ELM_THUMB_ANIMATION_LAST
3851 } Elm_Thumb_Animation_Setting;
3853 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3854 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
3855 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
3856 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
3857 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
3858 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
3859 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3860 EAPI void *elm_thumb_ethumb_client_get(void);
3861 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
3862 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3863 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3864 /* available styles:
3868 /* smart callbacks called:
3869 * "clicked" - This is called when a user has clicked the thumb without dragging around.
3870 * "clicked,double" - This is called when a user has double-clicked the thumb.
3871 * "press" - This is called when a user has pressed down the thumb.
3872 * "generate,start" - The thumbnail generation started.
3873 * "generate,stop" - The generation process stopped.
3874 * "generate,error" - The generation failed.
3875 * "load,error" - The thumbnail image loading failed.
3879 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3880 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3881 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3882 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3883 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3884 EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3885 EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3886 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3887 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3889 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3890 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3891 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3893 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3894 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);
3895 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
3896 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3897 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
3898 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
3899 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);
3900 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);
3901 /* smart callbacks called:
3902 * "clicked" - the user clicked the hoversel button and popped up the sel
3903 * "selected" - an item in the hoversel list is selected
3904 * "dismissed" - the hover is dismissed
3908 typedef enum _Elm_Toolbar_Shrink_Mode
3910 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
3911 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
3912 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
3913 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
3914 } Elm_Toolbar_Shrink_Mode;
3916 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
3917 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
3919 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3920 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
3921 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3922 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3923 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3924 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3925 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3926 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);
3927 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);
3928 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);
3929 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);
3930 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3931 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3932 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3933 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3934 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3935 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
3936 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3937 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3938 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3939 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
3940 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3941 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
3942 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3943 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3944 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3945 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3946 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
3947 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3948 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3949 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3950 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3951 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
3952 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3953 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
3954 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3955 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3956 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3958 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3959 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3960 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
3962 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3963 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
3964 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3965 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);
3966 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
3967 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
3968 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3969 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3970 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3971 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3972 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
3973 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);
3974 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3975 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
3976 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3977 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3978 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3979 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3980 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
3981 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3982 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3983 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3984 /* smart callbacks called:
3985 * "clicked" - when the user clicks on a toolbar item and becomes selected
3987 /* available styles:
3989 * transparent (no background or shadow, just show the provided content)
3993 EAPI double elm_tooltip_delay_get(void);
3994 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
3995 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
3996 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
3997 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
3998 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);
3999 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4000 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4001 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4002 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
4003 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4004 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4005 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4006 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4007 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4008 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4011 EAPI int elm_cursor_engine_only_get(void);
4012 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
4015 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
4016 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4017 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4018 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4020 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4021 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4022 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4023 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);
4024 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
4025 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4026 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
4027 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4028 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4029 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4030 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4031 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4032 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4033 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
4034 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4035 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4036 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4037 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4038 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
4039 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4040 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4041 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4042 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4043 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4044 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4046 /* smart callbacks called:
4047 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
4051 typedef enum _Elm_List_Mode
4053 ELM_LIST_COMPRESS = 0,
4059 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
4060 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4061 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);
4062 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);
4063 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);
4064 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);
4065 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);
4066 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4067 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
4068 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4069 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4070 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
4071 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4073 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4075 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4076 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4077 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4078 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
4080 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4081 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4082 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4083 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4084 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4085 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4086 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4087 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4088 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4089 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
4090 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4091 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
4092 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4093 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4094 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4095 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4096 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4097 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4098 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);
4099 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4100 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4101 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4102 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4103 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4104 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4105 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4106 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4107 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4108 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4109 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4110 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4111 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4112 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4113 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4114 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);
4115 /* smart callbacks called:
4116 * "clicked,double" - when the user double-clicked an item
4117 * "selected" - when the user selected an item
4118 * "unselected" - when the user selected an item
4119 * "longpressed" - an item in the hoversel list is long-pressed
4120 * "scroll,edge,top" - the list is scrolled until the top edge
4121 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
4122 * "scroll,edge,left" - the list is scrolled until the left edge
4123 * "scroll,edge,right" - the list is scrolled until the right edge
4127 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4128 EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4129 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4130 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4131 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4132 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4133 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
4134 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4135 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4136 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
4137 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
4139 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4140 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
4141 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4142 EAPI void elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val)) EINA_ARG_NONNULL(1);
4143 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4144 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4145 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
4146 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
4147 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4148 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4149 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
4150 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
4152 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4153 /* smart callbacks called:
4154 * "changed" - Whenever the slider value is changed by the user.
4155 * "slider,drag,start" - dragging the slider indicator around has started
4156 * "slider,drag,stop" - dragging the slider indicator around has stopped
4157 * "delay,changed" - A short time after the value is changed by the user.
4158 * This will be called only when the user stops dragging for a very short
4159 * period or when they release their finger/mouse, so it avoids possibly
4160 * expensive reactions to the value change.
4164 * @addtogroup Actionslider Actionslider
4166 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
4167 * properties. The indicator is the element the user drags to choose a label.
4168 * When the position is set with magnet, when released the indicator will be
4169 * moved to it if it's nearest the magnetized position.
4171 * @note By default all positions are set as enabled.
4173 * Signals that you can add callbacks for are:
4175 * "selected" - when user selects an enabled position (the label is passed
4178 * "pos_changed" - when the indicator reaches any of the positions("left",
4179 * "right" or "center").
4181 * See an example of actionslider usage @ref actionslider_example_page "here"
4184 typedef enum _Elm_Actionslider_Pos
4186 ELM_ACTIONSLIDER_NONE = 0,
4187 ELM_ACTIONSLIDER_LEFT = 1 << 0,
4188 ELM_ACTIONSLIDER_CENTER = 1 << 1,
4189 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
4190 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
4191 } Elm_Actionslider_Pos;
4194 * Add a new actionslider to the parent.
4196 * @param parent The parent object
4197 * @return The new actionslider object or NULL if it cannot be created
4199 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4201 * Set actionslider labels.
4203 * @param obj The actionslider object
4204 * @param left_label The label to be set on the left.
4205 * @param center_label The label to be set on the center.
4206 * @param right_label The label to be set on the right.
4208 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);
4210 * Get actionslider labels.
4212 * @param obj The actionslider object
4213 * @param left_label A char** to place the left_label of @p obj into.
4214 * @param center_label A char** to place the center_label of @p obj into.
4215 * @param right_label A char** to place the right_label of @p obj into.
4217 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);
4219 * Get actionslider selected label.
4221 * @param obj The actionslider object
4222 * @return The selected label
4224 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4226 * Set actionslider indicator position.
4228 * @param obj The actionslider object.
4229 * @param pos The position of the indicator.
4231 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
4233 * Get actionslider indicator position.
4235 * @param obj The actionslider object.
4236 * @return The position of the indicator.
4238 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240 * Set actionslider magnet position. To make multiple positions magnets @c or
4241 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
4243 * @param obj The actionslider object.
4244 * @param pos Bit mask indicating the magnet positions.
4246 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
4248 * Get actionslider magnet position.
4250 * @param obj The actionslider object.
4251 * @return The positions with magnet property.
4253 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4255 * Set actionslider enabled position. To set multiple positions as enabled @c or
4256 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
4258 * @note All the positions are enabled by default.
4260 * @param obj The actionslider object.
4261 * @param pos Bit mask indicating the enabled positions.
4263 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
4265 * Get actionslider enabled position.
4267 * @param obj The actionslider object.
4268 * @return The enabled positions.
4270 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4272 * Set the label used on the indicator.
4274 * @param obj The actionslider object
4275 * @param label The label to be set on the indicator.
4277 EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4279 * Get the label used on the indicator object.
4281 * @param obj The actionslider object
4282 * @return The indicator label
4284 EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4290 typedef enum _Elm_Genlist_Item_Flags
4292 ELM_GENLIST_ITEM_NONE = 0,
4293 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
4294 ELM_GENLIST_ITEM_GROUP = (1 << 1)
4295 } Elm_Genlist_Item_Flags;
4296 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
4297 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
4298 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
4299 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
4300 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
4301 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
4302 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
4303 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
4305 struct _Elm_Genlist_Item_Class
4307 const char *item_style;
4310 GenlistItemLabelGetFunc label_get;
4311 GenlistItemIconGetFunc icon_get;
4312 GenlistItemStateGetFunc state_get;
4313 GenlistItemDelFunc del;
4314 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
4316 const char *mode_item_style;
4319 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4320 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4321 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4322 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4323 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
4324 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4325 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4326 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4327 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4328 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
4330 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4331 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
4332 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4333 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4334 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4335 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4336 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4337 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
4338 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4339 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4340 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4341 /* operations to add items */
4342 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);
4343 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);
4344 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);
4345 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);
4346 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);
4347 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);
4348 /* operations to retrieve existing items */
4349 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4350 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4351 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4352 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);
4353 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4355 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4356 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);
4357 /* available item styles:
4359 * default_style - The text part is a textblock
4361 * icon_top_text_bottom
4363 /* Genlist Item operation */
4364 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4365 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4366 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4367 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4368 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4369 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4370 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4371 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
4372 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4373 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4374 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4375 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4376 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
4377 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4378 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4379 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4380 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4381 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4382 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4383 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4384 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4385 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4386 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
4387 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4388 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4389 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4390 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
4391 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4392 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
4393 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);
4394 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4395 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
4396 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4397 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4398 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4399 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4400 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
4401 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4402 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4403 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4404 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
4405 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
4406 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
4409 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4410 /** Signals that you can add callbacks for are:
4411 * "clicked,double" - This is called when a user has double-clicked an item.
4412 * The event_info parameter is the genlist item that was
4414 * "selected" - This is called when a user has made an item selected. The
4415 * event_info parameter is the genlist item that was selected.
4416 * "unselected" - This is called when a user has made an item unselected. The
4417 * event_info parameter is the genlist item that was
4419 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
4420 * and the item is now meant to be expanded. The event_info
4421 * parameter is the genlist item that was indicated to expand.
4422 * It is the job of this callback to then fill in the child
4424 * "contracted" - This is called when elm_genlist_item_expanded_set() is
4425 * called and the item is now meant to be contracted. The
4426 * event_info parameter is the genlist item that was indicated
4427 * to contract. It is the job of this callback to then delete
4429 * "expand,request" - This is called when a user has indicated they want to
4430 * expand a tree branch item. The callback should decide
4431 * if the item can expand (has any children) and then call
4432 * elm_genlist_item_expanded_set() appropriately to set
4433 * the state. The event_info parameter is the genlist item
4434 * that was indicated to expand.
4435 * "contract,request" - This is called when a user has indicated they want to
4436 * contract a tree branch item. The callback should
4437 * decide if the item can contract (has any children)
4438 * and then call elm_genlist_item_expanded_set()
4439 * appropriately to set the state. The event_info
4440 * parameter is the genlist item that was indicated to
4442 * "realized" - This is called when the item in the list is created as a real
4443 * evas object. event_info parameter is the genlist item that
4444 * was created. The object may be deleted at any time, so it is
4445 * up to the caller to not use the object pointer from
4446 * elm_genlist_item_object_get() in a way where it may point to
4448 * "unrealized" - This is called just before an item is unrealized. After
4449 * this call icon objects provided will be deleted and the
4450 * item object itself delete or be put into a floating cache.
4451 * "drag,start,up" - This is called when the item in the list has been
4452 * dragged (not scrolled) up.
4453 * "drag,start,down" - This is called when the item in the list has been
4454 * dragged (not scrolled) down.
4455 * "drag,start,left" - This is called when the item in the list has been
4456 * dragged (not scrolled) left.
4457 * "drag,start,right" - This is called when the item in the list has been
4458 * dragged (not scrolled) right.
4459 * "drag,stop" - This is called when the item in the list has stopped being
4461 * "drag" - This is called when the item in the list is being dragged.
4462 * "longpressed" - This is called when the item is pressed for a certain
4463 * amount of time. By default it's 1 second.
4464 * "scroll,edge,top" - This is called when the genlist is scrolled until the
4466 * "scroll,edge,bottom" - This is called when the genlist is scrolled until
4468 * "scroll,edge,left" - This is called when the genlist is scrolled until the
4470 * "scroll,edge,right" - This is called when the genlist is scrolled until
4472 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
4474 * "multi,swipe,right" - This is called when the genlist is multi-touch
4476 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
4478 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
4480 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
4482 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
4484 * "swipe" - This is called when the genlist is swiped.
4488 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4489 EAPI void elm_check_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
4490 EAPI const char *elm_check_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
4491 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon); EINA_ARG_NONNULL(1)
4492 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
4493 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
4494 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state); EINA_ARG_NONNULL(1)
4495 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
4496 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); EINA_ARG_NONNULL(1)
4497 /* smart callbacks called:
4498 * "changed" - This is called whenever the user changes the state of one of the check object.
4502 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4503 EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4504 EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4505 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4506 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4507 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4508 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
4509 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
4510 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4511 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
4512 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4513 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
4514 /* smart callbacks called:
4515 * "changed" - when the radio status is changed
4519 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4520 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4521 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
4522 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4523 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4524 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4525 /* available item styles:
4531 /* smart callbacks called:
4532 * "hide,finished" - when the previous page is hided
4535 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
4536 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
4537 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
4538 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
4539 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
4541 struct _Elm_Slideshow_Item_Class
4543 struct _Elm_Slideshow_Item_Class_Func
4545 SlideshowItemGetFunc get;
4546 SlideshowItemDelFunc del;
4550 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4551 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
4552 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);
4553 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
4554 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4555 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
4556 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4557 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
4558 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4559 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4560 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4561 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
4562 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4563 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4564 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4565 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
4566 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
4567 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4568 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
4569 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
4570 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4571 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
4572 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4573 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
4574 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4575 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
4576 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4577 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4578 /* smart callbacks called:
4579 * "changed" - when the slideshow switch to another item
4583 typedef enum _Elm_Fileselector_Mode
4585 ELM_FILESELECTOR_LIST = 0,
4586 ELM_FILESELECTOR_GRID,
4587 ELM_FILESELECTOR_LAST
4588 } Elm_Fileselector_Mode;
4590 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4591 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
4592 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4593 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
4594 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4595 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
4596 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4598 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
4599 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4600 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4601 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4602 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4603 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
4604 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4605 /* smart callbacks called:
4606 * "selected" - the user click on a file
4607 * "directory,open" - the list is populate with a new content. event_info is a directory.
4608 * "done" - the user click on the ok or cancel buttons
4612 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4613 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
4614 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4615 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4616 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4617 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4618 EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4619 EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4620 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4621 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4622 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4623 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
4624 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4625 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
4626 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4627 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4628 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4629 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
4630 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4631 /* smart callbacks called:
4633 /* available item styles:
4635 * wheel (simple style, no text, no progression, only pulse is available)
4639 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4640 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4641 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4642 /* smart callbacks called:
4646 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4647 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
4648 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4649 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
4650 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
4651 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
4652 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4653 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4654 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4655 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
4656 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4657 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4658 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4659 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
4660 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4661 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4662 /* smart callbacks called:
4663 * "changed" - when the spinner value changes
4664 * "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).
4666 /* available item styles:
4668 * vertical (two up/down buttons at the right side and text left aligned)
4672 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
4674 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4675 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
4676 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4677 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
4678 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4679 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
4680 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
4681 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
4682 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
4683 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
4684 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);
4685 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
4686 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
4687 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4688 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
4689 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
4690 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
4691 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4692 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
4693 /* smart callbacks called:
4694 * "changed" - when the selected index item changes
4695 * "delay,changed" - when the selected index item changes, but after some small idle period
4696 * "selected" - when the user releases a finger and selects an item
4697 * "level,up" - when the user moves a finger from the first level to the second level
4698 * "level,down" - when the user moves a finger from the second level to the first level
4702 typedef enum _Elm_Photocam_Zoom_Mode
4704 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
4705 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
4706 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
4707 ELM_PHOTOCAM_ZOOM_MODE_LAST
4708 } Elm_Photocam_Zoom_Mode;
4710 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4711 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4712 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4713 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
4714 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4715 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
4716 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4717 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4718 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4719 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4720 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4721 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4722 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4723 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4724 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4725 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4726 /* smart callbacks called:
4727 * "clicked" - when image clicked
4728 * "press" - when mouse/finger held down initially on image
4729 * "longpressed" - when mouse/finger held for long time on image
4730 * "clicked,double" - when mouse/finger double-clicked
4731 * "load" - when photo load begins
4732 * "loaded" - when photo load done
4733 * "load,detail" - when detailed image load begins
4734 * "loaded,detail" - when detailed image load done
4735 * "zoom,start" - when zooming started
4736 * "zoom,stop" - when zooming stopped
4737 * "zoom,change" - when auto zoom mode changed zoom level
4738 * "scroll - the content has been scrolled (moved)
4739 * "scroll,anim,start" - scrolling animation has started
4740 * "scroll,anim,stop" - scrolling animation has stopped
4741 * "scroll,drag,start" - dragging the contents around has started
4742 * "scroll,drag,stop" - dragging the contents around has stopped
4746 typedef enum _Elm_Map_Zoom_Mode
4748 ELM_MAP_ZOOM_MODE_MANUAL,
4749 ELM_MAP_ZOOM_MODE_AUTO_FIT,
4750 ELM_MAP_ZOOM_MODE_AUTO_FILL,
4751 ELM_MAP_ZOOM_MODE_LAST
4752 } Elm_Map_Zoom_Mode;
4754 typedef enum _Elm_Map_Route_Sources
4756 ELM_MAP_ROUTE_SOURCE_YOURS,
4757 ELM_MAP_ROUTE_SOURCE_MONAV,
4758 ELM_MAP_ROUTE_SOURCE_ORS,
4759 ELM_MAP_ROUTE_SOURCE_LAST
4760 } Elm_Map_Route_Sources;
4762 typedef enum _Elm_Map_Name_Sources
4764 ELM_MAP_NAME_SOURCE_NOMINATIM,
4765 ELM_MAP_NAME_SOURCE_LAST
4766 } Elm_Map_Name_Sources;
4768 typedef enum _Elm_Map_Route_Type
4770 ELM_MAP_ROUTE_TYPE_MOTOCAR,
4771 ELM_MAP_ROUTE_TYPE_BICYCLE,
4772 ELM_MAP_ROUTE_TYPE_FOOT,
4773 ELM_MAP_ROUTE_TYPE_LAST
4774 } Elm_Map_Route_Type;
4776 typedef enum _Elm_Map_Route_Method
4778 ELM_MAP_ROUTE_METHOD_FASTEST,
4779 ELM_MAP_ROUTE_METHOD_SHORTEST,
4780 ELM_MAP_ROUTE_METHOD_LAST
4781 } Elm_Map_Route_Method;
4783 typedef enum _Elm_Map_Name_Method
4785 ELM_MAP_NAME_METHOD_SEARCH,
4786 ELM_MAP_NAME_METHOD_REVERSE,
4787 ELM_MAP_NAME_METHOD_LAST
4788 } Elm_Map_Name_Method;
4790 typedef struct _Elm_Map_Marker Elm_Map_Marker;
4791 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
4792 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
4793 typedef struct _Elm_Map_Route Elm_Map_Route;
4794 typedef struct _Elm_Map_Name Elm_Map_Name;
4795 typedef struct _Elm_Map_Track Elm_Map_Track;
4797 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
4798 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
4799 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
4800 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
4802 typedef char *(*ElmMapModuleSourceFunc) (void);
4803 typedef int (*ElmMapModuleZoomMinFunc) (void);
4804 typedef int (*ElmMapModuleZoomMaxFunc) (void);
4805 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
4806 typedef int (*ElmMapModuleRouteSourceFunc) (void);
4807 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
4808 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
4809 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
4810 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
4812 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4813 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4814 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4815 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
4816 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4817 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
4818 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4819 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4820 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4821 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4822 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4823 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4824 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
4825 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);
4826 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);
4827 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4828 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
4829 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);
4830 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);
4831 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
4832 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4833 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
4834 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4835 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4836 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
4837 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4838 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4839 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4840 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
4841 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
4842 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
4843 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
4844 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
4845 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
4846 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
4847 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
4848 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
4849 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
4850 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
4851 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
4852 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4853 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
4854 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4855 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
4856 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4857 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4858 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4859 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4860 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4861 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
4862 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4863 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);
4864 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4865 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
4866 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
4867 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4868 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4869 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4870 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
4871 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
4872 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
4873 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
4874 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);
4875 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4876 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4878 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
4880 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
4882 /* smart callbacks called:
4883 * "clicked" - when image clicked
4884 * "press" - when mouse/finger held down initially on image
4885 * "longpressed" - when mouse/finger held for long time on image
4886 * "clicked,double" - when mouse/finger double-clicked
4887 * "load,details" - when detailed image load begins
4888 * "loaded,details" - when detailed image load done
4889 * "zoom,start" - when zooming started
4890 * "zoom,stop" - when zooming stopped
4891 * "zoom,change" - when auto zoom mode changed zoom level
4892 * "scroll - the content has been scrolled (moved)
4893 * "scroll,anim,start" - scrolling animation has started
4894 * "scroll,anim,stop" - scrolling animation has stopped
4895 * "scroll,drag,start" - dragging the contents around has started
4896 * "scroll,drag,stop" - dragging the contents around has stopped
4900 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
4902 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
4904 EAPI double elm_route_lon_min_get(Evas_Object *obj);
4905 EAPI double elm_route_lat_min_get(Evas_Object *obj);
4906 EAPI double elm_route_lon_max_get(Evas_Object *obj);
4907 EAPI double elm_route_lat_max_get(Evas_Object *obj);
4911 typedef enum _Elm_Panel_Orient
4913 ELM_PANEL_ORIENT_TOP,
4914 ELM_PANEL_ORIENT_BOTTOM,
4915 ELM_PANEL_ORIENT_LEFT,
4916 ELM_PANEL_ORIENT_RIGHT,
4919 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4920 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
4921 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4922 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4923 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4925 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
4926 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4927 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
4933 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
4934 * Add events (move, start ...)
4936 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4937 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4938 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4939 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4940 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4941 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4942 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4943 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4944 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
4945 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4946 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4949 typedef enum _Elm_Flip_Mode
4951 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
4952 ELM_FLIP_ROTATE_X_CENTER_AXIS,
4953 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
4954 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
4956 ELM_FLIP_CUBE_RIGHT,
4960 ELM_FLIP_PAGE_RIGHT,
4964 typedef enum _Elm_Flip_Interaction
4966 ELM_FLIP_INTERACTION_NONE,
4967 ELM_FLIP_INTERACTION_ROTATE,
4968 ELM_FLIP_INTERACTION_CUBE,
4969 ELM_FLIP_INTERACTION_PAGE
4970 } Elm_Flip_Interaction;
4971 typedef enum _Elm_Flip_Direction
4973 ELM_FLIP_DIRECTION_UP,
4974 ELM_FLIP_DIRECTION_DOWN,
4975 ELM_FLIP_DIRECTION_LEFT,
4976 ELM_FLIP_DIRECTION_RIGHT
4977 } Elm_Flip_Direction;
4979 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4980 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4981 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4982 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4983 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4984 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4985 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4986 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4987 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4988 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
4989 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
4990 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
4991 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
4992 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
4993 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
4994 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
4995 /* smart callbacks called:
4996 * "animate,begin" - when a flip animation was started
4997 * "animate,done" - when a flip animation is finished
5001 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5002 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
5003 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5004 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
5005 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5006 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5007 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5008 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5009 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5010 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5011 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5012 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5013 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5014 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5015 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
5016 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5017 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5018 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
5019 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
5020 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
5021 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5022 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5023 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5024 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5025 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5026 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5027 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5028 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5029 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5030 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5031 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5032 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
5033 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
5034 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
5035 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5036 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);
5037 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5038 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5039 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);
5040 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5041 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);
5042 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
5043 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5044 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5045 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
5046 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
5047 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5048 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5049 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
5050 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);
5051 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);
5052 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);
5053 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);
5054 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);
5055 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);
5056 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
5057 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
5058 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
5059 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
5060 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5061 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
5062 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5065 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5066 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5067 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5068 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5069 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5072 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5073 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5074 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5075 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5076 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
5077 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5078 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5079 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5080 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
5081 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5084 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item;
5086 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5087 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5088 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
5089 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, void (*func)(void *data, Evas_Object *obj, void *event_info), void *data) EINA_ARG_NONNULL(1);
5090 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, void (*func)(void *data, Evas_Object *obj, void *event_info), void *data) EINA_ARG_NONNULL(1);
5091 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5093 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5094 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5095 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5096 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
5097 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
5098 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
5099 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
5100 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
5101 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
5102 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5103 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5104 /* smart callbacks called:
5105 * "selected" - when flipselector selected item is changed
5106 * "overflowed" - when flipselector item is changed to first item
5108 * "underflowed" - when flipselector item is changed to last item
5111 /* available styles:
5116 * @addtogroup Animator Animator
5117 * @ingroup Elementary
5119 * @brief Functions to ease creation of animations.
5121 * elm_animator is designed to provide an easy way to create animations.
5122 * Creating an animation with elm_animator is as simple as setting a
5123 * duration, an operating callback and telling it to run the animation.
5124 * However that is not the full extent of elm_animator's ability, animations
5125 * can be paused and resumed, reversed and the animation need not be linear.
5127 * To run an animation you must specify at least a duration and operation
5128 * callback, not setting any other properties will create a linear animation
5129 * that runs once and is not reversed.
5131 * @ref elm_animator_example_page_01 "This" example should make all of that
5134 * @warning elm_animator is @b not a widget.
5138 * @brief Type of curve desired for animation.
5140 * The speed in which an animation happens doesn't have to be linear, some
5141 * animations will look better if they're accelerating or decelerating, so
5142 * elm_animator provides four options in this regard:
5143 * @image html elm_animator_curve_style.png
5144 * @image latex elm_animator_curve_style.eps width=\textwidth
5145 * As can be seen in the image the speed of the animation will be:
5146 * @li ELM_ANIMATOR_CURVE_LINEAR constant
5147 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
5148 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
5149 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
5153 ELM_ANIMATOR_CURVE_LINEAR,
5154 ELM_ANIMATOR_CURVE_IN_OUT,
5155 ELM_ANIMATOR_CURVE_IN,
5156 ELM_ANIMATOR_CURVE_OUT
5157 } Elm_Animator_Curve_Style;
5158 typedef struct _Elm_Animator Elm_Animator;
5160 * Called back per loop of an elementary animators cycle
5161 * @param data user-data given to elm_animator_operation_callback_set()
5162 * @param animator the animator being run
5163 * @param double the position in the animation
5165 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
5167 * Called back when an elementary animator finishes
5168 * @param data user-data given to elm_animator_completion_callback_set()
5170 typedef void (*Elm_Animator_Completion_Cb) (void *data);
5173 * @brief Create a new animator.
5175 * @param[in] parent Parent object
5177 * The @a parent argument can be set to NULL for no parent. If a parent is set
5178 * there is no need to call elm_animator_del(), when the parent is deleted it
5179 * will delete the animator.
5181 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
5183 * Deletes the animator freeing any resources it used. If the animator was
5184 * created with a NULL parent this must be called, otherwise it will be
5185 * automatically called when the parent is deleted.
5187 * @param[in] animator Animator object
5189 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5191 * Set the duration of the animation.
5193 * @param[in] animator Animator object
5194 * @param[in] duration Duration in second
5196 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
5198 * @brief Set the callback function for animator operation.
5200 * @param[in] animator Animator object
5201 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
5202 * @param[in] data Callback function user argument
5204 * The @p func callback will be called with a frame value in range [0, 1] which
5205 * indicates how far along the animation should be. It is the job of @p func to
5206 * actually change the state of any object(or objects) that are being animated.
5208 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
5210 * Set the callback function for the when the animation ends.
5212 * @param[in] animator Animator object
5213 * @param[in] func Callback function pointe
5214 * @param[in] data Callback function user argument
5216 * @warning @a func will not be executed if elm_animator_stop() is called.
5218 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
5220 * @brief Stop animator.
5222 * @param[in] animator Animator object
5224 * If called before elm_animator_animate() it does nothing. If there is an
5225 * animation in progress the animation will be stopped(the operation callback
5226 * will not be executed again) and it can't be restarted using
5227 * elm_animator_resume().
5229 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5231 * Set the animator repeat count.
5233 * @param[in] animator Animator object
5234 * @param[in] repeat_cnt Repeat count
5236 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
5238 * @brief Start animation.
5240 * @param[in] animator Animator object
5242 * This function starts the animation if the nescessary properties(duration
5243 * and operation callback) have been set. Once started the animation will
5244 * run until complete or elm_animator_stop() is called.
5246 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5248 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
5250 * @param[in] animator Animator object
5251 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
5253 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
5255 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
5257 * @param[in] animator Animator object
5258 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
5260 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator); EINA_ARG_NONNULL(1);
5262 * @brief Sets wether the animation should be automatically reversed.
5264 * @param[in] animator Animator object
5265 * @param[in] reverse Reverse or not
5267 * This controls wether the animation will be run on reverse imediately after
5268 * running forward. When this is set together with repetition the animation
5269 * will run in reverse once for each time it ran forward.@n
5270 * Runnin an animation in reverse is accomplished by calling the operation
5271 * callback with a frame value starting at 1 and diminshing until 0.
5273 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
5275 * Gets wether the animation will automatically reversed
5277 * @param[in] animator Animator object
5279 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
5281 * Gets the status for the animator operation. The status of the animator @b
5282 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
5283 * only informs if the animation was started and has not ended(either normally
5284 * or through elm_animator_stop()).
5286 * @param[in] animator Animator object
5288 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
5290 * Gets how many times the animation will be repeated
5292 * @param[in] animator Animator object
5294 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
5296 * Pause the animator.
5298 * @param[in] animator Animator object
5300 * This causes the animation to be temporarily stopped(the operation callback
5301 * will not be called). If the animation is not yet running this is a no-op.
5302 * Once an animation has been paused with this function it can be resumed
5303 * using elm_animator_resume().
5305 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5307 * @brief Resumes the animator.
5309 * @param[in] animator Animator object
5311 * Resumes an animation that was paused using elm_animator_pause(), after
5312 * calling this function calls to the operation callback will happen
5313 * normally. If an animation is stopped by means of elm_animator_stop it
5314 * @b can't be restarted with this function.@n
5316 * @warning When an animation is resumed it doesn't start from where it was paused, it
5317 * will go to where it would have been if it had not been paused. If an
5318 * animation with a duration of 3 seconds is paused after 1 second for 1 second
5319 * it will resume as if it had ben animating for 2 seconds, the operating
5320 * callback will be called with a frame value of aproximately 2/3.
5322 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5330 ELM_CALENDAR_UNIQUE,
5332 ELM_CALENDAR_WEEKLY,
5333 ELM_CALENDAR_MONTHLY,
5334 ELM_CALENDAR_ANNUALLY
5335 } Elm_Calendar_Mark_Repeat;
5336 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
5338 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5339 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5340 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
5341 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5342 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5343 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
5344 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
5345 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5346 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
5347 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
5348 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
5349 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
5350 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);
5351 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
5352 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5353 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5354 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
5355 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5356 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5357 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5358 /* smart callbacks called:
5359 * changed - emitted when the user select a day or change the displayed
5364 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
5366 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5367 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5368 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
5369 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5370 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
5371 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5372 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
5373 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5374 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5375 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);
5376 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5377 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5378 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5379 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);
5380 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5381 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5382 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5383 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5384 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5385 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5386 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
5387 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5388 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5389 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5390 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5391 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5392 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5393 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5394 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
5395 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);
5396 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5397 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
5398 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5399 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5400 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5401 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5402 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
5403 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5404 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5405 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5406 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
5407 /* smart callbacks called:
5408 * "selected" - when item is selected (scroller stops)
5412 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5413 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
5414 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
5415 /* smart callbacks called:
5416 * "changed" - when the color value changes
5419 /* Contextual Popup */
5420 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
5422 typedef enum _Elm_Ctxpopup_Direction
5424 ELM_CTXPOPUP_DIRECTION_DOWN,
5425 ELM_CTXPOPUP_DIRECTION_RIGHT,
5426 ELM_CTXPOPUP_DIRECTION_LEFT,
5427 ELM_CTXPOPUP_DIRECTION_UP,
5428 } Elm_Ctxpopup_Direction;
5430 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5431 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5432 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5433 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5434 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
5435 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
5436 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5437 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5438 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5439 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5440 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);
5441 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5442 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5443 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5444 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
5445 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5446 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);
5447 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);
5448 /* smart callbacks called:
5449 * "dismissed" - the ctxpopup was dismissed
5455 * @defgroup Transit Transit
5456 * @ingroup Elementary
5458 * Transit is designed to apply various animated transition effects to @c
5459 * Evas_Object, such like translation, rotation, etc. For using these
5460 * effects, create an @ref Elm_Transit and add the desired transition effects.
5462 * Once the effects are added into transit, they will be automatically
5463 * managed (their callback will be called until the duration is ended, and
5464 * they will be deleted on completion).
5468 * Elm_Transit *trans = elm_transit_add();
5469 * elm_transit_object_add(trans, obj);
5470 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
5471 * elm_transit_duration_set(transit, 1);
5472 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
5473 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
5474 * elm_transit_repeat_times_set(transit, 3);
5477 * Some transition effects are used to change the properties of objects. They
5479 * @li @ref elm_transit_effect_translation_add
5480 * @li @ref elm_transit_effect_color_add
5481 * @li @ref elm_transit_effect_rotation_add
5482 * @li @ref elm_transit_effect_wipe_add
5483 * @li @ref elm_transit_effect_zoom_add
5484 * @li @ref elm_transit_effect_resizing_add
5486 * Other transition effects are used to make one object disappear and another
5487 * object appear on its old place. These effects are:
5489 * @li @ref elm_transit_effect_flip_add
5490 * @li @ref elm_transit_effect_resizable_flip_add
5491 * @li @ref elm_transit_effect_fade_add
5492 * @li @ref elm_transit_effect_blend_add
5494 * It's also possible to make a transition chain with @ref
5495 * elm_transit_chain_transit_add.
5497 * @warning We strongly recommend to use elm_transit just when edje can not do
5498 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
5499 * animations can be manipulated inside the theme.
5502 * @li @ref transit_example_01_explained
5503 * @li @ref transit_example_02_explained
5504 * @li @ref transit_example_03_c
5505 * @li @ref transit_example_04_c
5511 * @enum Elm_Transit_Tween_Mode
5513 * The type of acceleration used in the transition.
5517 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
5518 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
5519 over time, then decrease again
5521 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
5523 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
5525 } Elm_Transit_Tween_Mode;
5528 * @enum Elm_Transit_Effect_Flip_Axis
5530 * The axis where flip effect should be applied.
5534 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
5535 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
5536 } Elm_Transit_Effect_Flip_Axis;
5538 * @enum Elm_Transit_Effect_Wipe_Dir
5540 * The direction where the wipe effect should occur.
5544 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
5545 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
5546 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
5547 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
5548 } Elm_Transit_Effect_Wipe_Dir;
5549 /** @enum Elm_Transit_Effect_Wipe_Type
5551 * Whether the wipe effect should show or hide the object.
5555 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
5557 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
5559 } Elm_Transit_Effect_Wipe_Type;
5562 * @typedef Elm_Transit
5564 * The Transit created with elm_transit_add(). This type has the information
5565 * about the objects which the transition will be applied, and the
5566 * transition effects that will be used. It also contains info about
5567 * duration, number of repetitions, auto-reverse, etc.
5569 typedef struct _Elm_Transit Elm_Transit;
5570 typedef void Elm_Transit_Effect;
5572 * @typedef Elm_Transit_Effect_Transition_Cb
5574 * Transition callback called for this effect on each transition iteration.
5576 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
5578 * Elm_Transit_Effect_End_Cb
5580 * Transition callback called for this effect when the transition is over.
5582 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
5587 * @note Is not necessary to delete the transit object, it will be deleted at
5588 * the end of its operation.
5589 * @note The transit will start playing when the program enter in the main loop, is not
5590 * necessary to give a start to the transit.
5592 * @return The transit object.
5596 EAPI Elm_Transit *elm_transit_add(void);
5599 * Stops the animation and delete the @p transit object.
5601 * Call this function if you wants to stop the animation before the duration
5602 * time. Make sure the @p transit object is still alive with
5603 * elm_transit_del_cb_set() function.
5604 * All added effects will be deleted, calling its repective data_free_cb
5605 * functions. The function setted by elm_transit_del_cb_set() will be called.
5607 * @see elm_transit_del_cb_set()
5609 * @param transit The transit object to be deleted.
5612 * @warning Just call this function if you are sure the transit is alive.
5614 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
5617 * Add a new effect to the transit.
5619 * @note The cb function and the data are the key to the effect. If you try to
5620 * add an already added effect, nothing is done.
5621 * @note After the first addition of an effect in @p transit, if its
5622 * effect list become empty again, the @p transit will be killed by
5623 * elm_transit_del(transit) function.
5627 * Elm_Transit *transit = elm_transit_add();
5628 * elm_transit_effect_add(transit,
5629 * elm_transit_effect_blend_op,
5630 * elm_transit_effect_blend_context_new(),
5631 * elm_transit_effect_blend_context_free);
5634 * @param transit The transit object.
5635 * @param transition_cb The operation function. It is called when the
5636 * animation begins, it is the function that actually performs the animation.
5637 * It is called with the @p data, @p transit and the time progression of the
5638 * animation (a double value between 0.0 and 1.0).
5639 * @param effect The context data of the effect.
5640 * @param end_cb The function to free the context data, it will be called
5641 * at the end of the effect, it must finalize the animation and free the
5645 * @warning The transit free the context data at the and of the transition with
5646 * the data_free_cb function, do not use the context data in another transit.
5648 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);
5651 * Delete an added effect.
5653 * This function will remove the effect from the @p transit, calling the
5654 * data_free_cb to free the @p data.
5656 * @see elm_transit_effect_add()
5658 * @note If the effect is not found, nothing is done.
5659 * @note If the effect list become empty, this function will call
5660 * elm_transit_del(transit), that is, it will kill the @p transit.
5662 * @param transit The transit object.
5663 * @param transition_cb The operation function.
5664 * @param effect The context data of the effect.
5668 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);
5671 * Add new object to apply the effects.
5673 * @note After the first addition of an object in @p transit, if its
5674 * object list become empty again, the @p transit will be killed by
5675 * elm_transit_del(transit) function.
5676 * @note If the @p obj belongs to another transit, the @p obj will be
5677 * removed from it and it will only belong to the @p transit. If the old
5678 * transit stays without objects, it will die.
5679 * @note When you add an object into the @p transit, its state from
5680 * evas_object_pass_events_get(obj) is saved, and it is applied when the
5681 * transit ends, if you change this state whith evas_object_pass_events_set()
5682 * after add the object, this state will change again when @p transit stops to
5685 * @param transit The transit object.
5686 * @param obj Object to be animated.
5689 * @warning It is not allowed to add a new object after transit begins to go.
5691 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
5694 * Removes an added object from the transit.
5696 * @note If the @p obj is not in the @p transit, nothing is done.
5697 * @note If the list become empty, this function will call
5698 * elm_transit_del(transit), that is, it will kill the @p transit.
5700 * @param transit The transit object.
5701 * @param obj Object to be removed from @p transit.
5704 * @warning It is not allowed to remove objects after transit begins to go.
5706 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
5709 * Get the objects of the transit.
5711 * @param transit The transit object.
5712 * @return a Eina_List with the objects from the transit.
5716 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5719 * Enable/disable keeping up the objects states.
5720 * If it is not kept, the objects states will be reset when transition ends.
5722 * @note @p transit can not be NULL.
5723 * @note One state includes geometry, color, map data.
5725 * @param transit The transit object.
5726 * @param state_keep Keeping or Non Keeping.
5730 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
5733 * Get a value whether the objects states will be reset or not.
5735 * @note @p transit can not be NULL
5737 * @see elm_transit_objects_final_state_keep_set()
5739 * @param transit The transit object.
5740 * @return EINA_TRUE means the states of the objects will be reset.
5741 * If @p transit is NULL, EINA_FALSE is returned
5745 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5748 * Set the event enabled when transit is operating.
5750 * If @p enabled is EINA_TRUE, the objects of the transit will receives
5751 * events from mouse and keyboard during the animation.
5752 * @note When you add an object with elm_transit_object_add(), its state from
5753 * evas_object_pass_events_get(obj) is saved, and it is applied when the
5754 * transit ends, if you change this state with evas_object_pass_events_set()
5755 * after adding the object, this state will change again when @p transit stops
5758 * @param transit The transit object.
5759 * @param enabled Events are received when enabled is @c EINA_TRUE, and
5760 * ignored otherwise.
5764 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
5767 * Get the value of event enabled status.
5769 * @see elm_transit_event_enabled_set()
5771 * @param transit The Transit object
5772 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
5773 * EINA_FALSE is returned
5777 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5780 * Set the user-callback function when the transit is deleted.
5782 * @note Using this function twice will overwrite the first function setted.
5783 * @note the @p transit object will be deleted after call @p cb function.
5785 * @param transit The transit object.
5786 * @param cb Callback function pointer. This function will be called before
5787 * the deletion of the transit.
5788 * @param data Callback funtion user data. It is the @p op parameter.
5792 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, void (*cb)(void *data, Elm_Transit* transit), void *data) EINA_ARG_NONNULL(1);
5795 * Set reverse effect automatically.
5797 * If auto reverse is setted, after running the effects with the progress
5798 * parameter from 0 to 1, it will call the effecs again with the progress
5799 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
5800 * where the duration was setted with the function elm_transit_add and
5801 * the repeat with the function elm_transit_repeat_times_set().
5803 * @param transit The transit object.
5804 * @param reverse EINA_TRUE means the auto_reverse is on.
5808 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
5811 * Get if the auto reverse is on.
5813 * @see elm_transit_auto_reverse_set()
5815 * @param transit The transit object.
5816 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
5817 * EINA_FALSE is returned
5821 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5824 * Set the transit repeat count. Effect will be repeated by repeat count.
5826 * This function sets the number of repetition the transit will run after
5827 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
5828 * If the @p repeat is a negative number, it will repeat infinite times.
5830 * @note If this function is called during the transit execution, the transit
5831 * will run @p repeat times, ignoring the times it already performed.
5833 * @param transit The transit object
5834 * @param repeat Repeat count
5838 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
5841 * Get the transit repeat count.
5843 * @see elm_transit_repeat_times_set()
5845 * @param transit The Transit object.
5846 * @return The repeat count. If @p transit is NULL
5851 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5854 * Set the transit animation acceleration type.
5856 * This function sets the tween mode of the transit that can be:
5857 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
5858 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
5859 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
5860 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
5862 * @param transit The transit object.
5863 * @param tween_mode The tween type.
5867 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
5870 * Get the transit animation acceleration type.
5872 * @note @p transit can not be NULL
5874 * @param transit The transit object.
5875 * @return The tween type. If @p transit is NULL
5876 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
5880 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5883 * Set the transit animation time
5885 * @note @p transit can not be NULL
5887 * @param transit The transit object.
5888 * @param duration The animation time.
5892 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
5895 * Get the transit animation time
5897 * @note @p transit can not be NULL
5899 * @param transit The transit object.
5901 * @return The transit animation time.
5905 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5908 * Starts the transition.
5909 * Once this API is called, the transit begins to measure the time.
5911 * @note @p transit can not be NULL
5913 * @param transit The transit object.
5917 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
5920 * Pause/Resume the transition.
5922 * If you call elm_transit_go again, the transit will be started from the
5923 * beginning, and will be unpaused.
5925 * @note @p transit can not be NULL
5927 * @param transit The transit object.
5928 * @param paused Whether the transition should be paused or not.
5932 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
5935 * Get the value of paused status.
5937 * @see elm_transit_paused_set()
5939 * @note @p transit can not be NULL
5941 * @param transit The transit object.
5942 * @return EINA_TRUE means transition is paused. If @p transit is NULL
5943 * EINA_FALSE is returned
5947 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5950 * Get the time progression of the animation (a double value between 0.0 and 1.0).
5952 * The value returned is a fraction (current time / total time). It
5953 * represents the progression position relative to the total.
5955 * @note @p transit can not be NULL
5957 * @param transit The transit object.
5959 * @return The time progression value. If @p transit is NULL
5964 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5967 * Makes the chain relationship between two transits.
5969 * @note @p transit can not be NULL. Transit would have multiple chain transits.
5970 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
5972 * @param transit The transit object.
5973 * @param chain_transit The chain transit object. This transit will be operated
5974 * after transit is done.
5976 * This function adds @p chain_transit transition to a chain after the @p
5977 * transit, and will be started as soon as @p transit ends. See @ref
5978 * transit_example_02_explained for a full example.
5982 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
5985 * Get the current chain transit list.
5987 * @note @p transit can not be NULL.
5989 * @param transit The transit object.
5990 * @return chain transit list.
5994 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
5997 * Add the Resizing Effect to Elm_Transit.
5999 * @note This API is one of the facades. It creates resizing effect context
6000 * and add it's required APIs to elm_transit_effect_add.
6002 * @see elm_transit_effect_add()
6004 * @param transit Transit object.
6005 * @param from_w Object width size when effect begins.
6006 * @param from_h Object height size when effect begins.
6007 * @param to_w Object width size when effect ends.
6008 * @param to_h Object height size when effect ends.
6009 * @return Resizing effect context data.
6013 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);
6016 * Add the Translation Effect to Elm_Transit.
6018 * @note This API is one of the facades. It creates translation effect context
6019 * and add it's required APIs to elm_transit_effect_add.
6021 * @see elm_transit_effect_add()
6023 * @param transit Transit object.
6024 * @param from_dx X Position variation when effect begins.
6025 * @param from_dy Y Position variation when effect begins.
6026 * @param to_dx X Position variation when effect ends.
6027 * @param to_dy Y Position variation when effect ends.
6028 * @return Translation effect context data.
6031 * @warning It is highly recommended just create a transit with this effect when
6032 * the window that the objects of the transit belongs has already been created.
6033 * This is because this effect needs the geometry information about the objects,
6034 * and if the window was not created yet, it can get a wrong information.
6036 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);
6039 * Add the Zoom Effect to Elm_Transit.
6041 * @note This API is one of the facades. It creates zoom effect context
6042 * and add it's required APIs to elm_transit_effect_add.
6044 * @see elm_transit_effect_add()
6046 * @param transit Transit object.
6047 * @param from_rate Scale rate when effect begins (1 is current rate).
6048 * @param to_rate Scale rate when effect ends.
6049 * @return Zoom effect context data.
6052 * @warning It is highly recommended just create a transit with this effect when
6053 * the window that the objects of the transit belongs has already been created.
6054 * This is because this effect needs the geometry information about the objects,
6055 * and if the window was not created yet, it can get a wrong information.
6057 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
6060 * Add the Flip Effect to Elm_Transit.
6062 * @note This API is one of the facades. It creates flip effect context
6063 * and add it's required APIs to elm_transit_effect_add.
6064 * @note This effect is applied to each pair of objects in the order they are listed
6065 * in the transit list of objects. The first object in the pair will be the
6066 * "front" object and the second will be the "back" object.
6068 * @see elm_transit_effect_add()
6070 * @param transit Transit object.
6071 * @param axis Flipping Axis(X or Y).
6072 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
6073 * @return Flip effect context data.
6076 * @warning It is highly recommended just create a transit with this effect when
6077 * the window that the objects of the transit belongs has already been created.
6078 * This is because this effect needs the geometry information about the objects,
6079 * and if the window was not created yet, it can get a wrong information.
6081 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
6084 * Add the Resizable Flip Effect to Elm_Transit.
6086 * @note This API is one of the facades. It creates resizable flip effect context
6087 * and add it's required APIs to elm_transit_effect_add.
6088 * @note This effect is applied to each pair of objects in the order they are listed
6089 * in the transit list of objects. The first object in the pair will be the
6090 * "front" object and the second will be the "back" object.
6092 * @see elm_transit_effect_add()
6094 * @param transit Transit object.
6095 * @param axis Flipping Axis(X or Y).
6096 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
6097 * @return Resizable flip effect context data.
6100 * @warning It is highly recommended just create a transit with this effect when
6101 * the window that the objects of the transit belongs has already been created.
6102 * This is because this effect needs the geometry information about the objects,
6103 * and if the window was not created yet, it can get a wrong information.
6105 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
6108 * Add the Wipe Effect to Elm_Transit.
6110 * @note This API is one of the facades. It creates wipe effect context
6111 * and add it's required APIs to elm_transit_effect_add.
6113 * @see elm_transit_effect_add()
6115 * @param transit Transit object.
6116 * @param type Wipe type. Hide or show.
6117 * @param dir Wipe Direction.
6118 * @return Wipe effect context data.
6121 * @warning It is highly recommended just create a transit with this effect when
6122 * the window that the objects of the transit belongs has already been created.
6123 * This is because this effect needs the geometry information about the objects,
6124 * and if the window was not created yet, it can get a wrong information.
6126 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
6129 * Add the Color Effect to Elm_Transit.
6131 * @note This API is one of the facades. It creates color effect context
6132 * and add it's required APIs to elm_transit_effect_add.
6134 * @see elm_transit_effect_add()
6136 * @param transit Transit object.
6137 * @param from_r RGB R when effect begins.
6138 * @param from_g RGB G when effect begins.
6139 * @param from_b RGB B when effect begins.
6140 * @param from_a RGB A when effect begins.
6141 * @param to_r RGB R when effect ends.
6142 * @param to_g RGB G when effect ends.
6143 * @param to_b RGB B when effect ends.
6144 * @param to_a RGB A when effect ends.
6145 * @return Color effect context data.
6149 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);
6152 * Add the Fade Effect to Elm_Transit.
6154 * @note This API is one of the facades. It creates fade effect context
6155 * and add it's required APIs to elm_transit_effect_add.
6156 * @note This effect is applied to each pair of objects in the order they are listed
6157 * in the transit list of objects. The first object in the pair will be the
6158 * "before" object and the second will be the "after" object.
6160 * @see elm_transit_effect_add()
6162 * @param transit Transit object.
6163 * @return Fade effect context data.
6166 * @warning It is highly recommended just create a transit with this effect when
6167 * the window that the objects of the transit belongs has already been created.
6168 * This is because this effect needs the color information about the objects,
6169 * and if the window was not created yet, it can get a wrong information.
6171 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
6174 * Add the Blend Effect to Elm_Transit.
6176 * @note This API is one of the facades. It creates blend effect context
6177 * and add it's required APIs to elm_transit_effect_add.
6178 * @note This effect is applied to each pair of objects in the order they are listed
6179 * in the transit list of objects. The first object in the pair will be the
6180 * "before" object and the second will be the "after" object.
6182 * @see elm_transit_effect_add()
6184 * @param transit Transit object.
6185 * @return Blend effect context data.
6188 * @warning It is highly recommended just create a transit with this effect when
6189 * the window that the objects of the transit belongs has already been created.
6190 * This is because this effect needs the color information about the objects,
6191 * and if the window was not created yet, it can get a wrong information.
6193 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
6196 * Add the Rotation Effect to Elm_Transit.
6198 * @note This API is one of the facades. It creates rotation effect context
6199 * and add it's required APIs to elm_transit_effect_add.
6201 * @see elm_transit_effect_add()
6203 * @param transit Transit object.
6204 * @param from_degree Degree when effect begins.
6205 * @param to_degree Degree when effect is ends.
6206 * @return Rotation effect context data.
6209 * @warning It is highly recommended just create a transit with this effect when
6210 * the window that the objects of the transit belongs has already been created.
6211 * This is because this effect needs the geometry information about the objects,
6212 * and if the window was not created yet, it can get a wrong information.
6214 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
6217 * Add the ImageAnimation Effect to Elm_Transit.
6219 * @note This API is one of the facades. It creates image animation effect context
6220 * and add it's required APIs to elm_transit_effect_add.
6221 * The @p images parameter is a list images paths. This list and
6222 * its contents will be deleted at the end of the effect by
6223 * elm_transit_effect_image_animation_context_free() function.
6227 * char buf[PATH_MAX];
6228 * Eina_List *images = NULL;
6229 * Elm_Transit *transi = elm_transit_add();
6231 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
6232 * images = eina_list_append(images, eina_stringshare_add(buf));
6234 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
6235 * images = eina_list_append(images, eina_stringshare_add(buf));
6236 * elm_transit_effect_image_animation_add(transi, images);
6240 * @see elm_transit_effect_add()
6242 * @param transit Transit object.
6243 * @param images Eina_List of images file paths. This list and
6244 * its contents will be deleted at the end of the effect by
6245 * elm_transit_effect_image_animation_context_free() function.
6246 * @return Image Animation effect context data.
6250 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
6255 typedef struct _Elm_Store Elm_Store;
6256 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
6257 typedef struct _Elm_Store_Item Elm_Store_Item;
6258 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
6259 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
6260 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
6261 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
6262 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
6263 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
6264 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
6265 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
6267 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
6268 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
6269 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
6270 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
6274 ELM_STORE_ITEM_MAPPING_NONE = 0,
6275 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
6276 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
6277 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
6278 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
6279 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
6280 // can add more here as needed by common apps
6281 ELM_STORE_ITEM_MAPPING_LAST
6282 } Elm_Store_Item_Mapping_Type;
6284 struct _Elm_Store_Item_Mapping_Icon
6286 // FIXME: allow edje file icons
6288 Elm_Icon_Lookup_Order lookup_order;
6289 Eina_Bool standard_name : 1;
6290 Eina_Bool no_scale : 1;
6291 Eina_Bool smooth : 1;
6292 Eina_Bool scale_up : 1;
6293 Eina_Bool scale_down : 1;
6296 struct _Elm_Store_Item_Mapping_Empty
6301 struct _Elm_Store_Item_Mapping_Photo
6306 struct _Elm_Store_Item_Mapping_Custom
6308 Elm_Store_Item_Mapping_Cb func;
6311 struct _Elm_Store_Item_Mapping
6313 Elm_Store_Item_Mapping_Type type;
6318 Elm_Store_Item_Mapping_Empty empty;
6319 Elm_Store_Item_Mapping_Icon icon;
6320 Elm_Store_Item_Mapping_Photo photo;
6321 Elm_Store_Item_Mapping_Custom custom;
6322 // add more types here
6326 struct _Elm_Store_Item_Info
6328 Elm_Genlist_Item_Class *item_class;
6329 const Elm_Store_Item_Mapping *mapping;
6334 struct _Elm_Store_Item_Info_Filesystem
6336 Elm_Store_Item_Info base;
6340 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
6341 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
6343 EAPI void elm_store_free(Elm_Store *st);
6345 EAPI Elm_Store *elm_store_filesystem_new(void);
6346 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
6347 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6348 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6350 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
6353 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6354 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
6355 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
6356 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
6357 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6359 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
6360 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
6361 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6362 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
6363 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6364 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6365 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6367 /* SegmentControl */
6368 typedef struct _Elm_Segment_Item Elm_Segment_Item;
6369 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6370 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
6371 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);
6372 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
6373 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6374 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6375 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6376 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6377 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
6378 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6379 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
6380 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
6381 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
6382 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6383 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
6384 /* smart callbacks called:
6385 * "changed" -when the user clicks on a segment item which is not previously
6386 * selected and get selected. The event_info parameter is the
6387 * segment item index.
6390 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
6391 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
6392 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
6393 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
6394 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
6395 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
6396 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
6397 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
6399 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
6400 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);