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 ?
\9cdon'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 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1863 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
1864 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1865 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
1866 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1868 /* smart callbacks called:
1869 * "clicked" - the user clicked the icon
1873 typedef enum _Elm_Image_Orient
1875 ELM_IMAGE_ORIENT_NONE,
1876 ELM_IMAGE_ROTATE_90_CW,
1877 ELM_IMAGE_ROTATE_180_CW,
1878 ELM_IMAGE_ROTATE_90_CCW,
1879 ELM_IMAGE_FLIP_HORIZONTAL,
1880 ELM_IMAGE_FLIP_VERTICAL,
1881 ELM_IMAGE_FLIP_TRANSPOSE,
1882 ELM_IMAGE_FLIP_TRANSVERSE
1884 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1885 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1886 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1887 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1888 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1889 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1890 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1891 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1892 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1893 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1894 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1895 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1896 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1897 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1898 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
1899 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1900 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
1901 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1902 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1903 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
1904 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1906 /* smart callbacks called:
1907 * "clicked" - the user clicked the image
1911 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
1913 typedef enum _Elm_GLView_Mode
1915 ELM_GLVIEW_ALPHA = 1,
1916 ELM_GLVIEW_DEPTH = 2,
1917 ELM_GLVIEW_STENCIL = 4
1921 * Defines a policy for the glview resizing.
1923 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
1925 typedef enum _Elm_GLView_Resize_Policy
1927 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
1928 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
1929 } Elm_GLView_Resize_Policy;
1931 typedef enum _Elm_GLView_Render_Policy
1933 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
1934 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
1935 } Elm_GLView_Render_Policy;
1938 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1939 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1940 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1941 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1942 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
1943 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
1944 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
1945 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1946 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1947 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1948 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1949 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1955 * A box arranges objects in a linear fashion, governed by a layout function
1956 * that defines the details of this arrangement.
1958 * By default, the box will use an internal function to set the layout to
1959 * a single row, either vertical or horizontal. This layout is affected
1960 * by a number of parameters, such as the homogeneous flag set by
1961 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
1962 * elm_box_align_set() and the hints set to each object in the box.
1964 * For this default layout, it's possible to change the orientation with
1965 * elm_box_horizontal_set(). The box will start in the vertical orientation,
1966 * placing its elements ordered from top to bottom. When horizontal is set,
1967 * the order will go from left to right. If the box is set to be
1968 * homogeneous, every object in it will be assigned the same space, that
1969 * of the largest object. Padding can be used to set some spacing between
1970 * the cell given to each object. The alignment of the box, set with
1971 * elm_box_align_set(), determines how the bounding box of all the elements
1972 * will be placed within the space given to the box widget itself.
1974 * The size hints of each object also affect how they are placed and sized
1975 * within the box. evas_object_size_hint_min_set() will give the minimum
1976 * size the object can have, and the box will use it as the basis for all
1977 * latter calculations. Elementary widgets set their own minimum size as
1978 * needed, so there's rarely any need to use it manually.
1980 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
1981 * used to tell whether the object will be allocated the minimum size it
1982 * needs or if the space given to it should be expanded. It's important
1983 * to realize that expanding the size given to the object is not the same
1984 * thing as resizing the object. It could very well end being a small
1985 * widget floating in a much larger empty space. If not set, the weight
1986 * for objects will normally be 0.0 for both axis, meaning the widget will
1987 * not be expanded. To take as much space possible, set the weight to
1988 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
1990 * Besides how much space each object is allocated, it's possible to control
1991 * how the widget will be placed within that space using
1992 * evas_object_size_hint_align_set(). By default, this value will be 0.5
1993 * for both axis, meaning the object will be centered, but any value from
1994 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
1995 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
1996 * is -1.0, means the object will be resized to fill the entire space it
1999 * In addition, customized functions to define the layout can be set, which
2000 * allow the application developer to organize the objects within the box
2001 * in any number of ways.
2003 * The special elm_box_layout_transition() function can be used
2004 * to switch from one layout to another, animating the motion of the
2005 * children of the box.
2007 * @note Objects should not be added to box objects using _add() calls.
2009 * Some examples on how to use boxes follow:
2010 * @li @ref box_example_01
2011 * @li @ref box_example_02
2016 * @typedef Elm_Box_Transition
2018 * Opaque handler containing the parameters to perform an animated
2019 * transition of the layout the box uses.
2021 * @see elm_box_transition_new()
2022 * @see elm_box_layout_set()
2023 * @see elm_box_layout_transition()
2025 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2028 * Add a new box to the parent
2030 * By default, the box will be in vertical mode and non-homogeneous.
2032 * @param parent The parent object
2033 * @return The new object or NULL if it cannot be created
2035 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2037 * Set the horizontal orientation
2039 * By default, box object arranges their contents vertically from top to
2041 * By calling this function with @p horizontal as EINA_TRUE, the box will
2042 * become horizontal, arranging contents from left to right.
2044 * @note This flag is ignored if a custom layout function is set.
2046 * @param obj The box object
2047 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2048 * EINA_FALSE = vertical)
2050 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2052 * Get the horizontal orientation
2054 * @param obj The box object
2055 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2057 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2059 * Set the box to arrange its children homogeneously
2061 * If enabled, homogeneous layout makes all items the same size, according
2062 * to the size of the largest of its children.
2064 * @note This flag is ignored if a custom layout function is set.
2066 * @param obj The box object
2067 * @param homogeneous The homogeneous flag
2069 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2071 * Get whether the box is using homogeneous mode or not
2073 * @param obj The box object
2074 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2076 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2077 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2078 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2080 * Add an object to the beginning of the pack list
2082 * Pack @p subobj into the box @p obj, placing it first in the list of
2083 * children objects. The actual position the object will get on screen
2084 * depends on the layout used. If no custom layout is set, it will be at
2085 * the top or left, depending if the box is vertical or horizontal,
2088 * @param obj The box object
2089 * @param subobj The object to add to the box
2091 * @see elm_box_pack_end()
2092 * @see elm_box_pack_before()
2093 * @see elm_box_pack_after()
2094 * @see elm_box_unpack()
2095 * @see elm_box_unpack_all()
2096 * @see elm_box_clear()
2098 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2100 * Add an object at the end of the pack list
2102 * Pack @p subobj into the box @p obj, placing it last in the list of
2103 * children objects. The actual position the object will get on screen
2104 * depends on the layout used. If no custom layout is set, it will be at
2105 * the bottom or right, depending if the box is vertical or horizontal,
2108 * @param obj The box object
2109 * @param subobj The object to add to the box
2111 * @see elm_box_pack_start()
2112 * @see elm_box_pack_before()
2113 * @see elm_box_pack_after()
2114 * @see elm_box_unpack()
2115 * @see elm_box_unpack_all()
2116 * @see elm_box_clear()
2118 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2120 * Adds an object to the box before the indicated object
2122 * This will add the @p subobj to the box indicated before the object
2123 * indicated with @p before. If @p before is not already in the box, results
2124 * are undefined. Before means either to the left of the indicated object or
2125 * above it depending on orientation.
2127 * @param obj The box object
2128 * @param subobj The object to add to the box
2129 * @param before The object before which to add it
2131 * @see elm_box_pack_start()
2132 * @see elm_box_pack_end()
2133 * @see elm_box_pack_after()
2134 * @see elm_box_unpack()
2135 * @see elm_box_unpack_all()
2136 * @see elm_box_clear()
2138 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2140 * Adds an object to the box after the indicated object
2142 * This will add the @p subobj to the box indicated after the object
2143 * indicated with @p after. If @p after is not already in the box, results
2144 * are undefined. After means either to the right of the indicated object or
2145 * below it depending on orientation.
2147 * @param obj The box object
2148 * @param subobj The object to add to the box
2149 * @param after The object after which to add it
2151 * @see elm_box_pack_start()
2152 * @see elm_box_pack_end()
2153 * @see elm_box_pack_before()
2154 * @see elm_box_unpack()
2155 * @see elm_box_unpack_all()
2156 * @see elm_box_clear()
2158 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2160 * Clear the box of all children
2162 * Remove all the elements contained by the box, deleting the respective
2165 * @param obj The box object
2167 * @see elm_box_unpack()
2168 * @see elm_box_unpack_all()
2170 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2174 * Remove the object given by @p subobj from the box @p obj without
2177 * @param obj The box object
2179 * @see elm_box_unpack_all()
2180 * @see elm_box_clear()
2182 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2184 * Remove all items from the box, without deleting them
2186 * Clear the box from all children, but don't delete the respective objects.
2187 * If no other references of the box children exist, the objects will never
2188 * be deleted, and thus the application will leak the memory. Make sure
2189 * when using this function that you hold a reference to all the objects
2190 * in the box @p obj.
2192 * @param obj The box object
2194 * @see elm_box_clear()
2195 * @see elm_box_unpack()
2197 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2199 * Retrieve a list of the objects packed into the box
2201 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2202 * The order of the list corresponds to the packing order the box uses.
2204 * You must free this list with eina_list_free() once you are done with it.
2206 * @param obj The box object
2208 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2210 * Set the space (padding) between the box's elements.
2212 * Extra space in pixels that will be added between a box child and its
2213 * neighbors after its containing cell has been calculated. This padding
2214 * is set for all elements in the box, besides any possible padding that
2215 * individual elements may have through their size hints.
2217 * @param obj The box object
2218 * @param horizontal The horizontal space between elements
2219 * @param vertical The vertical space between elements
2221 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2223 * Get the space (padding) between the box's elements.
2225 * @param obj The box object
2226 * @param horizontal The horizontal space between elements
2227 * @param vertical The vertical space between elements
2229 * @see elm_box_padding_set()
2231 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2233 * Set the alignment of the whole bouding box of contents.
2235 * Sets how the bounding box containing all the elements of the box, after
2236 * their sizes and position has been calculated, will be aligned within
2237 * the space given for the whole box widget.
2239 * @param obj The box object
2240 * @param horizontal The horizontal alignment of elements
2241 * @param vertical The vertical alignment of elements
2243 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2245 * Get the alignment of the whole bouding box of contents.
2247 * @param obj The box object
2248 * @param horizontal The horizontal alignment of elements
2249 * @param vertical The vertical alignment of elements
2251 * @see elm_box_align_set()
2253 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2256 * Set the layout defining function to be used by the box
2258 * Whenever anything changes that requires the box in @p obj to recalculate
2259 * the size and position of its elements, the function @p cb will be called
2260 * to determine what the layout of the children will be.
2262 * Once a custom function is set, everything about the children layout
2263 * is defined by it. The flags set by elm_box_horizontal_set() and
2264 * elm_box_homogeneous_set() no longer have any meaning, and the values
2265 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2266 * layout function to decide if they are used and how. These last two
2267 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2268 * passed to @p cb. The @c Evas_Object the function receives is not the
2269 * Elementary widget, but the internal Evas Box it uses, so none of the
2270 * functions described here can be used on it.
2272 * Any of the layout functions in @c Evas can be used here, as well as the
2273 * special elm_box_layout_transition().
2275 * The final @p data argument received by @p cb is the same @p data passed
2276 * here, and the @p free_data function will be called to free it
2277 * whenever the box is destroyed or another layout function is set.
2279 * Setting @p cb to NULL will revert back to the default layout function.
2281 * @param obj The box object
2282 * @param cb The callback function used for layout
2283 * @param data Data that will be passed to layout function
2284 * @param free_data Function called to free @p data
2286 * @see elm_box_layout_transition()
2288 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);
2290 * Special layout function that animates the transition from one layout to another
2292 * Normally, when switching the layout function for a box, this will be
2293 * reflected immediately on screen on the next render, but it's also
2294 * possible to do this through an animated transition.
2296 * This is done by creating an ::Elm_Box_Transition and setting the box
2297 * layout to this function.
2301 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2302 * evas_object_box_layout_vertical, // start
2303 * NULL, // data for initial layout
2304 * NULL, // free function for initial data
2305 * evas_object_box_layout_horizontal, // end
2306 * NULL, // data for final layout
2307 * NULL, // free function for final data
2308 * anim_end, // will be called when animation ends
2309 * NULL); // data for anim_end function\
2310 * elm_box_layout_set(box, elm_box_layout_transition, t,
2311 * elm_box_transition_free);
2314 * @note This function can only be used with elm_box_layout_set(). Calling
2315 * it directly will not have the expected results.
2317 * @see elm_box_transition_new
2318 * @see elm_box_transition_free
2319 * @see elm_box_layout_set
2321 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2323 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2325 * If you want to animate the change from one layout to another, you need
2326 * to set the layout function of the box to elm_box_layout_transition(),
2327 * passing as user data to it an instance of ::Elm_Box_Transition with the
2328 * necessary information to perform this animation. The free function to
2329 * set for the layout is elm_box_transition_free().
2331 * The parameters to create an ::Elm_Box_Transition sum up to how long
2332 * will it be, in seconds, a layout function to describe the initial point,
2333 * another for the final position of the children and one function to be
2334 * called when the whole animation ends. This last function is useful to
2335 * set the definitive layout for the box, usually the same as the end
2336 * layout for the animation, but could be used to start another transition.
2338 * @param start_layout The layout function that will be used to start the animation
2339 * @param start_layout_data The data to be passed the @p start_layout function
2340 * @param start_layout_free_data Function to free @p start_layout_data
2341 * @param end_layout The layout function that will be used to end the animation
2342 * @param end_layout_free_data The data to be passed the @p end_layout function
2343 * @param end_layout_free_data Function to free @p end_layout_data
2344 * @param transition_end_cb Callback function called when animation ends
2345 * @param transition_end_data Data to be passed to @p transition_end_cb
2346 * @return An instance of ::Elm_Box_Transition
2348 * @see elm_box_transition_new
2349 * @see elm_box_layout_transition
2351 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);
2353 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2355 * This function is mostly useful as the @c free_data parameter in
2356 * elm_box_layout_set() when elm_box_layout_transition().
2358 * @param data The Elm_Box_Transition instance to be freed.
2360 * @see elm_box_transition_new
2361 * @see elm_box_layout_transition
2363 EAPI void elm_box_transition_free(void *data);
2370 * @defgroup Button Button
2372 * @image html widget/button/preview-00.png
2373 * @image html widget/button/preview-01.png
2374 * @image html widget/button/preview-02.png
2376 * This is a push-button. Press it and run some function. It can contain
2377 * a simple label and icon object and it also has an autorepeat feature.
2379 * This widgets emits the following signals:
2380 * @li "clicked": the user clicked the button (press/release).
2381 * @li "repeated": the user pressed the button without releasing it.
2382 * @li "pressed": button was pressed.
2383 * @li "unpressed": button was released after being pressed.
2384 * In all three cases, the @c event parameter of the callback will be
2387 * Also, defined in the default theme, the button has the following styles
2389 * @li default: a normal button.
2390 * @li anchor: Like default, but the button fades away when the mouse is not
2391 * over it, leaving only the text or icon.
2392 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2393 * continuous look across its options.
2394 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2396 * Follow through a complete example @ref button_example_01 "here".
2402 UIControlStateDefault,
2403 UIControlStateHighlighted,
2404 UIControlStateDisabled,
2405 UIControlStateFocused,
2406 UIControlStateReserved
2410 * Add a new button to the parent's canvas
2412 * @param parent The parent object
2413 * @return The new object or NULL if it cannot be created
2415 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2417 * Set the label used in the button
2419 * The passed @p label can be NULL to clean any existing text in it and
2420 * leave the button as an icon only object.
2422 * @param obj The button object
2423 * @param label The text will be written on the button
2424 * @deprecated use elm_object_text_set() instead.
2426 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2428 * Get the label set for the button
2430 * The string returned is an internal pointer and should not be freed or
2431 * altered. It will also become invalid when the button is destroyed.
2432 * The string returned, if not NULL, is a stringshare, so if you need to
2433 * keep it around even after the button is destroyed, you can use
2434 * eina_stringshare_ref().
2436 * @param obj The button object
2437 * @return The text set to the label, or NULL if nothing is set
2438 * @deprecated use elm_object_text_set() instead.
2440 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2442 * Set the label for each state of button
2444 * The passed @p label can be NULL to clean any existing text in it and
2445 * leave the button as an icon only object for the state.
2447 * @param obj The button object
2448 * @param label The text will be written on the button
2449 * @param state The state of button
2453 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2455 * Get the label of button for each state
2457 * The string returned is an internal pointer and should not be freed or
2458 * altered. It will also become invalid when the button is destroyed.
2459 * The string returned, if not NULL, is a stringshare, so if you need to
2460 * keep it around even after the button is destroyed, you can use
2461 * eina_stringshare_ref().
2463 * @param obj The button object
2464 * @param state The state of button
2465 * @return The title of button for state
2469 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2471 * Set the icon used for the button
2473 * Setting a new icon will delete any other that was previously set, making
2474 * any reference to them invalid. If you need to maintain the previous
2475 * object alive, unset it first with elm_button_icon_unset().
2477 * @param obj The button object
2478 * @param icon The icon object for the button
2480 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2482 * Get the icon used for the button
2484 * Return the icon object which is set for this widget. If the button is
2485 * destroyed or another icon is set, the returned object will be deleted
2486 * and any reference to it will be invalid.
2488 * @param obj The button object
2489 * @return The icon object that is being used
2491 * @see elm_button_icon_unset()
2493 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2495 * Remove the icon set without deleting it and return the object
2497 * This function drops the reference the button holds of the icon object
2498 * and returns this last object. It is used in case you want to remove any
2499 * icon, or set another one, without deleting the actual object. The button
2500 * will be left without an icon set.
2502 * @param obj The button object
2503 * @return The icon object that was being used
2505 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2507 * Turn on/off the autorepeat event generated when the button is kept pressed
2509 * When off, no autorepeat is performed and buttons emit a normal @c clicked
2510 * signal when they are clicked.
2512 * When on, keeping a button pressed will continuously emit a @c repeated
2513 * signal until the button is released. The time it takes until it starts
2514 * emitting the signal is given by
2515 * elm_button_autorepeat_initial_timeout_set(), and the time between each
2516 * new emission by elm_button_autorepeat_gap_timeout_set().
2518 * @param obj The button object
2519 * @param on A bool to turn on/off the event
2521 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2523 * Get whether the autorepeat feature is enabled
2525 * @param obj The button object
2526 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2528 * @see elm_button_autorepeat_set()
2530 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2532 * Set the initial timeout before the autorepeat event is generated
2534 * Sets the timeout, in seconds, since the button is pressed until the
2535 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2536 * won't be any delay and the even will be fired the moment the button is
2539 * @param obj The button object
2540 * @param t Timeout in seconds
2542 * @see elm_button_autorepeat_set()
2543 * @see elm_button_autorepeat_gap_timeout_set()
2545 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2547 * Get the initial timeout before the autorepeat event is generated
2549 * @param obj The button object
2550 * @return Timeout in seconds
2552 * @see elm_button_autorepeat_initial_timeout_set()
2554 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2556 * Set the interval between each generated autorepeat event
2558 * After the first @c repeated event is fired, all subsequent ones will
2559 * follow after a delay of @p t seconds for each.
2561 * @param obj The button object
2562 * @param t Interval in seconds
2564 * @see elm_button_autorepeat_initial_timeout_set()
2566 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2568 * Get the interval between each generated autorepeat event
2570 * @param obj The button object
2571 * @return Interval in seconds
2573 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2579 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2580 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2581 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2582 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2583 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2584 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2585 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2586 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2587 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2588 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2589 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2590 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2591 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2592 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2593 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2594 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2595 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2596 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2597 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2598 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2599 /* available styles:
2603 * hoversel_vertical_entry
2605 /* smart callbacks called:
2606 * "file,chosen" - the user has selected a path, whose string pointer comes
2610 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2611 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2612 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2613 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2614 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2615 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2616 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2617 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2618 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2619 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2620 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2621 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2622 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2623 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2624 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2625 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2626 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2627 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2628 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2629 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2630 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2631 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2633 /* scroller policy */
2634 typedef enum _Elm_Scroller_Policy
2636 ELM_SCROLLER_POLICY_AUTO = 0,
2637 ELM_SCROLLER_POLICY_ON,
2638 ELM_SCROLLER_POLICY_OFF,
2639 ELM_SCROLLER_POLICY_LAST
2640 } Elm_Scroller_Policy;
2642 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2643 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2644 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2645 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2646 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2647 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2648 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);
2649 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2650 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2651 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);
2652 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2653 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2654 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2655 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2656 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2657 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);
2658 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2659 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
2660 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
2661 /* smart callbacks called:
2662 * "edge,left" - the left edge of the content has been reached
2663 * "edge,right" - the right edge of the content has been reached
2664 * "edge,top" - the top edge of the content has been reached
2665 * "edge,bottom" - the bottom edge of the content has been reached
2666 * "scroll" - the content has been scrolled (moved)
2667 * "scroll,anim,start" - scrolling animation has started
2668 * "scroll,anim,stop" - scrolling animation has stopped
2669 * "scroll,drag,start" - dragging the contents around has started
2670 * "scroll,drag,stop" - dragging the contents around has stopped
2674 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2675 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 */
2676 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2677 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2678 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2679 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2680 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2681 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2682 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2683 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2684 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);
2685 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2686 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);
2687 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2688 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
2689 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2690 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2691 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2692 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2693 /* available styles:
2697 /* smart callbacks called:
2701 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2702 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2703 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2704 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2705 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2706 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2707 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2708 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2709 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2710 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2711 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2712 /* smart callbacks called:
2713 * "changed" - Whenever the toggle value has been changed. Is not called
2714 * until the toggle is released by the cursor (assuming it has been triggered
2715 * by the cursor in the first place).
2719 * @page tutorial_frame Frame example
2720 * @dontinclude frame_example_01.c
2722 * In this example we are going to create 4 Frames with different styles and
2723 * add a rectangle of different color in each.
2725 * We start we the usual setup code:
2728 * And then create one rectangle:
2731 * To add it in our first frame, which since it doesn't have it's style
2732 * specifically set uses the default style:
2735 * And then create another rectangle:
2738 * To add it in our second frame, which uses the "pad_small" style, note that
2739 * even tough we are setting a text for this frame it won't be show, only the
2740 * default style shows the Frame's title:
2742 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
2743 * very similar, their only difference is the size of the empty area around
2744 * the content of the frame.
2746 * And then create yet another rectangle:
2749 * To add it in our third frame, which uses the "outdent_top" style, note
2750 * that even tough we are setting a text for this frame it won't be show,
2751 * only the default style shows the Frame's title:
2754 * And then create one last rectangle:
2757 * To add it in our fourth and final frame, which uses the "outdent_bottom"
2758 * style, note that even tough we are setting a text for this frame it won't
2759 * be show, only the default style shows the Frame's title:
2762 * And now we are left with just some more setup code:
2765 * Our example will look like this:
2766 * @image html screenshots/frame_example_01.png
2767 * @image latex screenshots/frame_example_01.eps
2769 * @example frame_example_01.c
2772 * @defgroup Frame Frame
2774 * @brief Frame is a widget that holds some content and has a title.
2776 * The default look is a frame with a title, but Frame supports multple
2784 * @li outdent_bottom
2786 * Of all this styles only default shows the title. Frame emits no signals.
2788 * For a detailed example see the @ref tutorial_frame.
2793 * @brief Add a new frame to the parent
2795 * @param parent The parent object
2796 * @return The new object or NULL if it cannot be created
2798 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2800 * @brief Set the frame label
2802 * @param obj The frame object
2803 * @param label The label of this frame object
2805 * @deprecated use elm_object_text_set() instead.
2807 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2809 * @brief Get the frame label
2811 * @param obj The frame object
2813 * @return The label of this frame objet or NULL if unable to get frame
2815 * @deprecated use elm_object_text_get() instead.
2817 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2819 * @brief Set the content of the frame widget
2821 * Once the content object is set, a previously set one will be deleted.
2822 * If you want to keep that old content object, use the
2823 * elm_frame_content_unset() function.
2825 * @param obj The frame object
2826 * @param content The content will be filled in this frame object
2828 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2830 * @brief Get the content of the frame widget
2832 * Return the content object which is set for this widget
2834 * @param obj The frame object
2835 * @return The content that is being used
2837 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2839 * @brief Unset the content of the frame widget
2841 * Unparent and return the content object which was set for this widget
2843 * @param obj The frame object
2844 * @return The content that was being used
2846 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2852 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2853 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2854 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2855 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2856 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2857 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2858 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2859 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2860 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2861 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
2862 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2863 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
2866 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
2867 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
2868 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
2869 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2870 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
2871 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2872 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
2874 struct _Elm_Gengrid_Item_Class
2876 const char *item_style;
2877 struct _Elm_Gengrid_Item_Class_Func
2879 GridItemLabelGetFunc label_get;
2880 GridItemIconGetFunc icon_get;
2881 GridItemStateGetFunc state_get;
2882 GridItemDelFunc del;
2886 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2887 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2888 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2889 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
2890 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
2892 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2893 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2894 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2895 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2896 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2897 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2898 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2899 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2900 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2901 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2902 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2903 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
2904 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2905 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
2906 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2908 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2909 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2911 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2912 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2913 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2914 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2915 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2916 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2917 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
2918 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2919 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
2920 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
2921 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2922 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2923 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2924 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2925 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2926 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2927 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2929 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
2930 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);
2931 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2932 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2933 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2934 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2935 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2936 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2937 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2938 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2939 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2940 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2942 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2943 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2944 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2946 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);
2947 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);
2948 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);
2949 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);
2950 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);
2951 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);
2952 /* smart callbacks called:
2954 * selected - User has selected an item.
2955 * unselected - User has unselected an item.
2956 * clicked,double - User has double-clicked or pressed enter on an item.
2957 * realized - An evas object for an item was built.
2958 * unrealized - An evas object for an item was deleted.
2959 * changed - An item has been added, removed, resized or moved,
2960 * or gengrid has been resized or horizontal property has been changed.
2961 * scroll - the content has been scrolled (moved).
2962 * "scroll,drag,start" - dragging the contents around has started.
2963 * "scroll,drag,stop" - dragging the contents around has stopped.
2964 * drag - Gengrid is being dragged.
2965 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
2966 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
2967 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
2968 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
2969 * "drag,stop" - Gengrid is not being dragged.
2973 * @defgroup Clock Clock
2975 * This is a @b digital clock widget. In its default theme, it has a
2976 * vintage "flipping numbers clock" appearance, which will animate
2977 * sheets of individual algarisms individually as time goes by.
2979 * A newly created clock will fetch system's time (already
2980 * considering local time adjustments) to start with, and will tick
2981 * accondingly. It may or may not show seconds.
2983 * Clocks have an @b edition mode. When in it, the sheets will
2984 * display extra arrow indications on the top and bottom and the
2985 * user may click on them to raise or lower the time values. After
2986 * it's told to exit edition mode, it will keep ticking with that
2987 * new time set (it keeps the difference from local time).
2989 * Also, when under edition mode, user clicks on the cited arrows
2990 * which are @b held for some time will make the clock to flip the
2991 * sheet, thus editing the time, continuosly and automatically for
2992 * the user. The interval between sheet flips will keep growing in
2993 * time, so that it helps the user to reach a time which is distant
2996 * The time display is, by default, in military mode (24h), but an
2997 * am/pm indicator may be optionally shown, too, when it will
3000 * Smart callbacks one can register to:
3001 * - "changed" - the clock's user changed the time
3003 * Here is an example on its usage:
3004 * @li @ref clock_example
3013 * Identifiers for which clock digits should be editable, when a
3014 * clock widget is in edition mode. Values may be ORed together to
3015 * make a mask, naturally.
3017 * @see elm_clock_edit_set()
3018 * @see elm_clock_digit_edit_set()
3020 typedef enum _Elm_Clock_Digedit
3022 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3023 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3024 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3025 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3026 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3027 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3028 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3029 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3030 } Elm_Clock_Digedit;
3033 * Add a new clock widget to the given parent Elementary
3034 * (container) object
3036 * @param parent The parent object
3037 * @return a new clock widget handle or @c NULL, on errors
3039 * This function inserts a new clock widget on the canvas.
3043 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3046 * Set a clock widget's time, programmatically
3048 * @param obj The clock widget object
3049 * @param hrs The hours to set
3050 * @param min The minutes to set
3051 * @param sec The secondes to set
3053 * This function updates the time that is showed by the clock
3056 * Values @b must be set within the following ranges:
3057 * - 0 - 23, for hours
3058 * - 0 - 59, for minutes
3059 * - 0 - 59, for seconds,
3061 * even if the clock is not in "military" mode.
3063 * @warning The behavior for values set out of those ranges is @b
3068 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3071 * Get a clock widget's time values
3073 * @param obj The clock object
3074 * @param[out] hrs Pointer to the variable to get the hours value
3075 * @param[out] min Pointer to the variable to get the minutes value
3076 * @param[out] sec Pointer to the variable to get the seconds value
3078 * This function gets the time set for @p obj, returning
3079 * it on the variables passed as the arguments to function
3081 * @note Use @c NULL pointers on the time values you're not
3082 * interested in: they'll be ignored by the function.
3086 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3089 * Set whether a given clock widget is under <b>edition mode</b> or
3090 * under (default) displaying-only mode.
3092 * @param obj The clock object
3093 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3094 * put it back to "displaying only" mode
3096 * This function makes a clock's time to be editable or not <b>by
3097 * user interaction</b>. When in edition mode, clocks @b stop
3098 * ticking, until one brings them back to canonical mode. The
3099 * elm_clock_digit_edit_set() function will influence which digits
3100 * of the clock will be editable. By default, all of them will be
3101 * (#ELM_CLOCK_NONE).
3103 * @note am/pm sheets, if being shown, will @b always be editable
3104 * under edition mode.
3106 * @see elm_clock_edit_get()
3110 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3113 * Retrieve whether a given clock widget is under <b>edition
3114 * mode</b> or under (default) displaying-only mode.
3116 * @param obj The clock object
3117 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3120 * This function retrieves whether the clock's time can be edited
3121 * or not by user interaction.
3123 * @see elm_clock_edit_set() for more details
3127 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3130 * Set what digits of the given clock widget should be editable
3131 * when in edition mode.
3133 * @param obj The clock object
3134 * @param digedit Bit mask indicating the digits to be editable
3135 * (values in #Elm_Clock_Digedit).
3137 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3138 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3141 * @see elm_clock_digit_edit_get()
3145 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3148 * Retrieve what digits of the given clock widget should be
3149 * editable when in edition mode.
3151 * @param obj The clock object
3152 * @return Bit mask indicating the digits to be editable
3153 * (values in #Elm_Clock_Digedit).
3155 * @see elm_clock_digit_edit_set() for more details
3159 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3162 * Set if the given clock widget must show hours in military or
3165 * @param obj The clock object
3166 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3169 * This function sets if the clock must show hours in military or
3170 * am/pm mode. In some countries like Brazil the military mode
3171 * (00-24h-format) is used, in opposition to the USA, where the
3172 * am/pm mode is more commonly used.
3174 * @see elm_clock_show_am_pm_get()
3178 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3181 * Get if the given clock widget shows hours in military or am/pm
3184 * @param obj The clock object
3185 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3188 * This function gets if the clock shows hours in military or am/pm
3191 * @see elm_clock_show_am_pm_set() for more details
3195 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3198 * Set if the given clock widget must show time with seconds or not
3200 * @param obj The clock object
3201 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3203 * This function sets if the given clock must show or not elapsed
3204 * seconds. By default, they are @b not shown.
3206 * @see elm_clock_show_seconds_get()
3210 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3213 * Get whether the given clock widget is showing time with seconds
3216 * @param obj The clock object
3217 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3219 * This function gets whether @p obj is showing or not the elapsed
3222 * @see elm_clock_show_seconds_set()
3226 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3229 * Set the interval on time updates for an user mouse button hold
3230 * on clock widgets' time edition.
3232 * @param obj The clock object
3233 * @param interval The (first) interval value in seconds
3235 * This interval value is @b decreased while the user holds the
3236 * mouse pointer either incrementing or decrementing a given the
3237 * clock digit's value.
3239 * This helps the user to get to a given time distant from the
3240 * current one easier/faster, as it will start to flip quicker and
3241 * quicker on mouse button holds.
3243 * The calculation for the next flip interval value, starting from
3244 * the one set with this call, is the previous interval divided by
3245 * 1.05, so it decreases a little bit.
3247 * The default starting interval value for automatic flips is
3250 * @see elm_clock_interval_get()
3254 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3257 * Get the interval on time updates for an user mouse button hold
3258 * on clock widgets' time edition.
3260 * @param obj The clock object
3261 * @return The (first) interval value, in seconds, set on it
3263 * @see elm_clock_interval_set() for more details
3267 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3274 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3275 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3276 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3277 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3278 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3279 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3280 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3281 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3282 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3283 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3284 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3285 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3286 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3287 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3288 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);
3289 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3290 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3291 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3292 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3293 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3294 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3295 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3296 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3297 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3298 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3299 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);
3300 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3302 * @def elm_layout_icon_set
3303 * Convienience macro to set the icon object in a layout that follows the
3304 * Elementary naming convention for its parts.
3308 #define elm_layout_icon_set(_ly, _obj) \
3311 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3312 if ((_obj)) sig = "elm,state,icon,visible"; \
3313 else sig = "elm,state,icon,hidden"; \
3314 elm_object_signal_emit((_ly), sig, "elm"); \
3318 * @def elm_layout_icon_get
3319 * Convienience macro to get the icon object from a layout that follows the
3320 * Elementary naming convention for its parts.
3324 #define elm_layout_icon_get(_ly) \
3325 elm_layout_content_get((_ly), "elm.swallow.icon")
3328 * @def elm_layout_end_set
3329 * Convienience macro to set the end object in a layout that follows the
3330 * Elementary naming convention for its parts.
3334 #define elm_layout_end_set(_ly, _obj) \
3337 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3338 if ((_obj)) sig = "elm,state,end,visible"; \
3339 else sig = "elm,state,end,hidden"; \
3340 elm_object_signal_emit((_ly), sig, "elm"); \
3344 * @def elm_layout_end_get
3345 * Convienience macro to get the end object in a layout that follows the
3346 * Elementary naming convention for its parts.
3350 #define elm_layout_end_get(_ly) \
3351 elm_layout_content_get((_ly), "elm.swallow.end")
3354 * @def elm_layout_label_set
3355 * Convienience macro to set the label in a layout that follows the
3356 * Elementary naming convention for its parts.
3359 * @deprecate use elm_object_text_* instead.
3361 #define elm_layout_label_set(_ly, _txt) \
3362 elm_layout_text_set((_ly), "elm.text", (_txt))
3365 * @def elm_layout_label_get
3366 * Convienience macro to get the label in a layout that follows the
3367 * Elementary naming convention for its parts.
3370 * @deprecate use elm_object_text_* instead.
3372 #define elm_layout_label_get(_ly) \
3373 elm_layout_text_get((_ly), "elm.text")
3375 /* smart callbacks called:
3379 typedef enum _Elm_Notify_Orient
3381 ELM_NOTIFY_ORIENT_TOP,
3382 ELM_NOTIFY_ORIENT_CENTER,
3383 ELM_NOTIFY_ORIENT_BOTTOM,
3384 ELM_NOTIFY_ORIENT_LEFT,
3385 ELM_NOTIFY_ORIENT_RIGHT,
3386 ELM_NOTIFY_ORIENT_TOP_LEFT,
3387 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3388 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3389 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3390 ELM_NOTIFY_ORIENT_LAST
3391 } Elm_Notify_Orient;
3392 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3393 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3394 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3395 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3396 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3397 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3398 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3399 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3400 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3401 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3402 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3403 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3404 /* smart callbacks called:
3405 * "timeout" - when timeout happens on notify and it's hidden
3406 * "block,clicked" - when it's hidden by a click outside of the notify's view
3410 typedef enum _Elm_Hover_Axis
3412 ELM_HOVER_AXIS_NONE,
3413 ELM_HOVER_AXIS_HORIZONTAL,
3414 ELM_HOVER_AXIS_VERTICAL,
3417 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3418 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3419 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3420 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3421 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3422 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3423 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3424 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3425 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3426 /* available styles:
3432 /* smart callbacks called:
3433 * "clicked" - the user clicked the empty space in the hover to dismiss
3434 * "smart,changed" - a content object placed under the "smart"
3435 * policy was replaced to a new slot direction.
3439 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3440 struct _Elm_Entry_Anchor_Info
3444 Evas_Coord x, y, w, h;
3446 typedef enum _Elm_Icon_Type
3453 typedef enum _Elm_Input_Panel_Layout
3455 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default 4x4 layout */
3456 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
3457 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
3458 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
3459 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
3460 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
3461 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
3462 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
3463 ELM_INPUT_PANEL_LAYOUT_CUSTOM_1 = 100, /* Reserved for future use */
3464 ELM_INPUT_PANEL_LAYOUT_CUSTOM_2,
3465 ELM_INPUT_PANEL_LAYOUT_CUSTOM_3,
3466 ELM_INPUT_PANEL_LAYOUT_CUSTOM_4,
3467 ELM_INPUT_PANEL_LAYOUT_CUSTOM_5,
3468 ELM_INPUT_PANEL_LAYOUT_CUSTOM_6,
3469 ELM_INPUT_PANEL_LAYOUT_CUSTOM_7,
3470 ELM_INPUT_PANEL_LAYOUT_CUSTOM_8,
3471 ELM_INPUT_PANEL_LAYOUT_CUSTOM_9,
3472 ELM_INPUT_PANEL_LAYOUT_CUSTOM_10
3473 } Elm_Input_Panel_Layout;
3475 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3477 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3478 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3479 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3480 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3481 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3482 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3483 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3484 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3485 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3486 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3487 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3488 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3489 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3490 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3491 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3492 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3493 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3494 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3495 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3496 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3497 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3498 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3499 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3500 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3501 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3502 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3503 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3504 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3505 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3506 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3507 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3508 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);
3509 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3510 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3511 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3512 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3513 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3514 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3515 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);
3516 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3517 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3518 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);
3519 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);
3520 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);
3521 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);
3522 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);
3523 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);
3524 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3525 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3526 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3527 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
3528 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3529 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3530 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3531 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3532 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3533 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3534 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3535 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3536 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3537 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3538 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3539 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3540 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3541 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3542 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
3543 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
3544 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3545 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3546 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3547 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3548 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3549 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
3550 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3551 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3552 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3553 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3554 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3555 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3556 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3557 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3558 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3559 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3560 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3562 /* pre-made filters for entries */
3563 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3564 struct _Elm_Entry_Filter_Limit_Size
3569 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3570 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3571 struct _Elm_Entry_Filter_Accept_Set
3573 const char *accepted;
3574 const char *rejected;
3576 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3577 /* smart callbacks called:
3578 * "changed" - the text content changed
3579 * "selection,start" - the user started selecting text
3580 * "selection,changed" - the user modified the selection size/location
3581 * "selection,cleared" - the user cleared the selection
3582 * "selection,paste" - the user requested a paste of text
3583 * "selection,copy" - the user copied the text
3584 * "selection,cut" - the user cut the text
3585 * "cursor,changed" - the cursor changed position
3586 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3587 * "activated" - when the enter key is pressed (useful for single line)
3588 * "press" - when finger/mouse is pressed down
3589 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3590 * "clicked,double" - when finger/mouse is double-pressed
3591 * "longpressed" - the entry has been longpressed
3592 * "focused" - the entry has received keyboard focus
3593 * "unfocused" - keyboard focus is gone
3596 /* composite widgets - these basically put together basic widgets above
3597 * in convenient packages that do more than basic stuff */
3601 * @defgroup Anchorview Anchorview
3603 * Anchorview is for displaying text that contains markup with anchors
3604 * like <c>\<a href=1234\>something\</\></c> in it.
3606 * Besides being styled differently, the anchorview widget provides the
3607 * necessary functionality so that clicking on these anchors brings up a
3608 * popup with user defined content such as "call", "add to contacts" or
3609 * "open web page". This popup is provided using the @ref Hover widget.
3611 * This widget is very similar to @ref Anchorblock, so refer to that
3612 * widget for an example. The only difference Anchorview has is that the
3613 * widget is already provided with scrolling functionality, so if the
3614 * text set to it is too large to fit in the given space, it will scroll,
3615 * whereas the @ref Anchorblock widget will keep growing to ensure all the
3616 * text can be displayed.
3618 * This widget emits the following signals:
3619 * @li "anchor,clicked": will be called when an anchor is clicked. The
3620 * @p event_info parameter on the callback will be a pointer of type
3621 * ::Elm_Entry_Anchorview_Info.
3623 * See @ref Anchorblock for an example on how to use both of them.
3632 * @typedef Elm_Entry_Anchorview_Info
3634 * The info sent in the callback for "anchor,clicked" signals emitted by
3635 * the Anchorview widget.
3637 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3639 * @struct _Elm_Entry_Anchorview_Info
3641 * The info sent in the callback for "anchor,clicked" signals emitted by
3642 * the Anchorview widget.
3644 struct _Elm_Entry_Anchorview_Info
3646 const char *name; /**< Name of the anchor, as indicated in its href
3648 int button; /**< The mouse button used to click on it */
3649 Evas_Object *hover; /**< The hover object to use for the popup */
3651 Evas_Coord x, y, w, h;
3652 } anchor, /**< Geometry selection of text used as anchor */
3653 hover_parent; /**< Geometry of the object used as parent by the
3655 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
3656 for content on the left side of
3657 the hover. Before calling the
3658 callback, the widget will make the
3659 necessary calculations to check
3660 which sides are fit to be set with
3661 content, based on the position the
3662 hover is activated and its distance
3663 to the edges of its parent object
3665 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
3666 the right side of the hover.
3667 See @ref hover_left */
3668 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
3669 of the hover. See @ref hover_left */
3670 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
3671 below the hover. See @ref
3675 * Add a new Anchorview object
3677 * @param parent The parent object
3678 * @return The new object or NULL if it cannot be created
3680 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3682 * Set the text to show in the anchorview
3684 * Sets the text of the anchorview to @p text. This text can include markup
3685 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3686 * text that will be specially styled and react to click events, ended with
3687 * either of \</a\> or \</\>. When clicked, the anchor will emit an
3688 * "anchor,clicked" signal that you can attach a callback to with
3689 * evas_object_smart_callback_add(). The name of the anchor given in the
3690 * event info struct will be the one set in the href attribute, in this
3693 * Other markup can be used to style the text in different ways, but it's
3694 * up to the style defined in the theme which tags do what.
3695 * @deprecated use elm_object_text_set() instead.
3697 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3699 * Get the markup text set for the anchorview
3701 * Retrieves the text set on the anchorview, with markup tags included.
3703 * @param obj The anchorview object
3704 * @return The markup text set or @c NULL if nothing was set or an error
3706 * @deprecated use elm_object_text_set() instead.
3708 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3710 * Set the parent of the hover popup
3712 * Sets the parent object to use by the hover created by the anchorview
3713 * when an anchor is clicked. See @ref Hover for more details on this.
3714 * If no parent is set, the same anchorview object will be used.
3716 * @param obj The anchorview object
3717 * @param parent The object to use as parent for the hover
3719 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3721 * Get the parent of the hover popup
3723 * Get the object used as parent for the hover created by the anchorview
3724 * widget. See @ref Hover for more details on this.
3726 * @param obj The anchorview object
3727 * @return The object used as parent for the hover, NULL if none is set.
3729 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3731 * Set the style that the hover should use
3733 * When creating the popup hover, anchorview will request that it's
3734 * themed according to @p style.
3736 * @param obj The anchorview object
3737 * @param style The style to use for the underlying hover
3739 * @see elm_object_style_set()
3741 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3743 * Get the style that the hover should use
3745 * Get the style the hover created by anchorview will use.
3747 * @param obj The anchorview object
3748 * @return The style to use by the hover. NULL means the default is used.
3750 * @see elm_object_style_set()
3752 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3754 * Ends the hover popup in the anchorview
3756 * When an anchor is clicked, the anchorview widget will create a hover
3757 * object to use as a popup with user provided content. This function
3758 * terminates this popup, returning the anchorview to its normal state.
3760 * @param obj The anchorview object
3762 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3764 * Set bouncing behaviour when the scrolled content reaches an edge
3766 * Tell the internal scroller object whether it should bounce or not
3767 * when it reaches the respective edges for each axis.
3769 * @param obj The anchorview object
3770 * @param h_bounce Whether to bounce or not in the horizontal axis
3771 * @param v_bounce Whether to bounce or not in the vertical axis
3773 * @see elm_scroller_bounce_set()
3775 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3777 * Get the set bouncing behaviour of the internal scroller
3779 * Get whether the internal scroller should bounce when the edge of each
3780 * axis is reached scrolling.
3782 * @param obj The anchorview object
3783 * @param h_bounce Pointer where to store the bounce state of the horizontal
3785 * @param v_bounce Pointer where to store the bounce state of the vertical
3788 * @see elm_scroller_bounce_get()
3790 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3792 * Appends a custom item provider to the given anchorview
3794 * Appends the given function to the list of items providers. This list is
3795 * called, one function at a time, with the given @p data pointer, the
3796 * anchorview object and, in the @p item parameter, the item name as
3797 * referenced in its href string. Following functions in the list will be
3798 * called in order until one of them returns something different to NULL,
3799 * which should be an Evas_Object which will be used in place of the item
3802 * Items in the markup text take the form \<item relsize=16x16 vsize=full
3803 * href=item/name\>\</item\>
3805 * @param obj The anchorview object
3806 * @param func The function to add to the list of providers
3807 * @param data User data that will be passed to the callback function
3809 * @see elm_entry_item_provider_append()
3811 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);
3813 * Prepend a custom item provider to the given anchorview
3815 * Like elm_anchorview_item_provider_append(), but it adds the function
3816 * @p func to the beginning of the list, instead of the end.
3818 * @param obj The anchorview object
3819 * @param func The function to add to the list of providers
3820 * @param data User data that will be passed to the callback function
3822 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);
3824 * Remove a custom item provider from the list of the given anchorview
3826 * Removes the function and data pairing that matches @p func and @p data.
3827 * That is, unless the same function and same user data are given, the
3828 * function will not be removed from the list. This allows us to add the
3829 * same callback several times, with different @p data pointers and be
3830 * able to remove them later without conflicts.
3832 * @param obj The anchorview object
3833 * @param func The function to remove from the list
3834 * @param data The data matching the function to remove from the list
3836 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);
3843 * @defgroup Anchorblock Anchorblock
3845 * Anchorblock is for displaying text that contains markup with anchors
3846 * like <c>\<a href=1234\>something\</\></c> in it.
3848 * Besides being styled differently, the anchorblock widget provides the
3849 * necessary functionality so that clicking on these anchors brings up a
3850 * popup with user defined content such as "call", "add to contacts" or
3851 * "open web page". This popup is provided using the @ref Hover widget.
3853 * This widget emits the following signals:
3854 * @li "anchor,clicked": will be called when an anchor is clicked. The
3855 * @p event_info parameter on the callback will be a pointer of type
3856 * ::Elm_Entry_Anchorblock_Info.
3862 * Since examples are usually better than plain words, we might as well
3863 * try @ref tutorial_anchorblock_example "one".
3866 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
3867 * This exampel will show both Anchorblock and @ref Anchorview,
3868 * since both are very similar and it's easier to show them once and side
3869 * by side, so the difference is more clear.
3871 * We'll show the relevant snippets of the code here, but the full example
3872 * can be found here... sorry, @ref anchorblock_example_01.c "here".
3874 * As for the actual example, it's just a simple window with an anchorblock
3875 * and an anchorview, both containing the same text. After including
3876 * Elementary.h and declaring some functions we'll need, we jump to our
3877 * elm_main (see ELM_MAIN) and create our window.
3878 * @dontinclude anchorblock_example_01.c
3883 * With the needed variables declared, we'll create the window and a box to
3884 * hold our widgets, but we don't need to go through that here.
3886 * In order to make clear where the anchorblock ends and the anchorview
3887 * begins, they'll be each inside a @ref Frame. After creating the frame,
3888 * the anchorblock follows.
3889 * @skip elm_frame_add
3890 * @until elm_frame_content_set
3892 * Nothing out of the ordinary there. What's worth mentioning is the call
3893 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
3894 * when an anchor is clicked, the hover for the popup will cover the entire
3895 * window. This affects the area that will be obscured by the hover and
3896 * where clicking will dismiss it, as well as the calculations it does to
3897 * inform the best locations where to insert the popups content.
3898 * Other than that, the code is pretty standard. We also need to set our
3899 * callback for when an anchor is clicked, since it's our task to populate
3900 * the popup. There's no default for it.
3902 * The anchorview is no different, we only change a few things so it looks
3904 * @until elm_frame_content_set
3906 * Then we run, so stuff works and close our main function in the usual way.
3909 * Now, a little note. Normally you would use either one of anchorblock or
3910 * anchorview, set your one callback to clicks and do your stuff in there.
3911 * In this example, however, there are a few tricks to make it easier to
3912 * show both widgets in one go (and to save me some typing). So we have
3913 * two callbacks, one per widget, that will call a common function to do
3914 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
3915 * anchorview too, since both are equal, and passing a callback to use
3916 * for our buttons to end the hover, because each widget has a different
3918 * @until _anchorview_clicked_cb
3921 * The meat of our popup is in the following function. We check what kind
3922 * of menu we need to show, based on the name set to the anchor in the
3923 * markup text. If there's no type (something went wrong, no valid contact
3924 * in the address list) we are just putting a button that does nothing, but
3925 * it's perfectly reasonable to just end the hover and call it quits.
3927 * Our popup will consist of one main button in the middle of our hover,
3928 * and possibly a secondary button and a list of other options. We'll create
3929 * first our main button and check what kind of popup we need afterwards.
3932 * @until eina_stringshare_add
3935 * Each button has two callbacks, one is our hack to close the hover
3936 * properly based on which widget it belongs to, the other a simple
3937 * printf that will show the action with the anchors own data. This is
3938 * not how you would usually do it. Instead, the common case is to have
3939 * one callback for the button that will know which function to call to end
3940 * things, but since we are doing it this way it's worth noting that
3941 * smart callbacks will be called in reverse in respect to the order they
3942 * were added, and since our @c btn_end_cb will close the hover, and thus
3943 * delete our buttons, the other callback wouldn't be called if we had
3946 * After our telephone popup, there are a few others that are practically
3947 * the same, so they won't be shown here.
3949 * Once we are done with that, it's time to place our actions into our
3950 * hover. Main button goes in the middle without much questioning, and then
3951 * we see if we have a secondary button and a box of extra options.
3952 * Because I said so, secondary button goes on either side and box of
3953 * options either on top or below the main one, but to choose which
3954 * exactly, we use the hints our callback info has, which saves us from
3955 * having to do the math and see which side has more space available, with
3956 * a little special case where we delete our extra stuff if there's nowhere
3960 * @skip evas_object_smart
3961 * @until evas_object_del(box)
3965 * The example will look like this:
3966 * @image html screenshots/anchorblock_01.png
3967 * @image latex screenshots/anchorblock_01.eps
3969 * @example anchorblock_example_01.c
3972 * @addtogroup Anchorblock
3976 * @typedef Elm_Entry_Anchorblock_Info
3978 * The info sent in the callback for "anchor,clicked" signals emitted by
3979 * the Anchorblock widget.
3981 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
3983 * @struct _Elm_Entry_Anchorblock_Info
3985 * The info sent in the callback for "anchor,clicked" signals emitted by
3986 * the Anchorblock widget.
3988 struct _Elm_Entry_Anchorblock_Info
3990 const char *name; /**< Name of the anchor, as indicated in its href
3992 int button; /**< The mouse button used to click on it */
3993 Evas_Object *hover; /**< The hover object to use for the popup */
3995 Evas_Coord x, y, w, h;
3996 } anchor, /**< Geometry selection of text used as anchor */
3997 hover_parent; /**< Geometry of the object used as parent by the
3999 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4000 for content on the left side of
4001 the hover. Before calling the
4002 callback, the widget will make the
4003 necessary calculations to check
4004 which sides are fit to be set with
4005 content, based on the position the
4006 hover is activated and its distance
4007 to the edges of its parent object
4009 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4010 the right side of the hover.
4011 See @ref hover_left */
4012 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4013 of the hover. See @ref hover_left */
4014 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4015 below the hover. See @ref
4019 * Add a new Anchorblock object
4021 * @param parent The parent object
4022 * @return The new object or NULL if it cannot be created
4024 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4026 * Set the text to show in the anchorblock
4028 * Sets the text of the anchorblock to @p text. This text can include markup
4029 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4030 * of text that will be specially styled and react to click events, ended
4031 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4032 * "anchor,clicked" signal that you can attach a callback to with
4033 * evas_object_smart_callback_add(). The name of the anchor given in the
4034 * event info struct will be the one set in the href attribute, in this
4037 * Other markup can be used to style the text in different ways, but it's
4038 * up to the style defined in the theme which tags do what.
4039 * @deprecated use elm_object_text_set() instead.
4041 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4043 * Get the markup text set for the anchorblock
4045 * Retrieves the text set on the anchorblock, with markup tags included.
4047 * @param obj The anchorblock object
4048 * @return The markup text set or @c NULL if nothing was set or an error
4050 * @deprecated use elm_object_text_set() instead.
4052 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4054 * Set the parent of the hover popup
4056 * Sets the parent object to use by the hover created by the anchorblock
4057 * when an anchor is clicked. See @ref Hover for more details on this.
4059 * @param obj The anchorblock object
4060 * @param parent The object to use as parent for the hover
4062 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4064 * Get the parent of the hover popup
4066 * Get the object used as parent for the hover created by the anchorblock
4067 * widget. See @ref Hover for more details on this.
4068 * If no parent is set, the same anchorblock object will be used.
4070 * @param obj The anchorblock object
4071 * @return The object used as parent for the hover, NULL if none is set.
4073 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4075 * Set the style that the hover should use
4077 * When creating the popup hover, anchorblock will request that it's
4078 * themed according to @p style.
4080 * @param obj The anchorblock object
4081 * @param style The style to use for the underlying hover
4083 * @see elm_object_style_set()
4085 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4087 * Get the style that the hover should use
4089 * Get the style the hover created by anchorblock will use.
4091 * @param obj The anchorblock object
4092 * @return The style to use by the hover. NULL means the default is used.
4094 * @see elm_object_style_set()
4096 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4098 * Ends the hover popup in the anchorblock
4100 * When an anchor is clicked, the anchorblock widget will create a hover
4101 * object to use as a popup with user provided content. This function
4102 * terminates this popup, returning the anchorblock to its normal state.
4104 * @param obj The anchorblock object
4106 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4108 * Appends a custom item provider to the given anchorblock
4110 * Appends the given function to the list of items providers. This list is
4111 * called, one function at a time, with the given @p data pointer, the
4112 * anchorblock object and, in the @p item parameter, the item name as
4113 * referenced in its href string. Following functions in the list will be
4114 * called in order until one of them returns something different to NULL,
4115 * which should be an Evas_Object which will be used in place of the item
4118 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4119 * href=item/name\>\</item\>
4121 * @param obj The anchorblock object
4122 * @param func The function to add to the list of providers
4123 * @param data User data that will be passed to the callback function
4125 * @see elm_entry_item_provider_append()
4127 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);
4129 * Prepend a custom item provider to the given anchorblock
4131 * Like elm_anchorblock_item_provider_append(), but it adds the function
4132 * @p func to the beginning of the list, instead of the end.
4134 * @param obj The anchorblock object
4135 * @param func The function to add to the list of providers
4136 * @param data User data that will be passed to the callback function
4138 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);
4140 * Remove a custom item provider from the list of the given anchorblock
4142 * Removes the function and data pairing that matches @p func and @p data.
4143 * That is, unless the same function and same user data are given, the
4144 * function will not be removed from the list. This allows us to add the
4145 * same callback several times, with different @p data pointers and be
4146 * able to remove them later without conflicts.
4148 * @param obj The anchorblock object
4149 * @param func The function to remove from the list
4150 * @param data The data matching the function to remove from the list
4152 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);
4158 * @defgroup Bubble Bubble
4160 * @brief The Bubble is a widget to show text similarly to how speech is
4161 * represented in comics.
4163 * The bubble widget contains 5 important visual elements:
4164 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4165 * @li The @p icon is an image to which the frame's arrow points to.
4166 * @li The @p label is a text which appears to the right of the icon if the
4167 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4169 * @li The @p info is a text which appears to the right of the label. Info's
4170 * font is of a ligther color than label.
4171 * @li The @p content is an evas object that is shown inside the frame.
4173 * The position of the arrow, icon, label and info depends on which corner is
4174 * selected. The four available corners are:
4175 * @li "top_left" - Default
4178 * @li "bottom_right"
4180 * Signals that you can add callbacks for are:
4181 * @li "clicked" - This is called when a user has clicked the bubble.
4183 * For an example of using a buble see @ref bubble_01_example_page "this".
4188 * Add a new bubble to the parent
4190 * @param parent The parent object
4191 * @return The new object or NULL if it cannot be created
4193 * This function adds a text bubble to the given parent evas object.
4195 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4197 * Set the label of the bubble
4199 * @param obj The bubble object
4200 * @param label The string to set in the label
4202 * This function sets the title of the bubble. Where this appears depends on
4203 * the selected corner.
4204 * @deprecated use elm_object_text_set() instead.
4206 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4208 * Get the label of the bubble
4210 * @param obj The bubble object
4211 * @return The string of set in the label
4213 * This function gets the title of the bubble.
4214 * @deprecated use elm_object_text_set() instead.
4216 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4218 * Set the info of the bubble
4220 * @param obj The bubble object
4221 * @param info The given info about the bubble
4223 * This function sets the info of the bubble. Where this appears depends on
4224 * the selected corner.
4225 * @deprecated use elm_object_text_set() instead.
4227 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4229 * Get the info of the bubble
4231 * @param obj The bubble object
4233 * @return The "info" string of the bubble
4235 * This function gets the info text.
4236 * @deprecated use elm_object_text_set() instead.
4238 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240 * Set the content to be shown in the bubble
4242 * Once the content object is set, a previously set one will be deleted.
4243 * If you want to keep the old content object, use the
4244 * elm_bubble_content_unset() function.
4246 * @param obj The bubble object
4247 * @param content The given content of the bubble
4249 * This function sets the content shown on the middle of the bubble.
4251 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4253 * Get the content shown in the bubble
4255 * Return the content object which is set for this widget.
4257 * @param obj The bubble object
4258 * @return The content that is being used
4260 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4262 * Unset the content shown in the bubble
4264 * Unparent and return the content object which was set for this widget.
4266 * @param obj The bubble object
4267 * @return The content that was being used
4269 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4271 * Set the icon of the bubble
4273 * Once the icon object is set, a previously set one will be deleted.
4274 * If you want to keep the old content object, use the
4275 * elm_icon_content_unset() function.
4277 * @param obj The bubble object
4278 * @param icon The given icon for the bubble
4280 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4282 * Get the icon of the bubble
4284 * @param obj The bubble object
4285 * @return The icon for the bubble
4287 * This function gets the icon shown on the top left of bubble.
4289 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4291 * Unset the icon of the bubble
4293 * Unparent and return the icon object which was set for this widget.
4295 * @param obj The bubble object
4296 * @return The icon that was being used
4298 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4300 * Set the corner of the bubble
4302 * @param obj The bubble object.
4303 * @param corner The given corner for the bubble.
4305 * This function sets the corner of the bubble. The corner will be used to
4306 * determine where the arrow in the frame points to and where label, icon and
4309 * Possible values for corner are:
4310 * @li "top_left" - Default
4313 * @li "bottom_right"
4315 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4317 * Get the corner of the bubble
4319 * @param obj The bubble object.
4320 * @return The given corner for the bubble.
4322 * This function gets the selected corner of the bubble.
4324 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4327 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4334 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4335 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4336 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4337 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4338 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4339 /* smart callbacks called:
4340 * "clicked" - the user clicked the icon
4341 * "drag,start" - Someone started dragging the image out of the object
4342 * "drag,end" - Dragged item was dropped (somewhere)
4346 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4348 * @enum _Elm_Gesture_Types
4349 * Emum of supported gesture types.
4350 * @ingroup Elm_Gesture_Layer
4352 enum _Elm_Gesture_Types
4354 ELM_GESTURE_FIRST = 0,
4356 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4357 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4358 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4360 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4362 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4363 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4365 ELM_GESTURE_ZOOM, /**< Zoom */
4366 ELM_GESTURE_ROTATE, /**< Rotate */
4372 * @typedef Elm_Gesture_Types
4373 * Type for Emum of supported gesture types.
4374 * @ingroup Elm_Gesture_Layer
4376 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4379 * @enum _Elm_Gesture_State
4380 * Emum of gesture states.
4381 * @ingroup Elm_Gesture_Layer
4383 enum _Elm_Gesture_State
4385 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4386 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4387 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4388 ELM_GESTURE_STATE_END, /**< Gesture completed */
4389 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4392 * @typedef Elm_Gesture_State
4394 * @ingroup Elm_Gesture_Layer
4396 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4399 * @struct _Elm_Gesture_Taps_Info
4400 * Struct holds taps info for user
4401 * @ingroup Elm_Gesture_Layer
4403 struct _Elm_Gesture_Taps_Info
4405 Evas_Coord x, y; /**< Holds center point between fingers */
4406 unsigned int n; /**< Number of fingers tapped */
4407 unsigned int timestamp; /**< event timestamp */
4411 * @typedef Elm_Gesture_Taps_Info
4412 * holds taps info for user
4413 * @ingroup Elm_Gesture_Layer
4415 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4418 * @struct _Elm_Gesture_Momentum_Info
4419 * Struct holds momentum info for user
4420 * x1 and y1 are not necessarily in sync
4421 * x1 holds x value of x direction starting point
4422 * and same holds for y1.
4423 * This is noticeable when doing V-shape movement
4424 * @ingroup Elm_Gesture_Layer
4426 struct _Elm_Gesture_Momentum_Info
4427 { /* Report line ends, timestamps, and momentum computed */
4428 Evas_Coord x1; /**< Final-swipe direction starting point on X */
4429 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4430 Evas_Coord x2; /**< Final-swipe direction ending point on X */
4431 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
4433 unsigned int tx; /**< Timestamp of start of final x-swipe */
4434 unsigned int ty; /**< Timestamp of start of final y-swipe */
4436 Evas_Coord mx; /**< Momentum on X */
4437 Evas_Coord my; /**< Momentum on Y */
4441 * @typedef Elm_Gesture_Momentum_Info
4442 * holds momentum info for user
4443 * @ingroup Elm_Gesture_Layer
4445 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4448 * @struct _Elm_Gesture_Line_Info
4449 * Struct holds line info for user
4450 * @ingroup Elm_Gesture_Layer
4452 struct _Elm_Gesture_Line_Info
4453 { /* Report line ends, timestamps, and momentum computed */
4454 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4455 unsigned int n; /**< Number of fingers (lines) */
4456 /* FIXME should be radians, bot degrees */
4457 double angle; /**< Angle (direction) of lines */
4461 * @typedef _Elm_Gesture_Line_Info
4462 * Holds line info for user
4463 * @ingroup Elm_Gesture_Layer
4465 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4468 * @struct _Elm_Gesture_Zoom_Info
4469 * Struct holds zoom info for user
4470 * @ingroup Elm_Gesture_Layer
4472 struct _Elm_Gesture_Zoom_Info
4474 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4475 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4476 float zoom; /**< Zoom value: 1.0 means no zoom */
4477 float momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4481 * @typedef Elm_Gesture_Zoom_Info
4482 * Holds zoom info for user
4483 * @ingroup Elm_Gesture_Layer
4485 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4488 * @struct _Elm_Gesture_Rotate_Info
4489 * Struct holds rotation info for user
4490 * @ingroup Elm_Gesture_Layer
4492 struct _Elm_Gesture_Rotate_Info
4494 Evas_Coord x, y; /**< Holds zoom center point reported to user */
4495 Evas_Coord radius; /**< Holds radius between fingers reported to user */
4496 double base_angle; /**< Holds start-angle */
4497 double angle; /**< Rotation value: 0.0 means no rotation */
4498 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4502 * @typedef Elm_Gesture_Rotate_Info
4503 * Holds rotation info for user
4504 * @ingroup Elm_Gesture_Layer
4506 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4509 * @typedef Elm_Gesture_Event_Cb
4510 * User callback used to stream gesture info from gesture layer
4511 * @param data user data
4512 * @param event_info gesture report info
4513 * Returns a flag field to be applied on the causing event.
4514 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4515 * upon the event, in an irreversible way.
4517 * @ingroup Elm_Gesture_Layer
4519 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4522 * Use function to set callbacks to be notified about
4523 * change of state of gesture.
4524 * When a user registers a callback with this function
4525 * this means this gesture has to be tested.
4527 * When ALL callbacks for a gesture are set to NULL
4528 * it means user isn't interested in gesture-state
4529 * and it will not be tested.
4531 * @param obj Pointer to gesture-layer.
4532 * @param idx The gesture you would like to track its state.
4533 * @param cb callback function pointer.
4534 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4535 * @param data user info to be sent to callback (usually, Smart Data)
4537 * @ingroup Elm_Gesture_Layer
4539 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);
4542 * Call this function to get repeat-events settings.
4544 * @param obj Pointer to gesture-layer.
4546 * @return repeat events settings.
4547 * @see elm_gesture_layer_hold_events_set()
4548 * @ingroup Elm_Gesture_Layer
4550 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4553 * This function called in order to make gesture-layer repeat events.
4554 * Set this of you like to get the raw events only if gestures were not detected.
4555 * Clear this if you like gesture layer to fwd events as testing gestures.
4557 * @param obj Pointer to gesture-layer.
4558 * @param r Repeat: TRUE/FALSE
4560 * @ingroup Elm_Gesture_Layer
4562 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4565 * This function sets step-value for zoom action.
4566 * Set step to any positive value.
4567 * Cancel step setting by setting to 0.0
4569 * @param obj Pointer to gesture-layer.
4570 * @param s new zoom step value.
4572 * @ingroup Elm_Gesture_Layer
4574 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4577 * This function sets step-value for rotate action.
4578 * Set step to any positive value.
4579 * Cancel step setting by setting to 0.0
4581 * @param obj Pointer to gesture-layer.
4582 * @param s new roatate step value.
4584 * @ingroup Elm_Gesture_Layer
4586 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4589 * This function called to attach gesture-layer to an Evas_Object.
4590 * @param obj Pointer to gesture-layer.
4591 * @param t Pointer to underlying object (AKA Target)
4593 * @return TRUE, FALSE on success, failure.
4595 * @ingroup Elm_Gesture_Layer
4597 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4600 * Call this function to construct a new gesture-layer object.
4601 * This does not activate the gesture layer. You have to
4602 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4604 * @param parent the parent object.
4606 * @return Pointer to new gesture-layer object.
4608 * @ingroup Elm_Gesture_Layer
4610 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4613 typedef enum _Elm_Thumb_Animation_Setting
4615 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4616 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
4617 ELM_THUMB_ANIMATION_STOP,
4618 ELM_THUMB_ANIMATION_LAST
4619 } Elm_Thumb_Animation_Setting;
4621 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4622 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4623 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4624 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4625 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4626 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4627 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4628 EAPI void *elm_thumb_ethumb_client_get(void);
4629 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
4630 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4631 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4632 /* available styles:
4636 /* smart callbacks called:
4637 * "clicked" - This is called when a user has clicked the thumb without dragging around.
4638 * "clicked,double" - This is called when a user has double-clicked the thumb.
4639 * "press" - This is called when a user has pressed down the thumb.
4640 * "generate,start" - The thumbnail generation started.
4641 * "generate,stop" - The generation process stopped.
4642 * "generate,error" - The generation failed.
4643 * "load,error" - The thumbnail image loading failed.
4647 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4648 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4649 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4651 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4652 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4653 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4654 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4655 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4656 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4657 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4658 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4659 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4660 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4661 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4662 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);
4663 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
4664 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4665 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4666 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4667 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);
4668 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);
4669 /* smart callbacks called:
4670 * "clicked" - the user clicked the hoversel button and popped up the sel
4671 * "selected" - an item in the hoversel list is selected
4672 * "dismissed" - the hover is dismissed
4676 typedef enum _Elm_Toolbar_Shrink_Mode
4678 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
4679 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
4680 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
4681 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
4682 } Elm_Toolbar_Shrink_Mode;
4684 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
4685 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
4687 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4688 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
4689 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4690 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4691 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4692 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4693 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4694 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);
4695 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);
4696 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);
4697 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);
4698 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4699 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4700 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4701 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4702 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4703 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
4704 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4705 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4706 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4707 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
4708 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4709 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
4710 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4711 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4712 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4713 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4714 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
4715 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4716 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4717 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4718 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4719 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
4720 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4721 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
4722 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4723 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4724 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4725 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4726 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4727 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4728 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4729 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
4730 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4731 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
4732 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4733 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);
4734 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4735 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4736 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4737 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4738 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4739 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4740 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
4741 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);
4742 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4743 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
4744 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4745 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4746 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4747 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4748 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
4749 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4750 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4751 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4752 /* smart callbacks called:
4753 * "clicked" - when the user clicks on a toolbar item and becomes selected
4755 /* available styles:
4757 * transparent (no background or shadow, just show the provided content)
4761 EAPI double elm_tooltip_delay_get(void);
4762 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
4763 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
4764 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
4765 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
4766 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);
4767 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4768 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4769 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4770 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
4771 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4772 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4773 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4774 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4775 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4776 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4779 EAPI int elm_cursor_engine_only_get(void);
4780 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
4783 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
4784 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4785 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4786 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4787 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4788 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4789 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4790 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4791 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);
4792 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
4793 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4794 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
4795 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4796 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4797 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4798 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4799 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4800 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4801 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
4802 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4803 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4804 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4805 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4806 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
4807 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
4808 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4809 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4810 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
4811 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4812 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
4814 /* smart callbacks called:
4815 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
4819 typedef enum _Elm_List_Mode
4821 ELM_LIST_COMPRESS = 0,
4827 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
4828 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4829 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);
4830 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);
4831 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);
4832 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);
4833 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);
4834 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4835 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
4836 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4837 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4838 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
4839 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4840 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4841 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4842 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4843 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4844 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4845 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4846 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4847 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
4848 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4849 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4850 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4851 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4852 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4853 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4854 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4855 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4856 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4857 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
4858 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4859 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
4860 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4861 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4862 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4863 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4864 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4865 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
4866 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);
4867 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4868 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4869 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4870 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4871 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4872 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
4873 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
4874 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4875 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4876 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
4877 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4878 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
4879 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4880 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4881 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4882 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);
4883 /* smart callbacks called:
4884 * "clicked,double" - when the user double-clicked an item
4885 * "selected" - when the user selected an item
4886 * "unselected" - when the user selected an item
4887 * "longpressed" - an item in the hoversel list is long-pressed
4888 * "scroll,edge,top" - the list is scrolled until the top edge
4889 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
4890 * "scroll,edge,left" - the list is scrolled until the left edge
4891 * "scroll,edge,right" - the list is scrolled until the right edge
4894 // FIXME: incomplete - carousel. don't use this until this comment is removed
4895 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
4896 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
4897 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
4898 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
4899 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
4900 /* smart callbacks called:
4901 * "clicked" - when the user clicks on a carousel item and becomes selected
4905 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4906 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4907 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4909 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4910 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4911 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
4912 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4913 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4914 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
4915 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4916 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
4917 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4918 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
4919 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4920 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);
4921 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);
4922 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4923 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
4925 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
4926 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4927 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4928 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
4929 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4930 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
4931 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4932 /* smart callbacks called:
4933 * "changed" - Whenever the slider value is changed by the user.
4934 * "slider,drag,start" - dragging the slider indicator around has started
4935 * "slider,drag,stop" - dragging the slider indicator around has stopped
4936 * "delay,changed" - A short time after the value is changed by the user.
4937 * This will be called only when the user stops dragging for a very short
4938 * period or when they release their finger/mouse, so it avoids possibly
4939 * expensive reactions to the value change.
4946 * @addtogroup Actionslider Actionslider
4948 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
4949 * properties. The indicator is the element the user drags to choose a label.
4950 * When the position is set with magnet, when released the indicator will be
4951 * moved to it if it's nearest the magnetized position.
4953 * @note By default all positions are set as enabled.
4955 * Signals that you can add callbacks for are:
4957 * "selected" - when user selects an enabled position (the label is passed
4960 * "pos_changed" - when the indicator reaches any of the positions("left",
4961 * "right" or "center").
4963 * See an example of actionslider usage @ref actionslider_example_page "here"
4967 typedef enum _Elm_Actionslider_Indicator_Pos
4969 ELM_ACTIONSLIDER_INDICATOR_NONE,
4970 ELM_ACTIONSLIDER_INDICATOR_LEFT,
4971 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
4972 ELM_ACTIONSLIDER_INDICATOR_CENTER
4973 } Elm_Actionslider_Indicator_Pos;
4975 typedef enum _Elm_Actionslider_Magnet_Pos
4977 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
4978 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
4979 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
4980 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
4981 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
4982 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
4983 } Elm_Actionslider_Magnet_Pos;
4985 typedef enum _Elm_Actionslider_Label_Pos
4987 ELM_ACTIONSLIDER_LABEL_LEFT,
4988 ELM_ACTIONSLIDER_LABEL_RIGHT,
4989 ELM_ACTIONSLIDER_LABEL_CENTER,
4990 ELM_ACTIONSLIDER_LABEL_BUTTON
4991 } Elm_Actionslider_Label_Pos;
4993 /* smart callbacks called:
4994 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
4998 * Add a new actionslider to the parent.
5000 * @param parent The parent object
5001 * @return The new actionslider object or NULL if it cannot be created
5003 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5006 * Set actionslider label.
5008 * @param[in] obj The actionslider object
5009 * @param[in] pos The position of the label.
5010 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5011 * @param label The label which is going to be set.
5013 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5015 * Get actionslider labels.
5017 * @param obj The actionslider object
5018 * @param left_label A char** to place the left_label of @p obj into.
5019 * @param center_label A char** to place the center_label of @p obj into.
5020 * @param right_label A char** to place the right_label of @p obj into.
5022 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);
5024 * Get actionslider selected label.
5026 * @param obj The actionslider object
5027 * @return The selected label
5029 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5031 * Set actionslider indicator position.
5033 * @param obj The actionslider object.
5034 * @param pos The position of the indicator.
5036 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5038 * Get actionslider indicator position.
5040 * @param obj The actionslider object.
5041 * @return The position of the indicator.
5043 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5045 * Set actionslider magnet position. To make multiple positions magnets @c or
5046 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5048 * @param obj The actionslider object.
5049 * @param pos Bit mask indicating the magnet positions.
5051 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5053 * Get actionslider magnet position.
5055 * @param obj The actionslider object.
5056 * @return The positions with magnet property.
5058 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5060 * Set actionslider enabled position. To set multiple positions as enabled @c or
5061 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5063 * @note All the positions are enabled by default.
5065 * @param obj The actionslider object.
5066 * @param pos Bit mask indicating the enabled positions.
5068 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5070 * Get actionslider enabled position.
5072 * @param obj The actionslider object.
5073 * @return The enabled positions.
5075 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5077 * Set the label used on the indicator.
5079 * @param obj The actionslider object
5080 * @param label The label to be set on the indicator.
5081 * @deprecated use elm_object_text_set() instead.
5083 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5085 * Get the label used on the indicator object.
5087 * @param obj The actionslider object
5088 * @return The indicator label
5089 * @deprecated use elm_object_text_get() instead.
5091 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5094 * Hold actionslider object movement.
5096 * @param[in] obj The actionslider object
5097 * @param[in] flag Actionslider hold/release
5098 * (EINA_TURE = hold/EIN_FALSE = release)
5100 * @ingroup Actionslider
5102 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5110 typedef enum _Elm_Genlist_Item_Flags
5112 ELM_GENLIST_ITEM_NONE = 0,
5113 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5114 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5115 } Elm_Genlist_Item_Flags;
5116 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5117 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5118 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5119 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5120 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5121 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5122 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5123 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5125 struct _Elm_Genlist_Item_Class
5127 const char *item_style;
5129 GenlistItemLabelGetFunc label_get;
5130 GenlistItemIconGetFunc icon_get;
5131 GenlistItemStateGetFunc state_get;
5132 GenlistItemDelFunc del;
5133 GenlistItemMovedFunc moved;
5135 const char *edit_item_style;
5136 const char *mode_item_style;
5138 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5139 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5140 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5141 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5143 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5144 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5145 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5146 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5147 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5148 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5149 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5150 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5151 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5152 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5153 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5154 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5155 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5156 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5157 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5158 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5159 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5160 /* operations to add items */
5161 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);
5162 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);
5163 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);
5164 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);
5165 /* operations to retrieve existing items */
5166 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5167 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5168 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5169 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);
5170 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5171 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5172 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5173 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);
5174 /* available item styles:
5176 * default_style - The text part is a textblock
5178 * icon_top_text_bottom
5180 /* Genlist Item operation */
5181 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5182 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5183 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5184 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5185 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5186 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5187 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5188 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5189 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5190 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5191 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5192 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5193 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5194 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5195 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5196 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5197 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5198 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5199 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5200 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5201 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5202 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5203 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5204 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5205 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5206 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5207 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5208 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5209 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);
5210 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5211 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5212 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5213 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5214 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5215 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5216 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5217 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5218 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5219 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5220 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5221 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5222 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5223 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5225 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5226 /* Signals that you can add callbacks for are:
5227 * "clicked,double" - This is called when a user has double-clicked an item.
5228 * The event_info parameter is the genlist item that was
5230 * "selected" - This is called when a user has made an item selected. The
5231 * event_info parameter is the genlist item that was selected.
5232 * "unselected" - This is called when a user has made an item unselected. The
5233 * event_info parameter is the genlist item that was unselected.
5234 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5235 * and the item is now meant to be expanded. The event_info parameter is the
5236 * genlist item that was indicated to expand. It is the job of this callback
5237 * to then fill in the child items.
5238 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5239 * and the item is now meant to be contracted. The event_info parameter is
5240 * the genlist item that was indicated to contract. It is the job of this
5241 * callback to then delete the child items.
5242 * "expand,request" - This is called when a user has indicated they want to
5243 * expand a tree branch item. The callback should decide if the item can
5244 * expand (has any children) and then call elm_genlist_item_expanded_set()
5245 * appropriately to set the state. The event_info parameter is the genlist
5246 * item that was indicated to expand.
5247 * "contract,request" - This is called when a user has indicated they want to
5248 * contract a tree branch item. The callback should decide if the item can
5249 * contract (has any children) and then call elm_genlist_item_expanded_set()
5250 * appropriately to set the state. The event_info parameter is the genlist
5251 * item that was indicated to contract.
5252 * "realized" - This is called when the item in the list is created as a real
5253 * evas object. event_info parameter is the genlist item that was created.
5254 * The object may be deleted at any time, so it is up to the caller to
5255 * not use the object pointer from elm_genlist_item_object_get() in a way
5256 * where it may point to freed objects.
5257 * "unrealized" - This is called just before an item is unrealized. After
5258 * this call icon objects provided will be deleted and the item object
5259 * itself delete or be put into a floating cache.
5260 * "drag,start,up" - This is called when the item in the list has been dragged
5261 * (not scrolled) up.
5262 * "drag,start,down" - This is called when the item in the list has been dragged
5263 * (not scrolled) down.
5264 * "drag,start,left" - This is called when the item in the list has been dragged i
5265 * (not scrolled) left.
5266 * "drag,start,right" - This is called when the item in the list has been dragged
5267 * (not scrolled) right.
5268 * "drag,stop" - This is called when the item in the list has stopped being
5270 * "drag" - This is called when the item in the list is being dragged.
5271 * "longpressed" - This is called when the item is pressed for a certain amount
5272 * of time. By default it's 1 second.
5273 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5275 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5277 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5279 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5281 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5283 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5285 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5286 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5288 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5290 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5293 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5294 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5295 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5296 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5297 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5298 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5299 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5300 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5301 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5302 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5305 * @page tutorial_check Check example
5306 * @dontinclude check_example_01.c
5308 * This example will show 2 checkboxes, one with just a label and the second
5309 * one with both a label and an icon. This example also ilustrates how to
5310 * have the checkbox change the value of a variable and how to react to those
5313 * We will start with the usual setup code:
5316 * And now we create our first checkbox, set its label, tell it to change
5317 * the value of @p value when the checkbox stats is changed and ask to be
5318 * notified of state changes:
5321 * For our second checkbox we are going to set an icon so we need to create
5324 * @note For simplicity we are using a rectangle as icon, but any evas object
5327 * And for our second checkbox we set the label, icon and state to true:
5330 * We now do some more setup:
5333 * And finally implement the callback that will be called when the first
5334 * checkbox's state changes. This callback will use @p data to print a
5337 * @note This work because @p data is @p value(from the main function) and @p
5338 * value is changed when the checkbox is changed.
5340 * Our example will look like this:
5341 * @image html screenshots/check_example_01.png
5342 * @image latex screenshots/check_example_01.eps
5344 * @example check_example_01.c
5347 * @defgroup Check Check
5349 * @brief The check widget allows for toggling a value between true and
5352 * Check objects are a lot like radio objects in layout and functionality
5353 * except they do not work as a group, but independently and only toggle the
5354 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5355 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5356 * returns the current state. For convenience, like the radio objects, you
5357 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5360 * Signals that you can add callbacks for are:
5361 * "changed" - This is called whenever the user changes the state of one of
5362 * the check object(event_info is NULL).
5364 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5368 * @brief Add a new Check object
5370 * @param parent The parent object
5371 * @return The new object or NULL if it cannot be created
5373 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5375 * @brief Set the text label of the check object
5377 * @param obj The check object
5378 * @param label The text label string in UTF-8
5380 * @deprecated use elm_object_text_set() instead.
5382 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5384 * @brief Get the text label of the check object
5386 * @param obj The check object
5387 * @return The text label string in UTF-8
5389 * @deprecated use elm_object_text_get() instead.
5391 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5393 * @brief Set the icon object of the check object
5395 * @param obj The check object
5396 * @param icon The icon object
5398 * Once the icon object is set, a previously set one will be deleted.
5399 * If you want to keep that old content object, use the
5400 * elm_check_icon_unset() function.
5402 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5404 * @brief Get the icon object of the check object
5406 * @param obj The check object
5407 * @return The icon object
5409 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5411 * @brief Unset the icon used for the check object
5413 * @param obj The check object
5414 * @return The icon object that was being used
5416 * Unparent and return the icon object which was set for this widget.
5418 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5420 * @brief Set the on/off state of the check object
5422 * @param obj The check object
5423 * @param state The state to use (1 == on, 0 == off)
5425 * This sets the state of the check. If set
5426 * with elm_check_state_pointer_set() the state of that variable is also
5427 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5429 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5431 * @brief Get the state of the check object
5433 * @param obj The check object
5434 * @return The boolean state
5436 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5438 * @brief Set a convenience pointer to a boolean to change
5440 * @param obj The check object
5441 * @param statep Pointer to the boolean to modify
5443 * This sets a pointer to a boolean, that, in addition to the check objects
5444 * state will also be modified directly. To stop setting the object pointed
5445 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5446 * then when this is called, the check objects state will also be modified to
5447 * reflect the value of the boolean @p statep points to, just like calling
5448 * elm_check_state_set().
5450 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5456 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5457 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5458 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5459 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5460 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5461 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5462 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5463 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5464 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5465 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5466 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5467 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5468 /* smart callbacks called:
5469 * "changed" - when the radio status is changed
5472 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
5473 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
5474 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
5475 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
5478 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5479 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5480 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5482 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5483 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5484 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5485 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5487 /* available item styles:
5493 /* smart callbacks called:
5494 * "hide,finished" - when the previous page is hided
5497 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5498 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5499 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5500 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5501 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5503 struct _Elm_Slideshow_Item_Class
5505 struct _Elm_Slideshow_Item_Class_Func
5507 SlideshowItemGetFunc get;
5508 SlideshowItemDelFunc del;
5512 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5513 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5514 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);
5515 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5516 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5517 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5518 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5519 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5520 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5522 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5523 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5524 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5525 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5526 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5527 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5528 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5529 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5530 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5531 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5532 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5533 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5534 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5535 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5536 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5537 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5538 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5539 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5540 /* smart callbacks called:
5541 * "changed" - when the slideshow switch to another item
5545 typedef enum _Elm_Fileselector_Mode
5547 ELM_FILESELECTOR_LIST = 0,
5548 ELM_FILESELECTOR_GRID,
5549 ELM_FILESELECTOR_LAST
5550 } Elm_Fileselector_Mode;
5552 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5553 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5554 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5555 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5556 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5557 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5558 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5559 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5560 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5561 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5562 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5563 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5564 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5565 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5566 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5567 /* smart callbacks called:
5568 * "selected" - the user click on a file
5569 * "directory,open" - the list is populate with a new content. event_info is a directory.
5570 * "done" - the user click on the ok or cancel buttons
5574 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5575 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5576 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5577 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5578 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5579 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5580 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5581 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5582 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5583 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5585 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5586 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5587 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5588 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5589 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5590 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5591 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5592 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5593 /* smart callbacks called:
5595 /* available item styles:
5597 * wheel (simple style, no text, no progression, only pulse is available)
5601 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5602 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5603 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5604 /* smart callbacks called:
5608 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5609 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5610 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5611 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5612 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5613 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5614 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5615 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5616 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5617 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5618 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5619 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5620 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5621 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5622 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5623 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5624 /* smart callbacks called:
5625 * "changed" - when the spinner value changes
5626 * "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).
5628 /* available item styles:
5630 * vertical (two up/down buttons at the right side and text left aligned)
5634 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5636 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5637 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5638 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5640 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5641 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5642 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5643 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5644 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5645 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5646 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);
5647 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5648 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5649 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5650 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5651 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5652 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
5653 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5654 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5655 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
5656 /* smart callbacks called:
5657 * "changed" - when the selected index item changes
5658 * "delay,changed" - when the selected index item changes, but after some small idle period
5659 * "selected" - when the user releases a finger and selects an item
5660 * "level,up" - when the user moves a finger from the first level to the second level
5661 * "level,down" - when the user moves a finger from the second level to the first level
5665 typedef enum _Elm_Photocam_Zoom_Mode
5667 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
5668 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
5669 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
5670 ELM_PHOTOCAM_ZOOM_MODE_LAST
5671 } Elm_Photocam_Zoom_Mode;
5673 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5674 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5675 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5676 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
5677 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5678 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5679 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5680 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5681 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5682 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5683 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5684 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5685 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5686 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5687 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5688 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5689 /* smart callbacks called:
5690 * "clicked" - when image clicked
5691 * "press" - when mouse/finger held down initially on image
5692 * "longpressed" - when mouse/finger held for long time on image
5693 * "clicked,double" - when mouse/finger double-clicked
5694 * "load" - when photo load begins
5695 * "loaded" - when photo load done
5696 * "load,detail" - when detailed image load begins
5697 * "loaded,detail" - when detailed image load done
5698 * "zoom,start" - when zooming started
5699 * "zoom,stop" - when zooming stopped
5700 * "zoom,change" - when auto zoom mode changed zoom level
5701 * "scroll - the content has been scrolled (moved)
5702 * "scroll,anim,start" - scrolling animation has started
5703 * "scroll,anim,stop" - scrolling animation has stopped
5704 * "scroll,drag,start" - dragging the contents around has started
5705 * "scroll,drag,stop" - dragging the contents around has stopped
5709 typedef enum _Elm_Map_Zoom_Mode
5711 ELM_MAP_ZOOM_MODE_MANUAL,
5712 ELM_MAP_ZOOM_MODE_AUTO_FIT,
5713 ELM_MAP_ZOOM_MODE_AUTO_FILL,
5714 ELM_MAP_ZOOM_MODE_LAST
5715 } Elm_Map_Zoom_Mode;
5717 typedef enum _Elm_Map_Route_Sources
5719 ELM_MAP_ROUTE_SOURCE_YOURS,
5720 ELM_MAP_ROUTE_SOURCE_MONAV,
5721 ELM_MAP_ROUTE_SOURCE_ORS,
5722 ELM_MAP_ROUTE_SOURCE_LAST
5723 } Elm_Map_Route_Sources;
5725 typedef enum _Elm_Map_Name_Sources
5727 ELM_MAP_NAME_SOURCE_NOMINATIM,
5728 ELM_MAP_NAME_SOURCE_LAST
5729 } Elm_Map_Name_Sources;
5731 typedef enum _Elm_Map_Route_Type
5733 ELM_MAP_ROUTE_TYPE_MOTOCAR,
5734 ELM_MAP_ROUTE_TYPE_BICYCLE,
5735 ELM_MAP_ROUTE_TYPE_FOOT,
5736 ELM_MAP_ROUTE_TYPE_LAST
5737 } Elm_Map_Route_Type;
5739 typedef enum _Elm_Map_Route_Method
5741 ELM_MAP_ROUTE_METHOD_FASTEST,
5742 ELM_MAP_ROUTE_METHOD_SHORTEST,
5743 ELM_MAP_ROUTE_METHOD_LAST
5744 } Elm_Map_Route_Method;
5746 typedef enum _Elm_Map_Name_Method
5748 ELM_MAP_NAME_METHOD_SEARCH,
5749 ELM_MAP_NAME_METHOD_REVERSE,
5750 ELM_MAP_NAME_METHOD_LAST
5751 } Elm_Map_Name_Method;
5753 typedef struct _Elm_Map_Marker Elm_Map_Marker;
5754 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
5755 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
5756 typedef struct _Elm_Map_Route Elm_Map_Route;
5757 typedef struct _Elm_Map_Name Elm_Map_Name;
5758 typedef struct _Elm_Map_Track Elm_Map_Track;
5760 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
5761 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
5762 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
5763 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
5765 typedef char *(*ElmMapModuleSourceFunc) (void);
5766 typedef int (*ElmMapModuleZoomMinFunc) (void);
5767 typedef int (*ElmMapModuleZoomMaxFunc) (void);
5768 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
5769 typedef int (*ElmMapModuleRouteSourceFunc) (void);
5770 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
5771 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
5772 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
5773 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
5775 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5776 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5777 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5778 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5779 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5780 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
5781 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5782 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5783 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5784 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5785 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5786 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5787 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
5788 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);
5789 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);
5790 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
5791 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
5792 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);
5793 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);
5794 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
5795 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5796 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
5797 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5798 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5799 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
5800 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5801 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
5802 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5803 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
5804 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
5805 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
5806 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
5807 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
5808 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
5809 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
5810 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
5811 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
5812 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
5813 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
5814 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
5815 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5816 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
5817 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5818 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
5819 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5820 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5821 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5822 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
5823 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5824 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
5825 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5826 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);
5827 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5828 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
5829 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
5830 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5831 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5832 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
5833 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
5834 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
5835 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
5836 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
5837 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);
5838 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5839 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5841 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
5843 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
5845 /* smart callbacks called:
5846 * "clicked" - when image clicked
5847 * "press" - when mouse/finger held down initially on image
5848 * "longpressed" - when mouse/finger held for long time on image
5849 * "clicked,double" - when mouse/finger double-clicked
5850 * "load,details" - when detailed image load begins
5851 * "loaded,details" - when detailed image load done
5852 * "zoom,start" - when zooming started
5853 * "zoom,stop" - when zooming stopped
5854 * "zoom,change" - when auto zoom mode changed zoom level
5855 * "scroll - the content has been scrolled (moved)
5856 * "scroll,anim,start" - scrolling animation has started
5857 * "scroll,anim,stop" - scrolling animation has stopped
5858 * "scroll,drag,start" - dragging the contents around has started
5859 * "scroll,drag,stop" - dragging the contents around has stopped
5863 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
5865 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
5867 EAPI double elm_route_lon_min_get(Evas_Object *obj);
5868 EAPI double elm_route_lat_min_get(Evas_Object *obj);
5869 EAPI double elm_route_lon_max_get(Evas_Object *obj);
5870 EAPI double elm_route_lat_max_get(Evas_Object *obj);
5874 typedef enum _Elm_Panel_Orient
5876 ELM_PANEL_ORIENT_TOP,
5877 ELM_PANEL_ORIENT_BOTTOM,
5878 ELM_PANEL_ORIENT_LEFT,
5879 ELM_PANEL_ORIENT_RIGHT,
5882 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5883 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
5884 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5885 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5886 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5887 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5888 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
5889 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5890 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
5896 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
5897 * Add events (move, start ...)
5899 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5900 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5901 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5902 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5903 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5904 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5905 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5906 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5907 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
5908 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5909 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5910 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
5911 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5914 typedef enum _Elm_Flip_Mode
5916 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
5917 ELM_FLIP_ROTATE_X_CENTER_AXIS,
5918 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
5919 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
5921 ELM_FLIP_CUBE_RIGHT,
5925 ELM_FLIP_PAGE_RIGHT,
5929 typedef enum _Elm_Flip_Interaction
5931 ELM_FLIP_INTERACTION_NONE,
5932 ELM_FLIP_INTERACTION_ROTATE,
5933 ELM_FLIP_INTERACTION_CUBE,
5934 ELM_FLIP_INTERACTION_PAGE
5935 } Elm_Flip_Interaction;
5936 typedef enum _Elm_Flip_Direction
5938 ELM_FLIP_DIRECTION_UP,
5939 ELM_FLIP_DIRECTION_DOWN,
5940 ELM_FLIP_DIRECTION_LEFT,
5941 ELM_FLIP_DIRECTION_RIGHT
5942 } Elm_Flip_Direction;
5944 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5945 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5946 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5947 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5948 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5949 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5950 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5951 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5952 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5953 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
5954 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
5955 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
5956 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
5957 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
5958 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
5959 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
5960 /* smart callbacks called:
5961 * "animate,begin" - when a flip animation was started
5962 * "animate,done" - when a flip animation is finished
5966 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5967 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
5968 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
5970 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5971 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5972 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5973 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5974 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5975 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5976 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5977 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5978 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5979 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5980 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
5981 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5982 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5983 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
5984 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
5985 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
5986 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5987 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5988 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5989 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5990 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5991 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5992 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5993 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5994 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5996 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5997 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
5998 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
5999 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6000 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6001 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);
6002 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6003 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6004 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);
6005 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6006 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);
6007 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6008 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6009 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6010 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6011 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6012 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6013 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6014 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6015 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);
6016 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);
6017 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);
6018 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);
6019 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);
6020 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);
6021 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6022 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6023 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6024 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6025 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6026 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6027 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6028 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6029 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6030 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6031 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6032 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6033 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6036 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6037 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6038 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6039 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6040 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6043 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6044 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6045 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6046 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6047 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6048 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6050 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6051 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6052 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6055 * @defgroup Flipselector Flip Selector
6057 * A flip selector is a widget to show a set of @b text items, one
6058 * at a time, with the same sheet switching style as the @ref Clock
6059 * "clock" widget, when one changes the current displaying sheet
6060 * (thus, the "flip" in the name).
6062 * User clicks to flip sheets which are @b held for some time will
6063 * make the flip selector to flip continuosly and automatically for
6064 * the user. The interval between flips will keep growing in time,
6065 * so that it helps the user to reach an item which is distant from
6066 * the current selection.
6068 * Smart callbacks one can register to:
6069 * - @c "selected" - when the widget's selected text item is changed
6070 * - @c "overflowed" - when the widget's current selection is changed
6071 * from the first item in its list to the last
6072 * - @c "underflowed" - when the widget's current selection is changed
6073 * from the last item in its list to the first
6075 * Available styles for it:
6078 * Here is an example on its usage:
6079 * @li @ref flipselector_example
6083 * @addtogroup Flipselector
6087 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6090 * Add a new flip selector widget to the given parent Elementary
6091 * (container) widget
6093 * @param parent The parent object
6094 * @return a new flip selector widget handle or @c NULL, on errors
6096 * This function inserts a new flip selector widget on the canvas.
6098 * @ingroup Flipselector
6100 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6103 * Programmatically select the next item of a flip selector widget
6105 * @param obj The flipselector object
6107 * @note The selection will be animated. Also, if it reaches the
6108 * end of its list of member items, it will continue with the first
6111 * @ingroup Flipselector
6113 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6116 * Programmatically select the previous item of a flip selector
6119 * @param obj The flipselector object
6121 * @note The selection will be animated. Also, if it reaches the
6122 * beginning of its list of member items, it will continue with the
6123 * last one backwards.
6125 * @ingroup Flipselector
6127 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6130 * Append a (text) item to a flip selector widget
6132 * @param obj The flipselector object
6133 * @param label The (text) label of the new item
6134 * @param func Convenience callback function to take place when
6136 * @param data Data passed to @p func, above
6137 * @return A handle to the item added or @c NULL, on errors
6139 * The widget's list of labels to show will be appended with the
6140 * given value. If the user wishes so, a callback function pointer
6141 * can be passed, which will get called when this same item is
6144 * @note The current selection @b won't be modified by appending an
6145 * element to the list.
6147 * @note The maximum length of the text label is going to be
6148 * determined <b>by the widget's theme</b>. Strings larger than
6149 * that value are going to be @b truncated.
6151 * @ingroup Flipselector
6153 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6156 * Prepend a (text) item to a flip selector widget
6158 * @param obj The flipselector object
6159 * @param label The (text) label of the new item
6160 * @param func Convenience callback function to take place when
6162 * @param data Data passed to @p func, above
6163 * @return A handle to the item added or @c NULL, on errors
6165 * The widget's list of labels to show will be prepended with the
6166 * given value. If the user wishes so, a callback function pointer
6167 * can be passed, which will get called when this same item is
6170 * @note The current selection @b won't be modified by prepending
6171 * an element to the list.
6173 * @note The maximum length of the text label is going to be
6174 * determined <b>by the widget's theme</b>. Strings larger than
6175 * that value are going to be @b truncated.
6177 * @ingroup Flipselector
6179 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6182 * Get the internal list of items in a given flip selector widget.
6184 * @param obj The flipselector object
6185 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6188 * This list is @b not to be modified in any way and must not be
6189 * freed. Use the list members with functions like
6190 * elm_flipselector_item_label_set(),
6191 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6192 * elm_flipselector_item_del(),
6193 * elm_flipselector_item_selected_get(),
6194 * elm_flipselector_item_selected_set().
6196 * @warning This list is only valid until @p obj object's internal
6197 * items list is changed. It should be fetched again with another
6198 * call to this function when changes happen.
6200 * @ingroup Flipselector
6202 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6205 * Get the first item in the given flip selector widget's list of
6208 * @param obj The flipselector object
6209 * @return The first item or @c NULL, if it has no items (and on
6212 * @see elm_flipselector_item_append()
6213 * @see elm_flipselector_last_item_get()
6215 * @ingroup Flipselector
6217 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6220 * Get the last item in the given flip selector widget's list of
6223 * @param obj The flipselector object
6224 * @return The last item or @c NULL, if it has no items (and on
6227 * @see elm_flipselector_item_prepend()
6228 * @see elm_flipselector_first_item_get()
6230 * @ingroup Flipselector
6232 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6235 * Get the currently selected item in a flip selector widget.
6237 * @param obj The flipselector object
6238 * @return The selected item or @c NULL, if the widget has no items
6241 * @ingroup Flipselector
6243 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6246 * Set whether a given flip selector widget's item should be the
6247 * currently selected one.
6249 * @param item The flip selector item
6250 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6252 * This sets whether @p item is or not the selected (thus, under
6253 * display) one. If @p item is different than one under display,
6254 * the latter will be unselected. If the @p item is set to be
6255 * unselected, on the other hand, the @b first item in the widget's
6256 * internal members list will be the new selected one.
6258 * @see elm_flipselector_item_selected_get()
6260 * @ingroup Flipselector
6262 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6265 * Get whether a given flip selector widget's item is the currently
6268 * @param item The flip selector item
6269 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6272 * @see elm_flipselector_item_selected_set()
6274 * @ingroup Flipselector
6276 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6279 * Delete a given item from a flip selector widget.
6281 * @param item The item to delete
6283 * @ingroup Flipselector
6285 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6288 * Get the label of a given flip selector widget's item.
6290 * @param item The item to get label from
6291 * @return The text label of @p item or @c NULL, on errors
6293 * @see elm_flipselector_item_label_set()
6295 * @ingroup Flipselector
6297 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6300 * Set the label of a given flip selector widget's item.
6302 * @param item The item to set label on
6303 * @param label The text label string, in UTF-8 encoding
6305 * @see elm_flipselector_item_label_get()
6307 * @ingroup Flipselector
6309 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6312 * Gets the item before @p item in a flip selector widget's
6313 * internal list of items.
6315 * @param item The item to fetch previous from
6316 * @return The item before the @p item, in its parent's list. If
6317 * there is no previous item for @p item or there's an
6318 * error, @c NULL is returned.
6320 * @see elm_flipselector_item_next_get()
6322 * @ingroup Flipselector
6324 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6327 * Gets the item after @p item in a flip selector widget's
6328 * internal list of items.
6330 * @param item The item to fetch next from
6331 * @return The item after the @p item, in its parent's list. If
6332 * there is no next item for @p item or there's an
6333 * error, @c NULL is returned.
6335 * @see elm_flipselector_item_next_get()
6337 * @ingroup Flipselector
6339 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6342 * Set the interval on time updates for an user mouse button hold
6343 * on a flip selector widget.
6345 * @param obj The flip selector object
6346 * @param interval The (first) interval value in seconds
6348 * This interval value is @b decreased while the user holds the
6349 * mouse pointer either flipping up or flipping doww a given flip
6352 * This helps the user to get to a given item distant from the
6353 * current one easier/faster, as it will start to flip quicker and
6354 * quicker on mouse button holds.
6356 * The calculation for the next flip interval value, starting from
6357 * the one set with this call, is the previous interval divided by
6358 * 1.05, so it decreases a little bit.
6360 * The default starting interval value for automatic flips is
6363 * @see elm_flipselector_interval_get()
6365 * @ingroup Flipselector
6367 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6370 * Get the interval on time updates for an user mouse button hold
6371 * on a flip selector widget.
6373 * @param obj The flip selector object
6374 * @return The (first) interval value, in seconds, set on it
6376 * @see elm_flipselector_interval_set() for more details
6378 * @ingroup Flipselector
6380 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6387 * @addtogroup Animator Animator
6388 * @ingroup Elementary
6390 * @brief Functions to ease creation of animations.
6392 * elm_animator is designed to provide an easy way to create animations.
6393 * Creating an animation with elm_animator is as simple as setting a
6394 * duration, an operating callback and telling it to run the animation.
6395 * However that is not the full extent of elm_animator's ability, animations
6396 * can be paused and resumed, reversed and the animation need not be linear.
6398 * To run an animation you must specify at least a duration and operation
6399 * callback, not setting any other properties will create a linear animation
6400 * that runs once and is not reversed.
6402 * @ref elm_animator_example_page_01 "This" example should make all of that
6405 * @warning elm_animator is @b not a widget.
6409 * @brief Type of curve desired for animation.
6411 * The speed in which an animation happens doesn't have to be linear, some
6412 * animations will look better if they're accelerating or decelerating, so
6413 * elm_animator provides four options in this regard:
6414 * @image html elm_animator_curve_style.png
6415 * @image latex elm_animator_curve_style.eps width=\textwidth
6416 * As can be seen in the image the speed of the animation will be:
6417 * @li ELM_ANIMATOR_CURVE_LINEAR constant
6418 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6419 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6420 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6424 ELM_ANIMATOR_CURVE_LINEAR,
6425 ELM_ANIMATOR_CURVE_IN_OUT,
6426 ELM_ANIMATOR_CURVE_IN,
6427 ELM_ANIMATOR_CURVE_OUT
6428 } Elm_Animator_Curve_Style;
6429 typedef struct _Elm_Animator Elm_Animator;
6431 * Called back per loop of an elementary animators cycle
6432 * @param data user-data given to elm_animator_operation_callback_set()
6433 * @param animator the animator being run
6434 * @param double the position in the animation
6436 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6438 * Called back when an elementary animator finishes
6439 * @param data user-data given to elm_animator_completion_callback_set()
6441 typedef void (*Elm_Animator_Completion_Cb) (void *data);
6444 * @brief Create a new animator.
6446 * @param[in] parent Parent object
6448 * The @a parent argument can be set to NULL for no parent. If a parent is set
6449 * there is no need to call elm_animator_del(), when the parent is deleted it
6450 * will delete the animator.
6451 * @deprecated Use @ref Transit instead.
6454 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
6456 * Deletes the animator freeing any resources it used. If the animator was
6457 * created with a NULL parent this must be called, otherwise it will be
6458 * automatically called when the parent is deleted.
6460 * @param[in] animator Animator object
6461 * @deprecated Use @ref Transit instead.
6463 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6465 * Set the duration of the animation.
6467 * @param[in] animator Animator object
6468 * @param[in] duration Duration in second
6469 * @deprecated Use @ref Transit instead.
6471 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6473 * @brief Set the callback function for animator operation.
6475 * @param[in] animator Animator object
6476 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6477 * @param[in] data Callback function user argument
6479 * The @p func callback will be called with a frame value in range [0, 1] which
6480 * indicates how far along the animation should be. It is the job of @p func to
6481 * actually change the state of any object(or objects) that are being animated.
6482 * @deprecated Use @ref Transit instead.
6484 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6486 * Set the callback function for the when the animation ends.
6488 * @param[in] animator Animator object
6489 * @param[in] func Callback function pointe
6490 * @param[in] data Callback function user argument
6492 * @warning @a func will not be executed if elm_animator_stop() is called.
6493 * @deprecated Use @ref Transit instead.
6495 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6497 * @brief Stop animator.
6499 * @param[in] animator Animator object
6501 * If called before elm_animator_animate() it does nothing. If there is an
6502 * animation in progress the animation will be stopped(the operation callback
6503 * will not be executed again) and it can't be restarted using
6504 * elm_animator_resume().
6505 * @deprecated Use @ref Transit instead.
6507 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6509 * Set the animator repeat count.
6511 * @param[in] animator Animator object
6512 * @param[in] repeat_cnt Repeat count
6513 * @deprecated Use @ref Transit instead.
6515 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6517 * @brief Start animation.
6519 * @param[in] animator Animator object
6521 * This function starts the animation if the nescessary properties(duration
6522 * and operation callback) have been set. Once started the animation will
6523 * run until complete or elm_animator_stop() is called.
6524 * @deprecated Use @ref Transit instead.
6526 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6528 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6530 * @param[in] animator Animator object
6531 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6532 * @deprecated Use @ref Transit instead.
6534 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6536 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6538 * @param[in] animator Animator object
6539 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6540 * @deprecated Use @ref Transit instead.
6542 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6544 * @brief Sets wether the animation should be automatically reversed.
6546 * @param[in] animator Animator object
6547 * @param[in] reverse Reverse or not
6549 * This controls wether the animation will be run on reverse imediately after
6550 * running forward. When this is set together with repetition the animation
6551 * will run in reverse once for each time it ran forward.@n
6552 * Runnin an animation in reverse is accomplished by calling the operation
6553 * callback with a frame value starting at 1 and diminshing until 0.
6554 * @deprecated Use @ref Transit instead.
6556 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6558 * Gets wether the animation will automatically reversed
6560 * @param[in] animator Animator object
6561 * @deprecated Use @ref Transit instead.
6563 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6565 * Gets the status for the animator operation. The status of the animator @b
6566 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6567 * only informs if the animation was started and has not ended(either normally
6568 * or through elm_animator_stop()).
6570 * @param[in] animator Animator object
6571 * @deprecated Use @ref Transit instead.
6573 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6575 * Gets how many times the animation will be repeated
6577 * @param[in] animator Animator object
6578 * @deprecated Use @ref Transit instead.
6580 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6582 * Pause the animator.
6584 * @param[in] animator Animator object
6586 * This causes the animation to be temporarily stopped(the operation callback
6587 * will not be called). If the animation is not yet running this is a no-op.
6588 * Once an animation has been paused with this function it can be resumed
6589 * using elm_animator_resume().
6590 * @deprecated Use @ref Transit instead.
6592 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6594 * @brief Resumes the animator.
6596 * @param[in] animator Animator object
6598 * Resumes an animation that was paused using elm_animator_pause(), after
6599 * calling this function calls to the operation callback will happen
6600 * normally. If an animation is stopped by means of elm_animator_stop it
6601 * @b can't be restarted with this function.@n
6603 * @warning When an animation is resumed it doesn't start from where it was paused, it
6604 * will go to where it would have been if it had not been paused. If an
6605 * animation with a duration of 3 seconds is paused after 1 second for 1 second
6606 * it will resume as if it had ben animating for 2 seconds, the operating
6607 * callback will be called with a frame value of aproximately 2/3.
6608 * @deprecated Use @ref Transit instead.
6610 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6618 ELM_CALENDAR_UNIQUE,
6620 ELM_CALENDAR_WEEKLY,
6621 ELM_CALENDAR_MONTHLY,
6622 ELM_CALENDAR_ANNUALLY
6623 } Elm_Calendar_Mark_Repeat;
6624 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6626 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6627 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6629 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6630 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6631 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6632 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6633 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6634 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6635 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6636 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6637 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6638 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);
6639 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6640 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6641 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6642 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
6643 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6644 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6645 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6646 /* smart callbacks called:
6647 * changed - emitted when the user select a day or change the displayed
6652 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
6654 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6655 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6656 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
6657 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6658 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6659 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6660 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6661 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6662 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6663 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);
6664 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6665 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6666 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6667 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);
6668 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6669 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6670 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6671 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6672 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6673 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6674 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6675 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6676 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6677 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6678 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6679 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6680 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6681 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6682 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
6683 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);
6684 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6685 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6686 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6687 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6688 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6689 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6690 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6691 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6692 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6693 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6694 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
6695 /* smart callbacks called:
6696 * "selected" - when item is selected (scroller stops)
6700 * @page tutorial_colorselector Color selector example
6701 * @dontinclude colorselector_example_01.c
6703 * This example shows how to change the color of a rectangle using a color
6704 * selector. We aren't going to explain a lot of the code since it's the
6708 * Now that we have a window with background and a rectangle we can create
6709 * our color_selector and set it's initial color to fully opaque blue:
6712 * Next we tell ask to be notified whenever the color changes:
6715 * We follow that we some more run of the mill setup code:
6718 * And now get to the callback that sets the color of the rectangle:
6721 * This example will look like this:
6722 * @image html screenshots/colorselector_example_01.png
6723 * @image latex screenshots/colorselector_example_01.eps
6725 * @example colorselector_example_01.c
6728 * @defgroup Colorselector Colorselector
6732 * @brief Widget for user to select a color.
6734 * Signals that you can add callbacks for are:
6735 * "changed" - When the color value changes(event_info is NULL).
6737 * See @ref tutorial_colorselector.
6740 * @brief Add a new colorselector to the parent
6742 * @param parent The parent object
6743 * @return The new object or NULL if it cannot be created
6745 * @ingroup Colorselector
6747 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6749 * Set a color for the colorselector
6751 * @param obj Colorselector object
6752 * @param r r-value of color
6753 * @param g g-value of color
6754 * @param b b-value of color
6755 * @param a a-value of color
6757 * @ingroup Colorselector
6759 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6761 * Get a color from the colorselector
6763 * @param obj Colorselector object
6764 * @param r integer pointer for r-value of color
6765 * @param g integer pointer for g-value of color
6766 * @param b integer pointer for b-value of color
6767 * @param a integer pointer for a-value of color
6769 * @ingroup Colorselector
6771 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6776 /* Contextual Popup */
6777 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
6779 typedef enum _Elm_Ctxpopup_Direction
6781 ELM_CTXPOPUP_DIRECTION_DOWN,
6782 ELM_CTXPOPUP_DIRECTION_RIGHT,
6783 ELM_CTXPOPUP_DIRECTION_LEFT,
6784 ELM_CTXPOPUP_DIRECTION_UP,
6785 } Elm_Ctxpopup_Direction;
6787 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6788 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6789 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6790 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6791 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
6792 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
6793 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6794 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6795 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6796 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6797 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);
6798 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6799 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6800 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
6801 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
6802 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6803 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);
6804 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);
6805 /* smart callbacks called:
6806 * "dismissed" - the ctxpopup was dismissed
6810 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
6812 struct _Colorpalette_Color
6814 unsigned int r, g, b;
6817 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
6818 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
6819 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
6820 /* smart callbacks called:
6821 * "clicked" - when image clicked
6825 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
6826 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
6827 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
6828 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
6829 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
6830 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
6831 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
6832 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
6833 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
6834 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
6835 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
6836 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
6837 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
6838 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
6839 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
6840 /* smart callbacks called:
6841 * "clicked" - when an editfield is clicked
6842 * "unfocused" - when an editfield is unfocused
6846 /* Sliding Drawer */
6847 typedef enum _Elm_SlidingDrawer_Pos
6849 ELM_SLIDINGDRAWER_BOTTOM,
6850 ELM_SLIDINGDRAWER_LEFT,
6851 ELM_SLIDINGDRAWER_RIGHT,
6852 ELM_SLIDINGDRAWER_TOP
6853 } Elm_SlidingDrawer_Pos;
6855 typedef struct _Elm_SlidingDrawer_Drag_Value
6858 } Elm_SlidingDrawer_Drag_Value;
6860 EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
6861 EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
6862 EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
6863 EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
6864 EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
6865 EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
6867 /* multibuttonentry */
6868 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
6869 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
6870 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
6871 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
6872 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
6873 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
6874 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
6875 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
6876 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
6877 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
6878 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
6879 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
6880 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
6881 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
6882 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
6883 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
6884 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
6885 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
6886 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
6887 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
6888 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
6889 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
6890 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
6891 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
6892 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
6893 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
6894 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
6895 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
6896 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
6897 /* smart callback called:
6898 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
6899 * "added" - This signal is emitted when a new multibuttonentry item is added.
6900 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
6901 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
6902 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
6903 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
6904 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
6905 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
6906 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
6907 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
6908 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
6909 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
6911 /* available styles:
6916 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
6917 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
6918 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
6919 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
6920 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
6921 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
6922 /* smart callback called:
6923 * "expanded" - This signal is emitted when a stackedicon is expanded.
6924 * "clicked" - This signal is emitted when a stackedicon is clicked.
6926 /* available styles:
6931 typedef struct _Dialogue_Item Dialogue_Item;
6933 typedef enum _Elm_Dialoguegourp_Item_Style
6935 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
6936 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
6937 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
6938 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
6939 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
6940 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
6941 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
6942 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
6943 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
6944 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
6945 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
6946 } Elm_Dialoguegroup_Item_Style;
6948 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
6949 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
6950 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
6951 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
6952 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
6953 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
6954 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
6955 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
6956 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
6957 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
6958 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
6959 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
6960 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
6961 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
6962 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
6963 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
6968 ELM_DAYSELECTOR_SUN,
6969 ELM_DAYSELECTOR_MON,
6970 ELM_DAYSELECTOR_TUE,
6971 ELM_DAYSELECTOR_WED,
6972 ELM_DAYSELECTOR_THU,
6973 ELM_DAYSELECTOR_FRI,
6975 } Elm_DaySelector_Day;
6977 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
6978 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
6979 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
6982 typedef struct _Imageslider_Item Elm_Imageslider_Item;
6983 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
6984 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6985 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);
6986 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);
6987 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);
6988 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6989 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6990 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6991 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6992 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6993 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6994 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
6995 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6996 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6997 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
6998 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
7003 * @defgroup Transit Transit
7004 * @ingroup Elementary
7006 * Transit is designed to apply various animated transition effects to @c
7007 * Evas_Object, such like translation, rotation, etc. For using these
7008 * effects, create an @ref Elm_Transit and add the desired transition effects.
7010 * Once the effects are added into transit, they will be automatically
7011 * managed (their callback will be called until the duration is ended, and
7012 * they will be deleted on completion).
7016 * Elm_Transit *trans = elm_transit_add();
7017 * elm_transit_object_add(trans, obj);
7018 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7019 * elm_transit_duration_set(transit, 1);
7020 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7021 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7022 * elm_transit_repeat_times_set(transit, 3);
7025 * Some transition effects are used to change the properties of objects. They
7027 * @li @ref elm_transit_effect_translation_add
7028 * @li @ref elm_transit_effect_color_add
7029 * @li @ref elm_transit_effect_rotation_add
7030 * @li @ref elm_transit_effect_wipe_add
7031 * @li @ref elm_transit_effect_zoom_add
7032 * @li @ref elm_transit_effect_resizing_add
7034 * Other transition effects are used to make one object disappear and another
7035 * object appear on its old place. These effects are:
7037 * @li @ref elm_transit_effect_flip_add
7038 * @li @ref elm_transit_effect_resizable_flip_add
7039 * @li @ref elm_transit_effect_fade_add
7040 * @li @ref elm_transit_effect_blend_add
7042 * It's also possible to make a transition chain with @ref
7043 * elm_transit_chain_transit_add.
7045 * @warning We strongly recommend to use elm_transit just when edje can not do
7046 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7047 * animations can be manipulated inside the theme.
7050 * @li @ref transit_example_01_explained
7051 * @li @ref transit_example_02_explained
7052 * @li @ref transit_example_03_c
7053 * @li @ref transit_example_04_c
7059 * @enum Elm_Transit_Tween_Mode
7061 * The type of acceleration used in the transition.
7065 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7066 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7067 over time, then decrease again
7069 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7071 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7073 } Elm_Transit_Tween_Mode;
7076 * @enum Elm_Transit_Effect_Flip_Axis
7078 * The axis where flip effect should be applied.
7082 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7083 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7084 } Elm_Transit_Effect_Flip_Axis;
7086 * @enum Elm_Transit_Effect_Wipe_Dir
7088 * The direction where the wipe effect should occur.
7092 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7093 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7094 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7095 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7096 } Elm_Transit_Effect_Wipe_Dir;
7097 /** @enum Elm_Transit_Effect_Wipe_Type
7099 * Whether the wipe effect should show or hide the object.
7103 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7105 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7107 } Elm_Transit_Effect_Wipe_Type;
7110 * @typedef Elm_Transit
7112 * The Transit created with elm_transit_add(). This type has the information
7113 * about the objects which the transition will be applied, and the
7114 * transition effects that will be used. It also contains info about
7115 * duration, number of repetitions, auto-reverse, etc.
7117 typedef struct _Elm_Transit Elm_Transit;
7118 typedef void Elm_Transit_Effect;
7120 * @typedef Elm_Transit_Effect_Transition_Cb
7122 * Transition callback called for this effect on each transition iteration.
7124 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7126 * Elm_Transit_Effect_End_Cb
7128 * Transition callback called for this effect when the transition is over.
7130 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7133 * Elm_Transit_Del_Cb
7135 * A callback called when the transit is deleted.
7137 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7142 * @note Is not necessary to delete the transit object, it will be deleted at
7143 * the end of its operation.
7144 * @note The transit will start playing when the program enter in the main loop, is not
7145 * necessary to give a start to the transit.
7147 * @return The transit object.
7151 EAPI Elm_Transit *elm_transit_add(void);
7154 * Stops the animation and delete the @p transit object.
7156 * Call this function if you wants to stop the animation before the duration
7157 * time. Make sure the @p transit object is still alive with
7158 * elm_transit_del_cb_set() function.
7159 * All added effects will be deleted, calling its repective data_free_cb
7160 * functions. The function setted by elm_transit_del_cb_set() will be called.
7162 * @see elm_transit_del_cb_set()
7164 * @param transit The transit object to be deleted.
7167 * @warning Just call this function if you are sure the transit is alive.
7169 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7172 * Add a new effect to the transit.
7174 * @note The cb function and the data are the key to the effect. If you try to
7175 * add an already added effect, nothing is done.
7176 * @note After the first addition of an effect in @p transit, if its
7177 * effect list become empty again, the @p transit will be killed by
7178 * elm_transit_del(transit) function.
7182 * Elm_Transit *transit = elm_transit_add();
7183 * elm_transit_effect_add(transit,
7184 * elm_transit_effect_blend_op,
7185 * elm_transit_effect_blend_context_new(),
7186 * elm_transit_effect_blend_context_free);
7189 * @param transit The transit object.
7190 * @param transition_cb The operation function. It is called when the
7191 * animation begins, it is the function that actually performs the animation.
7192 * It is called with the @p data, @p transit and the time progression of the
7193 * animation (a double value between 0.0 and 1.0).
7194 * @param effect The context data of the effect.
7195 * @param end_cb The function to free the context data, it will be called
7196 * at the end of the effect, it must finalize the animation and free the
7200 * @warning The transit free the context data at the and of the transition with
7201 * the data_free_cb function, do not use the context data in another transit.
7203 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);
7206 * Delete an added effect.
7208 * This function will remove the effect from the @p transit, calling the
7209 * data_free_cb to free the @p data.
7211 * @see elm_transit_effect_add()
7213 * @note If the effect is not found, nothing is done.
7214 * @note If the effect list become empty, this function will call
7215 * elm_transit_del(transit), that is, it will kill the @p transit.
7217 * @param transit The transit object.
7218 * @param transition_cb The operation function.
7219 * @param effect The context data of the effect.
7223 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);
7226 * Add new object to apply the effects.
7228 * @note After the first addition of an object in @p transit, if its
7229 * object list become empty again, the @p transit will be killed by
7230 * elm_transit_del(transit) function.
7231 * @note If the @p obj belongs to another transit, the @p obj will be
7232 * removed from it and it will only belong to the @p transit. If the old
7233 * transit stays without objects, it will die.
7234 * @note When you add an object into the @p transit, its state from
7235 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7236 * transit ends, if you change this state whith evas_object_pass_events_set()
7237 * after add the object, this state will change again when @p transit stops to
7240 * @param transit The transit object.
7241 * @param obj Object to be animated.
7244 * @warning It is not allowed to add a new object after transit begins to go.
7246 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7249 * Removes an added object from the transit.
7251 * @note If the @p obj is not in the @p transit, nothing is done.
7252 * @note If the list become empty, this function will call
7253 * elm_transit_del(transit), that is, it will kill the @p transit.
7255 * @param transit The transit object.
7256 * @param obj Object to be removed from @p transit.
7259 * @warning It is not allowed to remove objects after transit begins to go.
7261 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7264 * Get the objects of the transit.
7266 * @param transit The transit object.
7267 * @return a Eina_List with the objects from the transit.
7271 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7274 * Enable/disable keeping up the objects states.
7275 * If it is not kept, the objects states will be reset when transition ends.
7277 * @note @p transit can not be NULL.
7278 * @note One state includes geometry, color, map data.
7280 * @param transit The transit object.
7281 * @param state_keep Keeping or Non Keeping.
7285 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7288 * Get a value whether the objects states will be reset or not.
7290 * @note @p transit can not be NULL
7292 * @see elm_transit_objects_final_state_keep_set()
7294 * @param transit The transit object.
7295 * @return EINA_TRUE means the states of the objects will be reset.
7296 * If @p transit is NULL, EINA_FALSE is returned
7300 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7303 * Set the event enabled when transit is operating.
7305 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7306 * events from mouse and keyboard during the animation.
7307 * @note When you add an object with elm_transit_object_add(), its state from
7308 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7309 * transit ends, if you change this state with evas_object_pass_events_set()
7310 * after adding the object, this state will change again when @p transit stops
7313 * @param transit The transit object.
7314 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7315 * ignored otherwise.
7319 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7322 * Get the value of event enabled status.
7324 * @see elm_transit_event_enabled_set()
7326 * @param transit The Transit object
7327 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7328 * EINA_FALSE is returned
7332 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7335 * Set the user-callback function when the transit is deleted.
7337 * @note Using this function twice will overwrite the first function setted.
7338 * @note the @p transit object will be deleted after call @p cb function.
7340 * @param transit The transit object.
7341 * @param cb Callback function pointer. This function will be called before
7342 * the deletion of the transit.
7343 * @param data Callback funtion user data. It is the @p op parameter.
7347 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7350 * Set reverse effect automatically.
7352 * If auto reverse is setted, after running the effects with the progress
7353 * parameter from 0 to 1, it will call the effecs again with the progress
7354 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7355 * where the duration was setted with the function elm_transit_add and
7356 * the repeat with the function elm_transit_repeat_times_set().
7358 * @param transit The transit object.
7359 * @param reverse EINA_TRUE means the auto_reverse is on.
7363 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7366 * Get if the auto reverse is on.
7368 * @see elm_transit_auto_reverse_set()
7370 * @param transit The transit object.
7371 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7372 * EINA_FALSE is returned
7376 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7379 * Set the transit repeat count. Effect will be repeated by repeat count.
7381 * This function sets the number of repetition the transit will run after
7382 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7383 * If the @p repeat is a negative number, it will repeat infinite times.
7385 * @note If this function is called during the transit execution, the transit
7386 * will run @p repeat times, ignoring the times it already performed.
7388 * @param transit The transit object
7389 * @param repeat Repeat count
7393 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7396 * Get the transit repeat count.
7398 * @see elm_transit_repeat_times_set()
7400 * @param transit The Transit object.
7401 * @return The repeat count. If @p transit is NULL
7406 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7409 * Set the transit animation acceleration type.
7411 * This function sets the tween mode of the transit that can be:
7412 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7413 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7414 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7415 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7417 * @param transit The transit object.
7418 * @param tween_mode The tween type.
7422 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7425 * Get the transit animation acceleration type.
7427 * @note @p transit can not be NULL
7429 * @param transit The transit object.
7430 * @return The tween type. If @p transit is NULL
7431 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7435 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7438 * Set the transit animation time
7440 * @note @p transit can not be NULL
7442 * @param transit The transit object.
7443 * @param duration The animation time.
7447 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7450 * Get the transit animation time
7452 * @note @p transit can not be NULL
7454 * @param transit The transit object.
7456 * @return The transit animation time.
7460 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7463 * Starts the transition.
7464 * Once this API is called, the transit begins to measure the time.
7466 * @note @p transit can not be NULL
7468 * @param transit The transit object.
7472 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7475 * Pause/Resume the transition.
7477 * If you call elm_transit_go again, the transit will be started from the
7478 * beginning, and will be unpaused.
7480 * @note @p transit can not be NULL
7482 * @param transit The transit object.
7483 * @param paused Whether the transition should be paused or not.
7487 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7490 * Get the value of paused status.
7492 * @see elm_transit_paused_set()
7494 * @note @p transit can not be NULL
7496 * @param transit The transit object.
7497 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7498 * EINA_FALSE is returned
7502 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7505 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7507 * The value returned is a fraction (current time / total time). It
7508 * represents the progression position relative to the total.
7510 * @note @p transit can not be NULL
7512 * @param transit The transit object.
7514 * @return The time progression value. If @p transit is NULL
7519 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7522 * Makes the chain relationship between two transits.
7524 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7525 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7527 * @param transit The transit object.
7528 * @param chain_transit The chain transit object. This transit will be operated
7529 * after transit is done.
7531 * This function adds @p chain_transit transition to a chain after the @p
7532 * transit, and will be started as soon as @p transit ends. See @ref
7533 * transit_example_02_explained for a full example.
7537 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7540 * Cut off the chain relationship between two transits.
7542 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7543 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7545 * @param transit The transit object.
7546 * @param chain_transit The chain transit object.
7548 * This function remove the @p chain_transit transition from the @p transit.
7552 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7555 * Get the current chain transit list.
7557 * @note @p transit can not be NULL.
7559 * @param transit The transit object.
7560 * @return chain transit list.
7564 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7567 * Add the Resizing Effect to Elm_Transit.
7569 * @note This API is one of the facades. It creates resizing effect context
7570 * and add it's required APIs to elm_transit_effect_add.
7572 * @see elm_transit_effect_add()
7574 * @param transit Transit object.
7575 * @param from_w Object width size when effect begins.
7576 * @param from_h Object height size when effect begins.
7577 * @param to_w Object width size when effect ends.
7578 * @param to_h Object height size when effect ends.
7579 * @return Resizing effect context data.
7583 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);
7586 * Add the Translation Effect to Elm_Transit.
7588 * @note This API is one of the facades. It creates translation effect context
7589 * and add it's required APIs to elm_transit_effect_add.
7591 * @see elm_transit_effect_add()
7593 * @param transit Transit object.
7594 * @param from_dx X Position variation when effect begins.
7595 * @param from_dy Y Position variation when effect begins.
7596 * @param to_dx X Position variation when effect ends.
7597 * @param to_dy Y Position variation when effect ends.
7598 * @return Translation effect context data.
7601 * @warning It is highly recommended just create a transit with this effect when
7602 * the window that the objects of the transit belongs has already been created.
7603 * This is because this effect needs the geometry information about the objects,
7604 * and if the window was not created yet, it can get a wrong information.
7606 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);
7609 * Add the Zoom Effect to Elm_Transit.
7611 * @note This API is one of the facades. It creates zoom effect context
7612 * and add it's required APIs to elm_transit_effect_add.
7614 * @see elm_transit_effect_add()
7616 * @param transit Transit object.
7617 * @param from_rate Scale rate when effect begins (1 is current rate).
7618 * @param to_rate Scale rate when effect ends.
7619 * @return Zoom effect context data.
7622 * @warning It is highly recommended just create a transit with this effect when
7623 * the window that the objects of the transit belongs has already been created.
7624 * This is because this effect needs the geometry information about the objects,
7625 * and if the window was not created yet, it can get a wrong information.
7627 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7630 * Add the Flip Effect to Elm_Transit.
7632 * @note This API is one of the facades. It creates flip effect context
7633 * and add it's required APIs to elm_transit_effect_add.
7634 * @note This effect is applied to each pair of objects in the order they are listed
7635 * in the transit list of objects. The first object in the pair will be the
7636 * "front" object and the second will be the "back" object.
7638 * @see elm_transit_effect_add()
7640 * @param transit Transit object.
7641 * @param axis Flipping Axis(X or Y).
7642 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7643 * @return Flip effect context data.
7646 * @warning It is highly recommended just create a transit with this effect when
7647 * the window that the objects of the transit belongs has already been created.
7648 * This is because this effect needs the geometry information about the objects,
7649 * and if the window was not created yet, it can get a wrong information.
7651 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7654 * Add the Resizable Flip Effect to Elm_Transit.
7656 * @note This API is one of the facades. It creates resizable flip effect context
7657 * and add it's required APIs to elm_transit_effect_add.
7658 * @note This effect is applied to each pair of objects in the order they are listed
7659 * in the transit list of objects. The first object in the pair will be the
7660 * "front" object and the second will be the "back" object.
7662 * @see elm_transit_effect_add()
7664 * @param transit Transit object.
7665 * @param axis Flipping Axis(X or Y).
7666 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7667 * @return Resizable flip effect context data.
7670 * @warning It is highly recommended just create a transit with this effect when
7671 * the window that the objects of the transit belongs has already been created.
7672 * This is because this effect needs the geometry information about the objects,
7673 * and if the window was not created yet, it can get a wrong information.
7675 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7678 * Add the Wipe Effect to Elm_Transit.
7680 * @note This API is one of the facades. It creates wipe effect context
7681 * and add it's required APIs to elm_transit_effect_add.
7683 * @see elm_transit_effect_add()
7685 * @param transit Transit object.
7686 * @param type Wipe type. Hide or show.
7687 * @param dir Wipe Direction.
7688 * @return Wipe effect context data.
7691 * @warning It is highly recommended just create a transit with this effect when
7692 * the window that the objects of the transit belongs has already been created.
7693 * This is because this effect needs the geometry information about the objects,
7694 * and if the window was not created yet, it can get a wrong information.
7696 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7699 * Add the Color Effect to Elm_Transit.
7701 * @note This API is one of the facades. It creates color effect context
7702 * and add it's required APIs to elm_transit_effect_add.
7704 * @see elm_transit_effect_add()
7706 * @param transit Transit object.
7707 * @param from_r RGB R when effect begins.
7708 * @param from_g RGB G when effect begins.
7709 * @param from_b RGB B when effect begins.
7710 * @param from_a RGB A when effect begins.
7711 * @param to_r RGB R when effect ends.
7712 * @param to_g RGB G when effect ends.
7713 * @param to_b RGB B when effect ends.
7714 * @param to_a RGB A when effect ends.
7715 * @return Color effect context data.
7719 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);
7722 * Add the Fade Effect to Elm_Transit.
7724 * @note This API is one of the facades. It creates fade effect context
7725 * and add it's required APIs to elm_transit_effect_add.
7726 * @note This effect is applied to each pair of objects in the order they are listed
7727 * in the transit list of objects. The first object in the pair will be the
7728 * "before" object and the second will be the "after" object.
7730 * @see elm_transit_effect_add()
7732 * @param transit Transit object.
7733 * @return Fade effect context data.
7736 * @warning It is highly recommended just create a transit with this effect when
7737 * the window that the objects of the transit belongs has already been created.
7738 * This is because this effect needs the color information about the objects,
7739 * and if the window was not created yet, it can get a wrong information.
7741 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7744 * Add the Blend Effect to Elm_Transit.
7746 * @note This API is one of the facades. It creates blend effect context
7747 * and add it's required APIs to elm_transit_effect_add.
7748 * @note This effect is applied to each pair of objects in the order they are listed
7749 * in the transit list of objects. The first object in the pair will be the
7750 * "before" object and the second will be the "after" object.
7752 * @see elm_transit_effect_add()
7754 * @param transit Transit object.
7755 * @return Blend effect context data.
7758 * @warning It is highly recommended just create a transit with this effect when
7759 * the window that the objects of the transit belongs has already been created.
7760 * This is because this effect needs the color information about the objects,
7761 * and if the window was not created yet, it can get a wrong information.
7763 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7766 * Add the Rotation Effect to Elm_Transit.
7768 * @note This API is one of the facades. It creates rotation effect context
7769 * and add it's required APIs to elm_transit_effect_add.
7771 * @see elm_transit_effect_add()
7773 * @param transit Transit object.
7774 * @param from_degree Degree when effect begins.
7775 * @param to_degree Degree when effect is ends.
7776 * @return Rotation effect context data.
7779 * @warning It is highly recommended just create a transit with this effect when
7780 * the window that the objects of the transit belongs has already been created.
7781 * This is because this effect needs the geometry information about the objects,
7782 * and if the window was not created yet, it can get a wrong information.
7784 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7787 * Add the ImageAnimation Effect to Elm_Transit.
7789 * @note This API is one of the facades. It creates image animation effect context
7790 * and add it's required APIs to elm_transit_effect_add.
7791 * The @p images parameter is a list images paths. This list and
7792 * its contents will be deleted at the end of the effect by
7793 * elm_transit_effect_image_animation_context_free() function.
7797 * char buf[PATH_MAX];
7798 * Eina_List *images = NULL;
7799 * Elm_Transit *transi = elm_transit_add();
7801 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7802 * images = eina_list_append(images, eina_stringshare_add(buf));
7804 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7805 * images = eina_list_append(images, eina_stringshare_add(buf));
7806 * elm_transit_effect_image_animation_add(transi, images);
7810 * @see elm_transit_effect_add()
7812 * @param transit Transit object.
7813 * @param images Eina_List of images file paths. This list and
7814 * its contents will be deleted at the end of the effect by
7815 * elm_transit_effect_image_animation_context_free() function.
7816 * @return Image Animation effect context data.
7820 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7826 typedef struct _Elm_Store Elm_Store;
7827 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
7828 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
7829 typedef struct _Elm_Store_Item Elm_Store_Item;
7830 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
7831 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
7832 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
7833 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
7834 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
7835 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
7836 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
7837 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
7838 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
7840 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
7841 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7842 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7843 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
7844 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
7845 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
7846 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
7850 ELM_STORE_ITEM_MAPPING_NONE = 0,
7851 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
7852 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
7853 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
7854 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
7855 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
7856 // can add more here as needed by common apps
7857 ELM_STORE_ITEM_MAPPING_LAST
7858 } Elm_Store_Item_Mapping_Type;
7860 struct _Elm_Store_Item_Mapping_Icon
7862 // FIXME: allow edje file icons
7864 Elm_Icon_Lookup_Order lookup_order;
7865 Eina_Bool standard_name : 1;
7866 Eina_Bool no_scale : 1;
7867 Eina_Bool smooth : 1;
7868 Eina_Bool scale_up : 1;
7869 Eina_Bool scale_down : 1;
7872 struct _Elm_Store_Item_Mapping_Empty
7877 struct _Elm_Store_Item_Mapping_Photo
7882 struct _Elm_Store_Item_Mapping_Custom
7884 Elm_Store_Item_Mapping_Cb func;
7887 struct _Elm_Store_Item_Mapping
7889 Elm_Store_Item_Mapping_Type type;
7893 Elm_Store_Item_Mapping_Empty empty;
7894 Elm_Store_Item_Mapping_Icon icon;
7895 Elm_Store_Item_Mapping_Photo photo;
7896 Elm_Store_Item_Mapping_Custom custom;
7897 // add more types here
7901 struct _Elm_Store_Item_Info
7907 int pre_group_index;
7909 Elm_Genlist_Item_Class *item_class;
7910 const Elm_Store_Item_Mapping *mapping;
7915 struct _Elm_Store_Item_Info_Filesystem
7917 Elm_Store_Item_Info base;
7921 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
7922 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
7924 EAPI Elm_Store *elm_store_dbsystem_new(void);
7925 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
7926 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
7927 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
7928 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
7929 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7930 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7931 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
7932 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7933 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
7934 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7935 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
7936 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7937 EAPI void elm_store_free(Elm_Store *st);
7938 EAPI Elm_Store *elm_store_filesystem_new(void);
7939 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
7940 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7941 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7942 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
7943 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
7944 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7945 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7946 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7947 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
7948 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7949 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
7950 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
7951 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7952 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
7953 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7954 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7955 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7958 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
7959 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
7960 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
7961 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
7962 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
7967 ELM_TICKERNOTI_DEFAULT,
7968 ELM_TICKERNOTI_DETAILVIEW
7969 } Elm_Tickernoti_Mode;
7971 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
7972 EAPI void elm_tickernoti_icon_set (const Evas_Object *obj, Evas_Object *icon);
7973 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj);
7974 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label);
7975 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj);
7976 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label);
7977 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj);
7978 EAPI void elm_tickernoti_detailview_button_set (const Evas_Object *obj, Evas_Object *button);
7979 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj);
7980 EAPI void elm_tickernoti_detailview_icon_set (const Evas_Object *obj, Evas_Object *icon);
7981 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj);
7982 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj);
7983 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj);
7984 EAPI void elm_tickernoti_rotation_set (const Evas_Object *obj, int angle);
7985 EAPI void elm_tickernoti_mode_set (const Evas_Object *obj, Elm_Tickernoti_Mode mode);
7986 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj);
7988 /* SegmentControl */
7989 typedef struct _Elm_Segment_Item Elm_Segment_Item;
7990 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7991 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
7992 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);
7993 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
7994 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7995 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7996 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7997 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
7998 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
7999 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8000 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8001 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8002 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8003 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8004 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8005 /* smart callbacks called:
8006 * "changed" -when the user clicks on a segment item which is not previously
8007 * selected and get selected. The event_info parameter is the
8008 * segment item index.
8011 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8012 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8013 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8014 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8015 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8016 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8017 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8018 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8020 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8021 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8023 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8024 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8025 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8026 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8027 EAPI void elm_video_play(Evas_Object *video);
8028 EAPI void elm_video_pause(Evas_Object *video);
8029 EAPI void elm_video_stop(Evas_Object *video);
8030 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8031 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8032 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8033 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8034 EAPI double elm_video_audio_level_get(Evas_Object *video);
8035 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8036 EAPI double elm_video_play_position_get(Evas_Object *video);
8037 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8038 EAPI double elm_video_play_length_get(Evas_Object *video);
8039 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8040 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8041 EAPI const char *elm_video_title_get(Evas_Object *video);
8043 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8044 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8047 typedef enum _Elm_Datefield_Layout
8049 ELM_DATEFIELD_LAYOUT_TIME,
8050 ELM_DATEFIELD_LAYOUT_DATE,
8051 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8052 } Elm_Datefield_Layout;
8054 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8055 EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8056 EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8057 EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8058 EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8059 EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8060 EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8061 EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8062 EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8063 EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8064 EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8065 EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8066 EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8067 EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
8068 EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8069 /* smart callbacks called:
8070 * "changed" - when datefield entry is changed, this signal is sent.
8074 typedef enum _Elm_Popup_Response
8076 ELM_POPUP_RESPONSE_NONE = -1,
8077 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8078 ELM_POPUP_RESPONSE_OK = -3,
8079 ELM_POPUP_RESPONSE_CANCEL = -4,
8080 ELM_POPUP_RESPONSE_CLOSE = -5
8081 } Elm_Popup_Response;
8083 typedef enum _Elm_Popup_Mode
8085 ELM_POPUP_TYPE_NONE = 0,
8086 ELM_POPUP_TYPE_ALERT = (1 << 0)
8089 typedef enum _Elm_Popup_Orient
8091 ELM_POPUP_ORIENT_TOP,
8092 ELM_POPUP_ORIENT_CENTER,
8093 ELM_POPUP_ORIENT_BOTTOM,
8094 ELM_POPUP_ORIENT_LEFT,
8095 ELM_POPUP_ORIENT_RIGHT,
8096 ELM_POPUP_ORIENT_TOP_LEFT,
8097 ELM_POPUP_ORIENT_TOP_RIGHT,
8098 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8099 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8102 /* smart callbacks called:
8103 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8106 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8107 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8108 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8109 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8110 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8111 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8112 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8113 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8114 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8115 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8116 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, ... );
8117 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8118 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8119 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8120 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8121 EAPI int elm_popup_run(Evas_Object *obj);
8126 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8127 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8128 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8129 ELM_NAVIGATIONBAR_BACK_BUTTON
8130 } Elm_Navi_Button_Type;
8132 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8133 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);
8134 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8135 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8136 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8137 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8138 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8139 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8140 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8141 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8142 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8143 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8144 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8145 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8146 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8147 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8148 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8149 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8150 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8151 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8152 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8157 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8158 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8159 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8160 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8161 ELM_NAVIGATIONBAR_EX_MAX
8162 } Elm_Navi_ex_Button_Type;
8163 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8165 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8166 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8167 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8168 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8169 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8170 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8171 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8172 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8173 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8174 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);
8175 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8176 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8177 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8178 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8179 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8180 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8181 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8182 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8183 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8184 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8185 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8186 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8187 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8188 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8189 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8190 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8191 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8192 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8196 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8197 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8198 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8199 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8200 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8201 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8202 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8203 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8204 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8206 typedef enum _Elm_Controlbar_Mode_Type
8208 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8209 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8210 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8211 ELM_CONTROLBAR_MODE_LARGE,
8212 ELM_CONTROLBAR_MODE_SMALL,
8213 ELM_CONTROLBAR_MODE_LEFT,
8214 ELM_CONTROLBAR_MODE_RIGHT
8215 } Elm_Controlbar_Mode_Type;
8217 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8218 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8219 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8220 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8221 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);
8222 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);
8223 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);
8224 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);
8225 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);
8226 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);
8227 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8228 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8229 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8230 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8231 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8232 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8233 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8234 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8235 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8236 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8237 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8238 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8239 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8240 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8241 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8242 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8243 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8244 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8245 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8246 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8247 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8248 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8249 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8250 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8251 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8252 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8253 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8254 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8255 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8258 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8259 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8260 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8261 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8262 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8263 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8264 EAPI void elm_searchbar_clear(Evas_Object *obj);
8265 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);