3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
14 @version @PACKAGE_VERSION@
15 @author Carsten Haitzler <raster@@rasterman.com>
16 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
17 @author Cedric Bail <cedric.bail@@free.fr>
18 @author Vincent Torri <vtorri@@univ-evry.fr>
19 @author Daniel Kolesa <quaker66@@gmail.com>
20 @author Jaime Thomas <avi.thomas@@gmail.com>
21 @author Swisscom - http://www.swisscom.ch/
22 @author Christopher Michael <devilhorns@@comcast.net>
23 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
24 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
25 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
26 @author Brian Wang <brian.wang.0721@@gmail.com>
27 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
28 @author Samsung Electronics <tbd>
29 @author Samsung SAIT <tbd>
30 @author Brett Nash <nash@@nash.id.au>
31 @author Bruno Dilly <bdilly@@profusion.mobi>
32 @author Rafael Fonseca <rfonseca@@profusion.mobi>
33 @author Chuneon Park <hermet@@hermet.pe.kr>
34 @author Woohyun Jung <wh0705.jung@@samsung.com>
35 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
36 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
37 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
38 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
39 @author Gustavo Lima Chaves <glima@@profusion.mobi>
40 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
41 @author Tiago Falcão <tiago@@profusion.mobi>
42 @author Otavio Pontes <otavio@@profusion.mobi>
43 @author Viktor Kojouharov <vkojouharov@@gmail.com>
44 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
45 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
46 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
47 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
48 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
49 @author Jihoon Kim <jihoon48.kim@@samsung.com>
50 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
51 @author Tom Hacohen <tom@@stosb.com>
52 @author Aharon Hillel <a.hillel@@partner.samsung.com>
53 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
54 @author Shinwoo Kim <kimcinoo@@gmail.com>
55 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
56 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
59 @section intro What is Elementary?
61 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
62 applications (yet). Small simple ones with simple needs.
64 It is meant to make the programmers work almost brainless but give them lots
67 License: LGPL v2 (see COPYING in the base of Elementary's source). This
68 applies to all files in the source here.
70 Acknowledgements: There is a lot that goes into making a widget set, and
71 they don't happen out of nothing. It's like trying to make everyone
72 everywhere happy, regardless of age, gender, race or nationality - and
73 that is really tough. So thanks to people and organisations behind this,
74 aslisted in the Authors section above.
86 * @brief Elementary's API
91 @ELM_UNIX_DEF@ ELM_UNIX
92 @ELM_WIN32_DEF@ ELM_WIN32
93 @ELM_WINCE_DEF@ ELM_WINCE
94 @ELM_EDBUS_DEF@ ELM_EDBUS
95 @ELM_EFREET_DEF@ ELM_EFREET
96 @ELM_ETHUMB_DEF@ ELM_ETHUMB
97 @ELM_EMAP_DEF@ ELM_EMAP
98 @ELM_DEBUG_DEF@ ELM_DEBUG
99 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
100 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
102 /* Standard headers for standard system calls etc. */
107 #include <sys/types.h>
108 #include <sys/stat.h>
109 #include <sys/time.h>
110 #include <sys/param.h>
123 # ifdef ELM_LIBINTL_H
124 # include <libintl.h>
135 #if defined (ELM_WIN32) || defined (ELM_WINCE)
138 # define alloca _alloca
149 #include <Ecore_Evas.h>
150 #include <Ecore_File.h>
151 #include <Ecore_IMF.h>
160 # include <Efreet_Mime.h>
161 # include <Efreet_Trash.h>
165 # include <Ethumb_Client.h>
177 # ifdef ELEMENTARY_BUILD
179 # define EAPI __declspec(dllexport)
182 # endif /* ! DLL_EXPORT */
184 # define EAPI __declspec(dllimport)
185 # endif /* ! EFL_EVAS_BUILD */
189 # define EAPI __attribute__ ((visibility("default")))
196 #endif /* ! _WIN32 */
199 /* allow usage from c++ */
204 #define ELM_VERSION_MAJOR @VMAJ@
205 #define ELM_VERSION_MINOR @VMIN@
207 typedef struct _Elm_Version
215 EAPI extern Elm_Version *elm_version;
218 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
219 #define ELM_PI 3.14159265358979323846
222 * @defgroup General General
224 * @brief General Elementary API. Functions that don't relate to
225 * Elementary objects specifically.
227 * Here are documented functions which init/shutdown the library,
228 * that apply to generic Elementary objects, that deal with
229 * configuration, et cetera.
231 * @ref general_functions_example_page "This" example contemplates
232 * some of these functions.
236 * @addtogroup General
241 * Defines couple of standard Evas_Object layers to be used
242 * with evas_object_layer_set().
244 * @note whenever extending with new values, try to keep some padding
245 * to siblings so there is room for further extensions.
247 typedef enum _Elm_Object_Layer
249 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
250 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
251 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
252 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
253 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
254 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
257 /**************************************************************************/
258 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
261 * Emitted when any Elementary's policy value is changed.
263 EAPI extern int ELM_EVENT_POLICY_CHANGED;
266 * @typedef Elm_Event_Policy_Changed
268 * Data on the event when an Elementary policy has changed
270 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
273 * @struct _Elm_Event_Policy_Changed
275 * Data on the event when an Elementary policy has changed
277 struct _Elm_Event_Policy_Changed
279 unsigned int policy; /**< the policy identifier */
280 int new_value; /**< value the policy had before the change */
281 int old_value; /**< new value the policy got */
285 * Policy identifiers.
287 typedef enum _Elm_Policy
289 ELM_POLICY_QUIT, /**< under which circunstances the application
290 * should quit automatically. @see
294 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
297 typedef enum _Elm_Policy_Quit
299 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
301 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
303 * window is closed */
304 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
306 typedef enum _Elm_Focus_Direction
310 } Elm_Focus_Direction;
312 typedef enum _Elm_Text_Format
314 ELM_TEXT_FORMAT_PLAIN_UTF8,
315 ELM_TEXT_FORMAT_MARKUP_UTF8
319 * Line wrapping types.
321 typedef enum _Elm_Wrap_Type
323 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
324 ELM_WRAP_CHAR, /**< Char wrap - wrap between graphmes */
325 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
326 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
332 * Called back when a widget's tooltip is activated and needs content.
333 * @param data user-data given to elm_object_tooltip_content_cb_set()
334 * @param obj owner widget.
336 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
339 * Called back when a widget's item tooltip is activated and needs content.
340 * @param data user-data given to elm_object_tooltip_content_cb_set()
341 * @param obj owner widget.
342 * @param item context dependent item. As an example, if tooltip was
343 * set on Elm_List_Item, then it is of this type.
345 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
347 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
349 #ifndef ELM_LIB_QUICKLAUNCH
350 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
352 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
355 /**************************************************************************/
359 * Initialize Elementary
361 * @param[in] argc System's argument count value
362 * @param[in] argv System's pointer to array of argument strings
363 * @return The init counter value.
365 * This function initializes Elementary and increments a counter of
366 * the number of calls to it. It returs the new counter's value.
368 * @warning This call is exported only for use by the @c ELM_MAIN()
369 * macro. There is no need to use this if you use this macro (which
370 * is highly advisable). An elm_main() should contain the entry
371 * point code for your application, having the same prototype as
372 * elm_init(), and @b not being static (putting the @c EAPI symbol
373 * in front of its type declaration is advisable). The @c
374 * ELM_MAIN() call should be placed just after it.
377 * @dontinclude bg_example_01.c
381 * See the full @ref bg_example_01_c "example".
383 * @see elm_shutdown().
386 EAPI int elm_init(int argc, char **argv);
389 * Shut down Elementary
391 * @return The init counter value.
393 * This should be called at the end of your application, just
394 * before it ceases to do any more processing. This will clean up
395 * any permanent resources your application may have allocated via
396 * Elementary that would otherwise persist.
398 * @see elm_init() for an example
402 EAPI int elm_shutdown(void);
405 * Run Elementary's main loop
407 * This call should be issued just after all initialization is
408 * completed. This function will not return until elm_exit() is
409 * called. It will keep looping, running the main
410 * (event/processing) loop for Elementary.
412 * @see elm_init() for an example
416 EAPI void elm_run(void);
419 * Exit Elementary's main loop
421 * If this call is issued, it will flag the main loop to cease
422 * processing and return back to its parent function (usually your
423 * elm_main() function).
425 * @see elm_init() for an example. There, just after a request to
426 * close the window comes, the main loop will be left.
428 * @note By using the #ELM_POLICY_QUIT on your Elementary
429 * applications, you'll this function called automatically for you.
433 EAPI void elm_exit(void);
436 * Provide information in order to make Elementary determine the @b
437 * run time location of the software in question, so other data files
438 * such as images, sound files, executable utilities, libraries,
439 * modules and locale files can be found.
441 * @param mainfunc This is your application's main function name,
442 * whose binary's location is to be found. Providing @c NULL
443 * will make Elementary not to use it
444 * @param dom This will be used as the application's "domain", in the
445 * form of a prefix to any environment variables that may
446 * override prefix detection and the directory name, inside the
447 * standard share or data directories, where the software's
448 * data files will be looked for.
449 * @param checkfile This is an (optional) magic file's path to check
450 * for existence (and it must be located in the data directory,
451 * under the share directory provided above). Its presence will
452 * help determine the prefix found was correct. Pass @c NULL if
453 * the check is not to be done.
455 * This function allows one to re-locate the application somewhere
456 * else after compilation, if the developer wishes for easier
457 * distribution of pre-compiled binaries.
459 * The prefix system is designed to locate where the given software is
460 * installed (under a common path prefix) at run time and then report
461 * specific locations of this prefix and common directories inside
462 * this prefix like the binary, library, data and locale directories,
463 * through the @c elm_app_*_get() family of functions.
465 * Call elm_app_info_set() early on before you change working
466 * directory or anything about @c argv[0], so it gets accurate
469 * It will then try and trace back which file @p mainfunc comes from,
470 * if provided, to determine the application's prefix directory.
472 * The @p dom parameter provides a string prefix to prepend before
473 * environment variables, allowing a fallback to @b specific
474 * environment variables to locate the software. You would most
475 * probably provide a lowercase string there, because it will also
476 * serve as directory domain, explained next. For environment
477 * variables purposes, this string is made uppercase. For example if
478 * @c "myapp" is provided as the prefix, then the program would expect
479 * @c "MYAPP_PREFIX" as a master environment variable to specify the
480 * exact install prefix for the software, or more specific environment
481 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
482 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
483 * the user or scripts before launching. If not provided (@c NULL),
484 * environment variables will not be used to override compiled-in
485 * defaults or auto detections.
487 * The @p dom string also provides a subdirectory inside the system
488 * shared data directory for data files. For example, if the system
489 * directory is @c /usr/local/share, then this directory name is
490 * appended, creating @c /usr/local/share/myapp, if it @p was @c
491 * "myapp". It is expected the application installs data files in
494 * The @p checkfile is a file name or path of something inside the
495 * share or data directory to be used to test that the prefix
496 * detection worked. For example, your app will install a wallpaper
497 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
498 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
501 * @see elm_app_compile_bin_dir_set()
502 * @see elm_app_compile_lib_dir_set()
503 * @see elm_app_compile_data_dir_set()
504 * @see elm_app_compile_locale_set()
505 * @see elm_app_prefix_dir_get()
506 * @see elm_app_bin_dir_get()
507 * @see elm_app_lib_dir_get()
508 * @see elm_app_data_dir_get()
509 * @see elm_app_locale_dir_get()
511 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
514 * Provide information on the @b fallback application's binaries
515 * directory, on scenarios where they get overriden by
516 * elm_app_info_set().
518 * @param dir The path to the default binaries directory (compile time
521 * @note Elementary will as well use this path to determine actual
522 * names of binaries' directory paths, maybe changing it to be @c
523 * something/local/bin instead of @c something/bin, only, for
526 * @warning You should call this function @b before
527 * elm_app_info_set().
529 EAPI void elm_app_compile_bin_dir_set(const char *dir);
532 * Provide information on the @b fallback application's libraries
533 * directory, on scenarios where they get overriden by
534 * elm_app_info_set().
536 * @param dir The path to the default libraries directory (compile
539 * @note Elementary will as well use this path to determine actual
540 * names of libraries' directory paths, maybe changing it to be @c
541 * something/lib32 or @c something/lib64 instead of @c something/lib,
544 * @warning You should call this function @b before
545 * elm_app_info_set().
547 EAPI void elm_app_compile_lib_dir_set(const char *dir);
550 * Provide information on the @b fallback application's data
551 * directory, on scenarios where they get overriden by
552 * elm_app_info_set().
554 * @param dir The path to the default data directory (compile time
557 * @note Elementary will as well use this path to determine actual
558 * names of data directory paths, maybe changing it to be @c
559 * something/local/share instead of @c something/share, only, for
562 * @warning You should call this function @b before
563 * elm_app_info_set().
565 EAPI void elm_app_compile_data_dir_set(const char *dir);
568 * Provide information on the @b fallback application's locale
569 * directory, on scenarios where they get overriden by
570 * elm_app_info_set().
572 * @param dir The path to the default locale directory (compile time
575 * @warning You should call this function @b before
576 * elm_app_info_set().
578 EAPI void elm_app_compile_locale_set(const char *dir);
581 * Retrieve the application's run time prefix directory, as set by
582 * elm_app_info_set() and the way (environment) the application was
585 * @return The directory prefix the application is actually using
587 EAPI const char *elm_app_prefix_dir_get(void);
590 * Retrieve the application's run time binaries prefix directory, as
591 * set by elm_app_info_set() and the way (environment) the application
594 * @return The binaries directory prefix the application is actually
597 EAPI const char *elm_app_bin_dir_get(void);
600 * Retrieve the application's run time libraries prefix directory, as
601 * set by elm_app_info_set() and the way (environment) the application
604 * @return The libraries directory prefix the application is actually
607 EAPI const char *elm_app_lib_dir_get(void);
610 * Retrieve the application's run time data prefix directory, as
611 * set by elm_app_info_set() and the way (environment) the application
614 * @return The data directory prefix the application is actually
617 EAPI const char *elm_app_data_dir_get(void);
620 * Retrieve the application's run time locale prefix directory, as
621 * set by elm_app_info_set() and the way (environment) the application
624 * @return The locale directory prefix the application is actually
627 EAPI const char *elm_app_locale_dir_get(void);
629 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
630 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
631 EAPI int elm_quicklaunch_init(int argc, char **argv);
632 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
633 EAPI int elm_quicklaunch_sub_shutdown(void);
634 EAPI int elm_quicklaunch_shutdown(void);
635 EAPI void elm_quicklaunch_seed(void);
636 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
637 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
638 EAPI void elm_quicklaunch_cleanup(void);
639 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
640 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
642 EAPI Eina_Bool elm_need_efreet(void);
643 EAPI Eina_Bool elm_need_e_dbus(void);
644 EAPI Eina_Bool elm_need_ethumb(void);
647 * Set a new policy's value (for a given policy group/identifier).
649 * @param policy policy identifier, as in @ref Elm_Policy.
650 * @param value policy value, which depends on the identifier
652 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
654 * Elementary policies define applications' behavior,
655 * somehow. These behaviors are divided in policy groups (see
656 * #Elm_Policy enumeration). This call will emit the Ecore event
657 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
658 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
661 * @note Currently, we have only one policy identifier/group
662 * (#ELM_POLICY_QUIT), which has two possible values.
666 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
669 * Gets the policy value set for given policy identifier.
671 * @param policy policy identifier, as in #Elm_Policy.
672 * @return The currently set policy value, for that
673 * identifier. Will be @c 0 if @p policy passed is invalid.
677 EAPI int elm_policy_get(unsigned int policy);
680 * Set a label of an object
682 * @param obj The Elementary object
683 * @param item The label id to set (NULL for the default label)
684 * @param label The new text of the label
686 * @note Elementary objects may have many labels (e.g. Action Slider)
690 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
692 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
695 * Get a label of an object
697 * @param obj The Elementary object
698 * @param item The label id to get (NULL for the default label)
699 * @return text of the label or
702 * @note Elementary objects may have many labels (e.g. Action Slider)
706 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *item);
708 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
714 EAPI void elm_all_flush(void);
715 EAPI int elm_cache_flush_interval_get(void);
716 EAPI void elm_cache_flush_interval_set(int size);
717 EAPI void elm_cache_flush_interval_all_set(int size);
718 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
719 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
720 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
721 EAPI int elm_font_cache_get(void);
722 EAPI void elm_font_cache_set(int size);
723 EAPI void elm_font_cache_all_set(int size);
724 EAPI int elm_image_cache_get(void);
725 EAPI void elm_image_cache_set(int size);
726 EAPI void elm_image_cache_all_set(int size);
727 EAPI int elm_edje_file_cache_get(void);
728 EAPI void elm_edje_file_cache_set(int size);
729 EAPI void elm_edje_file_cache_all_set(int size);
730 EAPI int elm_edje_collection_cache_get(void);
731 EAPI void elm_edje_collection_cache_set(int size);
732 EAPI void elm_edje_collection_cache_all_set(int size);
735 * @defgroup Scaling Selective Widget Scaling
737 * Different widgets can be scaled independently. These functions
738 * allow you to manipulate this scaling on a per-widget basis. The
739 * object and all its children get their scaling factors multiplied
740 * by the scale factor set. This is multiplicative, in that if a
741 * child also has a scale size set it is in turn multiplied by its
742 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
743 * double size, @c 0.5 is half, etc.
745 * @ref general_functions_example_page "This" example contemplates
746 * some of these functions.
750 * Set the scaling factor for a given Elementary object
752 * @param obj The Elementary to operate on
753 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
758 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
761 * Get the scaling factor for a given Elementary object
763 * @param obj The object
764 * @return The scaling factor set by elm_object_scale_set()
768 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
769 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
770 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
771 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
772 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
774 * Set the style to use by a widget
776 * Sets the style name that will define the appearance of a widget. Styles
777 * vary from widget to widget and may also be defined by other themes
778 * by means of extensions and overlays.
780 * @param obj The Elementary widget to style
781 * @param style The style name to use
783 * @see elm_theme_extension_add()
784 * @see elm_theme_overlay_add()
788 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
790 * Get the style used by the widget
792 * This gets the style being used for that widget. Note that the string
793 * pointer is only valid as longas the object is valid and the style doesn't
796 * @param obj The Elementary widget to query for its style
797 * @return The style name used
799 * @see elm_object_style_set()
803 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
806 * @defgroup Styles Styles
808 * Widgets can have different styles of look. These generic API's
809 * set styles of widgets, if they support them (and if the theme(s)
812 * @ref general_functions_example_page "This" example contemplates
813 * some of these functions.
817 * Set the disabled state of an Elementary object.
819 * @param obj The Elementary object to operate on
820 * @param disabled The state to put in in: @c EINA_TRUE for
821 * disabled, @c EINA_FALSE for enabled
823 * Elementary objects can be @b disabled, in which state they won't
824 * receive input and, in general, will be themed differently from
825 * their normal state, usually greyed out. Useful for contexts
826 * where you don't want your users to interact with some of the
827 * parts of you interface.
829 * This sets the state for the widget, either disabling it or
834 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
837 * Get the disabled state of an Elementary object.
839 * @param obj The Elementary object to operate on
840 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
841 * if it's enabled (or on errors)
843 * This gets the state of the widget, which might be enabled or disabled.
847 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
850 * @defgroup WidgetNavigation Widget Tree Navigation.
852 * How to check if an Evas Object is an Elementary widget? How to
853 * get the first elementary widget that is parent of the given
854 * object? These are all covered in widget tree navigation.
856 * @ref general_functions_example_page "This" example contemplates
857 * some of these functions.
860 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
863 * Get the first parent of the given object that is an Elementary
866 * @param obj the Elementary object to query parent from.
867 * @return the parent object that is an Elementary widget, or @c
868 * NULL, if it was not found.
870 * Use this to query for an object's parent widget.
872 * @note Most of Elementary users wouldn't be mixing non-Elementary
873 * smart objects in the objects tree of an application, as this is
874 * an advanced usage of Elementary with Evas. So, except for the
875 * application's window, which is the root of that tree, all other
876 * objects would have valid Elementary widget parents.
878 * @ingroup WidgetNavigation
880 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
881 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
882 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
884 EAPI double elm_scale_get(void);
885 EAPI void elm_scale_set(double scale);
886 EAPI void elm_scale_all_set(double scale);
888 EAPI Eina_Bool elm_mirrored_get(void);
889 EAPI void elm_mirrored_set(Eina_Bool mirrored);
891 EAPI Eina_Bool elm_config_save(void);
892 EAPI void elm_config_reload(void);
894 EAPI const char *elm_profile_current_get(void);
895 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
896 EAPI void elm_profile_dir_free(const char *p_dir);
897 EAPI Eina_List *elm_profile_list_get(void);
898 EAPI void elm_profile_list_free(Eina_List *l);
899 EAPI void elm_profile_set(const char *profile);
900 EAPI void elm_profile_all_set(const char *profile);
902 EAPI const char *elm_engine_current_get(void);
903 EAPI void elm_engine_set(const char *engine);
905 typedef struct _Elm_Text_Class
911 typedef struct _Elm_Font_Overlay
913 const char *text_class;
918 typedef struct _Elm_Font_Properties
922 } Elm_Font_Properties;
924 EAPI const Eina_List *elm_text_classes_list_get(void);
925 EAPI void elm_text_classes_list_free(const Eina_List *list);
927 EAPI const Eina_List *elm_font_overlay_list_get(void);
928 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
929 EAPI void elm_font_overlay_unset(const char *text_class);
930 EAPI void elm_font_overlay_apply(void);
931 EAPI void elm_font_overlay_all_apply(void);
933 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
934 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
935 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
936 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
937 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
938 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
941 * @defgroup Fingers Fingers
943 * Elementary is designed to be finger-friendly for touchscreens,
944 * and so in addition to scaling for display resolution, it can
945 * also scale based on finger "resolution" (or size). You can then
946 * customize the granularity of the areas meant to receive clicks
949 * Different profiles may have pre-set values for finger sizes.
951 * @ref general_functions_example_page "This" example contemplates
952 * some of these functions.
956 * Get the configured "finger size"
958 * @return The finger size
960 * This gets the globally configured finger size, <b>in pixels</b>
964 EAPI Evas_Coord elm_finger_size_get(void);
965 EAPI void elm_finger_size_set(Evas_Coord size);
966 EAPI void elm_finger_size_all_set(Evas_Coord size);
969 * @defgroup Focus Focus
971 * An Elementary application has, at all times, one (and only one)
972 * @b focused object. This is what determines where the input
973 * events go to within the application's window. Also, focused
974 * objects can be decorated differently, in order to signal to the
975 * user where the input is, at a given moment.
977 * Elementary applications also have the concept of <b>focus
978 * chain</b>: one can cycle through all the windows' focusable
979 * objects by input (tab key) or programmatically. The default
980 * focus chain for an application is the one define by the order in
981 * which the widgets where added in code. One will cycle through
982 * top level widgets, and, for each one containg sub-objects, cycle
983 * through them all, before returning to the level
984 * above. Elementary also allows one to set @b custom focus chains
985 * for their applications.
987 * Besides the focused decoration a widget may exhibit, when it
988 * gets focus, Elementary has a @b global focus highlight object
989 * that can be enabled for a window. If one chooses to do so, this
990 * extra highlight effect will surround the current focused object,
993 * @note Some Elementary widgets are @b unfocusable, after
994 * creation, by their very nature: they are not meant to be
995 * interacted with input events, but are there just for visual
998 * @ref general_functions_example_page "This" example contemplates
999 * some of these functions.
1002 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1003 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1004 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1005 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1008 * Get the whether an Elementary object has the focus or not.
1010 * @param obj The Elementary object to get the information from
1011 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1012 * not (and on errors).
1014 * @see elm_object_focus()
1018 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1021 * Make a given Elementary object the focused one.
1023 * @param obj The Elementary object to make focused.
1025 * @note This object, if it can handle focus, will take the focus
1026 * away from the one who had it previously and will, for now on, be
1027 * the one receiving input events.
1029 * @see elm_object_focus_get()
1033 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1036 * Remove the focus from an Elementary object
1038 * @param obj The Elementary to take focus from
1040 * This removes the focus from @p obj, passing it back to the
1041 * previous element in the focus chain list.
1043 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1047 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1050 * Set the ability for an Element object to be focused
1052 * @param obj The Elementary object to operate on
1053 * @param enable @c EINA_TRUE if the object can be focused, @c
1054 * EINA_FALSE if not (and on errors)
1056 * This sets whether the object @p obj is able to take focus or
1057 * not. Unfocusable objects do nothing when programmatically
1058 * focused, being the nearest focusable parent object the one
1059 * really getting focus. Also, when they receive mouse input, they
1060 * will get the event, but not take away the focus from where it
1065 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1068 * Get whether an Elementary object is focusable or not
1070 * @param obj The Elementary object to operate on
1071 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1072 * EINA_FALSE if not (and on errors)
1074 * @note Objects which are meant to be interacted with by input
1075 * events are created able to be focused, by default. All the
1080 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1082 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1083 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1084 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1085 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1086 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1087 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1088 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1091 * Make the elementary object and its children to be unfocusable (or focusable).
1093 * @param obj The Elementary object to operate on
1094 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1095 * @c EINA_FALSE for focusable.
1097 * This sets whether the object @p obj and its children objects
1098 * able to take focus or not. If the tree is unfocusable,
1099 * newest focused object which is not in this tree will get focus.
1100 * This API can be helpful for an object to be deleted.
1101 * When an object will be deleted soon, it and its children may not
1102 * want to get focus (by focus reverting or by other focus controls).
1103 * Then, just use this API before deleting.
1105 * @see elm_object_tree_unfocusable_get()
1109 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1112 * Get whether an Elementary object and its children are unfocusable or not.
1114 * @param obj The Elementary object to get the information from
1115 * @return @c EINA_TRUE, if the tree is unfocussable,
1116 * @c EINA_FALSE if not (and on errors).
1118 * @see elm_object_tree_unfocusable_set()
1122 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1124 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1125 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1126 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1127 EAPI double elm_scroll_bounce_friction_get(void);
1128 EAPI void elm_scroll_bounce_friction_set(double friction);
1129 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1130 EAPI double elm_scroll_page_scroll_friction_get(void);
1131 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1132 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1133 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1134 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1135 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1136 EAPI double elm_scroll_zoom_friction_get(void);
1137 EAPI void elm_scroll_zoom_friction_set(double friction);
1138 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1139 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1140 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1141 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1142 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1143 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1144 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1145 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1146 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1147 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1148 EAPI double elm_scroll_thumbscroll_friction_get(void);
1149 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1150 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1151 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1152 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1153 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1155 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1156 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1157 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1158 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1159 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1160 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1161 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1162 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1164 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1165 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);
1166 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);
1168 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1169 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1172 * Adjust size of an element for finger usage.
1174 * @param times_w How many fingers should fit horizontally
1175 * @param w Pointer to the width size to adjust
1176 * @param times_h How many fingers should fit vertically
1177 * @param h Pointer to the height size to adjust
1179 * This takes width and height sizes (in pixels) as input and a
1180 * size multiple (which is how many fingers you want to place
1181 * within the area, being "finger" the size set by
1182 * elm_finger_size_set()), and adjusts the size to be large enough
1183 * to accommodate the resulting size -- if it doesn't already
1184 * accommodate it. On return the @p w and @p h sizes pointed to by
1185 * these parameters will be modified, on those conditions.
1187 * @note This is kind of a low level Elementary call, most useful
1188 * on size evaluation times for widgets. An external user wouldn't
1189 * be calling, most of the time.
1193 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1195 EAPI double elm_longpress_timeout_get(void);
1196 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1199 * don't use it unless you are sure
1201 EAPI void elm_object_tree_dump(const Evas_Object *top);
1202 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1204 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1205 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1210 * @defgroup Theme Theme
1212 * Elementary uses Edje to theme its widgets, naturally. But for the most
1213 * part this is hidden behind a simpler interface that lets the user set
1214 * extensions and choose the style of widgets in a much easier way.
1216 * Instead of thinking in terms of paths to Edje files and their groups
1217 * each time you want to change the appearance of a widget, Elementary
1218 * works so you can add any theme file with extensions or replace the
1219 * main theme at one point in the application, and then just set the style
1220 * of widgets with elm_object_style_set() and related functions. Elementary
1221 * will then look in its list of themes for a matching group and apply it,
1222 * and when the theme changes midway through the application, all widgets
1223 * will be updated accordingly.
1225 * There are three concepts you need to know to understand how Elementary
1226 * theming works: default theme, extensions and overlays.
1228 * Default theme, obviously enough, is the one that provides the default
1229 * look of all widgets. End users can change the theme used by Elementary
1230 * by setting the @c ELM_THEME environment variable before running an
1231 * application, or globally for all programs using the @c elementary_config
1232 * utility. Applications can change the default theme using elm_theme_set(),
1233 * but this can go against the user wishes, so it's not an adviced practice.
1235 * Ideally, applications should find everything they need in the already
1236 * provided theme, but there may be occasions when that's not enough and
1237 * custom styles are required to correctly express the idea. For this
1238 * cases, Elementary has extensions.
1240 * Extensions allow the application developer to write styles of its own
1241 * to apply to some widgets. This requires knowledge of how each widget
1242 * is themed, as extensions will always replace the entire group used by
1243 * the widget, so important signals and parts need to be there for the
1244 * object to behave properly (see documentation of Edje for details).
1245 * Once the theme for the extension is done, the application needs to add
1246 * it to the list of themes Elementary will look into, using
1247 * elm_theme_extension_add(), and set the style of the desired widgets as
1248 * he would normally with elm_object_style_set().
1250 * Overlays, on the other hand, can replace the look of all widgets by
1251 * overriding the default style. Like extensions, it's up to the application
1252 * developer to write the theme for the widgets it wants, the difference
1253 * being that when looking for the theme, Elementary will check first the
1254 * list of overlays, then the set theme and lastly the list of extensions,
1255 * so with overlays it's possible to replace the default view and every
1256 * widget will be affected. This is very much alike to setting the whole
1257 * theme for the application and will probably clash with the end user
1258 * options, not to mention the risk of ending up with not matching styles
1259 * across the program. Unless there's a very special reason to use them,
1260 * overlays should be avoided for the resons exposed before.
1262 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1263 * keeps one default internally and every function that receives one of
1264 * these can be called with NULL to refer to this default (except for
1265 * elm_theme_free()). It's possible to create a new instance of a
1266 * ::Elm_Theme to set other theme for a specific widget (and all of its
1267 * children), but this is as discouraged, if not even more so, than using
1268 * overlays. Don't use this unless you really know what you are doing.
1270 * But to be less negative about things, you can look at the following
1272 * @li @ref theme_example_01 "Using extensions"
1273 * @li @ref theme_example_02 "Using overlays"
1278 * @typedef Elm_Theme
1280 * Opaque handler for the list of themes Elementary looks for when
1281 * rendering widgets.
1283 * Stay out of this unless you really know what you are doing. For most
1284 * cases, sticking to the default is all a developer needs.
1286 typedef struct _Elm_Theme Elm_Theme;
1289 * Create a new specific theme
1291 * This creates an empty specific theme that only uses the default theme. A
1292 * specific theme has its own private set of extensions and overlays too
1293 * (which are empty by default). Specific themes do not fall back to themes
1294 * of parent objects. They are not intended for this use. Use styles, overlays
1295 * and extensions when needed, but avoid specific themes unless there is no
1296 * other way (example: you want to have a preview of a new theme you are
1297 * selecting in a "theme selector" window. The preview is inside a scroller
1298 * and should display what the theme you selected will look like, but not
1299 * actually apply it yet. The child of the scroller will have a specific
1300 * theme set to show this preview before the user decides to apply it to all
1303 EAPI Elm_Theme *elm_theme_new(void);
1305 * Free a specific theme
1307 * @param th The theme to free
1309 * This frees a theme created with elm_theme_new().
1311 EAPI void elm_theme_free(Elm_Theme *th);
1313 * Copy the theme fom the source to the destination theme
1315 * @param th The source theme to copy from
1316 * @param thdst The destination theme to copy data to
1318 * This makes a one-time static copy of all the theme config, extensions
1319 * and overlays from @p th to @p thdst. If @p th references a theme, then
1320 * @p thdst is also set to reference it, with all the theme settings,
1321 * overlays and extensions that @p th had.
1323 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1325 * Tell the source theme to reference the ref theme
1327 * @param th The theme that will do the referencing
1328 * @param thref The theme that is the reference source
1330 * This clears @p th to be empty and then sets it to refer to @p thref
1331 * so @p th acts as an override to @p thref, but where its overrides
1332 * don't apply, it will fall through to @pthref for configuration.
1334 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1336 * Return the theme referred to
1338 * @param th The theme to get the reference from
1339 * @return The referenced theme handle
1341 * This gets the theme set as the reference theme by elm_theme_ref_set().
1342 * If no theme is set as a reference, NULL is returned.
1344 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1346 * Return the default theme
1348 * @return The default theme handle
1350 * This returns the internal default theme setup handle that all widgets
1351 * use implicitly unless a specific theme is set. This is also often use
1352 * as a shorthand of NULL.
1354 EAPI Elm_Theme *elm_theme_default_get(void);
1356 * Prepends a theme overlay to the list of overlays
1358 * @param th The theme to add to, or if NULL, the default theme
1359 * @param item The Edje file path to be used
1361 * Use this if your application needs to provide some custom overlay theme
1362 * (An Edje file that replaces some default styles of widgets) where adding
1363 * new styles, or changing system theme configuration is not possible. Do
1364 * NOT use this instead of a proper system theme configuration. Use proper
1365 * configuration files, profiles, environment variables etc. to set a theme
1366 * so that the theme can be altered by simple confiugration by a user. Using
1367 * this call to achieve that effect is abusing the API and will create lots
1370 * @see elm_theme_extension_add()
1372 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1374 * Delete a theme overlay from the list of overlays
1376 * @param th The theme to delete from, or if NULL, the default theme
1377 * @param item The name of the theme overlay
1379 * @see elm_theme_overlay_add()
1381 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1383 * Appends a theme extension to the list of extensions.
1385 * @param th The theme to add to, or if NULL, the default theme
1386 * @param item The Edje file path to be used
1388 * This is intended when an application needs more styles of widgets or new
1389 * widget themes that the default does not provide (or may not provide). The
1390 * application has "extended" usage by coming up with new custom style names
1391 * for widgets for specific uses, but as these are not "standard", they are
1392 * not guaranteed to be provided by a default theme. This means the
1393 * application is required to provide these extra elements itself in specific
1394 * Edje files. This call adds one of those Edje files to the theme search
1395 * path to be search after the default theme. The use of this call is
1396 * encouraged when default styles do not meet the needs of the application.
1397 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1399 * @see elm_object_style_set()
1401 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1403 * Deletes a theme extension from the list of extensions.
1405 * @param th The theme to delete from, or if NULL, the default theme
1406 * @param item The name of the theme extension
1408 * @see elm_theme_extension_add()
1410 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1412 * Set the theme search order for the given theme
1414 * @param th The theme to set the search order, or if NULL, the default theme
1415 * @param theme Theme search string
1417 * This sets the search string for the theme in path-notation from first
1418 * theme to search, to last, delimited by the : character. Example:
1420 * "shiny:/path/to/file.edj:default"
1422 * See the ELM_THEME environment variable for more information.
1424 * @see elm_theme_get()
1425 * @see elm_theme_list_get()
1427 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1429 * Return the theme search order
1431 * @param th The theme to get the search order, or if NULL, the default theme
1432 * @return The internal search order path
1434 * This function returns a colon separated string of theme elements as
1435 * returned by elm_theme_list_get().
1437 * @see elm_theme_set()
1438 * @see elm_theme_list_get()
1440 EAPI const char *elm_theme_get(Elm_Theme *th);
1442 * Return a list of theme elements to be used in a theme.
1444 * @param th Theme to get the list of theme elements from.
1445 * @return The internal list of theme elements
1447 * This returns the internal list of theme elements (will only be valid as
1448 * long as the theme is not modified by elm_theme_set() or theme is not
1449 * freed by elm_theme_free(). This is a list of strings which must not be
1450 * altered as they are also internal. If @p th is NULL, then the default
1451 * theme element list is returned.
1453 * A theme element can consist of a full or relative path to a .edj file,
1454 * or a name, without extension, for a theme to be searched in the known
1455 * theme paths for Elemementary.
1457 * @see elm_theme_set()
1458 * @see elm_theme_get()
1460 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1462 * Return the full patrh for a theme element
1464 * @param f The theme element name
1465 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1466 * @return The full path to the file found.
1468 * This returns a string you should free with free() on success, NULL on
1469 * failure. This will search for the given theme element, and if it is a
1470 * full or relative path element or a simple searchable name. The returned
1471 * path is the full path to the file, if searched, and the file exists, or it
1472 * is simply the full path given in the element or a resolved path if
1473 * relative to home. The @p in_search_path boolean pointed to is set to
1474 * EINA_TRUE if the file was a searchable file andis in the search path,
1475 * and EINA_FALSE otherwise.
1477 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1479 * Flush the current theme.
1481 * @param th Theme to flush
1483 * This flushes caches that let elementary know where to find theme elements
1484 * in the given theme. If @p th is NULL, then the default theme is flushed.
1485 * Call this function if source theme data has changed in such a way as to
1486 * make any caches Elementary kept invalid.
1488 EAPI void elm_theme_flush(Elm_Theme *th);
1490 * This flushes all themes (default and specific ones).
1492 * This will flush all themes in the current application context, by calling
1493 * elm_theme_flush() on each of them.
1495 EAPI void elm_theme_full_flush(void);
1497 * Set the theme for all elementary using applications on the current display
1499 * @param theme The name of the theme to use. Format same as the ELM_THEME
1500 * environment variable.
1502 EAPI void elm_theme_all_set(const char *theme);
1504 * Return a list of theme elements in the theme search path
1506 * @return A list of strings that are the theme element names.
1508 * This lists all available theme files in the standard Elementary search path
1509 * for theme elements, and returns them in alphabetical order as theme
1510 * element names in a list of strings. Free this with
1511 * elm_theme_name_available_list_free() when you are done with the list.
1513 EAPI Eina_List *elm_theme_name_available_list_new(void);
1515 * Free the list returned by elm_theme_name_available_list_new()
1517 * This frees the list of themes returned by
1518 * elm_theme_name_available_list_new(). Once freed the list should no longer
1519 * be used. a new list mys be created.
1521 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1523 * Set a specific theme to be used for this object and its children
1525 * @param obj The object to set the theme on
1526 * @param th The theme to set
1528 * This sets a specific theme that will be used for the given object and any
1529 * child objects it has. If @p th is NULL then the theme to be used is
1530 * cleared and the object will inherit its theme from its parent (which
1531 * ultimately will use the default theme if no specific themes are set).
1533 * Use special themes with great care as this will annoy users and make
1534 * configuration difficult. Avoid any custom themes at all if it can be
1537 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1539 * Get the specific theme to be used
1541 * @param obj The object to get the specific theme from
1542 * @return The specifc theme set.
1544 * This will return a specific theme set, or NULL if no specific theme is
1545 * set on that object. It will not return inherited themes from parents, only
1546 * the specific theme set for that specific object. See elm_object_theme_set()
1547 * for more information.
1549 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1555 typedef enum _Elm_Win_Type
1558 ELM_WIN_DIALOG_BASIC,
1565 ELM_WIN_DROPDOWN_MENU,
1568 ELM_WIN_NOTIFICATION,
1571 ELM_WIN_INLINED_IMAGE,
1574 typedef enum _Elm_Win_Keyboard_Mode
1576 ELM_WIN_KEYBOARD_UNKNOWN,
1577 ELM_WIN_KEYBOARD_OFF,
1578 ELM_WIN_KEYBOARD_ON,
1579 ELM_WIN_KEYBOARD_ALPHA,
1580 ELM_WIN_KEYBOARD_NUMERIC,
1581 ELM_WIN_KEYBOARD_PIN,
1582 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1583 ELM_WIN_KEYBOARD_HEX,
1584 ELM_WIN_KEYBOARD_TERMINAL,
1585 ELM_WIN_KEYBOARD_PASSWORD,
1586 ELM_WIN_KEYBOARD_IP,
1587 ELM_WIN_KEYBOARD_HOST,
1588 ELM_WIN_KEYBOARD_FILE,
1589 ELM_WIN_KEYBOARD_URL,
1590 ELM_WIN_KEYBOARD_KEYPAD,
1591 ELM_WIN_KEYBOARD_J2ME
1592 } Elm_Win_Keyboard_Mode;
1594 typedef enum _Elm_Illume_Command
1596 ELM_ILLUME_COMMAND_FOCUS_BACK,
1597 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1598 ELM_ILLUME_COMMAND_FOCUS_HOME,
1599 ELM_ILLUME_COMMAND_CLOSE
1600 } Elm_Illume_Command;
1602 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1603 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1604 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1605 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1606 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1607 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1608 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1609 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1610 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1611 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1612 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1613 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1614 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1615 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1616 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1617 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1618 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1619 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1620 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1621 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1622 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1623 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1624 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1625 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1626 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1627 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1628 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1629 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1630 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1631 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1632 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1633 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1634 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1636 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1637 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1638 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1639 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1640 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1641 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1642 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1643 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1644 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1645 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1646 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1647 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1648 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1649 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1650 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1651 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1652 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1653 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
1655 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1656 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1657 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1658 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1659 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1660 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1661 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1663 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1664 * (blank mouse, private mouse obj, defaultmouse)
1667 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1668 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1669 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1670 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1672 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1674 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1675 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1676 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1677 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1678 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1679 /* available styles:
1684 /* X specific calls - won't work on non-x engines (return 0) */
1685 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1686 /* smart callbacks called:
1687 * "delete,request" - the user requested to delete the window
1688 * "focus,in" - window got focus
1689 * "focus,out" - window lost focus
1690 * "moved" - window that holds the canvas was moved
1696 * @brief Background object, used for setting a solid color, image or Edje
1697 * group as background to a window or any container object.
1699 * The bg object is used for setting a solid background to a window or
1700 * packing into any container object. It works just like an image, but has
1701 * some properties useful to a background, like setting it to tiled,
1702 * centered, scaled or stretched.
1704 * Here is some sample code using it:
1705 * @li @ref bg_01_example_page
1706 * @li @ref bg_02_example_page
1707 * @li @ref bg_03_example_page
1711 typedef enum _Elm_Bg_Option
1713 ELM_BG_OPTION_CENTER, /**< center the background */
1714 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1715 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1716 ELM_BG_OPTION_TILE /**< tile background at its original size */
1720 * Add a new background to the parent
1722 * @param parent The parent object
1723 * @return The new object or NULL if it cannot be created
1727 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1730 * Set the file (image or edje) used for the background
1732 * @param obj The bg object
1733 * @param file The file path
1734 * @param group Optional key (group in Edje) within the file
1736 * This sets the image file used in the background object. The image (or edje)
1737 * will be stretched (retaining aspect if its an image file) to completely fill
1738 * the bg object. This may mean some parts are not visible.
1740 * @note Once the image of @p obj is set, a previously set one will be deleted,
1741 * even if @p file is NULL.
1745 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1748 * Get the file (image or edje) used for the background
1750 * @param obj The bg object
1751 * @param file The file path
1752 * @param group Optional key (group in Edje) within the file
1756 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1759 * Set the option used for the background image
1761 * @param obj The bg object
1762 * @param option The desired background option (TILE, SCALE)
1764 * This sets the option used for manipulating the display of the background
1765 * image. The image can be tiled or scaled.
1769 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1772 * Get the option used for the background image
1774 * @param obj The bg object
1775 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1779 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1781 * Set the option used for the background color
1783 * @param obj The bg object
1788 * This sets the color used for the background rectangle. Its range goes
1793 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1795 * Get the option used for the background color
1797 * @param obj The bg object
1804 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1807 * Set the overlay object used for the background object.
1809 * @param obj The bg object
1810 * @param overlay The overlay object
1812 * This provides a way for elm_bg to have an 'overlay' that will be on top
1813 * of the bg. Once the over object is set, a previously set one will be
1814 * deleted, even if you set the new one to NULL. If you want to keep that
1815 * old content object, use the elm_bg_overlay_unset() function.
1820 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1823 * Get the overlay object used for the background object.
1825 * @param obj The bg object
1826 * @return The content that is being used
1828 * Return the content object which is set for this widget
1832 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1835 * Get the overlay object used for the background object.
1837 * @param obj The bg object
1838 * @return The content that was being used
1840 * Unparent and return the overlay object which was set for this widget
1844 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1847 * Set the size of the pixmap representation of the image.
1849 * This option just makes sense if an image is going to be set in the bg.
1851 * @param obj The bg object
1852 * @param w The new width of the image pixmap representation.
1853 * @param h The new height of the image pixmap representation.
1855 * This function sets a new size for pixmap representation of the given bg
1856 * image. It allows the image to be loaded already in the specified size,
1857 * reducing the memory usage and load time when loading a big image with load
1858 * size set to a smaller size.
1860 * NOTE: this is just a hint, the real size of the pixmap may differ
1861 * depending on the type of image being loaded, being bigger than requested.
1865 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1866 /* smart callbacks called:
1870 typedef enum _Elm_Icon_Lookup_Order
1872 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1873 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1874 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1875 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1876 } Elm_Icon_Lookup_Order;
1878 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1879 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1880 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1881 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1882 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1883 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1884 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1885 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1886 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1887 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1888 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1889 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1890 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1891 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1892 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1893 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1894 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
1895 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1896 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1897 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
1898 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1899 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
1900 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1902 /* smart callbacks called:
1903 * "clicked" - the user clicked the icon
1907 typedef enum _Elm_Image_Orient
1909 ELM_IMAGE_ORIENT_NONE,
1910 ELM_IMAGE_ROTATE_90_CW,
1911 ELM_IMAGE_ROTATE_180_CW,
1912 ELM_IMAGE_ROTATE_90_CCW,
1913 ELM_IMAGE_FLIP_HORIZONTAL,
1914 ELM_IMAGE_FLIP_VERTICAL,
1915 ELM_IMAGE_FLIP_TRANSPOSE,
1916 ELM_IMAGE_FLIP_TRANSVERSE
1918 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1919 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1920 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1921 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1922 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1923 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1924 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1925 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1926 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1927 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1928 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1929 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1930 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1931 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1932 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
1933 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1934 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
1935 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1936 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1937 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
1938 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1940 /* smart callbacks called:
1941 * "clicked" - the user clicked the image
1945 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
1947 typedef enum _Elm_GLView_Mode
1949 ELM_GLVIEW_ALPHA = 1,
1950 ELM_GLVIEW_DEPTH = 2,
1951 ELM_GLVIEW_STENCIL = 4
1955 * Defines a policy for the glview resizing.
1957 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
1959 typedef enum _Elm_GLView_Resize_Policy
1961 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
1962 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
1963 } Elm_GLView_Resize_Policy;
1965 typedef enum _Elm_GLView_Render_Policy
1967 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
1968 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
1969 } Elm_GLView_Render_Policy;
1972 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1973 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1974 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1975 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1976 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
1977 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
1978 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
1979 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1980 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1981 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1982 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1983 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1989 * A box arranges objects in a linear fashion, governed by a layout function
1990 * that defines the details of this arrangement.
1992 * By default, the box will use an internal function to set the layout to
1993 * a single row, either vertical or horizontal. This layout is affected
1994 * by a number of parameters, such as the homogeneous flag set by
1995 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
1996 * elm_box_align_set() and the hints set to each object in the box.
1998 * For this default layout, it's possible to change the orientation with
1999 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2000 * placing its elements ordered from top to bottom. When horizontal is set,
2001 * the order will go from left to right. If the box is set to be
2002 * homogeneous, every object in it will be assigned the same space, that
2003 * of the largest object. Padding can be used to set some spacing between
2004 * the cell given to each object. The alignment of the box, set with
2005 * elm_box_align_set(), determines how the bounding box of all the elements
2006 * will be placed within the space given to the box widget itself.
2008 * The size hints of each object also affect how they are placed and sized
2009 * within the box. evas_object_size_hint_min_set() will give the minimum
2010 * size the object can have, and the box will use it as the basis for all
2011 * latter calculations. Elementary widgets set their own minimum size as
2012 * needed, so there's rarely any need to use it manually.
2014 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2015 * used to tell whether the object will be allocated the minimum size it
2016 * needs or if the space given to it should be expanded. It's important
2017 * to realize that expanding the size given to the object is not the same
2018 * thing as resizing the object. It could very well end being a small
2019 * widget floating in a much larger empty space. If not set, the weight
2020 * for objects will normally be 0.0 for both axis, meaning the widget will
2021 * not be expanded. To take as much space possible, set the weight to
2022 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2024 * Besides how much space each object is allocated, it's possible to control
2025 * how the widget will be placed within that space using
2026 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2027 * for both axis, meaning the object will be centered, but any value from
2028 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2029 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2030 * is -1.0, means the object will be resized to fill the entire space it
2033 * In addition, customized functions to define the layout can be set, which
2034 * allow the application developer to organize the objects within the box
2035 * in any number of ways.
2037 * The special elm_box_layout_transition() function can be used
2038 * to switch from one layout to another, animating the motion of the
2039 * children of the box.
2041 * @note Objects should not be added to box objects using _add() calls.
2043 * Some examples on how to use boxes follow:
2044 * @li @ref box_example_01
2045 * @li @ref box_example_02
2050 * @typedef Elm_Box_Transition
2052 * Opaque handler containing the parameters to perform an animated
2053 * transition of the layout the box uses.
2055 * @see elm_box_transition_new()
2056 * @see elm_box_layout_set()
2057 * @see elm_box_layout_transition()
2059 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2062 * Add a new box to the parent
2064 * By default, the box will be in vertical mode and non-homogeneous.
2066 * @param parent The parent object
2067 * @return The new object or NULL if it cannot be created
2069 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2071 * Set the horizontal orientation
2073 * By default, box object arranges their contents vertically from top to
2075 * By calling this function with @p horizontal as EINA_TRUE, the box will
2076 * become horizontal, arranging contents from left to right.
2078 * @note This flag is ignored if a custom layout function is set.
2080 * @param obj The box object
2081 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2082 * EINA_FALSE = vertical)
2084 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2086 * Get the horizontal orientation
2088 * @param obj The box object
2089 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2091 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2093 * Set the box to arrange its children homogeneously
2095 * If enabled, homogeneous layout makes all items the same size, according
2096 * to the size of the largest of its children.
2098 * @note This flag is ignored if a custom layout function is set.
2100 * @param obj The box object
2101 * @param homogeneous The homogeneous flag
2103 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2105 * Get whether the box is using homogeneous mode or not
2107 * @param obj The box object
2108 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2110 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2111 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2112 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2114 * Add an object to the beginning of the pack list
2116 * Pack @p subobj into the box @p obj, placing it first in the list of
2117 * children objects. The actual position the object will get on screen
2118 * depends on the layout used. If no custom layout is set, it will be at
2119 * the top or left, depending if the box is vertical or horizontal,
2122 * @param obj The box object
2123 * @param subobj The object to add to the box
2125 * @see elm_box_pack_end()
2126 * @see elm_box_pack_before()
2127 * @see elm_box_pack_after()
2128 * @see elm_box_unpack()
2129 * @see elm_box_unpack_all()
2130 * @see elm_box_clear()
2132 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2134 * Add an object at the end of the pack list
2136 * Pack @p subobj into the box @p obj, placing it last in the list of
2137 * children objects. The actual position the object will get on screen
2138 * depends on the layout used. If no custom layout is set, it will be at
2139 * the bottom or right, depending if the box is vertical or horizontal,
2142 * @param obj The box object
2143 * @param subobj The object to add to the box
2145 * @see elm_box_pack_start()
2146 * @see elm_box_pack_before()
2147 * @see elm_box_pack_after()
2148 * @see elm_box_unpack()
2149 * @see elm_box_unpack_all()
2150 * @see elm_box_clear()
2152 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2154 * Adds an object to the box before the indicated object
2156 * This will add the @p subobj to the box indicated before the object
2157 * indicated with @p before. If @p before is not already in the box, results
2158 * are undefined. Before means either to the left of the indicated object or
2159 * above it depending on orientation.
2161 * @param obj The box object
2162 * @param subobj The object to add to the box
2163 * @param before The object before which to add it
2165 * @see elm_box_pack_start()
2166 * @see elm_box_pack_end()
2167 * @see elm_box_pack_after()
2168 * @see elm_box_unpack()
2169 * @see elm_box_unpack_all()
2170 * @see elm_box_clear()
2172 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2174 * Adds an object to the box after the indicated object
2176 * This will add the @p subobj to the box indicated after the object
2177 * indicated with @p after. If @p after is not already in the box, results
2178 * are undefined. After means either to the right of the indicated object or
2179 * below it depending on orientation.
2181 * @param obj The box object
2182 * @param subobj The object to add to the box
2183 * @param after The object after which to add it
2185 * @see elm_box_pack_start()
2186 * @see elm_box_pack_end()
2187 * @see elm_box_pack_before()
2188 * @see elm_box_unpack()
2189 * @see elm_box_unpack_all()
2190 * @see elm_box_clear()
2192 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2194 * Clear the box of all children
2196 * Remove all the elements contained by the box, deleting the respective
2199 * @param obj The box object
2201 * @see elm_box_unpack()
2202 * @see elm_box_unpack_all()
2204 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2208 * Remove the object given by @p subobj from the box @p obj without
2211 * @param obj The box object
2213 * @see elm_box_unpack_all()
2214 * @see elm_box_clear()
2216 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2218 * Remove all items from the box, without deleting them
2220 * Clear the box from all children, but don't delete the respective objects.
2221 * If no other references of the box children exist, the objects will never
2222 * be deleted, and thus the application will leak the memory. Make sure
2223 * when using this function that you hold a reference to all the objects
2224 * in the box @p obj.
2226 * @param obj The box object
2228 * @see elm_box_clear()
2229 * @see elm_box_unpack()
2231 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2233 * Retrieve a list of the objects packed into the box
2235 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2236 * The order of the list corresponds to the packing order the box uses.
2238 * You must free this list with eina_list_free() once you are done with it.
2240 * @param obj The box object
2242 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2244 * Set the space (padding) between the box's elements.
2246 * Extra space in pixels that will be added between a box child and its
2247 * neighbors after its containing cell has been calculated. This padding
2248 * is set for all elements in the box, besides any possible padding that
2249 * individual elements may have through their size hints.
2251 * @param obj The box object
2252 * @param horizontal The horizontal space between elements
2253 * @param vertical The vertical space between elements
2255 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2257 * Get the space (padding) between the box's elements.
2259 * @param obj The box object
2260 * @param horizontal The horizontal space between elements
2261 * @param vertical The vertical space between elements
2263 * @see elm_box_padding_set()
2265 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2267 * Set the alignment of the whole bouding box of contents.
2269 * Sets how the bounding box containing all the elements of the box, after
2270 * their sizes and position has been calculated, will be aligned within
2271 * the space given for the whole box widget.
2273 * @param obj The box object
2274 * @param horizontal The horizontal alignment of elements
2275 * @param vertical The vertical alignment of elements
2277 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2279 * Get the alignment of the whole bouding box of contents.
2281 * @param obj The box object
2282 * @param horizontal The horizontal alignment of elements
2283 * @param vertical The vertical alignment of elements
2285 * @see elm_box_align_set()
2287 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2290 * Set the layout defining function to be used by the box
2292 * Whenever anything changes that requires the box in @p obj to recalculate
2293 * the size and position of its elements, the function @p cb will be called
2294 * to determine what the layout of the children will be.
2296 * Once a custom function is set, everything about the children layout
2297 * is defined by it. The flags set by elm_box_horizontal_set() and
2298 * elm_box_homogeneous_set() no longer have any meaning, and the values
2299 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2300 * layout function to decide if they are used and how. These last two
2301 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2302 * passed to @p cb. The @c Evas_Object the function receives is not the
2303 * Elementary widget, but the internal Evas Box it uses, so none of the
2304 * functions described here can be used on it.
2306 * Any of the layout functions in @c Evas can be used here, as well as the
2307 * special elm_box_layout_transition().
2309 * The final @p data argument received by @p cb is the same @p data passed
2310 * here, and the @p free_data function will be called to free it
2311 * whenever the box is destroyed or another layout function is set.
2313 * Setting @p cb to NULL will revert back to the default layout function.
2315 * @param obj The box object
2316 * @param cb The callback function used for layout
2317 * @param data Data that will be passed to layout function
2318 * @param free_data Function called to free @p data
2320 * @see elm_box_layout_transition()
2322 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);
2324 * Special layout function that animates the transition from one layout to another
2326 * Normally, when switching the layout function for a box, this will be
2327 * reflected immediately on screen on the next render, but it's also
2328 * possible to do this through an animated transition.
2330 * This is done by creating an ::Elm_Box_Transition and setting the box
2331 * layout to this function.
2335 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2336 * evas_object_box_layout_vertical, // start
2337 * NULL, // data for initial layout
2338 * NULL, // free function for initial data
2339 * evas_object_box_layout_horizontal, // end
2340 * NULL, // data for final layout
2341 * NULL, // free function for final data
2342 * anim_end, // will be called when animation ends
2343 * NULL); // data for anim_end function\
2344 * elm_box_layout_set(box, elm_box_layout_transition, t,
2345 * elm_box_transition_free);
2348 * @note This function can only be used with elm_box_layout_set(). Calling
2349 * it directly will not have the expected results.
2351 * @see elm_box_transition_new
2352 * @see elm_box_transition_free
2353 * @see elm_box_layout_set
2355 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2357 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2359 * If you want to animate the change from one layout to another, you need
2360 * to set the layout function of the box to elm_box_layout_transition(),
2361 * passing as user data to it an instance of ::Elm_Box_Transition with the
2362 * necessary information to perform this animation. The free function to
2363 * set for the layout is elm_box_transition_free().
2365 * The parameters to create an ::Elm_Box_Transition sum up to how long
2366 * will it be, in seconds, a layout function to describe the initial point,
2367 * another for the final position of the children and one function to be
2368 * called when the whole animation ends. This last function is useful to
2369 * set the definitive layout for the box, usually the same as the end
2370 * layout for the animation, but could be used to start another transition.
2372 * @param start_layout The layout function that will be used to start the animation
2373 * @param start_layout_data The data to be passed the @p start_layout function
2374 * @param start_layout_free_data Function to free @p start_layout_data
2375 * @param end_layout The layout function that will be used to end the animation
2376 * @param end_layout_free_data The data to be passed the @p end_layout function
2377 * @param end_layout_free_data Function to free @p end_layout_data
2378 * @param transition_end_cb Callback function called when animation ends
2379 * @param transition_end_data Data to be passed to @p transition_end_cb
2380 * @return An instance of ::Elm_Box_Transition
2382 * @see elm_box_transition_new
2383 * @see elm_box_layout_transition
2385 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);
2387 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2389 * This function is mostly useful as the @c free_data parameter in
2390 * elm_box_layout_set() when elm_box_layout_transition().
2392 * @param data The Elm_Box_Transition instance to be freed.
2394 * @see elm_box_transition_new
2395 * @see elm_box_layout_transition
2397 EAPI void elm_box_transition_free(void *data);
2404 * @defgroup Button Button
2406 * @image html widget/button/preview-00.png
2407 * @image html widget/button/preview-01.png
2408 * @image html widget/button/preview-02.png
2410 * This is a push-button. Press it and run some function. It can contain
2411 * a simple label and icon object and it also has an autorepeat feature.
2413 * This widgets emits the following signals:
2414 * @li "clicked": the user clicked the button (press/release).
2415 * @li "repeated": the user pressed the button without releasing it.
2416 * @li "pressed": button was pressed.
2417 * @li "unpressed": button was released after being pressed.
2418 * In all three cases, the @c event parameter of the callback will be
2421 * Also, defined in the default theme, the button has the following styles
2423 * @li default: a normal button.
2424 * @li anchor: Like default, but the button fades away when the mouse is not
2425 * over it, leaving only the text or icon.
2426 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2427 * continuous look across its options.
2428 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2430 * Follow through a complete example @ref button_example_01 "here".
2436 UIControlStateDefault,
2437 UIControlStateHighlighted,
2438 UIControlStateDisabled,
2439 UIControlStateFocused,
2440 UIControlStateReserved
2444 * Add a new button to the parent's canvas
2446 * @param parent The parent object
2447 * @return The new object or NULL if it cannot be created
2449 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2451 * Set the label used in the button
2453 * The passed @p label can be NULL to clean any existing text in it and
2454 * leave the button as an icon only object.
2456 * @param obj The button object
2457 * @param label The text will be written on the button
2458 * @deprecated use elm_object_text_set() instead.
2460 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2462 * Get the label set for the button
2464 * The string returned is an internal pointer and should not be freed or
2465 * altered. It will also become invalid when the button is destroyed.
2466 * The string returned, if not NULL, is a stringshare, so if you need to
2467 * keep it around even after the button is destroyed, you can use
2468 * eina_stringshare_ref().
2470 * @param obj The button object
2471 * @return The text set to the label, or NULL if nothing is set
2472 * @deprecated use elm_object_text_set() instead.
2474 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2476 * Set the label for each state of button
2478 * The passed @p label can be NULL to clean any existing text in it and
2479 * leave the button as an icon only object for the state.
2481 * @param obj The button object
2482 * @param label The text will be written on the button
2483 * @param state The state of button
2487 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2489 * Get the label of button for each state
2491 * The string returned is an internal pointer and should not be freed or
2492 * altered. It will also become invalid when the button is destroyed.
2493 * The string returned, if not NULL, is a stringshare, so if you need to
2494 * keep it around even after the button is destroyed, you can use
2495 * eina_stringshare_ref().
2497 * @param obj The button object
2498 * @param state The state of button
2499 * @return The title of button for state
2503 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2505 * Set the icon used for the button
2507 * Setting a new icon will delete any other that was previously set, making
2508 * any reference to them invalid. If you need to maintain the previous
2509 * object alive, unset it first with elm_button_icon_unset().
2511 * @param obj The button object
2512 * @param icon The icon object for the button
2514 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2516 * Get the icon used for the button
2518 * Return the icon object which is set for this widget. If the button is
2519 * destroyed or another icon is set, the returned object will be deleted
2520 * and any reference to it will be invalid.
2522 * @param obj The button object
2523 * @return The icon object that is being used
2525 * @see elm_button_icon_unset()
2527 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2529 * Remove the icon set without deleting it and return the object
2531 * This function drops the reference the button holds of the icon object
2532 * and returns this last object. It is used in case you want to remove any
2533 * icon, or set another one, without deleting the actual object. The button
2534 * will be left without an icon set.
2536 * @param obj The button object
2537 * @return The icon object that was being used
2539 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2541 * Turn on/off the autorepeat event generated when the button is kept pressed
2543 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2544 * signal when they are clicked.
2546 * When on, keeping a button pressed will continuously emit a @c repeated
2547 * signal until the button is released. The time it takes until it starts
2548 * emitting the signal is given by
2549 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2550 * new emission by elm_button_autorepeat_gap_timeout_set().
2552 * @param obj The button object
2553 * @param on A bool to turn on/off the event
2555 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2557 * Get whether the autorepeat feature is enabled
2559 * @param obj The button object
2560 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2562 * @see elm_button_autorepeat_set()
2564 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2566 * Set the initial timeout before the autorepeat event is generated
2568 * Sets the timeout, in seconds, since the button is pressed until the
2569 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2570 * won't be any delay and the even will be fired the moment the button is
2573 * @param obj The button object
2574 * @param t Timeout in seconds
2576 * @see elm_button_autorepeat_set()
2577 * @see elm_button_autorepeat_gap_timeout_set()
2579 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2581 * Get the initial timeout before the autorepeat event is generated
2583 * @param obj The button object
2584 * @return Timeout in seconds
2586 * @see elm_button_autorepeat_initial_timeout_set()
2588 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2590 * Set the interval between each generated autorepeat event
2592 * After the first @c repeated event is fired, all subsequent ones will
2593 * follow after a delay of @p t seconds for each.
2595 * @param obj The button object
2596 * @param t Interval in seconds
2598 * @see elm_button_autorepeat_initial_timeout_set()
2600 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2602 * Get the interval between each generated autorepeat event
2604 * @param obj The button object
2605 * @return Interval in seconds
2607 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2613 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2614 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2615 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2616 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2617 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2618 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2619 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2620 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2621 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2622 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2623 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2624 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2625 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2626 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2627 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2628 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2629 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2630 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2631 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2632 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2633 /* available styles:
2637 * hoversel_vertical_entry
2639 /* smart callbacks called:
2640 * "file,chosen" - the user has selected a path, whose string pointer comes
2644 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2645 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2646 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2647 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2648 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2649 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2650 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2651 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2652 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2653 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2654 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2655 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2656 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2657 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2658 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2659 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2660 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2661 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2662 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2663 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2664 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2665 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2667 /* scroller policy */
2668 typedef enum _Elm_Scroller_Policy
2670 ELM_SCROLLER_POLICY_AUTO = 0,
2671 ELM_SCROLLER_POLICY_ON,
2672 ELM_SCROLLER_POLICY_OFF,
2673 ELM_SCROLLER_POLICY_LAST
2674 } Elm_Scroller_Policy;
2676 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2677 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2678 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2679 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2680 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2681 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2682 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);
2683 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2684 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2685 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);
2686 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2687 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2688 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2689 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2690 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2691 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);
2692 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2693 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2694 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
2695 /* smart callbacks called:
2696 * "edge,left" - the left edge of the content has been reached
2697 * "edge,right" - the right edge of the content has been reached
2698 * "edge,top" - the top edge of the content has been reached
2699 * "edge,bottom" - the bottom edge of the content has been reached
2700 * "scroll" - the content has been scrolled (moved)
2701 * "scroll,anim,start" - scrolling animation has started
2702 * "scroll,anim,stop" - scrolling animation has stopped
2703 * "scroll,drag,start" - dragging the contents around has started
2704 * "scroll,drag,stop" - dragging the contents around has stopped
2708 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2709 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
2710 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2711 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2712 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2713 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2714 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2715 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2716 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2717 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2718 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);
2719 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2720 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);
2721 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2722 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
2723 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2724 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2725 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2726 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2727 /* available styles:
2731 /* smart callbacks called:
2735 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2736 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2737 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2738 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2739 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2740 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2741 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2742 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2743 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2744 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2745 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2746 /* smart callbacks called:
2747 * "changed" - Whenever the toggle value has been changed. Is not called
2748 * until the toggle is released by the cursor (assuming it has been triggered
2749 * by the cursor in the first place).
2753 * @page tutorial_frame Frame example
2754 * @dontinclude frame_example_01.c
2756 * In this example we are going to create 4 Frames with different styles and
2757 * add a rectangle of different color in each.
2759 * We start we the usual setup code:
2762 * And then create one rectangle:
2765 * To add it in our first frame, which since it doesn't have it's style
2766 * specifically set uses the default style:
2769 * And then create another rectangle:
2772 * To add it in our second frame, which uses the "pad_small" style, note that
2773 * even tough we are setting a text for this frame it won't be show, only the
2774 * default style shows the Frame's title:
2776 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
2777 * very similar, their only difference is the size of the empty area around
2778 * the content of the frame.
2780 * And then create yet another rectangle:
2783 * To add it in our third frame, which uses the "outdent_top" style, note
2784 * that even tough we are setting a text for this frame it won't be show,
2785 * only the default style shows the Frame's title:
2788 * And then create one last rectangle:
2791 * To add it in our fourth and final frame, which uses the "outdent_bottom"
2792 * style, note that even tough we are setting a text for this frame it won't
2793 * be show, only the default style shows the Frame's title:
2796 * And now we are left with just some more setup code:
2799 * Our example will look like this:
2800 * @image html screenshots/frame_example_01.png
2801 * @image latex screenshots/frame_example_01.eps
2803 * @example frame_example_01.c
2806 * @defgroup Frame Frame
2808 * @brief Frame is a widget that holds some content and has a title.
2810 * The default look is a frame with a title, but Frame supports multple
2818 * @li outdent_bottom
2820 * Of all this styles only default shows the title. Frame emits no signals.
2822 * For a detailed example see the @ref tutorial_frame.
2827 * @brief Add a new frame to the parent
2829 * @param parent The parent object
2830 * @return The new object or NULL if it cannot be created
2832 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2834 * @brief Set the frame label
2836 * @param obj The frame object
2837 * @param label The label of this frame object
2839 * @deprecated use elm_object_text_set() instead.
2841 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2843 * @brief Get the frame label
2845 * @param obj The frame object
2847 * @return The label of this frame objet or NULL if unable to get frame
2849 * @deprecated use elm_object_text_get() instead.
2851 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2853 * @brief Set the content of the frame widget
2855 * Once the content object is set, a previously set one will be deleted.
2856 * If you want to keep that old content object, use the
2857 * elm_frame_content_unset() function.
2859 * @param obj The frame object
2860 * @param content The content will be filled in this frame object
2862 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2864 * @brief Get the content of the frame widget
2866 * Return the content object which is set for this widget
2868 * @param obj The frame object
2869 * @return The content that is being used
2871 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2873 * @brief Unset the content of the frame widget
2875 * Unparent and return the content object which was set for this widget
2877 * @param obj The frame object
2878 * @return The content that was being used
2880 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2886 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2887 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2888 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2889 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2890 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2891 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2892 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2893 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2894 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2895 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
2896 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2897 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
2900 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
2901 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
2902 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
2903 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2904 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
2905 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2906 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
2908 struct _Elm_Gengrid_Item_Class
2910 const char *item_style;
2911 struct _Elm_Gengrid_Item_Class_Func
2913 GridItemLabelGetFunc label_get;
2914 GridItemIconGetFunc icon_get;
2915 GridItemStateGetFunc state_get;
2916 GridItemDelFunc del;
2920 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2921 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2922 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2923 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
2924 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
2926 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2927 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2928 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2929 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2930 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2931 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2932 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2933 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2934 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2935 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2936 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2937 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
2938 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2939 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
2940 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2942 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2943 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2945 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2946 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2947 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2948 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2949 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2950 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2951 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
2952 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2953 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
2954 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
2955 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2956 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2957 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2958 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2959 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2960 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2961 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2963 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
2964 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);
2965 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2966 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2967 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2968 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2969 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2970 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2971 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2972 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2973 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2974 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2976 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2977 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2978 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2980 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);
2981 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);
2982 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);
2983 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);
2984 EAPI Elm_Gengrid_Item *elm_gengrid_item_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
2985 EAPI Elm_Gengrid_Item *elm_gengrid_item_direct_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
2986 /* smart callbacks called:
2988 * selected - User has selected an item.
2989 * unselected - User has unselected an item.
2990 * clicked,double - User has double-clicked or pressed enter on an item.
2991 * realized - An evas object for an item was built.
2992 * unrealized - An evas object for an item was deleted.
2993 * changed - An item has been added, removed, resized or moved,
2994 * or gengrid has been resized or horizontal property has been changed.
2995 * scroll - the content has been scrolled (moved).
2996 * "scroll,drag,start" - dragging the contents around has started.
2997 * "scroll,drag,stop" - dragging the contents around has stopped.
2998 * drag - Gengrid is being dragged.
2999 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3000 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3001 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3002 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3003 * "drag,stop" - Gengrid is not being dragged.
3007 * @defgroup Clock Clock
3009 * This is a @b digital clock widget. In its default theme, it has a
3010 * vintage "flipping numbers clock" appearance, which will animate
3011 * sheets of individual algarisms individually as time goes by.
3013 * A newly created clock will fetch system's time (already
3014 * considering local time adjustments) to start with, and will tick
3015 * accondingly. It may or may not show seconds.
3017 * Clocks have an @b edition mode. When in it, the sheets will
3018 * display extra arrow indications on the top and bottom and the
3019 * user may click on them to raise or lower the time values. After
3020 * it's told to exit edition mode, it will keep ticking with that
3021 * new time set (it keeps the difference from local time).
3023 * Also, when under edition mode, user clicks on the cited arrows
3024 * which are @b held for some time will make the clock to flip the
3025 * sheet, thus editing the time, continuosly and automatically for
3026 * the user. The interval between sheet flips will keep growing in
3027 * time, so that it helps the user to reach a time which is distant
3030 * The time display is, by default, in military mode (24h), but an
3031 * am/pm indicator may be optionally shown, too, when it will
3034 * Smart callbacks one can register to:
3035 * - "changed" - the clock's user changed the time
3037 * Here is an example on its usage:
3038 * @li @ref clock_example
3047 * Identifiers for which clock digits should be editable, when a
3048 * clock widget is in edition mode. Values may be ORed together to
3049 * make a mask, naturally.
3051 * @see elm_clock_edit_set()
3052 * @see elm_clock_digit_edit_set()
3054 typedef enum _Elm_Clock_Digedit
3056 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3057 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3058 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3059 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3060 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3061 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3062 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3063 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3064 } Elm_Clock_Digedit;
3067 * Add a new clock widget to the given parent Elementary
3068 * (container) object
3070 * @param parent The parent object
3071 * @return a new clock widget handle or @c NULL, on errors
3073 * This function inserts a new clock widget on the canvas.
3077 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3080 * Set a clock widget's time, programmatically
3082 * @param obj The clock widget object
3083 * @param hrs The hours to set
3084 * @param min The minutes to set
3085 * @param sec The secondes to set
3087 * This function updates the time that is showed by the clock
3090 * Values @b must be set within the following ranges:
3091 * - 0 - 23, for hours
3092 * - 0 - 59, for minutes
3093 * - 0 - 59, for seconds,
3095 * even if the clock is not in "military" mode.
3097 * @warning The behavior for values set out of those ranges is @b
3102 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3105 * Get a clock widget's time values
3107 * @param obj The clock object
3108 * @param[out] hrs Pointer to the variable to get the hours value
3109 * @param[out] min Pointer to the variable to get the minutes value
3110 * @param[out] sec Pointer to the variable to get the seconds value
3112 * This function gets the time set for @p obj, returning
3113 * it on the variables passed as the arguments to function
3115 * @note Use @c NULL pointers on the time values you're not
3116 * interested in: they'll be ignored by the function.
3120 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3123 * Set whether a given clock widget is under <b>edition mode</b> or
3124 * under (default) displaying-only mode.
3126 * @param obj The clock object
3127 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3128 * put it back to "displaying only" mode
3130 * This function makes a clock's time to be editable or not <b>by
3131 * user interaction</b>. When in edition mode, clocks @b stop
3132 * ticking, until one brings them back to canonical mode. The
3133 * elm_clock_digit_edit_set() function will influence which digits
3134 * of the clock will be editable. By default, all of them will be
3135 * (#ELM_CLOCK_NONE).
3137 * @note am/pm sheets, if being shown, will @b always be editable
3138 * under edition mode.
3140 * @see elm_clock_edit_get()
3144 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3147 * Retrieve whether a given clock widget is under <b>edition
3148 * mode</b> or under (default) displaying-only mode.
3150 * @param obj The clock object
3151 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3154 * This function retrieves whether the clock's time can be edited
3155 * or not by user interaction.
3157 * @see elm_clock_edit_set() for more details
3161 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3164 * Set what digits of the given clock widget should be editable
3165 * when in edition mode.
3167 * @param obj The clock object
3168 * @param digedit Bit mask indicating the digits to be editable
3169 * (values in #Elm_Clock_Digedit).
3171 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3172 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3175 * @see elm_clock_digit_edit_get()
3179 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3182 * Retrieve what digits of the given clock widget should be
3183 * editable when in edition mode.
3185 * @param obj The clock object
3186 * @return Bit mask indicating the digits to be editable
3187 * (values in #Elm_Clock_Digedit).
3189 * @see elm_clock_digit_edit_set() for more details
3193 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3196 * Set if the given clock widget must show hours in military or
3199 * @param obj The clock object
3200 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3203 * This function sets if the clock must show hours in military or
3204 * am/pm mode. In some countries like Brazil the military mode
3205 * (00-24h-format) is used, in opposition to the USA, where the
3206 * am/pm mode is more commonly used.
3208 * @see elm_clock_show_am_pm_get()
3212 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3215 * Get if the given clock widget shows hours in military or am/pm
3218 * @param obj The clock object
3219 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3222 * This function gets if the clock shows hours in military or am/pm
3225 * @see elm_clock_show_am_pm_set() for more details
3229 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3232 * Set if the given clock widget must show time with seconds or not
3234 * @param obj The clock object
3235 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3237 * This function sets if the given clock must show or not elapsed
3238 * seconds. By default, they are @b not shown.
3240 * @see elm_clock_show_seconds_get()
3244 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3247 * Get whether the given clock widget is showing time with seconds
3250 * @param obj The clock object
3251 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3253 * This function gets whether @p obj is showing or not the elapsed
3256 * @see elm_clock_show_seconds_set()
3260 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3263 * Set the interval on time updates for an user mouse button hold
3264 * on clock widgets' time edition.
3266 * @param obj The clock object
3267 * @param interval The (first) interval value in seconds
3269 * This interval value is @b decreased while the user holds the
3270 * mouse pointer either incrementing or decrementing a given the
3271 * clock digit's value.
3273 * This helps the user to get to a given time distant from the
3274 * current one easier/faster, as it will start to flip quicker and
3275 * quicker on mouse button holds.
3277 * The calculation for the next flip interval value, starting from
3278 * the one set with this call, is the previous interval divided by
3279 * 1.05, so it decreases a little bit.
3281 * The default starting interval value for automatic flips is
3284 * @see elm_clock_interval_get()
3288 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3291 * Get the interval on time updates for an user mouse button hold
3292 * on clock widgets' time edition.
3294 * @param obj The clock object
3295 * @return The (first) interval value, in seconds, set on it
3297 * @see elm_clock_interval_set() for more details
3301 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3308 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3309 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3310 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3311 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3312 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3313 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3314 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3315 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3316 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3317 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3318 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3319 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3320 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3321 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3322 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);
3323 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3324 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3325 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3326 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3327 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3328 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3329 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3330 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3331 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3332 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3333 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);
3334 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3336 * @def elm_layout_icon_set
3337 * Convienience macro to set the icon object in a layout that follows the
3338 * Elementary naming convention for its parts.
3342 #define elm_layout_icon_set(_ly, _obj) \
3345 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3346 if ((_obj)) sig = "elm,state,icon,visible"; \
3347 else sig = "elm,state,icon,hidden"; \
3348 elm_object_signal_emit((_ly), sig, "elm"); \
3352 * @def elm_layout_icon_get
3353 * Convienience macro to get the icon object from a layout that follows the
3354 * Elementary naming convention for its parts.
3358 #define elm_layout_icon_get(_ly) \
3359 elm_layout_content_get((_ly), "elm.swallow.icon")
3362 * @def elm_layout_end_set
3363 * Convienience macro to set the end object in a layout that follows the
3364 * Elementary naming convention for its parts.
3368 #define elm_layout_end_set(_ly, _obj) \
3371 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3372 if ((_obj)) sig = "elm,state,end,visible"; \
3373 else sig = "elm,state,end,hidden"; \
3374 elm_object_signal_emit((_ly), sig, "elm"); \
3378 * @def elm_layout_end_get
3379 * Convienience macro to get the end object in a layout that follows the
3380 * Elementary naming convention for its parts.
3384 #define elm_layout_end_get(_ly) \
3385 elm_layout_content_get((_ly), "elm.swallow.end")
3388 * @def elm_layout_label_set
3389 * Convienience macro to set the label in a layout that follows the
3390 * Elementary naming convention for its parts.
3393 * @deprecate use elm_object_text_* instead.
3395 #define elm_layout_label_set(_ly, _txt) \
3396 elm_layout_text_set((_ly), "elm.text", (_txt))
3399 * @def elm_layout_label_get
3400 * Convienience macro to get the label in a layout that follows the
3401 * Elementary naming convention for its parts.
3404 * @deprecate use elm_object_text_* instead.
3406 #define elm_layout_label_get(_ly) \
3407 elm_layout_text_get((_ly), "elm.text")
3409 /* smart callbacks called:
3413 typedef enum _Elm_Notify_Orient
3415 ELM_NOTIFY_ORIENT_TOP,
3416 ELM_NOTIFY_ORIENT_CENTER,
3417 ELM_NOTIFY_ORIENT_BOTTOM,
3418 ELM_NOTIFY_ORIENT_LEFT,
3419 ELM_NOTIFY_ORIENT_RIGHT,
3420 ELM_NOTIFY_ORIENT_TOP_LEFT,
3421 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3422 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3423 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3424 ELM_NOTIFY_ORIENT_LAST
3425 } Elm_Notify_Orient;
3426 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3427 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3428 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3429 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3430 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3431 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3432 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3433 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3434 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3435 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3436 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3437 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3438 /* smart callbacks called:
3439 * "timeout" - when timeout happens on notify and it's hidden
3440 * "block,clicked" - when it's hidden by a click outside of the notify's view
3444 typedef enum _Elm_Hover_Axis
3446 ELM_HOVER_AXIS_NONE,
3447 ELM_HOVER_AXIS_HORIZONTAL,
3448 ELM_HOVER_AXIS_VERTICAL,
3451 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3452 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3453 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3454 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3455 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3456 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3457 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3458 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3459 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3460 /* available styles:
3466 /* smart callbacks called:
3467 * "clicked" - the user clicked the empty space in the hover to dismiss
3468 * "smart,changed" - a content object placed under the "smart"
3469 * policy was replaced to a new slot direction.
3473 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3474 struct _Elm_Entry_Anchor_Info
3478 Evas_Coord x, y, w, h;
3480 typedef enum _Elm_Icon_Type
3487 typedef enum _Elm_Input_Panel_Layout
3489 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default 4x4 layout */
3490 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
3491 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
3492 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
3493 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
3494 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
3495 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
3496 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
3497 ELM_INPUT_PANEL_LAYOUT_CUSTOM_1 = 100, /* Reserved for future use */
3498 ELM_INPUT_PANEL_LAYOUT_CUSTOM_2,
3499 ELM_INPUT_PANEL_LAYOUT_CUSTOM_3,
3500 ELM_INPUT_PANEL_LAYOUT_CUSTOM_4,
3501 ELM_INPUT_PANEL_LAYOUT_CUSTOM_5,
3502 ELM_INPUT_PANEL_LAYOUT_CUSTOM_6,
3503 ELM_INPUT_PANEL_LAYOUT_CUSTOM_7,
3504 ELM_INPUT_PANEL_LAYOUT_CUSTOM_8,
3505 ELM_INPUT_PANEL_LAYOUT_CUSTOM_9,
3506 ELM_INPUT_PANEL_LAYOUT_CUSTOM_10
3507 } Elm_Input_Panel_Layout;
3509 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3511 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3512 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3513 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3514 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3515 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3516 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3517 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3518 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3519 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3520 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3521 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3522 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3523 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3524 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3525 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3526 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3527 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3528 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3529 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3530 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3531 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3532 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3533 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3534 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3535 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3536 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3537 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3538 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3539 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3540 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3541 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3542 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);
3543 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3544 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3545 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3546 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3547 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3548 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3549 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);
3550 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3551 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3552 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);
3553 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);
3554 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);
3555 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);
3556 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);
3557 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);
3558 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3559 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3560 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3561 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3562 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3563 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3564 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3565 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3566 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3567 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3568 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
3569 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3570 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3571 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3572 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3573 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3574 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3575 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3576 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3577 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3578 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3579 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3581 /* pre-made filters for entries */
3582 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3583 struct _Elm_Entry_Filter_Limit_Size
3588 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3589 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3590 struct _Elm_Entry_Filter_Accept_Set
3592 const char *accepted;
3593 const char *rejected;
3595 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3596 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3597 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3598 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3599 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3600 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
3601 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
3602 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3603 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3604 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3606 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3607 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
3608 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3609 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3610 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3612 /* smart callbacks called:
3613 * "changed" - the text content changed
3614 * "selection,start" - the user started selecting text
3615 * "selection,changed" - the user modified the selection size/location
3616 * "selection,cleared" - the user cleared the selection
3617 * "selection,paste" - the user requested a paste of text
3618 * "selection,copy" - the user copied the text
3619 * "selection,cut" - the user cut the text
3620 * "cursor,changed" - the cursor changed position
3621 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3622 * "activated" - when the enter key is pressed (useful for single line)
3623 * "press" - when finger/mouse is pressed down
3624 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3625 * "clicked,double" - when finger/mouse is double-pressed
3626 * "longpressed" - the entry has been longpressed
3627 * "focused" - the entry has received keyboard focus
3628 * "unfocused" - keyboard focus is gone
3631 /* composite widgets - these basically put together basic widgets above
3632 * in convenient packages that do more than basic stuff */
3636 * @defgroup Anchorview Anchorview
3638 * Anchorview is for displaying text that contains markup with anchors
3639 * like <c>\<a href=1234\>something\</\></c> in it.
3641 * Besides being styled differently, the anchorview widget provides the
3642 * necessary functionality so that clicking on these anchors brings up a
3643 * popup with user defined content such as "call", "add to contacts" or
3644 * "open web page". This popup is provided using the @ref Hover widget.
3646 * This widget is very similar to @ref Anchorblock, so refer to that
3647 * widget for an example. The only difference Anchorview has is that the
3648 * widget is already provided with scrolling functionality, so if the
3649 * text set to it is too large to fit in the given space, it will scroll,
3650 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3651 * text can be displayed.
3653 * This widget emits the following signals:
3654 * @li "anchor,clicked": will be called when an anchor is clicked. The
3655 * @p event_info parameter on the callback will be a pointer of type
3656 * ::Elm_Entry_Anchorview_Info.
3658 * See @ref Anchorblock for an example on how to use both of them.
3667 * @typedef Elm_Entry_Anchorview_Info
3669 * The info sent in the callback for "anchor,clicked" signals emitted by
3670 * the Anchorview widget.
3672 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3674 * @struct _Elm_Entry_Anchorview_Info
3676 * The info sent in the callback for "anchor,clicked" signals emitted by
3677 * the Anchorview widget.
3679 struct _Elm_Entry_Anchorview_Info
3681 const char *name; /**< Name of the anchor, as indicated in its href
3683 int button; /**< The mouse button used to click on it */
3684 Evas_Object *hover; /**< The hover object to use for the popup */
3686 Evas_Coord x, y, w, h;
3687 } anchor, /**< Geometry selection of text used as anchor */
3688 hover_parent; /**< Geometry of the object used as parent by the
3690 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3691 for content on the left side of
3692 the hover. Before calling the
3693 callback, the widget will make the
3694 necessary calculations to check
3695 which sides are fit to be set with
3696 content, based on the position the
3697 hover is activated and its distance
3698 to the edges of its parent object
3700 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3701 the right side of the hover.
3702 See @ref hover_left */
3703 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3704 of the hover. See @ref hover_left */
3705 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3706 below the hover. See @ref
3710 * Add a new Anchorview object
3712 * @param parent The parent object
3713 * @return The new object or NULL if it cannot be created
3715 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3717 * Set the text to show in the anchorview
3719 * Sets the text of the anchorview to @p text. This text can include markup
3720 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3721 * text that will be specially styled and react to click events, ended with
3722 * either of \</a\> or \</\>. When clicked, the anchor will emit an
3723 * "anchor,clicked" signal that you can attach a callback to with
3724 * evas_object_smart_callback_add(). The name of the anchor given in the
3725 * event info struct will be the one set in the href attribute, in this
3728 * Other markup can be used to style the text in different ways, but it's
3729 * up to the style defined in the theme which tags do what.
3730 * @deprecated use elm_object_text_set() instead.
3732 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3734 * Get the markup text set for the anchorview
3736 * Retrieves the text set on the anchorview, with markup tags included.
3738 * @param obj The anchorview object
3739 * @return The markup text set or @c NULL if nothing was set or an error
3741 * @deprecated use elm_object_text_set() instead.
3743 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3745 * Set the parent of the hover popup
3747 * Sets the parent object to use by the hover created by the anchorview
3748 * when an anchor is clicked. See @ref Hover for more details on this.
3749 * If no parent is set, the same anchorview object will be used.
3751 * @param obj The anchorview object
3752 * @param parent The object to use as parent for the hover
3754 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3756 * Get the parent of the hover popup
3758 * Get the object used as parent for the hover created by the anchorview
3759 * widget. See @ref Hover for more details on this.
3761 * @param obj The anchorview object
3762 * @return The object used as parent for the hover, NULL if none is set.
3764 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3766 * Set the style that the hover should use
3768 * When creating the popup hover, anchorview will request that it's
3769 * themed according to @p style.
3771 * @param obj The anchorview object
3772 * @param style The style to use for the underlying hover
3774 * @see elm_object_style_set()
3776 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3778 * Get the style that the hover should use
3780 * Get the style the hover created by anchorview will use.
3782 * @param obj The anchorview object
3783 * @return The style to use by the hover. NULL means the default is used.
3785 * @see elm_object_style_set()
3787 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3789 * Ends the hover popup in the anchorview
3791 * When an anchor is clicked, the anchorview widget will create a hover
3792 * object to use as a popup with user provided content. This function
3793 * terminates this popup, returning the anchorview to its normal state.
3795 * @param obj The anchorview object
3797 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3799 * Set bouncing behaviour when the scrolled content reaches an edge
3801 * Tell the internal scroller object whether it should bounce or not
3802 * when it reaches the respective edges for each axis.
3804 * @param obj The anchorview object
3805 * @param h_bounce Whether to bounce or not in the horizontal axis
3806 * @param v_bounce Whether to bounce or not in the vertical axis
3808 * @see elm_scroller_bounce_set()
3810 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3812 * Get the set bouncing behaviour of the internal scroller
3814 * Get whether the internal scroller should bounce when the edge of each
3815 * axis is reached scrolling.
3817 * @param obj The anchorview object
3818 * @param h_bounce Pointer where to store the bounce state of the horizontal
3820 * @param v_bounce Pointer where to store the bounce state of the vertical
3823 * @see elm_scroller_bounce_get()
3825 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3827 * Appends a custom item provider to the given anchorview
3829 * Appends the given function to the list of items providers. This list is
3830 * called, one function at a time, with the given @p data pointer, the
3831 * anchorview object and, in the @p item parameter, the item name as
3832 * referenced in its href string. Following functions in the list will be
3833 * called in order until one of them returns something different to NULL,
3834 * which should be an Evas_Object which will be used in place of the item
3837 * Items in the markup text take the form \<item relsize=16x16 vsize=full
3838 * href=item/name\>\</item\>
3840 * @param obj The anchorview object
3841 * @param func The function to add to the list of providers
3842 * @param data User data that will be passed to the callback function
3844 * @see elm_entry_item_provider_append()
3846 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);
3848 * Prepend a custom item provider to the given anchorview
3850 * Like elm_anchorview_item_provider_append(), but it adds the function
3851 * @p func to the beginning of the list, instead of the end.
3853 * @param obj The anchorview object
3854 * @param func The function to add to the list of providers
3855 * @param data User data that will be passed to the callback function
3857 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);
3859 * Remove a custom item provider from the list of the given anchorview
3861 * Removes the function and data pairing that matches @p func and @p data.
3862 * That is, unless the same function and same user data are given, the
3863 * function will not be removed from the list. This allows us to add the
3864 * same callback several times, with different @p data pointers and be
3865 * able to remove them later without conflicts.
3867 * @param obj The anchorview object
3868 * @param func The function to remove from the list
3869 * @param data The data matching the function to remove from the list
3871 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);
3878 * @defgroup Anchorblock Anchorblock
3880 * Anchorblock is for displaying text that contains markup with anchors
3881 * like <c>\<a href=1234\>something\</\></c> in it.
3883 * Besides being styled differently, the anchorblock widget provides the
3884 * necessary functionality so that clicking on these anchors brings up a
3885 * popup with user defined content such as "call", "add to contacts" or
3886 * "open web page". This popup is provided using the @ref Hover widget.
3888 * This widget emits the following signals:
3889 * @li "anchor,clicked": will be called when an anchor is clicked. The
3890 * @p event_info parameter on the callback will be a pointer of type
3891 * ::Elm_Entry_Anchorblock_Info.
3897 * Since examples are usually better than plain words, we might as well
3898 * try @ref tutorial_anchorblock_example "one".
3901 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
3902 * This exampel will show both Anchorblock and @ref Anchorview,
3903 * since both are very similar and it's easier to show them once and side
3904 * by side, so the difference is more clear.
3906 * We'll show the relevant snippets of the code here, but the full example
3907 * can be found here... sorry, @ref anchorblock_example_01.c "here".
3909 * As for the actual example, it's just a simple window with an anchorblock
3910 * and an anchorview, both containing the same text. After including
3911 * Elementary.h and declaring some functions we'll need, we jump to our
3912 * elm_main (see ELM_MAIN) and create our window.
3913 * @dontinclude anchorblock_example_01.c
3918 * With the needed variables declared, we'll create the window and a box to
3919 * hold our widgets, but we don't need to go through that here.
3921 * In order to make clear where the anchorblock ends and the anchorview
3922 * begins, they'll be each inside a @ref Frame. After creating the frame,
3923 * the anchorblock follows.
3924 * @skip elm_frame_add
3925 * @until elm_frame_content_set
3927 * Nothing out of the ordinary there. What's worth mentioning is the call
3928 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
3929 * when an anchor is clicked, the hover for the popup will cover the entire
3930 * window. This affects the area that will be obscured by the hover and
3931 * where clicking will dismiss it, as well as the calculations it does to
3932 * inform the best locations where to insert the popups content.
3933 * Other than that, the code is pretty standard. We also need to set our
3934 * callback for when an anchor is clicked, since it's our task to populate
3935 * the popup. There's no default for it.
3937 * The anchorview is no different, we only change a few things so it looks
3939 * @until elm_frame_content_set
3941 * Then we run, so stuff works and close our main function in the usual way.
3944 * Now, a little note. Normally you would use either one of anchorblock or
3945 * anchorview, set your one callback to clicks and do your stuff in there.
3946 * In this example, however, there are a few tricks to make it easier to
3947 * show both widgets in one go (and to save me some typing). So we have
3948 * two callbacks, one per widget, that will call a common function to do
3949 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
3950 * anchorview too, since both are equal, and passing a callback to use
3951 * for our buttons to end the hover, because each widget has a different
3953 * @until _anchorview_clicked_cb
3956 * The meat of our popup is in the following function. We check what kind
3957 * of menu we need to show, based on the name set to the anchor in the
3958 * markup text. If there's no type (something went wrong, no valid contact
3959 * in the address list) we are just putting a button that does nothing, but
3960 * it's perfectly reasonable to just end the hover and call it quits.
3962 * Our popup will consist of one main button in the middle of our hover,
3963 * and possibly a secondary button and a list of other options. We'll create
3964 * first our main button and check what kind of popup we need afterwards.
3967 * @until eina_stringshare_add
3970 * Each button has two callbacks, one is our hack to close the hover
3971 * properly based on which widget it belongs to, the other a simple
3972 * printf that will show the action with the anchors own data. This is
3973 * not how you would usually do it. Instead, the common case is to have
3974 * one callback for the button that will know which function to call to end
3975 * things, but since we are doing it this way it's worth noting that
3976 * smart callbacks will be called in reverse in respect to the order they
3977 * were added, and since our @c btn_end_cb will close the hover, and thus
3978 * delete our buttons, the other callback wouldn't be called if we had
3981 * After our telephone popup, there are a few others that are practically
3982 * the same, so they won't be shown here.
3984 * Once we are done with that, it's time to place our actions into our
3985 * hover. Main button goes in the middle without much questioning, and then
3986 * we see if we have a secondary button and a box of extra options.
3987 * Because I said so, secondary button goes on either side and box of
3988 * options either on top or below the main one, but to choose which
3989 * exactly, we use the hints our callback info has, which saves us from
3990 * having to do the math and see which side has more space available, with
3991 * a little special case where we delete our extra stuff if there's nowhere
3995 * @skip evas_object_smart
3996 * @until evas_object_del(box)
4000 * The example will look like this:
4001 * @image html screenshots/anchorblock_01.png
4002 * @image latex screenshots/anchorblock_01.eps
4004 * @example anchorblock_example_01.c
4007 * @addtogroup Anchorblock
4011 * @typedef Elm_Entry_Anchorblock_Info
4013 * The info sent in the callback for "anchor,clicked" signals emitted by
4014 * the Anchorblock widget.
4016 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4018 * @struct _Elm_Entry_Anchorblock_Info
4020 * The info sent in the callback for "anchor,clicked" signals emitted by
4021 * the Anchorblock widget.
4023 struct _Elm_Entry_Anchorblock_Info
4025 const char *name; /**< Name of the anchor, as indicated in its href
4027 int button; /**< The mouse button used to click on it */
4028 Evas_Object *hover; /**< The hover object to use for the popup */
4030 Evas_Coord x, y, w, h;
4031 } anchor, /**< Geometry selection of text used as anchor */
4032 hover_parent; /**< Geometry of the object used as parent by the
4034 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4035 for content on the left side of
4036 the hover. Before calling the
4037 callback, the widget will make the
4038 necessary calculations to check
4039 which sides are fit to be set with
4040 content, based on the position the
4041 hover is activated and its distance
4042 to the edges of its parent object
4044 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4045 the right side of the hover.
4046 See @ref hover_left */
4047 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4048 of the hover. See @ref hover_left */
4049 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4050 below the hover. See @ref
4054 * Add a new Anchorblock object
4056 * @param parent The parent object
4057 * @return The new object or NULL if it cannot be created
4059 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4061 * Set the text to show in the anchorblock
4063 * Sets the text of the anchorblock to @p text. This text can include markup
4064 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4065 * of text that will be specially styled and react to click events, ended
4066 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4067 * "anchor,clicked" signal that you can attach a callback to with
4068 * evas_object_smart_callback_add(). The name of the anchor given in the
4069 * event info struct will be the one set in the href attribute, in this
4072 * Other markup can be used to style the text in different ways, but it's
4073 * up to the style defined in the theme which tags do what.
4074 * @deprecated use elm_object_text_set() instead.
4076 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4078 * Get the markup text set for the anchorblock
4080 * Retrieves the text set on the anchorblock, with markup tags included.
4082 * @param obj The anchorblock object
4083 * @return The markup text set or @c NULL if nothing was set or an error
4085 * @deprecated use elm_object_text_set() instead.
4087 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089 * Set the parent of the hover popup
4091 * Sets the parent object to use by the hover created by the anchorblock
4092 * when an anchor is clicked. See @ref Hover for more details on this.
4094 * @param obj The anchorblock object
4095 * @param parent The object to use as parent for the hover
4097 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4099 * Get the parent of the hover popup
4101 * Get the object used as parent for the hover created by the anchorblock
4102 * widget. See @ref Hover for more details on this.
4103 * If no parent is set, the same anchorblock object will be used.
4105 * @param obj The anchorblock object
4106 * @return The object used as parent for the hover, NULL if none is set.
4108 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 * Set the style that the hover should use
4112 * When creating the popup hover, anchorblock will request that it's
4113 * themed according to @p style.
4115 * @param obj The anchorblock object
4116 * @param style The style to use for the underlying hover
4118 * @see elm_object_style_set()
4120 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4122 * Get the style that the hover should use
4124 * Get the style the hover created by anchorblock will use.
4126 * @param obj The anchorblock object
4127 * @return The style to use by the hover. NULL means the default is used.
4129 * @see elm_object_style_set()
4131 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4133 * Ends the hover popup in the anchorblock
4135 * When an anchor is clicked, the anchorblock widget will create a hover
4136 * object to use as a popup with user provided content. This function
4137 * terminates this popup, returning the anchorblock to its normal state.
4139 * @param obj The anchorblock object
4141 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 * Appends a custom item provider to the given anchorblock
4145 * Appends the given function to the list of items providers. This list is
4146 * called, one function at a time, with the given @p data pointer, the
4147 * anchorblock object and, in the @p item parameter, the item name as
4148 * referenced in its href string. Following functions in the list will be
4149 * called in order until one of them returns something different to NULL,
4150 * which should be an Evas_Object which will be used in place of the item
4153 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4154 * href=item/name\>\</item\>
4156 * @param obj The anchorblock object
4157 * @param func The function to add to the list of providers
4158 * @param data User data that will be passed to the callback function
4160 * @see elm_entry_item_provider_append()
4162 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);
4164 * Prepend a custom item provider to the given anchorblock
4166 * Like elm_anchorblock_item_provider_append(), but it adds the function
4167 * @p func to the beginning of the list, instead of the end.
4169 * @param obj The anchorblock object
4170 * @param func The function to add to the list of providers
4171 * @param data User data that will be passed to the callback function
4173 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);
4175 * Remove a custom item provider from the list of the given anchorblock
4177 * Removes the function and data pairing that matches @p func and @p data.
4178 * That is, unless the same function and same user data are given, the
4179 * function will not be removed from the list. This allows us to add the
4180 * same callback several times, with different @p data pointers and be
4181 * able to remove them later without conflicts.
4183 * @param obj The anchorblock object
4184 * @param func The function to remove from the list
4185 * @param data The data matching the function to remove from the list
4187 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);
4193 * @defgroup Bubble Bubble
4195 * @brief The Bubble is a widget to show text similarly to how speech is
4196 * represented in comics.
4198 * The bubble widget contains 5 important visual elements:
4199 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4200 * @li The @p icon is an image to which the frame's arrow points to.
4201 * @li The @p label is a text which appears to the right of the icon if the
4202 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4204 * @li The @p info is a text which appears to the right of the label. Info's
4205 * font is of a ligther color than label.
4206 * @li The @p content is an evas object that is shown inside the frame.
4208 * The position of the arrow, icon, label and info depends on which corner is
4209 * selected. The four available corners are:
4210 * @li "top_left" - Default
4213 * @li "bottom_right"
4215 * Signals that you can add callbacks for are:
4216 * @li "clicked" - This is called when a user has clicked the bubble.
4218 * For an example of using a buble see @ref bubble_01_example_page "this".
4223 * Add a new bubble to the parent
4225 * @param parent The parent object
4226 * @return The new object or NULL if it cannot be created
4228 * This function adds a text bubble to the given parent evas object.
4230 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4232 * Set the label of the bubble
4234 * @param obj The bubble object
4235 * @param label The string to set in the label
4237 * This function sets the title of the bubble. Where this appears depends on
4238 * the selected corner.
4239 * @deprecated use elm_object_text_set() instead.
4241 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4243 * Get the label of the bubble
4245 * @param obj The bubble object
4246 * @return The string of set in the label
4248 * This function gets the title of the bubble.
4249 * @deprecated use elm_object_text_set() instead.
4251 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4253 * Set the info of the bubble
4255 * @param obj The bubble object
4256 * @param info The given info about the bubble
4258 * This function sets the info of the bubble. Where this appears depends on
4259 * the selected corner.
4260 * @deprecated use elm_object_text_set() instead.
4262 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4264 * Get the info of the bubble
4266 * @param obj The bubble object
4268 * @return The "info" string of the bubble
4270 * This function gets the info text.
4271 * @deprecated use elm_object_text_set() instead.
4273 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * Set the content to be shown in the bubble
4277 * Once the content object is set, a previously set one will be deleted.
4278 * If you want to keep the old content object, use the
4279 * elm_bubble_content_unset() function.
4281 * @param obj The bubble object
4282 * @param content The given content of the bubble
4284 * This function sets the content shown on the middle of the bubble.
4286 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4288 * Get the content shown in the bubble
4290 * Return the content object which is set for this widget.
4292 * @param obj The bubble object
4293 * @return The content that is being used
4295 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4297 * Unset the content shown in the bubble
4299 * Unparent and return the content object which was set for this widget.
4301 * @param obj The bubble object
4302 * @return The content that was being used
4304 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4306 * Set the icon of the bubble
4308 * Once the icon object is set, a previously set one will be deleted.
4309 * If you want to keep the old content object, use the
4310 * elm_icon_content_unset() function.
4312 * @param obj The bubble object
4313 * @param icon The given icon for the bubble
4315 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4317 * Get the icon of the bubble
4319 * @param obj The bubble object
4320 * @return The icon for the bubble
4322 * This function gets the icon shown on the top left of bubble.
4324 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326 * Unset the icon of the bubble
4328 * Unparent and return the icon object which was set for this widget.
4330 * @param obj The bubble object
4331 * @return The icon that was being used
4333 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4335 * Set the corner of the bubble
4337 * @param obj The bubble object.
4338 * @param corner The given corner for the bubble.
4340 * This function sets the corner of the bubble. The corner will be used to
4341 * determine where the arrow in the frame points to and where label, icon and
4344 * Possible values for corner are:
4345 * @li "top_left" - Default
4348 * @li "bottom_right"
4350 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4352 * Get the corner of the bubble
4354 * @param obj The bubble object.
4355 * @return The given corner for the bubble.
4357 * This function gets the selected corner of the bubble.
4359 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4361 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4362 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4369 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4370 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4371 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4372 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4373 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4374 /* smart callbacks called:
4375 * "clicked" - the user clicked the icon
4376 * "drag,start" - Someone started dragging the image out of the object
4377 * "drag,end" - Dragged item was dropped (somewhere)
4381 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4383 * @enum _Elm_Gesture_Types
4384 * Emum of supported gesture types.
4385 * @ingroup Elm_Gesture_Layer
4387 enum _Elm_Gesture_Types
4389 ELM_GESTURE_FIRST = 0,
4391 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4392 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4393 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4395 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4397 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4398 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4400 ELM_GESTURE_ZOOM, /**< Zoom */
4401 ELM_GESTURE_ROTATE, /**< Rotate */
4407 * @typedef Elm_Gesture_Types
4408 * Type for Emum of supported gesture types.
4409 * @ingroup Elm_Gesture_Layer
4411 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4414 * @enum _Elm_Gesture_State
4415 * Emum of gesture states.
4416 * @ingroup Elm_Gesture_Layer
4418 enum _Elm_Gesture_State
4420 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4421 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4422 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4423 ELM_GESTURE_STATE_END, /**< Gesture completed */
4424 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4427 * @typedef Elm_Gesture_State
4429 * @ingroup Elm_Gesture_Layer
4431 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4434 * @struct _Elm_Gesture_Taps_Info
4435 * Struct holds taps info for user
4436 * @ingroup Elm_Gesture_Layer
4438 struct _Elm_Gesture_Taps_Info
4440 Evas_Coord x, y; /**< Holds center point between fingers */
4441 unsigned int n; /**< Number of fingers tapped */
4442 unsigned int timestamp; /**< event timestamp */
4446 * @typedef Elm_Gesture_Taps_Info
4447 * holds taps info for user
4448 * @ingroup Elm_Gesture_Layer
4450 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4453 * @struct _Elm_Gesture_Momentum_Info
4454 * Struct holds momentum info for user
4455 * x1 and y1 are not necessarily in sync
4456 * x1 holds x value of x direction starting point
4457 * and same holds for y1.
4458 * This is noticeable when doing V-shape movement
4459 * @ingroup Elm_Gesture_Layer
4461 struct _Elm_Gesture_Momentum_Info
4462 { /* Report line ends, timestamps, and momentum computed */
4463 Evas_Coord x1; /**< Final-swipe direction starting point on X */
4464 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4465 Evas_Coord x2; /**< Final-swipe direction ending point on X */
4466 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
4468 unsigned int tx; /**< Timestamp of start of final x-swipe */
4469 unsigned int ty; /**< Timestamp of start of final y-swipe */
4471 Evas_Coord mx; /**< Momentum on X */
4472 Evas_Coord my; /**< Momentum on Y */
4476 * @typedef Elm_Gesture_Momentum_Info
4477 * holds momentum info for user
4478 * @ingroup Elm_Gesture_Layer
4480 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4483 * @struct _Elm_Gesture_Line_Info
4484 * Struct holds line info for user
4485 * @ingroup Elm_Gesture_Layer
4487 struct _Elm_Gesture_Line_Info
4488 { /* Report line ends, timestamps, and momentum computed */
4489 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4490 unsigned int n; /**< Number of fingers (lines) */
4491 /* FIXME should be radians, bot degrees */
4492 double angle; /**< Angle (direction) of lines */
4496 * @typedef _Elm_Gesture_Line_Info
4497 * Holds line info for user
4498 * @ingroup Elm_Gesture_Layer
4500 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4503 * @struct _Elm_Gesture_Zoom_Info
4504 * Struct holds zoom info for user
4505 * @ingroup Elm_Gesture_Layer
4507 struct _Elm_Gesture_Zoom_Info
4509 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4510 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4511 float zoom; /**< Zoom value: 1.0 means no zoom */
4512 float momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4516 * @typedef Elm_Gesture_Zoom_Info
4517 * Holds zoom info for user
4518 * @ingroup Elm_Gesture_Layer
4520 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4523 * @struct _Elm_Gesture_Rotate_Info
4524 * Struct holds rotation info for user
4525 * @ingroup Elm_Gesture_Layer
4527 struct _Elm_Gesture_Rotate_Info
4529 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4530 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4531 double base_angle; /**< Holds start-angle */
4532 double angle; /**< Rotation value: 0.0 means no rotation */
4533 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4537 * @typedef Elm_Gesture_Rotate_Info
4538 * Holds rotation info for user
4539 * @ingroup Elm_Gesture_Layer
4541 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4544 * @typedef Elm_Gesture_Event_Cb
4545 * User callback used to stream gesture info from gesture layer
4546 * @param data user data
4547 * @param event_info gesture report info
4548 * Returns a flag field to be applied on the causing event.
4549 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4550 * upon the event, in an irreversible way.
4552 * @ingroup Elm_Gesture_Layer
4554 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4557 * Use function to set callbacks to be notified about
4558 * change of state of gesture.
4559 * When a user registers a callback with this function
4560 * this means this gesture has to be tested.
4562 * When ALL callbacks for a gesture are set to NULL
4563 * it means user isn't interested in gesture-state
4564 * and it will not be tested.
4566 * @param obj Pointer to gesture-layer.
4567 * @param idx The gesture you would like to track its state.
4568 * @param cb callback function pointer.
4569 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4570 * @param data user info to be sent to callback (usually, Smart Data)
4572 * @ingroup Elm_Gesture_Layer
4574 EAPI void elm_gesture_layer_cb_set(Evas_Object *obj, Elm_Gesture_Types idx, Elm_Gesture_State cb_type, Elm_Gesture_Event_Cb cb, void *data) EINA_ARG_NONNULL(1);
4577 * Call this function to get repeat-events settings.
4579 * @param obj Pointer to gesture-layer.
4581 * @return repeat events settings.
4582 * @see elm_gesture_layer_hold_events_set()
4583 * @ingroup Elm_Gesture_Layer
4585 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4588 * This function called in order to make gesture-layer repeat events.
4589 * Set this of you like to get the raw events only if gestures were not detected.
4590 * Clear this if you like gesture layer to fwd events as testing gestures.
4592 * @param obj Pointer to gesture-layer.
4593 * @param r Repeat: TRUE/FALSE
4595 * @ingroup Elm_Gesture_Layer
4597 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4600 * This function sets step-value for zoom action.
4601 * Set step to any positive value.
4602 * Cancel step setting by setting to 0.0
4604 * @param obj Pointer to gesture-layer.
4605 * @param s new zoom step value.
4607 * @ingroup Elm_Gesture_Layer
4609 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4612 * This function sets step-value for rotate action.
4613 * Set step to any positive value.
4614 * Cancel step setting by setting to 0.0
4616 * @param obj Pointer to gesture-layer.
4617 * @param s new roatate step value.
4619 * @ingroup Elm_Gesture_Layer
4621 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4624 * This function called to attach gesture-layer to an Evas_Object.
4625 * @param obj Pointer to gesture-layer.
4626 * @param t Pointer to underlying object (AKA Target)
4628 * @return TRUE, FALSE on success, failure.
4630 * @ingroup Elm_Gesture_Layer
4632 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4635 * Call this function to construct a new gesture-layer object.
4636 * This does not activate the gesture layer. You have to
4637 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4639 * @param parent the parent object.
4641 * @return Pointer to new gesture-layer object.
4643 * @ingroup Elm_Gesture_Layer
4645 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4648 typedef enum _Elm_Thumb_Animation_Setting
4650 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4651 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
4652 ELM_THUMB_ANIMATION_STOP,
4653 ELM_THUMB_ANIMATION_LAST
4654 } Elm_Thumb_Animation_Setting;
4656 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4657 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4658 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4659 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4660 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4661 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4662 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4663 EAPI void *elm_thumb_ethumb_client_get(void);
4664 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
4665 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4666 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4667 /* available styles:
4671 /* smart callbacks called:
4672 * "clicked" - This is called when a user has clicked the thumb without dragging around.
4673 * "clicked,double" - This is called when a user has double-clicked the thumb.
4674 * "press" - This is called when a user has pressed down the thumb.
4675 * "generate,start" - The thumbnail generation started.
4676 * "generate,stop" - The generation process stopped.
4677 * "generate,error" - The generation failed.
4678 * "load,error" - The thumbnail image loading failed.
4682 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4683 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4684 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4685 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4686 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4687 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4688 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4689 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4690 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4691 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4692 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4693 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4694 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4695 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4696 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4697 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);
4698 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
4699 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4700 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4701 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4702 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);
4703 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);
4704 /* smart callbacks called:
4705 * "clicked" - the user clicked the hoversel button and popped up the sel
4706 * "selected" - an item in the hoversel list is selected
4707 * "dismissed" - the hover is dismissed
4711 typedef enum _Elm_Toolbar_Shrink_Mode
4713 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
4714 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
4715 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
4716 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
4717 } Elm_Toolbar_Shrink_Mode;
4719 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
4720 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
4722 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4723 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
4724 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4725 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4726 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4727 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4728 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4729 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);
4730 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);
4731 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);
4732 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);
4733 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4734 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4735 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4736 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4737 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4738 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
4739 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4740 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4741 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4742 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
4743 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4744 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
4745 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4746 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4747 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4748 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4749 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
4750 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4751 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4752 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4753 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4754 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
4755 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4756 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
4757 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4758 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4759 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4760 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4761 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4762 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4763 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4764 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
4765 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4766 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
4767 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4768 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);
4769 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4770 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4771 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4772 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4773 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4774 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4775 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
4776 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);
4777 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4778 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
4779 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4780 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4781 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4782 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4783 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
4784 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4785 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4786 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4787 /* smart callbacks called:
4788 * "clicked" - when the user clicks on a toolbar item and becomes selected
4790 /* available styles:
4792 * transparent (no background or shadow, just show the provided content)
4796 EAPI double elm_tooltip_delay_get(void);
4797 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
4798 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
4799 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
4800 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
4801 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);
4802 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4803 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4804 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4805 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
4806 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4807 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4808 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4809 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4810 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4811 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4814 EAPI int elm_cursor_engine_only_get(void);
4815 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
4818 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
4819 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4820 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4821 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4822 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4823 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4824 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4825 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4826 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);
4827 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
4828 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4829 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
4830 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4831 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4832 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4833 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4834 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4835 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4836 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
4837 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4838 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4839 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4840 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4841 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
4842 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4843 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4844 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4845 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4846 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4847 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4849 /* smart callbacks called:
4850 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
4854 typedef enum _Elm_List_Mode
4856 ELM_LIST_COMPRESS = 0,
4862 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
4863 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4864 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);
4865 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);
4866 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);
4867 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);
4868 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);
4869 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4870 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
4871 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4872 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4873 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
4874 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4875 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4876 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4877 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4878 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4879 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4880 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4881 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
4883 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4884 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4885 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4886 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4887 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4888 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4889 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4890 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4891 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4892 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
4893 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4894 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
4895 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4896 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4897 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4898 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4899 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4900 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4901 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);
4902 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4903 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4904 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4905 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4906 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4907 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4908 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4909 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4910 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4911 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4912 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4913 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4914 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4915 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4916 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4917 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);
4918 /* smart callbacks called:
4919 * "clicked,double" - when the user double-clicked an item
4920 * "selected" - when the user selected an item
4921 * "unselected" - when the user selected an item
4922 * "longpressed" - an item in the hoversel list is long-pressed
4923 * "scroll,edge,top" - the list is scrolled until the top edge
4924 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
4925 * "scroll,edge,left" - the list is scrolled until the left edge
4926 * "scroll,edge,right" - the list is scrolled until the right edge
4930 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4931 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4932 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4933 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4934 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4935 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4936 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
4937 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4938 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4939 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
4940 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4941 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
4942 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4943 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
4944 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4945 EAPI void elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
4946 EAPI void elm_slider_units_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
4947 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4948 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4949 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
4950 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
4951 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4952 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4953 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
4954 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4955 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
4956 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4957 /* smart callbacks called:
4958 * "changed" - Whenever the slider value is changed by the user.
4959 * "slider,drag,start" - dragging the slider indicator around has started
4960 * "slider,drag,stop" - dragging the slider indicator around has stopped
4961 * "delay,changed" - A short time after the value is changed by the user.
4962 * This will be called only when the user stops dragging for a very short
4963 * period or when they release their finger/mouse, so it avoids possibly
4964 * expensive reactions to the value change.
4971 * @addtogroup Actionslider Actionslider
4973 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
4974 * properties. The indicator is the element the user drags to choose a label.
4975 * When the position is set with magnet, when released the indicator will be
4976 * moved to it if it's nearest the magnetized position.
4978 * @note By default all positions are set as enabled.
4980 * Signals that you can add callbacks for are:
4982 * "selected" - when user selects an enabled position (the label is passed
4985 * "pos_changed" - when the indicator reaches any of the positions("left",
4986 * "right" or "center").
4988 * See an example of actionslider usage @ref actionslider_example_page "here"
4992 typedef enum _Elm_Actionslider_Indicator_Pos
4994 ELM_ACTIONSLIDER_INDICATOR_NONE,
4995 ELM_ACTIONSLIDER_INDICATOR_LEFT,
4996 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
4997 ELM_ACTIONSLIDER_INDICATOR_CENTER
4998 } Elm_Actionslider_Indicator_Pos;
5000 typedef enum _Elm_Actionslider_Magnet_Pos
5002 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5003 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5004 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5005 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5006 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5007 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5008 } Elm_Actionslider_Magnet_Pos;
5010 typedef enum _Elm_Actionslider_Label_Pos
5012 ELM_ACTIONSLIDER_LABEL_LEFT,
5013 ELM_ACTIONSLIDER_LABEL_RIGHT,
5014 ELM_ACTIONSLIDER_LABEL_CENTER,
5015 ELM_ACTIONSLIDER_LABEL_BUTTON
5016 } Elm_Actionslider_Label_Pos;
5018 /* smart callbacks called:
5019 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5023 * Add a new actionslider to the parent.
5025 * @param parent The parent object
5026 * @return The new actionslider object or NULL if it cannot be created
5028 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5031 * Set actionslider label.
5033 * @param[in] obj The actionslider object
5034 * @param[in] pos The position of the label.
5035 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5036 * @param label The label which is going to be set.
5038 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5040 * Get actionslider labels.
5042 * @param obj The actionslider object
5043 * @param left_label A char** to place the left_label of @p obj into.
5044 * @param center_label A char** to place the center_label of @p obj into.
5045 * @param right_label A char** to place the right_label of @p obj into.
5047 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);
5049 * Get actionslider selected label.
5051 * @param obj The actionslider object
5052 * @return The selected label
5054 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5056 * Set actionslider indicator position.
5058 * @param obj The actionslider object.
5059 * @param pos The position of the indicator.
5061 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5063 * Get actionslider indicator position.
5065 * @param obj The actionslider object.
5066 * @return The position of the indicator.
5068 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5070 * Set actionslider magnet position. To make multiple positions magnets @c or
5071 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5073 * @param obj The actionslider object.
5074 * @param pos Bit mask indicating the magnet positions.
5076 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5078 * Get actionslider magnet position.
5080 * @param obj The actionslider object.
5081 * @return The positions with magnet property.
5083 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5085 * Set actionslider enabled position. To set multiple positions as enabled @c or
5086 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5088 * @note All the positions are enabled by default.
5090 * @param obj The actionslider object.
5091 * @param pos Bit mask indicating the enabled positions.
5093 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5095 * Get actionslider enabled position.
5097 * @param obj The actionslider object.
5098 * @return The enabled positions.
5100 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5102 * Set the label used on the indicator.
5104 * @param obj The actionslider object
5105 * @param label The label to be set on the indicator.
5106 * @deprecated use elm_object_text_set() instead.
5108 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5110 * Get the label used on the indicator object.
5112 * @param obj The actionslider object
5113 * @return The indicator label
5114 * @deprecated use elm_object_text_get() instead.
5116 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5119 * Hold actionslider object movement.
5121 * @param[in] obj The actionslider object
5122 * @param[in] flag Actionslider hold/release
5123 * (EINA_TURE = hold/EIN_FALSE = release)
5125 * @ingroup Actionslider
5127 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5135 typedef enum _Elm_Genlist_Item_Flags
5137 ELM_GENLIST_ITEM_NONE = 0,
5138 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5139 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5140 } Elm_Genlist_Item_Flags;
5141 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5142 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5143 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5144 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5145 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5146 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5147 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5148 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5150 struct _Elm_Genlist_Item_Class
5152 const char *item_style;
5154 GenlistItemLabelGetFunc label_get;
5155 GenlistItemIconGetFunc icon_get;
5156 GenlistItemStateGetFunc state_get;
5157 GenlistItemDelFunc del;
5158 GenlistItemMovedFunc moved;
5160 const char *edit_item_style;
5161 const char *mode_item_style;
5163 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5164 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5165 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5166 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5167 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5168 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5169 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5170 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5171 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5172 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5173 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5174 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5175 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5176 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5177 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5178 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5179 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5180 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5181 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5182 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5183 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5184 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5185 /* operations to add items */
5186 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);
5187 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);
5188 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);
5189 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);
5190 /* operations to retrieve existing items */
5191 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5192 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5193 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5194 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);
5195 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5196 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5197 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5198 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);
5199 /* available item styles:
5201 * default_style - The text part is a textblock
5203 * icon_top_text_bottom
5205 /* Genlist Item operation */
5206 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5207 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5208 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5209 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5210 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5211 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5212 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5213 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5214 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5215 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5216 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5217 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5218 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5219 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5220 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5221 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5222 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5223 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5224 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5225 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5226 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5227 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5228 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5229 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5230 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5231 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5232 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5233 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5234 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);
5235 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5236 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5237 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5238 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5239 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5240 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5241 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5242 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5243 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5244 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5245 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5246 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5247 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5248 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5249 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5250 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5251 /* Signals that you can add callbacks for are:
5252 * "clicked,double" - This is called when a user has double-clicked an item.
5253 * The event_info parameter is the genlist item that was
5255 * "selected" - This is called when a user has made an item selected. The
5256 * event_info parameter is the genlist item that was selected.
5257 * "unselected" - This is called when a user has made an item unselected. The
5258 * event_info parameter is the genlist item that was unselected.
5259 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5260 * and the item is now meant to be expanded. The event_info parameter is the
5261 * genlist item that was indicated to expand. It is the job of this callback
5262 * to then fill in the child items.
5263 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5264 * and the item is now meant to be contracted. The event_info parameter is
5265 * the genlist item that was indicated to contract. It is the job of this
5266 * callback to then delete the child items.
5267 * "expand,request" - This is called when a user has indicated they want to
5268 * expand a tree branch item. The callback should decide if the item can
5269 * expand (has any children) and then call elm_genlist_item_expanded_set()
5270 * appropriately to set the state. The event_info parameter is the genlist
5271 * item that was indicated to expand.
5272 * "contract,request" - This is called when a user has indicated they want to
5273 * contract a tree branch item. The callback should decide if the item can
5274 * contract (has any children) and then call elm_genlist_item_expanded_set()
5275 * appropriately to set the state. The event_info parameter is the genlist
5276 * item that was indicated to contract.
5277 * "realized" - This is called when the item in the list is created as a real
5278 * evas object. event_info parameter is the genlist item that was created.
5279 * The object may be deleted at any time, so it is up to the caller to
5280 * not use the object pointer from elm_genlist_item_object_get() in a way
5281 * where it may point to freed objects.
5282 * "unrealized" - This is called just before an item is unrealized. After
5283 * this call icon objects provided will be deleted and the item object
5284 * itself delete or be put into a floating cache.
5285 * "drag,start,up" - This is called when the item in the list has been dragged
5286 * (not scrolled) up.
5287 * "drag,start,down" - This is called when the item in the list has been dragged
5288 * (not scrolled) down.
5289 * "drag,start,left" - This is called when the item in the list has been dragged i
5290 * (not scrolled) left.
5291 * "drag,start,right" - This is called when the item in the list has been dragged
5292 * (not scrolled) right.
5293 * "drag,stop" - This is called when the item in the list has stopped being
5295 * "drag" - This is called when the item in the list is being dragged.
5296 * "longpressed" - This is called when the item is pressed for a certain amount
5297 * of time. By default it's 1 second.
5298 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5300 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5302 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5304 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5306 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5308 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5310 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5311 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5313 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5315 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5318 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5319 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5320 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5321 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5322 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5323 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5324 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5325 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5326 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5327 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5330 * @page tutorial_check Check example
5331 * @dontinclude check_example_01.c
5333 * This example will show 2 checkboxes, one with just a label and the second
5334 * one with both a label and an icon. This example also ilustrates how to
5335 * have the checkbox change the value of a variable and how to react to those
5338 * We will start with the usual setup code:
5341 * And now we create our first checkbox, set its label, tell it to change
5342 * the value of @p value when the checkbox stats is changed and ask to be
5343 * notified of state changes:
5346 * For our second checkbox we are going to set an icon so we need to create
5349 * @note For simplicity we are using a rectangle as icon, but any evas object
5352 * And for our second checkbox we set the label, icon and state to true:
5355 * We now do some more setup:
5358 * And finally implement the callback that will be called when the first
5359 * checkbox's state changes. This callback will use @p data to print a
5362 * @note This work because @p data is @p value(from the main function) and @p
5363 * value is changed when the checkbox is changed.
5365 * Our example will look like this:
5366 * @image html screenshots/check_example_01.png
5367 * @image latex screenshots/check_example_01.eps
5369 * @example check_example_01.c
5372 * @defgroup Check Check
5374 * @brief The check widget allows for toggling a value between true and
5377 * Check objects are a lot like radio objects in layout and functionality
5378 * except they do not work as a group, but independently and only toggle the
5379 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5380 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5381 * returns the current state. For convenience, like the radio objects, you
5382 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5385 * Signals that you can add callbacks for are:
5386 * "changed" - This is called whenever the user changes the state of one of
5387 * the check object(event_info is NULL).
5389 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5393 * @brief Add a new Check object
5395 * @param parent The parent object
5396 * @return The new object or NULL if it cannot be created
5398 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5400 * @brief Set the text label of the check object
5402 * @param obj The check object
5403 * @param label The text label string in UTF-8
5405 * @deprecated use elm_object_text_set() instead.
5407 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5409 * @brief Get the text label of the check object
5411 * @param obj The check object
5412 * @return The text label string in UTF-8
5414 * @deprecated use elm_object_text_get() instead.
5416 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5418 * @brief Set the icon object of the check object
5420 * @param obj The check object
5421 * @param icon The icon object
5423 * Once the icon object is set, a previously set one will be deleted.
5424 * If you want to keep that old content object, use the
5425 * elm_check_icon_unset() function.
5427 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5429 * @brief Get the icon object of the check object
5431 * @param obj The check object
5432 * @return The icon object
5434 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5436 * @brief Unset the icon used for the check object
5438 * @param obj The check object
5439 * @return The icon object that was being used
5441 * Unparent and return the icon object which was set for this widget.
5443 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5445 * @brief Set the on/off state of the check object
5447 * @param obj The check object
5448 * @param state The state to use (1 == on, 0 == off)
5450 * This sets the state of the check. If set
5451 * with elm_check_state_pointer_set() the state of that variable is also
5452 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5454 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5456 * @brief Get the state of the check object
5458 * @param obj The check object
5459 * @return The boolean state
5461 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5463 * @brief Set a convenience pointer to a boolean to change
5465 * @param obj The check object
5466 * @param statep Pointer to the boolean to modify
5468 * This sets a pointer to a boolean, that, in addition to the check objects
5469 * state will also be modified directly. To stop setting the object pointed
5470 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5471 * then when this is called, the check objects state will also be modified to
5472 * reflect the value of the boolean @p statep points to, just like calling
5473 * elm_check_state_set().
5475 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5481 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5482 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5483 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5484 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5485 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5486 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5487 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5488 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5489 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5490 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5491 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5492 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5493 /* smart callbacks called:
5494 * "changed" - when the radio status is changed
5498 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5499 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5500 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5501 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5502 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5504 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5505 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5507 /* available item styles:
5513 /* smart callbacks called:
5514 * "hide,finished" - when the previous page is hided
5517 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5518 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5519 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5520 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5521 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5523 struct _Elm_Slideshow_Item_Class
5525 struct _Elm_Slideshow_Item_Class_Func
5527 SlideshowItemGetFunc get;
5528 SlideshowItemDelFunc del;
5532 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5533 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5534 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);
5535 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5536 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5537 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5538 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5539 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5540 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5541 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5542 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5543 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5544 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5545 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5546 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5547 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5548 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5549 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5550 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5551 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5552 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5553 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5554 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5555 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5556 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5557 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5558 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5559 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5560 /* smart callbacks called:
5561 * "changed" - when the slideshow switch to another item
5565 typedef enum _Elm_Fileselector_Mode
5567 ELM_FILESELECTOR_LIST = 0,
5568 ELM_FILESELECTOR_GRID,
5569 ELM_FILESELECTOR_LAST
5570 } Elm_Fileselector_Mode;
5572 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5573 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5574 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5575 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5576 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5577 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5578 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5579 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5580 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5581 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5582 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5583 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5585 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5586 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5587 /* smart callbacks called:
5588 * "selected" - the user click on a file
5589 * "directory,open" - the list is populate with a new content. event_info is a directory.
5590 * "done" - the user click on the ok or cancel buttons
5594 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5595 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5596 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5597 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5598 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5599 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5600 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5601 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5602 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5603 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5604 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5605 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5606 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5607 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5608 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5609 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5610 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5611 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5612 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5613 /* smart callbacks called:
5615 /* available item styles:
5617 * wheel (simple style, no text, no progression, only pulse is available)
5621 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5622 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5623 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5624 /* smart callbacks called:
5628 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5629 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5630 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5631 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5632 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5633 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5634 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5635 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5636 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5637 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5638 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5640 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5641 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5642 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5643 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5644 /* smart callbacks called:
5645 * "changed" - when the spinner value changes
5646 * "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).
5648 /* available item styles:
5650 * vertical (two up/down buttons at the right side and text left aligned)
5654 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5656 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5657 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5658 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5659 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5660 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5661 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5662 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5663 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5664 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5665 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5666 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);
5667 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5668 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5669 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5670 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5671 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5672 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
5673 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5674 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5675 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
5676 /* smart callbacks called:
5677 * "changed" - when the selected index item changes
5678 * "delay,changed" - when the selected index item changes, but after some small idle period
5679 * "selected" - when the user releases a finger and selects an item
5680 * "level,up" - when the user moves a finger from the first level to the second level
5681 * "level,down" - when the user moves a finger from the second level to the first level
5685 typedef enum _Elm_Photocam_Zoom_Mode
5687 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
5688 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
5689 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
5690 ELM_PHOTOCAM_ZOOM_MODE_LAST
5691 } Elm_Photocam_Zoom_Mode;
5693 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5694 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5695 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5696 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
5697 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5698 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5699 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5700 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5701 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5702 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5703 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5704 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5705 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5706 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5707 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5708 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5709 /* smart callbacks called:
5710 * "clicked" - when image clicked
5711 * "press" - when mouse/finger held down initially on image
5712 * "longpressed" - when mouse/finger held for long time on image
5713 * "clicked,double" - when mouse/finger double-clicked
5714 * "load" - when photo load begins
5715 * "loaded" - when photo load done
5716 * "load,detail" - when detailed image load begins
5717 * "loaded,detail" - when detailed image load done
5718 * "zoom,start" - when zooming started
5719 * "zoom,stop" - when zooming stopped
5720 * "zoom,change" - when auto zoom mode changed zoom level
5721 * "scroll - the content has been scrolled (moved)
5722 * "scroll,anim,start" - scrolling animation has started
5723 * "scroll,anim,stop" - scrolling animation has stopped
5724 * "scroll,drag,start" - dragging the contents around has started
5725 * "scroll,drag,stop" - dragging the contents around has stopped
5729 typedef enum _Elm_Map_Zoom_Mode
5731 ELM_MAP_ZOOM_MODE_MANUAL,
5732 ELM_MAP_ZOOM_MODE_AUTO_FIT,
5733 ELM_MAP_ZOOM_MODE_AUTO_FILL,
5734 ELM_MAP_ZOOM_MODE_LAST
5735 } Elm_Map_Zoom_Mode;
5737 typedef enum _Elm_Map_Route_Sources
5739 ELM_MAP_ROUTE_SOURCE_YOURS,
5740 ELM_MAP_ROUTE_SOURCE_MONAV,
5741 ELM_MAP_ROUTE_SOURCE_ORS,
5742 ELM_MAP_ROUTE_SOURCE_LAST
5743 } Elm_Map_Route_Sources;
5745 typedef enum _Elm_Map_Name_Sources
5747 ELM_MAP_NAME_SOURCE_NOMINATIM,
5748 ELM_MAP_NAME_SOURCE_LAST
5749 } Elm_Map_Name_Sources;
5751 typedef enum _Elm_Map_Route_Type
5753 ELM_MAP_ROUTE_TYPE_MOTOCAR,
5754 ELM_MAP_ROUTE_TYPE_BICYCLE,
5755 ELM_MAP_ROUTE_TYPE_FOOT,
5756 ELM_MAP_ROUTE_TYPE_LAST
5757 } Elm_Map_Route_Type;
5759 typedef enum _Elm_Map_Route_Method
5761 ELM_MAP_ROUTE_METHOD_FASTEST,
5762 ELM_MAP_ROUTE_METHOD_SHORTEST,
5763 ELM_MAP_ROUTE_METHOD_LAST
5764 } Elm_Map_Route_Method;
5766 typedef enum _Elm_Map_Name_Method
5768 ELM_MAP_NAME_METHOD_SEARCH,
5769 ELM_MAP_NAME_METHOD_REVERSE,
5770 ELM_MAP_NAME_METHOD_LAST
5771 } Elm_Map_Name_Method;
5773 typedef struct _Elm_Map_Marker Elm_Map_Marker;
5774 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
5775 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
5776 typedef struct _Elm_Map_Route Elm_Map_Route;
5777 typedef struct _Elm_Map_Name Elm_Map_Name;
5778 typedef struct _Elm_Map_Track Elm_Map_Track;
5780 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
5781 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
5782 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
5783 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
5785 typedef char *(*ElmMapModuleSourceFunc) (void);
5786 typedef int (*ElmMapModuleZoomMinFunc) (void);
5787 typedef int (*ElmMapModuleZoomMaxFunc) (void);
5788 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
5789 typedef int (*ElmMapModuleRouteSourceFunc) (void);
5790 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
5791 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
5792 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
5793 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
5795 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5796 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5797 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5798 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5799 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5800 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
5801 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5802 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5803 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5804 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5806 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5807 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
5808 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);
5809 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);
5810 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5811 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
5812 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);
5813 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);
5814 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
5815 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5816 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
5817 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5818 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5819 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
5820 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5821 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5822 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5823 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
5824 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
5825 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
5826 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
5827 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
5828 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
5829 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
5830 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
5831 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
5832 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
5833 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
5834 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
5835 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5836 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
5837 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5838 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
5839 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5840 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5841 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5842 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5843 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5844 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
5845 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5846 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);
5847 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5848 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
5849 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
5850 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5851 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5852 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5853 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
5854 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
5855 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
5856 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
5857 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);
5858 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5859 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5861 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
5863 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
5865 /* smart callbacks called:
5866 * "clicked" - when image clicked
5867 * "press" - when mouse/finger held down initially on image
5868 * "longpressed" - when mouse/finger held for long time on image
5869 * "clicked,double" - when mouse/finger double-clicked
5870 * "load,details" - when detailed image load begins
5871 * "loaded,details" - when detailed image load done
5872 * "zoom,start" - when zooming started
5873 * "zoom,stop" - when zooming stopped
5874 * "zoom,change" - when auto zoom mode changed zoom level
5875 * "scroll - the content has been scrolled (moved)
5876 * "scroll,anim,start" - scrolling animation has started
5877 * "scroll,anim,stop" - scrolling animation has stopped
5878 * "scroll,drag,start" - dragging the contents around has started
5879 * "scroll,drag,stop" - dragging the contents around has stopped
5883 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
5885 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
5887 EAPI double elm_route_lon_min_get(Evas_Object *obj);
5888 EAPI double elm_route_lat_min_get(Evas_Object *obj);
5889 EAPI double elm_route_lon_max_get(Evas_Object *obj);
5890 EAPI double elm_route_lat_max_get(Evas_Object *obj);
5894 typedef enum _Elm_Panel_Orient
5896 ELM_PANEL_ORIENT_TOP,
5897 ELM_PANEL_ORIENT_BOTTOM,
5898 ELM_PANEL_ORIENT_LEFT,
5899 ELM_PANEL_ORIENT_RIGHT,
5902 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5903 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
5904 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5905 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5906 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5907 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5908 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
5909 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5910 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
5916 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
5917 * Add events (move, start ...)
5919 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5920 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5921 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5922 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5923 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5924 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5925 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5926 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5927 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
5928 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5929 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5930 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
5931 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5934 typedef enum _Elm_Flip_Mode
5936 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
5937 ELM_FLIP_ROTATE_X_CENTER_AXIS,
5938 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
5939 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
5941 ELM_FLIP_CUBE_RIGHT,
5945 ELM_FLIP_PAGE_RIGHT,
5949 typedef enum _Elm_Flip_Interaction
5951 ELM_FLIP_INTERACTION_NONE,
5952 ELM_FLIP_INTERACTION_ROTATE,
5953 ELM_FLIP_INTERACTION_CUBE,
5954 ELM_FLIP_INTERACTION_PAGE
5955 } Elm_Flip_Interaction;
5956 typedef enum _Elm_Flip_Direction
5958 ELM_FLIP_DIRECTION_UP,
5959 ELM_FLIP_DIRECTION_DOWN,
5960 ELM_FLIP_DIRECTION_LEFT,
5961 ELM_FLIP_DIRECTION_RIGHT
5962 } Elm_Flip_Direction;
5964 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5965 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5966 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5967 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5968 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5970 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5971 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5972 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5973 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
5974 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
5975 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
5976 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
5977 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
5978 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
5979 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
5980 /* smart callbacks called:
5981 * "animate,begin" - when a flip animation was started
5982 * "animate,done" - when a flip animation is finished
5986 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5987 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
5988 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5989 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
5990 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5991 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5992 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5993 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5994 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5996 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5997 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5998 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5999 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6000 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6001 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6002 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6003 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6004 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6005 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6006 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6007 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6008 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6009 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6010 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6011 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6012 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6013 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6014 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6015 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6016 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6017 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6018 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6019 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6020 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6021 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);
6022 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6023 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6024 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);
6025 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6026 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);
6027 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6028 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6029 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6030 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6031 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6032 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6033 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6034 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6035 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);
6036 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);
6037 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);
6038 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);
6039 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);
6040 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);
6041 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6042 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6043 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6044 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6045 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6046 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6047 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6048 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6049 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6050 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6051 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6052 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6053 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6056 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6057 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6058 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6059 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6060 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6063 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6064 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6065 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6066 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6067 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6068 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6069 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6070 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6071 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6072 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6075 * @defgroup Flipselector Flip Selector
6077 * A flip selector is a widget to show a set of @b text items, one
6078 * at a time, with the same sheet switching style as the @ref Clock
6079 * "clock" widget, when one changes the current displaying sheet
6080 * (thus, the "flip" in the name).
6082 * User clicks to flip sheets which are @b held for some time will
6083 * make the flip selector to flip continuosly and automatically for
6084 * the user. The interval between flips will keep growing in time,
6085 * so that it helps the user to reach an item which is distant from
6086 * the current selection.
6088 * Smart callbacks one can register to:
6089 * - @c "selected" - when the widget's selected text item is changed
6090 * - @c "overflowed" - when the widget's current selection is changed
6091 * from the first item in its list to the last
6092 * - @c "underflowed" - when the widget's current selection is changed
6093 * from the last item in its list to the first
6095 * Available styles for it:
6098 * Here is an example on its usage:
6099 * @li @ref flipselector_example
6103 * @addtogroup Flipselector
6107 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6110 * Add a new flip selector widget to the given parent Elementary
6111 * (container) widget
6113 * @param parent The parent object
6114 * @return a new flip selector widget handle or @c NULL, on errors
6116 * This function inserts a new flip selector widget on the canvas.
6118 * @ingroup Flipselector
6120 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6123 * Programmatically select the next item of a flip selector widget
6125 * @param obj The flipselector object
6127 * @note The selection will be animated. Also, if it reaches the
6128 * end of its list of member items, it will continue with the first
6131 * @ingroup Flipselector
6133 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6136 * Programmatically select the previous item of a flip selector
6139 * @param obj The flipselector object
6141 * @note The selection will be animated. Also, if it reaches the
6142 * beginning of its list of member items, it will continue with the
6143 * last one backwards.
6145 * @ingroup Flipselector
6147 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6150 * Append a (text) item to a flip selector widget
6152 * @param obj The flipselector object
6153 * @param label The (text) label of the new item
6154 * @param func Convenience callback function to take place when
6156 * @param data Data passed to @p func, above
6157 * @return A handle to the item added or @c NULL, on errors
6159 * The widget's list of labels to show will be appended with the
6160 * given value. If the user wishes so, a callback function pointer
6161 * can be passed, which will get called when this same item is
6164 * @note The current selection @b won't be modified by appending an
6165 * element to the list.
6167 * @note The maximum length of the text label is going to be
6168 * determined <b>by the widget's theme</b>. Strings larger than
6169 * that value are going to be @b truncated.
6171 * @ingroup Flipselector
6173 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6176 * Prepend a (text) item to a flip selector widget
6178 * @param obj The flipselector object
6179 * @param label The (text) label of the new item
6180 * @param func Convenience callback function to take place when
6182 * @param data Data passed to @p func, above
6183 * @return A handle to the item added or @c NULL, on errors
6185 * The widget's list of labels to show will be prepended with the
6186 * given value. If the user wishes so, a callback function pointer
6187 * can be passed, which will get called when this same item is
6190 * @note The current selection @b won't be modified by prepending
6191 * an element to the list.
6193 * @note The maximum length of the text label is going to be
6194 * determined <b>by the widget's theme</b>. Strings larger than
6195 * that value are going to be @b truncated.
6197 * @ingroup Flipselector
6199 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6202 * Get the internal list of items in a given flip selector widget.
6204 * @param obj The flipselector object
6205 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6208 * This list is @b not to be modified in any way and must not be
6209 * freed. Use the list members with functions like
6210 * elm_flipselector_item_label_set(),
6211 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6212 * elm_flipselector_item_del(),
6213 * elm_flipselector_item_selected_get(),
6214 * elm_flipselector_item_selected_set().
6216 * @warning This list is only valid until @p obj object's internal
6217 * items list is changed. It should be fetched again with another
6218 * call to this function when changes happen.
6220 * @ingroup Flipselector
6222 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6225 * Get the first item in the given flip selector widget's list of
6228 * @param obj The flipselector object
6229 * @return The first item or @c NULL, if it has no items (and on
6232 * @see elm_flipselector_item_append()
6233 * @see elm_flipselector_last_item_get()
6235 * @ingroup Flipselector
6237 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6240 * Get the last item in the given flip selector widget's list of
6243 * @param obj The flipselector object
6244 * @return The last item or @c NULL, if it has no items (and on
6247 * @see elm_flipselector_item_prepend()
6248 * @see elm_flipselector_first_item_get()
6250 * @ingroup Flipselector
6252 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6255 * Get the currently selected item in a flip selector widget.
6257 * @param obj The flipselector object
6258 * @return The selected item or @c NULL, if the widget has no items
6261 * @ingroup Flipselector
6263 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6266 * Set whether a given flip selector widget's item should be the
6267 * currently selected one.
6269 * @param item The flip selector item
6270 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6272 * This sets whether @p item is or not the selected (thus, under
6273 * display) one. If @p item is different than one under display,
6274 * the latter will be unselected. If the @p item is set to be
6275 * unselected, on the other hand, the @b first item in the widget's
6276 * internal members list will be the new selected one.
6278 * @see elm_flipselector_item_selected_get()
6280 * @ingroup Flipselector
6282 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6285 * Get whether a given flip selector widget's item is the currently
6288 * @param item The flip selector item
6289 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6292 * @see elm_flipselector_item_selected_set()
6294 * @ingroup Flipselector
6296 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6299 * Delete a given item from a flip selector widget.
6301 * @param item The item to delete
6303 * @ingroup Flipselector
6305 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6308 * Get the label of a given flip selector widget's item.
6310 * @param item The item to get label from
6311 * @return The text label of @p item or @c NULL, on errors
6313 * @see elm_flipselector_item_label_set()
6315 * @ingroup Flipselector
6317 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6320 * Set the label of a given flip selector widget's item.
6322 * @param item The item to set label on
6323 * @param label The text label string, in UTF-8 encoding
6325 * @see elm_flipselector_item_label_get()
6327 * @ingroup Flipselector
6329 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6332 * Gets the item before @p item in a flip selector widget's
6333 * internal list of items.
6335 * @param item The item to fetch previous from
6336 * @return The item before the @p item, in its parent's list. If
6337 * there is no previous item for @p item or there's an
6338 * error, @c NULL is returned.
6340 * @see elm_flipselector_item_next_get()
6342 * @ingroup Flipselector
6344 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6347 * Gets the item after @p item in a flip selector widget's
6348 * internal list of items.
6350 * @param item The item to fetch next from
6351 * @return The item after the @p item, in its parent's list. If
6352 * there is no next item for @p item or there's an
6353 * error, @c NULL is returned.
6355 * @see elm_flipselector_item_next_get()
6357 * @ingroup Flipselector
6359 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6362 * Set the interval on time updates for an user mouse button hold
6363 * on a flip selector widget.
6365 * @param obj The flip selector object
6366 * @param interval The (first) interval value in seconds
6368 * This interval value is @b decreased while the user holds the
6369 * mouse pointer either flipping up or flipping doww a given flip
6372 * This helps the user to get to a given item distant from the
6373 * current one easier/faster, as it will start to flip quicker and
6374 * quicker on mouse button holds.
6376 * The calculation for the next flip interval value, starting from
6377 * the one set with this call, is the previous interval divided by
6378 * 1.05, so it decreases a little bit.
6380 * The default starting interval value for automatic flips is
6383 * @see elm_flipselector_interval_get()
6385 * @ingroup Flipselector
6387 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6390 * Get the interval on time updates for an user mouse button hold
6391 * on a flip selector widget.
6393 * @param obj The flip selector object
6394 * @return The (first) interval value, in seconds, set on it
6396 * @see elm_flipselector_interval_set() for more details
6398 * @ingroup Flipselector
6400 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407 * @addtogroup Animator Animator
6408 * @ingroup Elementary
6410 * @brief Functions to ease creation of animations.
6412 * elm_animator is designed to provide an easy way to create animations.
6413 * Creating an animation with elm_animator is as simple as setting a
6414 * duration, an operating callback and telling it to run the animation.
6415 * However that is not the full extent of elm_animator's ability, animations
6416 * can be paused and resumed, reversed and the animation need not be linear.
6418 * To run an animation you must specify at least a duration and operation
6419 * callback, not setting any other properties will create a linear animation
6420 * that runs once and is not reversed.
6422 * @ref elm_animator_example_page_01 "This" example should make all of that
6425 * @warning elm_animator is @b not a widget.
6429 * @brief Type of curve desired for animation.
6431 * The speed in which an animation happens doesn't have to be linear, some
6432 * animations will look better if they're accelerating or decelerating, so
6433 * elm_animator provides four options in this regard:
6434 * @image html elm_animator_curve_style.png
6435 * @image latex elm_animator_curve_style.eps width=\textwidth
6436 * As can be seen in the image the speed of the animation will be:
6437 * @li ELM_ANIMATOR_CURVE_LINEAR constant
6438 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6439 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6440 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6444 ELM_ANIMATOR_CURVE_LINEAR,
6445 ELM_ANIMATOR_CURVE_IN_OUT,
6446 ELM_ANIMATOR_CURVE_IN,
6447 ELM_ANIMATOR_CURVE_OUT
6448 } Elm_Animator_Curve_Style;
6449 typedef struct _Elm_Animator Elm_Animator;
6451 * Called back per loop of an elementary animators cycle
6452 * @param data user-data given to elm_animator_operation_callback_set()
6453 * @param animator the animator being run
6454 * @param double the position in the animation
6456 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6458 * Called back when an elementary animator finishes
6459 * @param data user-data given to elm_animator_completion_callback_set()
6461 typedef void (*Elm_Animator_Completion_Cb) (void *data);
6464 * @brief Create a new animator.
6466 * @param[in] parent Parent object
6468 * The @a parent argument can be set to NULL for no parent. If a parent is set
6469 * there is no need to call elm_animator_del(), when the parent is deleted it
6470 * will delete the animator.
6471 * @deprecated Use @ref Transit instead.
6474 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
6476 * Deletes the animator freeing any resources it used. If the animator was
6477 * created with a NULL parent this must be called, otherwise it will be
6478 * automatically called when the parent is deleted.
6480 * @param[in] animator Animator object
6481 * @deprecated Use @ref Transit instead.
6483 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6485 * Set the duration of the animation.
6487 * @param[in] animator Animator object
6488 * @param[in] duration Duration in second
6489 * @deprecated Use @ref Transit instead.
6491 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6493 * @brief Set the callback function for animator operation.
6495 * @param[in] animator Animator object
6496 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6497 * @param[in] data Callback function user argument
6499 * The @p func callback will be called with a frame value in range [0, 1] which
6500 * indicates how far along the animation should be. It is the job of @p func to
6501 * actually change the state of any object(or objects) that are being animated.
6502 * @deprecated Use @ref Transit instead.
6504 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6506 * Set the callback function for the when the animation ends.
6508 * @param[in] animator Animator object
6509 * @param[in] func Callback function pointe
6510 * @param[in] data Callback function user argument
6512 * @warning @a func will not be executed if elm_animator_stop() is called.
6513 * @deprecated Use @ref Transit instead.
6515 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6517 * @brief Stop animator.
6519 * @param[in] animator Animator object
6521 * If called before elm_animator_animate() it does nothing. If there is an
6522 * animation in progress the animation will be stopped(the operation callback
6523 * will not be executed again) and it can't be restarted using
6524 * elm_animator_resume().
6525 * @deprecated Use @ref Transit instead.
6527 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6529 * Set the animator repeat count.
6531 * @param[in] animator Animator object
6532 * @param[in] repeat_cnt Repeat count
6533 * @deprecated Use @ref Transit instead.
6535 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6537 * @brief Start animation.
6539 * @param[in] animator Animator object
6541 * This function starts the animation if the nescessary properties(duration
6542 * and operation callback) have been set. Once started the animation will
6543 * run until complete or elm_animator_stop() is called.
6544 * @deprecated Use @ref Transit instead.
6546 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6548 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6550 * @param[in] animator Animator object
6551 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6552 * @deprecated Use @ref Transit instead.
6554 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6556 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6558 * @param[in] animator Animator object
6559 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6560 * @deprecated Use @ref Transit instead.
6562 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6564 * @brief Sets wether the animation should be automatically reversed.
6566 * @param[in] animator Animator object
6567 * @param[in] reverse Reverse or not
6569 * This controls wether the animation will be run on reverse imediately after
6570 * running forward. When this is set together with repetition the animation
6571 * will run in reverse once for each time it ran forward.@n
6572 * Runnin an animation in reverse is accomplished by calling the operation
6573 * callback with a frame value starting at 1 and diminshing until 0.
6574 * @deprecated Use @ref Transit instead.
6576 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6578 * Gets wether the animation will automatically reversed
6580 * @param[in] animator Animator object
6581 * @deprecated Use @ref Transit instead.
6583 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6585 * Gets the status for the animator operation. The status of the animator @b
6586 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6587 * only informs if the animation was started and has not ended(either normally
6588 * or through elm_animator_stop()).
6590 * @param[in] animator Animator object
6591 * @deprecated Use @ref Transit instead.
6593 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6595 * Gets how many times the animation will be repeated
6597 * @param[in] animator Animator object
6598 * @deprecated Use @ref Transit instead.
6600 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6602 * Pause the animator.
6604 * @param[in] animator Animator object
6606 * This causes the animation to be temporarily stopped(the operation callback
6607 * will not be called). If the animation is not yet running this is a no-op.
6608 * Once an animation has been paused with this function it can be resumed
6609 * using elm_animator_resume().
6610 * @deprecated Use @ref Transit instead.
6612 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6614 * @brief Resumes the animator.
6616 * @param[in] animator Animator object
6618 * Resumes an animation that was paused using elm_animator_pause(), after
6619 * calling this function calls to the operation callback will happen
6620 * normally. If an animation is stopped by means of elm_animator_stop it
6621 * @b can't be restarted with this function.@n
6623 * @warning When an animation is resumed it doesn't start from where it was paused, it
6624 * will go to where it would have been if it had not been paused. If an
6625 * animation with a duration of 3 seconds is paused after 1 second for 1 second
6626 * it will resume as if it had ben animating for 2 seconds, the operating
6627 * callback will be called with a frame value of aproximately 2/3.
6628 * @deprecated Use @ref Transit instead.
6630 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6638 ELM_CALENDAR_UNIQUE,
6640 ELM_CALENDAR_WEEKLY,
6641 ELM_CALENDAR_MONTHLY,
6642 ELM_CALENDAR_ANNUALLY
6643 } Elm_Calendar_Mark_Repeat;
6644 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6646 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6647 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6649 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6650 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6651 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6652 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6653 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6654 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6655 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6656 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6657 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6658 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);
6659 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6660 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6661 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6662 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
6663 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6664 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6665 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6666 /* smart callbacks called:
6667 * changed - emitted when the user select a day or change the displayed
6672 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
6674 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6675 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6676 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
6677 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6678 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6679 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6680 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6681 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6682 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6683 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);
6684 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6685 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6686 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6687 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);
6688 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6689 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6690 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6691 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6692 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6693 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6694 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6695 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6696 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6697 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6698 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6699 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6700 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6701 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6702 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
6703 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);
6704 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6705 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6706 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6707 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6708 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6709 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6710 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6711 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6712 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6713 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6714 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
6715 /* smart callbacks called:
6716 * "selected" - when item is selected (scroller stops)
6720 * @page tutorial_colorselector Color selector example
6721 * @dontinclude colorselector_example_01.c
6723 * This example shows how to change the color of a rectangle using a color
6724 * selector. We aren't going to explain a lot of the code since it's the
6728 * Now that we have a window with background and a rectangle we can create
6729 * our color_selector and set it's initial color to fully opaque blue:
6732 * Next we tell ask to be notified whenever the color changes:
6735 * We follow that we some more run of the mill setup code:
6738 * And now get to the callback that sets the color of the rectangle:
6741 * This example will look like this:
6742 * @image html screenshots/colorselector_example_01.png
6743 * @image latex screenshots/colorselector_example_01.eps
6745 * @example colorselector_example_01.c
6748 * @defgroup Colorselector Colorselector
6752 * @brief Widget for user to select a color.
6754 * Signals that you can add callbacks for are:
6755 * "changed" - When the color value changes(event_info is NULL).
6757 * See @ref tutorial_colorselector.
6760 * @brief Add a new colorselector to the parent
6762 * @param parent The parent object
6763 * @return The new object or NULL if it cannot be created
6765 * @ingroup Colorselector
6767 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6769 * Set a color for the colorselector
6771 * @param obj Colorselector object
6772 * @param r r-value of color
6773 * @param g g-value of color
6774 * @param b b-value of color
6775 * @param a a-value of color
6777 * @ingroup Colorselector
6779 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6781 * Get a color from the colorselector
6783 * @param obj Colorselector object
6784 * @param r integer pointer for r-value of color
6785 * @param g integer pointer for g-value of color
6786 * @param b integer pointer for b-value of color
6787 * @param a integer pointer for a-value of color
6789 * @ingroup Colorselector
6791 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6796 /* Contextual Popup */
6797 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
6799 typedef enum _Elm_Ctxpopup_Direction
6801 ELM_CTXPOPUP_DIRECTION_DOWN,
6802 ELM_CTXPOPUP_DIRECTION_RIGHT,
6803 ELM_CTXPOPUP_DIRECTION_LEFT,
6804 ELM_CTXPOPUP_DIRECTION_UP,
6805 } Elm_Ctxpopup_Direction;
6807 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6808 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6809 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6810 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6811 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
6812 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
6813 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6814 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6815 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6816 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6817 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);
6818 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6819 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6820 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6821 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
6822 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6823 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);
6824 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);
6825 /* smart callbacks called:
6826 * "dismissed" - the ctxpopup was dismissed
6832 * @defgroup Transit Transit
6833 * @ingroup Elementary
6835 * Transit is designed to apply various animated transition effects to @c
6836 * Evas_Object, such like translation, rotation, etc. For using these
6837 * effects, create an @ref Elm_Transit and add the desired transition effects.
6839 * Once the effects are added into transit, they will be automatically
6840 * managed (their callback will be called until the duration is ended, and
6841 * they will be deleted on completion).
6845 * Elm_Transit *trans = elm_transit_add();
6846 * elm_transit_object_add(trans, obj);
6847 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
6848 * elm_transit_duration_set(transit, 1);
6849 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
6850 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
6851 * elm_transit_repeat_times_set(transit, 3);
6854 * Some transition effects are used to change the properties of objects. They
6856 * @li @ref elm_transit_effect_translation_add
6857 * @li @ref elm_transit_effect_color_add
6858 * @li @ref elm_transit_effect_rotation_add
6859 * @li @ref elm_transit_effect_wipe_add
6860 * @li @ref elm_transit_effect_zoom_add
6861 * @li @ref elm_transit_effect_resizing_add
6863 * Other transition effects are used to make one object disappear and another
6864 * object appear on its old place. These effects are:
6866 * @li @ref elm_transit_effect_flip_add
6867 * @li @ref elm_transit_effect_resizable_flip_add
6868 * @li @ref elm_transit_effect_fade_add
6869 * @li @ref elm_transit_effect_blend_add
6871 * It's also possible to make a transition chain with @ref
6872 * elm_transit_chain_transit_add.
6874 * @warning We strongly recommend to use elm_transit just when edje can not do
6875 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
6876 * animations can be manipulated inside the theme.
6879 * @li @ref transit_example_01_explained
6880 * @li @ref transit_example_02_explained
6881 * @li @ref transit_example_03_c
6882 * @li @ref transit_example_04_c
6888 * @enum Elm_Transit_Tween_Mode
6890 * The type of acceleration used in the transition.
6894 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
6895 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
6896 over time, then decrease again
6898 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
6900 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
6902 } Elm_Transit_Tween_Mode;
6905 * @enum Elm_Transit_Effect_Flip_Axis
6907 * The axis where flip effect should be applied.
6911 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
6912 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
6913 } Elm_Transit_Effect_Flip_Axis;
6915 * @enum Elm_Transit_Effect_Wipe_Dir
6917 * The direction where the wipe effect should occur.
6921 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
6922 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
6923 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
6924 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
6925 } Elm_Transit_Effect_Wipe_Dir;
6926 /** @enum Elm_Transit_Effect_Wipe_Type
6928 * Whether the wipe effect should show or hide the object.
6932 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
6934 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
6936 } Elm_Transit_Effect_Wipe_Type;
6939 * @typedef Elm_Transit
6941 * The Transit created with elm_transit_add(). This type has the information
6942 * about the objects which the transition will be applied, and the
6943 * transition effects that will be used. It also contains info about
6944 * duration, number of repetitions, auto-reverse, etc.
6946 typedef struct _Elm_Transit Elm_Transit;
6947 typedef void Elm_Transit_Effect;
6949 * @typedef Elm_Transit_Effect_Transition_Cb
6951 * Transition callback called for this effect on each transition iteration.
6953 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
6955 * Elm_Transit_Effect_End_Cb
6957 * Transition callback called for this effect when the transition is over.
6959 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
6962 * Elm_Transit_Del_Cb
6964 * A callback called when the transit is deleted.
6966 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
6971 * @note Is not necessary to delete the transit object, it will be deleted at
6972 * the end of its operation.
6973 * @note The transit will start playing when the program enter in the main loop, is not
6974 * necessary to give a start to the transit.
6976 * @return The transit object.
6980 EAPI Elm_Transit *elm_transit_add(void);
6983 * Stops the animation and delete the @p transit object.
6985 * Call this function if you wants to stop the animation before the duration
6986 * time. Make sure the @p transit object is still alive with
6987 * elm_transit_del_cb_set() function.
6988 * All added effects will be deleted, calling its repective data_free_cb
6989 * functions. The function setted by elm_transit_del_cb_set() will be called.
6991 * @see elm_transit_del_cb_set()
6993 * @param transit The transit object to be deleted.
6996 * @warning Just call this function if you are sure the transit is alive.
6998 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7001 * Add a new effect to the transit.
7003 * @note The cb function and the data are the key to the effect. If you try to
7004 * add an already added effect, nothing is done.
7005 * @note After the first addition of an effect in @p transit, if its
7006 * effect list become empty again, the @p transit will be killed by
7007 * elm_transit_del(transit) function.
7011 * Elm_Transit *transit = elm_transit_add();
7012 * elm_transit_effect_add(transit,
7013 * elm_transit_effect_blend_op,
7014 * elm_transit_effect_blend_context_new(),
7015 * elm_transit_effect_blend_context_free);
7018 * @param transit The transit object.
7019 * @param transition_cb The operation function. It is called when the
7020 * animation begins, it is the function that actually performs the animation.
7021 * It is called with the @p data, @p transit and the time progression of the
7022 * animation (a double value between 0.0 and 1.0).
7023 * @param effect The context data of the effect.
7024 * @param end_cb The function to free the context data, it will be called
7025 * at the end of the effect, it must finalize the animation and free the
7029 * @warning The transit free the context data at the and of the transition with
7030 * the data_free_cb function, do not use the context data in another transit.
7032 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);
7035 * Delete an added effect.
7037 * This function will remove the effect from the @p transit, calling the
7038 * data_free_cb to free the @p data.
7040 * @see elm_transit_effect_add()
7042 * @note If the effect is not found, nothing is done.
7043 * @note If the effect list become empty, this function will call
7044 * elm_transit_del(transit), that is, it will kill the @p transit.
7046 * @param transit The transit object.
7047 * @param transition_cb The operation function.
7048 * @param effect The context data of the effect.
7052 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);
7055 * Add new object to apply the effects.
7057 * @note After the first addition of an object in @p transit, if its
7058 * object list become empty again, the @p transit will be killed by
7059 * elm_transit_del(transit) function.
7060 * @note If the @p obj belongs to another transit, the @p obj will be
7061 * removed from it and it will only belong to the @p transit. If the old
7062 * transit stays without objects, it will die.
7063 * @note When you add an object into the @p transit, its state from
7064 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7065 * transit ends, if you change this state whith evas_object_pass_events_set()
7066 * after add the object, this state will change again when @p transit stops to
7069 * @param transit The transit object.
7070 * @param obj Object to be animated.
7073 * @warning It is not allowed to add a new object after transit begins to go.
7075 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7078 * Removes an added object from the transit.
7080 * @note If the @p obj is not in the @p transit, nothing is done.
7081 * @note If the list become empty, this function will call
7082 * elm_transit_del(transit), that is, it will kill the @p transit.
7084 * @param transit The transit object.
7085 * @param obj Object to be removed from @p transit.
7088 * @warning It is not allowed to remove objects after transit begins to go.
7090 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7093 * Get the objects of the transit.
7095 * @param transit The transit object.
7096 * @return a Eina_List with the objects from the transit.
7100 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7103 * Enable/disable keeping up the objects states.
7104 * If it is not kept, the objects states will be reset when transition ends.
7106 * @note @p transit can not be NULL.
7107 * @note One state includes geometry, color, map data.
7109 * @param transit The transit object.
7110 * @param state_keep Keeping or Non Keeping.
7114 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7117 * Get a value whether the objects states will be reset or not.
7119 * @note @p transit can not be NULL
7121 * @see elm_transit_objects_final_state_keep_set()
7123 * @param transit The transit object.
7124 * @return EINA_TRUE means the states of the objects will be reset.
7125 * If @p transit is NULL, EINA_FALSE is returned
7129 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7132 * Set the event enabled when transit is operating.
7134 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7135 * events from mouse and keyboard during the animation.
7136 * @note When you add an object with elm_transit_object_add(), its state from
7137 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7138 * transit ends, if you change this state with evas_object_pass_events_set()
7139 * after adding the object, this state will change again when @p transit stops
7142 * @param transit The transit object.
7143 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7144 * ignored otherwise.
7148 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7151 * Get the value of event enabled status.
7153 * @see elm_transit_event_enabled_set()
7155 * @param transit The Transit object
7156 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7157 * EINA_FALSE is returned
7161 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7164 * Set the user-callback function when the transit is deleted.
7166 * @note Using this function twice will overwrite the first function setted.
7167 * @note the @p transit object will be deleted after call @p cb function.
7169 * @param transit The transit object.
7170 * @param cb Callback function pointer. This function will be called before
7171 * the deletion of the transit.
7172 * @param data Callback funtion user data. It is the @p op parameter.
7176 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7179 * Set reverse effect automatically.
7181 * If auto reverse is setted, after running the effects with the progress
7182 * parameter from 0 to 1, it will call the effecs again with the progress
7183 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7184 * where the duration was setted with the function elm_transit_add and
7185 * the repeat with the function elm_transit_repeat_times_set().
7187 * @param transit The transit object.
7188 * @param reverse EINA_TRUE means the auto_reverse is on.
7192 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7195 * Get if the auto reverse is on.
7197 * @see elm_transit_auto_reverse_set()
7199 * @param transit The transit object.
7200 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7201 * EINA_FALSE is returned
7205 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7208 * Set the transit repeat count. Effect will be repeated by repeat count.
7210 * This function sets the number of repetition the transit will run after
7211 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7212 * If the @p repeat is a negative number, it will repeat infinite times.
7214 * @note If this function is called during the transit execution, the transit
7215 * will run @p repeat times, ignoring the times it already performed.
7217 * @param transit The transit object
7218 * @param repeat Repeat count
7222 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7225 * Get the transit repeat count.
7227 * @see elm_transit_repeat_times_set()
7229 * @param transit The Transit object.
7230 * @return The repeat count. If @p transit is NULL
7235 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7238 * Set the transit animation acceleration type.
7240 * This function sets the tween mode of the transit that can be:
7241 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7242 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7243 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7244 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7246 * @param transit The transit object.
7247 * @param tween_mode The tween type.
7251 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7254 * Get the transit animation acceleration type.
7256 * @note @p transit can not be NULL
7258 * @param transit The transit object.
7259 * @return The tween type. If @p transit is NULL
7260 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7264 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7267 * Set the transit animation time
7269 * @note @p transit can not be NULL
7271 * @param transit The transit object.
7272 * @param duration The animation time.
7276 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7279 * Get the transit animation time
7281 * @note @p transit can not be NULL
7283 * @param transit The transit object.
7285 * @return The transit animation time.
7289 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7292 * Starts the transition.
7293 * Once this API is called, the transit begins to measure the time.
7295 * @note @p transit can not be NULL
7297 * @param transit The transit object.
7301 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7304 * Pause/Resume the transition.
7306 * If you call elm_transit_go again, the transit will be started from the
7307 * beginning, and will be unpaused.
7309 * @note @p transit can not be NULL
7311 * @param transit The transit object.
7312 * @param paused Whether the transition should be paused or not.
7316 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7319 * Get the value of paused status.
7321 * @see elm_transit_paused_set()
7323 * @note @p transit can not be NULL
7325 * @param transit The transit object.
7326 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7327 * EINA_FALSE is returned
7331 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7334 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7336 * The value returned is a fraction (current time / total time). It
7337 * represents the progression position relative to the total.
7339 * @note @p transit can not be NULL
7341 * @param transit The transit object.
7343 * @return The time progression value. If @p transit is NULL
7348 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7351 * Makes the chain relationship between two transits.
7353 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7354 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7356 * @param transit The transit object.
7357 * @param chain_transit The chain transit object. This transit will be operated
7358 * after transit is done.
7360 * This function adds @p chain_transit transition to a chain after the @p
7361 * transit, and will be started as soon as @p transit ends. See @ref
7362 * transit_example_02_explained for a full example.
7366 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7369 * Cut off the chain relationship between two transits.
7371 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7372 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7374 * @param transit The transit object.
7375 * @param chain_transit The chain transit object.
7377 * This function remove the @p chain_transit transition from the @p transit.
7381 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7384 * Get the current chain transit list.
7386 * @note @p transit can not be NULL.
7388 * @param transit The transit object.
7389 * @return chain transit list.
7393 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7396 * Add the Resizing Effect to Elm_Transit.
7398 * @note This API is one of the facades. It creates resizing effect context
7399 * and add it's required APIs to elm_transit_effect_add.
7401 * @see elm_transit_effect_add()
7403 * @param transit Transit object.
7404 * @param from_w Object width size when effect begins.
7405 * @param from_h Object height size when effect begins.
7406 * @param to_w Object width size when effect ends.
7407 * @param to_h Object height size when effect ends.
7408 * @return Resizing effect context data.
7412 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);
7415 * Add the Translation Effect to Elm_Transit.
7417 * @note This API is one of the facades. It creates translation effect context
7418 * and add it's required APIs to elm_transit_effect_add.
7420 * @see elm_transit_effect_add()
7422 * @param transit Transit object.
7423 * @param from_dx X Position variation when effect begins.
7424 * @param from_dy Y Position variation when effect begins.
7425 * @param to_dx X Position variation when effect ends.
7426 * @param to_dy Y Position variation when effect ends.
7427 * @return Translation effect context data.
7430 * @warning It is highly recommended just create a transit with this effect when
7431 * the window that the objects of the transit belongs has already been created.
7432 * This is because this effect needs the geometry information about the objects,
7433 * and if the window was not created yet, it can get a wrong information.
7435 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);
7438 * Add the Zoom Effect to Elm_Transit.
7440 * @note This API is one of the facades. It creates zoom effect context
7441 * and add it's required APIs to elm_transit_effect_add.
7443 * @see elm_transit_effect_add()
7445 * @param transit Transit object.
7446 * @param from_rate Scale rate when effect begins (1 is current rate).
7447 * @param to_rate Scale rate when effect ends.
7448 * @return Zoom effect context data.
7451 * @warning It is highly recommended just create a transit with this effect when
7452 * the window that the objects of the transit belongs has already been created.
7453 * This is because this effect needs the geometry information about the objects,
7454 * and if the window was not created yet, it can get a wrong information.
7456 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7459 * Add the Flip Effect to Elm_Transit.
7461 * @note This API is one of the facades. It creates flip effect context
7462 * and add it's required APIs to elm_transit_effect_add.
7463 * @note This effect is applied to each pair of objects in the order they are listed
7464 * in the transit list of objects. The first object in the pair will be the
7465 * "front" object and the second will be the "back" object.
7467 * @see elm_transit_effect_add()
7469 * @param transit Transit object.
7470 * @param axis Flipping Axis(X or Y).
7471 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7472 * @return Flip effect context data.
7475 * @warning It is highly recommended just create a transit with this effect when
7476 * the window that the objects of the transit belongs has already been created.
7477 * This is because this effect needs the geometry information about the objects,
7478 * and if the window was not created yet, it can get a wrong information.
7480 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7483 * Add the Resizable Flip Effect to Elm_Transit.
7485 * @note This API is one of the facades. It creates resizable flip effect context
7486 * and add it's required APIs to elm_transit_effect_add.
7487 * @note This effect is applied to each pair of objects in the order they are listed
7488 * in the transit list of objects. The first object in the pair will be the
7489 * "front" object and the second will be the "back" object.
7491 * @see elm_transit_effect_add()
7493 * @param transit Transit object.
7494 * @param axis Flipping Axis(X or Y).
7495 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7496 * @return Resizable flip effect context data.
7499 * @warning It is highly recommended just create a transit with this effect when
7500 * the window that the objects of the transit belongs has already been created.
7501 * This is because this effect needs the geometry information about the objects,
7502 * and if the window was not created yet, it can get a wrong information.
7504 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7507 * Add the Wipe Effect to Elm_Transit.
7509 * @note This API is one of the facades. It creates wipe effect context
7510 * and add it's required APIs to elm_transit_effect_add.
7512 * @see elm_transit_effect_add()
7514 * @param transit Transit object.
7515 * @param type Wipe type. Hide or show.
7516 * @param dir Wipe Direction.
7517 * @return Wipe effect context data.
7520 * @warning It is highly recommended just create a transit with this effect when
7521 * the window that the objects of the transit belongs has already been created.
7522 * This is because this effect needs the geometry information about the objects,
7523 * and if the window was not created yet, it can get a wrong information.
7525 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7528 * Add the Color Effect to Elm_Transit.
7530 * @note This API is one of the facades. It creates color effect context
7531 * and add it's required APIs to elm_transit_effect_add.
7533 * @see elm_transit_effect_add()
7535 * @param transit Transit object.
7536 * @param from_r RGB R when effect begins.
7537 * @param from_g RGB G when effect begins.
7538 * @param from_b RGB B when effect begins.
7539 * @param from_a RGB A when effect begins.
7540 * @param to_r RGB R when effect ends.
7541 * @param to_g RGB G when effect ends.
7542 * @param to_b RGB B when effect ends.
7543 * @param to_a RGB A when effect ends.
7544 * @return Color effect context data.
7548 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);
7551 * Add the Fade Effect to Elm_Transit.
7553 * @note This API is one of the facades. It creates fade effect context
7554 * and add it's required APIs to elm_transit_effect_add.
7555 * @note This effect is applied to each pair of objects in the order they are listed
7556 * in the transit list of objects. The first object in the pair will be the
7557 * "before" object and the second will be the "after" object.
7559 * @see elm_transit_effect_add()
7561 * @param transit Transit object.
7562 * @return Fade effect context data.
7565 * @warning It is highly recommended just create a transit with this effect when
7566 * the window that the objects of the transit belongs has already been created.
7567 * This is because this effect needs the color information about the objects,
7568 * and if the window was not created yet, it can get a wrong information.
7570 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7573 * Add the Blend Effect to Elm_Transit.
7575 * @note This API is one of the facades. It creates blend effect context
7576 * and add it's required APIs to elm_transit_effect_add.
7577 * @note This effect is applied to each pair of objects in the order they are listed
7578 * in the transit list of objects. The first object in the pair will be the
7579 * "before" object and the second will be the "after" object.
7581 * @see elm_transit_effect_add()
7583 * @param transit Transit object.
7584 * @return Blend effect context data.
7587 * @warning It is highly recommended just create a transit with this effect when
7588 * the window that the objects of the transit belongs has already been created.
7589 * This is because this effect needs the color information about the objects,
7590 * and if the window was not created yet, it can get a wrong information.
7592 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7595 * Add the Rotation Effect to Elm_Transit.
7597 * @note This API is one of the facades. It creates rotation effect context
7598 * and add it's required APIs to elm_transit_effect_add.
7600 * @see elm_transit_effect_add()
7602 * @param transit Transit object.
7603 * @param from_degree Degree when effect begins.
7604 * @param to_degree Degree when effect is ends.
7605 * @return Rotation effect context data.
7608 * @warning It is highly recommended just create a transit with this effect when
7609 * the window that the objects of the transit belongs has already been created.
7610 * This is because this effect needs the geometry information about the objects,
7611 * and if the window was not created yet, it can get a wrong information.
7613 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7616 * Add the ImageAnimation Effect to Elm_Transit.
7618 * @note This API is one of the facades. It creates image animation effect context
7619 * and add it's required APIs to elm_transit_effect_add.
7620 * The @p images parameter is a list images paths. This list and
7621 * its contents will be deleted at the end of the effect by
7622 * elm_transit_effect_image_animation_context_free() function.
7626 * char buf[PATH_MAX];
7627 * Eina_List *images = NULL;
7628 * Elm_Transit *transi = elm_transit_add();
7630 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7631 * images = eina_list_append(images, eina_stringshare_add(buf));
7633 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7634 * images = eina_list_append(images, eina_stringshare_add(buf));
7635 * elm_transit_effect_image_animation_add(transi, images);
7639 * @see elm_transit_effect_add()
7641 * @param transit Transit object.
7642 * @param images Eina_List of images file paths. This list and
7643 * its contents will be deleted at the end of the effect by
7644 * elm_transit_effect_image_animation_context_free() function.
7645 * @return Image Animation effect context data.
7649 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7655 typedef struct _Elm_Store Elm_Store;
7656 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
7657 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
7658 typedef struct _Elm_Store_Item Elm_Store_Item;
7659 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
7660 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
7661 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
7662 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
7663 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
7664 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
7665 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
7666 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
7667 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
7669 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
7670 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7671 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7672 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
7673 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
7674 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
7675 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
7679 ELM_STORE_ITEM_MAPPING_NONE = 0,
7680 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
7681 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
7682 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
7683 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
7684 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
7685 // can add more here as needed by common apps
7686 ELM_STORE_ITEM_MAPPING_LAST
7687 } Elm_Store_Item_Mapping_Type;
7689 struct _Elm_Store_Item_Mapping_Icon
7691 // FIXME: allow edje file icons
7693 Elm_Icon_Lookup_Order lookup_order;
7694 Eina_Bool standard_name : 1;
7695 Eina_Bool no_scale : 1;
7696 Eina_Bool smooth : 1;
7697 Eina_Bool scale_up : 1;
7698 Eina_Bool scale_down : 1;
7701 struct _Elm_Store_Item_Mapping_Empty
7706 struct _Elm_Store_Item_Mapping_Photo
7711 struct _Elm_Store_Item_Mapping_Custom
7713 Elm_Store_Item_Mapping_Cb func;
7716 struct _Elm_Store_Item_Mapping
7718 Elm_Store_Item_Mapping_Type type;
7722 Elm_Store_Item_Mapping_Empty empty;
7723 Elm_Store_Item_Mapping_Icon icon;
7724 Elm_Store_Item_Mapping_Photo photo;
7725 Elm_Store_Item_Mapping_Custom custom;
7726 // add more types here
7730 struct _Elm_Store_Item_Info
7736 int pre_group_index;
7738 Elm_Genlist_Item_Class *item_class;
7739 const Elm_Store_Item_Mapping *mapping;
7744 struct _Elm_Store_Item_Info_Filesystem
7746 Elm_Store_Item_Info base;
7750 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
7751 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
7753 EAPI Elm_Store *elm_store_dbsystem_new(void);
7754 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
7755 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
7756 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
7757 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
7758 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7759 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7760 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
7761 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7762 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
7763 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7764 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
7765 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7766 EAPI void elm_store_free(Elm_Store *st);
7767 EAPI Elm_Store *elm_store_filesystem_new(void);
7768 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
7769 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7770 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7771 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
7772 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
7773 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7774 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7775 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7776 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
7777 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7778 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7779 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
7780 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7781 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
7782 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7783 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7784 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7786 /* SegmentControl */
7787 typedef struct _Elm_Segment_Item Elm_Segment_Item;
7788 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7789 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
7790 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);
7791 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7792 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7793 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7794 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7795 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7796 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
7797 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7798 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
7799 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7800 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7801 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7802 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
7803 /* smart callbacks called:
7804 * "changed" -when the user clicks on a segment item which is not previously
7805 * selected and get selected. The event_info parameter is the
7806 * segment item index.
7809 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
7810 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
7811 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
7812 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
7813 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
7814 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
7815 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
7816 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
7818 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
7819 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
7821 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
7822 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
7823 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
7824 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
7825 EAPI void elm_video_play(Evas_Object *video);
7826 EAPI void elm_video_pause(Evas_Object *video);
7827 EAPI void elm_video_stop(Evas_Object *video);
7828 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
7829 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
7830 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
7831 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
7832 EAPI double elm_video_audio_level_get(Evas_Object *video);
7833 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
7834 EAPI double elm_video_play_position_get(Evas_Object *video);
7835 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
7836 EAPI double elm_video_play_length_get(Evas_Object *video);
7837 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
7838 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
7839 EAPI const char *elm_video_title_get(Evas_Object *video);
7841 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
7842 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
7844 // FIXME: incomplete - carousel. don't use this until this comment is removed
7845 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
7846 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
7847 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
7848 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
7849 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
7850 /* smart callbacks called:
7851 * "clicked" - when the user clicks on a carousel item and becomes selected
7855 typedef enum _Elm_Datefield_Layout
7857 ELM_DATEFIELD_LAYOUT_TIME,
7858 ELM_DATEFIELD_LAYOUT_DATE,
7859 ELM_DATEFIELD_LAYOUT_DATEANDTIME
7860 } Elm_Datefield_Layout;
7862 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
7863 EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
7864 EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
7865 EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
7866 EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
7867 EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
7868 EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
7869 EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
7870 EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
7871 EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
7872 EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
7873 EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
7874 EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
7875 EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
7876 EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
7877 /* smart callbacks called:
7878 * "changed" - when datefield entry is changed, this signal is sent.
7882 typedef enum _Elm_Popup_Response
7884 ELM_POPUP_RESPONSE_NONE = -1,
7885 ELM_POPUP_RESPONSE_TIMEOUT = -2,
7886 ELM_POPUP_RESPONSE_OK = -3,
7887 ELM_POPUP_RESPONSE_CANCEL = -4,
7888 ELM_POPUP_RESPONSE_CLOSE = -5
7889 } Elm_Popup_Response;
7891 typedef enum _Elm_Popup_Mode
7893 ELM_POPUP_TYPE_NONE = 0,
7894 ELM_POPUP_TYPE_ALERT = (1 << 0)
7897 typedef enum _Elm_Popup_Orient
7899 ELM_POPUP_ORIENT_TOP,
7900 ELM_POPUP_ORIENT_CENTER,
7901 ELM_POPUP_ORIENT_BOTTOM,
7902 ELM_POPUP_ORIENT_LEFT,
7903 ELM_POPUP_ORIENT_RIGHT,
7904 ELM_POPUP_ORIENT_TOP_LEFT,
7905 ELM_POPUP_ORIENT_TOP_RIGHT,
7906 ELM_POPUP_ORIENT_BOTTOM_LEFT,
7907 ELM_POPUP_ORIENT_BOTTOM_RIGHT
7910 /* smart callbacks called:
7911 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
7914 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
7915 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
7916 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
7917 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
7918 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
7919 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
7920 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
7921 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
7922 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
7923 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
7924 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
7925 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
7926 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
7927 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
7928 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
7929 EAPI int elm_popup_run(Evas_Object *obj);
7932 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
7933 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
7937 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
7938 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
7939 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
7940 ELM_NAVIGATIONBAR_BACK_BUTTON
7941 } Elm_Navi_Button_Type;
7943 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
7944 EAPI void elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
7945 EAPI void elm_navigationbar_pop(Evas_Object *obj);
7946 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
7947 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
7948 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
7949 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
7950 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
7951 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
7952 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
7953 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
7954 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
7955 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
7956 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
7957 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
7958 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
7959 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
7960 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
7961 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
7962 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
7963 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
7964 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
7967 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
7968 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
7972 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
7973 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
7974 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
7975 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
7976 ELM_NAVIGATIONBAR_EX_MAX
7977 } Elm_Navi_ex_Button_Type;
7978 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
7980 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
7981 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
7982 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
7983 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
7984 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
7985 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
7986 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
7987 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
7988 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
7989 EAPI void elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
7990 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
7991 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
7992 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
7993 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
7994 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
7995 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
7996 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
7997 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
7998 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
7999 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8000 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8001 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8002 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8003 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8004 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8005 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8006 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8007 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8011 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8012 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8013 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8014 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8015 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8016 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8017 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8018 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8019 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8021 typedef enum _Elm_Controlbar_Mode_Type
8023 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8024 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8025 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8026 ELM_CONTROLBAR_MODE_LARGE,
8027 ELM_CONTROLBAR_MODE_SMALL,
8028 ELM_CONTROLBAR_MODE_LEFT,
8029 ELM_CONTROLBAR_MODE_RIGHT
8030 } Elm_Controlbar_Mode_Type;
8032 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8033 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8034 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8035 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8036 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
8037 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
8038 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8039 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8040 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8041 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8042 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8043 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8044 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8045 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8046 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8047 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8048 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8049 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8050 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8051 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8052 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8053 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8054 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8055 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8056 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8057 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8058 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8059 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8060 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8061 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8062 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8063 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8064 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8065 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8066 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8067 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8068 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8069 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8070 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8073 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8074 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8075 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8076 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8077 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
8078 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8079 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8080 EAPI void elm_searchbar_clear(Evas_Object *obj);
8081 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
8083 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
8084 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
8085 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
8086 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
8089 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
8090 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
8091 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
8092 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
8093 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
8098 ELM_TICKERNOTI_DEFAULT,
8099 ELM_TICKERNOTI_DETAILVIEW
8100 } Elm_Tickernoti_Mode;
8104 ELM_TICKERNOTI_ORIENT_TOP,
8105 ELM_TICKERNOTI_ORIENT_BOTTOM
8106 } Elm_Tickernoti_Orient;
8108 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
8109 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8110 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8111 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8112 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8113 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
8114 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8115 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8116 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8117 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8118 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
8119 /* #### Below APIs are going to be deprecated, announcment will be made soon ####*/
8120 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8121 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8122 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
8123 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
8124 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8125 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8126 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8127 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8128 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
8129 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8130 /* ############################################################################### */
8133 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
8135 struct _Colorpalette_Color
8137 unsigned int r, g, b;
8140 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
8141 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
8142 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
8143 /* smart callbacks called:
8144 * "clicked" - when image clicked
8148 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
8149 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
8150 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
8151 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
8152 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
8153 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
8154 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
8155 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
8156 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
8157 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
8158 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
8159 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
8160 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
8161 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
8162 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
8163 /* smart callbacks called:
8164 * "clicked" - when an editfield is clicked
8165 * "unfocused" - when an editfield is unfocused
8169 /* Sliding Drawer */
8170 typedef enum _Elm_SlidingDrawer_Pos
8172 ELM_SLIDINGDRAWER_BOTTOM,
8173 ELM_SLIDINGDRAWER_LEFT,
8174 ELM_SLIDINGDRAWER_RIGHT,
8175 ELM_SLIDINGDRAWER_TOP
8176 } Elm_SlidingDrawer_Pos;
8178 typedef struct _Elm_SlidingDrawer_Drag_Value
8181 } Elm_SlidingDrawer_Drag_Value;
8183 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
8184 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
8185 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
8186 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
8187 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
8188 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
8190 /* multibuttonentry */
8191 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
8192 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
8193 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
8194 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
8195 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
8196 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
8197 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
8198 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
8199 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
8200 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
8201 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
8202 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
8203 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
8204 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
8205 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
8206 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
8207 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
8208 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
8209 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
8210 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
8211 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
8212 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
8213 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
8214 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
8215 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
8216 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
8217 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
8218 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
8219 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
8220 /* smart callback called:
8221 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8222 * "added" - This signal is emitted when a new multibuttonentry item is added.
8223 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
8224 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
8225 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
8226 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
8227 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8228 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
8229 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
8230 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
8231 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
8232 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
8234 /* available styles:
8239 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
8240 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
8241 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
8242 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
8243 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
8244 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
8245 /* smart callback called:
8246 * "expanded" - This signal is emitted when a stackedicon is expanded.
8247 * "clicked" - This signal is emitted when a stackedicon is clicked.
8249 /* available styles:
8254 typedef struct _Dialogue_Item Dialogue_Item;
8256 typedef enum _Elm_Dialoguegourp_Item_Style
8258 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
8259 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
8260 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
8261 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
8262 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
8263 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
8264 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
8265 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
8266 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
8267 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
8268 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
8269 } Elm_Dialoguegroup_Item_Style;
8271 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
8272 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8273 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8274 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
8275 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
8276 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
8277 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
8278 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
8279 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
8280 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
8281 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
8282 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
8283 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
8284 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
8285 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
8286 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
8291 ELM_DAYSELECTOR_SUN,
8292 ELM_DAYSELECTOR_MON,
8293 ELM_DAYSELECTOR_TUE,
8294 ELM_DAYSELECTOR_WED,
8295 ELM_DAYSELECTOR_THU,
8296 ELM_DAYSELECTOR_FRI,
8298 } Elm_DaySelector_Day;
8300 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
8301 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
8302 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
8305 typedef struct _Imageslider_Item Elm_Imageslider_Item;
8306 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
8307 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8308 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
8309 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
8310 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
8311 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8312 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8313 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8314 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8315 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8316 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8317 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8318 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8319 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8320 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
8321 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);