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_DEBUG_DEF@ ELM_DEBUG
98 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
99 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
102 # include "elementary_config.h"
105 /* Standard headers for standard system calls etc. */
110 #include <sys/types.h>
111 #include <sys/stat.h>
112 #include <sys/time.h>
113 #include <sys/param.h>
126 # ifdef ELM_LIBINTL_H
127 # include <libintl.h>
138 #if defined (ELM_WIN32) || defined (ELM_WINCE)
141 # define alloca _alloca
152 #include <Ecore_Evas.h>
153 #include <Ecore_File.h>
154 #include <Ecore_IMF.h>
163 # include <Efreet_Mime.h>
164 # include <Efreet_Trash.h>
168 # include <Ethumb_Client.h>
171 #ifdef HAVE_ELEMENTARY_EMAP
180 # ifdef ELEMENTARY_BUILD
182 # define EAPI __declspec(dllexport)
185 # endif /* ! DLL_EXPORT */
187 # define EAPI __declspec(dllimport)
188 # endif /* ! EFL_EVAS_BUILD */
192 # define EAPI __attribute__ ((visibility("default")))
199 #endif /* ! _WIN32 */
202 /* allow usage from c++ */
207 #define ELM_VERSION_MAJOR @VMAJ@
208 #define ELM_VERSION_MINOR @VMIN@
210 typedef struct _Elm_Version
218 EAPI extern Elm_Version *elm_version;
221 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
222 #define ELM_PI 3.14159265358979323846
225 * @defgroup General General
227 * @brief General Elementary API. Functions that don't relate to
228 * Elementary objects specifically.
230 * Here are documented functions which init/shutdown the library,
231 * that apply to generic Elementary objects, that deal with
232 * configuration, et cetera.
234 * @ref general_functions_example_page "This" example contemplates
235 * some of these functions.
239 * @addtogroup General
244 * Defines couple of standard Evas_Object layers to be used
245 * with evas_object_layer_set().
247 * @note whenever extending with new values, try to keep some padding
248 * to siblings so there is room for further extensions.
250 typedef enum _Elm_Object_Layer
252 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
253 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
254 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
255 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
256 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
257 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
260 /**************************************************************************/
261 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
264 * Emitted when any Elementary's policy value is changed.
266 EAPI extern int ELM_EVENT_POLICY_CHANGED;
269 * @typedef Elm_Event_Policy_Changed
271 * Data on the event when an Elementary policy has changed
273 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
276 * @struct _Elm_Event_Policy_Changed
278 * Data on the event when an Elementary policy has changed
280 struct _Elm_Event_Policy_Changed
282 unsigned int policy; /**< the policy identifier */
283 int new_value; /**< value the policy had before the change */
284 int old_value; /**< new value the policy got */
288 * Policy identifiers.
290 typedef enum _Elm_Policy
292 ELM_POLICY_QUIT, /**< under which circunstances the application
293 * should quit automatically. @see
297 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
300 typedef enum _Elm_Policy_Quit
302 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
304 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
306 * window is closed */
307 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
309 typedef enum _Elm_Focus_Direction
313 } Elm_Focus_Direction;
315 typedef enum _Elm_Text_Format
317 ELM_TEXT_FORMAT_PLAIN_UTF8,
318 ELM_TEXT_FORMAT_MARKUP_UTF8
322 * Line wrapping types.
324 typedef enum _Elm_Wrap_Type
326 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
327 ELM_WRAP_CHAR, /**< Char wrap - wrap between graphmes */
328 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
329 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
335 * Called back when a widget's tooltip is activated and needs content.
336 * @param data user-data given to elm_object_tooltip_content_cb_set()
337 * @param obj owner widget.
339 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
342 * Called back when a widget's item tooltip is activated and needs content.
343 * @param data user-data given to elm_object_tooltip_content_cb_set()
344 * @param obj owner widget.
345 * @param item context dependent item. As an example, if tooltip was
346 * set on Elm_List_Item, then it is of this type.
348 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
350 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
352 #ifndef ELM_LIB_QUICKLAUNCH
353 #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 */
355 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
358 /**************************************************************************/
362 * Initialize Elementary
364 * @param[in] argc System's argument count value
365 * @param[in] argv System's pointer to array of argument strings
366 * @return The init counter value.
368 * This function initializes Elementary and increments a counter of
369 * the number of calls to it. It returs the new counter's value.
371 * @warning This call is exported only for use by the @c ELM_MAIN()
372 * macro. There is no need to use this if you use this macro (which
373 * is highly advisable). An elm_main() should contain the entry
374 * point code for your application, having the same prototype as
375 * elm_init(), and @b not being static (putting the @c EAPI symbol
376 * in front of its type declaration is advisable). The @c
377 * ELM_MAIN() call should be placed just after it.
380 * @dontinclude bg_example_01.c
384 * See the full @ref bg_example_01_c "example".
386 * @see elm_shutdown().
389 EAPI int elm_init(int argc, char **argv);
392 * Shut down Elementary
394 * @return The init counter value.
396 * This should be called at the end of your application, just
397 * before it ceases to do any more processing. This will clean up
398 * any permanent resources your application may have allocated via
399 * Elementary that would otherwise persist.
401 * @see elm_init() for an example
405 EAPI int elm_shutdown(void);
408 * Run Elementary's main loop
410 * This call should be issued just after all initialization is
411 * completed. This function will not return until elm_exit() is
412 * called. It will keep looping, running the main
413 * (event/processing) loop for Elementary.
415 * @see elm_init() for an example
419 EAPI void elm_run(void);
422 * Exit Elementary's main loop
424 * If this call is issued, it will flag the main loop to cease
425 * processing and return back to its parent function (usually your
426 * elm_main() function).
428 * @see elm_init() for an example. There, just after a request to
429 * close the window comes, the main loop will be left.
431 * @note By using the #ELM_POLICY_QUIT on your Elementary
432 * applications, you'll this function called automatically for you.
436 EAPI void elm_exit(void);
439 * Provide information in order to make Elementary determine the @b
440 * run time location of the software in question, so other data files
441 * such as images, sound files, executable utilities, libraries,
442 * modules and locale files can be found.
444 * @param mainfunc This is your application's main function name,
445 * whose binary's location is to be found. Providing @c NULL
446 * will make Elementary not to use it
447 * @param dom This will be used as the application's "domain", in the
448 * form of a prefix to any environment variables that may
449 * override prefix detection and the directory name, inside the
450 * standard share or data directories, where the software's
451 * data files will be looked for.
452 * @param checkfile This is an (optional) magic file's path to check
453 * for existence (and it must be located in the data directory,
454 * under the share directory provided above). Its presence will
455 * help determine the prefix found was correct. Pass @c NULL if
456 * the check is not to be done.
458 * This function allows one to re-locate the application somewhere
459 * else after compilation, if the developer wishes for easier
460 * distribution of pre-compiled binaries.
462 * The prefix system is designed to locate where the given software is
463 * installed (under a common path prefix) at run time and then report
464 * specific locations of this prefix and common directories inside
465 * this prefix like the binary, library, data and locale directories,
466 * through the @c elm_app_*_get() family of functions.
468 * Call elm_app_info_set() early on before you change working
469 * directory or anything about @c argv[0], so it gets accurate
472 * It will then try and trace back which file @p mainfunc comes from,
473 * if provided, to determine the application's prefix directory.
475 * The @p dom parameter provides a string prefix to prepend before
476 * environment variables, allowing a fallback to @b specific
477 * environment variables to locate the software. You would most
478 * probably provide a lowercase string there, because it will also
479 * serve as directory domain, explained next. For environment
480 * variables purposes, this string is made uppercase. For example if
481 * @c "myapp" is provided as the prefix, then the program would expect
482 * @c "MYAPP_PREFIX" as a master environment variable to specify the
483 * exact install prefix for the software, or more specific environment
484 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
485 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
486 * the user or scripts before launching. If not provided (@c NULL),
487 * environment variables will not be used to override compiled-in
488 * defaults or auto detections.
490 * The @p dom string also provides a subdirectory inside the system
491 * shared data directory for data files. For example, if the system
492 * directory is @c /usr/local/share, then this directory name is
493 * appended, creating @c /usr/local/share/myapp, if it @p was @c
494 * "myapp". It is expected the application installs data files in
497 * The @p checkfile is a file name or path of something inside the
498 * share or data directory to be used to test that the prefix
499 * detection worked. For example, your app will install a wallpaper
500 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
501 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
504 * @see elm_app_compile_bin_dir_set()
505 * @see elm_app_compile_lib_dir_set()
506 * @see elm_app_compile_data_dir_set()
507 * @see elm_app_compile_locale_set()
508 * @see elm_app_prefix_dir_get()
509 * @see elm_app_bin_dir_get()
510 * @see elm_app_lib_dir_get()
511 * @see elm_app_data_dir_get()
512 * @see elm_app_locale_dir_get()
514 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
517 * Provide information on the @b fallback application's binaries
518 * directory, on scenarios where they get overriden by
519 * elm_app_info_set().
521 * @param dir The path to the default binaries directory (compile time
524 * @note Elementary will as well use this path to determine actual
525 * names of binaries' directory paths, maybe changing it to be @c
526 * something/local/bin instead of @c something/bin, only, for
529 * @warning You should call this function @b before
530 * elm_app_info_set().
532 EAPI void elm_app_compile_bin_dir_set(const char *dir);
535 * Provide information on the @b fallback application's libraries
536 * directory, on scenarios where they get overriden by
537 * elm_app_info_set().
539 * @param dir The path to the default libraries directory (compile
542 * @note Elementary will as well use this path to determine actual
543 * names of libraries' directory paths, maybe changing it to be @c
544 * something/lib32 or @c something/lib64 instead of @c something/lib,
547 * @warning You should call this function @b before
548 * elm_app_info_set().
550 EAPI void elm_app_compile_lib_dir_set(const char *dir);
553 * Provide information on the @b fallback application's data
554 * directory, on scenarios where they get overriden by
555 * elm_app_info_set().
557 * @param dir The path to the default data directory (compile time
560 * @note Elementary will as well use this path to determine actual
561 * names of data directory paths, maybe changing it to be @c
562 * something/local/share instead of @c something/share, only, for
565 * @warning You should call this function @b before
566 * elm_app_info_set().
568 EAPI void elm_app_compile_data_dir_set(const char *dir);
571 * Provide information on the @b fallback application's locale
572 * directory, on scenarios where they get overriden by
573 * elm_app_info_set().
575 * @param dir The path to the default locale directory (compile time
578 * @warning You should call this function @b before
579 * elm_app_info_set().
581 EAPI void elm_app_compile_locale_set(const char *dir);
584 * Retrieve the application's run time prefix directory, as set by
585 * elm_app_info_set() and the way (environment) the application was
588 * @return The directory prefix the application is actually using
590 EAPI const char *elm_app_prefix_dir_get(void);
593 * Retrieve the application's run time binaries prefix directory, as
594 * set by elm_app_info_set() and the way (environment) the application
597 * @return The binaries directory prefix the application is actually
600 EAPI const char *elm_app_bin_dir_get(void);
603 * Retrieve the application's run time libraries prefix directory, as
604 * set by elm_app_info_set() and the way (environment) the application
607 * @return The libraries directory prefix the application is actually
610 EAPI const char *elm_app_lib_dir_get(void);
613 * Retrieve the application's run time data prefix directory, as
614 * set by elm_app_info_set() and the way (environment) the application
617 * @return The data directory prefix the application is actually
620 EAPI const char *elm_app_data_dir_get(void);
623 * Retrieve the application's run time locale prefix directory, as
624 * set by elm_app_info_set() and the way (environment) the application
627 * @return The locale directory prefix the application is actually
630 EAPI const char *elm_app_locale_dir_get(void);
632 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
633 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
634 EAPI int elm_quicklaunch_init(int argc, char **argv);
635 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
636 EAPI int elm_quicklaunch_sub_shutdown(void);
637 EAPI int elm_quicklaunch_shutdown(void);
638 EAPI void elm_quicklaunch_seed(void);
639 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
640 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
641 EAPI void elm_quicklaunch_cleanup(void);
642 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
643 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
645 EAPI Eina_Bool elm_need_efreet(void);
646 EAPI Eina_Bool elm_need_e_dbus(void);
647 EAPI Eina_Bool elm_need_ethumb(void);
650 * Set a new policy's value (for a given policy group/identifier).
652 * @param policy policy identifier, as in @ref Elm_Policy.
653 * @param value policy value, which depends on the identifier
655 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
657 * Elementary policies define applications' behavior,
658 * somehow. These behaviors are divided in policy groups (see
659 * #Elm_Policy enumeration). This call will emit the Ecore event
660 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
661 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
664 * @note Currently, we have only one policy identifier/group
665 * (#ELM_POLICY_QUIT), which has two possible values.
669 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
672 * Gets the policy value set for given policy identifier.
674 * @param policy policy identifier, as in #Elm_Policy.
675 * @return The currently set policy value, for that
676 * identifier. Will be @c 0 if @p policy passed is invalid.
680 EAPI int elm_policy_get(unsigned int policy);
686 EAPI void elm_all_flush(void);
687 EAPI int elm_cache_flush_interval_get(void);
688 EAPI void elm_cache_flush_interval_set(int size);
689 EAPI void elm_cache_flush_interval_all_set(int size);
690 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
691 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
692 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
693 EAPI int elm_font_cache_get(void);
694 EAPI void elm_font_cache_set(int size);
695 EAPI void elm_font_cache_all_set(int size);
696 EAPI int elm_image_cache_get(void);
697 EAPI void elm_image_cache_set(int size);
698 EAPI void elm_image_cache_all_set(int size);
699 EAPI int elm_edje_file_cache_get(void);
700 EAPI void elm_edje_file_cache_set(int size);
701 EAPI void elm_edje_file_cache_all_set(int size);
702 EAPI int elm_edje_collection_cache_get(void);
703 EAPI void elm_edje_collection_cache_set(int size);
704 EAPI void elm_edje_collection_cache_all_set(int size);
707 * @defgroup Scaling Selective Widget Scaling
709 * Different widgets can be scaled independently. These functions
710 * allow you to manipulate this scaling on a per-widget basis. The
711 * object and all its children get their scaling factors multiplied
712 * by the scale factor set. This is multiplicative, in that if a
713 * child also has a scale size set it is in turn multiplied by its
714 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
715 * double size, @c 0.5 is half, etc.
717 * @ref general_functions_example_page "This" example contemplates
718 * some of these functions.
722 * Set the scaling factor for a given Elementary object
724 * @param obj The Elementary to operate on
725 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
730 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
733 * Get the scaling factor for a given Elementary object
735 * @param obj The object
736 * @return The scaling factor set by elm_object_scale_set()
740 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
741 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
742 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
743 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
744 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
746 * Set the style to use by a widget
748 * Sets the style name that will define the appearance of a widget. Styles
749 * vary from widget to widget and may also be defined by other themes
750 * by means of extensions and overlays.
752 * @param obj The Elementary widget to style
753 * @param style The style name to use
755 * @see elm_theme_extension_add()
756 * @see elm_theme_overlay_add()
760 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
762 * Get the style used by the widget
764 * This gets the style being used for that widget. Note that the string
765 * pointer is only valid as longas the object is valid and the style doesn't
768 * @param obj The Elementary widget to query for its style
769 * @return The style name used
771 * @see elm_object_style_set()
775 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
778 * @defgroup Styles Styles
780 * Widgets can have different styles of look. These generic API's
781 * set styles of widgets, if they support them (and if the theme(s)
784 * @ref general_functions_example_page "This" example contemplates
785 * some of these functions.
789 * Set the disabled state of an Elementary object.
791 * @param obj The Elementary object to operate on
792 * @param disabled The state to put in in: @c EINA_TRUE for
793 * disabled, @c EINA_FALSE for enabled
795 * Elementary objects can be @b disabled, in which state they won't
796 * receive input and, in general, will be themed differently from
797 * their normal state, usually greyed out. Useful for contexts
798 * where you don't want your users to interact with some of the
799 * parts of you interface.
801 * This sets the state for the widget, either disabling it or
806 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
809 * Get the disabled state of an Elementary object.
811 * @param obj The Elementary object to operate on
812 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
813 * if it's enabled (or on errors)
815 * This gets the state of the widget, which might be enabled or disabled.
819 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
822 * @defgroup WidgetNavigation Widget Tree Navigation.
824 * How to check if an Evas Object is an Elementary widget? How to
825 * get the first elementary widget that is parent of the given
826 * object? These are all covered in widget tree navigation.
828 * @ref general_functions_example_page "This" example contemplates
829 * some of these functions.
832 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
835 * Get the first parent of the given object that is an Elementary
838 * @param obj the Elementary object to query parent from.
839 * @return the parent object that is an Elementary widget, or @c
840 * NULL, if it was not found.
842 * Use this to query for an object's parent widget.
844 * @note Most of Elementary users wouldn't be mixing non-Elementary
845 * smart objects in the objects tree of an application, as this is
846 * an advanced usage of Elementary with Evas. So, except for the
847 * application's window, which is the root of that tree, all other
848 * objects would have valid Elementary widget parents.
850 * @ingroup WidgetNavigation
852 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
853 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
854 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
856 EAPI double elm_scale_get(void);
857 EAPI void elm_scale_set(double scale);
858 EAPI void elm_scale_all_set(double scale);
860 EAPI Eina_Bool elm_mirrored_get(void);
861 EAPI void elm_mirrored_set(Eina_Bool mirrored);
863 EAPI Eina_Bool elm_config_save(void);
864 EAPI void elm_config_reload(void);
866 EAPI const char *elm_profile_current_get(void);
867 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
868 EAPI void elm_profile_dir_free(const char *p_dir);
869 EAPI Eina_List *elm_profile_list_get(void);
870 EAPI void elm_profile_list_free(Eina_List *l);
871 EAPI void elm_profile_set(const char *profile);
872 EAPI void elm_profile_all_set(const char *profile);
874 EAPI const char *elm_engine_current_get(void);
875 EAPI void elm_engine_set(const char *engine);
877 typedef struct _Elm_Text_Class
883 typedef struct _Elm_Font_Overlay
885 const char *text_class;
890 typedef struct _Elm_Font_Properties
894 } Elm_Font_Properties;
896 EAPI const Eina_List *elm_text_classes_list_get(void);
897 EAPI void elm_text_classes_list_free(const Eina_List *list);
899 EAPI const Eina_List *elm_font_overlay_list_get(void);
900 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
901 EAPI void elm_font_overlay_unset(const char *text_class);
902 EAPI void elm_font_overlay_apply(void);
903 EAPI void elm_font_overlay_all_apply(void);
905 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
906 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
907 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
908 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
909 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
910 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
913 * @defgroup Fingers Fingers
915 * Elementary is designed to be finger-friendly for touchscreens,
916 * and so in addition to scaling for display resolution, it can
917 * also scale based on finger "resolution" (or size). You can then
918 * customize the granularity of the areas meant to receive clicks
921 * Different profiles may have pre-set values for finger sizes.
923 * @ref general_functions_example_page "This" example contemplates
924 * some of these functions.
928 * Get the configured "finger size"
930 * @return The finger size
932 * This gets the globally configured finger size, <b>in pixels</b>
936 EAPI Evas_Coord elm_finger_size_get(void);
937 EAPI void elm_finger_size_set(Evas_Coord size);
938 EAPI void elm_finger_size_all_set(Evas_Coord size);
941 * @defgroup Focus Focus
943 * An Elementary application has, at all times, one (and only one)
944 * @b focused object. This is what determines where the input
945 * events go to within the application's window. Also, focused
946 * objects can be decorated differently, in order to signal to the
947 * user where the input is, at a given moment.
949 * Elementary applications also have the concept of <b>focus
950 * chain</b>: one can cycle through all the windows' focusable
951 * objects by input (tab key) or programmatically. The default
952 * focus chain for an application is the one define by the order in
953 * which the widgets where added in code. One will cycle through
954 * top level widgets, and, for each one containg sub-objects, cycle
955 * through them all, before returning to the level
956 * above. Elementary also allows one to set @b custom focus chains
957 * for their applications.
959 * Besides the focused decoration a widget may exhibit, when it
960 * gets focus, Elementary has a @b global focus highlight object
961 * that can be enabled for a window. If one chooses to do so, this
962 * extra highlight effect will surround the current focused object,
965 * @note Some Elementary widgets are @b unfocusable, after
966 * creation, by their very nature: they are not meant to be
967 * interacted with input events, but are there just for visual
970 * @ref general_functions_example_page "This" example contemplates
971 * some of these functions.
974 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
975 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
976 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
977 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
980 * Get the whether an Elementary object has the focus or not.
982 * @param obj The Elementary object to get the information from
983 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
984 * not (and on errors).
986 * @see elm_object_focus()
990 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
993 * Make a given Elementary object the focused one.
995 * @param obj The Elementary object to make focused.
997 * @note This object, if it can handle focus, will take the focus
998 * away from the one who had it previously and will, for now on, be
999 * the one receiving input events.
1001 * @see elm_object_focus_get()
1005 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1008 * Remove the focus from an Elementary object
1010 * @param obj The Elementary to take focus from
1012 * This removes the focus from @p obj, passing it back to the
1013 * previous element in the focus chain list.
1015 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1019 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1022 * Set the ability for an Element object to be focused
1024 * @param obj The Elementary object to operate on
1025 * @param enable @c EINA_TRUE if the object can be focused, @c
1026 * EINA_FALSE if not (and on errors)
1028 * This sets whether the object @p obj is able to take focus or
1029 * not. Unfocusable objects do nothing when programmatically
1030 * focused, being the nearest focusable parent object the one
1031 * really getting focus. Also, when they receive mouse input, they
1032 * will get the event, but not take away the focus from where it
1037 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1040 * Get whether an Elementary object is focusable or not
1042 * @param obj The Elementary object to operate on
1043 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1044 * EINA_FALSE if not (and on errors)
1046 * @note Objects which are meant to be interacted with by input
1047 * events are created able to be focused, by default. All the
1052 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1054 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1055 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1056 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1057 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1058 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1059 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1060 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1062 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1063 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1064 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1065 EAPI double elm_scroll_bounce_friction_get(void);
1066 EAPI void elm_scroll_bounce_friction_set(double friction);
1067 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1068 EAPI double elm_scroll_page_scroll_friction_get(void);
1069 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1070 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1071 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1072 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1073 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1074 EAPI double elm_scroll_zoom_friction_get(void);
1075 EAPI void elm_scroll_zoom_friction_set(double friction);
1076 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1077 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1078 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1079 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1080 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1081 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1082 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1083 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1084 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1085 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1086 EAPI double elm_scroll_thumbscroll_friction_get(void);
1087 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1088 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1089 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1090 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1091 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1093 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1094 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1095 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1096 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1097 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1098 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1099 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1100 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1102 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1103 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);
1104 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);
1106 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1107 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1110 * Adjust size of an element for finger usage.
1112 * @param times_w How many fingers should fit horizontally
1113 * @param w Pointer to the width size to adjust
1114 * @param times_h How many fingers should fit vertically
1115 * @param h Pointer to the height size to adjust
1117 * This takes width and height sizes (in pixels) as input and a
1118 * size multiple (which is how many fingers you want to place
1119 * within the area, being "finger" the size set by
1120 * elm_finger_size_set()), and adjusts the size to be large enough
1121 * to accommodate the resulting size -- if it doesn't already
1122 * accommodate it. On return the @p w and @p h sizes pointed to by
1123 * these parameters will be modified, on those conditions.
1125 * @note This is kind of a low level Elementary call, most useful
1126 * on size evaluation times for widgets. An external user wouldn't
1127 * be calling, most of the time.
1131 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1133 EAPI double elm_longpress_timeout_get(void);
1134 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1137 * don't use it unless you are sure
1139 EAPI void elm_object_tree_dump(const Evas_Object *top);
1140 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1145 * @defgroup Theme Theme
1147 * Elementary uses Edje to theme its widgets, naturally. But for the most
1148 * part this is hidden behind a simpler interface that lets the user set
1149 * extensions and choose the style of widgets in a much easier way.
1151 * Instead of thinking in terms of paths to Edje files and their groups
1152 * each time you want to change the appearance of a widget, Elementary
1153 * works so you can add any theme file with extensions or replace the
1154 * main theme at one point in the application, and then just set the style
1155 * of widgets with elm_object_style_set() and related functions. Elementary
1156 * will then look in its list of themes for a matching group and apply it,
1157 * and when the theme changes midway through the application, all widgets
1158 * will be updated accordingly.
1160 * There are three concepts you need to know to understand how Elementary
1161 * theming works: default theme, extensions and overlays.
1163 * Default theme, obviously enough, is the one that provides the default
1164 * look of all widgets. End users can change the theme used by Elementary
1165 * by setting the @c ELM_THEME environment variable before running an
1166 * application, or globally for all programs using the @c elementary_config
1167 * utility. Applications can change the default theme using elm_theme_set(),
1168 * but this can go against the user wishes, so it's not an adviced practice.
1170 * Ideally, applications should find everything they need in the already
1171 * provided theme, but there may be occasions when that's not enough and
1172 * custom styles are required to correctly express the idea. For this
1173 * cases, Elementary has extensions.
1175 * Extensions allow the application developer to write styles of its own
1176 * to apply to some widgets. This requires knowledge of how each widget
1177 * is themed, as extensions will always replace the entire group used by
1178 * the widget, so important signals and parts need to be there for the
1179 * object to behave properly (see documentation of Edje for details).
1180 * Once the theme for the extension is done, the application needs to add
1181 * it to the list of themes Elementary will look into, using
1182 * elm_theme_extension_add(), and set the style of the desired widgets as
1183 * he would normally with elm_object_style_set().
1185 * Overlays, on the other hand, can replace the look of all widgets by
1186 * overriding the default style. Like extensions, it's up to the application
1187 * developer to write the theme for the widgets it wants, the difference
1188 * being that when looking for the theme, Elementary will check first the
1189 * list of overlays, then the set theme and lastly the list of extensions,
1190 * so with overlays it's possible to replace the default view and every
1191 * widget will be affected. This is very much alike to setting the whole
1192 * theme for the application and will probably clash with the end user
1193 * options, not to mention the risk of ending up with not matching styles
1194 * across the program. Unless there's a very special reason to use them,
1195 * overlays should be avoided for the resons exposed before.
1197 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1198 * keeps one default internally and every function that receives one of
1199 * these can be called with NULL to refer to this default (except for
1200 * elm_theme_free()). It's possible to create a new instance of a
1201 * ::Elm_Theme to set other theme for a specific widget (and all of its
1202 * children), but this is as discouraged, if not even more so, than using
1203 * overlays. Don't use this unless you really know what you are doing.
1205 * But to be less negative about things, you can look at the following
1207 * @li @ref theme_example_01 "Using extensions"
1208 * @li @ref theme_example_02 "Using overlays"
1213 * @typedef Elm_Theme
1215 * Opaque handler for the list of themes Elementary looks for when
1216 * rendering widgets.
1218 * Stay out of this unless you really know what you are doing. For most
1219 * cases, sticking to the default is all a developer needs.
1221 typedef struct _Elm_Theme Elm_Theme;
1224 * Create a new specific theme
1226 * This creates an empty specific theme that only uses the default theme. A
1227 * specific theme has its own private set of extensions and overlays too
1228 * (which are empty by default). Specific themes do not fall back to themes
1229 * of parent objects. They are not intended for this use. Use styles, overlays
1230 * and extensions when needed, but avoid specific themes unless there is no
1231 * other way (example: you want to have a preview of a new theme you are
1232 * selecting in a "theme selector" window. The preview is inside a scroller
1233 * and should display what the theme you selected will look like, but not
1234 * actually apply it yet. The child of the scroller will have a specific
1235 * theme set to show this preview before the user decides to apply it to all
1238 EAPI Elm_Theme *elm_theme_new(void);
1240 * Free a specific theme
1242 * @param th The theme to free
1244 * This frees a theme created with elm_theme_new().
1246 EAPI void elm_theme_free(Elm_Theme *th);
1248 * Copy the theme fom the source to the destination theme
1250 * @param th The source theme to copy from
1251 * @param thdst The destination theme to copy data to
1253 * This makes a one-time static copy of all the theme config, extensions
1254 * and overlays from @p th to @p thdst. If @p th references a theme, then
1255 * @p thdst is also set to reference it, with all the theme settings,
1256 * overlays and extensions that @p th had.
1258 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1260 * Tell the source theme to reference the ref theme
1262 * @param th The theme that will do the referencing
1263 * @param thref The theme that is the reference source
1265 * This clears @p th to be empty and then sets it to refer to @p thref
1266 * so @p th acts as an override to @p thref, but where its overrides
1267 * don't apply, it will fall through to @pthref for configuration.
1269 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1271 * Return the theme referred to
1273 * @param th The theme to get the reference from
1274 * @return The referenced theme handle
1276 * This gets the theme set as the reference theme by elm_theme_ref_set().
1277 * If no theme is set as a reference, NULL is returned.
1279 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1281 * Return the default theme
1283 * @return The default theme handle
1285 * This returns the internal default theme setup handle that all widgets
1286 * use implicitly unless a specific theme is set. This is also often use
1287 * as a shorthand of NULL.
1289 EAPI Elm_Theme *elm_theme_default_get(void);
1291 * Prepends a theme overlay to the list of overlays
1293 * @param th The theme to add to, or if NULL, the default theme
1294 * @param item The Edje file path to be used
1296 * Use this if your application needs to provide some custom overlay theme
1297 * (An Edje file that replaces some default styles of widgets) where adding
1298 * new styles, or changing system theme configuration is not possible. Do
1299 * NOT use this instead of a proper system theme configuration. Use proper
1300 * configuration files, profiles, environment variables etc. to set a theme
1301 * so that the theme can be altered by simple confiugration by a user. Using
1302 * this call to achieve that effect is abusing the API and will create lots
1305 * @see elm_theme_extension_add()
1307 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1309 * Delete a theme overlay from the list of overlays
1311 * @param th The theme to delete from, or if NULL, the default theme
1312 * @param item The name of the theme overlay
1314 * @see elm_theme_overlay_add()
1316 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1318 * Appends a theme extension to the list of extensions.
1320 * @param th The theme to add to, or if NULL, the default theme
1321 * @param item The Edje file path to be used
1323 * This is intended when an application needs more styles of widgets or new
1324 * widget themes that the default does not provide (or may not provide). The
1325 * application has "extended" usage by coming up with new custom style names
1326 * for widgets for specific uses, but as these are not "standard", they are
1327 * not guaranteed to be provided by a default theme. This means the
1328 * application is required to provide these extra elements itself in specific
1329 * Edje files. This call adds one of those Edje files to the theme search
1330 * path to be search after the default theme. The use of this call is
1331 * encouraged when default styles do not meet the needs of the application.
1332 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1334 * @see elm_object_style_set()
1336 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1338 * Deletes a theme extension from the list of extensions.
1340 * @param th The theme to delete from, or if NULL, the default theme
1341 * @param item The name of the theme extension
1343 * @see elm_theme_extension_add()
1345 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1347 * Set the theme search order for the given theme
1349 * @param th The theme to set the search order, or if NULL, the default theme
1350 * @param theme Theme search string
1352 * This sets the search string for the theme in path-notation from first
1353 * theme to search, to last, delimited by the : character. Example:
1355 * "shiny:/path/to/file.edj:default"
1357 * See the ELM_THEME environment variable for more information.
1359 * @see elm_theme_get()
1360 * @see elm_theme_list_get()
1362 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1364 * Return the theme search order
1366 * @param th The theme to get the search order, or if NULL, the default theme
1367 * @return The internal search order path
1369 * This function returns a colon separated string of theme elements as
1370 * returned by elm_theme_list_get().
1372 * @see elm_theme_set()
1373 * @see elm_theme_list_get()
1375 EAPI const char *elm_theme_get(Elm_Theme *th);
1377 * Return a list of theme elements to be used in a theme.
1379 * @param th Theme to get the list of theme elements from.
1380 * @return The internal list of theme elements
1382 * This returns the internal list of theme elements (will only be valid as
1383 * long as the theme is not modified by elm_theme_set() or theme is not
1384 * freed by elm_theme_free(). This is a list of strings which must not be
1385 * altered as they are also internal. If @p th is NULL, then the default
1386 * theme element list is returned.
1388 * A theme element can consist of a full or relative path to a .edj file,
1389 * or a name, without extension, for a theme to be searched in the known
1390 * theme paths for Elemementary.
1392 * @see elm_theme_set()
1393 * @see elm_theme_get()
1395 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1397 * Return the full patrh for a theme element
1399 * @param f The theme element name
1400 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1401 * @return The full path to the file found.
1403 * This returns a string you should free with free() on success, NULL on
1404 * failure. This will search for the given theme element, and if it is a
1405 * full or relative path element or a simple searchable name. The returned
1406 * path is the full path to the file, if searched, and the file exists, or it
1407 * is simply the full path given in the element or a resolved path if
1408 * relative to home. The @p in_search_path boolean pointed to is set to
1409 * EINA_TRUE if the file was a searchable file andis in the search path,
1410 * and EINA_FALSE otherwise.
1412 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1414 * Flush the current theme.
1416 * @param th Theme to flush
1418 * This flushes caches that let elementary know where to find theme elements
1419 * in the given theme. If @p th is NULL, then the default theme is flushed.
1420 * Call this function if source theme data has changed in such a way as to
1421 * make any caches Elementary kept invalid.
1423 EAPI void elm_theme_flush(Elm_Theme *th);
1425 * This flushes all themes (default and specific ones).
1427 * This will flush all themes in the current application context, by calling
1428 * elm_theme_flush() on each of them.
1430 EAPI void elm_theme_full_flush(void);
1432 * Set the theme for all elementary using applications on the current display
1434 * @param theme The name of the theme to use. Format same as the ELM_THEME
1435 * environment variable.
1437 EAPI void elm_theme_all_set(const char *theme);
1439 * Return a list of theme elements in the theme search path
1441 * @return A list of strings that are the theme element names.
1443 * This lists all available theme files in the standard Elementary search path
1444 * for theme elements, and returns them in alphabetical order as theme
1445 * element names in a list of strings. Free this with
1446 * elm_theme_name_available_list_free() when you are done with the list.
1448 EAPI Eina_List *elm_theme_name_available_list_new(void);
1450 * Free the list returned by elm_theme_name_available_list_new()
1452 * This frees the list of themes returned by
1453 * elm_theme_name_available_list_new(). Once freed the list should no longer
1454 * be used. a new list mys be created.
1456 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1458 * Set a specific theme to be used for this object and its children
1460 * @param obj The object to set the theme on
1461 * @param th The theme to set
1463 * This sets a specific theme that will be used for the given object and any
1464 * child objects it has. If @p th is NULL then the theme to be used is
1465 * cleared and the object will inherit its theme from its parent (which
1466 * ultimately will use the default theme if no specific themes are set).
1468 * Use special themes with great care as this will annoy users and make
1469 * configuration difficult. Avoid any custom themes at all if it can be
1472 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1474 * Get the specific theme to be used
1476 * @param obj The object to get the specific theme from
1477 * @return The specifc theme set.
1479 * This will return a specific theme set, or NULL if no specific theme is
1480 * set on that object. It will not return inherited themes from parents, only
1481 * the specific theme set for that specific object. See elm_object_theme_set()
1482 * for more information.
1484 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1490 typedef enum _Elm_Win_Type
1493 ELM_WIN_DIALOG_BASIC,
1500 ELM_WIN_DROPDOWN_MENU,
1503 ELM_WIN_NOTIFICATION,
1506 ELM_WIN_INLINED_IMAGE,
1509 typedef enum _Elm_Win_Keyboard_Mode
1511 ELM_WIN_KEYBOARD_UNKNOWN,
1512 ELM_WIN_KEYBOARD_OFF,
1513 ELM_WIN_KEYBOARD_ON,
1514 ELM_WIN_KEYBOARD_ALPHA,
1515 ELM_WIN_KEYBOARD_NUMERIC,
1516 ELM_WIN_KEYBOARD_PIN,
1517 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1518 ELM_WIN_KEYBOARD_HEX,
1519 ELM_WIN_KEYBOARD_TERMINAL,
1520 ELM_WIN_KEYBOARD_PASSWORD,
1521 ELM_WIN_KEYBOARD_IP,
1522 ELM_WIN_KEYBOARD_HOST,
1523 ELM_WIN_KEYBOARD_FILE,
1524 ELM_WIN_KEYBOARD_URL,
1525 ELM_WIN_KEYBOARD_KEYPAD,
1526 ELM_WIN_KEYBOARD_J2ME
1527 } Elm_Win_Keyboard_Mode;
1529 typedef enum _Elm_Illume_Command
1531 ELM_ILLUME_COMMAND_FOCUS_BACK,
1532 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1533 ELM_ILLUME_COMMAND_FOCUS_HOME,
1534 ELM_ILLUME_COMMAND_CLOSE
1535 } Elm_Illume_Command;
1537 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1538 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1539 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1540 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1541 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1542 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1543 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1544 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1545 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1546 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1547 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1548 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1549 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1550 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1551 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1552 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1554 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1555 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1556 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1557 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1558 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1559 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1560 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1561 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1562 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1564 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1565 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1566 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1567 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1568 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1569 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1570 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1571 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1572 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1573 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1574 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1575 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1576 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1577 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1578 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1579 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1580 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip); EINA_ARG_NONNULL(1);
1581 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params); EINA_ARG_NONNULL(1);
1582 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1583 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1584 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1585 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1586 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1588 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1589 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1590 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1591 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1592 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1593 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1594 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1596 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1597 * (blank mouse, private mouse obj, defaultmouse)
1600 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1601 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1602 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1603 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1605 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1607 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1608 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1609 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1610 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1611 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1612 /* available styles:
1617 /* X specific calls - won't work on non-x engines (return 0) */
1618 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1619 /* smart callbacks called:
1620 * "delete,request" - the user requested to delete the window
1621 * "focus,in" - window got focus
1622 * "focus,out" - window lost focus
1623 * "moved" - window that holds the canvas was moved
1629 * @brief Background object, used for setting a solid color, image or Edje
1630 * group as background to a window or any container object.
1632 * The bg object is used for setting a solid background to a window or
1633 * packing into any container object. It works just like an image, but has
1634 * some properties useful to a background, like setting it to tiled,
1635 * centered, scaled or stretched.
1637 * Here is some sample code using it:
1638 * @li @ref bg_01_example_page
1639 * @li @ref bg_02_example_page
1640 * @li @ref bg_03_example_page
1644 typedef enum _Elm_Bg_Option
1646 ELM_BG_OPTION_CENTER, /**< center the background */
1647 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1648 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1649 ELM_BG_OPTION_TILE /**< tile background at its original size */
1653 * Add a new background to the parent
1655 * @param parent The parent object
1656 * @return The new object or NULL if it cannot be created
1660 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1663 * Set the file (image or edje) used for the background
1665 * @param obj The bg object
1666 * @param file The file path
1667 * @param group Optional key (group in Edje) within the file
1669 * This sets the image file used in the background object. The image (or edje)
1670 * will be stretched (retaining aspect if its an image file) to completely fill
1671 * the bg object. This may mean some parts are not visible.
1673 * @note Once the image of @p obj is set, a previously set one will be deleted,
1674 * even if @p file is NULL.
1678 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1681 * Get the file (image or edje) used for the background
1683 * @param obj The bg object
1684 * @param file The file path
1685 * @param group Optional key (group in Edje) within the file
1689 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1692 * Set the option used for the background image
1694 * @param obj The bg object
1695 * @param option The desired background option (TILE, SCALE)
1697 * This sets the option used for manipulating the display of the background
1698 * image. The image can be tiled or scaled.
1702 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1705 * Get the option used for the background image
1707 * @param obj The bg object
1708 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1712 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1714 * Set the option used for the background color
1716 * @param obj The bg object
1721 * This sets the color used for the background rectangle. Its range goes
1726 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1728 * Get the option used for the background color
1730 * @param obj The bg object
1737 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1740 * Set the overlay object used for the background object.
1742 * @param obj The bg object
1743 * @param overlay The overlay object
1745 * This provides a way for elm_bg to have an 'overlay' that will be on top
1746 * of the bg. Once the over object is set, a previously set one will be
1747 * deleted, even if you set the new one to NULL. If you want to keep that
1748 * old content object, use the elm_bg_overlay_unset() function.
1753 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1756 * Get the overlay object used for the background object.
1758 * @param obj The bg object
1759 * @return The content that is being used
1761 * Return the content object which is set for this widget
1765 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1768 * Get the overlay object used for the background object.
1770 * @param obj The bg object
1771 * @return The content that was being used
1773 * Unparent and return the overlay object which was set for this widget
1777 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1780 * Set the size of the pixmap representation of the image.
1782 * This option just makes sense if an image is going to be set in the bg.
1784 * @param obj The bg object
1785 * @param w The new width of the image pixmap representation.
1786 * @param h The new height of the image pixmap representation.
1788 * This function sets a new size for pixmap representation of the given bg
1789 * image. It allows the image to be loaded already in the specified size,
1790 * reducing the memory usage and load time when loading a big image with load
1791 * size set to a smaller size.
1793 * NOTE: this is just a hint, the real size of the pixmap may differ
1794 * depending on the type of image being loaded, being bigger than requested.
1798 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1799 /* smart callbacks called:
1803 typedef enum _Elm_Icon_Lookup_Order
1805 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1806 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1807 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1808 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1809 } Elm_Icon_Lookup_Order;
1811 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1812 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1813 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1814 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1815 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1816 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1817 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1818 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1819 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1820 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1821 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1822 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1823 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1824 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1825 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1826 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1827 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
1828 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1829 /* smart callbacks called:
1830 * "clicked" - the user clicked the icon
1834 typedef enum _Elm_Image_Orient
1836 ELM_IMAGE_ORIENT_NONE,
1837 ELM_IMAGE_ROTATE_90_CW,
1838 ELM_IMAGE_ROTATE_180_CW,
1839 ELM_IMAGE_ROTATE_90_CCW,
1840 ELM_IMAGE_FLIP_HORIZONTAL,
1841 ELM_IMAGE_FLIP_VERTICAL,
1842 ELM_IMAGE_FLIP_TRANSPOSE,
1843 ELM_IMAGE_FLIP_TRANSVERSE
1845 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1846 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1847 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1848 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1849 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1850 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1851 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1852 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1853 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1854 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1855 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1856 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1857 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1858 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1859 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
1860 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1861 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
1862 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1863 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1864 /* smart callbacks called:
1865 * "clicked" - the user clicked the image
1869 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
1871 typedef enum _Elm_GLView_Mode
1873 ELM_GLVIEW_ALPHA = 1,
1874 ELM_GLVIEW_DEPTH = 2,
1875 ELM_GLVIEW_STENCIL = 4
1879 * Defines a policy for the glview resizing.
1881 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
1883 typedef enum _Elm_GLView_Resize_Policy
1885 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
1886 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
1887 } Elm_GLView_Resize_Policy;
1889 typedef enum _Elm_GLView_Render_Policy
1891 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
1892 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
1893 } Elm_GLView_Render_Policy;
1896 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1897 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1898 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1899 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1900 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
1901 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
1902 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
1903 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1904 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1905 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1906 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1907 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1910 typedef struct _Elm_Box_Transition Elm_Box_Transition;
1912 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1913 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
1914 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1915 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
1916 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1917 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
1918 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1919 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1920 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1921 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
1922 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
1923 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
1924 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1925 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
1926 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1927 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
1928 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
1929 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
1930 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
1932 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);
1933 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
1934 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);
1935 EAPI void elm_box_transition_free(void *data);
1936 /* smart callbacks called:
1941 * @defgroup Button Button
1943 * This is a push-button. Press it and run some function. It can contain
1944 * a simple label and icon object and it also has an autorepeat feature.
1946 * This widgets emits the following signals:
1947 * @li "clicked": the user clicked the button (press/release).
1948 * @li "repeated": the user pressed the button without releasing it.
1949 * @li "unpressed": button was released after being pressed.
1950 * In all three cases, the @c event parameter of the callback will be
1953 * Also, defined in the default theme, the button has the following styles
1955 * @li default: a normal button.
1956 * @li anchor: Like default, but the button fades away when the mouse is not
1957 * over it, leaving only the text or icon.
1958 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
1959 * continuous look across its options.
1960 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
1962 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1963 EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1964 EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1965 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
1966 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1967 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1968 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
1969 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1970 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
1971 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1972 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
1973 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1976 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1977 EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
1978 EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1979 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
1980 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1981 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1982 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1983 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1984 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1985 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1986 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
1987 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1988 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1989 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1990 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1991 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1992 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1993 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1994 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
1995 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1996 /* available styles:
2000 * hoversel_vertical_entry
2002 /* smart callbacks called:
2003 * "file,chosen" - the user has selected a path, whose string pointer comes
2007 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2008 EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2009 EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2010 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2011 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2012 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2013 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2014 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2015 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2016 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2017 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2018 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2019 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2020 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2021 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2022 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2023 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2024 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2025 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2026 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2027 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2028 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2030 /* scroller policy */
2031 typedef enum _Elm_Scroller_Policy
2033 ELM_SCROLLER_POLICY_AUTO = 0,
2034 ELM_SCROLLER_POLICY_ON,
2035 ELM_SCROLLER_POLICY_OFF,
2036 ELM_SCROLLER_POLICY_LAST
2037 } Elm_Scroller_Policy;
2039 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2040 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2041 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2042 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2043 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2044 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2045 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);
2046 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2047 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2048 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);
2049 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2050 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2051 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2052 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2053 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2054 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);
2055 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2056 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2057 /* smart callbacks called:
2058 * "edge,left" - the left edge of the content has been reached
2059 * "edge,right" - the right edge of the content has been reached
2060 * "edge,top" - the top edge of the content has been reached
2061 * "edge,bottom" - the bottom edge of the content has been reached
2062 * "scroll" - the content has been scrolled (moved)
2063 * "scroll,anim,start" - scrolling animation has started
2064 * "scroll,anim,stop" - scrolling animation has stopped
2065 * "scroll,drag,start" - dragging the contents around has started
2066 * "scroll,drag,stop" - dragging the contents around has stopped
2070 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2071 EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2072 EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2073 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2074 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2075 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2076 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2077 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2078 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2079 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2080 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);
2081 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2082 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);
2083 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2084 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2085 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2086 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2087 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2088 /* available styles:
2092 /* smart callbacks called:
2096 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2097 EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2098 EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2099 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2100 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2101 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2102 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2103 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2104 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2105 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2106 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2107 /* smart callbacks called:
2108 * "changed" - Whenever the toggle value has been changed. Is not called
2109 * until the toggle is released by the cursor (assuming it has been triggered
2110 * by the cursor in the first place).
2114 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2115 EAPI void elm_frame_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
2116 EAPI const char *elm_frame_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2117 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1)
2118 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2119 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
2120 /* available styles:
2129 /* smart callbacks called:
2133 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2134 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2135 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2136 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2137 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2138 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2139 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2140 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2141 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2142 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
2143 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2144 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
2147 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
2148 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
2149 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
2150 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2151 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
2152 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2153 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
2155 struct _Elm_Gengrid_Item_Class
2157 const char *item_style;
2158 struct _Elm_Gengrid_Item_Class_Func
2160 GridItemLabelGetFunc label_get;
2161 GridItemIconGetFunc icon_get;
2162 GridItemStateGetFunc state_get;
2163 GridItemDelFunc del;
2167 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2168 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2169 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2170 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
2171 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
2173 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2174 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2175 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2176 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2177 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2178 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2179 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2180 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2181 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2182 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2183 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2184 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
2185 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2186 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
2187 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2189 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2190 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2193 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2194 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2195 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2196 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2197 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2198 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
2199 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
2200 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2201 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2202 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2203 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2204 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2205 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2206 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2208 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
2209 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);
2210 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2211 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2212 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2213 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2214 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2215 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2216 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2217 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2218 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2219 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2221 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2222 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2223 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2225 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);
2226 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);
2227 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);
2228 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);
2229 /* smart callbacks called:
2231 * selected - User has selected an item.
2232 * unselected - User has unselected an item.
2233 * clicked,double - User has double-clicked or pressed enter on an item.
2234 * realized - An evas object for an item was built.
2235 * unrealized - An evas object for an item was deleted.
2236 * changed - An item has been added, removed, resized or moved,
2237 * or gengrid has been resized or horizontal property has been changed.
2238 * scroll - the content has been scrolled (moved).
2239 * "scroll,drag,start" - dragging the contents around has started.
2240 * "scroll,drat,stop" - dragging the contents around has stopped.
2241 * drag - Gengrid is being dragged.
2242 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
2243 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
2244 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
2245 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
2246 * "drag,stop" - Gengrid is not being dragged.
2250 typedef enum _Elm_Clock_Digedit
2253 ELM_CLOCK_HOUR_DECIMAL = 1 << 0,
2254 ELM_CLOCK_HOUR_UNIT = 1 << 1,
2255 ELM_CLOCK_MIN_DECIMAL = 1 << 2,
2256 ELM_CLOCK_MIN_UNIT = 1 << 3,
2257 ELM_CLOCK_SEC_DECIMAL = 1 << 4,
2258 ELM_CLOCK_SEC_UNIT = 1 << 5,
2259 ELM_CLOCK_ALL = (1 << 6) - 1
2260 } Elm_Clock_Digedit;
2262 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2263 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
2264 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
2265 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
2266 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2267 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
2268 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2269 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
2270 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2271 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
2272 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2273 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
2274 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2275 /* smart callbacks called:
2276 * "changed" - the user changed the time
2280 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2281 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2282 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
2283 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
2284 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2285 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2286 EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
2287 EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
2288 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
2289 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
2290 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
2291 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
2292 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
2293 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
2294 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);
2295 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
2296 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
2297 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2298 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
2299 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
2300 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
2301 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2302 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2303 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
2304 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2305 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);
2306 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2308 * @def elm_layout_icon_set
2309 * Convienience macro to set the icon object in a layout that follows the
2310 * Elementary naming convention for its parts.
2314 #define elm_layout_icon_set(_ly, _obj) \
2317 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
2318 if ((_obj)) sig = "elm,state,icon,visible"; \
2319 else sig = "elm,state,icon,hidden"; \
2320 elm_object_signal_emit((_ly), sig, "elm"); \
2324 * @def elm_layout_icon_get
2325 * Convienience macro to get the icon object from a layout that follows the
2326 * Elementary naming convention for its parts.
2330 #define elm_layout_icon_get(_ly) \
2331 elm_layout_content_get((_ly), "elm.swallow.icon")
2334 * @def elm_layout_end_set
2335 * Convienience macro to set the end object in a layout that follows the
2336 * Elementary naming convention for its parts.
2340 #define elm_layout_end_set(_ly, _obj) \
2343 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
2344 if ((_obj)) sig = "elm,state,end,visible"; \
2345 else sig = "elm,state,end,hidden"; \
2346 elm_object_signal_emit((_ly), sig, "elm"); \
2350 * @def elm_layout_end_get
2351 * Convienience macro to get the end object in a layout that follows the
2352 * Elementary naming convention for its parts.
2356 #define elm_layout_end_get(_ly) \
2357 elm_layout_content_get((_ly), "elm.swallow.end")
2360 * @def elm_layout_label_set
2361 * Convienience macro to set the label in a layout that follows the
2362 * Elementary naming convention for its parts.
2366 #define elm_layout_label_set(_ly, _txt) \
2367 elm_layout_text_set((_ly), "elm.text", (_txt))
2370 * @def elm_layout_label_get
2371 * Convienience macro to get the label in a layout that follows the
2372 * Elementary naming convention for its parts.
2376 #define elm_layout_label_get(_ly) \
2377 elm_layout_text_get((_ly), "elm.text")
2379 /* smart callbacks called:
2383 typedef enum _Elm_Notify_Orient
2385 ELM_NOTIFY_ORIENT_TOP,
2386 ELM_NOTIFY_ORIENT_CENTER,
2387 ELM_NOTIFY_ORIENT_BOTTOM,
2388 ELM_NOTIFY_ORIENT_LEFT,
2389 ELM_NOTIFY_ORIENT_RIGHT,
2390 ELM_NOTIFY_ORIENT_TOP_LEFT,
2391 ELM_NOTIFY_ORIENT_TOP_RIGHT,
2392 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
2393 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
2394 ELM_NOTIFY_ORIENT_LAST
2395 } Elm_Notify_Orient;
2396 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2397 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2398 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2399 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2400 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2401 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2402 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
2403 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2404 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
2405 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2406 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
2407 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2408 /* smart callbacks called:
2409 * "timeout" - when timeout happens on notify and it's hidden
2410 * "block,clicked" - when it's hidden by a click outside of the notify's view
2414 typedef enum _Elm_Hover_Axis
2416 ELM_HOVER_AXIS_NONE,
2417 ELM_HOVER_AXIS_HORIZONTAL,
2418 ELM_HOVER_AXIS_VERTICAL,
2421 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2422 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
2423 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2424 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2425 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2426 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
2427 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2428 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2429 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
2430 /* available styles:
2436 /* smart callbacks called:
2437 * "clicked" - the user clicked the empty space in the hover to dismiss
2438 * "smart,changed" - a content object placed under the "smart"
2439 * policy was replaced to a new slot direction.
2443 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
2444 struct _Elm_Entry_Anchor_Info
2448 Evas_Coord x, y, w, h;
2450 typedef enum _Elm_Icon_Type
2456 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
2458 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2459 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
2460 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2461 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
2462 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2463 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
2464 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2465 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
2466 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2467 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2468 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
2469 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2470 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
2471 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2472 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
2473 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2474 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
2475 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
2476 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
2477 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
2478 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2479 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2480 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2481 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2482 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
2483 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
2484 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2485 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2486 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2487 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);
2488 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
2489 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2490 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
2491 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
2492 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
2493 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2494 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);
2495 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2496 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2497 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);
2498 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);
2499 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);
2500 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);
2501 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);
2502 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);
2503 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
2504 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
2505 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
2506 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
2507 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
2508 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
2509 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2510 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
2511 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2512 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
2513 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
2514 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
2515 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
2516 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
2517 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
2518 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
2519 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
2520 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
2521 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
2522 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
2523 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
2524 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
2526 /* pre-made filters for entries */
2527 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
2528 struct _Elm_Entry_Filter_Limit_Size
2533 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
2534 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
2535 struct _Elm_Entry_Filter_Accept_Set
2537 const char *accepted;
2538 const char *rejected;
2540 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
2541 /* smart callbacks called:
2542 * "changed" - the text content changed
2543 * "selection,start" - the user started selecting text
2544 * "selection,changed" - the user modified the selection size/location
2545 * "selection,cleared" - the user cleared the selection
2546 * "selection,paste" - the user requested a paste of text
2547 * "selection,copy" - the user copied the text
2548 * "selection,cut" - the user cut the text
2549 * "cursor,changed" - the cursor changed position
2550 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
2551 * "activated" - when the enter key is pressed (useful for single line)
2552 * "press" - when finger/mouse is pressed down
2553 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
2554 * "clicked,double" - when finger/mouse is double-pressed
2555 * "longpressed" - the entry has been longpressed
2556 * "focused" - the entry has received keyboard focus
2557 * "unfocused" - keyboard focus is gone
2560 /* composite widgets - these basically put together basic widgets above
2561 * in convenient packages that do more than basic stuff */
2565 * @defgroup Anchorview Anchorview
2567 * Anchorview is for displaying text that contains markup with anchors
2568 * like <c>\<a href=1234\>something\</\></c> in it.
2570 * Besides being styled differently, the anchorview widget provides the
2571 * necessary functionality so that clicking on these anchors brings up a
2572 * popup with user defined content such as "call", "add to contacts" or
2573 * "open web page". This popup is provided using the @ref Hover widget.
2575 * This widget is very similar to @ref Anchorblock, so refer to that
2576 * widget for an example. The only difference Anchorview has is that the
2577 * widget is already provided with scrolling functionality, so if the
2578 * text set to it is too large to fit in the given space, it will scroll,
2579 * whereas the @ref Anchorblock widget will keep growing to ensure all the
2580 * text can be displayed.
2582 * This widget emits the following signals:
2583 * @li "anchor,clicked": will be called when an anchor is clicked. The
2584 * @p event_info parameter on the callback will be a pointer of type
2585 * ::Elm_Entry_Anchorview_Info.
2587 * See @ref Anchorblock for an example on how to use both of them.
2596 * @typedef Elm_Entry_Anchorview_Info
2598 * The info sent in the callback for "anchor,clicked" signals emitted by
2599 * the Anchorview widget.
2601 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
2603 * @struct _Elm_Entry_Anchorview_Info
2605 * The info sent in the callback for "anchor,clicked" signals emitted by
2606 * the Anchorview widget.
2608 struct _Elm_Entry_Anchorview_Info
2610 const char *name; /**< Name of the anchor, as indicated in its href
2612 int button; /**< The mouse button used to click on it */
2613 Evas_Object *hover; /**< The hover object to use for the popup */
2615 Evas_Coord x, y, w, h;
2616 } anchor, /**< Geometry selection of text used as anchor */
2617 hover_parent; /**< Geometry of the object used as parent by the
2619 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
2620 for content on the left side of
2621 the hover. Before calling the
2622 callback, the widget will make the
2623 necessary calculations to check
2624 which sides are fit to be set with
2625 content, based on the position the
2626 hover is activated and its distance
2627 to the edges of its parent object
2629 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
2630 the right side of the hover.
2631 See @ref hover_left */
2632 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
2633 of the hover. See @ref hover_left */
2634 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
2635 below the hover. See @ref
2639 * Add a new Anchorview object
2641 * @param parent The parent object
2642 * @return The new object or NULL if it cannot be created
2644 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2646 * Set the text to show in the anchorview
2648 * Sets the text of the anchorview to @p text. This text can include markup
2649 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
2650 * text that will be specially styled and react to click events, ended with
2651 * either of \</a\> or \</\>. When clicked, the anchor will emit an
2652 * "anchor,clicked" signal that you can attach a callback to with
2653 * evas_object_smart_callback_add(). The name of the anchor given in the
2654 * event info struct will be the one set in the href attribute, in this
2657 * Other markup can be used to style the text in different ways, but it's
2658 * up to the style defined in the theme which tags do what.
2660 EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
2662 * Get the markup text set for the anchorview
2664 * Retrieves the text set on the anchorview, with markup tags included.
2666 * @param obj The anchorview object
2667 * @return The markup text set or @c NULL if nothing was set or an error
2670 EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2672 * Set the parent of the hover popup
2674 * Sets the parent object to use by the hover created by the anchorview
2675 * when an anchor is clicked. See @ref Hover for more details on this.
2676 * If no parent is set, the same anchorview object will be used.
2678 * @param obj The anchorview object
2679 * @param parent The object to use as parent for the hover
2681 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2683 * Get the parent of the hover popup
2685 * Get the object used as parent for the hover created by the anchorview
2686 * widget. See @ref Hover for more details on this.
2688 * @param obj The anchorview object
2689 * @return The object used as parent for the hover, NULL if none is set.
2691 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2693 * Set the style that the hover should use
2695 * When creating the popup hover, anchorview will request that it's
2696 * themed according to @p style.
2698 * @param obj The anchorview object
2699 * @param style The style to use for the underlying hover
2701 * @see elm_object_style_set()
2703 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2705 * Get the style that the hover should use
2707 * Get the style the hover created by anchorview will use.
2709 * @param obj The anchorview object
2710 * @return The style to use by the hover. NULL means the default is used.
2712 * @see elm_object_style_set()
2714 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2716 * Ends the hover popup in the anchorview
2718 * When an anchor is clicked, the anchorview widget will create a hover
2719 * object to use as a popup with user provided content. This function
2720 * terminates this popup, returning the anchorview to its normal state.
2722 * @param obj The anchorview object
2724 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
2726 * Set bouncing behaviour when the scrolled content reaches an edge
2728 * Tell the internal scroller object whether it should bounce or not
2729 * when it reaches the respective edges for each axis.
2731 * @param obj The anchorview object
2732 * @param h_bounce Whether to bounce or not in the horizontal axis
2733 * @param v_bounce Whether to bounce or not in the vertical axis
2735 * @see elm_scroller_bounce_set()
2737 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2739 * Get the set bouncing behaviour of the internal scroller
2741 * Get whether the internal scroller should bounce when the edge of each
2742 * axis is reached scrolling.
2744 * @param obj The anchorview object
2745 * @param h_bounce Pointer where to store the bounce state of the horizontal
2747 * @param v_bounce Pointer where to store the bounce state of the vertical
2750 * @see elm_scroller_bounce_get()
2752 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2754 * Appends a custom item provider to the given anchorview
2756 * Appends the given function to the list of items providers. This list is
2757 * called, one function at a time, with the given @p data pointer, the
2758 * anchorview object and, in the @p item parameter, the item name as
2759 * referenced in its href string. Following functions in the list will be
2760 * called in order until one of them returns something different to NULL,
2761 * which should be an Evas_Object which will be used in place of the item
2764 * Items in the markup text take the form \<item relsize=16x16 vsize=full
2765 * href=item/name\>\</item\>
2767 * @param obj The anchorview object
2768 * @param func The function to add to the list of providers
2769 * @param data User data that will be passed to the callback function
2771 * @see elm_entry_item_provider_append()
2773 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);
2775 * Prepend a custom item provider to the given anchorview
2777 * Like elm_anchorview_item_provider_append(), but it adds the function
2778 * @p func to the beginning of the list, instead of the end.
2780 * @param obj The anchorview object
2781 * @param func The function to add to the list of providers
2782 * @param data User data that will be passed to the callback function
2784 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);
2786 * Remove a custom item provider from the list of the given anchorview
2788 * Removes the function and data pairing that matches @p func and @p data.
2789 * That is, unless the same function and same user data are given, the
2790 * function will not be removed from the list. This allows us to add the
2791 * same callback several times, with different @p data pointers and be
2792 * able to remove them later without conflicts.
2794 * @param obj The anchorview object
2795 * @param func The function to remove from the list
2796 * @param data The data matching the function to remove from the list
2798 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);
2805 * @defgroup Anchorblock Anchorblock
2807 * Anchorblock is for displaying text that contains markup with anchors
2808 * like <c>\<a href=1234\>something\</\></c> in it.
2810 * Besides being styled differently, the anchorblock widget provides the
2811 * necessary functionality so that clicking on these anchors brings up a
2812 * popup with user defined content such as "call", "add to contacts" or
2813 * "open web page". This popup is provided using the @ref Hover widget.
2815 * This widget emits the following signals:
2816 * @li "anchor,clicked": will be called when an anchor is clicked. The
2817 * @p event_info parameter on the callback will be a pointer of type
2818 * ::Elm_Entry_Anchorblock_Info.
2824 * Since examples are usually better than plain words, we might as well
2825 * try one. This exampel will show both Anchorblock and @ref Anchorview,
2826 * since both are very similar and it's easier to show them once and side
2827 * by side, so the difference is more clear.
2829 * We'll show the relevant snippets of the code here, but the full example
2830 * can be found here... sorry, @ref anchorblock_example_01.c "here".
2832 * As for the actual example, it's just a simple window with an anchorblock
2833 * and an anchorview, both containing the same text. After including
2834 * Elementary.h and declaring some functions we'll need, we jump to our
2835 * elm_main (see ELM_MAIN) and create our window.
2836 * @dontinclude anchorblock_example_01.c
2841 * With the needed variables declared, we'll create the window and a box to
2842 * hold our widgets, but we don't need to go through that here.
2844 * In order to make clear where the anchorblock ends and the anchorview
2845 * begins, they'll be each inside a @ref Frame. After creating the frame,
2846 * the anchorblock follows.
2847 * @skip elm_frame_add
2848 * @until elm_frame_content_set
2850 * Nothing out of the ordinary there. What's worth mentioning is the call
2851 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
2852 * when an anchor is clicked, the hover for the popup will cover the entire
2853 * window. This affects the area that will be obscured by the hover and
2854 * where clicking will dismiss it, as well as the calculations it does to
2855 * inform the best locations where to insert the popups content.
2856 * Other than that, the code is pretty standard. We also need to set our
2857 * callback for when an anchor is clicked, since it's our task to populate
2858 * the popup. There's no default for it.
2860 * The anchorview is no different, we only change a few things so it looks
2862 * @until elm_frame_content_set
2864 * Then we run, so stuff works and close our main function in the usual way.
2867 * Now, a little note. Normally you would use either one of anchorblock or
2868 * anchorview, set your one callback to clicks and do your stuff in there.
2869 * In this example, however, there are a few tricks to make it easier to
2870 * show both widgets in one go (and to save me some typing). So we have
2871 * two callbacks, one per widget, that will call a common function to do
2872 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
2873 * anchorview too, since both are equal, and passing a callback to use
2874 * for our buttons to end the hover, because each widget has a different
2876 * @until _anchorview_clicked_cb
2879 * The meat of our popup is in the following function. We check what kind
2880 * of menu we need to show, based on the name set to the anchor in the
2881 * markup text. If there's no type (something went wrong, no valid contact
2882 * in the address list) we are just putting a button that does nothing, but
2883 * it's perfectly reasonable to just end the hover and call it quits.
2885 * Our popup will consist of one main button in the middle of our hover,
2886 * and possibly a secondary button and a list of other options. We'll create
2887 * first our main button and check what kind of popup we need afterwards.
2890 * @until eina_stringshare_add
2893 * Each button has two callbacks, one is our hack to close the hover
2894 * properly based on which widget it belongs to, the other a simple
2895 * printf that will show the action with the anchors own data. This is
2896 * not how you would usually do it. Instead, the common case is to have
2897 * one callback for the button that will know which function to call to end
2898 * things, but since we are doing it this way it's worth noting that
2899 * smart callbacks will be called in reverse in respect to the order they
2900 * were added, and since our @c btn_end_cb will close the hover, and thus
2901 * delete our buttons, the other callback wouldn't be called if we had
2904 * After our telephone popup, there are a few others that are practically
2905 * the same, so they won't be shown here.
2907 * Once we are done with that, it's time to place our actions into our
2908 * hover. Main button goes in the middle without much questioning, and then
2909 * we see if we have a secondary button and a box of extra options.
2910 * Because I said so, secondary button goes on either side and box of
2911 * options either on top or below the main one, but to choose which
2912 * exactly, we use the hints our callback info has, which saves us from
2913 * having to do the math and see which side has more space available, with
2914 * a little special case where we delete our extra stuff if there's nowhere
2918 * @skip evas_object_smart
2919 * @until evas_object_del(box)
2924 * @example anchorblock_example_01.c
2927 * @addtogroup Anchorblock
2931 * @typedef Elm_Entry_Anchorblock_Info
2933 * The info sent in the callback for "anchor,clicked" signals emitted by
2934 * the Anchorblock widget.
2936 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
2938 * @struct _Elm_Entry_Anchorblock_Info
2940 * The info sent in the callback for "anchor,clicked" signals emitted by
2941 * the Anchorblock widget.
2943 struct _Elm_Entry_Anchorblock_Info
2945 const char *name; /**< Name of the anchor, as indicated in its href
2947 int button; /**< The mouse button used to click on it */
2948 Evas_Object *hover; /**< The hover object to use for the popup */
2950 Evas_Coord x, y, w, h;
2951 } anchor, /**< Geometry selection of text used as anchor */
2952 hover_parent; /**< Geometry of the object used as parent by the
2954 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
2955 for content on the left side of
2956 the hover. Before calling the
2957 callback, the widget will make the
2958 necessary calculations to check
2959 which sides are fit to be set with
2960 content, based on the position the
2961 hover is activated and its distance
2962 to the edges of its parent object
2964 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
2965 the right side of the hover.
2966 See @ref hover_left */
2967 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
2968 of the hover. See @ref hover_left */
2969 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
2970 below the hover. See @ref
2974 * Add a new Anchorblock object
2976 * @param parent The parent object
2977 * @return The new object or NULL if it cannot be created
2979 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2981 * Set the text to show in the anchorblock
2983 * Sets the text of the anchorblock to @p text. This text can include markup
2984 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
2985 * of text that will be specially styled and react to click events, ended
2986 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
2987 * "anchor,clicked" signal that you can attach a callback to with
2988 * evas_object_smart_callback_add(). The name of the anchor given in the
2989 * event info struct will be the one set in the href attribute, in this
2992 * Other markup can be used to style the text in different ways, but it's
2993 * up to the style defined in the theme which tags do what.
2995 EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
2997 * Get the markup text set for the anchorblock
2999 * Retrieves the text set on the anchorblock, with markup tags included.
3001 * @param obj The anchorblock object
3002 * @return The markup text set or @c NULL if nothing was set or an error
3005 EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3007 * Set the parent of the hover popup
3009 * Sets the parent object to use by the hover created by the anchorblock
3010 * when an anchor is clicked. See @ref Hover for more details on this.
3012 * @param obj The anchorblock object
3013 * @param parent The object to use as parent for the hover
3015 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3017 * Get the parent of the hover popup
3019 * Get the object used as parent for the hover created by the anchorblock
3020 * widget. See @ref Hover for more details on this.
3021 * If no parent is set, the same anchorblock object will be used.
3023 * @param obj The anchorblock object
3024 * @return The object used as parent for the hover, NULL if none is set.
3026 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3028 * Set the style that the hover should use
3030 * When creating the popup hover, anchorblock will request that it's
3031 * themed according to @p style.
3033 * @param obj The anchorblock object
3034 * @param style The style to use for the underlying hover
3036 * @see elm_object_style_set()
3038 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3040 * Get the style that the hover should use
3042 * Get the style the hover created by anchorblock will use.
3044 * @param obj The anchorblock object
3045 * @return The style to use by the hover. NULL means the default is used.
3047 * @see elm_object_style_set()
3049 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3051 * Ends the hover popup in the anchorblock
3053 * When an anchor is clicked, the anchorblock widget will create a hover
3054 * object to use as a popup with user provided content. This function
3055 * terminates this popup, returning the anchorblock to its normal state.
3057 * @param obj The anchorblock object
3059 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3061 * Appends a custom item provider to the given anchorblock
3063 * Appends the given function to the list of items providers. This list is
3064 * called, one function at a time, with the given @p data pointer, the
3065 * anchorblock object and, in the @p item parameter, the item name as
3066 * referenced in its href string. Following functions in the list will be
3067 * called in order until one of them returns something different to NULL,
3068 * which should be an Evas_Object which will be used in place of the item
3071 * Items in the markup text take the form \<item relsize=16x16 vsize=full
3072 * href=item/name\>\</item\>
3074 * @param obj The anchorblock object
3075 * @param func The function to add to the list of providers
3076 * @param data User data that will be passed to the callback function
3078 * @see elm_entry_item_provider_append()
3080 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);
3082 * Prepend a custom item provider to the given anchorblock
3084 * Like elm_anchorblock_item_provider_append(), but it adds the function
3085 * @p func to the beginning of the list, instead of the end.
3087 * @param obj The anchorblock object
3088 * @param func The function to add to the list of providers
3089 * @param data User data that will be passed to the callback function
3091 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);
3093 * Remove a custom item provider from the list of the given anchorblock
3095 * Removes the function and data pairing that matches @p func and @p data.
3096 * That is, unless the same function and same user data are given, the
3097 * function will not be removed from the list. This allows us to add the
3098 * same callback several times, with different @p data pointers and be
3099 * able to remove them later without conflicts.
3101 * @param obj The anchorblock object
3102 * @param func The function to remove from the list
3103 * @param data The data matching the function to remove from the list
3105 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);
3111 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3112 EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3113 EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3114 EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
3115 EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3117 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3118 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3119 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3120 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3121 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3122 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3123 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
3124 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3125 /* smart callbacks called:
3126 * "clicked" - the user clicked the bubble
3130 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3131 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
3132 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3133 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
3134 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3135 /* smart callbacks called:
3136 * "clicked" - the user clicked the icon
3137 * "drag,start" - Someone started dragging the image out of the object
3138 * "drag,end" - Dragged item was dropped (somewhere)
3142 typedef enum _Elm_Thumb_Animation_Setting
3144 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
3145 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
3146 ELM_THUMB_ANIMATION_STOP,
3147 ELM_THUMB_ANIMATION_LAST
3148 } Elm_Thumb_Animation_Setting;
3150 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3151 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
3152 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
3153 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
3154 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
3155 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
3156 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3157 EAPI void *elm_thumb_ethumb_client_get(void);
3158 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
3159 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3160 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3161 /* available styles:
3165 /* smart callbacks called:
3166 * "clicked" - This is called when a user has clicked the thumb without dragging around.
3167 * "clicked,double" - This is called when a user has double-clicked the thumb.
3168 * "press" - This is called when a user has pressed down the thumb.
3169 * "generate,start" - The thumbnail generation started.
3170 * "generate,stop" - The generation process stopped.
3171 * "generate,error" - The generation failed.
3172 * "load,error" - The thumbnail image loading failed.
3176 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3177 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3178 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3179 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3180 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3181 EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3182 EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3183 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3184 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3185 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3186 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3187 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3188 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3189 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3190 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3191 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);
3192 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
3193 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3194 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
3195 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
3196 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);
3197 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);
3198 /* smart callbacks called:
3199 * "clicked" - the user clicked the hoversel button and popped up the sel
3200 * "selected" - an item in the hoversel list is selected
3201 * "dismissed" - the hover is dismissed
3205 typedef enum _Elm_Toolbar_Shrink_Mode
3207 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
3208 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
3209 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
3210 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
3211 } Elm_Toolbar_Shrink_Mode;
3213 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
3214 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
3216 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3217 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
3218 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3219 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3220 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3221 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3222 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3223 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);
3224 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);
3225 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);
3226 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);
3227 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3228 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3229 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3230 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3231 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3232 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
3233 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3234 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3235 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3236 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
3237 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3238 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
3239 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3240 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3241 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3242 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3243 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
3244 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3245 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3246 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3247 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3248 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
3249 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3250 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
3251 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3252 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3253 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3254 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3255 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3256 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3257 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3258 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
3259 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3260 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
3261 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3262 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);
3263 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
3264 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
3265 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3266 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3267 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3268 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3269 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
3270 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);
3271 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3272 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
3273 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3274 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3275 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3276 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3277 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
3278 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3279 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3280 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3281 /* smart callbacks called:
3282 * "clicked" - when the user clicks on a toolbar item and becomes selected
3284 /* available styles:
3286 * transparent (no background or shadow, just show the provided content)
3290 EAPI double elm_tooltip_delay_get(void);
3291 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
3292 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
3293 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
3294 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
3295 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);
3296 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3297 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3298 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3299 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
3300 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3301 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3302 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3303 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3304 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3305 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3308 EAPI int elm_cursor_engine_only_get(void);
3309 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
3312 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
3313 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3314 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3315 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3316 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
3317 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
3318 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3319 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3320 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);
3321 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
3322 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3323 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
3324 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3325 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3326 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3327 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3328 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3329 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3330 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
3331 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3332 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3333 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3334 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3335 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
3336 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3337 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
3338 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
3339 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
3340 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3341 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3343 /* smart callbacks called:
3344 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
3348 typedef enum _Elm_List_Mode
3350 ELM_LIST_COMPRESS = 0,
3356 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
3357 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3358 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);
3359 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);
3360 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);
3361 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);
3362 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);
3363 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3364 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
3365 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3366 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3367 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
3368 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3369 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3370 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3371 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3372 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3373 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3374 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3375 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3376 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
3377 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3378 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3379 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3380 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3381 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3382 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3383 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3384 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3385 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3386 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
3387 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3388 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
3389 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3390 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3391 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
3392 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3393 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3394 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
3395 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);
3396 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3397 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
3398 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3399 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3400 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3401 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3402 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
3403 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3404 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3405 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3406 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3407 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3408 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3409 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3410 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3411 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);
3412 /* smart callbacks called:
3413 * "clicked,double" - when the user double-clicked an item
3414 * "selected" - when the user selected an item
3415 * "unselected" - when the user selected an item
3416 * "longpressed" - an item in the hoversel list is long-pressed
3417 * "scroll,edge,top" - the list is scrolled until the top edge
3418 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
3419 * "scroll,edge,left" - the list is scrolled until the left edge
3420 * "scroll,edge,right" - the list is scrolled until the right edge
3424 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3425 EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3426 EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3427 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3428 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3429 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3430 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
3431 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3432 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3433 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
3434 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3435 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
3436 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3437 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
3438 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3439 EAPI void elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val)) EINA_ARG_NONNULL(1);
3440 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3441 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3442 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
3443 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
3444 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
3445 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3446 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
3447 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3448 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
3449 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3450 /* smart callbacks called:
3451 * "changed" - Whenever the slider value is changed by the user.
3452 * "slider,drag,start" - dragging the slider indicator around has started
3453 * "slider,drag,stop" - dragging the slider indicator around has stopped
3454 * "delay,changed" - A short time after the value is changed by the user.
3455 * This will be called only when the user stops dragging for a very short
3456 * period or when they release their finger/mouse, so it avoids possibly
3457 * expensive reactions to the value change.
3461 * @addtogroup Actionslider Actionslider
3463 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
3464 * properties. The indicator is the element the user drags to choose a label.
3465 * When the position is set with magnet, when released the indicator will be
3466 * moved to it if it's nearest the magnetized position.
3468 * @note By default all positions are set as enabled.
3470 * Signals that you can add callbacks for are:
3472 * "selected" - when user selects an enabled position (the label is passed
3475 * "pos_changed" - when the indicator reaches any of the positions("left",
3476 * "right" or "center").
3478 * See an example of actionslider usage @ref actionslider_example_page "here"
3481 typedef enum _Elm_Actionslider_Pos
3483 ELM_ACTIONSLIDER_NONE = 0,
3484 ELM_ACTIONSLIDER_LEFT = 1 << 0,
3485 ELM_ACTIONSLIDER_CENTER = 1 << 1,
3486 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
3487 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
3488 } Elm_Actionslider_Pos;
3491 * Add a new actionslider to the parent.
3493 * @param parent The parent object
3494 * @return The new actionslider object or NULL if it cannot be created
3496 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3498 * Set actionslider labels.
3500 * @param obj The actionslider object
3501 * @param left_label The label to be set on the left.
3502 * @param center_label The label to be set on the center.
3503 * @param right_label The label to be set on the right.
3505 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);
3507 * Get actionslider labels.
3509 * @param obj The actionslider object
3510 * @param left_label A char** to place the left_label of @p obj into.
3511 * @param center_label A char** to place the center_label of @p obj into.
3512 * @param right_label A char** to place the right_label of @p obj into.
3514 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);
3516 * Get actionslider selected label.
3518 * @param obj The actionslider object
3519 * @return The selected label
3521 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3523 * Set actionslider indicator position.
3525 * @param obj The actionslider object.
3526 * @param pos The position of the indicator.
3528 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
3530 * Get actionslider indicator position.
3532 * @param obj The actionslider object.
3533 * @return The position of the indicator.
3535 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3537 * Set actionslider magnet position. To make multiple positions magnets @c or
3538 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
3540 * @param obj The actionslider object.
3541 * @param pos Bit mask indicating the magnet positions.
3543 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
3545 * Get actionslider magnet position.
3547 * @param obj The actionslider object.
3548 * @return The positions with magnet property.
3550 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3552 * Set actionslider enabled position. To set multiple positions as enabled @c or
3553 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
3555 * @note All the positions are enabled by default.
3557 * @param obj The actionslider object.
3558 * @param pos Bit mask indicating the enabled positions.
3560 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
3562 * Get actionslider enabled position.
3564 * @param obj The actionslider object.
3565 * @return The enabled positions.
3567 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3569 * Set the label used on the indicator.
3571 * @param obj The actionslider object
3572 * @param label The label to be set on the indicator.
3574 EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3576 * Get the label used on the indicator object.
3578 * @param obj The actionslider object
3579 * @return The indicator label
3581 EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3587 typedef enum _Elm_Genlist_Item_Flags
3589 ELM_GENLIST_ITEM_NONE = 0,
3590 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
3591 ELM_GENLIST_ITEM_GROUP = (1 << 1)
3592 } Elm_Genlist_Item_Flags;
3593 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
3594 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
3595 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
3596 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3597 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3598 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3599 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
3600 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
3602 struct _Elm_Genlist_Item_Class
3604 const char *item_style;
3607 GenlistItemLabelGetFunc label_get;
3608 GenlistItemIconGetFunc icon_get;
3609 GenlistItemStateGetFunc state_get;
3610 GenlistItemDelFunc del;
3611 GenlistItemMovedFunc moved;
3613 const char *mode_item_style;
3616 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3617 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3618 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3619 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3620 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
3621 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3622 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3623 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3624 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3625 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3626 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
3627 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3628 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
3629 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3630 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3631 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3632 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3633 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3634 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
3635 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3636 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3637 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3638 /* operations to add items */
3639 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);
3640 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);
3641 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);
3642 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);
3643 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);
3644 /* operations to retrieve existing items */
3645 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3646 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3647 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3648 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);
3649 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3650 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3651 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3652 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);
3653 /* available item styles:
3655 * default_style - The text part is a textblock
3657 * icon_top_text_bottom
3659 /* Genlist Item operation */
3660 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3661 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3662 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3663 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3664 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3665 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3666 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3667 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
3668 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3669 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3670 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3671 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3672 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
3673 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3674 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3675 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3676 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3677 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3678 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3679 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3680 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3681 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3682 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
3683 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3684 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
3685 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3686 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
3687 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
3688 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);
3689 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3690 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
3691 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3692 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3693 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3694 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3695 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
3696 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3697 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3698 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
3699 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
3700 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
3701 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3702 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3703 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3704 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3705 /** Signals that you can add callbacks for are:
3706 * "clicked,double" - This is called when a user has double-clicked an item.
3707 * The event_info parameter is the genlist item that was
3709 * "selected" - This is called when a user has made an item selected. The
3710 * event_info parameter is the genlist item that was selected.
3711 * "unselected" - This is called when a user has made an item unselected. The
3712 * event_info parameter is the genlist item that was
3714 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
3715 * and the item is now meant to be expanded. The event_info
3716 * parameter is the genlist item that was indicated to expand.
3717 * It is the job of this callback to then fill in the child
3719 * "contracted" - This is called when elm_genlist_item_expanded_set() is
3720 * called and the item is now meant to be contracted. The
3721 * event_info parameter is the genlist item that was indicated
3722 * to contract. It is the job of this callback to then delete
3724 * "expand,request" - This is called when a user has indicated they want to
3725 * expand a tree branch item. The callback should decide
3726 * if the item can expand (has any children) and then call
3727 * elm_genlist_item_expanded_set() appropriately to set
3728 * the state. The event_info parameter is the genlist item
3729 * that was indicated to expand.
3730 * "contract,request" - This is called when a user has indicated they want to
3731 * contract a tree branch item. The callback should
3732 * decide if the item can contract (has any children)
3733 * and then call elm_genlist_item_expanded_set()
3734 * appropriately to set the state. The event_info
3735 * parameter is the genlist item that was indicated to
3737 * "realized" - This is called when the item in the list is created as a real
3738 * evas object. event_info parameter is the genlist item that
3739 * was created. The object may be deleted at any time, so it is
3740 * up to the caller to not use the object pointer from
3741 * elm_genlist_item_object_get() in a way where it may point to
3743 * "unrealized" - This is called just before an item is unrealized. After
3744 * this call icon objects provided will be deleted and the
3745 * item object itself delete or be put into a floating cache.
3746 * "drag,start,up" - This is called when the item in the list has been
3747 * dragged (not scrolled) up.
3748 * "drag,start,down" - This is called when the item in the list has been
3749 * dragged (not scrolled) down.
3750 * "drag,start,left" - This is called when the item in the list has been
3751 * dragged (not scrolled) left.
3752 * "drag,start,right" - This is called when the item in the list has been
3753 * dragged (not scrolled) right.
3754 * "drag,stop" - This is called when the item in the list has stopped being
3756 * "drag" - This is called when the item in the list is being dragged.
3757 * "longpressed" - This is called when the item is pressed for a certain
3758 * amount of time. By default it's 1 second.
3759 * "scroll,edge,top" - This is called when the genlist is scrolled until the
3761 * "scroll,edge,bottom" - This is called when the genlist is scrolled until
3763 * "scroll,edge,left" - This is called when the genlist is scrolled until the
3765 * "scroll,edge,right" - This is called when the genlist is scrolled until
3767 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
3769 * "multi,swipe,right" - This is called when the genlist is multi-touch
3771 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
3773 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
3775 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
3777 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
3779 * "swipe" - This is called when the genlist is swiped.
3783 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3784 EAPI void elm_check_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
3785 EAPI const char *elm_check_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
3786 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon); EINA_ARG_NONNULL(1)
3787 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
3788 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
3789 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state); EINA_ARG_NONNULL(1)
3790 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
3791 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); EINA_ARG_NONNULL(1)
3792 /* smart callbacks called:
3793 * "changed" - This is called whenever the user changes the state of one of the check object.
3797 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3798 EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3799 EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3800 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3801 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3802 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3803 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
3804 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
3805 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3806 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
3807 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3808 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
3809 /* smart callbacks called:
3810 * "changed" - when the radio status is changed
3814 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3815 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3816 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3817 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3818 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3819 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3820 /* available item styles:
3826 /* smart callbacks called:
3827 * "hide,finished" - when the previous page is hided
3830 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
3831 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
3832 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
3833 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
3834 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
3836 struct _Elm_Slideshow_Item_Class
3838 struct _Elm_Slideshow_Item_Class_Func
3840 SlideshowItemGetFunc get;
3841 SlideshowItemDelFunc del;
3845 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3846 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
3847 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);
3848 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
3849 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3850 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
3851 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3852 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
3853 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3854 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3855 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3856 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
3857 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3858 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3859 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3860 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
3861 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
3862 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3863 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
3864 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
3865 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3866 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
3867 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3868 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
3869 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3870 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
3871 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3872 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3873 /* smart callbacks called:
3874 * "changed" - when the slideshow switch to another item
3878 typedef enum _Elm_Fileselector_Mode
3880 ELM_FILESELECTOR_LIST = 0,
3881 ELM_FILESELECTOR_GRID,
3882 ELM_FILESELECTOR_LAST
3883 } Elm_Fileselector_Mode;
3885 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3886 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
3887 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
3889 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
3891 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3893 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
3894 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3895 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3896 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3897 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3898 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
3899 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3900 /* smart callbacks called:
3901 * "selected" - the user click on a file
3902 * "directory,open" - the list is populate with a new content. event_info is a directory.
3903 * "done" - the user click on the ok or cancel buttons
3907 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3908 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
3909 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3910 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3911 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
3912 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3913 EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3914 EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3915 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3916 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3917 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3918 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
3919 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3920 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
3921 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3922 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3923 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3924 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
3925 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3926 /* smart callbacks called:
3928 /* available item styles:
3930 * wheel (simple style, no text, no progression, only pulse is available)
3934 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3935 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3936 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 /* smart callbacks called:
3941 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3942 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
3943 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3944 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
3945 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
3946 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
3947 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3948 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
3949 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3950 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3951 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3952 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3953 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3954 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
3955 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3956 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957 /* smart callbacks called:
3958 * "changed" - when the spinner value changes
3959 * "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).
3961 /* available item styles:
3963 * vertical (two up/down buttons at the right side and text left aligned)
3967 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
3969 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3970 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
3971 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3972 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
3973 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3974 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
3975 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
3976 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
3977 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
3978 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
3979 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);
3980 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
3981 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
3982 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3983 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
3984 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
3985 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
3986 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3987 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
3988 /* smart callbacks called:
3989 * "changed" - when the selected index item changes
3990 * "delay,changed" - when the selected index item changes, but after some small idle period
3991 * "selected" - when the user releases a finger and selects an item
3992 * "level,up" - when the user moves a finger from the first level to the second level
3993 * "level,down" - when the user moves a finger from the second level to the first level
3997 typedef enum _Elm_Photocam_Zoom_Mode
3999 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
4000 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
4001 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
4002 ELM_PHOTOCAM_ZOOM_MODE_LAST
4003 } Elm_Photocam_Zoom_Mode;
4005 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4006 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4007 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4008 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
4009 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4010 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
4011 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4012 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4013 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4014 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4015 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4016 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4017 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4020 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4021 /* smart callbacks called:
4022 * "clicked" - when image clicked
4023 * "press" - when mouse/finger held down initially on image
4024 * "longpressed" - when mouse/finger held for long time on image
4025 * "clicked,double" - when mouse/finger double-clicked
4026 * "load" - when photo load begins
4027 * "loaded" - when photo load done
4028 * "load,detail" - when detailed image load begins
4029 * "loaded,detail" - when detailed image load done
4030 * "zoom,start" - when zooming started
4031 * "zoom,stop" - when zooming stopped
4032 * "zoom,change" - when auto zoom mode changed zoom level
4033 * "scroll - the content has been scrolled (moved)
4034 * "scroll,anim,start" - scrolling animation has started
4035 * "scroll,anim,stop" - scrolling animation has stopped
4036 * "scroll,drag,start" - dragging the contents around has started
4037 * "scroll,drag,stop" - dragging the contents around has stopped
4041 typedef enum _Elm_Map_Zoom_Mode
4043 ELM_MAP_ZOOM_MODE_MANUAL,
4044 ELM_MAP_ZOOM_MODE_AUTO_FIT,
4045 ELM_MAP_ZOOM_MODE_AUTO_FILL,
4046 ELM_MAP_ZOOM_MODE_LAST
4047 } Elm_Map_Zoom_Mode;
4049 typedef enum _Elm_Map_Route_Sources
4051 ELM_MAP_ROUTE_SOURCE_YOURS,
4052 ELM_MAP_ROUTE_SOURCE_MONAV,
4053 ELM_MAP_ROUTE_SOURCE_ORS,
4054 ELM_MAP_ROUTE_SOURCE_LAST
4055 } Elm_Map_Route_Sources;
4057 typedef enum _Elm_Map_Name_Sources
4059 ELM_MAP_NAME_SOURCE_NOMINATIM,
4060 ELM_MAP_NAME_SOURCE_LAST
4061 } Elm_Map_Name_Sources;
4063 typedef enum _Elm_Map_Route_Type
4065 ELM_MAP_ROUTE_TYPE_MOTOCAR,
4066 ELM_MAP_ROUTE_TYPE_BICYCLE,
4067 ELM_MAP_ROUTE_TYPE_FOOT,
4068 ELM_MAP_ROUTE_TYPE_LAST
4069 } Elm_Map_Route_Type;
4071 typedef enum _Elm_Map_Route_Method
4073 ELM_MAP_ROUTE_METHOD_FASTEST,
4074 ELM_MAP_ROUTE_METHOD_SHORTEST,
4075 ELM_MAP_ROUTE_METHOD_LAST
4076 } Elm_Map_Route_Method;
4078 typedef enum _Elm_Map_Name_Method
4080 ELM_MAP_NAME_METHOD_SEARCH,
4081 ELM_MAP_NAME_METHOD_REVERSE,
4082 ELM_MAP_NAME_METHOD_LAST
4083 } Elm_Map_Name_Method;
4085 typedef struct _Elm_Map_Marker Elm_Map_Marker;
4086 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
4087 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
4088 typedef struct _Elm_Map_Route Elm_Map_Route;
4089 typedef struct _Elm_Map_Name Elm_Map_Name;
4090 typedef struct _Elm_Map_Track Elm_Map_Track;
4092 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
4093 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
4094 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
4095 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
4097 typedef char *(*ElmMapModuleSourceFunc) (void);
4098 typedef int (*ElmMapModuleZoomMinFunc) (void);
4099 typedef int (*ElmMapModuleZoomMaxFunc) (void);
4100 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
4101 typedef int (*ElmMapModuleRouteSourceFunc) (void);
4102 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
4103 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
4104 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
4105 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
4107 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4108 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4109 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
4111 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4112 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
4113 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4114 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4115 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4116 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4117 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4118 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4119 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
4120 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);
4121 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);
4122 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4123 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
4124 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);
4125 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);
4126 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
4127 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4128 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
4129 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4130 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4131 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
4132 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4133 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4134 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4135 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
4136 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
4137 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
4138 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
4139 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
4140 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
4141 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
4142 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
4144 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
4145 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
4146 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
4147 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
4149 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4150 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
4151 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4153 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4154 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4155 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4156 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
4157 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4158 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);
4159 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4160 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
4161 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
4162 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4163 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4164 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4165 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
4166 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
4167 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
4168 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
4169 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);
4170 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4171 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4172 #ifdef HAVE_ELEMENTARY_EMAP
4173 EAPI Elm_Map_Track *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
4175 EAPI void elm_map_track_remove(Elm_Map_Track *track) EINA_ARG_NONNULL(1);
4176 EAPI void elm_map_track_color_set(Elm_Map_Track *track, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
4177 EAPI void elm_map_track_color_get(const Elm_Map_Track *track, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
4179 /* smart callbacks called:
4180 * "clicked" - when image clicked
4181 * "press" - when mouse/finger held down initially on image
4182 * "longpressed" - when mouse/finger held for long time on image
4183 * "clicked,double" - when mouse/finger double-clicked
4184 * "load,details" - when detailed image load begins
4185 * "loaded,details" - when detailed image load done
4186 * "zoom,start" - when zooming started
4187 * "zoom,stop" - when zooming stopped
4188 * "zoom,change" - when auto zoom mode changed zoom level
4189 * "scroll - the content has been scrolled (moved)
4190 * "scroll,anim,start" - scrolling animation has started
4191 * "scroll,anim,stop" - scrolling animation has stopped
4192 * "scroll,drag,start" - dragging the contents around has started
4193 * "scroll,drag,stop" - dragging the contents around has stopped
4197 typedef enum _Elm_Panel_Orient
4199 ELM_PANEL_ORIENT_TOP,
4200 ELM_PANEL_ORIENT_BOTTOM,
4201 ELM_PANEL_ORIENT_LEFT,
4202 ELM_PANEL_ORIENT_RIGHT,
4205 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4206 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
4207 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4208 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4209 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4210 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4211 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
4212 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4213 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
4219 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
4220 * Add events (move, start ...)
4222 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4223 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4224 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4225 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4226 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4227 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4228 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4229 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4230 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
4231 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4232 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4235 typedef enum _Elm_Flip_Mode
4237 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
4238 ELM_FLIP_ROTATE_X_CENTER_AXIS,
4239 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
4240 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
4242 ELM_FLIP_CUBE_RIGHT,
4246 ELM_FLIP_PAGE_RIGHT,
4250 typedef enum _Elm_Flip_Interaction
4252 ELM_FLIP_INTERACTION_NONE,
4253 ELM_FLIP_INTERACTION_ROTATE,
4254 ELM_FLIP_INTERACTION_CUBE,
4255 ELM_FLIP_INTERACTION_PAGE
4256 } Elm_Flip_Interaction;
4257 typedef enum _Elm_Flip_Direction
4259 ELM_FLIP_DIRECTION_UP,
4260 ELM_FLIP_DIRECTION_DOWN,
4261 ELM_FLIP_DIRECTION_LEFT,
4262 ELM_FLIP_DIRECTION_RIGHT
4263 } Elm_Flip_Direction;
4265 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4266 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4267 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4268 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4269 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4270 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4271 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4272 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4273 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4274 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
4275 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
4276 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
4277 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
4278 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
4279 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
4280 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
4281 /* smart callbacks called:
4282 * "animate,begin" - when a flip animation was started
4283 * "animate,done" - when a flip animation is finished
4287 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4288 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
4289 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4290 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
4291 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4292 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4293 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4294 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4295 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4296 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4297 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4298 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4299 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4300 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4301 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
4302 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4303 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4304 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4305 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
4306 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
4307 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4308 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4309 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4310 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4311 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4312 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4313 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4314 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4316 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4317 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4318 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
4319 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
4320 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
4321 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4322 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);
4323 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4324 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4325 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);
4326 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4327 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);
4328 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
4329 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4331 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
4332 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
4333 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4334 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4335 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
4336 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);
4337 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);
4338 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);
4339 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);
4340 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);
4341 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);
4342 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
4343 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
4344 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
4345 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
4346 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4347 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
4348 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4351 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4352 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4353 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4355 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4358 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4359 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4360 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4361 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4362 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4363 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4364 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4365 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4366 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4367 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4370 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item;
4372 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4373 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4375 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);
4376 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);
4377 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4378 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4379 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4380 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4381 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4382 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4383 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4384 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4385 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
4386 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4387 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4388 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4389 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4390 /* smart callbacks called:
4391 * "selected" - when flipselector selected item is changed
4392 * "overflowed" - when flipselector item is changed to first item
4394 * "underflowed" - when flipselector item is changed to last item
4397 /* available styles:
4402 * @addtogroup Animator Animator
4403 * @ingroup Elementary
4405 * @brief Functions to ease creation of animations.
4407 * elm_animator is designed to provide an easy way to create animations.
4408 * Creating an animation with elm_animator is as simple as setting a
4409 * duration, an operating callback and telling it to run the animation.
4410 * However that is not the full extent of elm_animator's ability, animations
4411 * can be paused and resumed, reversed and the animation need not be linear.
4413 * To run an animation you must specify at least a duration and operation
4414 * callback, not setting any other properties will create a linear animation
4415 * that runs once and is not reversed.
4417 * @ref elm_animator_example_page_01 "This" example should make all of that
4420 * @warning elm_animator is @b not a widget.
4424 * @brief Type of curve desired for animation.
4426 * The speed in which an animation happens doesn't have to be linear, some
4427 * animations will look better if they're accelerating or decelerating, so
4428 * elm_animator provides four options in this regard:
4429 * @image html elm_animator_curve_style.png
4430 * @image latex elm_animator_curve_style.eps width=\textwidth
4431 * As can be seen in the image the speed of the animation will be:
4432 * @li ELM_ANIMATOR_CURVE_LINEAR constant
4433 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
4434 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
4435 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
4439 ELM_ANIMATOR_CURVE_LINEAR,
4440 ELM_ANIMATOR_CURVE_IN_OUT,
4441 ELM_ANIMATOR_CURVE_IN,
4442 ELM_ANIMATOR_CURVE_OUT
4443 } Elm_Animator_Curve_Style;
4444 typedef struct _Elm_Animator Elm_Animator;
4446 * Called back per loop of an elementary animators cycle
4447 * @param data user-data given to elm_animator_operation_callback_set()
4448 * @param animator the animator being run
4449 * @param double the position in the animation
4451 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
4453 * Called back when an elementary animator finishes
4454 * @param data user-data given to elm_animator_completion_callback_set()
4456 typedef void (*Elm_Animator_Completion_Cb) (void *data);
4459 * @brief Create a new animator.
4461 * @param[in] parent Parent object
4463 * The @a parent argument can be set to NULL for no parent. If a parent is set
4464 * there is no need to call elm_animator_del(), when the parent is deleted it
4465 * will delete the animator.
4467 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
4469 * Deletes the animator freeing any resources it used. If the animator was
4470 * created with a NULL parent this must be called, otherwise it will be
4471 * automatically called when the parent is deleted.
4473 * @param[in] animator Animator object
4475 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
4477 * Set the duration of the animation.
4479 * @param[in] animator Animator object
4480 * @param[in] duration Duration in second
4482 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
4484 * @brief Set the callback function for animator operation.
4486 * @param[in] animator Animator object
4487 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
4488 * @param[in] data Callback function user argument
4490 * The @p func callback will be called with a frame value in range [0, 1] which
4491 * indicates how far along the animation should be. It is the job of @p func to
4492 * actually change the state of any object(or objects) that are being animated.
4494 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
4496 * Set the callback function for the when the animation ends.
4498 * @param[in] animator Animator object
4499 * @param[in] func Callback function pointe
4500 * @param[in] data Callback function user argument
4502 * @warning @a func will not be executed if elm_animator_stop() is called.
4504 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
4506 * @brief Stop animator.
4508 * @param[in] animator Animator object
4510 * If called before elm_animator_animate() it does nothing. If there is an
4511 * animation in progress the animation will be stopped(the operation callback
4512 * will not be executed again) and it can't be restarted using
4513 * elm_animator_resume().
4515 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
4517 * Set the animator repeat count.
4519 * @param[in] animator Animator object
4520 * @param[in] repeat_cnt Repeat count
4522 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
4524 * @brief Start animation.
4526 * @param[in] animator Animator object
4528 * This function starts the animation if the nescessary properties(duration
4529 * and operation callback) have been set. Once started the animation will
4530 * run until complete or elm_animator_stop() is called.
4532 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
4534 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
4536 * @param[in] animator Animator object
4537 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
4539 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
4541 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
4543 * @param[in] animator Animator object
4544 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
4546 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator); EINA_ARG_NONNULL(1);
4548 * @brief Sets wether the animation should be automatically reversed.
4550 * @param[in] animator Animator object
4551 * @param[in] reverse Reverse or not
4553 * This controls wether the animation will be run on reverse imediately after
4554 * running forward. When this is set together with repetition the animation
4555 * will run in reverse once for each time it ran forward.@n
4556 * Runnin an animation in reverse is accomplished by calling the operation
4557 * callback with a frame value starting at 1 and diminshing until 0.
4559 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
4561 * Gets wether the animation will automatically reversed
4563 * @param[in] animator Animator object
4565 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
4567 * Gets the status for the animator operation. The status of the animator @b
4568 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
4569 * only informs if the animation was started and has not ended(either normally
4570 * or through elm_animator_stop()).
4572 * @param[in] animator Animator object
4574 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
4576 * Gets how many times the animation will be repeated
4578 * @param[in] animator Animator object
4580 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
4582 * Pause the animator.
4584 * @param[in] animator Animator object
4586 * This causes the animation to be temporarily stopped(the operation callback
4587 * will not be called). If the animation is not yet running this is a no-op.
4588 * Once an animation has been paused with this function it can be resumed
4589 * using elm_animator_resume().
4591 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
4593 * @brief Resumes the animator.
4595 * @param[in] animator Animator object
4597 * Resumes an animation that was paused using elm_animator_pause(), after
4598 * calling this function calls to the operation callback will happen
4599 * normally. If an animation is stopped by means of elm_animator_stop it
4600 * @b can't be restarted with this function.@n
4602 * @warning When an animation is resumed it doesn't start from where it was paused, it
4603 * will go to where it would have been if it had not been paused. If an
4604 * animation with a duration of 3 seconds is paused after 1 second for 1 second
4605 * it will resume as if it had ben animating for 2 seconds, the operating
4606 * callback will be called with a frame value of aproximately 2/3.
4608 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
4616 ELM_CALENDAR_UNIQUE,
4618 ELM_CALENDAR_WEEKLY,
4619 ELM_CALENDAR_MONTHLY,
4620 ELM_CALENDAR_ANNUALLY
4621 } Elm_Calendar_Mark_Repeat;
4622 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
4624 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4625 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4626 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
4627 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4628 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4629 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
4630 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
4631 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4632 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4633 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
4634 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
4635 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
4636 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);
4637 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
4638 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4639 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4640 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
4641 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4642 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4643 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4644 /* smart callbacks called:
4645 * changed - emitted when the user select a day or change the displayed
4650 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
4652 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4653 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4654 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
4655 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4656 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
4657 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4658 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
4659 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4660 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4661 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);
4662 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4663 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4664 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4665 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);
4666 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4667 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4668 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4669 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4670 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
4671 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4672 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
4673 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4674 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4675 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4676 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4677 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4678 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4679 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4680 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
4681 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);
4682 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4683 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
4684 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4685 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4686 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4687 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4688 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
4689 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4690 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4691 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
4692 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
4693 /* smart callbacks called:
4694 * "selected" - when item is selected (scroller stops)
4698 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4699 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
4700 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
4701 /* smart callbacks called:
4702 * "changed" - when the color value changes
4705 /* Contextual Popup */
4706 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
4708 typedef enum _Elm_Ctxpopup_Direction
4710 ELM_CTXPOPUP_DIRECTION_DOWN,
4711 ELM_CTXPOPUP_DIRECTION_RIGHT,
4712 ELM_CTXPOPUP_DIRECTION_LEFT,
4713 ELM_CTXPOPUP_DIRECTION_UP,
4714 } Elm_Ctxpopup_Direction;
4716 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4717 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
4718 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
4719 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
4720 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
4721 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
4722 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4723 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4724 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4725 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4726 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);
4727 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
4728 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4729 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
4730 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
4731 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4732 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);
4733 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);
4734 /* smart callbacks called:
4735 * "dismissed" - the ctxpopup was dismissed
4741 * @defgroup Transit Transit
4742 * @ingroup Elementary
4744 * Transit is designed to apply various animated transition effects to @c
4745 * Evas_Object, such like translation, rotation, etc. For using these
4746 * effects, create an @ref Elm_Transit and add the desired transition effects.
4748 * Once the effects are added into transit, they will be automatically
4749 * managed (their callback will be called until the duration is ended, and
4750 * they will be deleted on completion).
4754 * Elm_Transit *trans = elm_transit_add();
4755 * elm_transit_object_add(trans, obj);
4756 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
4757 * elm_transit_duration_set(transit, 1);
4758 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
4759 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
4760 * elm_transit_repeat_times_set(transit, 3);
4763 * Some transition effects are used to change the properties of objects. They
4765 * @li @ref elm_transit_effect_translation_add
4766 * @li @ref elm_transit_effect_color_add
4767 * @li @ref elm_transit_effect_rotation_add
4768 * @li @ref elm_transit_effect_wipe_add
4769 * @li @ref elm_transit_effect_zoom_add
4770 * @li @ref elm_transit_effect_resizing_add
4772 * Other transition effects are used to make one object disappear and another
4773 * object appear on its old place. These effects are:
4775 * @li @ref elm_transit_effect_flip_add
4776 * @li @ref elm_transit_effect_resizable_flip_add
4777 * @li @ref elm_transit_effect_fade_add
4778 * @li @ref elm_transit_effect_blend_add
4780 * It's also possible to make a transition chain with @ref
4781 * elm_transit_chain_transit_add.
4783 * @warning We strongly recomend to use elm_transit just when edje can not do
4784 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
4785 * animations can be manipulated inside the theme.
4788 * @li @ref transit_example_01_explained
4789 * @li @ref transit_example_02_explained
4790 * @li @ref transit_example_03_c
4791 * @li @ref transit_example_04_c
4797 * @enum Elm_Transit_Tween_Mode
4799 * The type of acceleration used in the transition.
4803 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
4804 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
4805 over time, then decrease again
4807 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
4809 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
4811 } Elm_Transit_Tween_Mode;
4814 * @enum Elm_Transit_Effect_Flip_Axis
4816 * The axis where flip effect should be applied.
4820 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
4821 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
4822 } Elm_Transit_Effect_Flip_Axis;
4824 * @enum Elm_Transit_Effect_Wipe_Dir
4826 * The direction where the wipe effect should occur.
4830 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
4831 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
4832 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
4833 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
4834 } Elm_Transit_Effect_Wipe_Dir;
4835 /** @enum Elm_Transit_Effect_Wipe_Type
4837 * Whether the wipe effect should show or hide the object.
4841 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
4843 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
4845 } Elm_Transit_Effect_Wipe_Type;
4848 * @typedef Elm_Transit
4850 * The Transit created with elm_transit_add(). This type has the information
4851 * about the objects which the transition will be applied, and the
4852 * transition effects that will be used. It also contains info about
4853 * duration, number of repetitions, auto-reverse, etc.
4855 typedef struct _Elm_Transit Elm_Transit;
4856 typedef void Elm_Transit_Effect;
4858 * @typedef Elm_Transit_Effect_Transition_Cb
4860 * Transition callback called for this effect on each transition iteration.
4862 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
4864 * Elm_Transit_Effect_End_Cb
4866 * Transition callback called for this effect when the transition is over.
4868 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
4873 * @note Is not necessary to delete the transit object, it will be deleted at
4874 * the end of its operation.
4875 * @note The transit will start playing when the program enter in the main loop, is not
4876 * necessary to give a start to the transit.
4878 * @return The transit object.
4882 EAPI Elm_Transit *elm_transit_add(void);
4885 * Stops the animation and delete the @p transit object.
4887 * Call this function if you wants to stop the animation before the duration
4888 * time. Make sure the @p transit object is still alive with
4889 * elm_transit_del_cb_set() function.
4890 * All added effects will be deleted, calling its repective data_free_cb
4891 * functions. The function setted by elm_transit_del_cb_set() will be called.
4893 * @see elm_transit_del_cb_set()
4895 * @param transit The transit object to be deleted.
4898 * @warning Just call this function if you are sure the transit is alive.
4900 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
4903 * Add a new effect to the transit.
4905 * @note The cb function and the data are the key to the effect. If you try to
4906 * add an already added effect, nothing is done.
4907 * @note After the first addition of an effect in @p transit, if its
4908 * effect list become empty again, the @p transit will be killed by
4909 * elm_transit_del(transit) function.
4913 * Elm_Transit *transit = elm_transit_add();
4914 * elm_transit_effect_add(transit,
4915 * elm_transit_effect_blend_op,
4916 * elm_transit_effect_blend_context_new(),
4917 * elm_transit_effect_blend_context_free);
4920 * @param transit The transit object.
4921 * @param transition_cb The operation function. It is called when the
4922 * animation begins, it is the function that actually performs the animation.
4923 * It is called with the @p data, @p transit and the time progression of the
4924 * animation (a double value between 0.0 and 1.0).
4925 * @param effect The context data of the effect.
4926 * @param end_cb The function to free the context data, it will be called
4927 * at the end of the effect, it must finalize the animation and free the
4931 * @warning The transit free the context data at the and of the transition with
4932 * the data_free_cb function, do not use the context data in another transit.
4934 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);
4937 * Delete an added effect.
4939 * This function will remove the effect from the @p transit, calling the
4940 * data_free_cb to free the @p data.
4942 * @see elm_transit_effect_add()
4944 * @note If the effect is not found, nothing is done.
4945 * @note If the effect list become empty, this function will call
4946 * elm_transit_del(transit), that is, it will kill the @p transit.
4948 * @param transit The transit object.
4949 * @param transition_cb The operation function.
4950 * @param effect The context data of the effect.
4954 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);
4957 * Add new object to apply the effects.
4959 * @note After the first addition of an object in @p transit, if its
4960 * object list become empty again, the @p transit will be killed by
4961 * elm_transit_del(transit) function.
4962 * @note If the @p obj belongs to another transit, the @p obj will be
4963 * removed from it and it will only belong to the @p transit. If the old
4964 * transit stays without objects, it will die.
4965 * @note When you add an object into the @p transit, its state from
4966 * evas_object_pass_events_get(obj) is saved, and it is applied when the
4967 * transit ends, if you change this state whith evas_object_pass_events_set()
4968 * after add the object, this state will change again when @p transit stops to
4971 * @param transit The transit object.
4972 * @param obj Object to be animated.
4975 * @warning It is not allowed to add a new object after transit begins to go.
4977 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
4980 * Removes an added object from the transit.
4982 * @note If the @p obj is not in the @p transit, nothing is done.
4983 * @note If the list become empty, this function will call
4984 * elm_transit_del(transit), that is, it will kill the @p transit.
4986 * @param transit The transit object.
4987 * @param obj Object to be removed from @p transit.
4990 * @warning It is not allowed to remove objects after transit begins to go.
4992 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
4995 * Get the objects of the transit.
4997 * @param transit The transit object.
4998 * @return a Eina_List with the objects from the transit.
5002 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5005 * Enable/disable keeping up the objects states.
5006 * If it is not kept, the objects states will be reset when transition ends.
5008 * @note @p transit can not be NULL.
5009 * @note One state includes geometry, color, map data.
5011 * @param transit The transit object.
5012 * @param state_keep Keeping or Non Keeping.
5016 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
5019 * Get a value whether the objects states will be reset or not.
5021 * @note @p transit can not be NULL
5023 * @see elm_transit_objects_final_state_keep_set()
5025 * @param transit The transit object.
5026 * @return EINA_TRUE means the states of the objects will be reset.
5027 * If @p transit is NULL, EINA_FALSE is returned
5031 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5034 * Set the event enabled when transit is operating.
5036 * If @p enabled is EINA_TRUE, the objects of the transit will receives
5037 * events from mouse and keyboard during the animation.
5038 * @note When you add an object with elm_transit_object_add(), its state from
5039 * evas_object_pass_events_get(obj) is saved, and it is applied when the
5040 * transit ends, if you change this state with evas_object_pass_events_set()
5041 * after adding the object, this state will change again when @p transit stops
5044 * @param transit The transit object.
5045 * @param enabled Events are received when enabled is @c EINA_TRUE, and
5046 * ignored otherwise.
5050 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
5053 * Get the value of event enabled status.
5055 * @see elm_transit_event_enabled_set()
5057 * @param transit The Transit object
5058 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
5059 * EINA_FALSE is returned
5063 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5066 * Set the user-callback function when the transit is deleted.
5068 * @note Using this function twice will overwrite the first function setted.
5069 * @note the @p transit object will be deleted after call @p cb function.
5071 * @param transit The transit object.
5072 * @param cb Callback function pointer. This function will be called before
5073 * the deletion of the transit.
5074 * @param data Callback funtion user data. It is the @p op parameter.
5078 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, void (*cb)(void *data, Elm_Transit* transit), void *data) EINA_ARG_NONNULL(1);
5081 * Set reverse effect automatically.
5083 * If auto reverse is setted, after running the effects with the progress
5084 * parameter from 0 to 1, it will call the effecs again with the progress
5085 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
5086 * where the duration was setted with the function elm_transit_add and
5087 * the repeat with the function elm_transit_repeat_times_set().
5089 * @param transit The transit object.
5090 * @param reverse EINA_TRUE means the auto_reverse is on.
5094 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
5097 * Get if the auto reverse is on.
5099 * @see elm_transit_auto_reverse_set()
5101 * @param transit The transit object.
5102 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
5103 * EINA_FALSE is returned
5107 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5110 * Set the transit repeat count. Effect will be repeated by repeat count.
5112 * This function sets the number of repetition the transit will run after
5113 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
5114 * If the @p repeat is a negative number, it will repeat infinite times.
5116 * @note If this function is called during the transit execution, the transit
5117 * will run @p repeat times, ignoring the times it already performed.
5119 * @param transit The transit object
5120 * @param repeat Repeat count
5124 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
5127 * Get the transit repeat count.
5129 * @see elm_transit_repeat_times_set()
5131 * @param transit The Transit object.
5132 * @return The repeat count. If @p transit is NULL
5137 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5140 * Set the transit animation acceleration type.
5142 * This function sets the tween mode of the transit that can be:
5143 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
5144 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
5145 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
5146 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
5148 * @param transit The transit object.
5149 * @param tween_mode The tween type.
5153 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
5156 * Get the transit animation acceleration type.
5158 * @note @p transit can not be NULL
5160 * @param transit The transit object.
5161 * @return The tween type. If @p transit is NULL
5162 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
5166 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5169 * Set the transit animation time
5171 * @note @p transit can not be NULL
5173 * @param transit The transit object.
5174 * @param duration The animation time.
5178 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
5181 * Get the transit animation time
5183 * @note @p transit can not be NULL
5185 * @param transit The transit object.
5187 * @return The transit animation time.
5191 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5194 * Starts the transition.
5195 * Once this API is called, the transit begins to measure the time.
5197 * @note @p transit can not be NULL
5199 * @param transit The transit object.
5203 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
5206 * Pause/Resume the transition.
5208 * If you call elm_transit_go again, the transit will be started from the
5209 * beginning, and will be unpaused.
5211 * @note @p transit can not be NULL
5213 * @param transit The transit object.
5214 * @param paused Whether the transition should be paused or not.
5218 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
5221 * Get the value of paused status.
5223 * @see elm_transit_paused_set()
5225 * @note @p transit can not be NULL
5227 * @param transit The transit object.
5228 * @return EINA_TRUE means transition is paused. If @p transit is NULL
5229 * EINA_FALSE is returned
5233 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5236 * Get the time progression of the animation (a double value between 0.0 and 1.0).
5238 * The value returned is a fraction (current time / total time). It
5239 * represents the progression position relative to the total.
5241 * @note @p transit can not be NULL
5243 * @param transit The transit object.
5245 * @return The time progression value. If @p transit is NULL
5250 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5253 * Makes the chain relationship between two transits.
5255 * @note @p transit can not be NULL. Transit would have multiple chain transits.
5256 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
5258 * @param transit The transit object.
5259 * @param chain_transit The chain transit object. This transit will be operated
5260 * after transit is done.
5262 * This function adds @p chain_transit transition to a chain after the @p
5263 * transit, and will be started as soon as @p transit ends. See @ref
5264 * transit_example_02_explained for a full example.
5268 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
5271 * Get the current chain transit list.
5273 * @note @p transit can not be NULL.
5275 * @param transit The transit object.
5276 * @return chain transit list.
5280 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
5283 * Add the Resizing Effect to Elm_Transit.
5285 * @note This API is one of the facades. It creates resizing effect context
5286 * and add it's required APIs to elm_transit_effect_add.
5288 * @see elm_transit_effect_add()
5290 * @param transit Transit object.
5291 * @param from_w Object width size when effect begins.
5292 * @param from_h Object height size when effect begins.
5293 * @param to_w Object width size when effect ends.
5294 * @param to_h Object height size when effect ends.
5295 * @return Resizing effect context data.
5299 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);
5302 * Add the Translation Effect to Elm_Transit.
5304 * @note This API is one of the facades. It creates translation effect context
5305 * and add it's required APIs to elm_transit_effect_add.
5307 * @see elm_transit_effect_add()
5309 * @param transit Transit object.
5310 * @param from_dx X Position variation when effect begins.
5311 * @param from_dy Y Position variation when effect begins.
5312 * @param to_dx X Position variation when effect ends.
5313 * @param to_dy Y Position variation when effect ends.
5314 * @return Translation effect context data.
5317 * @warning It is highly recommended just create a transit with this effect when
5318 * the window that the objects of the transit belongs has already been created.
5319 * This is because this effect needs the geometry information about the objects,
5320 * and if the window was not created yet, it can get a wrong information.
5322 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);
5325 * Add the Zoom Effect to Elm_Transit.
5327 * @note This API is one of the facades. It creates zoom effect context
5328 * and add it's required APIs to elm_transit_effect_add.
5330 * @see elm_transit_effect_add()
5332 * @param transit Transit object.
5333 * @param from_rate Scale rate when effect begins (1 is current rate).
5334 * @param to_rate Scale rate when effect ends.
5335 * @return Zoom effect context data.
5338 * @warning It is highly recommended just create a transit with this effect when
5339 * the window that the objects of the transit belongs has already been created.
5340 * This is because this effect needs the geometry information about the objects,
5341 * and if the window was not created yet, it can get a wrong information.
5343 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
5346 * Add the Flip Effect to Elm_Transit.
5348 * @note This API is one of the facades. It creates flip effect context
5349 * and add it's required APIs to elm_transit_effect_add.
5350 * @note This effect is applied to each pair of objects in the order they are listed
5351 * in the transit list of objects. The first object in the pair will be the
5352 * "front" object and the second will be the "back" object.
5354 * @see elm_transit_effect_add()
5356 * @param transit Transit object.
5357 * @param axis Flipping Axis(X or Y).
5358 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
5359 * @return Flip effect context data.
5362 * @warning It is highly recommended just create a transit with this effect when
5363 * the window that the objects of the transit belongs has already been created.
5364 * This is because this effect needs the geometry information about the objects,
5365 * and if the window was not created yet, it can get a wrong information.
5367 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
5370 * Add the Resizable Flip Effect to Elm_Transit.
5372 * @note This API is one of the facades. It creates resizable flip effect context
5373 * and add it's required APIs to elm_transit_effect_add.
5374 * @note This effect is applied to each pair of objects in the order they are listed
5375 * in the transit list of objects. The first object in the pair will be the
5376 * "front" object and the second will be the "back" object.
5378 * @see elm_transit_effect_add()
5380 * @param transit Transit object.
5381 * @param axis Flipping Axis(X or Y).
5382 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
5383 * @return Resizable flip effect context data.
5386 * @warning It is highly recommended just create a transit with this effect when
5387 * the window that the objects of the transit belongs has already been created.
5388 * This is because this effect needs the geometry information about the objects,
5389 * and if the window was not created yet, it can get a wrong information.
5391 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
5394 * Add the Wipe Effect to Elm_Transit.
5396 * @note This API is one of the facades. It creates wipe effect context
5397 * and add it's required APIs to elm_transit_effect_add.
5399 * @see elm_transit_effect_add()
5401 * @param transit Transit object.
5402 * @param type Wipe type. Hide or show.
5403 * @param dir Wipe Direction.
5404 * @return Wipe effect context data.
5407 * @warning It is highly recommended just create a transit with this effect when
5408 * the window that the objects of the transit belongs has already been created.
5409 * This is because this effect needs the geometry information about the objects,
5410 * and if the window was not created yet, it can get a wrong information.
5412 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
5415 * Add the Color Effect to Elm_Transit.
5417 * @note This API is one of the facades. It creates color effect context
5418 * and add it's required APIs to elm_transit_effect_add.
5420 * @see elm_transit_effect_add()
5422 * @param transit Transit object.
5423 * @param from_r RGB R when effect begins.
5424 * @param from_g RGB G when effect begins.
5425 * @param from_b RGB B when effect begins.
5426 * @param from_a RGB A when effect begins.
5427 * @param to_r RGB R when effect ends.
5428 * @param to_g RGB G when effect ends.
5429 * @param to_b RGB B when effect ends.
5430 * @param to_a RGB A when effect ends.
5431 * @return Color effect context data.
5435 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);
5438 * Add the Fade Effect to Elm_Transit.
5440 * @note This API is one of the facades. It creates fade effect context
5441 * and add it's required APIs to elm_transit_effect_add.
5442 * @note This effect is applied to each pair of objects in the order they are listed
5443 * in the transit list of objects. The first object in the pair will be the
5444 * "before" object and the second will be the "after" object.
5446 * @see elm_transit_effect_add()
5448 * @param transit Transit object.
5449 * @return Fade effect context data.
5452 * @warning It is highly recommended just create a transit with this effect when
5453 * the window that the objects of the transit belongs has already been created.
5454 * This is because this effect needs the color information about the objects,
5455 * and if the window was not created yet, it can get a wrong information.
5457 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
5460 * Add the Blend Effect to Elm_Transit.
5462 * @note This API is one of the facades. It creates blend effect context
5463 * and add it's required APIs to elm_transit_effect_add.
5464 * @note This effect is applied to each pair of objects in the order they are listed
5465 * in the transit list of objects. The first object in the pair will be the
5466 * "before" object and the second will be the "after" object.
5468 * @see elm_transit_effect_add()
5470 * @param transit Transit object.
5471 * @return Blend effect context data.
5474 * @warning It is highly recommended just create a transit with this effect when
5475 * the window that the objects of the transit belongs has already been created.
5476 * This is because this effect needs the color information about the objects,
5477 * and if the window was not created yet, it can get a wrong information.
5479 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
5482 * Add the Rotation Effect to Elm_Transit.
5484 * @note This API is one of the facades. It creates rotation effect context
5485 * and add it's required APIs to elm_transit_effect_add.
5487 * @see elm_transit_effect_add()
5489 * @param transit Transit object.
5490 * @param from_degree Degree when effect begins.
5491 * @param to_degree Degree when effect is ends.
5492 * @return Rotation effect context data.
5495 * @warning It is highly recommended just create a transit with this effect when
5496 * the window that the objects of the transit belongs has already been created.
5497 * This is because this effect needs the geometry information about the objects,
5498 * and if the window was not created yet, it can get a wrong information.
5500 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
5503 * Add the ImageAnimation Effect to Elm_Transit.
5505 * @note This API is one of the facades. It creates image animation effect context
5506 * and add it's required APIs to elm_transit_effect_add.
5507 * The @p images parameter is a list images paths. This list and
5508 * its contents will be deleted at the end of the effect by
5509 * elm_transit_effect_image_animation_context_free() function.
5513 * char buf[PATH_MAX];
5514 * Eina_List *images = NULL;
5515 * Elm_Transit *transi = elm_transit_add();
5517 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
5518 * images = eina_list_append(images, eina_stringshare_add(buf));
5520 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
5521 * images = eina_list_append(images, eina_stringshare_add(buf));
5522 * elm_transit_effect_image_animation_add(transi, images);
5526 * @see elm_transit_effect_add()
5528 * @param transit Transit object.
5529 * @param images Eina_List of images file paths. This list and
5530 * its contents will be deleted at the end of the effect by
5531 * elm_transit_effect_image_animation_context_free() function.
5532 * @return Image Animation effect context data.
5536 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
5541 typedef struct _Elm_Store Elm_Store;
5542 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
5543 typedef struct _Elm_Store_Item Elm_Store_Item;
5544 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
5545 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
5546 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
5547 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
5548 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
5549 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
5550 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
5551 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
5553 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
5554 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
5555 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
5556 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
5560 ELM_STORE_ITEM_MAPPING_NONE = 0,
5561 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
5562 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
5563 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
5564 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
5565 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
5566 // can add more here as needed by common apps
5567 ELM_STORE_ITEM_MAPPING_LAST
5568 } Elm_Store_Item_Mapping_Type;
5570 struct _Elm_Store_Item_Mapping_Icon
5572 // FIXME: allow edje file icons
5574 Elm_Icon_Lookup_Order lookup_order;
5575 Eina_Bool standard_name : 1;
5576 Eina_Bool no_scale : 1;
5577 Eina_Bool smooth : 1;
5578 Eina_Bool scale_up : 1;
5579 Eina_Bool scale_down : 1;
5582 struct _Elm_Store_Item_Mapping_Empty
5587 struct _Elm_Store_Item_Mapping_Photo
5592 struct _Elm_Store_Item_Mapping_Custom
5594 Elm_Store_Item_Mapping_Cb func;
5597 struct _Elm_Store_Item_Mapping
5599 Elm_Store_Item_Mapping_Type type;
5604 Elm_Store_Item_Mapping_Empty empty;
5605 Elm_Store_Item_Mapping_Icon icon;
5606 Elm_Store_Item_Mapping_Photo photo;
5607 Elm_Store_Item_Mapping_Custom custom;
5608 // add more types here
5612 struct _Elm_Store_Item_Info
5614 Elm_Genlist_Item_Class *item_class;
5615 const Elm_Store_Item_Mapping *mapping;
5620 struct _Elm_Store_Item_Info_Filesystem
5622 Elm_Store_Item_Info base;
5626 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
5627 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
5629 EAPI void elm_store_free(Elm_Store *st);
5631 EAPI Elm_Store *elm_store_filesystem_new(void);
5632 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
5633 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
5634 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
5636 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
5638 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
5639 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
5640 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
5641 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
5642 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
5643 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
5645 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
5646 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
5647 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
5648 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
5649 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
5650 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
5651 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
5653 /* SegmentControl */
5654 typedef struct _Elm_Segment_Item Elm_Segment_Item;
5655 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5656 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
5657 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);
5658 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
5659 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
5660 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5661 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
5662 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
5663 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
5664 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
5665 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
5666 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
5667 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
5668 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5669 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
5670 /* smart callbacks called:
5671 * "changed" -when the user clicks on a segment item which is not previously
5672 * selected and get selected. The event_info parameter is the
5673 * segment item index.
5676 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
5677 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
5678 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
5679 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
5680 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
5681 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
5682 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
5683 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
5685 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
5686 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);