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);
1090 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1091 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1092 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1093 EAPI double elm_scroll_bounce_friction_get(void);
1094 EAPI void elm_scroll_bounce_friction_set(double friction);
1095 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1096 EAPI double elm_scroll_page_scroll_friction_get(void);
1097 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1098 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1099 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1100 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1101 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1102 EAPI double elm_scroll_zoom_friction_get(void);
1103 EAPI void elm_scroll_zoom_friction_set(double friction);
1104 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1105 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1106 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1107 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1108 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1109 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1110 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1111 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1112 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1113 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1114 EAPI double elm_scroll_thumbscroll_friction_get(void);
1115 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1116 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1117 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1118 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1119 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1121 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1122 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1123 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1124 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1125 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1126 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1127 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1128 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1130 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1131 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
1132 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
1134 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1135 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1138 * Adjust size of an element for finger usage.
1140 * @param times_w How many fingers should fit horizontally
1141 * @param w Pointer to the width size to adjust
1142 * @param times_h How many fingers should fit vertically
1143 * @param h Pointer to the height size to adjust
1145 * This takes width and height sizes (in pixels) as input and a
1146 * size multiple (which is how many fingers you want to place
1147 * within the area, being "finger" the size set by
1148 * elm_finger_size_set()), and adjusts the size to be large enough
1149 * to accommodate the resulting size -- if it doesn't already
1150 * accommodate it. On return the @p w and @p h sizes pointed to by
1151 * these parameters will be modified, on those conditions.
1153 * @note This is kind of a low level Elementary call, most useful
1154 * on size evaluation times for widgets. An external user wouldn't
1155 * be calling, most of the time.
1159 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1161 EAPI double elm_longpress_timeout_get(void);
1162 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1165 * don't use it unless you are sure
1167 EAPI void elm_object_tree_dump(const Evas_Object *top);
1168 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1170 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1171 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1176 * @defgroup Theme Theme
1178 * Elementary uses Edje to theme its widgets, naturally. But for the most
1179 * part this is hidden behind a simpler interface that lets the user set
1180 * extensions and choose the style of widgets in a much easier way.
1182 * Instead of thinking in terms of paths to Edje files and their groups
1183 * each time you want to change the appearance of a widget, Elementary
1184 * works so you can add any theme file with extensions or replace the
1185 * main theme at one point in the application, and then just set the style
1186 * of widgets with elm_object_style_set() and related functions. Elementary
1187 * will then look in its list of themes for a matching group and apply it,
1188 * and when the theme changes midway through the application, all widgets
1189 * will be updated accordingly.
1191 * There are three concepts you need to know to understand how Elementary
1192 * theming works: default theme, extensions and overlays.
1194 * Default theme, obviously enough, is the one that provides the default
1195 * look of all widgets. End users can change the theme used by Elementary
1196 * by setting the @c ELM_THEME environment variable before running an
1197 * application, or globally for all programs using the @c elementary_config
1198 * utility. Applications can change the default theme using elm_theme_set(),
1199 * but this can go against the user wishes, so it's not an adviced practice.
1201 * Ideally, applications should find everything they need in the already
1202 * provided theme, but there may be occasions when that's not enough and
1203 * custom styles are required to correctly express the idea. For this
1204 * cases, Elementary has extensions.
1206 * Extensions allow the application developer to write styles of its own
1207 * to apply to some widgets. This requires knowledge of how each widget
1208 * is themed, as extensions will always replace the entire group used by
1209 * the widget, so important signals and parts need to be there for the
1210 * object to behave properly (see documentation of Edje for details).
1211 * Once the theme for the extension is done, the application needs to add
1212 * it to the list of themes Elementary will look into, using
1213 * elm_theme_extension_add(), and set the style of the desired widgets as
1214 * he would normally with elm_object_style_set().
1216 * Overlays, on the other hand, can replace the look of all widgets by
1217 * overriding the default style. Like extensions, it's up to the application
1218 * developer to write the theme for the widgets it wants, the difference
1219 * being that when looking for the theme, Elementary will check first the
1220 * list of overlays, then the set theme and lastly the list of extensions,
1221 * so with overlays it's possible to replace the default view and every
1222 * widget will be affected. This is very much alike to setting the whole
1223 * theme for the application and will probably clash with the end user
1224 * options, not to mention the risk of ending up with not matching styles
1225 * across the program. Unless there's a very special reason to use them,
1226 * overlays should be avoided for the resons exposed before.
1228 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1229 * keeps one default internally and every function that receives one of
1230 * these can be called with NULL to refer to this default (except for
1231 * elm_theme_free()). It's possible to create a new instance of a
1232 * ::Elm_Theme to set other theme for a specific widget (and all of its
1233 * children), but this is as discouraged, if not even more so, than using
1234 * overlays. Don't use this unless you really know what you are doing.
1236 * But to be less negative about things, you can look at the following
1238 * @li @ref theme_example_01 "Using extensions"
1239 * @li @ref theme_example_02 "Using overlays"
1244 * @typedef Elm_Theme
1246 * Opaque handler for the list of themes Elementary looks for when
1247 * rendering widgets.
1249 * Stay out of this unless you really know what you are doing. For most
1250 * cases, sticking to the default is all a developer needs.
1252 typedef struct _Elm_Theme Elm_Theme;
1255 * Create a new specific theme
1257 * This creates an empty specific theme that only uses the default theme. A
1258 * specific theme has its own private set of extensions and overlays too
1259 * (which are empty by default). Specific themes do not fall back to themes
1260 * of parent objects. They are not intended for this use. Use styles, overlays
1261 * and extensions when needed, but avoid specific themes unless there is no
1262 * other way (example: you want to have a preview of a new theme you are
1263 * selecting in a "theme selector" window. The preview is inside a scroller
1264 * and should display what the theme you selected will look like, but not
1265 * actually apply it yet. The child of the scroller will have a specific
1266 * theme set to show this preview before the user decides to apply it to all
1269 EAPI Elm_Theme *elm_theme_new(void);
1271 * Free a specific theme
1273 * @param th The theme to free
1275 * This frees a theme created with elm_theme_new().
1277 EAPI void elm_theme_free(Elm_Theme *th);
1279 * Copy the theme fom the source to the destination theme
1281 * @param th The source theme to copy from
1282 * @param thdst The destination theme to copy data to
1284 * This makes a one-time static copy of all the theme config, extensions
1285 * and overlays from @p th to @p thdst. If @p th references a theme, then
1286 * @p thdst is also set to reference it, with all the theme settings,
1287 * overlays and extensions that @p th had.
1289 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1291 * Tell the source theme to reference the ref theme
1293 * @param th The theme that will do the referencing
1294 * @param thref The theme that is the reference source
1296 * This clears @p th to be empty and then sets it to refer to @p thref
1297 * so @p th acts as an override to @p thref, but where its overrides
1298 * don't apply, it will fall through to @pthref for configuration.
1300 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1302 * Return the theme referred to
1304 * @param th The theme to get the reference from
1305 * @return The referenced theme handle
1307 * This gets the theme set as the reference theme by elm_theme_ref_set().
1308 * If no theme is set as a reference, NULL is returned.
1310 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1312 * Return the default theme
1314 * @return The default theme handle
1316 * This returns the internal default theme setup handle that all widgets
1317 * use implicitly unless a specific theme is set. This is also often use
1318 * as a shorthand of NULL.
1320 EAPI Elm_Theme *elm_theme_default_get(void);
1322 * Prepends a theme overlay to the list of overlays
1324 * @param th The theme to add to, or if NULL, the default theme
1325 * @param item The Edje file path to be used
1327 * Use this if your application needs to provide some custom overlay theme
1328 * (An Edje file that replaces some default styles of widgets) where adding
1329 * new styles, or changing system theme configuration is not possible. Do
1330 * NOT use this instead of a proper system theme configuration. Use proper
1331 * configuration files, profiles, environment variables etc. to set a theme
1332 * so that the theme can be altered by simple confiugration by a user. Using
1333 * this call to achieve that effect is abusing the API and will create lots
1336 * @see elm_theme_extension_add()
1338 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1340 * Delete a theme overlay from the list of overlays
1342 * @param th The theme to delete from, or if NULL, the default theme
1343 * @param item The name of the theme overlay
1345 * @see elm_theme_overlay_add()
1347 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1349 * Appends a theme extension to the list of extensions.
1351 * @param th The theme to add to, or if NULL, the default theme
1352 * @param item The Edje file path to be used
1354 * This is intended when an application needs more styles of widgets or new
1355 * widget themes that the default does not provide (or may not provide). The
1356 * application has "extended" usage by coming up with new custom style names
1357 * for widgets for specific uses, but as these are not "standard", they are
1358 * not guaranteed to be provided by a default theme. This means the
1359 * application is required to provide these extra elements itself in specific
1360 * Edje files. This call adds one of those Edje files to the theme search
1361 * path to be search after the default theme. The use of this call is
1362 * encouraged when default styles do not meet the needs of the application.
1363 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1365 * @see elm_object_style_set()
1367 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1369 * Deletes a theme extension from the list of extensions.
1371 * @param th The theme to delete from, or if NULL, the default theme
1372 * @param item The name of the theme extension
1374 * @see elm_theme_extension_add()
1376 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1378 * Set the theme search order for the given theme
1380 * @param th The theme to set the search order, or if NULL, the default theme
1381 * @param theme Theme search string
1383 * This sets the search string for the theme in path-notation from first
1384 * theme to search, to last, delimited by the : character. Example:
1386 * "shiny:/path/to/file.edj:default"
1388 * See the ELM_THEME environment variable for more information.
1390 * @see elm_theme_get()
1391 * @see elm_theme_list_get()
1393 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1395 * Return the theme search order
1397 * @param th The theme to get the search order, or if NULL, the default theme
1398 * @return The internal search order path
1400 * This function returns a colon separated string of theme elements as
1401 * returned by elm_theme_list_get().
1403 * @see elm_theme_set()
1404 * @see elm_theme_list_get()
1406 EAPI const char *elm_theme_get(Elm_Theme *th);
1408 * Return a list of theme elements to be used in a theme.
1410 * @param th Theme to get the list of theme elements from.
1411 * @return The internal list of theme elements
1413 * This returns the internal list of theme elements (will only be valid as
1414 * long as the theme is not modified by elm_theme_set() or theme is not
1415 * freed by elm_theme_free(). This is a list of strings which must not be
1416 * altered as they are also internal. If @p th is NULL, then the default
1417 * theme element list is returned.
1419 * A theme element can consist of a full or relative path to a .edj file,
1420 * or a name, without extension, for a theme to be searched in the known
1421 * theme paths for Elemementary.
1423 * @see elm_theme_set()
1424 * @see elm_theme_get()
1426 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1428 * Return the full patrh for a theme element
1430 * @param f The theme element name
1431 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1432 * @return The full path to the file found.
1434 * This returns a string you should free with free() on success, NULL on
1435 * failure. This will search for the given theme element, and if it is a
1436 * full or relative path element or a simple searchable name. The returned
1437 * path is the full path to the file, if searched, and the file exists, or it
1438 * is simply the full path given in the element or a resolved path if
1439 * relative to home. The @p in_search_path boolean pointed to is set to
1440 * EINA_TRUE if the file was a searchable file andis in the search path,
1441 * and EINA_FALSE otherwise.
1443 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1445 * Flush the current theme.
1447 * @param th Theme to flush
1449 * This flushes caches that let elementary know where to find theme elements
1450 * in the given theme. If @p th is NULL, then the default theme is flushed.
1451 * Call this function if source theme data has changed in such a way as to
1452 * make any caches Elementary kept invalid.
1454 EAPI void elm_theme_flush(Elm_Theme *th);
1456 * This flushes all themes (default and specific ones).
1458 * This will flush all themes in the current application context, by calling
1459 * elm_theme_flush() on each of them.
1461 EAPI void elm_theme_full_flush(void);
1463 * Set the theme for all elementary using applications on the current display
1465 * @param theme The name of the theme to use. Format same as the ELM_THEME
1466 * environment variable.
1468 EAPI void elm_theme_all_set(const char *theme);
1470 * Return a list of theme elements in the theme search path
1472 * @return A list of strings that are the theme element names.
1474 * This lists all available theme files in the standard Elementary search path
1475 * for theme elements, and returns them in alphabetical order as theme
1476 * element names in a list of strings. Free this with
1477 * elm_theme_name_available_list_free() when you are done with the list.
1479 EAPI Eina_List *elm_theme_name_available_list_new(void);
1481 * Free the list returned by elm_theme_name_available_list_new()
1483 * This frees the list of themes returned by
1484 * elm_theme_name_available_list_new(). Once freed the list should no longer
1485 * be used. a new list mys be created.
1487 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1489 * Set a specific theme to be used for this object and its children
1491 * @param obj The object to set the theme on
1492 * @param th The theme to set
1494 * This sets a specific theme that will be used for the given object and any
1495 * child objects it has. If @p th is NULL then the theme to be used is
1496 * cleared and the object will inherit its theme from its parent (which
1497 * ultimately will use the default theme if no specific themes are set).
1499 * Use special themes with great care as this will annoy users and make
1500 * configuration difficult. Avoid any custom themes at all if it can be
1503 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1505 * Get the specific theme to be used
1507 * @param obj The object to get the specific theme from
1508 * @return The specifc theme set.
1510 * This will return a specific theme set, or NULL if no specific theme is
1511 * set on that object. It will not return inherited themes from parents, only
1512 * the specific theme set for that specific object. See elm_object_theme_set()
1513 * for more information.
1515 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1521 typedef enum _Elm_Win_Type
1524 ELM_WIN_DIALOG_BASIC,
1531 ELM_WIN_DROPDOWN_MENU,
1534 ELM_WIN_NOTIFICATION,
1537 ELM_WIN_INLINED_IMAGE,
1540 typedef enum _Elm_Win_Keyboard_Mode
1542 ELM_WIN_KEYBOARD_UNKNOWN,
1543 ELM_WIN_KEYBOARD_OFF,
1544 ELM_WIN_KEYBOARD_ON,
1545 ELM_WIN_KEYBOARD_ALPHA,
1546 ELM_WIN_KEYBOARD_NUMERIC,
1547 ELM_WIN_KEYBOARD_PIN,
1548 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1549 ELM_WIN_KEYBOARD_HEX,
1550 ELM_WIN_KEYBOARD_TERMINAL,
1551 ELM_WIN_KEYBOARD_PASSWORD,
1552 ELM_WIN_KEYBOARD_IP,
1553 ELM_WIN_KEYBOARD_HOST,
1554 ELM_WIN_KEYBOARD_FILE,
1555 ELM_WIN_KEYBOARD_URL,
1556 ELM_WIN_KEYBOARD_KEYPAD,
1557 ELM_WIN_KEYBOARD_J2ME
1558 } Elm_Win_Keyboard_Mode;
1560 typedef enum _Elm_Illume_Command
1562 ELM_ILLUME_COMMAND_FOCUS_BACK,
1563 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1564 ELM_ILLUME_COMMAND_FOCUS_HOME,
1565 ELM_ILLUME_COMMAND_CLOSE
1566 } Elm_Illume_Command;
1568 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1569 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1570 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1571 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1572 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1573 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1574 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1575 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1576 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1577 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1578 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1579 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1580 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1581 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1582 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1583 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1584 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1585 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1586 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1587 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1588 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1589 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1590 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1591 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1592 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1593 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1594 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1595 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1596 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1597 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1598 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1599 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1600 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1601 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1602 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1603 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1604 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1605 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1606 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1607 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1608 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1609 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1610 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1611 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1612 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1613 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1614 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1615 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1616 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1617 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1618 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1619 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
1621 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1622 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1623 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1624 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1625 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1626 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1627 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1629 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1630 * (blank mouse, private mouse obj, defaultmouse)
1633 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1634 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1636 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1638 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1640 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1641 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1642 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1643 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1644 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1645 /* available styles:
1650 /* X specific calls - won't work on non-x engines (return 0) */
1651 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1652 /* smart callbacks called:
1653 * "delete,request" - the user requested to delete the window
1654 * "focus,in" - window got focus
1655 * "focus,out" - window lost focus
1656 * "moved" - window that holds the canvas was moved
1662 * @brief Background object, used for setting a solid color, image or Edje
1663 * group as background to a window or any container object.
1665 * The bg object is used for setting a solid background to a window or
1666 * packing into any container object. It works just like an image, but has
1667 * some properties useful to a background, like setting it to tiled,
1668 * centered, scaled or stretched.
1670 * Here is some sample code using it:
1671 * @li @ref bg_01_example_page
1672 * @li @ref bg_02_example_page
1673 * @li @ref bg_03_example_page
1677 typedef enum _Elm_Bg_Option
1679 ELM_BG_OPTION_CENTER, /**< center the background */
1680 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1681 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1682 ELM_BG_OPTION_TILE /**< tile background at its original size */
1686 * Add a new background to the parent
1688 * @param parent The parent object
1689 * @return The new object or NULL if it cannot be created
1693 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1696 * Set the file (image or edje) used for the background
1698 * @param obj The bg object
1699 * @param file The file path
1700 * @param group Optional key (group in Edje) within the file
1702 * This sets the image file used in the background object. The image (or edje)
1703 * will be stretched (retaining aspect if its an image file) to completely fill
1704 * the bg object. This may mean some parts are not visible.
1706 * @note Once the image of @p obj is set, a previously set one will be deleted,
1707 * even if @p file is NULL.
1711 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1714 * Get the file (image or edje) used for the background
1716 * @param obj The bg object
1717 * @param file The file path
1718 * @param group Optional key (group in Edje) within the file
1722 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1725 * Set the option used for the background image
1727 * @param obj The bg object
1728 * @param option The desired background option (TILE, SCALE)
1730 * This sets the option used for manipulating the display of the background
1731 * image. The image can be tiled or scaled.
1735 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1738 * Get the option used for the background image
1740 * @param obj The bg object
1741 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1745 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1747 * Set the option used for the background color
1749 * @param obj The bg object
1754 * This sets the color used for the background rectangle. Its range goes
1759 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1761 * Get the option used for the background color
1763 * @param obj The bg object
1770 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1773 * Set the overlay object used for the background object.
1775 * @param obj The bg object
1776 * @param overlay The overlay object
1778 * This provides a way for elm_bg to have an 'overlay' that will be on top
1779 * of the bg. Once the over object is set, a previously set one will be
1780 * deleted, even if you set the new one to NULL. If you want to keep that
1781 * old content object, use the elm_bg_overlay_unset() function.
1786 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1789 * Get the overlay object used for the background object.
1791 * @param obj The bg object
1792 * @return The content that is being used
1794 * Return the content object which is set for this widget
1798 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1801 * Get the overlay object used for the background object.
1803 * @param obj The bg object
1804 * @return The content that was being used
1806 * Unparent and return the overlay object which was set for this widget
1810 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1813 * Set the size of the pixmap representation of the image.
1815 * This option just makes sense if an image is going to be set in the bg.
1817 * @param obj The bg object
1818 * @param w The new width of the image pixmap representation.
1819 * @param h The new height of the image pixmap representation.
1821 * This function sets a new size for pixmap representation of the given bg
1822 * image. It allows the image to be loaded already in the specified size,
1823 * reducing the memory usage and load time when loading a big image with load
1824 * size set to a smaller size.
1826 * NOTE: this is just a hint, the real size of the pixmap may differ
1827 * depending on the type of image being loaded, being bigger than requested.
1831 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1832 /* smart callbacks called:
1836 typedef enum _Elm_Icon_Lookup_Order
1838 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1839 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1840 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1841 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1842 } Elm_Icon_Lookup_Order;
1844 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1845 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1846 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1847 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1848 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1849 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1850 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1851 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1852 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1853 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1854 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1855 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1856 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1857 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1858 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1859 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1860 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
1861 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1862 /* smart callbacks called:
1863 * "clicked" - the user clicked the icon
1867 typedef enum _Elm_Image_Orient
1869 ELM_IMAGE_ORIENT_NONE,
1870 ELM_IMAGE_ROTATE_90_CW,
1871 ELM_IMAGE_ROTATE_180_CW,
1872 ELM_IMAGE_ROTATE_90_CCW,
1873 ELM_IMAGE_FLIP_HORIZONTAL,
1874 ELM_IMAGE_FLIP_VERTICAL,
1875 ELM_IMAGE_FLIP_TRANSPOSE,
1876 ELM_IMAGE_FLIP_TRANSVERSE
1878 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1879 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1880 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1881 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1882 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1883 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1884 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1885 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1886 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1887 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1888 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1889 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1890 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1891 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1892 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
1893 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1894 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
1895 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1896 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1897 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
1898 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1900 /* smart callbacks called:
1901 * "clicked" - the user clicked the image
1905 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
1907 typedef enum _Elm_GLView_Mode
1909 ELM_GLVIEW_ALPHA = 1,
1910 ELM_GLVIEW_DEPTH = 2,
1911 ELM_GLVIEW_STENCIL = 4
1915 * Defines a policy for the glview resizing.
1917 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
1919 typedef enum _Elm_GLView_Resize_Policy
1921 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
1922 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
1923 } Elm_GLView_Resize_Policy;
1925 typedef enum _Elm_GLView_Render_Policy
1927 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
1928 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
1929 } Elm_GLView_Render_Policy;
1932 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1933 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1934 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1935 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1936 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
1937 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
1938 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
1939 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1940 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1941 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1942 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1943 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1949 * A box arranges objects in a linear fashion, governed by a layout function
1950 * that defines the details of this arrangement.
1952 * By default, the box will use an internal function to set the layout to
1953 * a single row, either vertical or horizontal. This layout is affected
1954 * by a number of parameters, such as the homogeneous flag set by
1955 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
1956 * elm_box_align_set() and the hints set to each object in the box.
1958 * For this default layout, it's possible to change the orientation with
1959 * elm_box_horizontal_set(). The box will start in the vertical orientation,
1960 * placing its elements ordered from top to bottom. When horizontal is set,
1961 * the order will go from left to right. If the box is set to be
1962 * homogeneous, every object in it will be assigned the same space, that
1963 * of the largest object. Padding can be used to set some spacing between
1964 * the cell given to each object. The alignment of the box, set with
1965 * elm_box_align_set(), determines how the bounding box of all the elements
1966 * will be placed within the space given to the box widget itself.
1968 * The size hints of each object also affect how they are placed and sized
1969 * within the box. evas_object_size_hint_min_set() will give the minimum
1970 * size the object can have, and the box will use it as the basis for all
1971 * latter calculations. Elementary widgets set their own minimum size as
1972 * needed, so there's rarely any need to use it manually.
1974 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
1975 * used to tell whether the object will be allocated the minimum size it
1976 * needs or if the space given to it should be expanded. It's important
1977 * to realize that expanding the size given to the object is not the same
1978 * thing as resizing the object. It could very well end being a small
1979 * widget floating in a much larger empty space. If not set, the weight
1980 * for objects will normally be 0.0 for both axis, meaning the widget will
1981 * not be expanded. To take as much space possible, set the weight to
1982 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
1984 * Besides how much space each object is allocated, it's possible to control
1985 * how the widget will be placed within that space using
1986 * evas_object_size_hint_align_set(). By default, this value will be 0.5
1987 * for both axis, meaning the object will be centered, but any value from
1988 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
1989 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
1990 * is -1.0, means the object will be resized to fill the entire space it
1993 * In addition, customized functions to define the layout can be set, which
1994 * allow the application developer to organize the objects within the box
1995 * in any number of ways.
1997 * The special elm_box_layout_transition() function can be used
1998 * to switch from one layout to another, animating the motion of the
1999 * children of the box.
2001 * @note Objects should not be added to box objects using _add() calls.
2003 * Some examples on how to use boxes follow:
2004 * @li @ref box_example_01
2005 * @li @ref box_example_02
2010 * @typedef Elm_Box_Transition
2012 * Opaque handler containing the parameters to perform an animated
2013 * transition of the layout the box uses.
2015 * @see elm_box_transition_new()
2016 * @see elm_box_layout_set()
2017 * @see elm_box_layout_transition()
2019 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2022 * Add a new box to the parent
2024 * By default, the box will be in vertical mode and non-homogeneous.
2026 * @param parent The parent object
2027 * @return The new object or NULL if it cannot be created
2029 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2031 * Set the horizontal orientation
2033 * By default, box object arranges their contents vertically from top to
2035 * By calling this function with @p horizontal as EINA_TRUE, the box will
2036 * become horizontal, arranging contents from left to right.
2038 * @note This flag is ignored if a custom layout function is set.
2040 * @param obj The box object
2041 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2042 * EINA_FALSE = vertical)
2044 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2046 * Get the horizontal orientation
2048 * @param obj The box object
2049 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2051 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2053 * Set the box to arrange its children homogeneously
2055 * If enabled, homogeneous layout makes all items the same size, according
2056 * to the size of the largest of its children.
2058 * @note This flag is ignored if a custom layout function is set.
2060 * @param obj The box object
2061 * @param homogeneous The homogeneous flag
2063 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2065 * Get whether the box is using homogeneous mode or not
2067 * @param obj The box object
2068 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2070 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2071 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2072 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2074 * Add an object to the beginning of the pack list
2076 * Pack @p subobj into the box @p obj, placing it first in the list of
2077 * children objects. The actual position the object will get on screen
2078 * depends on the layout used. If no custom layout is set, it will be at
2079 * the top or left, depending if the box is vertical or horizontal,
2082 * @param obj The box object
2083 * @param subobj The object to add to the box
2085 * @see elm_box_pack_end()
2086 * @see elm_box_pack_before()
2087 * @see elm_box_pack_after()
2088 * @see elm_box_unpack()
2089 * @see elm_box_unpack_all()
2090 * @see elm_box_clear()
2092 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2094 * Add an object at the end of the pack list
2096 * Pack @p subobj into the box @p obj, placing it last in the list of
2097 * children objects. The actual position the object will get on screen
2098 * depends on the layout used. If no custom layout is set, it will be at
2099 * the bottom or right, depending if the box is vertical or horizontal,
2102 * @param obj The box object
2103 * @param subobj The object to add to the box
2105 * @see elm_box_pack_start()
2106 * @see elm_box_pack_before()
2107 * @see elm_box_pack_after()
2108 * @see elm_box_unpack()
2109 * @see elm_box_unpack_all()
2110 * @see elm_box_clear()
2112 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2114 * Adds an object to the box before the indicated object
2116 * This will add the @p subobj to the box indicated before the object
2117 * indicated with @p before. If @p before is not already in the box, results
2118 * are undefined. Before means either to the left of the indicated object or
2119 * above it depending on orientation.
2121 * @param obj The box object
2122 * @param subobj The object to add to the box
2123 * @param before The object before which to add it
2125 * @see elm_box_pack_start()
2126 * @see elm_box_pack_end()
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_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2134 * Adds an object to the box after the indicated object
2136 * This will add the @p subobj to the box indicated after the object
2137 * indicated with @p after. If @p after is not already in the box, results
2138 * are undefined. After means either to the right of the indicated object or
2139 * below it depending on orientation.
2141 * @param obj The box object
2142 * @param subobj The object to add to the box
2143 * @param after The object after which to add it
2145 * @see elm_box_pack_start()
2146 * @see elm_box_pack_end()
2147 * @see elm_box_pack_before()
2148 * @see elm_box_unpack()
2149 * @see elm_box_unpack_all()
2150 * @see elm_box_clear()
2152 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2154 * Clear the box of all children
2156 * Remove all the elements contained by the box, deleting the respective
2159 * @param obj The box object
2161 * @see elm_box_unpack()
2162 * @see elm_box_unpack_all()
2164 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2168 * Remove the object given by @p subobj from the box @p obj without
2171 * @param obj The box object
2173 * @see elm_box_unpack_all()
2174 * @see elm_box_clear()
2176 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2178 * Remove all items from the box, without deleting them
2180 * Clear the box from all children, but don't delete the respective objects.
2181 * If no other references of the box children exist, the objects will never
2182 * be deleted, and thus the application will leak the memory. Make sure
2183 * when using this function that you hold a reference to all the objects
2184 * in the box @p obj.
2186 * @param obj The box object
2188 * @see elm_box_clear()
2189 * @see elm_box_unpack()
2191 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2193 * Retrieve a list of the objects packed into the box
2195 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2196 * The order of the list corresponds to the packing order the box uses.
2198 * You must free this list with eina_list_free() once you are done with it.
2200 * @param obj The box object
2202 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2204 * Set the space (padding) between the box's elements.
2206 * Extra space in pixels that will be added between a box child and its
2207 * neighbors after its containing cell has been calculated. This padding
2208 * is set for all elements in the box, besides any possible padding that
2209 * individual elements may have through their size hints.
2211 * @param obj The box object
2212 * @param horizontal The horizontal space between elements
2213 * @param vertical The vertical space between elements
2215 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2217 * Get the space (padding) between the box's elements.
2219 * @param obj The box object
2220 * @param horizontal The horizontal space between elements
2221 * @param vertical The vertical space between elements
2223 * @see elm_box_padding_set()
2225 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2227 * Set the alignment of the whole bouding box of contents.
2229 * Sets how the bounding box containing all the elements of the box, after
2230 * their sizes and position has been calculated, will be aligned within
2231 * the space given for the whole box widget.
2233 * @param obj The box object
2234 * @param horizontal The horizontal alignment of elements
2235 * @param vertical The vertical alignment of elements
2237 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2239 * Get the alignment of the whole bouding box of contents.
2241 * @param obj The box object
2242 * @param horizontal The horizontal alignment of elements
2243 * @param vertical The vertical alignment of elements
2245 * @see elm_box_align_set()
2247 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2250 * Set the layout defining function to be used by the box
2252 * Whenever anything changes that requires the box in @p obj to recalculate
2253 * the size and position of its elements, the function @p cb will be called
2254 * to determine what the layout of the children will be.
2256 * Once a custom function is set, everything about the children layout
2257 * is defined by it. The flags set by elm_box_horizontal_set() and
2258 * elm_box_homogeneous_set() no longer have any meaning, and the values
2259 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2260 * layout function to decide if they are used and how. These last two
2261 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2262 * passed to @p cb. The @c Evas_Object the function receives is not the
2263 * Elementary widget, but the internal Evas Box it uses, so none of the
2264 * functions described here can be used on it.
2266 * Any of the layout functions in @c Evas can be used here, as well as the
2267 * special elm_box_layout_transition().
2269 * The final @p data argument received by @p cb is the same @p data passed
2270 * here, and the @p free_data function will be called to free it
2271 * whenever the box is destroyed or another layout function is set.
2273 * Setting @p cb to NULL will revert back to the default layout function.
2275 * @param obj The box object
2276 * @param cb The callback function used for layout
2277 * @param data Data that will be passed to layout function
2278 * @param free_data Function called to free @p data
2280 * @see elm_box_layout_transition()
2282 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);
2284 * Special layout function that animates the transition from one layout to another
2286 * Normally, when switching the layout function for a box, this will be
2287 * reflected immediately on screen on the next render, but it's also
2288 * possible to do this through an animated transition.
2290 * This is done by creating an ::Elm_Box_Transition and setting the box
2291 * layout to this function.
2295 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2296 * evas_object_box_layout_vertical, // start
2297 * NULL, // data for initial layout
2298 * NULL, // free function for initial data
2299 * evas_object_box_layout_horizontal, // end
2300 * NULL, // data for final layout
2301 * NULL, // free function for final data
2302 * anim_end, // will be called when animation ends
2303 * NULL); // data for anim_end function\
2304 * elm_box_layout_set(box, elm_box_layout_transition, t,
2305 * elm_box_transition_free);
2308 * @note This function can only be used with elm_box_layout_set(). Calling
2309 * it directly will not have the expected results.
2311 * @see elm_box_transition_new
2312 * @see elm_box_transition_free
2313 * @see elm_box_layout_set
2315 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2317 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2319 * If you want to animate the change from one layout to another, you need
2320 * to set the layout function of the box to elm_box_layout_transition(),
2321 * passing as user data to it an instance of ::Elm_Box_Transition with the
2322 * necessary information to perform this animation. The free function to
2323 * set for the layout is elm_box_transition_free().
2325 * The parameters to create an ::Elm_Box_Transition sum up to how long
2326 * will it be, in seconds, a layout function to describe the initial point,
2327 * another for the final position of the children and one function to be
2328 * called when the whole animation ends. This last function is useful to
2329 * set the definitive layout for the box, usually the same as the end
2330 * layout for the animation, but could be used to start another transition.
2332 * @param start_layout The layout function that will be used to start the animation
2333 * @param start_layout_data The data to be passed the @p start_layout function
2334 * @param start_layout_free_data Function to free @p start_layout_data
2335 * @param end_layout The layout function that will be used to end the animation
2336 * @param end_layout_free_data The data to be passed the @p end_layout function
2337 * @param end_layout_free_data Function to free @p end_layout_data
2338 * @param transition_end_cb Callback function called when animation ends
2339 * @param transition_end_data Data to be passed to @p transition_end_cb
2340 * @return An instance of ::Elm_Box_Transition
2342 * @see elm_box_transition_new
2343 * @see elm_box_layout_transition
2345 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);
2347 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2349 * This function is mostly useful as the @c free_data parameter in
2350 * elm_box_layout_set() when elm_box_layout_transition().
2352 * @param data The Elm_Box_Transition instance to be freed.
2354 * @see elm_box_transition_new
2355 * @see elm_box_layout_transition
2357 EAPI void elm_box_transition_free(void *data);
2364 * @defgroup Button Button
2366 * @image html widget/button/preview-00.png
2367 * @image html widget/button/preview-01.png
2368 * @image html widget/button/preview-02.png
2370 * This is a push-button. Press it and run some function. It can contain
2371 * a simple label and icon object and it also has an autorepeat feature.
2373 * This widgets emits the following signals:
2374 * @li "clicked": the user clicked the button (press/release).
2375 * @li "repeated": the user pressed the button without releasing it.
2376 * @li "pressed": button was pressed.
2377 * @li "unpressed": button was released after being pressed.
2378 * In all three cases, the @c event parameter of the callback will be
2381 * Also, defined in the default theme, the button has the following styles
2383 * @li default: a normal button.
2384 * @li anchor: Like default, but the button fades away when the mouse is not
2385 * over it, leaving only the text or icon.
2386 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2387 * continuous look across its options.
2388 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2390 * Follow through a complete example @ref button_example_01 "here".
2396 UIControlStateDefault,
2397 UIControlStateHighlighted,
2398 UIControlStateDisabled,
2399 UIControlStateFocused,
2400 UIControlStateReserved
2404 * Add a new button to the parent's canvas
2406 * @param parent The parent object
2407 * @return The new object or NULL if it cannot be created
2409 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2411 * Set the label used in the button
2413 * The passed @p label can be NULL to clean any existing text in it and
2414 * leave the button as an icon only object.
2416 * @param obj The button object
2417 * @param label The text will be written on the button
2418 * @deprecated use elm_object_text_set() instead.
2420 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2422 * Get the label set for the button
2424 * The string returned is an internal pointer and should not be freed or
2425 * altered. It will also become invalid when the button is destroyed.
2426 * The string returned, if not NULL, is a stringshare, so if you need to
2427 * keep it around even after the button is destroyed, you can use
2428 * eina_stringshare_ref().
2430 * @param obj The button object
2431 * @return The text set to the label, or NULL if nothing is set
2432 * @deprecated use elm_object_text_set() instead.
2434 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2436 * Set the label for each state of button
2438 * The passed @p label can be NULL to clean any existing text in it and
2439 * leave the button as an icon only object for the state.
2441 * @param obj The button object
2442 * @param label The text will be written on the button
2443 * @param state The state of button
2447 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2449 * Get the label of button for each state
2451 * The string returned is an internal pointer and should not be freed or
2452 * altered. It will also become invalid when the button is destroyed.
2453 * The string returned, if not NULL, is a stringshare, so if you need to
2454 * keep it around even after the button is destroyed, you can use
2455 * eina_stringshare_ref().
2457 * @param obj The button object
2458 * @param state The state of button
2459 * @return The title of button for state
2463 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2465 * Set the icon used for the button
2467 * Setting a new icon will delete any other that was previously set, making
2468 * any reference to them invalid. If you need to maintain the previous
2469 * object alive, unset it first with elm_button_icon_unset().
2471 * @param obj The button object
2472 * @param icon The icon object for the button
2474 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2476 * Get the icon used for the button
2478 * Return the icon object which is set for this widget. If the button is
2479 * destroyed or another icon is set, the returned object will be deleted
2480 * and any reference to it will be invalid.
2482 * @param obj The button object
2483 * @return The icon object that is being used
2485 * @see elm_button_icon_unset()
2487 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2489 * Remove the icon set without deleting it and return the object
2491 * This function drops the reference the button holds of the icon object
2492 * and returns this last object. It is used in case you want to remove any
2493 * icon, or set another one, without deleting the actual object. The button
2494 * will be left without an icon set.
2496 * @param obj The button object
2497 * @return The icon object that was being used
2499 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2501 * Turn on/off the autorepeat event generated when the button is kept pressed
2503 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2504 * signal when they are clicked.
2506 * When on, keeping a button pressed will continuously emit a @c repeated
2507 * signal until the button is released. The time it takes until it starts
2508 * emitting the signal is given by
2509 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2510 * new emission by elm_button_autorepeat_gap_timeout_set().
2512 * @param obj The button object
2513 * @param on A bool to turn on/off the event
2515 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2517 * Get whether the autorepeat feature is enabled
2519 * @param obj The button object
2520 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2522 * @see elm_button_autorepeat_set()
2524 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2526 * Set the initial timeout before the autorepeat event is generated
2528 * Sets the timeout, in seconds, since the button is pressed until the
2529 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2530 * won't be any delay and the even will be fired the moment the button is
2533 * @param obj The button object
2534 * @param t Timeout in seconds
2536 * @see elm_button_autorepeat_set()
2537 * @see elm_button_autorepeat_gap_timeout_set()
2539 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2541 * Get the initial timeout before the autorepeat event is generated
2543 * @param obj The button object
2544 * @return Timeout in seconds
2546 * @see elm_button_autorepeat_initial_timeout_set()
2548 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2550 * Set the interval between each generated autorepeat event
2552 * After the first @c repeated event is fired, all subsequent ones will
2553 * follow after a delay of @p t seconds for each.
2555 * @param obj The button object
2556 * @param t Interval in seconds
2558 * @see elm_button_autorepeat_initial_timeout_set()
2560 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2562 * Get the interval between each generated autorepeat event
2564 * @param obj The button object
2565 * @return Interval in seconds
2567 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2573 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2574 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2575 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2576 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2577 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2578 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2579 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2580 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2581 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2582 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2583 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2584 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2585 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2586 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2587 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2588 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2589 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2590 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2591 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2592 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2593 /* available styles:
2597 * hoversel_vertical_entry
2599 /* smart callbacks called:
2600 * "file,chosen" - the user has selected a path, whose string pointer comes
2604 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2605 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2606 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2607 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2608 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2609 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2610 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2611 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2612 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2613 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2614 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2615 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2616 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2617 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2618 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2619 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2620 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2621 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2622 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2623 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2624 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2625 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2627 /* scroller policy */
2628 typedef enum _Elm_Scroller_Policy
2630 ELM_SCROLLER_POLICY_AUTO = 0,
2631 ELM_SCROLLER_POLICY_ON,
2632 ELM_SCROLLER_POLICY_OFF,
2633 ELM_SCROLLER_POLICY_LAST
2634 } Elm_Scroller_Policy;
2636 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2637 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2638 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2639 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2640 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2641 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2642 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);
2643 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2644 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2645 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);
2646 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2647 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2648 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2649 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2650 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2651 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);
2652 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2653 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2654 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
2655 /* smart callbacks called:
2656 * "edge,left" - the left edge of the content has been reached
2657 * "edge,right" - the right edge of the content has been reached
2658 * "edge,top" - the top edge of the content has been reached
2659 * "edge,bottom" - the bottom edge of the content has been reached
2660 * "scroll" - the content has been scrolled (moved)
2661 * "scroll,anim,start" - scrolling animation has started
2662 * "scroll,anim,stop" - scrolling animation has stopped
2663 * "scroll,drag,start" - dragging the contents around has started
2664 * "scroll,drag,stop" - dragging the contents around has stopped
2668 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2669 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 */
2670 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2671 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2672 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2673 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2674 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2675 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2676 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2677 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2678 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);
2679 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2680 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);
2681 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2682 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
2683 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2684 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2685 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2686 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2687 /* available styles:
2691 /* smart callbacks called:
2695 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2696 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2697 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2698 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2699 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2700 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2701 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2702 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2703 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2704 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2705 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2706 /* smart callbacks called:
2707 * "changed" - Whenever the toggle value has been changed. Is not called
2708 * until the toggle is released by the cursor (assuming it has been triggered
2709 * by the cursor in the first place).
2713 * @page tutorial_frame Frame example
2714 * @dontinclude frame_example_01.c
2716 * In this example we are going to create 4 Frames with different styles and
2717 * add a rectangle of different color in each.
2719 * We start we the usual setup code:
2722 * And then create one rectangle:
2725 * To add it in our first frame, which since it doesn't have it's style
2726 * specifically set uses the default style:
2729 * And then create another rectangle:
2732 * To add it in our second frame, which uses the "pad_small" style, note that
2733 * even tough we are setting a text for this frame it won't be show, only the
2734 * default style shows the Frame's title:
2736 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
2737 * very similar, their only difference is the size of the empty area around
2738 * the content of the frame.
2740 * And then create yet another rectangle:
2743 * To add it in our third frame, which uses the "outdent_top" style, note
2744 * that even tough we are setting a text for this frame it won't be show,
2745 * only the default style shows the Frame's title:
2748 * And then create one last rectangle:
2751 * To add it in our fourth and final frame, which uses the "outdent_bottom"
2752 * style, note that even tough we are setting a text for this frame it won't
2753 * be show, only the default style shows the Frame's title:
2756 * And now we are left with just some more setup code:
2759 * Our example will look like this:
2760 * @image html screenshots/frame_example_01.png
2761 * @image latex screenshots/frame_example_01.eps
2763 * @example frame_example_01.c
2766 * @defgroup Frame Frame
2768 * @brief Frame is a widget that holds some content and has a title.
2770 * The default look is a frame with a title, but Frame supports multple
2778 * @li outdent_bottom
2780 * Of all this styles only default shows the title. Frame emits no signals.
2782 * For a detailed example see the @ref tutorial_frame.
2787 * @brief Add a new frame to the parent
2789 * @param parent The parent object
2790 * @return The new object or NULL if it cannot be created
2792 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2794 * @brief Set the frame label
2796 * @param obj The frame object
2797 * @param label The label of this frame object
2799 * @deprecated use elm_object_text_set() instead.
2801 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2803 * @brief Get the frame label
2805 * @param obj The frame object
2807 * @return The label of this frame objet or NULL if unable to get frame
2809 * @deprecated use elm_object_text_get() instead.
2811 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2813 * @brief Set the content of the frame widget
2815 * Once the content object is set, a previously set one will be deleted.
2816 * If you want to keep that old content object, use the
2817 * elm_frame_content_unset() function.
2819 * @param obj The frame object
2820 * @param content The content will be filled in this frame object
2822 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2824 * @brief Get the content of the frame widget
2826 * Return the content object which is set for this widget
2828 * @param obj The frame object
2829 * @return The content that is being used
2831 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2833 * @brief Unset the content of the frame widget
2835 * Unparent and return the content object which was set for this widget
2837 * @param obj The frame object
2838 * @return The content that was being used
2840 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2846 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2847 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2848 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2849 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2850 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2851 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2852 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2853 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2854 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2855 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
2856 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2857 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
2860 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
2861 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
2862 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
2863 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2864 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
2865 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2866 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
2868 struct _Elm_Gengrid_Item_Class
2870 const char *item_style;
2871 struct _Elm_Gengrid_Item_Class_Func
2873 GridItemLabelGetFunc label_get;
2874 GridItemIconGetFunc icon_get;
2875 GridItemStateGetFunc state_get;
2876 GridItemDelFunc del;
2880 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2881 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2882 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2883 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
2884 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
2886 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2887 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2888 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2889 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2890 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2891 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2892 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2893 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2894 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2895 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2896 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2897 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
2898 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2899 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
2900 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2902 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2903 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2905 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2906 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2907 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2908 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2909 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2910 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2911 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
2912 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2913 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
2914 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
2915 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2916 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2917 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2918 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2919 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2920 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2921 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2923 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
2924 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);
2925 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2926 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2927 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2928 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2929 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2930 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2931 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2932 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2933 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2934 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2936 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2937 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2938 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2940 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);
2941 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);
2942 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);
2943 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);
2944 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);
2945 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);
2946 /* smart callbacks called:
2948 * selected - User has selected an item.
2949 * unselected - User has unselected an item.
2950 * clicked,double - User has double-clicked or pressed enter on an item.
2951 * realized - An evas object for an item was built.
2952 * unrealized - An evas object for an item was deleted.
2953 * changed - An item has been added, removed, resized or moved,
2954 * or gengrid has been resized or horizontal property has been changed.
2955 * scroll - the content has been scrolled (moved).
2956 * "scroll,drag,start" - dragging the contents around has started.
2957 * "scroll,drag,stop" - dragging the contents around has stopped.
2958 * drag - Gengrid is being dragged.
2959 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
2960 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
2961 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
2962 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
2963 * "drag,stop" - Gengrid is not being dragged.
2967 * @defgroup Clock Clock
2969 * This is a @b digital clock widget. In its default theme, it has a
2970 * vintage "flipping numbers clock" appearance, which will animate
2971 * sheets of individual algarisms individually as time goes by.
2973 * A newly created clock will fetch system's time (already
2974 * considering local time adjustments) to start with, and will tick
2975 * accondingly. It may or may not show seconds.
2977 * Clocks have an @b edition mode. When in it, the sheets will
2978 * display extra arrow indications on the top and bottom and the
2979 * user may click on them to raise or lower the time values. After
2980 * it's told to exit edition mode, it will keep ticking with that
2981 * new time set (it keeps the difference from local time).
2983 * Also, when under edition mode, user clicks on the cited arrows
2984 * which are @b held for some time will make the clock to flip the
2985 * sheet, thus editing the time, continuosly and automatically for
2986 * the user. The interval between sheet flips will keep growing in
2987 * time, so that it helps the user to reach a time which is distant
2990 * The time display is, by default, in military mode (24h), but an
2991 * am/pm indicator may be optionally shown, too, when it will
2994 * Smart callbacks one can register to:
2995 * - "changed" - the clock's user changed the time
2997 * Here is an example on its usage:
2998 * @li @ref clock_example
3007 * Identifiers for which clock digits should be editable, when a
3008 * clock widget is in edition mode. Values may be ORed together to
3009 * make a mask, naturally.
3011 * @see elm_clock_edit_set()
3012 * @see elm_clock_digit_edit_set()
3014 typedef enum _Elm_Clock_Digedit
3016 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3017 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3018 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3019 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3020 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3021 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3022 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3023 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3024 } Elm_Clock_Digedit;
3027 * Add a new clock widget to the given parent Elementary
3028 * (container) object
3030 * @param parent The parent object
3031 * @return a new clock widget handle or @c NULL, on errors
3033 * This function inserts a new clock widget on the canvas.
3037 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3040 * Set a clock widget's time, programmatically
3042 * @param obj The clock widget object
3043 * @param hrs The hours to set
3044 * @param min The minutes to set
3045 * @param sec The secondes to set
3047 * This function updates the time that is showed by the clock
3050 * Values @b must be set within the following ranges:
3051 * - 0 - 23, for hours
3052 * - 0 - 59, for minutes
3053 * - 0 - 59, for seconds,
3055 * even if the clock is not in "military" mode.
3057 * @warning The behavior for values set out of those ranges is @b
3062 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3065 * Get a clock widget's time values
3067 * @param obj The clock object
3068 * @param[out] hrs Pointer to the variable to get the hours value
3069 * @param[out] min Pointer to the variable to get the minutes value
3070 * @param[out] sec Pointer to the variable to get the seconds value
3072 * This function gets the time set for @p obj, returning
3073 * it on the variables passed as the arguments to function
3075 * @note Use @c NULL pointers on the time values you're not
3076 * interested in: they'll be ignored by the function.
3080 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3083 * Set whether a given clock widget is under <b>edition mode</b> or
3084 * under (default) displaying-only mode.
3086 * @param obj The clock object
3087 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3088 * put it back to "displaying only" mode
3090 * This function makes a clock's time to be editable or not <b>by
3091 * user interaction</b>. When in edition mode, clocks @b stop
3092 * ticking, until one brings them back to canonical mode. The
3093 * elm_clock_digit_edit_set() function will influence which digits
3094 * of the clock will be editable. By default, all of them will be
3095 * (#ELM_CLOCK_NONE).
3097 * @note am/pm sheets, if being shown, will @b always be editable
3098 * under edition mode.
3100 * @see elm_clock_edit_get()
3104 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3107 * Retrieve whether a given clock widget is under <b>edition
3108 * mode</b> or under (default) displaying-only mode.
3110 * @param obj The clock object
3111 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3114 * This function retrieves whether the clock's time can be edited
3115 * or not by user interaction.
3117 * @see elm_clock_edit_set() for more details
3121 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3124 * Set what digits of the given clock widget should be editable
3125 * when in edition mode.
3127 * @param obj The clock object
3128 * @param digedit Bit mask indicating the digits to be editable
3129 * (values in #Elm_Clock_Digedit).
3131 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3132 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3135 * @see elm_clock_digit_edit_get()
3139 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3142 * Retrieve what digits of the given clock widget should be
3143 * editable when in edition mode.
3145 * @param obj The clock object
3146 * @return Bit mask indicating the digits to be editable
3147 * (values in #Elm_Clock_Digedit).
3149 * @see elm_clock_digit_edit_set() for more details
3153 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3156 * Set if the given clock widget must show hours in military or
3159 * @param obj The clock object
3160 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3163 * This function sets if the clock must show hours in military or
3164 * am/pm mode. In some countries like Brazil the military mode
3165 * (00-24h-format) is used, in opposition to the USA, where the
3166 * am/pm mode is more commonly used.
3168 * @see elm_clock_show_am_pm_get()
3172 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3175 * Get if the given clock widget shows hours in military or am/pm
3178 * @param obj The clock object
3179 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3182 * This function gets if the clock shows hours in military or am/pm
3185 * @see elm_clock_show_am_pm_set() for more details
3189 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3192 * Set if the given clock widget must show time with seconds or not
3194 * @param obj The clock object
3195 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3197 * This function sets if the given clock must show or not elapsed
3198 * seconds. By default, they are @b not shown.
3200 * @see elm_clock_show_seconds_get()
3204 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3207 * Get whether the given clock widget is showing time with seconds
3210 * @param obj The clock object
3211 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3213 * This function gets whether @p obj is showing or not the elapsed
3216 * @see elm_clock_show_seconds_set()
3220 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3223 * Set the interval on time updates for an user mouse button hold
3224 * on clock widgets' time edition.
3226 * @param obj The clock object
3227 * @param interval The (first) interval value in seconds
3229 * This interval value is @b decreased while the user holds the
3230 * mouse pointer either incrementing or decrementing a given the
3231 * clock digit's value.
3233 * This helps the user to get to a given time distant from the
3234 * current one easier/faster, as it will start to flip quicker and
3235 * quicker on mouse button holds.
3237 * The calculation for the next flip interval value, starting from
3238 * the one set with this call, is the previous interval divided by
3239 * 1.05, so it decreases a little bit.
3241 * The default starting interval value for automatic flips is
3244 * @see elm_clock_interval_get()
3248 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3251 * Get the interval on time updates for an user mouse button hold
3252 * on clock widgets' time edition.
3254 * @param obj The clock object
3255 * @return The (first) interval value, in seconds, set on it
3257 * @see elm_clock_interval_set() for more details
3261 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3268 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3269 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3270 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3271 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3272 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3273 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3274 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3275 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3276 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3277 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3278 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3279 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3280 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3281 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3282 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);
3283 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3284 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3285 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3286 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3287 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3288 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3289 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3290 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3291 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3292 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3293 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);
3294 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3296 * @def elm_layout_icon_set
3297 * Convienience macro to set the icon object in a layout that follows the
3298 * Elementary naming convention for its parts.
3302 #define elm_layout_icon_set(_ly, _obj) \
3305 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3306 if ((_obj)) sig = "elm,state,icon,visible"; \
3307 else sig = "elm,state,icon,hidden"; \
3308 elm_object_signal_emit((_ly), sig, "elm"); \
3312 * @def elm_layout_icon_get
3313 * Convienience macro to get the icon object from a layout that follows the
3314 * Elementary naming convention for its parts.
3318 #define elm_layout_icon_get(_ly) \
3319 elm_layout_content_get((_ly), "elm.swallow.icon")
3322 * @def elm_layout_end_set
3323 * Convienience macro to set the end object in a layout that follows the
3324 * Elementary naming convention for its parts.
3328 #define elm_layout_end_set(_ly, _obj) \
3331 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3332 if ((_obj)) sig = "elm,state,end,visible"; \
3333 else sig = "elm,state,end,hidden"; \
3334 elm_object_signal_emit((_ly), sig, "elm"); \
3338 * @def elm_layout_end_get
3339 * Convienience macro to get the end object in a layout that follows the
3340 * Elementary naming convention for its parts.
3344 #define elm_layout_end_get(_ly) \
3345 elm_layout_content_get((_ly), "elm.swallow.end")
3348 * @def elm_layout_label_set
3349 * Convienience macro to set the label in a layout that follows the
3350 * Elementary naming convention for its parts.
3353 * @deprecate use elm_object_text_* instead.
3355 #define elm_layout_label_set(_ly, _txt) \
3356 elm_layout_text_set((_ly), "elm.text", (_txt))
3359 * @def elm_layout_label_get
3360 * Convienience macro to get the label in a layout that follows the
3361 * Elementary naming convention for its parts.
3364 * @deprecate use elm_object_text_* instead.
3366 #define elm_layout_label_get(_ly) \
3367 elm_layout_text_get((_ly), "elm.text")
3369 /* smart callbacks called:
3373 typedef enum _Elm_Notify_Orient
3375 ELM_NOTIFY_ORIENT_TOP,
3376 ELM_NOTIFY_ORIENT_CENTER,
3377 ELM_NOTIFY_ORIENT_BOTTOM,
3378 ELM_NOTIFY_ORIENT_LEFT,
3379 ELM_NOTIFY_ORIENT_RIGHT,
3380 ELM_NOTIFY_ORIENT_TOP_LEFT,
3381 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3382 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3383 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3384 ELM_NOTIFY_ORIENT_LAST
3385 } Elm_Notify_Orient;
3386 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3387 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3388 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3389 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3390 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3391 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3392 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3393 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3394 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3395 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3396 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3397 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3398 /* smart callbacks called:
3399 * "timeout" - when timeout happens on notify and it's hidden
3400 * "block,clicked" - when it's hidden by a click outside of the notify's view
3404 typedef enum _Elm_Hover_Axis
3406 ELM_HOVER_AXIS_NONE,
3407 ELM_HOVER_AXIS_HORIZONTAL,
3408 ELM_HOVER_AXIS_VERTICAL,
3411 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3412 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3413 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3414 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3415 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3416 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3417 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3418 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3419 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3420 /* available styles:
3426 /* smart callbacks called:
3427 * "clicked" - the user clicked the empty space in the hover to dismiss
3428 * "smart,changed" - a content object placed under the "smart"
3429 * policy was replaced to a new slot direction.
3433 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3434 struct _Elm_Entry_Anchor_Info
3438 Evas_Coord x, y, w, h;
3440 typedef enum _Elm_Icon_Type
3447 typedef enum _Elm_Input_Panel_Layout
3449 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default 4x4 layout */
3450 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
3451 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
3452 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
3453 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
3454 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
3455 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
3456 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
3457 ELM_INPUT_PANEL_LAYOUT_CUSTOM_1 = 100, /* Reserved for future use */
3458 ELM_INPUT_PANEL_LAYOUT_CUSTOM_2,
3459 ELM_INPUT_PANEL_LAYOUT_CUSTOM_3,
3460 ELM_INPUT_PANEL_LAYOUT_CUSTOM_4,
3461 ELM_INPUT_PANEL_LAYOUT_CUSTOM_5,
3462 ELM_INPUT_PANEL_LAYOUT_CUSTOM_6,
3463 ELM_INPUT_PANEL_LAYOUT_CUSTOM_7,
3464 ELM_INPUT_PANEL_LAYOUT_CUSTOM_8,
3465 ELM_INPUT_PANEL_LAYOUT_CUSTOM_9,
3466 ELM_INPUT_PANEL_LAYOUT_CUSTOM_10
3467 } Elm_Input_Panel_Layout;
3469 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3471 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3472 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3473 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3474 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3475 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3476 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3477 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3478 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3479 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3480 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3481 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3482 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3483 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3484 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3485 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3486 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3487 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3488 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3489 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3490 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3491 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3492 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3493 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3494 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3495 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3496 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3497 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3498 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3499 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3500 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3501 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3502 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);
3503 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3504 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3505 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3506 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3507 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3508 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3509 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);
3510 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3511 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3512 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);
3513 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);
3514 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);
3515 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);
3516 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);
3517 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);
3518 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3519 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3520 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3521 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
3522 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3523 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3524 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3525 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3526 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3527 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3528 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3529 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3530 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3531 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3532 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3533 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3534 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3535 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3536 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
3537 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
3538 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3539 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3540 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3541 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3542 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3543 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
3544 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3545 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3546 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3547 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3548 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3549 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3550 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3551 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3552 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3553 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3554 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3556 /* pre-made filters for entries */
3557 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3558 struct _Elm_Entry_Filter_Limit_Size
3563 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3564 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3565 struct _Elm_Entry_Filter_Accept_Set
3567 const char *accepted;
3568 const char *rejected;
3570 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3571 /* smart callbacks called:
3572 * "changed" - the text content changed
3573 * "selection,start" - the user started selecting text
3574 * "selection,changed" - the user modified the selection size/location
3575 * "selection,cleared" - the user cleared the selection
3576 * "selection,paste" - the user requested a paste of text
3577 * "selection,copy" - the user copied the text
3578 * "selection,cut" - the user cut the text
3579 * "cursor,changed" - the cursor changed position
3580 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3581 * "activated" - when the enter key is pressed (useful for single line)
3582 * "press" - when finger/mouse is pressed down
3583 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3584 * "clicked,double" - when finger/mouse is double-pressed
3585 * "longpressed" - the entry has been longpressed
3586 * "focused" - the entry has received keyboard focus
3587 * "unfocused" - keyboard focus is gone
3590 /* composite widgets - these basically put together basic widgets above
3591 * in convenient packages that do more than basic stuff */
3595 * @defgroup Anchorview Anchorview
3597 * Anchorview is for displaying text that contains markup with anchors
3598 * like <c>\<a href=1234\>something\</\></c> in it.
3600 * Besides being styled differently, the anchorview widget provides the
3601 * necessary functionality so that clicking on these anchors brings up a
3602 * popup with user defined content such as "call", "add to contacts" or
3603 * "open web page". This popup is provided using the @ref Hover widget.
3605 * This widget is very similar to @ref Anchorblock, so refer to that
3606 * widget for an example. The only difference Anchorview has is that the
3607 * widget is already provided with scrolling functionality, so if the
3608 * text set to it is too large to fit in the given space, it will scroll,
3609 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3610 * text can be displayed.
3612 * This widget emits the following signals:
3613 * @li "anchor,clicked": will be called when an anchor is clicked. The
3614 * @p event_info parameter on the callback will be a pointer of type
3615 * ::Elm_Entry_Anchorview_Info.
3617 * See @ref Anchorblock for an example on how to use both of them.
3626 * @typedef Elm_Entry_Anchorview_Info
3628 * The info sent in the callback for "anchor,clicked" signals emitted by
3629 * the Anchorview widget.
3631 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3633 * @struct _Elm_Entry_Anchorview_Info
3635 * The info sent in the callback for "anchor,clicked" signals emitted by
3636 * the Anchorview widget.
3638 struct _Elm_Entry_Anchorview_Info
3640 const char *name; /**< Name of the anchor, as indicated in its href
3642 int button; /**< The mouse button used to click on it */
3643 Evas_Object *hover; /**< The hover object to use for the popup */
3645 Evas_Coord x, y, w, h;
3646 } anchor, /**< Geometry selection of text used as anchor */
3647 hover_parent; /**< Geometry of the object used as parent by the
3649 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3650 for content on the left side of
3651 the hover. Before calling the
3652 callback, the widget will make the
3653 necessary calculations to check
3654 which sides are fit to be set with
3655 content, based on the position the
3656 hover is activated and its distance
3657 to the edges of its parent object
3659 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3660 the right side of the hover.
3661 See @ref hover_left */
3662 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3663 of the hover. See @ref hover_left */
3664 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3665 below the hover. See @ref
3669 * Add a new Anchorview object
3671 * @param parent The parent object
3672 * @return The new object or NULL if it cannot be created
3674 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3676 * Set the text to show in the anchorview
3678 * Sets the text of the anchorview to @p text. This text can include markup
3679 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3680 * text that will be specially styled and react to click events, ended with
3681 * either of \</a\> or \</\>. When clicked, the anchor will emit an
3682 * "anchor,clicked" signal that you can attach a callback to with
3683 * evas_object_smart_callback_add(). The name of the anchor given in the
3684 * event info struct will be the one set in the href attribute, in this
3687 * Other markup can be used to style the text in different ways, but it's
3688 * up to the style defined in the theme which tags do what.
3689 * @deprecated use elm_object_text_set() instead.
3691 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3693 * Get the markup text set for the anchorview
3695 * Retrieves the text set on the anchorview, with markup tags included.
3697 * @param obj The anchorview object
3698 * @return The markup text set or @c NULL if nothing was set or an error
3700 * @deprecated use elm_object_text_set() instead.
3702 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3704 * Set the parent of the hover popup
3706 * Sets the parent object to use by the hover created by the anchorview
3707 * when an anchor is clicked. See @ref Hover for more details on this.
3708 * If no parent is set, the same anchorview object will be used.
3710 * @param obj The anchorview object
3711 * @param parent The object to use as parent for the hover
3713 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3715 * Get the parent of the hover popup
3717 * Get the object used as parent for the hover created by the anchorview
3718 * widget. See @ref Hover for more details on this.
3720 * @param obj The anchorview object
3721 * @return The object used as parent for the hover, NULL if none is set.
3723 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3725 * Set the style that the hover should use
3727 * When creating the popup hover, anchorview will request that it's
3728 * themed according to @p style.
3730 * @param obj The anchorview object
3731 * @param style The style to use for the underlying hover
3733 * @see elm_object_style_set()
3735 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3737 * Get the style that the hover should use
3739 * Get the style the hover created by anchorview will use.
3741 * @param obj The anchorview object
3742 * @return The style to use by the hover. NULL means the default is used.
3744 * @see elm_object_style_set()
3746 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3748 * Ends the hover popup in the anchorview
3750 * When an anchor is clicked, the anchorview widget will create a hover
3751 * object to use as a popup with user provided content. This function
3752 * terminates this popup, returning the anchorview to its normal state.
3754 * @param obj The anchorview object
3756 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3758 * Set bouncing behaviour when the scrolled content reaches an edge
3760 * Tell the internal scroller object whether it should bounce or not
3761 * when it reaches the respective edges for each axis.
3763 * @param obj The anchorview object
3764 * @param h_bounce Whether to bounce or not in the horizontal axis
3765 * @param v_bounce Whether to bounce or not in the vertical axis
3767 * @see elm_scroller_bounce_set()
3769 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3771 * Get the set bouncing behaviour of the internal scroller
3773 * Get whether the internal scroller should bounce when the edge of each
3774 * axis is reached scrolling.
3776 * @param obj The anchorview object
3777 * @param h_bounce Pointer where to store the bounce state of the horizontal
3779 * @param v_bounce Pointer where to store the bounce state of the vertical
3782 * @see elm_scroller_bounce_get()
3784 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3786 * Appends a custom item provider to the given anchorview
3788 * Appends the given function to the list of items providers. This list is
3789 * called, one function at a time, with the given @p data pointer, the
3790 * anchorview object and, in the @p item parameter, the item name as
3791 * referenced in its href string. Following functions in the list will be
3792 * called in order until one of them returns something different to NULL,
3793 * which should be an Evas_Object which will be used in place of the item
3796 * Items in the markup text take the form \<item relsize=16x16 vsize=full
3797 * href=item/name\>\</item\>
3799 * @param obj The anchorview object
3800 * @param func The function to add to the list of providers
3801 * @param data User data that will be passed to the callback function
3803 * @see elm_entry_item_provider_append()
3805 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);
3807 * Prepend a custom item provider to the given anchorview
3809 * Like elm_anchorview_item_provider_append(), but it adds the function
3810 * @p func to the beginning of the list, instead of the end.
3812 * @param obj The anchorview object
3813 * @param func The function to add to the list of providers
3814 * @param data User data that will be passed to the callback function
3816 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);
3818 * Remove a custom item provider from the list of the given anchorview
3820 * Removes the function and data pairing that matches @p func and @p data.
3821 * That is, unless the same function and same user data are given, the
3822 * function will not be removed from the list. This allows us to add the
3823 * same callback several times, with different @p data pointers and be
3824 * able to remove them later without conflicts.
3826 * @param obj The anchorview object
3827 * @param func The function to remove from the list
3828 * @param data The data matching the function to remove from the list
3830 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);
3837 * @defgroup Anchorblock Anchorblock
3839 * Anchorblock is for displaying text that contains markup with anchors
3840 * like <c>\<a href=1234\>something\</\></c> in it.
3842 * Besides being styled differently, the anchorblock widget provides the
3843 * necessary functionality so that clicking on these anchors brings up a
3844 * popup with user defined content such as "call", "add to contacts" or
3845 * "open web page". This popup is provided using the @ref Hover widget.
3847 * This widget emits the following signals:
3848 * @li "anchor,clicked": will be called when an anchor is clicked. The
3849 * @p event_info parameter on the callback will be a pointer of type
3850 * ::Elm_Entry_Anchorblock_Info.
3856 * Since examples are usually better than plain words, we might as well
3857 * try @ref tutorial_anchorblock_example "one".
3860 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
3861 * This exampel will show both Anchorblock and @ref Anchorview,
3862 * since both are very similar and it's easier to show them once and side
3863 * by side, so the difference is more clear.
3865 * We'll show the relevant snippets of the code here, but the full example
3866 * can be found here... sorry, @ref anchorblock_example_01.c "here".
3868 * As for the actual example, it's just a simple window with an anchorblock
3869 * and an anchorview, both containing the same text. After including
3870 * Elementary.h and declaring some functions we'll need, we jump to our
3871 * elm_main (see ELM_MAIN) and create our window.
3872 * @dontinclude anchorblock_example_01.c
3877 * With the needed variables declared, we'll create the window and a box to
3878 * hold our widgets, but we don't need to go through that here.
3880 * In order to make clear where the anchorblock ends and the anchorview
3881 * begins, they'll be each inside a @ref Frame. After creating the frame,
3882 * the anchorblock follows.
3883 * @skip elm_frame_add
3884 * @until elm_frame_content_set
3886 * Nothing out of the ordinary there. What's worth mentioning is the call
3887 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
3888 * when an anchor is clicked, the hover for the popup will cover the entire
3889 * window. This affects the area that will be obscured by the hover and
3890 * where clicking will dismiss it, as well as the calculations it does to
3891 * inform the best locations where to insert the popups content.
3892 * Other than that, the code is pretty standard. We also need to set our
3893 * callback for when an anchor is clicked, since it's our task to populate
3894 * the popup. There's no default for it.
3896 * The anchorview is no different, we only change a few things so it looks
3898 * @until elm_frame_content_set
3900 * Then we run, so stuff works and close our main function in the usual way.
3903 * Now, a little note. Normally you would use either one of anchorblock or
3904 * anchorview, set your one callback to clicks and do your stuff in there.
3905 * In this example, however, there are a few tricks to make it easier to
3906 * show both widgets in one go (and to save me some typing). So we have
3907 * two callbacks, one per widget, that will call a common function to do
3908 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
3909 * anchorview too, since both are equal, and passing a callback to use
3910 * for our buttons to end the hover, because each widget has a different
3912 * @until _anchorview_clicked_cb
3915 * The meat of our popup is in the following function. We check what kind
3916 * of menu we need to show, based on the name set to the anchor in the
3917 * markup text. If there's no type (something went wrong, no valid contact
3918 * in the address list) we are just putting a button that does nothing, but
3919 * it's perfectly reasonable to just end the hover and call it quits.
3921 * Our popup will consist of one main button in the middle of our hover,
3922 * and possibly a secondary button and a list of other options. We'll create
3923 * first our main button and check what kind of popup we need afterwards.
3926 * @until eina_stringshare_add
3929 * Each button has two callbacks, one is our hack to close the hover
3930 * properly based on which widget it belongs to, the other a simple
3931 * printf that will show the action with the anchors own data. This is
3932 * not how you would usually do it. Instead, the common case is to have
3933 * one callback for the button that will know which function to call to end
3934 * things, but since we are doing it this way it's worth noting that
3935 * smart callbacks will be called in reverse in respect to the order they
3936 * were added, and since our @c btn_end_cb will close the hover, and thus
3937 * delete our buttons, the other callback wouldn't be called if we had
3940 * After our telephone popup, there are a few others that are practically
3941 * the same, so they won't be shown here.
3943 * Once we are done with that, it's time to place our actions into our
3944 * hover. Main button goes in the middle without much questioning, and then
3945 * we see if we have a secondary button and a box of extra options.
3946 * Because I said so, secondary button goes on either side and box of
3947 * options either on top or below the main one, but to choose which
3948 * exactly, we use the hints our callback info has, which saves us from
3949 * having to do the math and see which side has more space available, with
3950 * a little special case where we delete our extra stuff if there's nowhere
3954 * @skip evas_object_smart
3955 * @until evas_object_del(box)
3959 * The example will look like this:
3960 * @image html screenshots/anchorblock_01.png
3961 * @image latex screenshots/anchorblock_01.eps
3963 * @example anchorblock_example_01.c
3966 * @addtogroup Anchorblock
3970 * @typedef Elm_Entry_Anchorblock_Info
3972 * The info sent in the callback for "anchor,clicked" signals emitted by
3973 * the Anchorblock widget.
3975 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
3977 * @struct _Elm_Entry_Anchorblock_Info
3979 * The info sent in the callback for "anchor,clicked" signals emitted by
3980 * the Anchorblock widget.
3982 struct _Elm_Entry_Anchorblock_Info
3984 const char *name; /**< Name of the anchor, as indicated in its href
3986 int button; /**< The mouse button used to click on it */
3987 Evas_Object *hover; /**< The hover object to use for the popup */
3989 Evas_Coord x, y, w, h;
3990 } anchor, /**< Geometry selection of text used as anchor */
3991 hover_parent; /**< Geometry of the object used as parent by the
3993 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3994 for content on the left side of
3995 the hover. Before calling the
3996 callback, the widget will make the
3997 necessary calculations to check
3998 which sides are fit to be set with
3999 content, based on the position the
4000 hover is activated and its distance
4001 to the edges of its parent object
4003 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4004 the right side of the hover.
4005 See @ref hover_left */
4006 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4007 of the hover. See @ref hover_left */
4008 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4009 below the hover. See @ref
4013 * Add a new Anchorblock object
4015 * @param parent The parent object
4016 * @return The new object or NULL if it cannot be created
4018 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4020 * Set the text to show in the anchorblock
4022 * Sets the text of the anchorblock to @p text. This text can include markup
4023 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4024 * of text that will be specially styled and react to click events, ended
4025 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4026 * "anchor,clicked" signal that you can attach a callback to with
4027 * evas_object_smart_callback_add(). The name of the anchor given in the
4028 * event info struct will be the one set in the href attribute, in this
4031 * Other markup can be used to style the text in different ways, but it's
4032 * up to the style defined in the theme which tags do what.
4033 * @deprecated use elm_object_text_set() instead.
4035 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4037 * Get the markup text set for the anchorblock
4039 * Retrieves the text set on the anchorblock, with markup tags included.
4041 * @param obj The anchorblock object
4042 * @return The markup text set or @c NULL if nothing was set or an error
4044 * @deprecated use elm_object_text_set() instead.
4046 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4048 * Set the parent of the hover popup
4050 * Sets the parent object to use by the hover created by the anchorblock
4051 * when an anchor is clicked. See @ref Hover for more details on this.
4053 * @param obj The anchorblock object
4054 * @param parent The object to use as parent for the hover
4056 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4058 * Get the parent of the hover popup
4060 * Get the object used as parent for the hover created by the anchorblock
4061 * widget. See @ref Hover for more details on this.
4062 * If no parent is set, the same anchorblock object will be used.
4064 * @param obj The anchorblock object
4065 * @return The object used as parent for the hover, NULL if none is set.
4067 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4069 * Set the style that the hover should use
4071 * When creating the popup hover, anchorblock will request that it's
4072 * themed according to @p style.
4074 * @param obj The anchorblock object
4075 * @param style The style to use for the underlying hover
4077 * @see elm_object_style_set()
4079 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4081 * Get the style that the hover should use
4083 * Get the style the hover created by anchorblock will use.
4085 * @param obj The anchorblock object
4086 * @return The style to use by the hover. NULL means the default is used.
4088 * @see elm_object_style_set()
4090 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4092 * Ends the hover popup in the anchorblock
4094 * When an anchor is clicked, the anchorblock widget will create a hover
4095 * object to use as a popup with user provided content. This function
4096 * terminates this popup, returning the anchorblock to its normal state.
4098 * @param obj The anchorblock object
4100 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4102 * Appends a custom item provider to the given anchorblock
4104 * Appends the given function to the list of items providers. This list is
4105 * called, one function at a time, with the given @p data pointer, the
4106 * anchorblock object and, in the @p item parameter, the item name as
4107 * referenced in its href string. Following functions in the list will be
4108 * called in order until one of them returns something different to NULL,
4109 * which should be an Evas_Object which will be used in place of the item
4112 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4113 * href=item/name\>\</item\>
4115 * @param obj The anchorblock object
4116 * @param func The function to add to the list of providers
4117 * @param data User data that will be passed to the callback function
4119 * @see elm_entry_item_provider_append()
4121 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);
4123 * Prepend a custom item provider to the given anchorblock
4125 * Like elm_anchorblock_item_provider_append(), but it adds the function
4126 * @p func to the beginning of the list, instead of the end.
4128 * @param obj The anchorblock object
4129 * @param func The function to add to the list of providers
4130 * @param data User data that will be passed to the callback function
4132 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);
4134 * Remove a custom item provider from the list of the given anchorblock
4136 * Removes the function and data pairing that matches @p func and @p data.
4137 * That is, unless the same function and same user data are given, the
4138 * function will not be removed from the list. This allows us to add the
4139 * same callback several times, with different @p data pointers and be
4140 * able to remove them later without conflicts.
4142 * @param obj The anchorblock object
4143 * @param func The function to remove from the list
4144 * @param data The data matching the function to remove from the list
4146 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);
4152 * @defgroup Bubble Bubble
4154 * @brief The Bubble is a widget to show text similarly to how speech is
4155 * represented in comics.
4157 * The bubble widget contains 5 important visual elements:
4158 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4159 * @li The @p icon is an image to which the frame's arrow points to.
4160 * @li The @p label is a text which appears to the right of the icon if the
4161 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4163 * @li The @p info is a text which appears to the right of the label. Info's
4164 * font is of a ligther color than label.
4165 * @li The @p content is an evas object that is shown inside the frame.
4167 * The position of the arrow, icon, label and info depends on which corner is
4168 * selected. The four available corners are:
4169 * @li "top_left" - Default
4172 * @li "bottom_right"
4174 * Signals that you can add callbacks for are:
4175 * @li "clicked" - This is called when a user has clicked the bubble.
4177 * For an example of using a buble see @ref bubble_01_example_page "this".
4182 * Add a new bubble to the parent
4184 * @param parent The parent object
4185 * @return The new object or NULL if it cannot be created
4187 * This function adds a text bubble to the given parent evas object.
4189 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4191 * Set the label of the bubble
4193 * @param obj The bubble object
4194 * @param label The string to set in the label
4196 * This function sets the title of the bubble. Where this appears depends on
4197 * the selected corner.
4198 * @deprecated use elm_object_text_set() instead.
4200 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4202 * Get the label of the bubble
4204 * @param obj The bubble object
4205 * @return The string of set in the label
4207 * This function gets the title of the bubble.
4208 * @deprecated use elm_object_text_set() instead.
4210 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212 * Set the info of the bubble
4214 * @param obj The bubble object
4215 * @param info The given info about the bubble
4217 * This function sets the info of the bubble. Where this appears depends on
4218 * the selected corner.
4219 * @deprecated use elm_object_text_set() instead.
4221 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4223 * Get the info of the bubble
4225 * @param obj The bubble object
4227 * @return The "info" string of the bubble
4229 * This function gets the info text.
4230 * @deprecated use elm_object_text_set() instead.
4232 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4234 * Set the content to be shown in the bubble
4236 * Once the content object is set, a previously set one will be deleted.
4237 * If you want to keep the old content object, use the
4238 * elm_bubble_content_unset() function.
4240 * @param obj The bubble object
4241 * @param content The given content of the bubble
4243 * This function sets the content shown on the middle of the bubble.
4245 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4247 * Get the content shown in the bubble
4249 * Return the content object which is set for this widget.
4251 * @param obj The bubble object
4252 * @return The content that is being used
4254 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4256 * Unset the content shown in the bubble
4258 * Unparent and return the content object which was set for this widget.
4260 * @param obj The bubble object
4261 * @return The content that was being used
4263 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4265 * Set the icon of the bubble
4267 * Once the icon object is set, a previously set one will be deleted.
4268 * If you want to keep the old content object, use the
4269 * elm_icon_content_unset() function.
4271 * @param obj The bubble object
4272 * @param icon The given icon for the bubble
4274 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4276 * Get the icon of the bubble
4278 * @param obj The bubble object
4279 * @return The icon for the bubble
4281 * This function gets the icon shown on the top left of bubble.
4283 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4285 * Unset the icon of the bubble
4287 * Unparent and return the icon object which was set for this widget.
4289 * @param obj The bubble object
4290 * @return The icon that was being used
4292 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4294 * Set the corner of the bubble
4296 * @param obj The bubble object.
4297 * @param corner The given corner for the bubble.
4299 * This function sets the corner of the bubble. The corner will be used to
4300 * determine where the arrow in the frame points to and where label, icon and
4303 * Possible values for corner are:
4304 * @li "top_left" - Default
4307 * @li "bottom_right"
4309 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4311 * Get the corner of the bubble
4313 * @param obj The bubble object.
4314 * @return The given corner for the bubble.
4316 * This function gets the selected corner of the bubble.
4318 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4320 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4321 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4328 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4329 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4330 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4331 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4332 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4333 /* smart callbacks called:
4334 * "clicked" - the user clicked the icon
4335 * "drag,start" - Someone started dragging the image out of the object
4336 * "drag,end" - Dragged item was dropped (somewhere)
4340 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4342 * @enum _Elm_Gesture_Types
4343 * Emum of supported gesture types.
4344 * @ingroup Elm_Gesture_Layer
4346 enum _Elm_Gesture_Types
4348 ELM_GESTURE_FIRST = 0,
4350 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4351 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4352 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4354 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4356 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4357 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4359 ELM_GESTURE_ZOOM, /**< Zoom */
4360 ELM_GESTURE_ROTATE, /**< Rotate */
4366 * @typedef Elm_Gesture_Types
4367 * Type for Emum of supported gesture types.
4368 * @ingroup Elm_Gesture_Layer
4370 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4373 * @enum _Elm_Gesture_State
4374 * Emum of gesture states.
4375 * @ingroup Elm_Gesture_Layer
4377 enum _Elm_Gesture_State
4379 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4380 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4381 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4382 ELM_GESTURE_STATE_END, /**< Gesture completed */
4383 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4386 * @typedef Elm_Gesture_State
4388 * @ingroup Elm_Gesture_Layer
4390 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4393 * @struct _Elm_Gesture_Taps_Info
4394 * Struct holds taps info for user
4395 * @ingroup Elm_Gesture_Layer
4397 struct _Elm_Gesture_Taps_Info
4399 Evas_Coord x, y; /**< Holds center point between fingers */
4400 unsigned int n; /**< Number of fingers tapped */
4401 unsigned int timestamp; /**< event timestamp */
4405 * @typedef Elm_Gesture_Taps_Info
4406 * holds taps info for user
4407 * @ingroup Elm_Gesture_Layer
4409 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4412 * @struct _Elm_Gesture_Momentum_Info
4413 * Struct holds momentum info for user
4414 * x1 and y1 are not necessarily in sync
4415 * x1 holds x value of x direction starting point
4416 * and same holds for y1.
4417 * This is noticeable when doing V-shape movement
4418 * @ingroup Elm_Gesture_Layer
4420 struct _Elm_Gesture_Momentum_Info
4421 { /* Report line ends, timestamps, and momentum computed */
4422 Evas_Coord x1; /**< Final-swipe direction starting point on X */
4423 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4424 Evas_Coord x2; /**< Final-swipe direction ending point on X */
4425 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
4427 unsigned int tx; /**< Timestamp of start of final x-swipe */
4428 unsigned int ty; /**< Timestamp of start of final y-swipe */
4430 Evas_Coord mx; /**< Momentum on X */
4431 Evas_Coord my; /**< Momentum on Y */
4435 * @typedef Elm_Gesture_Momentum_Info
4436 * holds momentum info for user
4437 * @ingroup Elm_Gesture_Layer
4439 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4442 * @struct _Elm_Gesture_Line_Info
4443 * Struct holds line info for user
4444 * @ingroup Elm_Gesture_Layer
4446 struct _Elm_Gesture_Line_Info
4447 { /* Report line ends, timestamps, and momentum computed */
4448 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4449 unsigned int n; /**< Number of fingers (lines) */
4450 /* FIXME should be radians, bot degrees */
4451 double angle; /**< Angle (direction) of lines */
4455 * @typedef _Elm_Gesture_Line_Info
4456 * Holds line info for user
4457 * @ingroup Elm_Gesture_Layer
4459 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4462 * @struct _Elm_Gesture_Zoom_Info
4463 * Struct holds zoom info for user
4464 * @ingroup Elm_Gesture_Layer
4466 struct _Elm_Gesture_Zoom_Info
4468 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4469 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4470 float zoom; /**< Zoom value: 1.0 means no zoom */
4471 float momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4475 * @typedef Elm_Gesture_Zoom_Info
4476 * Holds zoom info for user
4477 * @ingroup Elm_Gesture_Layer
4479 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4482 * @struct _Elm_Gesture_Rotate_Info
4483 * Struct holds rotation info for user
4484 * @ingroup Elm_Gesture_Layer
4486 struct _Elm_Gesture_Rotate_Info
4488 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4489 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4490 double base_angle; /**< Holds start-angle */
4491 double angle; /**< Rotation value: 0.0 means no rotation */
4492 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4496 * @typedef Elm_Gesture_Rotate_Info
4497 * Holds rotation info for user
4498 * @ingroup Elm_Gesture_Layer
4500 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4503 * @typedef Elm_Gesture_Event_Cb
4504 * User callback used to stream gesture info from gesture layer
4505 * @param data user data
4506 * @param event_info gesture report info
4507 * Returns a flag field to be applied on the causing event.
4508 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4509 * upon the event, in an irreversible way.
4511 * @ingroup Elm_Gesture_Layer
4513 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4516 * Use function to set callbacks to be notified about
4517 * change of state of gesture.
4518 * When a user registers a callback with this function
4519 * this means this gesture has to be tested.
4521 * When ALL callbacks for a gesture are set to NULL
4522 * it means user isn't interested in gesture-state
4523 * and it will not be tested.
4525 * @param obj Pointer to gesture-layer.
4526 * @param idx The gesture you would like to track its state.
4527 * @param cb callback function pointer.
4528 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4529 * @param data user info to be sent to callback (usually, Smart Data)
4531 * @ingroup Elm_Gesture_Layer
4533 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);
4536 * Call this function to get repeat-events settings.
4538 * @param obj Pointer to gesture-layer.
4540 * @return repeat events settings.
4541 * @see elm_gesture_layer_hold_events_set()
4542 * @ingroup Elm_Gesture_Layer
4544 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4547 * This function called in order to make gesture-layer repeat events.
4548 * Set this of you like to get the raw events only if gestures were not detected.
4549 * Clear this if you like gesture layer to fwd events as testing gestures.
4551 * @param obj Pointer to gesture-layer.
4552 * @param r Repeat: TRUE/FALSE
4554 * @ingroup Elm_Gesture_Layer
4556 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4559 * This function sets step-value for zoom action.
4560 * Set step to any positive value.
4561 * Cancel step setting by setting to 0.0
4563 * @param obj Pointer to gesture-layer.
4564 * @param s new zoom step value.
4566 * @ingroup Elm_Gesture_Layer
4568 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4571 * This function sets step-value for rotate action.
4572 * Set step to any positive value.
4573 * Cancel step setting by setting to 0.0
4575 * @param obj Pointer to gesture-layer.
4576 * @param s new roatate step value.
4578 * @ingroup Elm_Gesture_Layer
4580 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4583 * This function called to attach gesture-layer to an Evas_Object.
4584 * @param obj Pointer to gesture-layer.
4585 * @param t Pointer to underlying object (AKA Target)
4587 * @return TRUE, FALSE on success, failure.
4589 * @ingroup Elm_Gesture_Layer
4591 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4594 * Call this function to construct a new gesture-layer object.
4595 * This does not activate the gesture layer. You have to
4596 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4598 * @param parent the parent object.
4600 * @return Pointer to new gesture-layer object.
4602 * @ingroup Elm_Gesture_Layer
4604 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4607 typedef enum _Elm_Thumb_Animation_Setting
4609 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4610 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
4611 ELM_THUMB_ANIMATION_STOP,
4612 ELM_THUMB_ANIMATION_LAST
4613 } Elm_Thumb_Animation_Setting;
4615 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4616 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4617 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4618 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4619 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4620 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4621 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4622 EAPI void *elm_thumb_ethumb_client_get(void);
4623 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
4624 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4625 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4626 /* available styles:
4630 /* smart callbacks called:
4631 * "clicked" - This is called when a user has clicked the thumb without dragging around.
4632 * "clicked,double" - This is called when a user has double-clicked the thumb.
4633 * "press" - This is called when a user has pressed down the thumb.
4634 * "generate,start" - The thumbnail generation started.
4635 * "generate,stop" - The generation process stopped.
4636 * "generate,error" - The generation failed.
4637 * "load,error" - The thumbnail image loading failed.
4641 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4642 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4643 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4644 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4645 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4646 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4647 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4648 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4649 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4651 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4652 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4653 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4654 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4655 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4656 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);
4657 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
4658 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4659 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4660 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4661 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);
4662 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);
4663 /* smart callbacks called:
4664 * "clicked" - the user clicked the hoversel button and popped up the sel
4665 * "selected" - an item in the hoversel list is selected
4666 * "dismissed" - the hover is dismissed
4670 typedef enum _Elm_Toolbar_Shrink_Mode
4672 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
4673 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
4674 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
4675 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
4676 } Elm_Toolbar_Shrink_Mode;
4678 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
4679 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
4681 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4682 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
4683 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4684 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4685 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4686 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4687 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4688 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);
4689 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);
4690 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);
4691 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);
4692 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4693 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4694 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4695 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4696 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4697 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
4698 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4699 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4700 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4701 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
4702 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4703 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
4704 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4705 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4706 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4707 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4708 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
4709 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4710 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4711 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4712 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4713 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
4714 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4715 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
4716 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4717 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4718 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4719 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4720 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4721 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4722 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4723 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
4724 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4725 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
4726 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4727 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);
4728 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4729 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4730 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4731 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4732 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4733 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4734 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
4735 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);
4736 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4737 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
4738 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4739 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4740 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4741 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4742 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
4743 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4744 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4745 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4746 /* smart callbacks called:
4747 * "clicked" - when the user clicks on a toolbar item and becomes selected
4749 /* available styles:
4751 * transparent (no background or shadow, just show the provided content)
4755 EAPI double elm_tooltip_delay_get(void);
4756 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
4757 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
4758 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
4759 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
4760 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);
4761 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4762 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4763 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4764 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
4765 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4766 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4767 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4768 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4769 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4770 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4773 EAPI int elm_cursor_engine_only_get(void);
4774 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
4777 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
4778 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4779 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4780 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4781 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4782 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4783 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4784 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4785 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);
4786 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
4787 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4788 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
4789 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4790 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4791 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4792 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4793 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4794 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4795 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
4796 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4797 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4798 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4799 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4800 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
4801 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4802 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4803 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4804 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4805 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4806 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4808 /* smart callbacks called:
4809 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
4813 typedef enum _Elm_List_Mode
4815 ELM_LIST_COMPRESS = 0,
4821 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
4822 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4823 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);
4824 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);
4825 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);
4826 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);
4827 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);
4828 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4829 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
4830 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4831 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4832 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
4833 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4834 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4835 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4836 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4837 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4838 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4839 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4840 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4841 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
4842 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4843 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4844 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4845 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4846 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4847 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4848 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4849 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4850 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4851 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
4852 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4853 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
4854 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4855 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4856 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4857 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4858 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4859 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4860 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);
4861 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4862 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4863 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4864 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4865 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4866 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4867 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4868 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4869 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4870 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4871 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4872 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4873 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4874 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4875 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4876 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);
4877 /* smart callbacks called:
4878 * "clicked,double" - when the user double-clicked an item
4879 * "selected" - when the user selected an item
4880 * "unselected" - when the user selected an item
4881 * "longpressed" - an item in the hoversel list is long-pressed
4882 * "scroll,edge,top" - the list is scrolled until the top edge
4883 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
4884 * "scroll,edge,left" - the list is scrolled until the left edge
4885 * "scroll,edge,right" - the list is scrolled until the right edge
4888 // FIXME: incomplete - carousel. don't use this until this comment is removed
4889 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
4890 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
4891 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
4892 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
4893 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
4894 /* smart callbacks called:
4895 * "clicked" - when the user clicks on a carousel item and becomes selected
4899 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4900 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4901 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4902 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4903 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4904 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4905 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
4906 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4907 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
4909 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4910 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
4911 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4912 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
4913 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4914 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);
4915 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);
4916 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4917 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4918 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
4919 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
4920 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4921 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4922 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
4923 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
4925 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4926 /* smart callbacks called:
4927 * "changed" - Whenever the slider value is changed by the user.
4928 * "slider,drag,start" - dragging the slider indicator around has started
4929 * "slider,drag,stop" - dragging the slider indicator around has stopped
4930 * "delay,changed" - A short time after the value is changed by the user.
4931 * This will be called only when the user stops dragging for a very short
4932 * period or when they release their finger/mouse, so it avoids possibly
4933 * expensive reactions to the value change.
4940 * @addtogroup Actionslider Actionslider
4942 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
4943 * properties. The indicator is the element the user drags to choose a label.
4944 * When the position is set with magnet, when released the indicator will be
4945 * moved to it if it's nearest the magnetized position.
4947 * @note By default all positions are set as enabled.
4949 * Signals that you can add callbacks for are:
4951 * "selected" - when user selects an enabled position (the label is passed
4954 * "pos_changed" - when the indicator reaches any of the positions("left",
4955 * "right" or "center").
4957 * See an example of actionslider usage @ref actionslider_example_page "here"
4961 typedef enum _Elm_Actionslider_Indicator_Pos
4963 ELM_ACTIONSLIDER_INDICATOR_NONE,
4964 ELM_ACTIONSLIDER_INDICATOR_LEFT,
4965 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
4966 ELM_ACTIONSLIDER_INDICATOR_CENTER
4967 } Elm_Actionslider_Indicator_Pos;
4969 typedef enum _Elm_Actionslider_Magnet_Pos
4971 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
4972 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
4973 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
4974 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
4975 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
4976 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
4977 } Elm_Actionslider_Magnet_Pos;
4979 typedef enum _Elm_Actionslider_Label_Pos
4981 ELM_ACTIONSLIDER_LABEL_LEFT,
4982 ELM_ACTIONSLIDER_LABEL_RIGHT,
4983 ELM_ACTIONSLIDER_LABEL_CENTER,
4984 ELM_ACTIONSLIDER_LABEL_BUTTON
4985 } Elm_Actionslider_Label_Pos;
4987 /* smart callbacks called:
4988 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
4992 * Add a new actionslider to the parent.
4994 * @param parent The parent object
4995 * @return The new actionslider object or NULL if it cannot be created
4997 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5000 * Set actionslider label.
5002 * @param[in] obj The actionslider object
5003 * @param[in] pos The position of the label.
5004 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5005 * @param label The label which is going to be set.
5007 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5009 * Get actionslider labels.
5011 * @param obj The actionslider object
5012 * @param left_label A char** to place the left_label of @p obj into.
5013 * @param center_label A char** to place the center_label of @p obj into.
5014 * @param right_label A char** to place the right_label of @p obj into.
5016 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);
5018 * Get actionslider selected label.
5020 * @param obj The actionslider object
5021 * @return The selected label
5023 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5025 * Set actionslider indicator position.
5027 * @param obj The actionslider object.
5028 * @param pos The position of the indicator.
5030 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5032 * Get actionslider indicator position.
5034 * @param obj The actionslider object.
5035 * @return The position of the indicator.
5037 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5039 * Set actionslider magnet position. To make multiple positions magnets @c or
5040 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5042 * @param obj The actionslider object.
5043 * @param pos Bit mask indicating the magnet positions.
5045 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5047 * Get actionslider magnet position.
5049 * @param obj The actionslider object.
5050 * @return The positions with magnet property.
5052 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5054 * Set actionslider enabled position. To set multiple positions as enabled @c or
5055 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5057 * @note All the positions are enabled by default.
5059 * @param obj The actionslider object.
5060 * @param pos Bit mask indicating the enabled positions.
5062 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5064 * Get actionslider enabled position.
5066 * @param obj The actionslider object.
5067 * @return The enabled positions.
5069 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5071 * Set the label used on the indicator.
5073 * @param obj The actionslider object
5074 * @param label The label to be set on the indicator.
5075 * @deprecated use elm_object_text_set() instead.
5077 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5079 * Get the label used on the indicator object.
5081 * @param obj The actionslider object
5082 * @return The indicator label
5083 * @deprecated use elm_object_text_get() instead.
5085 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5088 * Hold actionslider object movement.
5090 * @param[in] obj The actionslider object
5091 * @param[in] flag Actionslider hold/release
5092 * (EINA_TURE = hold/EIN_FALSE = release)
5094 * @ingroup Actionslider
5096 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5104 typedef enum _Elm_Genlist_Item_Flags
5106 ELM_GENLIST_ITEM_NONE = 0,
5107 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5108 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5109 } Elm_Genlist_Item_Flags;
5110 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5111 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5112 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5113 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5114 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5115 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5116 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5117 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5119 struct _Elm_Genlist_Item_Class
5121 const char *item_style;
5123 GenlistItemLabelGetFunc label_get;
5124 GenlistItemIconGetFunc icon_get;
5125 GenlistItemStateGetFunc state_get;
5126 GenlistItemDelFunc del;
5127 GenlistItemMovedFunc moved;
5129 const char *edit_item_style;
5130 const char *mode_item_style;
5132 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5133 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5134 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5135 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5136 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5137 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5138 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5139 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5140 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5141 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5143 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5144 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5145 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5146 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5147 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5148 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5149 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5150 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5151 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5152 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5153 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5154 /* operations to add items */
5155 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);
5156 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);
5157 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);
5158 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);
5159 /* operations to retrieve existing items */
5160 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5161 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5162 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5163 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);
5164 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5165 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5166 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5167 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);
5168 /* available item styles:
5170 * default_style - The text part is a textblock
5172 * icon_top_text_bottom
5174 /* Genlist Item operation */
5175 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5176 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5177 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5178 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5179 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5180 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5181 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5182 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5183 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5184 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5185 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5186 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5187 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5188 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5189 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5190 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5191 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5192 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5193 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5194 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5195 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5196 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5197 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5198 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5199 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5200 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5201 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5202 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5203 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);
5204 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5205 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5206 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5207 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5208 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5209 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5210 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5211 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5212 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5213 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5214 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5215 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5216 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5217 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5218 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5219 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5220 /* Signals that you can add callbacks for are:
5221 * "clicked,double" - This is called when a user has double-clicked an item.
5222 * The event_info parameter is the genlist item that was
5224 * "selected" - This is called when a user has made an item selected. The
5225 * event_info parameter is the genlist item that was selected.
5226 * "unselected" - This is called when a user has made an item unselected. The
5227 * event_info parameter is the genlist item that was unselected.
5228 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5229 * and the item is now meant to be expanded. The event_info parameter is the
5230 * genlist item that was indicated to expand. It is the job of this callback
5231 * to then fill in the child items.
5232 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5233 * and the item is now meant to be contracted. The event_info parameter is
5234 * the genlist item that was indicated to contract. It is the job of this
5235 * callback to then delete the child items.
5236 * "expand,request" - This is called when a user has indicated they want to
5237 * expand a tree branch item. The callback should decide if the item can
5238 * expand (has any children) and then call elm_genlist_item_expanded_set()
5239 * appropriately to set the state. The event_info parameter is the genlist
5240 * item that was indicated to expand.
5241 * "contract,request" - This is called when a user has indicated they want to
5242 * contract a tree branch item. The callback should decide if the item can
5243 * contract (has any children) and then call elm_genlist_item_expanded_set()
5244 * appropriately to set the state. The event_info parameter is the genlist
5245 * item that was indicated to contract.
5246 * "realized" - This is called when the item in the list is created as a real
5247 * evas object. event_info parameter is the genlist item that was created.
5248 * The object may be deleted at any time, so it is up to the caller to
5249 * not use the object pointer from elm_genlist_item_object_get() in a way
5250 * where it may point to freed objects.
5251 * "unrealized" - This is called just before an item is unrealized. After
5252 * this call icon objects provided will be deleted and the item object
5253 * itself delete or be put into a floating cache.
5254 * "drag,start,up" - This is called when the item in the list has been dragged
5255 * (not scrolled) up.
5256 * "drag,start,down" - This is called when the item in the list has been dragged
5257 * (not scrolled) down.
5258 * "drag,start,left" - This is called when the item in the list has been dragged i
5259 * (not scrolled) left.
5260 * "drag,start,right" - This is called when the item in the list has been dragged
5261 * (not scrolled) right.
5262 * "drag,stop" - This is called when the item in the list has stopped being
5264 * "drag" - This is called when the item in the list is being dragged.
5265 * "longpressed" - This is called when the item is pressed for a certain amount
5266 * of time. By default it's 1 second.
5267 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5269 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5271 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5273 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5275 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5277 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5279 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5280 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5282 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5284 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5287 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5288 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5289 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5290 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5291 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5292 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5293 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5294 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5295 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5296 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5299 * @page tutorial_check Check example
5300 * @dontinclude check_example_01.c
5302 * This example will show 2 checkboxes, one with just a label and the second
5303 * one with both a label and an icon. This example also ilustrates how to
5304 * have the checkbox change the value of a variable and how to react to those
5307 * We will start with the usual setup code:
5310 * And now we create our first checkbox, set its label, tell it to change
5311 * the value of @p value when the checkbox stats is changed and ask to be
5312 * notified of state changes:
5315 * For our second checkbox we are going to set an icon so we need to create
5318 * @note For simplicity we are using a rectangle as icon, but any evas object
5321 * And for our second checkbox we set the label, icon and state to true:
5324 * We now do some more setup:
5327 * And finally implement the callback that will be called when the first
5328 * checkbox's state changes. This callback will use @p data to print a
5331 * @note This work because @p data is @p value(from the main function) and @p
5332 * value is changed when the checkbox is changed.
5334 * Our example will look like this:
5335 * @image html screenshots/check_example_01.png
5336 * @image latex screenshots/check_example_01.eps
5338 * @example check_example_01.c
5341 * @defgroup Check Check
5343 * @brief The check widget allows for toggling a value between true and
5346 * Check objects are a lot like radio objects in layout and functionality
5347 * except they do not work as a group, but independently and only toggle the
5348 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5349 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5350 * returns the current state. For convenience, like the radio objects, you
5351 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5354 * Signals that you can add callbacks for are:
5355 * "changed" - This is called whenever the user changes the state of one of
5356 * the check object(event_info is NULL).
5358 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5362 * @brief Add a new Check object
5364 * @param parent The parent object
5365 * @return The new object or NULL if it cannot be created
5367 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5369 * @brief Set the text label of the check object
5371 * @param obj The check object
5372 * @param label The text label string in UTF-8
5374 * @deprecated use elm_object_text_set() instead.
5376 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5378 * @brief Get the text label of the check object
5380 * @param obj The check object
5381 * @return The text label string in UTF-8
5383 * @deprecated use elm_object_text_get() instead.
5385 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5387 * @brief Set the icon object of the check object
5389 * @param obj The check object
5390 * @param icon The icon object
5392 * Once the icon object is set, a previously set one will be deleted.
5393 * If you want to keep that old content object, use the
5394 * elm_check_icon_unset() function.
5396 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5398 * @brief Get the icon object of the check object
5400 * @param obj The check object
5401 * @return The icon object
5403 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5405 * @brief Unset the icon used for the check object
5407 * @param obj The check object
5408 * @return The icon object that was being used
5410 * Unparent and return the icon object which was set for this widget.
5412 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5414 * @brief Set the on/off state of the check object
5416 * @param obj The check object
5417 * @param state The state to use (1 == on, 0 == off)
5419 * This sets the state of the check. If set
5420 * with elm_check_state_pointer_set() the state of that variable is also
5421 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5423 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5425 * @brief Get the state of the check object
5427 * @param obj The check object
5428 * @return The boolean state
5430 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5432 * @brief Set a convenience pointer to a boolean to change
5434 * @param obj The check object
5435 * @param statep Pointer to the boolean to modify
5437 * This sets a pointer to a boolean, that, in addition to the check objects
5438 * state will also be modified directly. To stop setting the object pointed
5439 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5440 * then when this is called, the check objects state will also be modified to
5441 * reflect the value of the boolean @p statep points to, just like calling
5442 * elm_check_state_set().
5444 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5450 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5451 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5452 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5453 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5454 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5455 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5456 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5457 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5458 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5459 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5460 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5461 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5462 /* smart callbacks called:
5463 * "changed" - when the radio status is changed
5466 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
5467 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
5468 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
5469 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
5472 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5473 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5474 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5475 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5476 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5477 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5478 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5479 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5481 /* available item styles:
5487 /* smart callbacks called:
5488 * "hide,finished" - when the previous page is hided
5491 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5492 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5493 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5494 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5495 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5497 struct _Elm_Slideshow_Item_Class
5499 struct _Elm_Slideshow_Item_Class_Func
5501 SlideshowItemGetFunc get;
5502 SlideshowItemDelFunc del;
5506 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5507 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5508 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);
5509 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5510 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5511 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5512 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5513 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5514 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5515 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5516 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5517 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5518 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5519 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5520 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5522 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5523 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5524 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5525 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5526 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5527 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5528 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5529 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5530 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5531 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5532 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5533 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5534 /* smart callbacks called:
5535 * "changed" - when the slideshow switch to another item
5539 typedef enum _Elm_Fileselector_Mode
5541 ELM_FILESELECTOR_LIST = 0,
5542 ELM_FILESELECTOR_GRID,
5543 ELM_FILESELECTOR_LAST
5544 } Elm_Fileselector_Mode;
5546 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5547 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5548 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5549 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5550 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5551 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5552 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5553 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5554 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5555 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5556 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5557 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5558 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5559 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5560 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5561 /* smart callbacks called:
5562 * "selected" - the user click on a file
5563 * "directory,open" - the list is populate with a new content. event_info is a directory.
5564 * "done" - the user click on the ok or cancel buttons
5568 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5569 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5570 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5571 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5572 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5573 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5574 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5575 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5576 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5577 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5579 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5580 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5581 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5582 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5583 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5584 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5585 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5586 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5587 /* smart callbacks called:
5589 /* available item styles:
5591 * wheel (simple style, no text, no progression, only pulse is available)
5595 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5596 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5597 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5598 /* smart callbacks called:
5602 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5603 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5604 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5605 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5606 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5607 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5608 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5609 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5610 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5611 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5612 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5613 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5614 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5615 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5616 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5617 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5618 /* smart callbacks called:
5619 * "changed" - when the spinner value changes
5620 * "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).
5622 /* available item styles:
5624 * vertical (two up/down buttons at the right side and text left aligned)
5628 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5630 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5631 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5632 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5633 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5634 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5635 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5636 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5637 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5638 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5639 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5640 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);
5641 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5642 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5643 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5644 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5645 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5646 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
5647 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5648 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5649 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
5650 /* smart callbacks called:
5651 * "changed" - when the selected index item changes
5652 * "delay,changed" - when the selected index item changes, but after some small idle period
5653 * "selected" - when the user releases a finger and selects an item
5654 * "level,up" - when the user moves a finger from the first level to the second level
5655 * "level,down" - when the user moves a finger from the second level to the first level
5659 typedef enum _Elm_Photocam_Zoom_Mode
5661 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
5662 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
5663 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
5664 ELM_PHOTOCAM_ZOOM_MODE_LAST
5665 } Elm_Photocam_Zoom_Mode;
5667 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5668 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5669 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5670 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
5671 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5672 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5673 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5674 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5675 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5676 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5677 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5678 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5679 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5680 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5681 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5682 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5683 /* smart callbacks called:
5684 * "clicked" - when image clicked
5685 * "press" - when mouse/finger held down initially on image
5686 * "longpressed" - when mouse/finger held for long time on image
5687 * "clicked,double" - when mouse/finger double-clicked
5688 * "load" - when photo load begins
5689 * "loaded" - when photo load done
5690 * "load,detail" - when detailed image load begins
5691 * "loaded,detail" - when detailed image load done
5692 * "zoom,start" - when zooming started
5693 * "zoom,stop" - when zooming stopped
5694 * "zoom,change" - when auto zoom mode changed zoom level
5695 * "scroll - the content has been scrolled (moved)
5696 * "scroll,anim,start" - scrolling animation has started
5697 * "scroll,anim,stop" - scrolling animation has stopped
5698 * "scroll,drag,start" - dragging the contents around has started
5699 * "scroll,drag,stop" - dragging the contents around has stopped
5703 typedef enum _Elm_Map_Zoom_Mode
5705 ELM_MAP_ZOOM_MODE_MANUAL,
5706 ELM_MAP_ZOOM_MODE_AUTO_FIT,
5707 ELM_MAP_ZOOM_MODE_AUTO_FILL,
5708 ELM_MAP_ZOOM_MODE_LAST
5709 } Elm_Map_Zoom_Mode;
5711 typedef enum _Elm_Map_Route_Sources
5713 ELM_MAP_ROUTE_SOURCE_YOURS,
5714 ELM_MAP_ROUTE_SOURCE_MONAV,
5715 ELM_MAP_ROUTE_SOURCE_ORS,
5716 ELM_MAP_ROUTE_SOURCE_LAST
5717 } Elm_Map_Route_Sources;
5719 typedef enum _Elm_Map_Name_Sources
5721 ELM_MAP_NAME_SOURCE_NOMINATIM,
5722 ELM_MAP_NAME_SOURCE_LAST
5723 } Elm_Map_Name_Sources;
5725 typedef enum _Elm_Map_Route_Type
5727 ELM_MAP_ROUTE_TYPE_MOTOCAR,
5728 ELM_MAP_ROUTE_TYPE_BICYCLE,
5729 ELM_MAP_ROUTE_TYPE_FOOT,
5730 ELM_MAP_ROUTE_TYPE_LAST
5731 } Elm_Map_Route_Type;
5733 typedef enum _Elm_Map_Route_Method
5735 ELM_MAP_ROUTE_METHOD_FASTEST,
5736 ELM_MAP_ROUTE_METHOD_SHORTEST,
5737 ELM_MAP_ROUTE_METHOD_LAST
5738 } Elm_Map_Route_Method;
5740 typedef enum _Elm_Map_Name_Method
5742 ELM_MAP_NAME_METHOD_SEARCH,
5743 ELM_MAP_NAME_METHOD_REVERSE,
5744 ELM_MAP_NAME_METHOD_LAST
5745 } Elm_Map_Name_Method;
5747 typedef struct _Elm_Map_Marker Elm_Map_Marker;
5748 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
5749 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
5750 typedef struct _Elm_Map_Route Elm_Map_Route;
5751 typedef struct _Elm_Map_Name Elm_Map_Name;
5752 typedef struct _Elm_Map_Track Elm_Map_Track;
5754 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
5755 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
5756 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
5757 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
5759 typedef char *(*ElmMapModuleSourceFunc) (void);
5760 typedef int (*ElmMapModuleZoomMinFunc) (void);
5761 typedef int (*ElmMapModuleZoomMaxFunc) (void);
5762 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
5763 typedef int (*ElmMapModuleRouteSourceFunc) (void);
5764 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
5765 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
5766 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
5767 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
5769 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5770 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5771 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5772 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5773 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5774 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
5775 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5776 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5777 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5778 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5779 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5780 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5781 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
5782 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);
5783 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);
5784 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5785 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
5786 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);
5787 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);
5788 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
5789 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5790 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
5791 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5792 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5793 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
5794 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5795 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5796 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5797 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
5798 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
5799 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
5800 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
5801 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
5802 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
5803 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
5804 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
5806 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
5807 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
5808 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
5809 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5810 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
5811 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5812 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
5813 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5814 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5815 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5816 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5817 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5818 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
5819 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5820 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);
5821 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5822 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
5823 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
5824 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5825 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5826 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5827 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
5828 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
5829 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
5830 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
5831 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);
5832 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5833 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
5837 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
5839 /* smart callbacks called:
5840 * "clicked" - when image clicked
5841 * "press" - when mouse/finger held down initially on image
5842 * "longpressed" - when mouse/finger held for long time on image
5843 * "clicked,double" - when mouse/finger double-clicked
5844 * "load,details" - when detailed image load begins
5845 * "loaded,details" - when detailed image load done
5846 * "zoom,start" - when zooming started
5847 * "zoom,stop" - when zooming stopped
5848 * "zoom,change" - when auto zoom mode changed zoom level
5849 * "scroll - the content has been scrolled (moved)
5850 * "scroll,anim,start" - scrolling animation has started
5851 * "scroll,anim,stop" - scrolling animation has stopped
5852 * "scroll,drag,start" - dragging the contents around has started
5853 * "scroll,drag,stop" - dragging the contents around has stopped
5857 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
5859 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
5861 EAPI double elm_route_lon_min_get(Evas_Object *obj);
5862 EAPI double elm_route_lat_min_get(Evas_Object *obj);
5863 EAPI double elm_route_lon_max_get(Evas_Object *obj);
5864 EAPI double elm_route_lat_max_get(Evas_Object *obj);
5868 typedef enum _Elm_Panel_Orient
5870 ELM_PANEL_ORIENT_TOP,
5871 ELM_PANEL_ORIENT_BOTTOM,
5872 ELM_PANEL_ORIENT_LEFT,
5873 ELM_PANEL_ORIENT_RIGHT,
5876 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5877 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
5878 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5879 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5880 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5881 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5882 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
5883 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5884 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
5890 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
5891 * Add events (move, start ...)
5893 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5894 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5895 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5896 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5897 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5898 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5899 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5900 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5901 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
5902 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5903 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5904 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
5905 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5908 typedef enum _Elm_Flip_Mode
5910 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
5911 ELM_FLIP_ROTATE_X_CENTER_AXIS,
5912 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
5913 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
5915 ELM_FLIP_CUBE_RIGHT,
5919 ELM_FLIP_PAGE_RIGHT,
5923 typedef enum _Elm_Flip_Interaction
5925 ELM_FLIP_INTERACTION_NONE,
5926 ELM_FLIP_INTERACTION_ROTATE,
5927 ELM_FLIP_INTERACTION_CUBE,
5928 ELM_FLIP_INTERACTION_PAGE
5929 } Elm_Flip_Interaction;
5930 typedef enum _Elm_Flip_Direction
5932 ELM_FLIP_DIRECTION_UP,
5933 ELM_FLIP_DIRECTION_DOWN,
5934 ELM_FLIP_DIRECTION_LEFT,
5935 ELM_FLIP_DIRECTION_RIGHT
5936 } Elm_Flip_Direction;
5938 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5939 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5940 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5941 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5942 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5943 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5944 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5945 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5946 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5947 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
5948 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
5949 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
5950 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
5951 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
5952 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
5953 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
5954 /* smart callbacks called:
5955 * "animate,begin" - when a flip animation was started
5956 * "animate,done" - when a flip animation is finished
5960 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5961 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
5962 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5963 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
5964 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5965 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5966 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5967 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5968 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5970 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5971 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5972 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5973 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5974 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
5975 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5976 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5977 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
5978 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
5979 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
5980 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5981 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5982 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5983 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5984 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5985 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5986 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5987 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5988 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5989 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5990 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5991 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
5992 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
5993 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
5994 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 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);
5996 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5997 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5998 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);
5999 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6000 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);
6001 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6002 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6003 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6004 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6005 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6006 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6007 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6008 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6009 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);
6010 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);
6011 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);
6012 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);
6013 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);
6014 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);
6015 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6016 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6017 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6018 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6019 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6020 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6021 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6022 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6023 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6024 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6025 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6026 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6027 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6030 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6031 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6032 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6033 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6034 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6037 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6038 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6039 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6040 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6041 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6042 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6043 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6044 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6045 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6046 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 * @defgroup Flipselector Flip Selector
6051 * A flip selector is a widget to show a set of @b text items, one
6052 * at a time, with the same sheet switching style as the @ref Clock
6053 * "clock" widget, when one changes the current displaying sheet
6054 * (thus, the "flip" in the name).
6056 * User clicks to flip sheets which are @b held for some time will
6057 * make the flip selector to flip continuosly and automatically for
6058 * the user. The interval between flips will keep growing in time,
6059 * so that it helps the user to reach an item which is distant from
6060 * the current selection.
6062 * Smart callbacks one can register to:
6063 * - @c "selected" - when the widget's selected text item is changed
6064 * - @c "overflowed" - when the widget's current selection is changed
6065 * from the first item in its list to the last
6066 * - @c "underflowed" - when the widget's current selection is changed
6067 * from the last item in its list to the first
6069 * Available styles for it:
6072 * Here is an example on its usage:
6073 * @li @ref flipselector_example
6077 * @addtogroup Flipselector
6081 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6084 * Add a new flip selector widget to the given parent Elementary
6085 * (container) widget
6087 * @param parent The parent object
6088 * @return a new flip selector widget handle or @c NULL, on errors
6090 * This function inserts a new flip selector widget on the canvas.
6092 * @ingroup Flipselector
6094 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6097 * Programmatically select the next item of a flip selector widget
6099 * @param obj The flipselector object
6101 * @note The selection will be animated. Also, if it reaches the
6102 * end of its list of member items, it will continue with the first
6105 * @ingroup Flipselector
6107 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6110 * Programmatically select the previous item of a flip selector
6113 * @param obj The flipselector object
6115 * @note The selection will be animated. Also, if it reaches the
6116 * beginning of its list of member items, it will continue with the
6117 * last one backwards.
6119 * @ingroup Flipselector
6121 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6124 * Append a (text) item to a flip selector widget
6126 * @param obj The flipselector object
6127 * @param label The (text) label of the new item
6128 * @param func Convenience callback function to take place when
6130 * @param data Data passed to @p func, above
6131 * @return A handle to the item added or @c NULL, on errors
6133 * The widget's list of labels to show will be appended with the
6134 * given value. If the user wishes so, a callback function pointer
6135 * can be passed, which will get called when this same item is
6138 * @note The current selection @b won't be modified by appending an
6139 * element to the list.
6141 * @note The maximum length of the text label is going to be
6142 * determined <b>by the widget's theme</b>. Strings larger than
6143 * that value are going to be @b truncated.
6145 * @ingroup Flipselector
6147 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6150 * Prepend 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 prepended 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 prepending
6165 * an 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_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6176 * Get the internal list of items in a given flip selector widget.
6178 * @param obj The flipselector object
6179 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6182 * This list is @b not to be modified in any way and must not be
6183 * freed. Use the list members with functions like
6184 * elm_flipselector_item_label_set(),
6185 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6186 * elm_flipselector_item_del(),
6187 * elm_flipselector_item_selected_get(),
6188 * elm_flipselector_item_selected_set().
6190 * @warning This list is only valid until @p obj object's internal
6191 * items list is changed. It should be fetched again with another
6192 * call to this function when changes happen.
6194 * @ingroup Flipselector
6196 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6199 * Get the first item in the given flip selector widget's list of
6202 * @param obj The flipselector object
6203 * @return The first item or @c NULL, if it has no items (and on
6206 * @see elm_flipselector_item_append()
6207 * @see elm_flipselector_last_item_get()
6209 * @ingroup Flipselector
6211 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6214 * Get the last item in the given flip selector widget's list of
6217 * @param obj The flipselector object
6218 * @return The last item or @c NULL, if it has no items (and on
6221 * @see elm_flipselector_item_prepend()
6222 * @see elm_flipselector_first_item_get()
6224 * @ingroup Flipselector
6226 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6229 * Get the currently selected item in a flip selector widget.
6231 * @param obj The flipselector object
6232 * @return The selected item or @c NULL, if the widget has no items
6235 * @ingroup Flipselector
6237 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6240 * Set whether a given flip selector widget's item should be the
6241 * currently selected one.
6243 * @param item The flip selector item
6244 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6246 * This sets whether @p item is or not the selected (thus, under
6247 * display) one. If @p item is different than one under display,
6248 * the latter will be unselected. If the @p item is set to be
6249 * unselected, on the other hand, the @b first item in the widget's
6250 * internal members list will be the new selected one.
6252 * @see elm_flipselector_item_selected_get()
6254 * @ingroup Flipselector
6256 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6259 * Get whether a given flip selector widget's item is the currently
6262 * @param item The flip selector item
6263 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6266 * @see elm_flipselector_item_selected_set()
6268 * @ingroup Flipselector
6270 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6273 * Delete a given item from a flip selector widget.
6275 * @param item The item to delete
6277 * @ingroup Flipselector
6279 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6282 * Get the label of a given flip selector widget's item.
6284 * @param item The item to get label from
6285 * @return The text label of @p item or @c NULL, on errors
6287 * @see elm_flipselector_item_label_set()
6289 * @ingroup Flipselector
6291 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6294 * Set the label of a given flip selector widget's item.
6296 * @param item The item to set label on
6297 * @param label The text label string, in UTF-8 encoding
6299 * @see elm_flipselector_item_label_get()
6301 * @ingroup Flipselector
6303 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6306 * Gets the item before @p item in a flip selector widget's
6307 * internal list of items.
6309 * @param item The item to fetch previous from
6310 * @return The item before the @p item, in its parent's list. If
6311 * there is no previous item for @p item or there's an
6312 * error, @c NULL is returned.
6314 * @see elm_flipselector_item_next_get()
6316 * @ingroup Flipselector
6318 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6321 * Gets the item after @p item in a flip selector widget's
6322 * internal list of items.
6324 * @param item The item to fetch next from
6325 * @return The item after the @p item, in its parent's list. If
6326 * there is no next item for @p item or there's an
6327 * error, @c NULL is returned.
6329 * @see elm_flipselector_item_next_get()
6331 * @ingroup Flipselector
6333 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6336 * Set the interval on time updates for an user mouse button hold
6337 * on a flip selector widget.
6339 * @param obj The flip selector object
6340 * @param interval The (first) interval value in seconds
6342 * This interval value is @b decreased while the user holds the
6343 * mouse pointer either flipping up or flipping doww a given flip
6346 * This helps the user to get to a given item distant from the
6347 * current one easier/faster, as it will start to flip quicker and
6348 * quicker on mouse button holds.
6350 * The calculation for the next flip interval value, starting from
6351 * the one set with this call, is the previous interval divided by
6352 * 1.05, so it decreases a little bit.
6354 * The default starting interval value for automatic flips is
6357 * @see elm_flipselector_interval_get()
6359 * @ingroup Flipselector
6361 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6364 * Get the interval on time updates for an user mouse button hold
6365 * on a flip selector widget.
6367 * @param obj The flip selector object
6368 * @return The (first) interval value, in seconds, set on it
6370 * @see elm_flipselector_interval_set() for more details
6372 * @ingroup Flipselector
6374 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6381 * @addtogroup Animator Animator
6382 * @ingroup Elementary
6384 * @brief Functions to ease creation of animations.
6386 * elm_animator is designed to provide an easy way to create animations.
6387 * Creating an animation with elm_animator is as simple as setting a
6388 * duration, an operating callback and telling it to run the animation.
6389 * However that is not the full extent of elm_animator's ability, animations
6390 * can be paused and resumed, reversed and the animation need not be linear.
6392 * To run an animation you must specify at least a duration and operation
6393 * callback, not setting any other properties will create a linear animation
6394 * that runs once and is not reversed.
6396 * @ref elm_animator_example_page_01 "This" example should make all of that
6399 * @warning elm_animator is @b not a widget.
6403 * @brief Type of curve desired for animation.
6405 * The speed in which an animation happens doesn't have to be linear, some
6406 * animations will look better if they're accelerating or decelerating, so
6407 * elm_animator provides four options in this regard:
6408 * @image html elm_animator_curve_style.png
6409 * @image latex elm_animator_curve_style.eps width=\textwidth
6410 * As can be seen in the image the speed of the animation will be:
6411 * @li ELM_ANIMATOR_CURVE_LINEAR constant
6412 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6413 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6414 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6418 ELM_ANIMATOR_CURVE_LINEAR,
6419 ELM_ANIMATOR_CURVE_IN_OUT,
6420 ELM_ANIMATOR_CURVE_IN,
6421 ELM_ANIMATOR_CURVE_OUT
6422 } Elm_Animator_Curve_Style;
6423 typedef struct _Elm_Animator Elm_Animator;
6425 * Called back per loop of an elementary animators cycle
6426 * @param data user-data given to elm_animator_operation_callback_set()
6427 * @param animator the animator being run
6428 * @param double the position in the animation
6430 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6432 * Called back when an elementary animator finishes
6433 * @param data user-data given to elm_animator_completion_callback_set()
6435 typedef void (*Elm_Animator_Completion_Cb) (void *data);
6438 * @brief Create a new animator.
6440 * @param[in] parent Parent object
6442 * The @a parent argument can be set to NULL for no parent. If a parent is set
6443 * there is no need to call elm_animator_del(), when the parent is deleted it
6444 * will delete the animator.
6445 * @deprecated Use @ref Transit instead.
6448 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
6450 * Deletes the animator freeing any resources it used. If the animator was
6451 * created with a NULL parent this must be called, otherwise it will be
6452 * automatically called when the parent is deleted.
6454 * @param[in] animator Animator object
6455 * @deprecated Use @ref Transit instead.
6457 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6459 * Set the duration of the animation.
6461 * @param[in] animator Animator object
6462 * @param[in] duration Duration in second
6463 * @deprecated Use @ref Transit instead.
6465 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6467 * @brief Set the callback function for animator operation.
6469 * @param[in] animator Animator object
6470 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6471 * @param[in] data Callback function user argument
6473 * The @p func callback will be called with a frame value in range [0, 1] which
6474 * indicates how far along the animation should be. It is the job of @p func to
6475 * actually change the state of any object(or objects) that are being animated.
6476 * @deprecated Use @ref Transit instead.
6478 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6480 * Set the callback function for the when the animation ends.
6482 * @param[in] animator Animator object
6483 * @param[in] func Callback function pointe
6484 * @param[in] data Callback function user argument
6486 * @warning @a func will not be executed if elm_animator_stop() is called.
6487 * @deprecated Use @ref Transit instead.
6489 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6491 * @brief Stop animator.
6493 * @param[in] animator Animator object
6495 * If called before elm_animator_animate() it does nothing. If there is an
6496 * animation in progress the animation will be stopped(the operation callback
6497 * will not be executed again) and it can't be restarted using
6498 * elm_animator_resume().
6499 * @deprecated Use @ref Transit instead.
6501 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6503 * Set the animator repeat count.
6505 * @param[in] animator Animator object
6506 * @param[in] repeat_cnt Repeat count
6507 * @deprecated Use @ref Transit instead.
6509 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6511 * @brief Start animation.
6513 * @param[in] animator Animator object
6515 * This function starts the animation if the nescessary properties(duration
6516 * and operation callback) have been set. Once started the animation will
6517 * run until complete or elm_animator_stop() is called.
6518 * @deprecated Use @ref Transit instead.
6520 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6522 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6524 * @param[in] animator Animator object
6525 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6526 * @deprecated Use @ref Transit instead.
6528 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6530 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6532 * @param[in] animator Animator object
6533 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6534 * @deprecated Use @ref Transit instead.
6536 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6538 * @brief Sets wether the animation should be automatically reversed.
6540 * @param[in] animator Animator object
6541 * @param[in] reverse Reverse or not
6543 * This controls wether the animation will be run on reverse imediately after
6544 * running forward. When this is set together with repetition the animation
6545 * will run in reverse once for each time it ran forward.@n
6546 * Runnin an animation in reverse is accomplished by calling the operation
6547 * callback with a frame value starting at 1 and diminshing until 0.
6548 * @deprecated Use @ref Transit instead.
6550 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6552 * Gets wether the animation will automatically reversed
6554 * @param[in] animator Animator object
6555 * @deprecated Use @ref Transit instead.
6557 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6559 * Gets the status for the animator operation. The status of the animator @b
6560 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6561 * only informs if the animation was started and has not ended(either normally
6562 * or through elm_animator_stop()).
6564 * @param[in] animator Animator object
6565 * @deprecated Use @ref Transit instead.
6567 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6569 * Gets how many times the animation will be repeated
6571 * @param[in] animator Animator object
6572 * @deprecated Use @ref Transit instead.
6574 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6576 * Pause the animator.
6578 * @param[in] animator Animator object
6580 * This causes the animation to be temporarily stopped(the operation callback
6581 * will not be called). If the animation is not yet running this is a no-op.
6582 * Once an animation has been paused with this function it can be resumed
6583 * using elm_animator_resume().
6584 * @deprecated Use @ref Transit instead.
6586 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6588 * @brief Resumes the animator.
6590 * @param[in] animator Animator object
6592 * Resumes an animation that was paused using elm_animator_pause(), after
6593 * calling this function calls to the operation callback will happen
6594 * normally. If an animation is stopped by means of elm_animator_stop it
6595 * @b can't be restarted with this function.@n
6597 * @warning When an animation is resumed it doesn't start from where it was paused, it
6598 * will go to where it would have been if it had not been paused. If an
6599 * animation with a duration of 3 seconds is paused after 1 second for 1 second
6600 * it will resume as if it had ben animating for 2 seconds, the operating
6601 * callback will be called with a frame value of aproximately 2/3.
6602 * @deprecated Use @ref Transit instead.
6604 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6612 ELM_CALENDAR_UNIQUE,
6614 ELM_CALENDAR_WEEKLY,
6615 ELM_CALENDAR_MONTHLY,
6616 ELM_CALENDAR_ANNUALLY
6617 } Elm_Calendar_Mark_Repeat;
6618 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6620 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6621 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6622 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6623 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6624 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6625 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6626 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6627 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6629 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6630 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6631 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6632 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);
6633 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6634 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6635 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6636 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
6637 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6638 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6639 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6640 /* smart callbacks called:
6641 * changed - emitted when the user select a day or change the displayed
6646 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
6648 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6649 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6650 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
6651 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6652 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6653 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6654 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6655 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6656 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6657 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);
6658 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6659 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6660 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6661 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);
6662 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6663 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6664 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6665 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6666 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6667 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6668 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6669 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6670 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6671 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6672 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6673 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6674 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6675 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6676 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
6677 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);
6678 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6679 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6680 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6681 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6682 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6683 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6684 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6685 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6686 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6687 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6688 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
6689 /* smart callbacks called:
6690 * "selected" - when item is selected (scroller stops)
6694 * @page tutorial_colorselector Color selector example
6695 * @dontinclude colorselector_example_01.c
6697 * This example shows how to change the color of a rectangle using a color
6698 * selector. We aren't going to explain a lot of the code since it's the
6702 * Now that we have a window with background and a rectangle we can create
6703 * our color_selector and set it's initial color to fully opaque blue:
6706 * Next we tell ask to be notified whenever the color changes:
6709 * We follow that we some more run of the mill setup code:
6712 * And now get to the callback that sets the color of the rectangle:
6715 * This example will look like this:
6716 * @image html screenshots/colorselector_example_01.png
6717 * @image latex screenshots/colorselector_example_01.eps
6719 * @example colorselector_example_01.c
6722 * @defgroup Colorselector Colorselector
6726 * @brief Widget for user to select a color.
6728 * Signals that you can add callbacks for are:
6729 * "changed" - When the color value changes(event_info is NULL).
6731 * See @ref tutorial_colorselector.
6734 * @brief Add a new colorselector to the parent
6736 * @param parent The parent object
6737 * @return The new object or NULL if it cannot be created
6739 * @ingroup Colorselector
6741 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6743 * Set a color for the colorselector
6745 * @param obj Colorselector object
6746 * @param r r-value of color
6747 * @param g g-value of color
6748 * @param b b-value of color
6749 * @param a a-value of color
6751 * @ingroup Colorselector
6753 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6755 * Get a color from the colorselector
6757 * @param obj Colorselector object
6758 * @param r integer pointer for r-value of color
6759 * @param g integer pointer for g-value of color
6760 * @param b integer pointer for b-value of color
6761 * @param a integer pointer for a-value of color
6763 * @ingroup Colorselector
6765 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6770 /* Contextual Popup */
6771 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
6773 typedef enum _Elm_Ctxpopup_Direction
6775 ELM_CTXPOPUP_DIRECTION_DOWN,
6776 ELM_CTXPOPUP_DIRECTION_RIGHT,
6777 ELM_CTXPOPUP_DIRECTION_LEFT,
6778 ELM_CTXPOPUP_DIRECTION_UP,
6779 } Elm_Ctxpopup_Direction;
6781 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6782 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6783 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6784 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6785 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
6786 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
6787 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6788 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6789 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6790 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6791 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);
6792 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6793 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6794 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6795 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
6796 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6797 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);
6798 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);
6799 /* smart callbacks called:
6800 * "dismissed" - the ctxpopup was dismissed
6804 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
6806 struct _Colorpalette_Color
6808 unsigned int r, g, b;
6811 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
6812 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
6813 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
6814 /* smart callbacks called:
6815 * "clicked" - when image clicked
6819 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
6820 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
6821 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
6822 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
6823 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
6824 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
6825 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
6826 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
6827 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
6828 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
6829 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
6830 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
6831 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
6832 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
6833 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
6834 /* smart callbacks called:
6835 * "clicked" - when an editfield is clicked
6836 * "unfocused" - when an editfield is unfocused
6840 /* Sliding Drawer */
6841 typedef enum _Elm_SlidingDrawer_Pos
6843 ELM_SLIDINGDRAWER_BOTTOM,
6844 ELM_SLIDINGDRAWER_LEFT,
6845 ELM_SLIDINGDRAWER_RIGHT,
6846 ELM_SLIDINGDRAWER_TOP
6847 } Elm_SlidingDrawer_Pos;
6849 typedef struct _Elm_SlidingDrawer_Drag_Value
6852 } Elm_SlidingDrawer_Drag_Value;
6854 EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
6855 EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
6856 EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
6857 EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
6858 EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
6859 EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
6861 /* multibuttonentry */
6862 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
6863 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
6864 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
6865 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
6866 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
6867 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
6868 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
6869 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
6870 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
6871 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
6872 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
6873 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
6874 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
6875 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
6876 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
6877 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
6878 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
6879 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
6880 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
6881 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
6882 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
6883 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
6884 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
6885 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
6886 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
6887 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
6888 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
6889 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
6890 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
6891 /* smart callback called:
6892 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
6893 * "added" - This signal is emitted when a new multibuttonentry item is added.
6894 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
6895 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
6896 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
6897 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
6898 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
6899 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
6900 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
6901 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
6902 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
6903 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
6905 /* available styles:
6910 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
6911 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
6912 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
6913 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
6914 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
6915 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
6916 /* smart callback called:
6917 * "expanded" - This signal is emitted when a stackedicon is expanded.
6918 * "clicked" - This signal is emitted when a stackedicon is clicked.
6920 /* available styles:
6925 typedef struct _Dialogue_Item Dialogue_Item;
6927 typedef enum _Elm_Dialoguegourp_Item_Style
6929 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
6930 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
6931 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
6932 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
6933 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
6934 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
6935 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
6936 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
6937 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
6938 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
6939 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
6940 } Elm_Dialoguegroup_Item_Style;
6942 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
6943 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
6944 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
6945 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
6946 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
6947 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
6948 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
6949 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
6950 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
6951 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
6952 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
6953 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
6954 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
6955 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
6956 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
6957 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
6962 ELM_DAYSELECTOR_SUN,
6963 ELM_DAYSELECTOR_MON,
6964 ELM_DAYSELECTOR_TUE,
6965 ELM_DAYSELECTOR_WED,
6966 ELM_DAYSELECTOR_THU,
6967 ELM_DAYSELECTOR_FRI,
6969 } Elm_DaySelector_Day;
6971 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
6972 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
6973 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
6976 typedef struct _Imageslider_Item Elm_Imageslider_Item;
6977 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
6978 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6979 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);
6980 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);
6981 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);
6982 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6983 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6984 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6985 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6986 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6987 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6988 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6989 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6990 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6991 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
6992 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6997 * @defgroup Transit Transit
6998 * @ingroup Elementary
7000 * Transit is designed to apply various animated transition effects to @c
7001 * Evas_Object, such like translation, rotation, etc. For using these
7002 * effects, create an @ref Elm_Transit and add the desired transition effects.
7004 * Once the effects are added into transit, they will be automatically
7005 * managed (their callback will be called until the duration is ended, and
7006 * they will be deleted on completion).
7010 * Elm_Transit *trans = elm_transit_add();
7011 * elm_transit_object_add(trans, obj);
7012 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7013 * elm_transit_duration_set(transit, 1);
7014 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7015 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7016 * elm_transit_repeat_times_set(transit, 3);
7019 * Some transition effects are used to change the properties of objects. They
7021 * @li @ref elm_transit_effect_translation_add
7022 * @li @ref elm_transit_effect_color_add
7023 * @li @ref elm_transit_effect_rotation_add
7024 * @li @ref elm_transit_effect_wipe_add
7025 * @li @ref elm_transit_effect_zoom_add
7026 * @li @ref elm_transit_effect_resizing_add
7028 * Other transition effects are used to make one object disappear and another
7029 * object appear on its old place. These effects are:
7031 * @li @ref elm_transit_effect_flip_add
7032 * @li @ref elm_transit_effect_resizable_flip_add
7033 * @li @ref elm_transit_effect_fade_add
7034 * @li @ref elm_transit_effect_blend_add
7036 * It's also possible to make a transition chain with @ref
7037 * elm_transit_chain_transit_add.
7039 * @warning We strongly recommend to use elm_transit just when edje can not do
7040 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7041 * animations can be manipulated inside the theme.
7044 * @li @ref transit_example_01_explained
7045 * @li @ref transit_example_02_explained
7046 * @li @ref transit_example_03_c
7047 * @li @ref transit_example_04_c
7053 * @enum Elm_Transit_Tween_Mode
7055 * The type of acceleration used in the transition.
7059 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7060 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7061 over time, then decrease again
7063 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7065 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7067 } Elm_Transit_Tween_Mode;
7070 * @enum Elm_Transit_Effect_Flip_Axis
7072 * The axis where flip effect should be applied.
7076 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7077 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7078 } Elm_Transit_Effect_Flip_Axis;
7080 * @enum Elm_Transit_Effect_Wipe_Dir
7082 * The direction where the wipe effect should occur.
7086 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7087 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7088 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7089 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7090 } Elm_Transit_Effect_Wipe_Dir;
7091 /** @enum Elm_Transit_Effect_Wipe_Type
7093 * Whether the wipe effect should show or hide the object.
7097 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7099 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7101 } Elm_Transit_Effect_Wipe_Type;
7104 * @typedef Elm_Transit
7106 * The Transit created with elm_transit_add(). This type has the information
7107 * about the objects which the transition will be applied, and the
7108 * transition effects that will be used. It also contains info about
7109 * duration, number of repetitions, auto-reverse, etc.
7111 typedef struct _Elm_Transit Elm_Transit;
7112 typedef void Elm_Transit_Effect;
7114 * @typedef Elm_Transit_Effect_Transition_Cb
7116 * Transition callback called for this effect on each transition iteration.
7118 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7120 * Elm_Transit_Effect_End_Cb
7122 * Transition callback called for this effect when the transition is over.
7124 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7129 * @note Is not necessary to delete the transit object, it will be deleted at
7130 * the end of its operation.
7131 * @note The transit will start playing when the program enter in the main loop, is not
7132 * necessary to give a start to the transit.
7134 * @return The transit object.
7138 EAPI Elm_Transit *elm_transit_add(void);
7141 * Stops the animation and delete the @p transit object.
7143 * Call this function if you wants to stop the animation before the duration
7144 * time. Make sure the @p transit object is still alive with
7145 * elm_transit_del_cb_set() function.
7146 * All added effects will be deleted, calling its repective data_free_cb
7147 * functions. The function setted by elm_transit_del_cb_set() will be called.
7149 * @see elm_transit_del_cb_set()
7151 * @param transit The transit object to be deleted.
7154 * @warning Just call this function if you are sure the transit is alive.
7156 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7159 * Add a new effect to the transit.
7161 * @note The cb function and the data are the key to the effect. If you try to
7162 * add an already added effect, nothing is done.
7163 * @note After the first addition of an effect in @p transit, if its
7164 * effect list become empty again, the @p transit will be killed by
7165 * elm_transit_del(transit) function.
7169 * Elm_Transit *transit = elm_transit_add();
7170 * elm_transit_effect_add(transit,
7171 * elm_transit_effect_blend_op,
7172 * elm_transit_effect_blend_context_new(),
7173 * elm_transit_effect_blend_context_free);
7176 * @param transit The transit object.
7177 * @param transition_cb The operation function. It is called when the
7178 * animation begins, it is the function that actually performs the animation.
7179 * It is called with the @p data, @p transit and the time progression of the
7180 * animation (a double value between 0.0 and 1.0).
7181 * @param effect The context data of the effect.
7182 * @param end_cb The function to free the context data, it will be called
7183 * at the end of the effect, it must finalize the animation and free the
7187 * @warning The transit free the context data at the and of the transition with
7188 * the data_free_cb function, do not use the context data in another transit.
7190 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);
7193 * Delete an added effect.
7195 * This function will remove the effect from the @p transit, calling the
7196 * data_free_cb to free the @p data.
7198 * @see elm_transit_effect_add()
7200 * @note If the effect is not found, nothing is done.
7201 * @note If the effect list become empty, this function will call
7202 * elm_transit_del(transit), that is, it will kill the @p transit.
7204 * @param transit The transit object.
7205 * @param transition_cb The operation function.
7206 * @param effect The context data of the effect.
7210 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);
7213 * Add new object to apply the effects.
7215 * @note After the first addition of an object in @p transit, if its
7216 * object list become empty again, the @p transit will be killed by
7217 * elm_transit_del(transit) function.
7218 * @note If the @p obj belongs to another transit, the @p obj will be
7219 * removed from it and it will only belong to the @p transit. If the old
7220 * transit stays without objects, it will die.
7221 * @note When you add an object into the @p transit, its state from
7222 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7223 * transit ends, if you change this state whith evas_object_pass_events_set()
7224 * after add the object, this state will change again when @p transit stops to
7227 * @param transit The transit object.
7228 * @param obj Object to be animated.
7231 * @warning It is not allowed to add a new object after transit begins to go.
7233 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7236 * Removes an added object from the transit.
7238 * @note If the @p obj is not in the @p transit, nothing is done.
7239 * @note If the list become empty, this function will call
7240 * elm_transit_del(transit), that is, it will kill the @p transit.
7242 * @param transit The transit object.
7243 * @param obj Object to be removed from @p transit.
7246 * @warning It is not allowed to remove objects after transit begins to go.
7248 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7251 * Get the objects of the transit.
7253 * @param transit The transit object.
7254 * @return a Eina_List with the objects from the transit.
7258 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7261 * Enable/disable keeping up the objects states.
7262 * If it is not kept, the objects states will be reset when transition ends.
7264 * @note @p transit can not be NULL.
7265 * @note One state includes geometry, color, map data.
7267 * @param transit The transit object.
7268 * @param state_keep Keeping or Non Keeping.
7272 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7275 * Get a value whether the objects states will be reset or not.
7277 * @note @p transit can not be NULL
7279 * @see elm_transit_objects_final_state_keep_set()
7281 * @param transit The transit object.
7282 * @return EINA_TRUE means the states of the objects will be reset.
7283 * If @p transit is NULL, EINA_FALSE is returned
7287 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7290 * Set the event enabled when transit is operating.
7292 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7293 * events from mouse and keyboard during the animation.
7294 * @note When you add an object with elm_transit_object_add(), its state from
7295 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7296 * transit ends, if you change this state with evas_object_pass_events_set()
7297 * after adding the object, this state will change again when @p transit stops
7300 * @param transit The transit object.
7301 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7302 * ignored otherwise.
7306 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7309 * Get the value of event enabled status.
7311 * @see elm_transit_event_enabled_set()
7313 * @param transit The Transit object
7314 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7315 * EINA_FALSE is returned
7319 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7322 * Set the user-callback function when the transit is deleted.
7324 * @note Using this function twice will overwrite the first function setted.
7325 * @note the @p transit object will be deleted after call @p cb function.
7327 * @param transit The transit object.
7328 * @param cb Callback function pointer. This function will be called before
7329 * the deletion of the transit.
7330 * @param data Callback funtion user data. It is the @p op parameter.
7334 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, void (*cb)(void *data, Elm_Transit* transit), void *data) EINA_ARG_NONNULL(1);
7337 * Set reverse effect automatically.
7339 * If auto reverse is setted, after running the effects with the progress
7340 * parameter from 0 to 1, it will call the effecs again with the progress
7341 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7342 * where the duration was setted with the function elm_transit_add and
7343 * the repeat with the function elm_transit_repeat_times_set().
7345 * @param transit The transit object.
7346 * @param reverse EINA_TRUE means the auto_reverse is on.
7350 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7353 * Get if the auto reverse is on.
7355 * @see elm_transit_auto_reverse_set()
7357 * @param transit The transit object.
7358 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7359 * EINA_FALSE is returned
7363 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7366 * Set the transit repeat count. Effect will be repeated by repeat count.
7368 * This function sets the number of repetition the transit will run after
7369 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7370 * If the @p repeat is a negative number, it will repeat infinite times.
7372 * @note If this function is called during the transit execution, the transit
7373 * will run @p repeat times, ignoring the times it already performed.
7375 * @param transit The transit object
7376 * @param repeat Repeat count
7380 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7383 * Get the transit repeat count.
7385 * @see elm_transit_repeat_times_set()
7387 * @param transit The Transit object.
7388 * @return The repeat count. If @p transit is NULL
7393 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7396 * Set the transit animation acceleration type.
7398 * This function sets the tween mode of the transit that can be:
7399 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7400 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7401 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7402 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7404 * @param transit The transit object.
7405 * @param tween_mode The tween type.
7409 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7412 * Get the transit animation acceleration type.
7414 * @note @p transit can not be NULL
7416 * @param transit The transit object.
7417 * @return The tween type. If @p transit is NULL
7418 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7422 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7425 * Set the transit animation time
7427 * @note @p transit can not be NULL
7429 * @param transit The transit object.
7430 * @param duration The animation time.
7434 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7437 * Get the transit animation time
7439 * @note @p transit can not be NULL
7441 * @param transit The transit object.
7443 * @return The transit animation time.
7447 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7450 * Starts the transition.
7451 * Once this API is called, the transit begins to measure the time.
7453 * @note @p transit can not be NULL
7455 * @param transit The transit object.
7459 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7462 * Pause/Resume the transition.
7464 * If you call elm_transit_go again, the transit will be started from the
7465 * beginning, and will be unpaused.
7467 * @note @p transit can not be NULL
7469 * @param transit The transit object.
7470 * @param paused Whether the transition should be paused or not.
7474 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7477 * Get the value of paused status.
7479 * @see elm_transit_paused_set()
7481 * @note @p transit can not be NULL
7483 * @param transit The transit object.
7484 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7485 * EINA_FALSE is returned
7489 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7492 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7494 * The value returned is a fraction (current time / total time). It
7495 * represents the progression position relative to the total.
7497 * @note @p transit can not be NULL
7499 * @param transit The transit object.
7501 * @return The time progression value. If @p transit is NULL
7506 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7509 * Makes the chain relationship between two transits.
7511 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7512 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7514 * @param transit The transit object.
7515 * @param chain_transit The chain transit object. This transit will be operated
7516 * after transit is done.
7518 * This function adds @p chain_transit transition to a chain after the @p
7519 * transit, and will be started as soon as @p transit ends. See @ref
7520 * transit_example_02_explained for a full example.
7524 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7527 * Get the current chain transit list.
7529 * @note @p transit can not be NULL.
7531 * @param transit The transit object.
7532 * @return chain transit list.
7536 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7539 * Add the Resizing Effect to Elm_Transit.
7541 * @note This API is one of the facades. It creates resizing effect context
7542 * and add it's required APIs to elm_transit_effect_add.
7544 * @see elm_transit_effect_add()
7546 * @param transit Transit object.
7547 * @param from_w Object width size when effect begins.
7548 * @param from_h Object height size when effect begins.
7549 * @param to_w Object width size when effect ends.
7550 * @param to_h Object height size when effect ends.
7551 * @return Resizing effect context data.
7555 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);
7558 * Add the Translation Effect to Elm_Transit.
7560 * @note This API is one of the facades. It creates translation effect context
7561 * and add it's required APIs to elm_transit_effect_add.
7563 * @see elm_transit_effect_add()
7565 * @param transit Transit object.
7566 * @param from_dx X Position variation when effect begins.
7567 * @param from_dy Y Position variation when effect begins.
7568 * @param to_dx X Position variation when effect ends.
7569 * @param to_dy Y Position variation when effect ends.
7570 * @return Translation effect context data.
7573 * @warning It is highly recommended just create a transit with this effect when
7574 * the window that the objects of the transit belongs has already been created.
7575 * This is because this effect needs the geometry information about the objects,
7576 * and if the window was not created yet, it can get a wrong information.
7578 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);
7581 * Add the Zoom Effect to Elm_Transit.
7583 * @note This API is one of the facades. It creates zoom effect context
7584 * and add it's required APIs to elm_transit_effect_add.
7586 * @see elm_transit_effect_add()
7588 * @param transit Transit object.
7589 * @param from_rate Scale rate when effect begins (1 is current rate).
7590 * @param to_rate Scale rate when effect ends.
7591 * @return Zoom effect context data.
7594 * @warning It is highly recommended just create a transit with this effect when
7595 * the window that the objects of the transit belongs has already been created.
7596 * This is because this effect needs the geometry information about the objects,
7597 * and if the window was not created yet, it can get a wrong information.
7599 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7602 * Add the Flip Effect to Elm_Transit.
7604 * @note This API is one of the facades. It creates flip effect context
7605 * and add it's required APIs to elm_transit_effect_add.
7606 * @note This effect is applied to each pair of objects in the order they are listed
7607 * in the transit list of objects. The first object in the pair will be the
7608 * "front" object and the second will be the "back" object.
7610 * @see elm_transit_effect_add()
7612 * @param transit Transit object.
7613 * @param axis Flipping Axis(X or Y).
7614 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7615 * @return Flip effect context data.
7618 * @warning It is highly recommended just create a transit with this effect when
7619 * the window that the objects of the transit belongs has already been created.
7620 * This is because this effect needs the geometry information about the objects,
7621 * and if the window was not created yet, it can get a wrong information.
7623 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7626 * Add the Resizable Flip Effect to Elm_Transit.
7628 * @note This API is one of the facades. It creates resizable flip effect context
7629 * and add it's required APIs to elm_transit_effect_add.
7630 * @note This effect is applied to each pair of objects in the order they are listed
7631 * in the transit list of objects. The first object in the pair will be the
7632 * "front" object and the second will be the "back" object.
7634 * @see elm_transit_effect_add()
7636 * @param transit Transit object.
7637 * @param axis Flipping Axis(X or Y).
7638 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7639 * @return Resizable flip effect context data.
7642 * @warning It is highly recommended just create a transit with this effect when
7643 * the window that the objects of the transit belongs has already been created.
7644 * This is because this effect needs the geometry information about the objects,
7645 * and if the window was not created yet, it can get a wrong information.
7647 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7650 * Add the Wipe Effect to Elm_Transit.
7652 * @note This API is one of the facades. It creates wipe effect context
7653 * and add it's required APIs to elm_transit_effect_add.
7655 * @see elm_transit_effect_add()
7657 * @param transit Transit object.
7658 * @param type Wipe type. Hide or show.
7659 * @param dir Wipe Direction.
7660 * @return Wipe effect context data.
7663 * @warning It is highly recommended just create a transit with this effect when
7664 * the window that the objects of the transit belongs has already been created.
7665 * This is because this effect needs the geometry information about the objects,
7666 * and if the window was not created yet, it can get a wrong information.
7668 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7671 * Add the Color Effect to Elm_Transit.
7673 * @note This API is one of the facades. It creates color effect context
7674 * and add it's required APIs to elm_transit_effect_add.
7676 * @see elm_transit_effect_add()
7678 * @param transit Transit object.
7679 * @param from_r RGB R when effect begins.
7680 * @param from_g RGB G when effect begins.
7681 * @param from_b RGB B when effect begins.
7682 * @param from_a RGB A when effect begins.
7683 * @param to_r RGB R when effect ends.
7684 * @param to_g RGB G when effect ends.
7685 * @param to_b RGB B when effect ends.
7686 * @param to_a RGB A when effect ends.
7687 * @return Color effect context data.
7691 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);
7694 * Add the Fade Effect to Elm_Transit.
7696 * @note This API is one of the facades. It creates fade effect context
7697 * and add it's required APIs to elm_transit_effect_add.
7698 * @note This effect is applied to each pair of objects in the order they are listed
7699 * in the transit list of objects. The first object in the pair will be the
7700 * "before" object and the second will be the "after" object.
7702 * @see elm_transit_effect_add()
7704 * @param transit Transit object.
7705 * @return Fade effect context data.
7708 * @warning It is highly recommended just create a transit with this effect when
7709 * the window that the objects of the transit belongs has already been created.
7710 * This is because this effect needs the color information about the objects,
7711 * and if the window was not created yet, it can get a wrong information.
7713 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7716 * Add the Blend Effect to Elm_Transit.
7718 * @note This API is one of the facades. It creates blend effect context
7719 * and add it's required APIs to elm_transit_effect_add.
7720 * @note This effect is applied to each pair of objects in the order they are listed
7721 * in the transit list of objects. The first object in the pair will be the
7722 * "before" object and the second will be the "after" object.
7724 * @see elm_transit_effect_add()
7726 * @param transit Transit object.
7727 * @return Blend effect context data.
7730 * @warning It is highly recommended just create a transit with this effect when
7731 * the window that the objects of the transit belongs has already been created.
7732 * This is because this effect needs the color information about the objects,
7733 * and if the window was not created yet, it can get a wrong information.
7735 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7738 * Add the Rotation Effect to Elm_Transit.
7740 * @note This API is one of the facades. It creates rotation effect context
7741 * and add it's required APIs to elm_transit_effect_add.
7743 * @see elm_transit_effect_add()
7745 * @param transit Transit object.
7746 * @param from_degree Degree when effect begins.
7747 * @param to_degree Degree when effect is ends.
7748 * @return Rotation effect context data.
7751 * @warning It is highly recommended just create a transit with this effect when
7752 * the window that the objects of the transit belongs has already been created.
7753 * This is because this effect needs the geometry information about the objects,
7754 * and if the window was not created yet, it can get a wrong information.
7756 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7759 * Add the ImageAnimation Effect to Elm_Transit.
7761 * @note This API is one of the facades. It creates image animation effect context
7762 * and add it's required APIs to elm_transit_effect_add.
7763 * The @p images parameter is a list images paths. This list and
7764 * its contents will be deleted at the end of the effect by
7765 * elm_transit_effect_image_animation_context_free() function.
7769 * char buf[PATH_MAX];
7770 * Eina_List *images = NULL;
7771 * Elm_Transit *transi = elm_transit_add();
7773 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7774 * images = eina_list_append(images, eina_stringshare_add(buf));
7776 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7777 * images = eina_list_append(images, eina_stringshare_add(buf));
7778 * elm_transit_effect_image_animation_add(transi, images);
7782 * @see elm_transit_effect_add()
7784 * @param transit Transit object.
7785 * @param images Eina_List of images file paths. This list and
7786 * its contents will be deleted at the end of the effect by
7787 * elm_transit_effect_image_animation_context_free() function.
7788 * @return Image Animation effect context data.
7792 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7798 typedef struct _Elm_Store Elm_Store;
7799 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
7800 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
7801 typedef struct _Elm_Store_Item Elm_Store_Item;
7802 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
7803 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
7804 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
7805 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
7806 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
7807 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
7808 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
7809 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
7810 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
7812 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
7813 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7814 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7815 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
7816 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
7817 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
7818 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
7822 ELM_STORE_ITEM_MAPPING_NONE = 0,
7823 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
7824 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
7825 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
7826 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
7827 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
7828 // can add more here as needed by common apps
7829 ELM_STORE_ITEM_MAPPING_LAST
7830 } Elm_Store_Item_Mapping_Type;
7832 struct _Elm_Store_Item_Mapping_Icon
7834 // FIXME: allow edje file icons
7836 Elm_Icon_Lookup_Order lookup_order;
7837 Eina_Bool standard_name : 1;
7838 Eina_Bool no_scale : 1;
7839 Eina_Bool smooth : 1;
7840 Eina_Bool scale_up : 1;
7841 Eina_Bool scale_down : 1;
7844 struct _Elm_Store_Item_Mapping_Empty
7849 struct _Elm_Store_Item_Mapping_Photo
7854 struct _Elm_Store_Item_Mapping_Custom
7856 Elm_Store_Item_Mapping_Cb func;
7859 struct _Elm_Store_Item_Mapping
7861 Elm_Store_Item_Mapping_Type type;
7865 Elm_Store_Item_Mapping_Empty empty;
7866 Elm_Store_Item_Mapping_Icon icon;
7867 Elm_Store_Item_Mapping_Photo photo;
7868 Elm_Store_Item_Mapping_Custom custom;
7869 // add more types here
7873 struct _Elm_Store_Item_Info
7879 int pre_group_index;
7881 Elm_Genlist_Item_Class *item_class;
7882 const Elm_Store_Item_Mapping *mapping;
7887 struct _Elm_Store_Item_Info_Filesystem
7889 Elm_Store_Item_Info base;
7893 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
7894 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
7896 EAPI Elm_Store *elm_store_dbsystem_new(void);
7897 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
7898 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
7899 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
7900 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
7901 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7902 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7903 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
7904 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7905 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
7906 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7907 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
7908 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7909 EAPI void elm_store_free(Elm_Store *st);
7910 EAPI Elm_Store *elm_store_filesystem_new(void);
7911 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
7912 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7913 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7914 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
7915 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
7916 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7917 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7918 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7919 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
7920 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7921 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7922 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
7923 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7924 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
7925 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7926 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7927 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7930 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
7931 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
7932 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
7933 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
7934 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
7939 ELM_TICKERNOTI_DEFAULT,
7940 ELM_TICKERNOTI_DETAILVIEW
7941 } Elm_Tickernoti_Mode;
7943 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
7944 EAPI void elm_tickernoti_icon_set (const Evas_Object *obj, Evas_Object *icon);
7945 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj);
7946 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label);
7947 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj);
7948 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label);
7949 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj);
7950 EAPI void elm_tickernoti_detailview_button_set (const Evas_Object *obj, Evas_Object *button);
7951 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj);
7952 EAPI void elm_tickernoti_detailview_icon_set (const Evas_Object *obj, Evas_Object *icon);
7953 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj);
7954 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj);
7955 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj);
7956 EAPI void elm_tickernoti_rotation_set (const Evas_Object *obj, int angle);
7957 EAPI void elm_tickernoti_mode_set (const Evas_Object *obj, Elm_Tickernoti_Mode mode);
7958 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj);
7960 /* SegmentControl */
7961 typedef struct _Elm_Segment_Item Elm_Segment_Item;
7962 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7963 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
7964 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);
7965 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7966 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7967 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7968 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7969 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7970 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
7971 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7972 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
7973 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7974 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7975 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7976 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
7977 /* smart callbacks called:
7978 * "changed" -when the user clicks on a segment item which is not previously
7979 * selected and get selected. The event_info parameter is the
7980 * segment item index.
7983 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
7984 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
7985 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
7986 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
7987 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
7988 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
7989 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
7990 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
7992 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
7993 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
7995 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
7996 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
7997 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
7998 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
7999 EAPI void elm_video_play(Evas_Object *video);
8000 EAPI void elm_video_pause(Evas_Object *video);
8001 EAPI void elm_video_stop(Evas_Object *video);
8002 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8003 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8004 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8005 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8006 EAPI double elm_video_audio_level_get(Evas_Object *video);
8007 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8008 EAPI double elm_video_play_position_get(Evas_Object *video);
8009 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8010 EAPI double elm_video_play_length_get(Evas_Object *video);
8011 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8012 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8013 EAPI const char *elm_video_title_get(Evas_Object *video);
8015 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8016 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8019 typedef enum _Elm_Datefield_Layout
8021 ELM_DATEFIELD_LAYOUT_TIME,
8022 ELM_DATEFIELD_LAYOUT_DATE,
8023 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8024 } Elm_Datefield_Layout;
8026 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8027 EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8028 EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8029 EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8030 EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8031 EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8032 EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8033 EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8034 EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8035 EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8036 EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8037 EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8038 EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8039 EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
8040 EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8041 /* smart callbacks called:
8042 * "changed" - when datefield entry is changed, this signal is sent.
8046 typedef enum _Elm_Popup_Response
8048 ELM_POPUP_RESPONSE_NONE = -1,
8049 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8050 ELM_POPUP_RESPONSE_OK = -3,
8051 ELM_POPUP_RESPONSE_CANCEL = -4,
8052 ELM_POPUP_RESPONSE_CLOSE = -5
8053 } Elm_Popup_Response;
8055 typedef enum _Elm_Popup_Mode
8057 ELM_POPUP_TYPE_NONE = 0,
8058 ELM_POPUP_TYPE_ALERT = (1 << 0)
8061 typedef enum _Elm_Popup_Orient
8063 ELM_POPUP_ORIENT_TOP,
8064 ELM_POPUP_ORIENT_CENTER,
8065 ELM_POPUP_ORIENT_BOTTOM,
8066 ELM_POPUP_ORIENT_LEFT,
8067 ELM_POPUP_ORIENT_RIGHT,
8068 ELM_POPUP_ORIENT_TOP_LEFT,
8069 ELM_POPUP_ORIENT_TOP_RIGHT,
8070 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8071 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8074 /* smart callbacks called:
8075 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8078 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8079 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8080 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8081 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8082 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8083 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8084 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8085 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8086 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8087 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8088 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, ... );
8089 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8090 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8091 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8092 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8093 EAPI int elm_popup_run(Evas_Object *obj);
8098 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8099 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8100 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8101 ELM_NAVIGATIONBAR_BACK_BUTTON
8102 } Elm_Navi_Button_Type;
8104 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8105 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);
8106 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8107 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8108 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8109 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8110 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8111 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8112 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8113 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8114 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8115 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8116 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8117 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8118 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8119 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8120 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8121 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8122 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8123 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8124 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8129 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8130 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8131 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8132 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8133 ELM_NAVIGATIONBAR_EX_MAX
8134 } Elm_Navi_ex_Button_Type;
8135 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8137 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8138 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8139 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8140 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8141 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8142 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8143 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8144 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8145 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8146 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);
8147 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8148 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8149 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8150 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8151 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8152 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8153 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8154 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8155 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8156 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8157 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8158 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8159 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8160 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8161 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8162 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8163 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8164 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8168 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8169 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8170 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8171 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8172 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8173 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8174 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8175 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8176 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8178 typedef enum _Elm_Controlbar_Mode_Type
8180 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8181 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8182 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8183 ELM_CONTROLBAR_MODE_LARGE,
8184 ELM_CONTROLBAR_MODE_SMALL,
8185 ELM_CONTROLBAR_MODE_LEFT,
8186 ELM_CONTROLBAR_MODE_RIGHT
8187 } Elm_Controlbar_Mode_Type;
8189 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8190 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8191 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8192 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8193 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);
8194 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);
8195 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);
8196 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);
8197 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);
8198 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);
8199 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8200 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8201 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8202 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8203 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8204 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8205 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8206 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8207 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8208 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8209 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8210 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8211 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8212 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8213 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8214 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8215 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8216 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8217 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8218 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8219 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8220 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8221 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8222 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8223 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8224 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8225 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8226 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8227 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8230 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8231 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8232 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8233 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8234 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8235 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8236 EAPI void elm_searchbar_clear(Evas_Object *obj);
8237 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);