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 characters */
325 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
326 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
332 * Called back when a widget's tooltip is activated and needs content.
333 * @param data user-data given to elm_object_tooltip_content_cb_set()
334 * @param obj owner widget.
336 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
339 * Called back when a widget's item tooltip is activated and needs content.
340 * @param data user-data given to elm_object_tooltip_content_cb_set()
341 * @param obj owner widget.
342 * @param item context dependent item. As an example, if tooltip was
343 * set on Elm_List_Item, then it is of this type.
345 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
347 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
349 #ifndef ELM_LIB_QUICKLAUNCH
350 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
352 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
355 /**************************************************************************/
359 * Initialize Elementary
361 * @param[in] argc System's argument count value
362 * @param[in] argv System's pointer to array of argument strings
363 * @return The init counter value.
365 * This function initializes Elementary and increments a counter of
366 * the number of calls to it. It returs the new counter's value.
368 * @warning This call is exported only for use by the @c ELM_MAIN()
369 * macro. There is no need to use this if you use this macro (which
370 * is highly advisable). An elm_main() should contain the entry
371 * point code for your application, having the same prototype as
372 * elm_init(), and @b not being static (putting the @c EAPI symbol
373 * in front of its type declaration is advisable). The @c
374 * ELM_MAIN() call should be placed just after it.
377 * @dontinclude bg_example_01.c
381 * See the full @ref bg_example_01_c "example".
383 * @see elm_shutdown().
386 EAPI int elm_init(int argc, char **argv);
389 * Shut down Elementary
391 * @return The init counter value.
393 * This should be called at the end of your application, just
394 * before it ceases to do any more processing. This will clean up
395 * any permanent resources your application may have allocated via
396 * Elementary that would otherwise persist.
398 * @see elm_init() for an example
402 EAPI int elm_shutdown(void);
405 * Run Elementary's main loop
407 * This call should be issued just after all initialization is
408 * completed. This function will not return until elm_exit() is
409 * called. It will keep looping, running the main
410 * (event/processing) loop for Elementary.
412 * @see elm_init() for an example
416 EAPI void elm_run(void);
419 * Exit Elementary's main loop
421 * If this call is issued, it will flag the main loop to cease
422 * processing and return back to its parent function (usually your
423 * elm_main() function).
425 * @see elm_init() for an example. There, just after a request to
426 * close the window comes, the main loop will be left.
428 * @note By using the #ELM_POLICY_QUIT on your Elementary
429 * applications, you'll this function called automatically for you.
433 EAPI void elm_exit(void);
436 * Provide information in order to make Elementary determine the @b
437 * run time location of the software in question, so other data files
438 * such as images, sound files, executable utilities, libraries,
439 * modules and locale files can be found.
441 * @param mainfunc This is your application's main function name,
442 * whose binary's location is to be found. Providing @c NULL
443 * will make Elementary not to use it
444 * @param dom This will be used as the application's "domain", in the
445 * form of a prefix to any environment variables that may
446 * override prefix detection and the directory name, inside the
447 * standard share or data directories, where the software's
448 * data files will be looked for.
449 * @param checkfile This is an (optional) magic file's path to check
450 * for existence (and it must be located in the data directory,
451 * under the share directory provided above). Its presence will
452 * help determine the prefix found was correct. Pass @c NULL if
453 * the check is not to be done.
455 * This function allows one to re-locate the application somewhere
456 * else after compilation, if the developer wishes for easier
457 * distribution of pre-compiled binaries.
459 * The prefix system is designed to locate where the given software is
460 * installed (under a common path prefix) at run time and then report
461 * specific locations of this prefix and common directories inside
462 * this prefix like the binary, library, data and locale directories,
463 * through the @c elm_app_*_get() family of functions.
465 * Call elm_app_info_set() early on before you change working
466 * directory or anything about @c argv[0], so it gets accurate
469 * It will then try and trace back which file @p mainfunc comes from,
470 * if provided, to determine the application's prefix directory.
472 * The @p dom parameter provides a string prefix to prepend before
473 * environment variables, allowing a fallback to @b specific
474 * environment variables to locate the software. You would most
475 * probably provide a lowercase string there, because it will also
476 * serve as directory domain, explained next. For environment
477 * variables purposes, this string is made uppercase. For example if
478 * @c "myapp" is provided as the prefix, then the program would expect
479 * @c "MYAPP_PREFIX" as a master environment variable to specify the
480 * exact install prefix for the software, or more specific environment
481 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
482 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
483 * the user or scripts before launching. If not provided (@c NULL),
484 * environment variables will not be used to override compiled-in
485 * defaults or auto detections.
487 * The @p dom string also provides a subdirectory inside the system
488 * shared data directory for data files. For example, if the system
489 * directory is @c /usr/local/share, then this directory name is
490 * appended, creating @c /usr/local/share/myapp, if it @p was @c
491 * "myapp". It is expected the application installs data files in
494 * The @p checkfile is a file name or path of something inside the
495 * share or data directory to be used to test that the prefix
496 * detection worked. For example, your app will install a wallpaper
497 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
498 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
501 * @see elm_app_compile_bin_dir_set()
502 * @see elm_app_compile_lib_dir_set()
503 * @see elm_app_compile_data_dir_set()
504 * @see elm_app_compile_locale_set()
505 * @see elm_app_prefix_dir_get()
506 * @see elm_app_bin_dir_get()
507 * @see elm_app_lib_dir_get()
508 * @see elm_app_data_dir_get()
509 * @see elm_app_locale_dir_get()
511 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
514 * Provide information on the @b fallback application's binaries
515 * directory, on scenarios where they get overriden by
516 * elm_app_info_set().
518 * @param dir The path to the default binaries directory (compile time
521 * @note Elementary will as well use this path to determine actual
522 * names of binaries' directory paths, maybe changing it to be @c
523 * something/local/bin instead of @c something/bin, only, for
526 * @warning You should call this function @b before
527 * elm_app_info_set().
529 EAPI void elm_app_compile_bin_dir_set(const char *dir);
532 * Provide information on the @b fallback application's libraries
533 * directory, on scenarios where they get overriden by
534 * elm_app_info_set().
536 * @param dir The path to the default libraries directory (compile
539 * @note Elementary will as well use this path to determine actual
540 * names of libraries' directory paths, maybe changing it to be @c
541 * something/lib32 or @c something/lib64 instead of @c something/lib,
544 * @warning You should call this function @b before
545 * elm_app_info_set().
547 EAPI void elm_app_compile_lib_dir_set(const char *dir);
550 * Provide information on the @b fallback application's data
551 * directory, on scenarios where they get overriden by
552 * elm_app_info_set().
554 * @param dir The path to the default data directory (compile time
557 * @note Elementary will as well use this path to determine actual
558 * names of data directory paths, maybe changing it to be @c
559 * something/local/share instead of @c something/share, only, for
562 * @warning You should call this function @b before
563 * elm_app_info_set().
565 EAPI void elm_app_compile_data_dir_set(const char *dir);
568 * Provide information on the @b fallback application's locale
569 * directory, on scenarios where they get overriden by
570 * elm_app_info_set().
572 * @param dir The path to the default locale directory (compile time
575 * @warning You should call this function @b before
576 * elm_app_info_set().
578 EAPI void elm_app_compile_locale_set(const char *dir);
581 * Retrieve the application's run time prefix directory, as set by
582 * elm_app_info_set() and the way (environment) the application was
585 * @return The directory prefix the application is actually using
587 EAPI const char *elm_app_prefix_dir_get(void);
590 * Retrieve the application's run time binaries prefix directory, as
591 * set by elm_app_info_set() and the way (environment) the application
594 * @return The binaries directory prefix the application is actually
597 EAPI const char *elm_app_bin_dir_get(void);
600 * Retrieve the application's run time libraries prefix directory, as
601 * set by elm_app_info_set() and the way (environment) the application
604 * @return The libraries directory prefix the application is actually
607 EAPI const char *elm_app_lib_dir_get(void);
610 * Retrieve the application's run time data prefix directory, as
611 * set by elm_app_info_set() and the way (environment) the application
614 * @return The data directory prefix the application is actually
617 EAPI const char *elm_app_data_dir_get(void);
620 * Retrieve the application's run time locale prefix directory, as
621 * set by elm_app_info_set() and the way (environment) the application
624 * @return The locale directory prefix the application is actually
627 EAPI const char *elm_app_locale_dir_get(void);
629 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
630 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
631 EAPI int elm_quicklaunch_init(int argc, char **argv);
632 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
633 EAPI int elm_quicklaunch_sub_shutdown(void);
634 EAPI int elm_quicklaunch_shutdown(void);
635 EAPI void elm_quicklaunch_seed(void);
636 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
637 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
638 EAPI void elm_quicklaunch_cleanup(void);
639 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
640 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
642 EAPI Eina_Bool elm_need_efreet(void);
643 EAPI Eina_Bool elm_need_e_dbus(void);
644 EAPI Eina_Bool elm_need_ethumb(void);
647 * Set a new policy's value (for a given policy group/identifier).
649 * @param policy policy identifier, as in @ref Elm_Policy.
650 * @param value policy value, which depends on the identifier
652 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
654 * Elementary policies define applications' behavior,
655 * somehow. These behaviors are divided in policy groups (see
656 * #Elm_Policy enumeration). This call will emit the Ecore event
657 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
658 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
661 * @note Currently, we have only one policy identifier/group
662 * (#ELM_POLICY_QUIT), which has two possible values.
666 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
669 * Gets the policy value set for given policy identifier.
671 * @param policy policy identifier, as in #Elm_Policy.
672 * @return The currently set policy value, for that
673 * identifier. Will be @c 0 if @p policy passed is invalid.
677 EAPI int elm_policy_get(unsigned int policy);
680 * Set a label of an object
682 * @param obj The Elementary object
683 * @param item The label id to set (NULL for the default label)
684 * @param label The new text of the label
686 * @note Elementary objects may have many labels (e.g. Action Slider)
690 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
692 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
695 * Get a label of an object
697 * @param obj The Elementary object
698 * @param item The label id to get (NULL for the default label)
699 * @return text of the label or
702 * @note Elementary objects may have many labels (e.g. Action Slider)
706 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *item);
708 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
714 EAPI void elm_all_flush(void);
715 EAPI int elm_cache_flush_interval_get(void);
716 EAPI void elm_cache_flush_interval_set(int size);
717 EAPI void elm_cache_flush_interval_all_set(int size);
718 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
719 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
720 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
721 EAPI int elm_font_cache_get(void);
722 EAPI void elm_font_cache_set(int size);
723 EAPI void elm_font_cache_all_set(int size);
724 EAPI int elm_image_cache_get(void);
725 EAPI void elm_image_cache_set(int size);
726 EAPI void elm_image_cache_all_set(int size);
727 EAPI int elm_edje_file_cache_get(void);
728 EAPI void elm_edje_file_cache_set(int size);
729 EAPI void elm_edje_file_cache_all_set(int size);
730 EAPI int elm_edje_collection_cache_get(void);
731 EAPI void elm_edje_collection_cache_set(int size);
732 EAPI void elm_edje_collection_cache_all_set(int size);
735 * @defgroup Scaling Selective Widget Scaling
737 * Different widgets can be scaled independently. These functions
738 * allow you to manipulate this scaling on a per-widget basis. The
739 * object and all its children get their scaling factors multiplied
740 * by the scale factor set. This is multiplicative, in that if a
741 * child also has a scale size set it is in turn multiplied by its
742 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
743 * double size, @c 0.5 is half, etc.
745 * @ref general_functions_example_page "This" example contemplates
746 * some of these functions.
750 * Set the scaling factor for a given Elementary object
752 * @param obj The Elementary to operate on
753 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
758 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
761 * Get the scaling factor for a given Elementary object
763 * @param obj The object
764 * @return The scaling factor set by elm_object_scale_set()
768 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
769 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
770 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
771 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
772 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
774 * Set the style to use by a widget
776 * Sets the style name that will define the appearance of a widget. Styles
777 * vary from widget to widget and may also be defined by other themes
778 * by means of extensions and overlays.
780 * @param obj The Elementary widget to style
781 * @param style The style name to use
783 * @see elm_theme_extension_add()
784 * @see elm_theme_overlay_add()
788 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
790 * Get the style used by the widget
792 * This gets the style being used for that widget. Note that the string
793 * pointer is only valid as longas the object is valid and the style doesn't
796 * @param obj The Elementary widget to query for its style
797 * @return The style name used
799 * @see elm_object_style_set()
803 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
806 * @defgroup Styles Styles
808 * Widgets can have different styles of look. These generic API's
809 * set styles of widgets, if they support them (and if the theme(s)
812 * @ref general_functions_example_page "This" example contemplates
813 * some of these functions.
817 * Set the disabled state of an Elementary object.
819 * @param obj The Elementary object to operate on
820 * @param disabled The state to put in in: @c EINA_TRUE for
821 * disabled, @c EINA_FALSE for enabled
823 * Elementary objects can be @b disabled, in which state they won't
824 * receive input and, in general, will be themed differently from
825 * their normal state, usually greyed out. Useful for contexts
826 * where you don't want your users to interact with some of the
827 * parts of you interface.
829 * This sets the state for the widget, either disabling it or
834 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
837 * Get the disabled state of an Elementary object.
839 * @param obj The Elementary object to operate on
840 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
841 * if it's enabled (or on errors)
843 * This gets the state of the widget, which might be enabled or disabled.
847 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
850 * @defgroup WidgetNavigation Widget Tree Navigation.
852 * How to check if an Evas Object is an Elementary widget? How to
853 * get the first elementary widget that is parent of the given
854 * object? These are all covered in widget tree navigation.
856 * @ref general_functions_example_page "This" example contemplates
857 * some of these functions.
860 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
863 * Get the first parent of the given object that is an Elementary
866 * @param obj the Elementary object to query parent from.
867 * @return the parent object that is an Elementary widget, or @c
868 * NULL, if it was not found.
870 * Use this to query for an object's parent widget.
872 * @note Most of Elementary users wouldn't be mixing non-Elementary
873 * smart objects in the objects tree of an application, as this is
874 * an advanced usage of Elementary with Evas. So, except for the
875 * application's window, which is the root of that tree, all other
876 * objects would have valid Elementary widget parents.
878 * @ingroup WidgetNavigation
880 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
881 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
882 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
884 EAPI double elm_scale_get(void);
885 EAPI void elm_scale_set(double scale);
886 EAPI void elm_scale_all_set(double scale);
888 EAPI Eina_Bool elm_mirrored_get(void);
889 EAPI void elm_mirrored_set(Eina_Bool mirrored);
891 EAPI Eina_Bool elm_config_save(void);
892 EAPI void elm_config_reload(void);
894 EAPI const char *elm_profile_current_get(void);
895 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
896 EAPI void elm_profile_dir_free(const char *p_dir);
897 EAPI Eina_List *elm_profile_list_get(void);
898 EAPI void elm_profile_list_free(Eina_List *l);
899 EAPI void elm_profile_set(const char *profile);
900 EAPI void elm_profile_all_set(const char *profile);
902 EAPI const char *elm_engine_current_get(void);
903 EAPI void elm_engine_set(const char *engine);
905 typedef struct _Elm_Text_Class
911 typedef struct _Elm_Font_Overlay
913 const char *text_class;
918 typedef struct _Elm_Font_Properties
922 } Elm_Font_Properties;
924 EAPI const Eina_List *elm_text_classes_list_get(void);
925 EAPI void elm_text_classes_list_free(const Eina_List *list);
927 EAPI const Eina_List *elm_font_overlay_list_get(void);
928 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
929 EAPI void elm_font_overlay_unset(const char *text_class);
930 EAPI void elm_font_overlay_apply(void);
931 EAPI void elm_font_overlay_all_apply(void);
933 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
934 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
935 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
936 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
937 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
938 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
941 * @defgroup Fingers Fingers
943 * Elementary is designed to be finger-friendly for touchscreens,
944 * and so in addition to scaling for display resolution, it can
945 * also scale based on finger "resolution" (or size). You can then
946 * customize the granularity of the areas meant to receive clicks
949 * Different profiles may have pre-set values for finger sizes.
951 * @ref general_functions_example_page "This" example contemplates
952 * some of these functions.
956 * Get the configured "finger size"
958 * @return The finger size
960 * This gets the globally configured finger size, <b>in pixels</b>
964 EAPI Evas_Coord elm_finger_size_get(void);
965 EAPI void elm_finger_size_set(Evas_Coord size);
966 EAPI void elm_finger_size_all_set(Evas_Coord size);
969 * @defgroup Focus Focus
971 * An Elementary application has, at all times, one (and only one)
972 * @b focused object. This is what determines where the input
973 * events go to within the application's window. Also, focused
974 * objects can be decorated differently, in order to signal to the
975 * user where the input is, at a given moment.
977 * Elementary applications also have the concept of <b>focus
978 * chain</b>: one can cycle through all the windows' focusable
979 * objects by input (tab key) or programmatically. The default
980 * focus chain for an application is the one define by the order in
981 * which the widgets where added in code. One will cycle through
982 * top level widgets, and, for each one containg sub-objects, cycle
983 * through them all, before returning to the level
984 * above. Elementary also allows one to set @b custom focus chains
985 * for their applications.
987 * Besides the focused decoration a widget may exhibit, when it
988 * gets focus, Elementary has a @b global focus highlight object
989 * that can be enabled for a window. If one chooses to do so, this
990 * extra highlight effect will surround the current focused object,
993 * @note Some Elementary widgets are @b unfocusable, after
994 * creation, by their very nature: they are not meant to be
995 * interacted with input events, but are there just for visual
998 * @ref general_functions_example_page "This" example contemplates
999 * some of these functions.
1002 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1003 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1004 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1005 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1008 * Get the whether an Elementary object has the focus or not.
1010 * @param obj The Elementary object to get the information from
1011 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1012 * not (and on errors).
1014 * @see elm_object_focus()
1018 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1021 * Make a given Elementary object the focused one.
1023 * @param obj The Elementary object to make focused.
1025 * @note This object, if it can handle focus, will take the focus
1026 * away from the one who had it previously and will, for now on, be
1027 * the one receiving input events.
1029 * @see elm_object_focus_get()
1033 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1036 * Remove the focus from an Elementary object
1038 * @param obj The Elementary to take focus from
1040 * This removes the focus from @p obj, passing it back to the
1041 * previous element in the focus chain list.
1043 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1047 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1050 * Set the ability for an Element object to be focused
1052 * @param obj The Elementary object to operate on
1053 * @param enable @c EINA_TRUE if the object can be focused, @c
1054 * EINA_FALSE if not (and on errors)
1056 * This sets whether the object @p obj is able to take focus or
1057 * not. Unfocusable objects do nothing when programmatically
1058 * focused, being the nearest focusable parent object the one
1059 * really getting focus. Also, when they receive mouse input, they
1060 * will get the event, but not take away the focus from where it
1065 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1068 * Get whether an Elementary object is focusable or not
1070 * @param obj The Elementary object to operate on
1071 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1072 * EINA_FALSE if not (and on errors)
1074 * @note Objects which are meant to be interacted with by input
1075 * events are created able to be focused, by default. All the
1080 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1082 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1083 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1084 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1085 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1086 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1087 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1088 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1090 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1091 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1092 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1093 EAPI double elm_scroll_bounce_friction_get(void);
1094 EAPI void elm_scroll_bounce_friction_set(double friction);
1095 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1096 EAPI double elm_scroll_page_scroll_friction_get(void);
1097 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1098 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1099 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1100 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1101 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1102 EAPI double elm_scroll_zoom_friction_get(void);
1103 EAPI void elm_scroll_zoom_friction_set(double friction);
1104 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1105 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1106 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1107 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1108 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1109 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1110 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1111 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1112 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1113 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1114 EAPI double elm_scroll_thumbscroll_friction_get(void);
1115 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1116 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1117 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1118 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1119 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1121 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1122 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1123 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1124 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1125 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1126 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1127 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1128 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1130 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1131 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
1132 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
1134 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1135 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1138 * Adjust size of an element for finger usage.
1140 * @param times_w How many fingers should fit horizontally
1141 * @param w Pointer to the width size to adjust
1142 * @param times_h How many fingers should fit vertically
1143 * @param h Pointer to the height size to adjust
1145 * This takes width and height sizes (in pixels) as input and a
1146 * size multiple (which is how many fingers you want to place
1147 * within the area, being "finger" the size set by
1148 * elm_finger_size_set()), and adjusts the size to be large enough
1149 * to accommodate the resulting size -- if it doesn't already
1150 * accommodate it. On return the @p w and @p h sizes pointed to by
1151 * these parameters will be modified, on those conditions.
1153 * @note This is kind of a low level Elementary call, most useful
1154 * on size evaluation times for widgets. An external user wouldn't
1155 * be calling, most of the time.
1159 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1161 EAPI double elm_longpress_timeout_get(void);
1162 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1165 * don't use it unless you are sure
1167 EAPI void elm_object_tree_dump(const Evas_Object *top);
1168 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1173 * @defgroup Theme Theme
1175 * Elementary uses Edje to theme its widgets, naturally. But for the most
1176 * part this is hidden behind a simpler interface that lets the user set
1177 * extensions and choose the style of widgets in a much easier way.
1179 * Instead of thinking in terms of paths to Edje files and their groups
1180 * each time you want to change the appearance of a widget, Elementary
1181 * works so you can add any theme file with extensions or replace the
1182 * main theme at one point in the application, and then just set the style
1183 * of widgets with elm_object_style_set() and related functions. Elementary
1184 * will then look in its list of themes for a matching group and apply it,
1185 * and when the theme changes midway through the application, all widgets
1186 * will be updated accordingly.
1188 * There are three concepts you need to know to understand how Elementary
1189 * theming works: default theme, extensions and overlays.
1191 * Default theme, obviously enough, is the one that provides the default
1192 * look of all widgets. End users can change the theme used by Elementary
1193 * by setting the @c ELM_THEME environment variable before running an
1194 * application, or globally for all programs using the @c elementary_config
1195 * utility. Applications can change the default theme using elm_theme_set(),
1196 * but this can go against the user wishes, so it's not an adviced practice.
1198 * Ideally, applications should find everything they need in the already
1199 * provided theme, but there may be occasions when that's not enough and
1200 * custom styles are required to correctly express the idea. For this
1201 * cases, Elementary has extensions.
1203 * Extensions allow the application developer to write styles of its own
1204 * to apply to some widgets. This requires knowledge of how each widget
1205 * is themed, as extensions will always replace the entire group used by
1206 * the widget, so important signals and parts need to be there for the
1207 * object to behave properly (see documentation of Edje for details).
1208 * Once the theme for the extension is done, the application needs to add
1209 * it to the list of themes Elementary will look into, using
1210 * elm_theme_extension_add(), and set the style of the desired widgets as
1211 * he would normally with elm_object_style_set().
1213 * Overlays, on the other hand, can replace the look of all widgets by
1214 * overriding the default style. Like extensions, it's up to the application
1215 * developer to write the theme for the widgets it wants, the difference
1216 * being that when looking for the theme, Elementary will check first the
1217 * list of overlays, then the set theme and lastly the list of extensions,
1218 * so with overlays it's possible to replace the default view and every
1219 * widget will be affected. This is very much alike to setting the whole
1220 * theme for the application and will probably clash with the end user
1221 * options, not to mention the risk of ending up with not matching styles
1222 * across the program. Unless there's a very special reason to use them,
1223 * overlays should be avoided for the resons exposed before.
1225 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1226 * keeps one default internally and every function that receives one of
1227 * these can be called with NULL to refer to this default (except for
1228 * elm_theme_free()). It's possible to create a new instance of a
1229 * ::Elm_Theme to set other theme for a specific widget (and all of its
1230 * children), but this is as discouraged, if not even more so, than using
1231 * overlays. Don't use this unless you really know what you are doing.
1233 * But to be less negative about things, you can look at the following
1235 * @li @ref theme_example_01 "Using extensions"
1236 * @li @ref theme_example_02 "Using overlays"
1241 * @typedef Elm_Theme
1243 * Opaque handler for the list of themes Elementary looks for when
1244 * rendering widgets.
1246 * Stay out of this unless you really know what you are doing. For most
1247 * cases, sticking to the default is all a developer needs.
1249 typedef struct _Elm_Theme Elm_Theme;
1252 * Create a new specific theme
1254 * This creates an empty specific theme that only uses the default theme. A
1255 * specific theme has its own private set of extensions and overlays too
1256 * (which are empty by default). Specific themes do not fall back to themes
1257 * of parent objects. They are not intended for this use. Use styles, overlays
1258 * and extensions when needed, but avoid specific themes unless there is no
1259 * other way (example: you want to have a preview of a new theme you are
1260 * selecting in a "theme selector" window. The preview is inside a scroller
1261 * and should display what the theme you selected will look like, but not
1262 * actually apply it yet. The child of the scroller will have a specific
1263 * theme set to show this preview before the user decides to apply it to all
1266 EAPI Elm_Theme *elm_theme_new(void);
1268 * Free a specific theme
1270 * @param th The theme to free
1272 * This frees a theme created with elm_theme_new().
1274 EAPI void elm_theme_free(Elm_Theme *th);
1276 * Copy the theme fom the source to the destination theme
1278 * @param th The source theme to copy from
1279 * @param thdst The destination theme to copy data to
1281 * This makes a one-time static copy of all the theme config, extensions
1282 * and overlays from @p th to @p thdst. If @p th references a theme, then
1283 * @p thdst is also set to reference it, with all the theme settings,
1284 * overlays and extensions that @p th had.
1286 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1288 * Tell the source theme to reference the ref theme
1290 * @param th The theme that will do the referencing
1291 * @param thref The theme that is the reference source
1293 * This clears @p th to be empty and then sets it to refer to @p thref
1294 * so @p th acts as an override to @p thref, but where its overrides
1295 * don't apply, it will fall through to @pthref for configuration.
1297 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1299 * Return the theme referred to
1301 * @param th The theme to get the reference from
1302 * @return The referenced theme handle
1304 * This gets the theme set as the reference theme by elm_theme_ref_set().
1305 * If no theme is set as a reference, NULL is returned.
1307 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1309 * Return the default theme
1311 * @return The default theme handle
1313 * This returns the internal default theme setup handle that all widgets
1314 * use implicitly unless a specific theme is set. This is also often use
1315 * as a shorthand of NULL.
1317 EAPI Elm_Theme *elm_theme_default_get(void);
1319 * Prepends a theme overlay to the list of overlays
1321 * @param th The theme to add to, or if NULL, the default theme
1322 * @param item The Edje file path to be used
1324 * Use this if your application needs to provide some custom overlay theme
1325 * (An Edje file that replaces some default styles of widgets) where adding
1326 * new styles, or changing system theme configuration is not possible. Do
1327 * NOT use this instead of a proper system theme configuration. Use proper
1328 * configuration files, profiles, environment variables etc. to set a theme
1329 * so that the theme can be altered by simple confiugration by a user. Using
1330 * this call to achieve that effect is abusing the API and will create lots
1333 * @see elm_theme_extension_add()
1335 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1337 * Delete a theme overlay from the list of overlays
1339 * @param th The theme to delete from, or if NULL, the default theme
1340 * @param item The name of the theme overlay
1342 * @see elm_theme_overlay_add()
1344 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1346 * Appends a theme extension to the list of extensions.
1348 * @param th The theme to add to, or if NULL, the default theme
1349 * @param item The Edje file path to be used
1351 * This is intended when an application needs more styles of widgets or new
1352 * widget themes that the default does not provide (or may not provide). The
1353 * application has "extended" usage by coming up with new custom style names
1354 * for widgets for specific uses, but as these are not "standard", they are
1355 * not guaranteed to be provided by a default theme. This means the
1356 * application is required to provide these extra elements itself in specific
1357 * Edje files. This call adds one of those Edje files to the theme search
1358 * path to be search after the default theme. The use of this call is
1359 * encouraged when default styles do not meet the needs of the application.
1360 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1362 * @see elm_object_style_set()
1364 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1366 * Deletes a theme extension from the list of extensions.
1368 * @param th The theme to delete from, or if NULL, the default theme
1369 * @param item The name of the theme extension
1371 * @see elm_theme_extension_add()
1373 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1375 * Set the theme search order for the given theme
1377 * @param th The theme to set the search order, or if NULL, the default theme
1378 * @param theme Theme search string
1380 * This sets the search string for the theme in path-notation from first
1381 * theme to search, to last, delimited by the : character. Example:
1383 * "shiny:/path/to/file.edj:default"
1385 * See the ELM_THEME environment variable for more information.
1387 * @see elm_theme_get()
1388 * @see elm_theme_list_get()
1390 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1392 * Return the theme search order
1394 * @param th The theme to get the search order, or if NULL, the default theme
1395 * @return The internal search order path
1397 * This function returns a colon separated string of theme elements as
1398 * returned by elm_theme_list_get().
1400 * @see elm_theme_set()
1401 * @see elm_theme_list_get()
1403 EAPI const char *elm_theme_get(Elm_Theme *th);
1405 * Return a list of theme elements to be used in a theme.
1407 * @param th Theme to get the list of theme elements from.
1408 * @return The internal list of theme elements
1410 * This returns the internal list of theme elements (will only be valid as
1411 * long as the theme is not modified by elm_theme_set() or theme is not
1412 * freed by elm_theme_free(). This is a list of strings which must not be
1413 * altered as they are also internal. If @p th is NULL, then the default
1414 * theme element list is returned.
1416 * A theme element can consist of a full or relative path to a .edj file,
1417 * or a name, without extension, for a theme to be searched in the known
1418 * theme paths for Elemementary.
1420 * @see elm_theme_set()
1421 * @see elm_theme_get()
1423 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1425 * Return the full patrh for a theme element
1427 * @param f The theme element name
1428 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1429 * @return The full path to the file found.
1431 * This returns a string you should free with free() on success, NULL on
1432 * failure. This will search for the given theme element, and if it is a
1433 * full or relative path element or a simple searchable name. The returned
1434 * path is the full path to the file, if searched, and the file exists, or it
1435 * is simply the full path given in the element or a resolved path if
1436 * relative to home. The @p in_search_path boolean pointed to is set to
1437 * EINA_TRUE if the file was a searchable file andis in the search path,
1438 * and EINA_FALSE otherwise.
1440 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1442 * Flush the current theme.
1444 * @param th Theme to flush
1446 * This flushes caches that let elementary know where to find theme elements
1447 * in the given theme. If @p th is NULL, then the default theme is flushed.
1448 * Call this function if source theme data has changed in such a way as to
1449 * make any caches Elementary kept invalid.
1451 EAPI void elm_theme_flush(Elm_Theme *th);
1453 * This flushes all themes (default and specific ones).
1455 * This will flush all themes in the current application context, by calling
1456 * elm_theme_flush() on each of them.
1458 EAPI void elm_theme_full_flush(void);
1460 * Set the theme for all elementary using applications on the current display
1462 * @param theme The name of the theme to use. Format same as the ELM_THEME
1463 * environment variable.
1465 EAPI void elm_theme_all_set(const char *theme);
1467 * Return a list of theme elements in the theme search path
1469 * @return A list of strings that are the theme element names.
1471 * This lists all available theme files in the standard Elementary search path
1472 * for theme elements, and returns them in alphabetical order as theme
1473 * element names in a list of strings. Free this with
1474 * elm_theme_name_available_list_free() when you are done with the list.
1476 EAPI Eina_List *elm_theme_name_available_list_new(void);
1478 * Free the list returned by elm_theme_name_available_list_new()
1480 * This frees the list of themes returned by
1481 * elm_theme_name_available_list_new(). Once freed the list should no longer
1482 * be used. a new list mys be created.
1484 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1486 * Set a specific theme to be used for this object and its children
1488 * @param obj The object to set the theme on
1489 * @param th The theme to set
1491 * This sets a specific theme that will be used for the given object and any
1492 * child objects it has. If @p th is NULL then the theme to be used is
1493 * cleared and the object will inherit its theme from its parent (which
1494 * ultimately will use the default theme if no specific themes are set).
1496 * Use special themes with great care as this will annoy users and make
1497 * configuration difficult. Avoid any custom themes at all if it can be
1500 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1502 * Get the specific theme to be used
1504 * @param obj The object to get the specific theme from
1505 * @return The specifc theme set.
1507 * This will return a specific theme set, or NULL if no specific theme is
1508 * set on that object. It will not return inherited themes from parents, only
1509 * the specific theme set for that specific object. See elm_object_theme_set()
1510 * for more information.
1512 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1518 typedef enum _Elm_Win_Type
1521 ELM_WIN_DIALOG_BASIC,
1528 ELM_WIN_DROPDOWN_MENU,
1531 ELM_WIN_NOTIFICATION,
1534 ELM_WIN_INLINED_IMAGE,
1537 typedef enum _Elm_Win_Keyboard_Mode
1539 ELM_WIN_KEYBOARD_UNKNOWN,
1540 ELM_WIN_KEYBOARD_OFF,
1541 ELM_WIN_KEYBOARD_ON,
1542 ELM_WIN_KEYBOARD_ALPHA,
1543 ELM_WIN_KEYBOARD_NUMERIC,
1544 ELM_WIN_KEYBOARD_PIN,
1545 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1546 ELM_WIN_KEYBOARD_HEX,
1547 ELM_WIN_KEYBOARD_TERMINAL,
1548 ELM_WIN_KEYBOARD_PASSWORD,
1549 ELM_WIN_KEYBOARD_IP,
1550 ELM_WIN_KEYBOARD_HOST,
1551 ELM_WIN_KEYBOARD_FILE,
1552 ELM_WIN_KEYBOARD_URL,
1553 ELM_WIN_KEYBOARD_KEYPAD,
1554 ELM_WIN_KEYBOARD_J2ME
1555 } Elm_Win_Keyboard_Mode;
1557 typedef enum _Elm_Illume_Command
1559 ELM_ILLUME_COMMAND_FOCUS_BACK,
1560 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1561 ELM_ILLUME_COMMAND_FOCUS_HOME,
1562 ELM_ILLUME_COMMAND_CLOSE
1563 } Elm_Illume_Command;
1565 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1566 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1567 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1568 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1569 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1570 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1571 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1572 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1573 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1574 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1575 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1576 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1578 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1580 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1581 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1582 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1583 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1584 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1585 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1586 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1587 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1588 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1589 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1590 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1592 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1593 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1594 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1595 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1596 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1597 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1598 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1599 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1600 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1601 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1602 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1603 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1604 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1605 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1606 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1607 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1608 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1609 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1610 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1611 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1612 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1613 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1614 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1616 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1617 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1618 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1619 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1620 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1621 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1622 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1624 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1625 * (blank mouse, private mouse obj, defaultmouse)
1628 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1629 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1630 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1631 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1633 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1635 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1636 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1637 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1638 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1639 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1640 /* available styles:
1645 /* X specific calls - won't work on non-x engines (return 0) */
1646 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1647 /* smart callbacks called:
1648 * "delete,request" - the user requested to delete the window
1649 * "focus,in" - window got focus
1650 * "focus,out" - window lost focus
1651 * "moved" - window that holds the canvas was moved
1657 * @image html img/icon/bg/preview-00.png
1658 * @image latex img/icon/bg/preview-00.png
1660 * @brief Background object, used for setting a solid color, image or Edje
1661 * group as background to a window or any container object.
1663 * The bg object is used for setting a solid background to a window or
1664 * packing into any container object. It works just like an image, but has
1665 * some properties useful to a background, like setting it to tiled,
1666 * centered, scaled or stretched.
1668 * Here is some sample code using it:
1669 * @li @ref bg_01_example_page
1670 * @li @ref bg_02_example_page
1671 * @li @ref bg_03_example_page
1675 typedef enum _Elm_Bg_Option
1677 ELM_BG_OPTION_CENTER, /**< center the background */
1678 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1679 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1680 ELM_BG_OPTION_TILE /**< tile background at its original size */
1684 * Add a new background to the parent
1686 * @param parent The parent object
1687 * @return The new object or NULL if it cannot be created
1691 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1694 * Set the file (image or edje) used for the background
1696 * @param obj The bg object
1697 * @param file The file path
1698 * @param group Optional key (group in Edje) within the file
1700 * This sets the image file used in the background object. The image (or edje)
1701 * will be stretched (retaining aspect if its an image file) to completely fill
1702 * the bg object. This may mean some parts are not visible.
1704 * @note Once the image of @p obj is set, a previously set one will be deleted,
1705 * even if @p file is NULL.
1709 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1712 * Get the file (image or edje) used for the background
1714 * @param obj The bg object
1715 * @param file The file path
1716 * @param group Optional key (group in Edje) within the file
1720 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1723 * Set the option used for the background image
1725 * @param obj The bg object
1726 * @param option The desired background option (TILE, SCALE)
1728 * This sets the option used for manipulating the display of the background
1729 * image. The image can be tiled or scaled.
1733 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1736 * Get the option used for the background image
1738 * @param obj The bg object
1739 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1743 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1745 * Set the option used for the background color
1747 * @param obj The bg object
1752 * This sets the color used for the background rectangle. Its range goes
1757 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1759 * Get the option used for the background color
1761 * @param obj The bg object
1768 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1771 * Set the overlay object used for the background object.
1773 * @param obj The bg object
1774 * @param overlay The overlay object
1776 * This provides a way for elm_bg to have an 'overlay' that will be on top
1777 * of the bg. Once the over object is set, a previously set one will be
1778 * deleted, even if you set the new one to NULL. If you want to keep that
1779 * old content object, use the elm_bg_overlay_unset() function.
1784 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1787 * Get the overlay object used for the background object.
1789 * @param obj The bg object
1790 * @return The content that is being used
1792 * Return the content object which is set for this widget
1796 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1799 * Get the overlay object used for the background object.
1801 * @param obj The bg object
1802 * @return The content that was being used
1804 * Unparent and return the overlay object which was set for this widget
1808 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1811 * Set the size of the pixmap representation of the image.
1813 * This option just makes sense if an image is going to be set in the bg.
1815 * @param obj The bg object
1816 * @param w The new width of the image pixmap representation.
1817 * @param h The new height of the image pixmap representation.
1819 * This function sets a new size for pixmap representation of the given bg
1820 * image. It allows the image to be loaded already in the specified size,
1821 * reducing the memory usage and load time when loading a big image with load
1822 * size set to a smaller size.
1824 * NOTE: this is just a hint, the real size of the pixmap may differ
1825 * depending on the type of image being loaded, being bigger than requested.
1829 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1830 /* smart callbacks called:
1834 * @defgroup Icon Icon
1836 * @image html img/icon/button/preview-00.png
1837 * @image latex img/icon/button/preview-00.png
1839 * An object that provides standard icon images (delete, edit, arrows, etc.)
1840 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
1842 * The icon image requested can be in the elementary theme, or in the
1843 * freedesktop.org paths. It's possible to set the order of preference from
1844 * where the image will be used.
1846 * This API is very similar to @ref Image, but with ready to use images.
1848 * Default images provided by the theme are described below.
1850 * The first list contains icons that were first intended to be used in
1851 * toolbars, but can be used in many other places too:
1867 * Now some icons that were designed to be used in menus (but again, you can
1868 * use them anywhere else):
1873 * @li menu/arrow_down
1874 * @li menu/arrow_left
1875 * @li menu/arrow_right
1884 * And here we have some media player specific icons:
1885 * @li media_player/forward
1886 * @li media_player/info
1887 * @li media_player/next
1888 * @li media_player/pause
1889 * @li media_player/play
1890 * @li media_player/prev
1891 * @li media_player/rewind
1892 * @li media_player/stop
1894 * Signals that you can add callbacks for are:
1896 * "clicked" - This is called when a user has clicked the icon
1898 * An example of usage for this API follows:
1899 * @li @ref tutorial_icon
1908 * @enum _Elm_Icon_Lookup_Order
1909 * @typedef Elm_Icon_Lookup_Order
1911 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
1912 * theme, FDO paths, or both?
1916 typedef enum _Elm_Icon_Lookup_Order
1918 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1919 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1920 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1921 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1922 } Elm_Icon_Lookup_Order;
1925 * Add a new icon object to the parent.
1927 * @param parent The parent object
1928 * @return The new object or NULL if it cannot be created
1930 * @see elm_icon_file_set()
1934 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1936 * Set the file that will be used as icon.
1938 * @param obj The icon object
1939 * @param file The path to file that will be used as icon image
1940 * @param group The group that the icon belongs to in edje file
1942 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1944 * @note The icon image set by this function can be changed by
1945 * elm_icon_standard_set().
1947 * @see elm_icon_file_get()
1951 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1953 * Get the file that will be used as icon.
1955 * @param obj The icon object
1956 * @param file The path to file that will be used as icon icon image
1957 * @param group The group that the icon belongs to in edje file
1959 * @see elm_icon_file_set()
1963 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1964 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1966 * Set the icon by icon standards names.
1968 * @param obj The icon object
1969 * @param name The icon name
1971 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1973 * For example, freedesktop.org defines standard icon names such as "home",
1974 * "network", etc. There can be different icon sets to match those icon
1975 * keys. The @p name given as parameter is one of these "keys", and will be
1976 * used to look in the freedesktop.org paths and elementary theme. One can
1977 * change the lookup order with elm_icon_order_lookup_set().
1979 * If name is not found in any of the expected locations and it is the
1980 * absolute path of an image file, this image will be used.
1982 * @note The icon image set by this function can be changed by
1983 * elm_icon_file_set().
1985 * @see elm_icon_standard_get()
1986 * @see elm_icon_file_set()
1990 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1992 * Get the icon name set by icon standard names.
1994 * @param obj The icon object
1995 * @return The icon name
1997 * If the icon image was set using elm_icon_file_set() instead of
1998 * elm_icon_standard_set(), then this function will return @c NULL.
2000 * @see elm_icon_standard_set()
2004 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2006 * Set the smooth effect for an icon object.
2008 * @param obj The icon object
2009 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2010 * otherwise. Default is @c EINA_TRUE.
2012 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2013 * scaling provides a better resulting image, but is slower.
2015 * The smooth scaling should be disabled when making animations that change
2016 * the icon size, since they will be faster. Animations that don't require
2017 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2018 * is already scaled, since the scaled icon image will be cached).
2020 * @see elm_icon_smooth_get()
2024 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2026 * Get the smooth effect for an icon object.
2028 * @param obj The icon object
2029 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2031 * @see elm_icon_smooth_set()
2035 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2037 * Disable scaling of this object.
2039 * @param obj The icon object.
2040 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2041 * otherwise. Default is @c EINA_FALSE.
2043 * This function disables scaling of the icon object through the function
2044 * elm_object_scale_set(). However, this does not affect the object
2045 * size/resize in any way. For that effect, take a look at
2046 * elm_icon_scale_set().
2048 * @see elm_icon_no_scale_get()
2049 * @see elm_icon_scale_set()
2050 * @see elm_object_scale_set()
2054 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2056 * Get whether scaling is disabled on the object.
2058 * @param obj The icon object
2059 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2061 * @see elm_icon_no_scale_set()
2065 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2067 * Set if the object is (up/down) resizeable.
2069 * @param obj The icon object
2070 * @param scale_up A bool to set if the object is resizeable up. Default is
2072 * @param scale_down A bool to set if the object is resizeable down. Default
2075 * This function limits the icon object resize ability. If @p scale_up is set to
2076 * @c EINA_FALSE, the object can't have its height or width resized to a value
2077 * higher than the original icon size. Same is valid for @p scale_down.
2079 * @see elm_icon_scale_get()
2083 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2085 * Get if the object is (up/down) resizeable.
2087 * @param obj The icon object
2088 * @param scale_up A bool to set if the object is resizeable up
2089 * @param scale_down A bool to set if the object is resizeable down
2091 * @see elm_icon_scale_set()
2095 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2097 * Set if the icon fill the entire object area.
2099 * @param obj The icon object
2100 * @param fill_outside @c EINA_TRUE if the object is filled outside,
2101 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2103 * When the icon object is resized to a different aspect ratio from the
2104 * original icon image, the icon image will still keep its aspect. This flag
2105 * tells how the image should fill the object's area. They are: keep the
2106 * entire icon inside the limits of height and width of the object (@p
2107 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
2108 * of the object, and the icon will fill the entire object (@p fill_outside
2111 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
2112 * retain property to false. Thus, the icon image will always keep its
2113 * original aspect ratio.
2115 * @see elm_icon_fill_outside_get()
2116 * @see elm_image_fill_outside_set()
2120 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2122 * Get if the object is filled outside.
2124 * @param obj The icon object
2125 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2127 * @see elm_icon_fill_outside_set()
2131 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2133 * Set the prescale size for the icon.
2135 * @param obj The icon object
2136 * @param size The prescale size. This value is used for both width and
2139 * This function sets a new size for pixmap representation of the given
2140 * icon. It allows the icon to be loaded already in the specified size,
2141 * reducing the memory usage and load time when loading a big icon with load
2142 * size set to a smaller size.
2144 * It's equivalent to the elm_bg_load_size_set() function for bg.
2146 * @note this is just a hint, the real size of the pixmap may differ
2147 * depending on the type of icon being loaded, being bigger than requested.
2149 * @see elm_icon_prescale_get()
2150 * @see elm_bg_load_size_set()
2154 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2156 * Get the prescale size for the icon.
2158 * @param obj The icon object
2159 * @return The prescale size
2161 * @see elm_icon_prescale_set()
2165 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2167 * Sets the icon lookup order used by elm_icon_standard_set().
2169 * @param obj The icon object
2170 * @param order The icon lookup order (can be one of
2171 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
2172 * or ELM_ICON_LOOKUP_THEME)
2174 * @see elm_icon_order_lookup_get()
2175 * @see Elm_Icon_Lookup_Order
2179 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2181 * Gets the icon lookup order.
2183 * @param obj The icon object
2184 * @return The icon lookup order
2186 * @see elm_icon_order_lookup_set()
2187 * @see Elm_Icon_Lookup_Order
2191 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2198 * @defgroup Image Image
2200 * @image html img/image/button/preview-00.png
2201 * @image latex img/image/button/preview-00.png
2203 * An object that allows one to load an image file to it. It can be used
2204 * anywhere like any other elementary widget.
2206 * This widget provides most of the functionality provided from @ref Bg or @ref
2207 * Icon, but with a slightly different API (use the one that fits better your
2210 * The features not provided by those two other image widgets are:
2211 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
2212 * @li change the object orientation with elm_image_orient_set();
2213 * @li and turning the image editable with elm_image_editable_set().
2215 * Signals that you can add callbacks for are:
2217 * @li @c "clicked" - This is called when a user has clicked the image
2219 * An example of usage for this API follows:
2220 * @li @ref tutorial_image
2229 * @enum _Elm_Image_Orient
2230 * @typedef Elm_Image_Orient
2232 * Possible orientation options for elm_image_orient_set().
2234 * @image html elm_image_orient_set.png
2235 * @image latex elm_image_orient_set.eps width=\textwidth
2239 typedef enum _Elm_Image_Orient
2241 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
2242 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
2243 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
2244 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
2245 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
2246 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
2247 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
2248 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
2252 * Add a new image to the parent.
2254 * @param parent The parent object
2255 * @return The new object or NULL if it cannot be created
2257 * @see elm_image_file_set()
2261 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2263 * Set the file that will be used as image.
2265 * @param obj The image object
2266 * @param file The path to file that will be used as image
2267 * @param group The group that the image belongs in edje file (if it's an
2270 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2272 * @see elm_image_file_get()
2276 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2278 * Get the file that will be used as image.
2280 * @param obj The image object
2281 * @param file The path to file
2282 * @param group The group that the image belongs in edje file
2284 * @see elm_image_file_set()
2288 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2290 * Set the smooth effect for an image.
2292 * @param obj The image object
2293 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2294 * otherwise. Default is @c EINA_TRUE.
2296 * Set the scaling algorithm to be used when scaling the image. Smooth
2297 * scaling provides a better resulting image, but is slower.
2299 * The smooth scaling should be disabled when making animations that change
2300 * the image size, since it will be faster. Animations that don't require
2301 * resizing of the image can keep the smooth scaling enabled (even if the
2302 * image is already scaled, since the scaled image will be cached).
2304 * @see elm_image_smooth_get()
2308 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2310 * Get the smooth effect for an image.
2312 * @param obj The image object
2313 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2315 * @see elm_image_smooth_get()
2319 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2321 * Gets the current size of the image.
2323 * @param obj The image object.
2324 * @param w Pointer to store width, or NULL.
2325 * @param h Pointer to store height, or NULL.
2327 * This is the real size of the image, not the size of the object.
2329 * On error, neither w or h will be written.
2333 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2335 * Disable scaling of this object.
2337 * @param obj The image object.
2338 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2339 * otherwise. Default is @c EINA_FALSE.
2341 * This function disables scaling of the elm_image widget through the
2342 * function elm_object_scale_set(). However, this does not affect the widget
2343 * size/resize in any way. For that effect, take a look at
2344 * elm_image_scale_set().
2346 * @see elm_image_no_scale_get()
2347 * @see elm_image_scale_set()
2348 * @see elm_object_scale_set()
2352 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2354 * Get whether scaling is disabled on the object.
2356 * @param obj The image object
2357 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2359 * @see elm_image_no_scale_set()
2363 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2365 * Set if the object is (up/down) resizeable.
2367 * @param obj The image object
2368 * @param scale_up A bool to set if the object is resizeable up. Default is
2370 * @param scale_down A bool to set if the object is resizeable down. Default
2373 * This function limits the image resize ability. If @p scale_up is set to
2374 * @c EINA_FALSE, the object can't have its height or width resized to a value
2375 * higher than the original image size. Same is valid for @p scale_down.
2377 * @see elm_image_scale_get()
2381 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2383 * Get if the object is (up/down) resizeable.
2385 * @param obj The image object
2386 * @param scale_up A bool to set if the object is resizeable up
2387 * @param scale_down A bool to set if the object is resizeable down
2389 * @see elm_image_scale_set()
2393 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2395 * Set if the image fill the entire object area when keeping the aspect ratio.
2397 * @param obj The image object
2398 * @param fill_outside @c EINA_TRUE if the object is filled outside,
2399 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2401 * When the image should keep its aspect ratio even if resized to another
2402 * aspect ratio, there are two possibilities to resize it: keep the entire
2403 * image inside the limits of height and width of the object (@p fill_outside
2404 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
2405 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
2407 * @note This option will have no effect if
2408 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
2410 * @see elm_image_fill_outside_get()
2411 * @see elm_image_aspect_ratio_retained_set()
2415 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2417 * Get if the object is filled outside
2419 * @param obj The image object
2420 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2422 * @see elm_image_fill_outside_set()
2426 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2428 * Set the prescale size for the image
2430 * @param obj The image object
2431 * @param size The prescale size. This value is used for both width and
2434 * This function sets a new size for pixmap representation of the given
2435 * image. It allows the image to be loaded already in the specified size,
2436 * reducing the memory usage and load time when loading a big image with load
2437 * size set to a smaller size.
2439 * It's equivalent to the elm_bg_load_size_set() function for bg.
2441 * @note this is just a hint, the real size of the pixmap may differ
2442 * depending on the type of image being loaded, being bigger than requested.
2444 * @see elm_image_prescale_get()
2445 * @see elm_bg_load_size_set()
2449 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2451 * Get the prescale size for the image
2453 * @param obj The image object
2454 * @return The prescale size
2456 * @see elm_image_prescale_set()
2460 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2462 * Set the image orientation.
2464 * @param obj The image object
2465 * @param orient The image orientation
2466 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2467 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2468 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2469 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
2470 * Default is #ELM_IMAGE_ORIENT_NONE.
2472 * This function allows to rotate or flip the given image.
2474 * @see elm_image_orient_get()
2475 * @see @ref Elm_Image_Orient
2479 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2481 * Get the image orientation.
2483 * @param obj The image object
2484 * @return The image orientation
2485 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2486 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2487 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2488 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
2490 * @see elm_image_orient_set()
2491 * @see @ref Elm_Image_Orient
2495 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2497 * Make the image 'editable'.
2499 * @param obj Image object.
2500 * @param set Turn on or off editability. Default is @c EINA_FALSE.
2502 * This means the image is a valid drag target for drag and drop, and can be
2503 * cut or pasted too.
2507 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2509 * Make the image 'editable'.
2511 * @param obj Image object.
2512 * @return Editability.
2514 * This means the image is a valid drag target for drag and drop, and can be
2515 * cut or pasted too.
2519 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2521 * Get the basic Evas_Image object from this object (widget).
2523 * @param obj The image object to get the inlined image from
2524 * @return The inlined image object, or NULL if none exists
2526 * This function allows one to get the underlying @c Evas_Object of type
2527 * Image from this elementary widget. It can be useful to do things like get
2528 * the pixel data, save the image to a file, etc.
2530 * @note Be careful to not manipulate it, as it is under control of
2535 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2537 * Set whether the original aspect ratio of the image should be kept on resize.
2539 * @param obj The image object.
2540 * @param retained @c EINA_TRUE if the image should retain the aspect,
2541 * @c EINA_FALSE otherwise.
2543 * The original aspect ratio (width / height) of the image is usually
2544 * distorted to match the object's size. Enabling this option will retain
2545 * this original aspect, and the way that the image is fit into the object's
2546 * area depends on the option set by elm_image_fill_outside_set().
2548 * @see elm_image_aspect_ratio_retained_get()
2549 * @see elm_image_fill_outside_set()
2553 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2555 * Get if the object retains the original aspect ratio.
2557 * @param obj The image object.
2558 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
2563 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2565 /* smart callbacks called:
2566 * "clicked" - the user clicked the image
2574 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2576 typedef enum _Elm_GLView_Mode
2578 ELM_GLVIEW_ALPHA = 1,
2579 ELM_GLVIEW_DEPTH = 2,
2580 ELM_GLVIEW_STENCIL = 4
2584 * Defines a policy for the glview resizing.
2586 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2588 typedef enum _Elm_GLView_Resize_Policy
2590 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2591 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2592 } Elm_GLView_Resize_Policy;
2594 typedef enum _Elm_GLView_Render_Policy
2596 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2597 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2598 } Elm_GLView_Render_Policy;
2601 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2602 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2603 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2604 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2605 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2606 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2607 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2608 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2609 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2610 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2611 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2612 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2618 * A box arranges objects in a linear fashion, governed by a layout function
2619 * that defines the details of this arrangement.
2621 * By default, the box will use an internal function to set the layout to
2622 * a single row, either vertical or horizontal. This layout is affected
2623 * by a number of parameters, such as the homogeneous flag set by
2624 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2625 * elm_box_align_set() and the hints set to each object in the box.
2627 * For this default layout, it's possible to change the orientation with
2628 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2629 * placing its elements ordered from top to bottom. When horizontal is set,
2630 * the order will go from left to right. If the box is set to be
2631 * homogeneous, every object in it will be assigned the same space, that
2632 * of the largest object. Padding can be used to set some spacing between
2633 * the cell given to each object. The alignment of the box, set with
2634 * elm_box_align_set(), determines how the bounding box of all the elements
2635 * will be placed within the space given to the box widget itself.
2637 * The size hints of each object also affect how they are placed and sized
2638 * within the box. evas_object_size_hint_min_set() will give the minimum
2639 * size the object can have, and the box will use it as the basis for all
2640 * latter calculations. Elementary widgets set their own minimum size as
2641 * needed, so there's rarely any need to use it manually.
2643 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2644 * used to tell whether the object will be allocated the minimum size it
2645 * needs or if the space given to it should be expanded. It's important
2646 * to realize that expanding the size given to the object is not the same
2647 * thing as resizing the object. It could very well end being a small
2648 * widget floating in a much larger empty space. If not set, the weight
2649 * for objects will normally be 0.0 for both axis, meaning the widget will
2650 * not be expanded. To take as much space possible, set the weight to
2651 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2653 * Besides how much space each object is allocated, it's possible to control
2654 * how the widget will be placed within that space using
2655 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2656 * for both axis, meaning the object will be centered, but any value from
2657 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2658 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2659 * is -1.0, means the object will be resized to fill the entire space it
2662 * In addition, customized functions to define the layout can be set, which
2663 * allow the application developer to organize the objects within the box
2664 * in any number of ways.
2666 * The special elm_box_layout_transition() function can be used
2667 * to switch from one layout to another, animating the motion of the
2668 * children of the box.
2670 * @note Objects should not be added to box objects using _add() calls.
2672 * Some examples on how to use boxes follow:
2673 * @li @ref box_example_01
2674 * @li @ref box_example_02
2679 * @typedef Elm_Box_Transition
2681 * Opaque handler containing the parameters to perform an animated
2682 * transition of the layout the box uses.
2684 * @see elm_box_transition_new()
2685 * @see elm_box_layout_set()
2686 * @see elm_box_layout_transition()
2688 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2691 * Add a new box to the parent
2693 * By default, the box will be in vertical mode and non-homogeneous.
2695 * @param parent The parent object
2696 * @return The new object or NULL if it cannot be created
2698 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2700 * Set the horizontal orientation
2702 * By default, box object arranges their contents vertically from top to
2704 * By calling this function with @p horizontal as EINA_TRUE, the box will
2705 * become horizontal, arranging contents from left to right.
2707 * @note This flag is ignored if a custom layout function is set.
2709 * @param obj The box object
2710 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2711 * EINA_FALSE = vertical)
2713 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2715 * Get the horizontal orientation
2717 * @param obj The box object
2718 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
2720 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2722 * Set the box to arrange its children homogeneously
2724 * If enabled, homogeneous layout makes all items the same size, according
2725 * to the size of the largest of its children.
2727 * @note This flag is ignored if a custom layout function is set.
2729 * @param obj The box object
2730 * @param homogeneous The homogeneous flag
2732 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2734 * Get whether the box is using homogeneous mode or not
2736 * @param obj The box object
2737 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2739 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2740 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2741 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2743 * Add an object to the beginning of the pack list
2745 * Pack @p subobj into the box @p obj, placing it first in the list of
2746 * children objects. The actual position the object will get on screen
2747 * depends on the layout used. If no custom layout is set, it will be at
2748 * the top or left, depending if the box is vertical or horizontal,
2751 * @param obj The box object
2752 * @param subobj The object to add to the box
2754 * @see elm_box_pack_end()
2755 * @see elm_box_pack_before()
2756 * @see elm_box_pack_after()
2757 * @see elm_box_unpack()
2758 * @see elm_box_unpack_all()
2759 * @see elm_box_clear()
2761 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2763 * Add an object at the end of the pack list
2765 * Pack @p subobj into the box @p obj, placing it last in the list of
2766 * children objects. The actual position the object will get on screen
2767 * depends on the layout used. If no custom layout is set, it will be at
2768 * the bottom or right, depending if the box is vertical or horizontal,
2771 * @param obj The box object
2772 * @param subobj The object to add to the box
2774 * @see elm_box_pack_start()
2775 * @see elm_box_pack_before()
2776 * @see elm_box_pack_after()
2777 * @see elm_box_unpack()
2778 * @see elm_box_unpack_all()
2779 * @see elm_box_clear()
2781 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2783 * Adds an object to the box before the indicated object
2785 * This will add the @p subobj to the box indicated before the object
2786 * indicated with @p before. If @p before is not already in the box, results
2787 * are undefined. Before means either to the left of the indicated object or
2788 * above it depending on orientation.
2790 * @param obj The box object
2791 * @param subobj The object to add to the box
2792 * @param before The object before which to add it
2794 * @see elm_box_pack_start()
2795 * @see elm_box_pack_end()
2796 * @see elm_box_pack_after()
2797 * @see elm_box_unpack()
2798 * @see elm_box_unpack_all()
2799 * @see elm_box_clear()
2801 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2803 * Adds an object to the box after the indicated object
2805 * This will add the @p subobj to the box indicated after the object
2806 * indicated with @p after. If @p after is not already in the box, results
2807 * are undefined. After means either to the right of the indicated object or
2808 * below it depending on orientation.
2810 * @param obj The box object
2811 * @param subobj The object to add to the box
2812 * @param after The object after which to add it
2814 * @see elm_box_pack_start()
2815 * @see elm_box_pack_end()
2816 * @see elm_box_pack_before()
2817 * @see elm_box_unpack()
2818 * @see elm_box_unpack_all()
2819 * @see elm_box_clear()
2821 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2823 * Clear the box of all children
2825 * Remove all the elements contained by the box, deleting the respective
2828 * @param obj The box object
2830 * @see elm_box_unpack()
2831 * @see elm_box_unpack_all()
2833 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2837 * Remove the object given by @p subobj from the box @p obj without
2840 * @param obj The box object
2842 * @see elm_box_unpack_all()
2843 * @see elm_box_clear()
2845 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2847 * Remove all items from the box, without deleting them
2849 * Clear the box from all children, but don't delete the respective objects.
2850 * If no other references of the box children exist, the objects will never
2851 * be deleted, and thus the application will leak the memory. Make sure
2852 * when using this function that you hold a reference to all the objects
2853 * in the box @p obj.
2855 * @param obj The box object
2857 * @see elm_box_clear()
2858 * @see elm_box_unpack()
2860 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2862 * Retrieve a list of the objects packed into the box
2864 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2865 * The order of the list corresponds to the packing order the box uses.
2867 * You must free this list with eina_list_free() once you are done with it.
2869 * @param obj The box object
2871 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2873 * Set the space (padding) between the box's elements.
2875 * Extra space in pixels that will be added between a box child and its
2876 * neighbors after its containing cell has been calculated. This padding
2877 * is set for all elements in the box, besides any possible padding that
2878 * individual elements may have through their size hints.
2880 * @param obj The box object
2881 * @param horizontal The horizontal space between elements
2882 * @param vertical The vertical space between elements
2884 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2886 * Get the space (padding) between the box's elements.
2888 * @param obj The box object
2889 * @param horizontal The horizontal space between elements
2890 * @param vertical The vertical space between elements
2892 * @see elm_box_padding_set()
2894 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2896 * Set the alignment of the whole bouding box of contents.
2898 * Sets how the bounding box containing all the elements of the box, after
2899 * their sizes and position has been calculated, will be aligned within
2900 * the space given for the whole box widget.
2902 * @param obj The box object
2903 * @param horizontal The horizontal alignment of elements
2904 * @param vertical The vertical alignment of elements
2906 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2908 * Get the alignment of the whole bouding box of contents.
2910 * @param obj The box object
2911 * @param horizontal The horizontal alignment of elements
2912 * @param vertical The vertical alignment of elements
2914 * @see elm_box_align_set()
2916 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2919 * Set the layout defining function to be used by the box
2921 * Whenever anything changes that requires the box in @p obj to recalculate
2922 * the size and position of its elements, the function @p cb will be called
2923 * to determine what the layout of the children will be.
2925 * Once a custom function is set, everything about the children layout
2926 * is defined by it. The flags set by elm_box_horizontal_set() and
2927 * elm_box_homogeneous_set() no longer have any meaning, and the values
2928 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2929 * layout function to decide if they are used and how. These last two
2930 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2931 * passed to @p cb. The @c Evas_Object the function receives is not the
2932 * Elementary widget, but the internal Evas Box it uses, so none of the
2933 * functions described here can be used on it.
2935 * Any of the layout functions in @c Evas can be used here, as well as the
2936 * special elm_box_layout_transition().
2938 * The final @p data argument received by @p cb is the same @p data passed
2939 * here, and the @p free_data function will be called to free it
2940 * whenever the box is destroyed or another layout function is set.
2942 * Setting @p cb to NULL will revert back to the default layout function.
2944 * @param obj The box object
2945 * @param cb The callback function used for layout
2946 * @param data Data that will be passed to layout function
2947 * @param free_data Function called to free @p data
2949 * @see elm_box_layout_transition()
2951 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);
2953 * Special layout function that animates the transition from one layout to another
2955 * Normally, when switching the layout function for a box, this will be
2956 * reflected immediately on screen on the next render, but it's also
2957 * possible to do this through an animated transition.
2959 * This is done by creating an ::Elm_Box_Transition and setting the box
2960 * layout to this function.
2964 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2965 * evas_object_box_layout_vertical, // start
2966 * NULL, // data for initial layout
2967 * NULL, // free function for initial data
2968 * evas_object_box_layout_horizontal, // end
2969 * NULL, // data for final layout
2970 * NULL, // free function for final data
2971 * anim_end, // will be called when animation ends
2972 * NULL); // data for anim_end function\
2973 * elm_box_layout_set(box, elm_box_layout_transition, t,
2974 * elm_box_transition_free);
2977 * @note This function can only be used with elm_box_layout_set(). Calling
2978 * it directly will not have the expected results.
2980 * @see elm_box_transition_new
2981 * @see elm_box_transition_free
2982 * @see elm_box_layout_set
2984 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2986 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2988 * If you want to animate the change from one layout to another, you need
2989 * to set the layout function of the box to elm_box_layout_transition(),
2990 * passing as user data to it an instance of ::Elm_Box_Transition with the
2991 * necessary information to perform this animation. The free function to
2992 * set for the layout is elm_box_transition_free().
2994 * The parameters to create an ::Elm_Box_Transition sum up to how long
2995 * will it be, in seconds, a layout function to describe the initial point,
2996 * another for the final position of the children and one function to be
2997 * called when the whole animation ends. This last function is useful to
2998 * set the definitive layout for the box, usually the same as the end
2999 * layout for the animation, but could be used to start another transition.
3001 * @param start_layout The layout function that will be used to start the animation
3002 * @param start_layout_data The data to be passed the @p start_layout function
3003 * @param start_layout_free_data Function to free @p start_layout_data
3004 * @param end_layout The layout function that will be used to end the animation
3005 * @param end_layout_free_data The data to be passed the @p end_layout function
3006 * @param end_layout_free_data Function to free @p end_layout_data
3007 * @param transition_end_cb Callback function called when animation ends
3008 * @param transition_end_data Data to be passed to @p transition_end_cb
3009 * @return An instance of ::Elm_Box_Transition
3011 * @see elm_box_transition_new
3012 * @see elm_box_layout_transition
3014 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);
3016 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3018 * This function is mostly useful as the @c free_data parameter in
3019 * elm_box_layout_set() when elm_box_layout_transition().
3021 * @param data The Elm_Box_Transition instance to be freed.
3023 * @see elm_box_transition_new
3024 * @see elm_box_layout_transition
3026 EAPI void elm_box_transition_free(void *data);
3033 * @defgroup Button Button
3035 * @image html img/widget/button/preview-00.png
3036 * @image html img/widget/button/preview-01.png
3037 * @image html img/widget/button/preview-02.png
3039 * This is a push-button. Press it and run some function. It can contain
3040 * a simple label and icon object and it also has an autorepeat feature.
3042 * This widgets emits the following signals:
3043 * @li "clicked": the user clicked the button (press/release).
3044 * @li "repeated": the user pressed the button without releasing it.
3045 * @li "pressed": button was pressed.
3046 * @li "unpressed": button was released after being pressed.
3047 * In all three cases, the @c event parameter of the callback will be
3050 * Also, defined in the default theme, the button has the following styles
3052 * @li default: a normal button.
3053 * @li anchor: Like default, but the button fades away when the mouse is not
3054 * over it, leaving only the text or icon.
3055 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3056 * continuous look across its options.
3057 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3059 * Follow through a complete example @ref button_example_01 "here".
3063 * Add a new button to the parent's canvas
3065 * @param parent The parent object
3066 * @return The new object or NULL if it cannot be created
3068 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3070 * Set the label used in the button
3072 * The passed @p label can be NULL to clean any existing text in it and
3073 * leave the button as an icon only object.
3075 * @param obj The button object
3076 * @param label The text will be written on the button
3077 * @deprecated use elm_object_text_set() instead.
3079 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3081 * Get the label set for the button
3083 * The string returned is an internal pointer and should not be freed or
3084 * altered. It will also become invalid when the button is destroyed.
3085 * The string returned, if not NULL, is a stringshare, so if you need to
3086 * keep it around even after the button is destroyed, you can use
3087 * eina_stringshare_ref().
3089 * @param obj The button object
3090 * @return The text set to the label, or NULL if nothing is set
3091 * @deprecated use elm_object_text_set() instead.
3093 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3095 * Set the icon used for the button
3097 * Setting a new icon will delete any other that was previously set, making
3098 * any reference to them invalid. If you need to maintain the previous
3099 * object alive, unset it first with elm_button_icon_unset().
3101 * @param obj The button object
3102 * @param icon The icon object for the button
3104 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3106 * Get the icon used for the button
3108 * Return the icon object which is set for this widget. If the button is
3109 * destroyed or another icon is set, the returned object will be deleted
3110 * and any reference to it will be invalid.
3112 * @param obj The button object
3113 * @return The icon object that is being used
3115 * @see elm_button_icon_unset()
3117 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3119 * Remove the icon set without deleting it and return the object
3121 * This function drops the reference the button holds of the icon object
3122 * and returns this last object. It is used in case you want to remove any
3123 * icon, or set another one, without deleting the actual object. The button
3124 * will be left without an icon set.
3126 * @param obj The button object
3127 * @return The icon object that was being used
3129 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3131 * Turn on/off the autorepeat event generated when the button is kept pressed
3133 * When off, no autorepeat is performed and buttons emit a normal @c clicked
3134 * signal when they are clicked.
3136 * When on, keeping a button pressed will continuously emit a @c repeated
3137 * signal until the button is released. The time it takes until it starts
3138 * emitting the signal is given by
3139 * elm_button_autorepeat_initial_timeout_set(), and the time between each
3140 * new emission by elm_button_autorepeat_gap_timeout_set().
3142 * @param obj The button object
3143 * @param on A bool to turn on/off the event
3145 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3147 * Get whether the autorepeat feature is enabled
3149 * @param obj The button object
3150 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3152 * @see elm_button_autorepeat_set()
3154 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3156 * Set the initial timeout before the autorepeat event is generated
3158 * Sets the timeout, in seconds, since the button is pressed until the
3159 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3160 * won't be any delay and the even will be fired the moment the button is
3163 * @param obj The button object
3164 * @param t Timeout in seconds
3166 * @see elm_button_autorepeat_set()
3167 * @see elm_button_autorepeat_gap_timeout_set()
3169 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3171 * Get the initial timeout before the autorepeat event is generated
3173 * @param obj The button object
3174 * @return Timeout in seconds
3176 * @see elm_button_autorepeat_initial_timeout_set()
3178 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3180 * Set the interval between each generated autorepeat event
3182 * After the first @c repeated event is fired, all subsequent ones will
3183 * follow after a delay of @p t seconds for each.
3185 * @param obj The button object
3186 * @param t Interval in seconds
3188 * @see elm_button_autorepeat_initial_timeout_set()
3190 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3192 * Get the interval between each generated autorepeat event
3194 * @param obj The button object
3195 * @return Interval in seconds
3197 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3203 * @defgroup File_Selector_Button File Selector Button
3205 * @image html img/widget/fileselector_button/preview-00.png
3206 * @image html img/widget/fileselector_button/preview-01.png
3207 * @image html img/widget/fileselector_button/preview-02.png
3209 * This is a button that, when clicked, creates an Elementary
3210 * window (or inner window) <b> with a @ref Fileselector "file
3211 * selector widget" within</b>. When a file is chosen, the (inner)
3212 * window is closed and the button emits a signal having the
3213 * selected file as it's @c event_info.
3215 * This widget encapsulates operations on its internal file
3216 * selector on its own API. There is less control over its file
3217 * selector than that one would have instatiating one directly.
3219 * The following styles are available for this button:
3222 * @li @c "hoversel_vertical"
3223 * @li @c "hoversel_vertical_entry"
3225 * Smart callbacks one can register to:
3226 * - @c "file,chosen" - the user has selected a path, whose string
3227 * pointer comes as the @c event_info data (a stringshared
3230 * Here is an example on its usage:
3231 * @li @ref fileselector_button_example
3233 * @see @ref File_Selector_Entry for a similar widget.
3238 * Add a new file selector button widget to the given parent
3239 * Elementary (container) object
3241 * @param parent The parent object
3242 * @return a new file selector button widget handle or @c NULL, on
3245 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3248 * Set the label for a given file selector button widget
3250 * @param obj The file selector button widget
3251 * @param label The text label to be displayed on @p obj
3253 * @deprecated use elm_object_text_set() instead.
3255 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3258 * Get the label set for a given file selector button widget
3260 * @param obj The file selector button widget
3261 * @return The button label
3263 * @deprecated use elm_object_text_set() instead.
3265 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3268 * Set the icon on a given file selector button widget
3270 * @param obj The file selector button widget
3271 * @param icon The icon object for the button
3273 * Once the icon object is set, a previously set one will be
3274 * deleted. If you want to keep the latter, use the
3275 * elm_fileselector_button_icon_unset() function.
3277 * @see elm_fileselector_button_icon_get()
3279 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3282 * Get the icon set for a given file selector button widget
3284 * @param obj The file selector button widget
3285 * @return The icon object currently set on @p obj or @c NULL, if
3288 * @see elm_fileselector_button_icon_set()
3290 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3293 * Unset the icon used in a given file selector button widget
3295 * @param obj The file selector button widget
3296 * @return The icon object that was being used on @p obj or @c
3299 * Unparent and return the icon object which was set for this
3302 * @see elm_fileselector_button_icon_set()
3304 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3307 * Set the title for a given file selector button widget's window
3309 * @param obj The file selector button widget
3310 * @param title The title string
3312 * This will change the window's title, when the file selector pops
3313 * out after a click on the button. Those windows have the default
3314 * (unlocalized) value of @c "Select a file" as titles.
3316 * @note It will only take any effect if the file selector
3317 * button widget is @b not under "inwin mode".
3319 * @see elm_fileselector_button_window_title_get()
3321 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3324 * Get the title set for a given file selector button widget's
3327 * @param obj The file selector button widget
3328 * @return Title of the file selector button's window
3330 * @see elm_fileselector_button_window_title_get() for more details
3332 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3335 * Set the size of a given file selector button widget's window,
3336 * holding the file selector itself.
3338 * @param obj The file selector button widget
3339 * @param width The window's width
3340 * @param height The window's height
3342 * @note it will only take any effect if the file selector button
3343 * widget is @b not under "inwin mode". The default size for the
3344 * window (when applicable) is 400x400 pixels.
3346 * @see elm_fileselector_button_window_size_get()
3348 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3351 * Get the size of a given file selector button widget's window,
3352 * holding the file selector itself.
3354 * @param obj The file selector button widget
3355 * @param width Pointer into which to store the width value
3356 * @param height Pointer into which to store the height value
3358 * @note Use @c NULL pointers on the size values you're not
3359 * interested in: they'll be ignored by the function.
3361 * @see elm_fileselector_button_window_size_set(), for more details
3363 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3366 * Set the initial file system path for a given file selector
3369 * @param obj The file selector button widget
3370 * @param path The path string
3372 * It must be a <b>directory</b> path, which will have the contents
3373 * displayed initially in the file selector's view, when invoked
3374 * from @p obj. The default initial path is the @c "HOME"
3375 * environment variable's value.
3377 * @see elm_fileselector_button_path_get()
3379 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3382 * Get the initial file system path set for a given file selector
3385 * @param obj The file selector button widget
3386 * @return path The path string
3388 * @see elm_fileselector_button_path_set() for more details
3390 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3393 * Enable/disable a tree view in the given file selector button
3394 * widget's internal file selector
3396 * @param obj The file selector button widget
3397 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3400 * This has the same effect as elm_fileselector_expandable_set(),
3401 * but now applied to a file selector button's internal file
3404 * @note There's no way to put a file selector button's internal
3405 * file selector in "grid mode", as one may do with "pure" file
3408 * @see elm_fileselector_expandable_get()
3410 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3413 * Get whether tree view is enabled for the given file selector
3414 * button widget's internal file selector
3416 * @param obj The file selector button widget
3417 * @return @c EINA_TRUE if @p obj widget's internal file selector
3418 * is in tree view, @c EINA_FALSE otherwise (and or errors)
3420 * @see elm_fileselector_expandable_set() for more details
3422 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3425 * Set whether a given file selector button widget's internal file
3426 * selector is to display folders only or the directory contents,
3429 * @param obj The file selector button widget
3430 * @param only @c EINA_TRUE to make @p obj widget's internal file
3431 * selector only display directories, @c EINA_FALSE to make files
3432 * to be displayed in it too
3434 * This has the same effect as elm_fileselector_folder_only_set(),
3435 * but now applied to a file selector button's internal file
3438 * @see elm_fileselector_folder_only_get()
3440 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3443 * Get whether a given file selector button widget's internal file
3444 * selector is displaying folders only or the directory contents,
3447 * @param obj The file selector button widget
3448 * @return @c EINA_TRUE if @p obj widget's internal file
3449 * selector is only displaying directories, @c EINA_FALSE if files
3450 * are being displayed in it too (and on errors)
3452 * @see elm_fileselector_button_folder_only_set() for more details
3454 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3457 * Enable/disable the file name entry box where the user can type
3458 * in a name for a file, in a given file selector button widget's
3459 * internal file selector.
3461 * @param obj The file selector button widget
3462 * @param is_save @c EINA_TRUE to make @p obj widget's internal
3463 * file selector a "saving dialog", @c EINA_FALSE otherwise
3465 * This has the same effect as elm_fileselector_is_save_set(),
3466 * but now applied to a file selector button's internal file
3469 * @see elm_fileselector_is_save_get()
3471 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3474 * Get whether the given file selector button widget's internal
3475 * file selector is in "saving dialog" mode
3477 * @param obj The file selector button widget
3478 * @return @c EINA_TRUE, if @p obj widget's internal file selector
3479 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3482 * @see elm_fileselector_button_is_save_set() for more details
3484 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3487 * Set whether a given file selector button widget's internal file
3488 * selector will raise an Elementary "inner window", instead of a
3489 * dedicated Elementary window. By default, it won't.
3491 * @param obj The file selector button widget
3492 * @param value @c EINA_TRUE to make it use an inner window, @c
3493 * EINA_TRUE to make it use a dedicated window
3495 * @see elm_win_inwin_add() for more information on inner windows
3496 * @see elm_fileselector_button_inwin_mode_get()
3498 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3501 * Get whether a given file selector button widget's internal file
3502 * selector will raise an Elementary "inner window", instead of a
3503 * dedicated Elementary window.
3505 * @param obj The file selector button widget
3506 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3507 * if it will use a dedicated window
3509 * @see elm_fileselector_button_inwin_mode_set() for more details
3511 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3518 * @defgroup File_Selector_Entry File Selector Entry
3520 * This is an entry made to be filled with or display a <b>file
3521 * system path string</b>. Besides the entry itself, the widget has
3522 * a @ref File_Selector_Button "file selector button" on its side,
3523 * which will raise an internal @ref Fileselector "file selector widget",
3524 * when clicked, for path selection aided by file system
3527 * This file selector may appear in an Elementary window or in an
3528 * inner window. When a file is chosen from it, the (inner) window
3529 * is closed and the selected file's path string is exposed both as
3530 * an smart event and as the new text on the entry.
3532 * This widget encapsulates operations on its internal file
3533 * selector on its own API. There is less control over its file
3534 * selector than that one would have instatiating one directly.
3536 * Smart callbacks one can register to:
3537 * - @c "changed" - The text within the entry was changed
3538 * - @c "activated" - The entry has had editing finished and
3539 * changes are to be "committed"
3540 * - @c "press" - The entry has been clicked
3541 * - @c "longpressed" - The entry has been clicked (and held) for a
3543 * - @c "clicked" - The entry has been clicked
3544 * - @c "clicked,double" - The entry has been double clicked
3545 * - @c "focused" - The entry has received focus
3546 * - @c "unfocused" - The entry has lost focus
3547 * - @c "selection,paste" - A paste action has occurred on the
3549 * - @c "selection,copy" - A copy action has occurred on the entry
3550 * - @c "selection,cut" - A cut action has occurred on the entry
3551 * - @c "unpressed" - The file selector entry's button was released
3552 * after being pressed.
3553 * - @c "file,chosen" - The user has selected a path via the file
3554 * selector entry's internal file selector, whose string pointer
3555 * comes as the @c event_info data (a stringshared string)
3557 * Here is an example on its usage:
3558 * @li @ref fileselector_entry_example
3560 * @see @ref File_Selector_Button for a similar widget.
3565 * Add a new file selector entry widget to the given parent
3566 * Elementary (container) object
3568 * @param parent The parent object
3569 * @return a new file selector entry widget handle or @c NULL, on
3572 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3575 * Set the label for a given file selector entry widget's button
3577 * @param obj The file selector entry widget
3578 * @param label The text label to be displayed on @p obj widget's
3581 * @deprecated use elm_object_text_set() instead.
3583 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3586 * Get the label set for a given file selector entry widget's button
3588 * @param obj The file selector entry widget
3589 * @return The widget button's label
3591 * @deprecated use elm_object_text_set() instead.
3593 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3596 * Set the icon on a given file selector entry widget's button
3598 * @param obj The file selector entry widget
3599 * @param icon The icon object for the entry's button
3601 * Once the icon object is set, a previously set one will be
3602 * deleted. If you want to keep the latter, use the
3603 * elm_fileselector_entry_button_icon_unset() function.
3605 * @see elm_fileselector_entry_button_icon_get()
3607 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3610 * Get the icon set for a given file selector entry widget's button
3612 * @param obj The file selector entry widget
3613 * @return The icon object currently set on @p obj widget's button
3614 * or @c NULL, if none is
3616 * @see elm_fileselector_entry_button_icon_set()
3618 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3621 * Unset the icon used in a given file selector entry widget's
3624 * @param obj The file selector entry widget
3625 * @return The icon object that was being used on @p obj widget's
3626 * button or @c NULL, on errors
3628 * Unparent and return the icon object which was set for this
3631 * @see elm_fileselector_entry_button_icon_set()
3633 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3636 * Set the title for a given file selector entry widget's window
3638 * @param obj The file selector entry widget
3639 * @param title The title string
3641 * This will change the window's title, when the file selector pops
3642 * out after a click on the entry's button. Those windows have the
3643 * default (unlocalized) value of @c "Select a file" as titles.
3645 * @note It will only take any effect if the file selector
3646 * entry widget is @b not under "inwin mode".
3648 * @see elm_fileselector_entry_window_title_get()
3650 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3653 * Get the title set for a given file selector entry widget's
3656 * @param obj The file selector entry widget
3657 * @return Title of the file selector entry's window
3659 * @see elm_fileselector_entry_window_title_get() for more details
3661 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3664 * Set the size of a given file selector entry widget's window,
3665 * holding the file selector itself.
3667 * @param obj The file selector entry widget
3668 * @param width The window's width
3669 * @param height The window's height
3671 * @note it will only take any effect if the file selector entry
3672 * widget is @b not under "inwin mode". The default size for the
3673 * window (when applicable) is 400x400 pixels.
3675 * @see elm_fileselector_entry_window_size_get()
3677 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3680 * Get the size of a given file selector entry widget's window,
3681 * holding the file selector itself.
3683 * @param obj The file selector entry widget
3684 * @param width Pointer into which to store the width value
3685 * @param height Pointer into which to store the height value
3687 * @note Use @c NULL pointers on the size values you're not
3688 * interested in: they'll be ignored by the function.
3690 * @see elm_fileselector_entry_window_size_set(), for more details
3692 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3695 * Set the initial file system path and the entry's path string for
3696 * a given file selector entry widget
3698 * @param obj The file selector entry widget
3699 * @param path The path string
3701 * It must be a <b>directory</b> path, which will have the contents
3702 * displayed initially in the file selector's view, when invoked
3703 * from @p obj. The default initial path is the @c "HOME"
3704 * environment variable's value.
3706 * @see elm_fileselector_entry_path_get()
3708 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3711 * Get the entry's path string for a given file selector entry
3714 * @param obj The file selector entry widget
3715 * @return path The path string
3717 * @see elm_fileselector_entry_path_set() for more details
3719 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3722 * Enable/disable a tree view in the given file selector entry
3723 * widget's internal file selector
3725 * @param obj The file selector entry widget
3726 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3729 * This has the same effect as elm_fileselector_expandable_set(),
3730 * but now applied to a file selector entry's internal file
3733 * @note There's no way to put a file selector entry's internal
3734 * file selector in "grid mode", as one may do with "pure" file
3737 * @see elm_fileselector_expandable_get()
3739 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3742 * Get whether tree view is enabled for the given file selector
3743 * entry widget's internal file selector
3745 * @param obj The file selector entry widget
3746 * @return @c EINA_TRUE if @p obj widget's internal file selector
3747 * is in tree view, @c EINA_FALSE otherwise (and or errors)
3749 * @see elm_fileselector_expandable_set() for more details
3751 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3754 * Set whether a given file selector entry widget's internal file
3755 * selector is to display folders only or the directory contents,
3758 * @param obj The file selector entry widget
3759 * @param only @c EINA_TRUE to make @p obj widget's internal file
3760 * selector only display directories, @c EINA_FALSE to make files
3761 * to be displayed in it too
3763 * This has the same effect as elm_fileselector_folder_only_set(),
3764 * but now applied to a file selector entry's internal file
3767 * @see elm_fileselector_folder_only_get()
3769 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3772 * Get whether a given file selector entry widget's internal file
3773 * selector is displaying folders only or the directory contents,
3776 * @param obj The file selector entry widget
3777 * @return @c EINA_TRUE if @p obj widget's internal file
3778 * selector is only displaying directories, @c EINA_FALSE if files
3779 * are being displayed in it too (and on errors)
3781 * @see elm_fileselector_entry_folder_only_set() for more details
3783 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3786 * Enable/disable the file name entry box where the user can type
3787 * in a name for a file, in a given file selector entry widget's
3788 * internal file selector.
3790 * @param obj The file selector entry widget
3791 * @param is_save @c EINA_TRUE to make @p obj widget's internal
3792 * file selector a "saving dialog", @c EINA_FALSE otherwise
3794 * This has the same effect as elm_fileselector_is_save_set(),
3795 * but now applied to a file selector entry's internal file
3798 * @see elm_fileselector_is_save_get()
3800 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3803 * Get whether the given file selector entry widget's internal
3804 * file selector is in "saving dialog" mode
3806 * @param obj The file selector entry widget
3807 * @return @c EINA_TRUE, if @p obj widget's internal file selector
3808 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3811 * @see elm_fileselector_entry_is_save_set() for more details
3813 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3816 * Set whether a given file selector entry widget's internal file
3817 * selector will raise an Elementary "inner window", instead of a
3818 * dedicated Elementary window. By default, it won't.
3820 * @param obj The file selector entry widget
3821 * @param value @c EINA_TRUE to make it use an inner window, @c
3822 * EINA_TRUE to make it use a dedicated window
3824 * @see elm_win_inwin_add() for more information on inner windows
3825 * @see elm_fileselector_entry_inwin_mode_get()
3827 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3830 * Get whether a given file selector entry widget's internal file
3831 * selector will raise an Elementary "inner window", instead of a
3832 * dedicated Elementary window.
3834 * @param obj The file selector entry widget
3835 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3836 * if it will use a dedicated window
3838 * @see elm_fileselector_entry_inwin_mode_set() for more details
3840 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3843 * Set the initial file system path for a given file selector entry
3846 * @param obj The file selector entry widget
3847 * @param path The path string
3849 * It must be a <b>directory</b> path, which will have the contents
3850 * displayed initially in the file selector's view, when invoked
3851 * from @p obj. The default initial path is the @c "HOME"
3852 * environment variable's value.
3854 * @see elm_fileselector_entry_path_get()
3856 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3859 * Get the parent directory's path to the latest file selection on
3860 * a given filer selector entry widget
3862 * @param obj The file selector object
3863 * @return The (full) path of the directory of the last selection
3864 * on @p obj widget, a @b stringshared string
3866 * @see elm_fileselector_entry_path_set()
3868 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3874 /* scroller policy */
3875 typedef enum _Elm_Scroller_Policy
3877 ELM_SCROLLER_POLICY_AUTO = 0,
3878 ELM_SCROLLER_POLICY_ON,
3879 ELM_SCROLLER_POLICY_OFF,
3880 ELM_SCROLLER_POLICY_LAST
3881 } Elm_Scroller_Policy;
3883 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3884 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3885 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3886 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3887 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3888 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3889 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);
3890 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3891 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3892 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);
3893 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3894 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3895 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3896 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3897 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3898 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);
3899 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3900 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
3901 /* smart callbacks called:
3902 * "edge,left" - the left edge of the content has been reached
3903 * "edge,right" - the right edge of the content has been reached
3904 * "edge,top" - the top edge of the content has been reached
3905 * "edge,bottom" - the bottom edge of the content has been reached
3906 * "scroll" - the content has been scrolled (moved)
3907 * "scroll,anim,start" - scrolling animation has started
3908 * "scroll,anim,stop" - scrolling animation has stopped
3909 * "scroll,drag,start" - dragging the contents around has started
3910 * "scroll,drag,stop" - dragging the contents around has stopped
3914 * @defgroup Label Label
3916 * @image html img/widget/label/preview-00.png
3917 * @image latex img/widget/label/preview-00.eps
3919 * @brief Widget to display text, with simple html-like markup.
3921 * The Label widget @b doesn't allow text to overflow its boundaries, if the
3922 * text doesn't fit the geometry of the label it will be ellipsized or be
3923 * cut. Elementary provides several themes for this widget:
3924 * @li default - No animation
3925 * @li marker - Centers the text in the label and make it bold by default
3926 * @li slide_long - The entire text appears from the right of the screen and
3927 * slides until it disappears in the left of the screen(reappering on the
3929 * @li slide_short - The text appears in the left of the label and slides to
3930 * the right to show the overflow. When all of the text has been shown the
3931 * position is reset.
3932 * @li slide_bounce - The text appears in the left of the label and slides to
3933 * the right to show the overflow. When all of the text has been shown the
3934 * animation reverses, moving the text to the left.
3936 * Custom themes can of course invent new markup tags and style them any way
3939 * See @ref tutorial_label for a demonstration of how to use a label widget.
3943 * @brief Add a new label to the parent
3945 * @param parent The parent object
3946 * @return The new object or NULL if it cannot be created
3948 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3950 * @brief Set the label on the label object
3952 * @param obj The label object
3953 * @param label The label will be used on the label object
3954 * @deprecated See elm_object_text_set()
3956 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 */
3958 * @brief Get the label used on the label object
3960 * @param obj The label object
3961 * @return The string inside the label
3962 * @deprecated See elm_object_text_get()
3964 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3966 * @brief Set the wrapping behavior of the label
3968 * @param obj The label object
3969 * @param wrap To wrap text or not
3971 * By default no wrapping is done. Possible values for @p wrap are:
3972 * @li ELM_WRAP_NONE - No wrapping
3973 * @li ELM_WRAP_CHAR - wrap between characters
3974 * @li ELM_WRAP_WORD - wrap between words
3975 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
3977 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3979 * @brief Get the wrapping behavior of the label
3981 * @param obj The label object
3984 * @see elm_label_line_wrap_set()
3986 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3988 * @brief Set wrap width of the label
3990 * @param obj The label object
3991 * @param w The wrap width in pixels at a minimum where words need to wrap
3993 * This function sets the maximum width size hint of the label.
3995 * @warning This is only relevant if the label is inside a container.
3997 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3999 * @brief Get wrap width of the label
4001 * @param obj The label object
4002 * @return The wrap width in pixels at a minimum where words need to wrap
4004 * @see elm_label_wrap_width_set()
4006 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4008 * @brief Set wrap height of the label
4010 * @param obj The label object
4011 * @param h The wrap height in pixels at a minimum where words need to wrap
4013 * This function sets the maximum height size hint of the label.
4015 * @warning This is only relevant if the label is inside a container.
4017 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
4019 * @brief get wrap width of the label
4021 * @param obj The label object
4022 * @return The wrap height in pixels at a minimum where words need to wrap
4024 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4026 * @brief Set the font size on the label object.
4028 * @param obj The label object
4029 * @param size font size
4031 * @warning NEVER use this. It is for hyper-special cases only. use styles
4032 * instead. e.g. "big", "medium", "small" - or better name them by use:
4033 * "title", "footnote", "quote" etc.
4035 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
4037 * @brief Set the text color on the label object
4039 * @param obj The label object
4040 * @param r Red property background color of The label object
4041 * @param g Green property background color of The label object
4042 * @param b Blue property background color of The label object
4043 * @param a Alpha property background color of The label object
4045 * @warning NEVER use this. It is for hyper-special cases only. use styles
4046 * instead. e.g. "big", "medium", "small" - or better name them by use:
4047 * "title", "footnote", "quote" etc.
4049 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);
4051 * @brief Set the text align on the label object
4053 * @param obj The label object
4054 * @param align align mode ("left", "center", "right")
4056 * @warning NEVER use this. It is for hyper-special cases only. use styles
4057 * instead. e.g. "big", "medium", "small" - or better name them by use:
4058 * "title", "footnote", "quote" etc.
4060 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
4062 * @brief Set background color of the label
4064 * @param obj The label object
4065 * @param r Red property background color of The label object
4066 * @param g Green property background color of The label object
4067 * @param b Blue property background color of The label object
4068 * @param a Alpha property background alpha of The label object
4070 * @warning NEVER use this. It is for hyper-special cases only. use styles
4071 * instead. e.g. "big", "medium", "small" - or better name them by use:
4072 * "title", "footnote", "quote" etc.
4074 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);
4076 * @brief Set the ellipsis behavior of the label
4078 * @param obj The label object
4079 * @param ellipsis To ellipsis text or not
4081 * If set to true and the text doesn't fit in the label an ellipsis("...")
4082 * will be shown at the end of the widget.
4084 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
4085 * choosen wrap method was ELM_WRAP_WORD.
4087 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
4089 * @brief Set the text slide of the label
4091 * @param obj The label object
4092 * @param slide To start slide or stop
4094 * If set to true the text of the label will slide throught the length of
4097 * @warning This must be called before elm_label_slide_set().
4098 * @warning This only work with the themes "slide_short", "slide_long" and
4101 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
4103 * @brief Get the text slide mode of the label
4105 * @param obj The label object
4106 * @return slide slide mode value
4108 * @see elm_label_slide_set()
4110 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4112 * @brief Set the slide duration(speed) of the label
4114 * @param obj The label object
4115 * @return The duration in seconds in moving text from slide begin position
4116 * to slide end position
4118 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
4120 * @brief Get the slide duration(speed) of the label
4122 * @param obj The label object
4123 * @return The duration time in moving text from slide begin position to slide end position
4125 * @see elm_label_slide_duration_set()
4127 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4133 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4134 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4135 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4136 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4137 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4139 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
4140 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
4141 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4142 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
4144 /* smart callbacks called:
4145 * "changed" - Whenever the toggle value has been changed. Is not called
4146 * until the toggle is released by the cursor (assuming it has been triggered
4147 * by the cursor in the first place).
4151 * @page tutorial_frame Frame example
4152 * @dontinclude frame_example_01.c
4154 * In this example we are going to create 4 Frames with different styles and
4155 * add a rectangle of different color in each.
4157 * We start we the usual setup code:
4160 * And then create one rectangle:
4163 * To add it in our first frame, which since it doesn't have it's style
4164 * specifically set uses the default style:
4167 * And then create another rectangle:
4170 * To add it in our second frame, which uses the "pad_small" style, note that
4171 * even tough we are setting a text for this frame it won't be show, only the
4172 * default style shows the Frame's title:
4174 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
4175 * very similar, their only difference is the size of the empty area around
4176 * the content of the frame.
4178 * And then create yet another rectangle:
4181 * To add it in our third frame, which uses the "outdent_top" style, note
4182 * that even tough we are setting a text for this frame it won't be show,
4183 * only the default style shows the Frame's title:
4186 * And then create one last rectangle:
4189 * To add it in our fourth and final frame, which uses the "outdent_bottom"
4190 * style, note that even tough we are setting a text for this frame it won't
4191 * be show, only the default style shows the Frame's title:
4194 * And now we are left with just some more setup code:
4197 * Our example will look like this:
4199 * @image html screenshots/frame_example_01.png
4200 * @image latex screenshots/frame_example_01.eps width=\textwidth
4202 * @example frame_example_01.c
4205 * @defgroup Frame Frame
4207 * @image html img/widget/frame/preview-00.png
4208 * @image latex img/widget/frame/preview-00.eps
4210 * @brief Frame is a widget that holds some content and has a title.
4212 * The default look is a frame with a title, but Frame supports multple
4220 * @li outdent_bottom
4222 * Of all this styles only default shows the title. Frame emits no signals.
4224 * For a detailed example see the @ref tutorial_frame.
4229 * @brief Add a new frame to the parent
4231 * @param parent The parent object
4232 * @return The new object or NULL if it cannot be created
4234 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4236 * @brief Set the frame label
4238 * @param obj The frame object
4239 * @param label The label of this frame object
4241 * @deprecated use elm_object_text_set() instead.
4243 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4245 * @brief Get the frame label
4247 * @param obj The frame object
4249 * @return The label of this frame objet or NULL if unable to get frame
4251 * @deprecated use elm_object_text_get() instead.
4253 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4255 * @brief Set the content of the frame widget
4257 * Once the content object is set, a previously set one will be deleted.
4258 * If you want to keep that old content object, use the
4259 * elm_frame_content_unset() function.
4261 * @param obj The frame object
4262 * @param content The content will be filled in this frame object
4264 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4266 * @brief Get the content of the frame widget
4268 * Return the content object which is set for this widget
4270 * @param obj The frame object
4271 * @return The content that is being used
4273 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * @brief Unset the content of the frame widget
4277 * Unparent and return the content object which was set for this widget
4279 * @param obj The frame object
4280 * @return The content that was being used
4282 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4288 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4289 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4290 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4291 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4292 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4293 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4294 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4295 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4296 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4297 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
4298 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4299 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4302 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
4303 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
4304 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
4305 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
4306 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
4307 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
4308 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
4310 struct _Elm_Gengrid_Item_Class
4312 const char *item_style;
4313 struct _Elm_Gengrid_Item_Class_Func
4315 GridItemLabelGetFunc label_get;
4316 GridItemIconGetFunc icon_get;
4317 GridItemStateGetFunc state_get;
4318 GridItemDelFunc del;
4322 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4323 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4324 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4325 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
4326 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
4328 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
4329 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4331 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4332 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4333 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4334 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4335 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4336 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4337 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4338 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
4339 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
4340 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
4341 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
4342 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4344 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4345 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4347 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4348 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4349 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4350 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4351 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4352 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4353 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
4354 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4355 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
4356 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
4357 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4358 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4359 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4360 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4361 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4362 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4363 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4365 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
4366 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);
4367 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4368 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
4369 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4370 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4371 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4372 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4373 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
4374 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4375 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4376 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4378 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4379 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4380 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4382 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);
4383 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);
4384 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);
4385 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);
4386 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);
4387 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);
4388 /* smart callbacks called:
4390 * selected - User has selected an item.
4391 * unselected - User has unselected an item.
4392 * clicked,double - User has double-clicked or pressed enter on an item.
4393 * realized - An evas object for an item was built.
4394 * unrealized - An evas object for an item was deleted.
4395 * changed - An item has been added, removed, resized or moved,
4396 * or gengrid has been resized or horizontal property has been changed.
4397 * scroll - the content has been scrolled (moved).
4398 * "scroll,drag,start" - dragging the contents around has started.
4399 * "scroll,drag,stop" - dragging the contents around has stopped.
4400 * drag - Gengrid is being dragged.
4401 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
4402 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
4403 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
4404 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
4405 * "drag,stop" - Gengrid is not being dragged.
4409 * @defgroup Clock Clock
4411 * @image html img/widget/clock/preview-00.png
4412 * @image latex img/widget/clock/preview-00.eps
4414 * This is a @b digital clock widget. In its default theme, it has a
4415 * vintage "flipping numbers clock" appearance, which will animate
4416 * sheets of individual algarisms individually as time goes by.
4418 * A newly created clock will fetch system's time (already
4419 * considering local time adjustments) to start with, and will tick
4420 * accondingly. It may or may not show seconds.
4422 * Clocks have an @b edition mode. When in it, the sheets will
4423 * display extra arrow indications on the top and bottom and the
4424 * user may click on them to raise or lower the time values. After
4425 * it's told to exit edition mode, it will keep ticking with that
4426 * new time set (it keeps the difference from local time).
4428 * Also, when under edition mode, user clicks on the cited arrows
4429 * which are @b held for some time will make the clock to flip the
4430 * sheet, thus editing the time, continuosly and automatically for
4431 * the user. The interval between sheet flips will keep growing in
4432 * time, so that it helps the user to reach a time which is distant
4435 * The time display is, by default, in military mode (24h), but an
4436 * am/pm indicator may be optionally shown, too, when it will
4439 * Smart callbacks one can register to:
4440 * - "changed" - the clock's user changed the time
4442 * Here is an example on its usage:
4443 * @li @ref clock_example
4452 * Identifiers for which clock digits should be editable, when a
4453 * clock widget is in edition mode. Values may be ORed together to
4454 * make a mask, naturally.
4456 * @see elm_clock_edit_set()
4457 * @see elm_clock_digit_edit_set()
4459 typedef enum _Elm_Clock_Digedit
4461 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
4462 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
4463 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
4464 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
4465 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
4466 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
4467 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
4468 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
4469 } Elm_Clock_Digedit;
4472 * Add a new clock widget to the given parent Elementary
4473 * (container) object
4475 * @param parent The parent object
4476 * @return a new clock widget handle or @c NULL, on errors
4478 * This function inserts a new clock widget on the canvas.
4482 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4485 * Set a clock widget's time, programmatically
4487 * @param obj The clock widget object
4488 * @param hrs The hours to set
4489 * @param min The minutes to set
4490 * @param sec The secondes to set
4492 * This function updates the time that is showed by the clock
4495 * Values @b must be set within the following ranges:
4496 * - 0 - 23, for hours
4497 * - 0 - 59, for minutes
4498 * - 0 - 59, for seconds,
4500 * even if the clock is not in "military" mode.
4502 * @warning The behavior for values set out of those ranges is @b
4507 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
4510 * Get a clock widget's time values
4512 * @param obj The clock object
4513 * @param[out] hrs Pointer to the variable to get the hours value
4514 * @param[out] min Pointer to the variable to get the minutes value
4515 * @param[out] sec Pointer to the variable to get the seconds value
4517 * This function gets the time set for @p obj, returning
4518 * it on the variables passed as the arguments to function
4520 * @note Use @c NULL pointers on the time values you're not
4521 * interested in: they'll be ignored by the function.
4525 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
4528 * Set whether a given clock widget is under <b>edition mode</b> or
4529 * under (default) displaying-only mode.
4531 * @param obj The clock object
4532 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
4533 * put it back to "displaying only" mode
4535 * This function makes a clock's time to be editable or not <b>by
4536 * user interaction</b>. When in edition mode, clocks @b stop
4537 * ticking, until one brings them back to canonical mode. The
4538 * elm_clock_digit_edit_set() function will influence which digits
4539 * of the clock will be editable. By default, all of them will be
4540 * (#ELM_CLOCK_NONE).
4542 * @note am/pm sheets, if being shown, will @b always be editable
4543 * under edition mode.
4545 * @see elm_clock_edit_get()
4549 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4552 * Retrieve whether a given clock widget is under <b>edition
4553 * mode</b> or under (default) displaying-only mode.
4555 * @param obj The clock object
4556 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
4559 * This function retrieves whether the clock's time can be edited
4560 * or not by user interaction.
4562 * @see elm_clock_edit_set() for more details
4566 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4569 * Set what digits of the given clock widget should be editable
4570 * when in edition mode.
4572 * @param obj The clock object
4573 * @param digedit Bit mask indicating the digits to be editable
4574 * (values in #Elm_Clock_Digedit).
4576 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
4577 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
4580 * @see elm_clock_digit_edit_get()
4584 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
4587 * Retrieve what digits of the given clock widget should be
4588 * editable when in edition mode.
4590 * @param obj The clock object
4591 * @return Bit mask indicating the digits to be editable
4592 * (values in #Elm_Clock_Digedit).
4594 * @see elm_clock_digit_edit_set() for more details
4598 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4601 * Set if the given clock widget must show hours in military or
4604 * @param obj The clock object
4605 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
4608 * This function sets if the clock must show hours in military or
4609 * am/pm mode. In some countries like Brazil the military mode
4610 * (00-24h-format) is used, in opposition to the USA, where the
4611 * am/pm mode is more commonly used.
4613 * @see elm_clock_show_am_pm_get()
4617 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
4620 * Get if the given clock widget shows hours in military or am/pm
4623 * @param obj The clock object
4624 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
4627 * This function gets if the clock shows hours in military or am/pm
4630 * @see elm_clock_show_am_pm_set() for more details
4634 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4637 * Set if the given clock widget must show time with seconds or not
4639 * @param obj The clock object
4640 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
4642 * This function sets if the given clock must show or not elapsed
4643 * seconds. By default, they are @b not shown.
4645 * @see elm_clock_show_seconds_get()
4649 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
4652 * Get whether the given clock widget is showing time with seconds
4655 * @param obj The clock object
4656 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
4658 * This function gets whether @p obj is showing or not the elapsed
4661 * @see elm_clock_show_seconds_set()
4665 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4668 * Set the interval on time updates for an user mouse button hold
4669 * on clock widgets' time edition.
4671 * @param obj The clock object
4672 * @param interval The (first) interval value in seconds
4674 * This interval value is @b decreased while the user holds the
4675 * mouse pointer either incrementing or decrementing a given the
4676 * clock digit's value.
4678 * This helps the user to get to a given time distant from the
4679 * current one easier/faster, as it will start to flip quicker and
4680 * quicker on mouse button holds.
4682 * The calculation for the next flip interval value, starting from
4683 * the one set with this call, is the previous interval divided by
4684 * 1.05, so it decreases a little bit.
4686 * The default starting interval value for automatic flips is
4689 * @see elm_clock_interval_get()
4693 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4696 * Get the interval on time updates for an user mouse button hold
4697 * on clock widgets' time edition.
4699 * @param obj The clock object
4700 * @return The (first) interval value, in seconds, set on it
4702 * @see elm_clock_interval_set() for more details
4706 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4713 * @defgroup Layout Layout
4715 * @image html img/widget/layout/preview-00.png
4716 * @image latex img/widget/layout/preview-00.eps width=\textwidth
4718 * @image html img/layout-predefined.png
4719 * @image latex img/layout-predefined.eps width=\textwidth
4721 * This is a container widget that takes a standard Edje design file and
4722 * wraps it very thinly in a widget.
4724 * An Edje design (theme) file has a very wide range of possibilities to
4725 * describe the behavior of elements added to the Layout. Check out the Edje
4726 * documentation and the EDC reference to get more information about what can
4727 * be done with Edje.
4729 * Just like @ref List, @ref Box, and other container widgets, any
4730 * object added to the Layout will become its child, meaning that it will be
4731 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
4733 * The Layout widget can contain as many Contents, Boxes or Tables as
4734 * described in its theme file. For instance, objects can be added to
4735 * different Tables by specifying the respective Table part names. The same
4736 * is valid for Content and Box.
4738 * The objects added as child of the Layout will behave as described in the
4739 * part description where they were added. There are 3 possible types of
4740 * parts where a child can be added:
4742 * @section secContent Content (SWALLOW part)
4744 * Only one object can be added to the @c SWALLOW part (but you still can
4745 * have many @c SWALLOW parts and one object on each of them). Use the @c
4746 * elm_layout_content_* set of functions to set, retrieve and unset objects
4747 * as content of the @c SWALLOW. After being set to this part, the object
4748 * size, position, visibility, clipping and other description properties
4749 * will be totally controled by the description of the given part (inside
4750 * the Edje theme file).
4752 * One can use @c evas_object_size_hint_* functions on the child to have some
4753 * kind of control over its behavior, but the resulting behavior will still
4754 * depend heavily on the @c SWALLOW part description.
4756 * The Edje theme also can change the part description, based on signals or
4757 * scripts running inside the theme. This change can also be animated. All of
4758 * this will affect the child object set as content accordingly. The object
4759 * size will be changed if the part size is changed, it will animate move if
4760 * the part is moving, and so on.
4762 * The following picture demonstrates a Layout widget with a child object
4763 * added to its @c SWALLOW:
4765 * @image html layout_swallow.png
4766 * @image latex layout_swallow.png width=\textwidth
4768 * @section secBox Box (BOX part)
4770 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
4771 * allows one to add objects to the box and have them distributed along its
4772 * area, accordingly to the specified @a layout property (now by @a layout we
4773 * mean the chosen layouting design of the Box, not the Layout widget
4776 * A similar effect for having a box with its position, size and other things
4777 * controled by the Layout theme would be to create an Elementary @ref Box
4778 * widget and add it as a Content in the @c SWALLOW part.
4780 * The main difference of using the Layout Box is that its behavior, the box
4781 * properties like layouting format, padding, align, etc. will be all
4782 * controled by the theme. This means, for example, that a signal could be
4783 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
4784 * handled the signal by changing the box padding, or align, or both. Using
4785 * the Elementary @ref Box widget is not necessarily harder or easier, it
4786 * just depends on the circunstances and requirements.
4788 * The Layout Box can be used through the @c elm_layout_box_* set of
4791 * The following picture demonstrates a Layout widget with many child objects
4792 * added to its @c BOX part:
4794 * @image html layout_box.png
4795 * @image latex layout_box.png width=\textwidth
4797 * @section secTable Table (TABLE part)
4799 * Just like the @ref secBox, the Layout Table is very similar to the
4800 * Elementary @ref Table widget. It allows one to add objects to the Table
4801 * specifying the row and column where the object should be added, and any
4802 * column or row span if necessary.
4804 * Again, we could have this design by adding a @ref Table widget to the @c
4805 * SWALLOW part using elm_layout_content_set(). The same difference happens
4806 * here when choosing to use the Layout Table (a @c TABLE part) instead of
4807 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
4809 * The Layout Table can be used through the @c elm_layout_table_* set of
4812 * The following picture demonstrates a Layout widget with many child objects
4813 * added to its @c TABLE part:
4815 * @image html layout_table.png
4816 * @image latex layout_table.png width=\textwidth
4818 * @section secPredef Predefined Layouts
4820 * Another interesting thing about the Layout widget is that it offers some
4821 * predefined themes that come with the default Elementary theme. These
4822 * themes can be set by the call elm_layout_theme_set(), and provide some
4823 * basic functionality depending on the theme used.
4825 * Most of them already send some signals, some already provide a toolbar or
4826 * back and next buttons.
4828 * These are available predefined theme layouts. All of them have class = @c
4829 * layout, group = @c application, and style = one of the following options:
4831 * @li @c toolbar-content - application with toolbar and main content area
4832 * @li @c toolbar-content-back - application with toolbar and main content
4833 * area with a back button and title area
4834 * @li @c toolbar-content-back-next - application with toolbar and main
4835 * content area with a back and next buttons and title area
4836 * @li @c content-back - application with a main content area with a back
4837 * button and title area
4838 * @li @c content-back-next - application with a main content area with a
4839 * back and next buttons and title area
4840 * @li @c toolbar-vbox - application with toolbar and main content area as a
4842 * @li @c toolbar-table - application with toolbar and main content area as a
4845 * @section secExamples Examples
4847 * Some examples of the Layout widget can be found here:
4848 * @li @ref layout_example_01
4849 * @li @ref layout_example_02
4850 * @li @ref layout_example_03
4851 * @li @ref layout_example_edc
4856 * Add a new layout to the parent
4858 * @param parent The parent object
4859 * @return The new object or NULL if it cannot be created
4861 * @see elm_layout_file_set()
4862 * @see elm_layout_theme_set()
4866 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4868 * Set the file that will be used as layout
4870 * @param obj The layout object
4871 * @param file The path to file (edj) that will be used as layout
4872 * @param group The group that the layout belongs in edje file
4874 * @return (1 = success, 0 = error)
4878 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4880 * Set the edje group from the elementary theme that will be used as layout
4882 * @param obj The layout object
4883 * @param clas the clas of the group
4884 * @param group the group
4885 * @param style the style to used
4887 * @return (1 = success, 0 = error)
4891 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
4893 * Set the layout content.
4895 * @param obj The layout object
4896 * @param swallow The swallow part name in the edje file
4897 * @param content The child that will be added in this layout object
4899 * Once the content object is set, a previously set one will be deleted.
4900 * If you want to keep that old content object, use the
4901 * elm_layout_content_unset() function.
4903 * @note In an Edje theme, the part used as a content container is called @c
4904 * SWALLOW. This is why the parameter name is called @p swallow, but it is
4905 * expected to be a part name just like the second parameter of
4906 * elm_layout_box_append().
4908 * @see elm_layout_box_append()
4909 * @see elm_layout_content_get()
4910 * @see elm_layout_content_unset()
4915 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4917 * Get the child object in the given content part.
4919 * @param obj The layout object
4920 * @param swallow The SWALLOW part to get its content
4922 * @return The swallowed object or NULL if none or an error occurred
4924 * @see elm_layout_content_set()
4928 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4930 * Unset the layout content.
4932 * @param obj The layout object
4933 * @param swallow The swallow part name in the edje file
4934 * @return The content that was being used
4936 * Unparent and return the content object which was set for this part.
4938 * @see elm_layout_content_set()
4942 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4944 * Set the text of the given part
4946 * @param obj The layout object
4947 * @param part The TEXT part where to set the text
4948 * @param text The text to set
4951 * @deprecated use elm_object_text_* instead.
4953 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
4955 * Get the text set in the given part
4957 * @param obj The layout object
4958 * @param part The TEXT part to retrieve the text off
4960 * @return The text set in @p part
4963 * @deprecated use elm_object_text_* instead.
4965 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
4967 * Append child to layout box part.
4969 * @param obj the layout object
4970 * @param part the box part to which the object will be appended.
4971 * @param child the child object to append to box.
4973 * Once the object is appended, it will become child of the layout. Its
4974 * lifetime will be bound to the layout, whenever the layout dies the child
4975 * will be deleted automatically. One should use elm_layout_box_remove() to
4976 * make this layout forget about the object.
4978 * @see elm_layout_box_prepend()
4979 * @see elm_layout_box_insert_before()
4980 * @see elm_layout_box_insert_at()
4981 * @see elm_layout_box_remove()
4985 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4987 * Prepend child to layout box part.
4989 * @param obj the layout object
4990 * @param part the box part to prepend.
4991 * @param child the child object to prepend to box.
4993 * Once the object is prepended, it will become child of the layout. Its
4994 * lifetime will be bound to the layout, whenever the layout dies the child
4995 * will be deleted automatically. One should use elm_layout_box_remove() to
4996 * make this layout forget about the object.
4998 * @see elm_layout_box_append()
4999 * @see elm_layout_box_insert_before()
5000 * @see elm_layout_box_insert_at()
5001 * @see elm_layout_box_remove()
5005 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
5007 * Insert child to layout box part before a reference object.
5009 * @param obj the layout object
5010 * @param part the box part to insert.
5011 * @param child the child object to insert into box.
5012 * @param reference another reference object to insert before in box.
5014 * Once the object is inserted, it will become child of the layout. Its
5015 * lifetime will be bound to the layout, whenever the layout dies the child
5016 * will be deleted automatically. One should use elm_layout_box_remove() to
5017 * make this layout forget about the object.
5019 * @see elm_layout_box_append()
5020 * @see elm_layout_box_prepend()
5021 * @see elm_layout_box_insert_before()
5022 * @see elm_layout_box_remove()
5026 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
5028 * Insert child to layout box part at a given position.
5030 * @param obj the layout object
5031 * @param part the box part to insert.
5032 * @param child the child object to insert into box.
5033 * @param pos the numeric position >=0 to insert the child.
5035 * Once the object is inserted, it will become child of the layout. Its
5036 * lifetime will be bound to the layout, whenever the layout dies the child
5037 * will be deleted automatically. One should use elm_layout_box_remove() to
5038 * make this layout forget about the object.
5040 * @see elm_layout_box_append()
5041 * @see elm_layout_box_prepend()
5042 * @see elm_layout_box_insert_before()
5043 * @see elm_layout_box_remove()
5047 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
5049 * Remove a child of the given part box.
5051 * @param obj The layout object
5052 * @param part The box part name to remove child.
5053 * @param child The object to remove from box.
5054 * @return The object that was being used, or NULL if not found.
5056 * The object will be removed from the box part and its lifetime will
5057 * not be handled by the layout anymore. This is equivalent to
5058 * elm_layout_content_unset() for box.
5060 * @see elm_layout_box_append()
5061 * @see elm_layout_box_remove_all()
5065 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
5067 * Remove all child of the given part box.
5069 * @param obj The layout object
5070 * @param part The box part name to remove child.
5071 * @param clear If EINA_TRUE, then all objects will be deleted as
5072 * well, otherwise they will just be removed and will be
5073 * dangling on the canvas.
5075 * The objects will be removed from the box part and their lifetime will
5076 * not be handled by the layout anymore. This is equivalent to
5077 * elm_layout_box_remove() for all box children.
5079 * @see elm_layout_box_append()
5080 * @see elm_layout_box_remove()
5084 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
5086 * Insert child to layout table part.
5088 * @param obj the layout object
5089 * @param part the box part to pack child.
5090 * @param child_obj the child object to pack into table.
5091 * @param col the column to which the child should be added. (>= 0)
5092 * @param row the row to which the child should be added. (>= 0)
5093 * @param colspan how many columns should be used to store this object. (>=
5095 * @param rowspan how many rows should be used to store this object. (>= 1)
5097 * Once the object is inserted, it will become child of the table. Its
5098 * lifetime will be bound to the layout, and whenever the layout dies the
5099 * child will be deleted automatically. One should use
5100 * elm_layout_table_remove() to make this layout forget about the object.
5102 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
5103 * more space than a single cell. For instance, the following code:
5105 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
5108 * Would result in an object being added like the following picture:
5110 * @image html layout_colspan.png
5111 * @image latex layout_colspan.eps width=\textwidth
5113 * @see elm_layout_table_unpack()
5114 * @see elm_layout_table_clear()
5118 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);
5120 * Unpack (remove) a child of the given part table.
5122 * @param obj The layout object
5123 * @param part The table part name to remove child.
5124 * @param child_obj The object to remove from table.
5125 * @return The object that was being used, or NULL if not found.
5127 * The object will be unpacked from the table part and its lifetime
5128 * will not be handled by the layout anymore. This is equivalent to
5129 * elm_layout_content_unset() for table.
5131 * @see elm_layout_table_pack()
5132 * @see elm_layout_table_clear()
5136 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
5138 * Remove all child of the given part table.
5140 * @param obj The layout object
5141 * @param part The table part name to remove child.
5142 * @param clear If EINA_TRUE, then all objects will be deleted as
5143 * well, otherwise they will just be removed and will be
5144 * dangling on the canvas.
5146 * The objects will be removed from the table part and their lifetime will
5147 * not be handled by the layout anymore. This is equivalent to
5148 * elm_layout_table_unpack() for all table children.
5150 * @see elm_layout_table_pack()
5151 * @see elm_layout_table_unpack()
5155 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
5157 * Get the edje layout
5159 * @param obj The layout object
5161 * @return A Evas_Object with the edje layout settings loaded
5162 * with function elm_layout_file_set
5164 * This returns the edje object. It is not expected to be used to then
5165 * swallow objects via edje_object_part_swallow() for example. Use
5166 * elm_layout_content_set() instead so child object handling and sizing is
5169 * @note This function should only be used if you really need to call some
5170 * low level Edje function on this edje object. All the common stuff (setting
5171 * text, emitting signals, hooking callbacks to signals, etc.) can be done
5172 * with proper elementary functions.
5174 * @see elm_object_signal_callback_add()
5175 * @see elm_object_signal_emit()
5176 * @see elm_object_text_part_set()
5177 * @see elm_layout_content_set()
5178 * @see elm_layout_box_append()
5179 * @see elm_layout_table_pack()
5180 * @see elm_layout_data_get()
5184 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5186 * Get the edje data from the given layout
5188 * @param obj The layout object
5189 * @param key The data key
5191 * @return The edje data string
5193 * This function fetches data specified inside the edje theme of this layout.
5194 * This function return NULL if data is not found.
5196 * In EDC this comes from a data block within the group block that @p
5197 * obj was loaded from. E.g.
5204 * item: "key1" "value1";
5205 * item: "key2" "value2";
5213 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
5217 * @param obj The layout object
5219 * Manually forces a sizing re-evaluation. This is useful when the minimum
5220 * size required by the edje theme of this layout has changed. The change on
5221 * the minimum size required by the edje theme is not immediately reported to
5222 * the elementary layout, so one needs to call this function in order to tell
5223 * the widget (layout) that it needs to reevaluate its own size.
5225 * The minimum size of the theme is calculated based on minimum size of
5226 * parts, the size of elements inside containers like box and table, etc. All
5227 * of this can change due to state changes, and that's when this function
5230 * Also note that a standard signal of "size,eval" "elm" emitted from the
5231 * edje object will cause this to happen too.
5235 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
5236 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
5237 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
5238 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
5239 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
5240 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
5241 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);
5242 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
5244 * @def elm_layout_icon_set
5245 * Convienience macro to set the icon object in a layout that follows the
5246 * Elementary naming convention for its parts.
5250 #define elm_layout_icon_set(_ly, _obj) \
5253 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
5254 if ((_obj)) sig = "elm,state,icon,visible"; \
5255 else sig = "elm,state,icon,hidden"; \
5256 elm_object_signal_emit((_ly), sig, "elm"); \
5260 * @def elm_layout_icon_get
5261 * Convienience macro to get the icon object from a layout that follows the
5262 * Elementary naming convention for its parts.
5266 #define elm_layout_icon_get(_ly) \
5267 elm_layout_content_get((_ly), "elm.swallow.icon")
5270 * @def elm_layout_end_set
5271 * Convienience macro to set the end object in a layout that follows the
5272 * Elementary naming convention for its parts.
5276 #define elm_layout_end_set(_ly, _obj) \
5279 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
5280 if ((_obj)) sig = "elm,state,end,visible"; \
5281 else sig = "elm,state,end,hidden"; \
5282 elm_object_signal_emit((_ly), sig, "elm"); \
5286 * @def elm_layout_end_get
5287 * Convienience macro to get the end object in a layout that follows the
5288 * Elementary naming convention for its parts.
5292 #define elm_layout_end_get(_ly) \
5293 elm_layout_content_get((_ly), "elm.swallow.end")
5296 * @def elm_layout_label_set
5297 * Convienience macro to set the label in a layout that follows the
5298 * Elementary naming convention for its parts.
5301 * @deprecate use elm_object_text_* instead.
5303 #define elm_layout_label_set(_ly, _txt) \
5304 elm_layout_text_set((_ly), "elm.text", (_txt))
5307 * @def elm_layout_label_get
5308 * Convienience macro to get the label in a layout that follows the
5309 * Elementary naming convention for its parts.
5312 * @deprecate use elm_object_text_* instead.
5314 #define elm_layout_label_get(_ly) \
5315 elm_layout_text_get((_ly), "elm.text")
5317 /* smart callbacks called:
5318 * "theme,changed" - when elm theme is changed.
5322 typedef enum _Elm_Notify_Orient
5324 ELM_NOTIFY_ORIENT_TOP,
5325 ELM_NOTIFY_ORIENT_CENTER,
5326 ELM_NOTIFY_ORIENT_BOTTOM,
5327 ELM_NOTIFY_ORIENT_LEFT,
5328 ELM_NOTIFY_ORIENT_RIGHT,
5329 ELM_NOTIFY_ORIENT_TOP_LEFT,
5330 ELM_NOTIFY_ORIENT_TOP_RIGHT,
5331 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
5332 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
5333 ELM_NOTIFY_ORIENT_LAST
5334 } Elm_Notify_Orient;
5335 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5336 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5337 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5338 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5339 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5340 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5341 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
5342 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5343 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5344 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5345 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
5346 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5347 /* smart callbacks called:
5348 * "timeout" - when timeout happens on notify and it's hidden
5349 * "block,clicked" - when it's hidden by a click outside of the notify's view
5353 * @defgroup Hover Hover
5355 * A Hover object will hover over its @p parent object at the @p target
5356 * location. Anything in the background will be given a darker coloring to
5357 * indicate that the hover object is on top (at the default theme). When the
5358 * hover is clicked it is dismissed(hidden), if the contents of the hover are
5359 * clicked that @b doesn't cause the hover to be dismissed.
5361 * @note The hover object will take up the entire space of @p target
5364 * Elementary has the following styles for the hover widget:
5368 * @li hoversel_vertical
5370 * The following are the available position for content:
5382 * Signals that you can add callbacks for are:
5383 * @li "clicked" - the user clicked the empty space in the hover to dismiss
5384 * @li "smart,changed" - a content object placed under the "smart"
5385 * policy was replaced to a new slot direction.
5387 * See @ref tutorial_hover for more information.
5391 typedef enum _Elm_Hover_Axis
5393 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
5394 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
5395 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
5396 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
5399 * @brief Adds a hover object to @p parent
5401 * @param parent The parent object
5402 * @return The hover object or NULL if one could not be created
5404 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5406 * @brief Sets the target object for the hover.
5408 * @param obj The hover object
5409 * @param target The object to center the hover onto. The hover
5411 * This function will cause the hover to be centered on the target object.
5413 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
5415 * @brief Gets the target object for the hover.
5417 * @param obj The hover object
5418 * @param parent The object to locate the hover over.
5420 * @see elm_hover_target_set()
5422 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5424 * @brief Sets the parent object for the hover.
5426 * @param obj The hover object
5427 * @param parent The object to locate the hover over.
5429 * This function will cause the hover to take up the entire space that the
5430 * parent object fills.
5432 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5434 * @brief Gets the parent object for the hover.
5436 * @param obj The hover object
5437 * @return The parent object to locate the hover over.
5439 * @see elm_hover_parent_set()
5441 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5443 * @brief Sets the content of the hover object and the direction in which it
5446 * @param obj The hover object
5447 * @param swallow The direction that the object will be displayed
5448 * at. Accepted values are "left", "top-left", "top", "top-right",
5449 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
5451 * @param content The content to place at @p swallow
5453 * Once the content object is set for a given direction, a previously
5454 * set one (on the same direction) will be deleted. If you want to
5455 * keep that old content object, use the elm_hover_content_unset()
5458 * All directions may have contents at the same time, except for
5459 * "smart". This is a special placement hint and its use case
5460 * independs of the calculations coming from
5461 * elm_hover_best_content_location_get(). Its use is for cases when
5462 * one desires only one hover content, but with a dinamic special
5463 * placement within the hover area. The content's geometry, whenever
5464 * it changes, will be used to decide on a best location not
5465 * extrapolating the hover's parent object view to show it in (still
5466 * being the hover's target determinant of its medium part -- move and
5467 * resize it to simulate finger sizes, for example). If one of the
5468 * directions other than "smart" are used, a previously content set
5469 * using it will be deleted, and vice-versa.
5471 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
5473 * @brief Get the content of the hover object, in a given direction.
5475 * Return the content object which was set for this widget in the
5476 * @p swallow direction.
5478 * @param obj The hover object
5479 * @param swallow The direction that the object was display at.
5480 * @return The content that was being used
5482 * @see elm_hover_content_set()
5484 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
5486 * @brief Unset the content of the hover object, in a given direction.
5488 * Unparent and return the content object set at @p swallow direction.
5490 * @param obj The hover object
5491 * @param swallow The direction that the object was display at.
5492 * @return The content that was being used.
5494 * @see elm_hover_content_set()
5496 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
5498 * @brief Returns the best swallow location for content in the hover.
5500 * @param obj The hover object
5501 * @param pref_axis The preferred orientation axis for the hover object to use
5502 * @return The edje location to place content into the hover or @c
5505 * Best is defined here as the location at which there is the most available
5508 * @p pref_axis may be one of
5509 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
5510 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
5511 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
5512 * - @c ELM_HOVER_AXIS_BOTH -- both
5514 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
5515 * nescessarily be along the horizontal axis("left" or "right"). If
5516 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
5517 * be along the vertical axis("top" or "bottom"). Chossing
5518 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
5519 * returned position may be in either axis.
5521 * @see elm_hover_content_set()
5523 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
5529 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
5530 struct _Elm_Entry_Anchor_Info
5534 Evas_Coord x, y, w, h;
5536 typedef enum _Elm_Icon_Type
5542 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
5544 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5545 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
5546 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5547 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
5548 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5549 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5550 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5551 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5552 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5553 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5554 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5555 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5556 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5557 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5558 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5559 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
5560 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5561 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5562 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
5563 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
5564 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
5565 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5566 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5567 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5568 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5569 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5570 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5571 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5572 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5573 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5574 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);
5575 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5576 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5577 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
5579 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
5580 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5581 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);
5582 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5583 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584 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);
5585 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);
5586 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);
5587 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);
5588 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);
5589 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);
5590 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
5591 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
5592 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
5593 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
5594 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
5595 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
5596 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5597 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
5598 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5599 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
5600 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
5601 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
5602 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
5603 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
5604 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
5605 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
5606 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
5607 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
5608 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
5609 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
5610 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
5611 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
5613 /* pre-made filters for entries */
5614 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
5615 struct _Elm_Entry_Filter_Limit_Size
5620 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
5621 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
5622 struct _Elm_Entry_Filter_Accept_Set
5624 const char *accepted;
5625 const char *rejected;
5627 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
5628 /* smart callbacks called:
5629 * "changed" - the text content changed
5630 * "selection,start" - the user started selecting text
5631 * "selection,changed" - the user modified the selection size/location
5632 * "selection,cleared" - the user cleared the selection
5633 * "selection,paste" - the user requested a paste of text
5634 * "selection,copy" - the user copied the text
5635 * "selection,cut" - the user cut the text
5636 * "cursor,changed" - the cursor changed position
5637 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
5638 * "activated" - when the enter key is pressed (useful for single line)
5639 * "press" - when finger/mouse is pressed down
5640 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
5641 * "clicked,double" - when finger/mouse is double-pressed
5642 * "longpressed" - the entry has been longpressed
5643 * "focused" - the entry has received keyboard focus
5644 * "unfocused" - keyboard focus is gone
5647 /* composite widgets - these basically put together basic widgets above
5648 * in convenient packages that do more than basic stuff */
5652 * @defgroup Anchorview Anchorview
5654 * Anchorview is for displaying text that contains markup with anchors
5655 * like <c>\<a href=1234\>something\</\></c> in it.
5657 * Besides being styled differently, the anchorview widget provides the
5658 * necessary functionality so that clicking on these anchors brings up a
5659 * popup with user defined content such as "call", "add to contacts" or
5660 * "open web page". This popup is provided using the @ref Hover widget.
5662 * This widget is very similar to @ref Anchorblock, so refer to that
5663 * widget for an example. The only difference Anchorview has is that the
5664 * widget is already provided with scrolling functionality, so if the
5665 * text set to it is too large to fit in the given space, it will scroll,
5666 * whereas the @ref Anchorblock widget will keep growing to ensure all the
5667 * text can be displayed.
5669 * This widget emits the following signals:
5670 * @li "anchor,clicked": will be called when an anchor is clicked. The
5671 * @p event_info parameter on the callback will be a pointer of type
5672 * ::Elm_Entry_Anchorview_Info.
5674 * See @ref Anchorblock for an example on how to use both of them.
5683 * @typedef Elm_Entry_Anchorview_Info
5685 * The info sent in the callback for "anchor,clicked" signals emitted by
5686 * the Anchorview widget.
5688 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
5690 * @struct _Elm_Entry_Anchorview_Info
5692 * The info sent in the callback for "anchor,clicked" signals emitted by
5693 * the Anchorview widget.
5695 struct _Elm_Entry_Anchorview_Info
5697 const char *name; /**< Name of the anchor, as indicated in its href
5699 int button; /**< The mouse button used to click on it */
5700 Evas_Object *hover; /**< The hover object to use for the popup */
5702 Evas_Coord x, y, w, h;
5703 } anchor, /**< Geometry selection of text used as anchor */
5704 hover_parent; /**< Geometry of the object used as parent by the
5706 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
5707 for content on the left side of
5708 the hover. Before calling the
5709 callback, the widget will make the
5710 necessary calculations to check
5711 which sides are fit to be set with
5712 content, based on the position the
5713 hover is activated and its distance
5714 to the edges of its parent object
5716 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
5717 the right side of the hover.
5718 See @ref hover_left */
5719 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
5720 of the hover. See @ref hover_left */
5721 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
5722 below the hover. See @ref
5726 * Add a new Anchorview object
5728 * @param parent The parent object
5729 * @return The new object or NULL if it cannot be created
5731 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5733 * Set the text to show in the anchorview
5735 * Sets the text of the anchorview to @p text. This text can include markup
5736 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
5737 * text that will be specially styled and react to click events, ended with
5738 * either of \</a\> or \</\>. When clicked, the anchor will emit an
5739 * "anchor,clicked" signal that you can attach a callback to with
5740 * evas_object_smart_callback_add(). The name of the anchor given in the
5741 * event info struct will be the one set in the href attribute, in this
5744 * Other markup can be used to style the text in different ways, but it's
5745 * up to the style defined in the theme which tags do what.
5746 * @deprecated use elm_object_text_set() instead.
5748 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
5750 * Get the markup text set for the anchorview
5752 * Retrieves the text set on the anchorview, with markup tags included.
5754 * @param obj The anchorview object
5755 * @return The markup text set or @c NULL if nothing was set or an error
5757 * @deprecated use elm_object_text_set() instead.
5759 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5761 * Set the parent of the hover popup
5763 * Sets the parent object to use by the hover created by the anchorview
5764 * when an anchor is clicked. See @ref Hover for more details on this.
5765 * If no parent is set, the same anchorview object will be used.
5767 * @param obj The anchorview object
5768 * @param parent The object to use as parent for the hover
5770 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5772 * Get the parent of the hover popup
5774 * Get the object used as parent for the hover created by the anchorview
5775 * widget. See @ref Hover for more details on this.
5777 * @param obj The anchorview object
5778 * @return The object used as parent for the hover, NULL if none is set.
5780 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5782 * Set the style that the hover should use
5784 * When creating the popup hover, anchorview will request that it's
5785 * themed according to @p style.
5787 * @param obj The anchorview object
5788 * @param style The style to use for the underlying hover
5790 * @see elm_object_style_set()
5792 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5794 * Get the style that the hover should use
5796 * Get the style the hover created by anchorview will use.
5798 * @param obj The anchorview object
5799 * @return The style to use by the hover. NULL means the default is used.
5801 * @see elm_object_style_set()
5803 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 * Ends the hover popup in the anchorview
5807 * When an anchor is clicked, the anchorview widget will create a hover
5808 * object to use as a popup with user provided content. This function
5809 * terminates this popup, returning the anchorview to its normal state.
5811 * @param obj The anchorview object
5813 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5815 * Set bouncing behaviour when the scrolled content reaches an edge
5817 * Tell the internal scroller object whether it should bounce or not
5818 * when it reaches the respective edges for each axis.
5820 * @param obj The anchorview object
5821 * @param h_bounce Whether to bounce or not in the horizontal axis
5822 * @param v_bounce Whether to bounce or not in the vertical axis
5824 * @see elm_scroller_bounce_set()
5826 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5828 * Get the set bouncing behaviour of the internal scroller
5830 * Get whether the internal scroller should bounce when the edge of each
5831 * axis is reached scrolling.
5833 * @param obj The anchorview object
5834 * @param h_bounce Pointer where to store the bounce state of the horizontal
5836 * @param v_bounce Pointer where to store the bounce state of the vertical
5839 * @see elm_scroller_bounce_get()
5841 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5843 * Appends a custom item provider to the given anchorview
5845 * Appends the given function to the list of items providers. This list is
5846 * called, one function at a time, with the given @p data pointer, the
5847 * anchorview object and, in the @p item parameter, the item name as
5848 * referenced in its href string. Following functions in the list will be
5849 * called in order until one of them returns something different to NULL,
5850 * which should be an Evas_Object which will be used in place of the item
5853 * Items in the markup text take the form \<item relsize=16x16 vsize=full
5854 * href=item/name\>\</item\>
5856 * @param obj The anchorview object
5857 * @param func The function to add to the list of providers
5858 * @param data User data that will be passed to the callback function
5860 * @see elm_entry_item_provider_append()
5862 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);
5864 * Prepend a custom item provider to the given anchorview
5866 * Like elm_anchorview_item_provider_append(), but it adds the function
5867 * @p func to the beginning of the list, instead of the end.
5869 * @param obj The anchorview object
5870 * @param func The function to add to the list of providers
5871 * @param data User data that will be passed to the callback function
5873 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);
5875 * Remove a custom item provider from the list of the given anchorview
5877 * Removes the function and data pairing that matches @p func and @p data.
5878 * That is, unless the same function and same user data are given, the
5879 * function will not be removed from the list. This allows us to add the
5880 * same callback several times, with different @p data pointers and be
5881 * able to remove them later without conflicts.
5883 * @param obj The anchorview object
5884 * @param func The function to remove from the list
5885 * @param data The data matching the function to remove from the list
5887 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);
5894 * @defgroup Anchorblock Anchorblock
5896 * Anchorblock is for displaying text that contains markup with anchors
5897 * like <c>\<a href=1234\>something\</\></c> in it.
5899 * Besides being styled differently, the anchorblock widget provides the
5900 * necessary functionality so that clicking on these anchors brings up a
5901 * popup with user defined content such as "call", "add to contacts" or
5902 * "open web page". This popup is provided using the @ref Hover widget.
5904 * This widget emits the following signals:
5905 * @li "anchor,clicked": will be called when an anchor is clicked. The
5906 * @p event_info parameter on the callback will be a pointer of type
5907 * ::Elm_Entry_Anchorblock_Info.
5913 * Since examples are usually better than plain words, we might as well
5914 * try @ref tutorial_anchorblock_example "one".
5917 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
5918 * This example will show both Anchorblock and @ref Anchorview,
5919 * since both are very similar and it's easier to show them once and side
5920 * by side, so the difference is more clear.
5922 * We'll show the relevant snippets of the code here, but the full example
5923 * can be found here... sorry, @ref anchorblock_example_01.c "here".
5925 * As for the actual example, it's just a simple window with an anchorblock
5926 * and an anchorview, both containing the same text. After including
5927 * Elementary.h and declaring some functions we'll need, we jump to our
5928 * elm_main (see ELM_MAIN) and create our window.
5929 * @dontinclude anchorblock_example_01.c
5934 * With the needed variables declared, we'll create the window and a box to
5935 * hold our widgets, but we don't need to go through that here.
5937 * In order to make clear where the anchorblock ends and the anchorview
5938 * begins, they'll be each inside a @ref Frame. After creating the frame,
5939 * the anchorblock follows.
5940 * @skip elm_frame_add
5941 * @until elm_frame_content_set
5943 * Nothing out of the ordinary there. What's worth mentioning is the call
5944 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
5945 * when an anchor is clicked, the hover for the popup will cover the entire
5946 * window. This affects the area that will be obscured by the hover and
5947 * where clicking will dismiss it, as well as the calculations it does to
5948 * inform the best locations where to insert the popups content.
5949 * Other than that, the code is pretty standard. We also need to set our
5950 * callback for when an anchor is clicked, since it's our task to populate
5951 * the popup. There's no default for it.
5953 * The anchorview is no different, we only change a few things so it looks
5955 * @until elm_frame_content_set
5957 * Then we run, so stuff works and close our main function in the usual way.
5960 * Now, a little note. Normally you would use either one of anchorblock or
5961 * anchorview, set your one callback to clicks and do your stuff in there.
5962 * In this example, however, there are a few tricks to make it easier to
5963 * show both widgets in one go (and to save me some typing). So we have
5964 * two callbacks, one per widget, that will call a common function to do
5965 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
5966 * anchorview too, since both are equal, and passing a callback to use
5967 * for our buttons to end the hover, because each widget has a different
5969 * @until _anchorview_clicked_cb
5972 * The meat of our popup is in the following function. We check what kind
5973 * of menu we need to show, based on the name set to the anchor in the
5974 * markup text. If there's no type (something went wrong, no valid contact
5975 * in the address list) we are just putting a button that does nothing, but
5976 * it's perfectly reasonable to just end the hover and call it quits.
5978 * Our popup will consist of one main button in the middle of our hover,
5979 * and possibly a secondary button and a list of other options. We'll create
5980 * first our main button and check what kind of popup we need afterwards.
5983 * @until eina_stringshare_add
5986 * Each button has two callbacks, one is our hack to close the hover
5987 * properly based on which widget it belongs to, the other a simple
5988 * printf that will show the action with the anchors own data. This is
5989 * not how you would usually do it. Instead, the common case is to have
5990 * one callback for the button that will know which function to call to end
5991 * things, but since we are doing it this way it's worth noting that
5992 * smart callbacks will be called in reverse in respect to the order they
5993 * were added, and since our @c btn_end_cb will close the hover, and thus
5994 * delete our buttons, the other callback wouldn't be called if we had
5997 * After our telephone popup, there are a few others that are practically
5998 * the same, so they won't be shown here.
6000 * Once we are done with that, it's time to place our actions into our
6001 * hover. Main button goes in the middle without much questioning, and then
6002 * we see if we have a secondary button and a box of extra options.
6003 * Because I said so, secondary button goes on either side and box of
6004 * options either on top or below the main one, but to choose which
6005 * exactly, we use the hints our callback info has, which saves us from
6006 * having to do the math and see which side has more space available, with
6007 * a little special case where we delete our extra stuff if there's nowhere
6011 * @skip evas_object_smart
6012 * @until evas_object_del(box)
6016 * The example will look like this:
6018 * @image html screenshots/anchorblock_01.png
6019 * @image latex screenshots/anchorblock_01.eps width=\textwidth
6021 * @example anchorblock_example_01.c
6024 * @addtogroup Anchorblock
6028 * @typedef Elm_Entry_Anchorblock_Info
6030 * The info sent in the callback for "anchor,clicked" signals emitted by
6031 * the Anchorblock widget.
6033 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
6035 * @struct _Elm_Entry_Anchorblock_Info
6037 * The info sent in the callback for "anchor,clicked" signals emitted by
6038 * the Anchorblock widget.
6040 struct _Elm_Entry_Anchorblock_Info
6042 const char *name; /**< Name of the anchor, as indicated in its href
6044 int button; /**< The mouse button used to click on it */
6045 Evas_Object *hover; /**< The hover object to use for the popup */
6047 Evas_Coord x, y, w, h;
6048 } anchor, /**< Geometry selection of text used as anchor */
6049 hover_parent; /**< Geometry of the object used as parent by the
6051 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
6052 for content on the left side of
6053 the hover. Before calling the
6054 callback, the widget will make the
6055 necessary calculations to check
6056 which sides are fit to be set with
6057 content, based on the position the
6058 hover is activated and its distance
6059 to the edges of its parent object
6061 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
6062 the right side of the hover.
6063 See @ref hover_left */
6064 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
6065 of the hover. See @ref hover_left */
6066 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
6067 below the hover. See @ref
6071 * Add a new Anchorblock object
6073 * @param parent The parent object
6074 * @return The new object or NULL if it cannot be created
6076 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6078 * Set the text to show in the anchorblock
6080 * Sets the text of the anchorblock to @p text. This text can include markup
6081 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
6082 * of text that will be specially styled and react to click events, ended
6083 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
6084 * "anchor,clicked" signal that you can attach a callback to with
6085 * evas_object_smart_callback_add(). The name of the anchor given in the
6086 * event info struct will be the one set in the href attribute, in this
6089 * Other markup can be used to style the text in different ways, but it's
6090 * up to the style defined in the theme which tags do what.
6091 * @deprecated use elm_object_text_set() instead.
6093 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
6095 * Get the markup text set for the anchorblock
6097 * Retrieves the text set on the anchorblock, with markup tags included.
6099 * @param obj The anchorblock object
6100 * @return The markup text set or @c NULL if nothing was set or an error
6102 * @deprecated use elm_object_text_set() instead.
6104 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6106 * Set the parent of the hover popup
6108 * Sets the parent object to use by the hover created by the anchorblock
6109 * when an anchor is clicked. See @ref Hover for more details on this.
6111 * @param obj The anchorblock object
6112 * @param parent The object to use as parent for the hover
6114 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6116 * Get the parent of the hover popup
6118 * Get the object used as parent for the hover created by the anchorblock
6119 * widget. See @ref Hover for more details on this.
6120 * If no parent is set, the same anchorblock object will be used.
6122 * @param obj The anchorblock object
6123 * @return The object used as parent for the hover, NULL if none is set.
6125 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6127 * Set the style that the hover should use
6129 * When creating the popup hover, anchorblock will request that it's
6130 * themed according to @p style.
6132 * @param obj The anchorblock object
6133 * @param style The style to use for the underlying hover
6135 * @see elm_object_style_set()
6137 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
6139 * Get the style that the hover should use
6141 * Get the style the hover created by anchorblock will use.
6143 * @param obj The anchorblock object
6144 * @return The style to use by the hover. NULL means the default is used.
6146 * @see elm_object_style_set()
6148 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6150 * Ends the hover popup in the anchorblock
6152 * When an anchor is clicked, the anchorblock widget will create a hover
6153 * object to use as a popup with user provided content. This function
6154 * terminates this popup, returning the anchorblock to its normal state.
6156 * @param obj The anchorblock object
6158 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6160 * Appends a custom item provider to the given anchorblock
6162 * Appends the given function to the list of items providers. This list is
6163 * called, one function at a time, with the given @p data pointer, the
6164 * anchorblock object and, in the @p item parameter, the item name as
6165 * referenced in its href string. Following functions in the list will be
6166 * called in order until one of them returns something different to NULL,
6167 * which should be an Evas_Object which will be used in place of the item
6170 * Items in the markup text take the form \<item relsize=16x16 vsize=full
6171 * href=item/name\>\</item\>
6173 * @param obj The anchorblock object
6174 * @param func The function to add to the list of providers
6175 * @param data User data that will be passed to the callback function
6177 * @see elm_entry_item_provider_append()
6179 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);
6181 * Prepend a custom item provider to the given anchorblock
6183 * Like elm_anchorblock_item_provider_append(), but it adds the function
6184 * @p func to the beginning of the list, instead of the end.
6186 * @param obj The anchorblock object
6187 * @param func The function to add to the list of providers
6188 * @param data User data that will be passed to the callback function
6190 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);
6192 * Remove a custom item provider from the list of the given anchorblock
6194 * Removes the function and data pairing that matches @p func and @p data.
6195 * That is, unless the same function and same user data are given, the
6196 * function will not be removed from the list. This allows us to add the
6197 * same callback several times, with different @p data pointers and be
6198 * able to remove them later without conflicts.
6200 * @param obj The anchorblock object
6201 * @param func The function to remove from the list
6202 * @param data The data matching the function to remove from the list
6204 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);
6210 * @defgroup Bubble Bubble
6212 * @image html img/widget/bubble/preview-00.png
6213 * @image html img/widget/bubble/preview-01.png
6214 * @image html img/widget/bubble/preview-02.png
6216 * @brief The Bubble is a widget to show text similarly to how speech is
6217 * represented in comics.
6219 * The bubble widget contains 5 important visual elements:
6220 * @li The frame is a rectangle with rounded rectangles and an "arrow".
6221 * @li The @p icon is an image to which the frame's arrow points to.
6222 * @li The @p label is a text which appears to the right of the icon if the
6223 * corner is "top_left" or "bottom_left" and is right aligned to the frame
6225 * @li The @p info is a text which appears to the right of the label. Info's
6226 * font is of a ligther color than label.
6227 * @li The @p content is an evas object that is shown inside the frame.
6229 * The position of the arrow, icon, label and info depends on which corner is
6230 * selected. The four available corners are:
6231 * @li "top_left" - Default
6234 * @li "bottom_right"
6236 * Signals that you can add callbacks for are:
6237 * @li "clicked" - This is called when a user has clicked the bubble.
6239 * For an example of using a buble see @ref bubble_01_example_page "this".
6244 * Add a new bubble to the parent
6246 * @param parent The parent object
6247 * @return The new object or NULL if it cannot be created
6249 * This function adds a text bubble to the given parent evas object.
6251 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6253 * Set the label of the bubble
6255 * @param obj The bubble object
6256 * @param label The string to set in the label
6258 * This function sets the title of the bubble. Where this appears depends on
6259 * the selected corner.
6260 * @deprecated use elm_object_text_set() instead.
6262 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6264 * Get the label of the bubble
6266 * @param obj The bubble object
6267 * @return The string of set in the label
6269 * This function gets the title of the bubble.
6270 * @deprecated use elm_object_text_set() instead.
6272 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6274 * Set the info of the bubble
6276 * @param obj The bubble object
6277 * @param info The given info about the bubble
6279 * This function sets the info of the bubble. Where this appears depends on
6280 * the selected corner.
6281 * @deprecated use elm_object_text_set() instead.
6283 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
6285 * Get the info of the bubble
6287 * @param obj The bubble object
6289 * @return The "info" string of the bubble
6291 * This function gets the info text.
6292 * @deprecated use elm_object_text_set() instead.
6294 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6296 * Set the content to be shown in the bubble
6298 * Once the content object is set, a previously set one will be deleted.
6299 * If you want to keep the old content object, use the
6300 * elm_bubble_content_unset() function.
6302 * @param obj The bubble object
6303 * @param content The given content of the bubble
6305 * This function sets the content shown on the middle of the bubble.
6307 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6309 * Get the content shown in the bubble
6311 * Return the content object which is set for this widget.
6313 * @param obj The bubble object
6314 * @return The content that is being used
6316 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6318 * Unset the content shown in the bubble
6320 * Unparent and return the content object which was set for this widget.
6322 * @param obj The bubble object
6323 * @return The content that was being used
6325 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6327 * Set the icon of the bubble
6329 * Once the icon object is set, a previously set one will be deleted.
6330 * If you want to keep the old content object, use the
6331 * elm_icon_content_unset() function.
6333 * @param obj The bubble object
6334 * @param icon The given icon for the bubble
6336 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6338 * Get the icon of the bubble
6340 * @param obj The bubble object
6341 * @return The icon for the bubble
6343 * This function gets the icon shown on the top left of bubble.
6345 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6347 * Unset the icon of the bubble
6349 * Unparent and return the icon object which was set for this widget.
6351 * @param obj The bubble object
6352 * @return The icon that was being used
6354 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6356 * Set the corner of the bubble
6358 * @param obj The bubble object.
6359 * @param corner The given corner for the bubble.
6361 * This function sets the corner of the bubble. The corner will be used to
6362 * determine where the arrow in the frame points to and where label, icon and
6365 * Possible values for corner are:
6366 * @li "top_left" - Default
6369 * @li "bottom_right"
6371 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
6373 * Get the corner of the bubble
6375 * @param obj The bubble object.
6376 * @return The given corner for the bubble.
6378 * This function gets the selected corner of the bubble.
6380 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6386 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6387 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
6388 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
6389 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
6390 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
6391 /* smart callbacks called:
6392 * "clicked" - the user clicked the icon
6393 * "drag,start" - Someone started dragging the image out of the object
6394 * "drag,end" - Dragged item was dropped (somewhere)
6398 /** @defgroup Elm_Gesture_Layer Gesture Layer */
6400 * @enum _Elm_Gesture_Types
6401 * Emum of supported gesture types.
6402 * @ingroup Elm_Gesture_Layer
6404 enum _Elm_Gesture_Types
6406 ELM_GESTURE_FIRST = 0,
6408 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
6409 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
6410 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
6412 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
6414 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
6415 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
6417 ELM_GESTURE_ZOOM, /**< Zoom */
6418 ELM_GESTURE_ROTATE, /**< Rotate */
6424 * @typedef Elm_Gesture_Types
6425 * Type for Emum of supported gesture types.
6426 * @ingroup Elm_Gesture_Layer
6428 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
6431 * @enum _Elm_Gesture_State
6432 * Emum of gesture states.
6433 * @ingroup Elm_Gesture_Layer
6435 enum _Elm_Gesture_State
6437 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
6438 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
6439 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
6440 ELM_GESTURE_STATE_END, /**< Gesture completed */
6441 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
6444 * @typedef Elm_Gesture_State
6446 * @ingroup Elm_Gesture_Layer
6448 typedef enum _Elm_Gesture_State Elm_Gesture_State;
6451 * @struct _Elm_Gesture_Taps_Info
6452 * Struct holds taps info for user
6453 * @ingroup Elm_Gesture_Layer
6455 struct _Elm_Gesture_Taps_Info
6457 Evas_Coord x, y; /**< Holds center point between fingers */
6458 unsigned int n; /**< Number of fingers tapped */
6459 unsigned int timestamp; /**< event timestamp */
6463 * @typedef Elm_Gesture_Taps_Info
6464 * holds taps info for user
6465 * @ingroup Elm_Gesture_Layer
6467 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
6470 * @struct _Elm_Gesture_Momentum_Info
6471 * Struct holds momentum info for user
6472 * x1 and y1 are not necessarily in sync
6473 * x1 holds x value of x direction starting point
6474 * and same holds for y1.
6475 * This is noticeable when doing V-shape movement
6476 * @ingroup Elm_Gesture_Layer
6478 struct _Elm_Gesture_Momentum_Info
6479 { /* Report line ends, timestamps, and momentum computed */
6480 Evas_Coord x1; /**< Final-swipe direction starting point on X */
6481 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
6482 Evas_Coord x2; /**< Final-swipe direction ending point on X */
6483 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
6485 unsigned int tx; /**< Timestamp of start of final x-swipe */
6486 unsigned int ty; /**< Timestamp of start of final y-swipe */
6488 Evas_Coord mx; /**< Momentum on X */
6489 Evas_Coord my; /**< Momentum on Y */
6493 * @typedef Elm_Gesture_Momentum_Info
6494 * holds momentum info for user
6495 * @ingroup Elm_Gesture_Layer
6497 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
6500 * @struct _Elm_Gesture_Line_Info
6501 * Struct holds line info for user
6502 * @ingroup Elm_Gesture_Layer
6504 struct _Elm_Gesture_Line_Info
6505 { /* Report line ends, timestamps, and momentum computed */
6506 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
6507 unsigned int n; /**< Number of fingers (lines) */
6508 /* FIXME should be radians, bot degrees */
6509 double angle; /**< Angle (direction) of lines */
6513 * @typedef _Elm_Gesture_Line_Info
6514 * Holds line info for user
6515 * @ingroup Elm_Gesture_Layer
6517 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
6520 * @struct _Elm_Gesture_Zoom_Info
6521 * Struct holds zoom info for user
6522 * @ingroup Elm_Gesture_Layer
6524 struct _Elm_Gesture_Zoom_Info
6526 Evas_Coord x, y; /**< Holds zoom center point reported to user */
6527 Evas_Coord radius; /**< Holds radius between fingers reported to user */
6528 double zoom; /**< Zoom value: 1.0 means no zoom */
6529 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
6533 * @typedef Elm_Gesture_Zoom_Info
6534 * Holds zoom info for user
6535 * @ingroup Elm_Gesture_Layer
6537 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
6540 * @struct _Elm_Gesture_Rotate_Info
6541 * Struct holds rotation info for user
6542 * @ingroup Elm_Gesture_Layer
6544 struct _Elm_Gesture_Rotate_Info
6546 Evas_Coord x, y; /**< Holds zoom center point reported to user */
6547 Evas_Coord radius; /**< Holds radius between fingers reported to user */
6548 double base_angle; /**< Holds start-angle */
6549 double angle; /**< Rotation value: 0.0 means no rotation */
6550 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
6554 * @typedef Elm_Gesture_Rotate_Info
6555 * Holds rotation info for user
6556 * @ingroup Elm_Gesture_Layer
6558 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
6561 * @typedef Elm_Gesture_Event_Cb
6562 * User callback used to stream gesture info from gesture layer
6563 * @param data user data
6564 * @param event_info gesture report info
6565 * Returns a flag field to be applied on the causing event.
6566 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
6567 * upon the event, in an irreversible way.
6569 * @ingroup Elm_Gesture_Layer
6571 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
6574 * Use function to set callbacks to be notified about
6575 * change of state of gesture.
6576 * When a user registers a callback with this function
6577 * this means this gesture has to be tested.
6579 * When ALL callbacks for a gesture are set to NULL
6580 * it means user isn't interested in gesture-state
6581 * and it will not be tested.
6583 * @param obj Pointer to gesture-layer.
6584 * @param idx The gesture you would like to track its state.
6585 * @param cb callback function pointer.
6586 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
6587 * @param data user info to be sent to callback (usually, Smart Data)
6589 * @ingroup Elm_Gesture_Layer
6591 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);
6594 * Call this function to get repeat-events settings.
6596 * @param obj Pointer to gesture-layer.
6598 * @return repeat events settings.
6599 * @see elm_gesture_layer_hold_events_set()
6600 * @ingroup Elm_Gesture_Layer
6602 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6605 * This function called in order to make gesture-layer repeat events.
6606 * Set this of you like to get the raw events only if gestures were not detected.
6607 * Clear this if you like gesture layer to fwd events as testing gestures.
6609 * @param obj Pointer to gesture-layer.
6610 * @param r Repeat: TRUE/FALSE
6612 * @ingroup Elm_Gesture_Layer
6614 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
6617 * This function sets step-value for zoom action.
6618 * Set step to any positive value.
6619 * Cancel step setting by setting to 0.0
6621 * @param obj Pointer to gesture-layer.
6622 * @param s new zoom step value.
6624 * @ingroup Elm_Gesture_Layer
6626 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
6629 * This function sets step-value for rotate action.
6630 * Set step to any positive value.
6631 * Cancel step setting by setting to 0.0
6633 * @param obj Pointer to gesture-layer.
6634 * @param s new roatate step value.
6636 * @ingroup Elm_Gesture_Layer
6638 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
6641 * This function called to attach gesture-layer to an Evas_Object.
6642 * @param obj Pointer to gesture-layer.
6643 * @param t Pointer to underlying object (AKA Target)
6645 * @return TRUE, FALSE on success, failure.
6647 * @ingroup Elm_Gesture_Layer
6649 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
6652 * Call this function to construct a new gesture-layer object.
6653 * This does not activate the gesture layer. You have to
6654 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
6656 * @param parent the parent object.
6658 * @return Pointer to new gesture-layer object.
6660 * @ingroup Elm_Gesture_Layer
6662 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6665 typedef enum _Elm_Thumb_Animation_Setting
6667 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
6668 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
6669 ELM_THUMB_ANIMATION_STOP,
6670 ELM_THUMB_ANIMATION_LAST
6671 } Elm_Thumb_Animation_Setting;
6673 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6674 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
6675 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
6676 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
6677 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
6678 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
6679 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6680 EAPI void *elm_thumb_ethumb_client_get(void);
6681 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
6682 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
6683 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6684 /* available styles:
6688 /* smart callbacks called:
6689 * "clicked" - This is called when a user has clicked the thumb without dragging around.
6690 * "clicked,double" - This is called when a user has double-clicked the thumb.
6691 * "press" - This is called when a user has pressed down the thumb.
6692 * "generate,start" - The thumbnail generation started.
6693 * "generate,stop" - The generation process stopped.
6694 * "generate,error" - The generation failed.
6695 * "load,error" - The thumbnail image loading failed.
6699 * @defgroup Hoversel
6701 * A hoversel is a button that pops up a list of items (automatically
6702 * choosing the direction to display) that have a label and, optionally, an
6703 * icon to select from. It is a convenience widget to avoid the need to do
6704 * all the piecing together yourself. It is intended for a small number of
6705 * items in the hoversel menu (no more than 8), though is capable of many
6708 * Signals that you can add callbacks for are:
6709 * "clicked" - the user clicked the hoversel button and popped up the sel
6710 * "selected" - an item in the hoversel list is selected. event_info is the item
6711 * "dismissed" - the hover is dismissed
6713 * See @ref tutorial_hoversel for an example.
6717 * @brief Add a new Hoversel object
6719 * @param parent The parent object
6720 * @return The new object or NULL if it cannot be created
6722 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6724 * @brief This sets the hoversel to expand horizontally.
6726 * @param obj The hoversel object
6727 * @param horizontal If true, the hover will expand horizontally to the
6730 * @note The initial button will display horizontally regardless of this
6733 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6735 * @brief This returns whether the hoversel is set to expand horizontally.
6737 * @param obj The hoversel object
6738 * @return If true, the hover will expand horizontally to the right.
6740 * @see elm_hoversel_horizontal_set()
6742 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6744 * @brief Set the Hover parent
6746 * @param obj The hoversel object
6747 * @param parent The parent to use
6749 * Sets the hover parent object, the area that will be darkened when the
6750 * hoversel is clicked. Should probably be the window that the hoversel is
6751 * in. See @ref Hover objects for more information.
6753 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6755 * @brief Get the Hover parent
6757 * @param obj The hoversel object
6758 * @return The used parent
6760 * Gets the hover parent object.
6762 * @see elm_hoversel_hover_parent_set()
6764 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6766 * @brief Set the hoversel button label
6768 * @param obj The hoversel object
6769 * @param label The label text.
6771 * This sets the label of the button that is always visible (before it is
6772 * clicked and expanded).
6774 * @deprecated elm_object_text_set()
6776 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6778 * @brief Get the hoversel button label
6780 * @param obj The hoversel object
6781 * @return The label text.
6783 * @deprecated elm_object_text_get()
6785 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6787 * @brief Set the icon of the hoversel button
6789 * @param obj The hoversel object
6790 * @param icon The icon object
6792 * Sets the icon of the button that is always visible (before it is clicked
6793 * and expanded). Once the icon object is set, a previously set one will be
6794 * deleted, if you want to keep that old content object, use the
6795 * elm_hoversel_icon_unset() function.
6797 * @see elm_button_icon_set()
6799 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6801 * @brief Get the icon of the hoversel button
6803 * @param obj The hoversel object
6804 * @return The icon object
6806 * Get the icon of the button that is always visible (before it is clicked
6807 * and expanded). Also see elm_button_icon_get().
6809 * @see elm_hoversel_icon_set()
6811 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6813 * @brief Get and unparent the icon of the hoversel button
6815 * @param obj The hoversel object
6816 * @return The icon object that was being used
6818 * Unparent and return the icon of the button that is always visible
6819 * (before it is clicked and expanded).
6821 * @see elm_hoversel_icon_set()
6822 * @see elm_button_icon_unset()
6824 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6826 * @brief This triggers the hoversel popup from code, the same as if the user
6827 * had clicked the button.
6829 * @param obj The hoversel object
6831 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6833 * @brief This dismisses the hoversel popup as if the user had clicked
6834 * outside the hover.
6836 * @param obj The hoversel object
6838 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6840 * @brief Returns whether the hoversel is expanded.
6842 * @param obj The hoversel object
6843 * @return This will return EINA_TRUE if the hoversel is expanded or
6844 * EINA_FALSE if it is not expanded.
6846 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6848 * @brief This will remove all the children items from the hoversel.
6850 * @param obj The hoversel object
6852 * @warning Should @b not be called while the hoversel is active; use
6853 * elm_hoversel_expanded_get() to check first.
6855 * @see elm_hoversel_item_del_cb_set()
6856 * @see elm_hoversel_item_del()
6858 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6860 * @brief Get the list of items within the given hoversel.
6862 * @param obj The hoversel object
6863 * @return Returns a list of Elm_Hoversel_Item*
6865 * @see elm_hoversel_item_add()
6867 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6869 * @brief Add an item to the hoversel button
6871 * @param obj The hoversel object
6872 * @param label The text label to use for the item (NULL if not desired)
6873 * @param icon_file An image file path on disk to use for the icon or standard
6874 * icon name (NULL if not desired)
6875 * @param icon_type The icon type if relevant
6876 * @param func Convenience function to call when this item is selected
6877 * @param data Data to pass to item-related functions
6878 * @return A handle to the item added.
6880 * This adds an item to the hoversel to show when it is clicked. Note: if you
6881 * need to use an icon from an edje file then use
6882 * elm_hoversel_item_icon_set() right after the this function, and set
6883 * icon_file to NULL here.
6885 * For more information on what @p icon_file and @p icon_type are see the
6886 * @ref Icon "icon documentation".
6888 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);
6890 * @brief Delete an item from the hoversel
6892 * @param item The item to delete
6894 * This deletes the item from the hoversel (should not be called while the
6895 * hoversel is active; use elm_hoversel_expanded_get() to check first).
6897 * @see elm_hoversel_item_add()
6898 * @see elm_hoversel_item_del_cb_set()
6900 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
6902 * @brief Set the function to be called when an item from the hoversel is
6905 * @param item The item to set the callback on
6906 * @param func The function called
6908 * That function will receive these parameters:
6909 * @li void *item_data
6910 * @li Evas_Object *the_item_object
6911 * @li Elm_Hoversel_Item *the_object_struct
6913 * @see elm_hoversel_item_add()
6915 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6917 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
6918 * that will be passed to associated function callbacks.
6920 * @param item The item to get the data from
6921 * @return The data pointer set with elm_hoversel_item_add()
6923 * @see elm_hoversel_item_add()
6925 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
6927 * @brief This returns the label text of the given hoversel item.
6929 * @param item The item to get the label
6930 * @return The label text of the hoversel item
6932 * @see elm_hoversel_item_add()
6934 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
6936 * @brief This sets the icon for the given hoversel item.
6938 * @param item The item to set the icon
6939 * @param icon_file An image file path on disk to use for the icon or standard
6941 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
6942 * to NULL if the icon is not an edje file
6943 * @param icon_type The icon type
6945 * The icon can be loaded from the standard set, from an image file, or from
6948 * @see elm_hoversel_item_add()
6950 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);
6952 * @brief Get the icon object of the hoversel item
6954 * @param item The item to get the icon from
6955 * @param icon_file The image file path on disk used for the icon or standard
6957 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
6958 * if the icon is not an edje file
6959 * @param icon_type The icon type
6961 * @see elm_hoversel_item_icon_set()
6962 * @see elm_hoversel_item_add()
6964 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);
6970 typedef enum _Elm_Toolbar_Shrink_Mode
6972 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
6973 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
6974 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
6975 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
6976 } Elm_Toolbar_Shrink_Mode;
6978 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
6979 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
6981 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6982 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
6983 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6984 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
6985 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6986 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6987 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6988 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);
6989 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);
6990 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);
6991 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);
6992 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6993 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6994 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6995 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6996 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6997 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
6998 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6999 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7000 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7001 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
7002 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7003 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
7004 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7005 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7006 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7007 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7008 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
7009 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7010 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7011 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7012 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7013 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
7014 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7015 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
7016 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7017 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7018 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7019 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7020 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7021 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7022 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7023 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
7024 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7025 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
7026 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7027 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);
7028 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
7029 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
7030 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7031 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7032 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7033 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7034 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
7035 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);
7036 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7037 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
7038 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7039 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7040 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7041 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7042 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
7043 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7044 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7045 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7046 /* smart callbacks called:
7047 * "clicked" - when the user clicks on a toolbar item and becomes selected
7049 /* available styles:
7051 * transparent (no background or shadow, just show the provided content)
7055 EAPI double elm_tooltip_delay_get(void);
7056 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
7057 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
7058 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
7059 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
7060 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);
7061 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7062 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
7063 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7064 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
7065 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7066 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7067 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
7068 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7069 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7070 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7073 EAPI int elm_cursor_engine_only_get(void);
7074 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
7077 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
7078 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7079 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7080 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7081 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
7082 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
7083 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7084 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7085 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);
7086 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
7087 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7088 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
7089 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7090 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7091 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7092 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7093 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7094 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7095 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
7096 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7097 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7098 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7099 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7100 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
7101 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7102 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
7103 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
7104 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
7105 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7106 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7108 /* smart callbacks called:
7109 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
7113 typedef enum _Elm_List_Mode
7115 ELM_LIST_COMPRESS = 0,
7121 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
7122 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7123 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);
7124 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);
7125 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);
7126 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);
7127 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);
7128 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7129 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
7130 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7131 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7132 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
7133 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7134 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7135 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7136 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7137 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7138 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7139 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7140 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7141 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
7142 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7143 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7144 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7145 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7146 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7147 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7148 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7149 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7150 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7151 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7152 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7153 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
7154 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7155 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7156 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
7157 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7158 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7159 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
7160 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);
7161 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7162 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
7163 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7164 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7165 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7166 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7167 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
7168 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7169 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7170 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7171 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7172 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7173 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7174 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7175 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7176 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);
7177 /* smart callbacks called:
7178 * "clicked,double" - when the user double-clicked an item
7179 * "selected" - when the user selected an item
7180 * "unselected" - when the user selected an item
7181 * "longpressed" - an item in the hoversel list is long-pressed
7182 * "scroll,edge,top" - the list is scrolled until the top edge
7183 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
7184 * "scroll,edge,left" - the list is scrolled until the left edge
7185 * "scroll,edge,right" - the list is scrolled until the right edge
7189 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7190 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7191 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7192 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7193 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7194 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7195 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
7196 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7197 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7198 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
7199 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7200 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
7201 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7202 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
7203 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7204 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);
7205 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);
7206 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7207 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7208 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
7209 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
7210 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
7211 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7212 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
7213 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7214 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
7215 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7216 /* smart callbacks called:
7217 * "changed" - Whenever the slider value is changed by the user.
7218 * "slider,drag,start" - dragging the slider indicator around has started
7219 * "slider,drag,stop" - dragging the slider indicator around has stopped
7220 * "delay,changed" - A short time after the value is changed by the user.
7221 * This will be called only when the user stops dragging for a very short
7222 * period or when they release their finger/mouse, so it avoids possibly
7223 * expensive reactions to the value change.
7227 * @addtogroup Actionslider Actionslider
7229 * @image html img/icon/actionslider/preview-00.png
7230 * @image latex img/icon/actionslider/preview-00.png
7232 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
7233 * properties. The indicator is the element the user drags to choose a label.
7234 * When the position is set with magnet, when released the indicator will be
7235 * moved to it if it's nearest the magnetized position.
7237 * @note By default all positions are set as enabled.
7239 * Signals that you can add callbacks for are:
7241 * "selected" - when user selects an enabled position (the label is passed
7244 * "pos_changed" - when the indicator reaches any of the positions("left",
7245 * "right" or "center").
7247 * See an example of actionslider usage @ref actionslider_example_page "here"
7250 typedef enum _Elm_Actionslider_Pos
7252 ELM_ACTIONSLIDER_NONE = 0,
7253 ELM_ACTIONSLIDER_LEFT = 1 << 0,
7254 ELM_ACTIONSLIDER_CENTER = 1 << 1,
7255 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
7256 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
7257 } Elm_Actionslider_Pos;
7260 * Add a new actionslider to the parent.
7262 * @param parent The parent object
7263 * @return The new actionslider object or NULL if it cannot be created
7265 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7267 * Set actionslider labels.
7269 * @param obj The actionslider object
7270 * @param left_label The label to be set on the left.
7271 * @param center_label The label to be set on the center.
7272 * @param right_label The label to be set on the right.
7273 * @deprecated use elm_object_text_set() instead.
7275 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
7277 * Get actionslider labels.
7279 * @param obj The actionslider object
7280 * @param left_label A char** to place the left_label of @p obj into.
7281 * @param center_label A char** to place the center_label of @p obj into.
7282 * @param right_label A char** to place the right_label of @p obj into.
7283 * @deprecated use elm_object_text_set() instead.
7285 EINA_DEPRECATED 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);
7287 * Get actionslider selected label.
7289 * @param obj The actionslider object
7290 * @return The selected label
7292 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7294 * Set actionslider indicator position.
7296 * @param obj The actionslider object.
7297 * @param pos The position of the indicator.
7299 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
7301 * Get actionslider indicator position.
7303 * @param obj The actionslider object.
7304 * @return The position of the indicator.
7306 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7308 * Set actionslider magnet position. To make multiple positions magnets @c or
7309 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
7311 * @param obj The actionslider object.
7312 * @param pos Bit mask indicating the magnet positions.
7314 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
7316 * Get actionslider magnet position.
7318 * @param obj The actionslider object.
7319 * @return The positions with magnet property.
7321 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7323 * Set actionslider enabled position. To set multiple positions as enabled @c or
7324 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
7326 * @note All the positions are enabled by default.
7328 * @param obj The actionslider object.
7329 * @param pos Bit mask indicating the enabled positions.
7331 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
7333 * Get actionslider enabled position.
7335 * @param obj The actionslider object.
7336 * @return The enabled positions.
7338 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7340 * Set the label used on the indicator.
7342 * @param obj The actionslider object
7343 * @param label The label to be set on the indicator.
7344 * @deprecated use elm_object_text_set() instead.
7346 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7348 * Get the label used on the indicator object.
7350 * @param obj The actionslider object
7351 * @return The indicator label
7352 * @deprecated use elm_object_text_set() instead.
7354 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7360 typedef enum _Elm_Genlist_Item_Flags
7362 ELM_GENLIST_ITEM_NONE = 0,
7363 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
7364 ELM_GENLIST_ITEM_GROUP = (1 << 1)
7365 } Elm_Genlist_Item_Flags;
7366 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
7367 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
7368 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
7369 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
7370 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
7371 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
7372 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
7373 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
7375 struct _Elm_Genlist_Item_Class
7377 const char *item_style;
7380 GenlistItemLabelGetFunc label_get;
7381 GenlistItemIconGetFunc icon_get;
7382 GenlistItemStateGetFunc state_get;
7383 GenlistItemDelFunc del;
7384 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
7386 const char *mode_item_style;
7389 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7390 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7391 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7392 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7393 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
7394 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7395 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7396 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7397 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7398 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7399 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
7400 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7401 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
7402 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7403 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7404 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7405 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7406 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7407 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
7408 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7409 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7410 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7411 /* operations to add items */
7412 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);
7413 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);
7414 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);
7415 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);
7416 EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
7417 EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
7418 /* operations to retrieve existing items */
7419 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7420 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7421 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7422 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);
7423 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7424 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7425 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7426 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);
7427 /* available item styles:
7429 * default_style - The text part is a textblock
7431 * icon_top_text_bottom
7433 /* Genlist Item operation */
7434 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7435 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7436 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7437 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7438 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7439 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7440 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7441 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
7442 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7443 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7444 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7445 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7446 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
7447 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7448 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7449 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7450 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7451 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7452 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7453 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7454 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7455 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7456 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
7457 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7458 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7459 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7460 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
7461 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
7462 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
7463 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);
7464 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7465 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
7466 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7467 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7468 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7469 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7470 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
7471 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7472 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7473 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7474 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
7475 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
7476 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7477 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7478 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7479 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480 /* Signals that you can add callbacks for are:
7481 * "clicked,double" - This is called when a user has double-clicked an item.
7482 * The event_info parameter is the genlist item that was
7484 * "selected" - This is called when a user has made an item selected. The
7485 * event_info parameter is the genlist item that was selected.
7486 * "unselected" - This is called when a user has made an item unselected. The
7487 * event_info parameter is the genlist item that was
7489 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
7490 * and the item is now meant to be expanded. The event_info
7491 * parameter is the genlist item that was indicated to expand.
7492 * It is the job of this callback to then fill in the child
7494 * "contracted" - This is called when elm_genlist_item_expanded_set() is
7495 * called and the item is now meant to be contracted. The
7496 * event_info parameter is the genlist item that was indicated
7497 * to contract. It is the job of this callback to then delete
7499 * "expand,request" - This is called when a user has indicated they want to
7500 * expand a tree branch item. The callback should decide
7501 * if the item can expand (has any children) and then call
7502 * elm_genlist_item_expanded_set() appropriately to set
7503 * the state. The event_info parameter is the genlist item
7504 * that was indicated to expand.
7505 * "contract,request" - This is called when a user has indicated they want to
7506 * contract a tree branch item. The callback should
7507 * decide if the item can contract (has any children)
7508 * and then call elm_genlist_item_expanded_set()
7509 * appropriately to set the state. The event_info
7510 * parameter is the genlist item that was indicated to
7512 * "realized" - This is called when the item in the list is created as a real
7513 * evas object. event_info parameter is the genlist item that
7514 * was created. The object may be deleted at any time, so it is
7515 * up to the caller to not use the object pointer from
7516 * elm_genlist_item_object_get() in a way where it may point to
7518 * "unrealized" - This is called just before an item is unrealized. After
7519 * this call icon objects provided will be deleted and the
7520 * item object itself delete or be put into a floating cache.
7521 * "drag,start,up" - This is called when the item in the list has been
7522 * dragged (not scrolled) up.
7523 * "drag,start,down" - This is called when the item in the list has been
7524 * dragged (not scrolled) down.
7525 * "drag,start,left" - This is called when the item in the list has been
7526 * dragged (not scrolled) left.
7527 * "drag,start,right" - This is called when the item in the list has been
7528 * dragged (not scrolled) right.
7529 * "drag,stop" - This is called when the item in the list has stopped being
7531 * "drag" - This is called when the item in the list is being dragged.
7532 * "longpressed" - This is called when the item is pressed for a certain
7533 * amount of time. By default it's 1 second.
7534 * "scroll,edge,top" - This is called when the genlist is scrolled until the
7536 * "scroll,edge,bottom" - This is called when the genlist is scrolled until
7538 * "scroll,edge,left" - This is called when the genlist is scrolled until the
7540 * "scroll,edge,right" - This is called when the genlist is scrolled until
7542 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
7544 * "multi,swipe,right" - This is called when the genlist is multi-touch
7546 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
7548 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
7550 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
7552 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
7554 * "swipe" - This is called when the genlist is swiped.
7558 * @page tutorial_check Check example
7559 * @dontinclude check_example_01.c
7561 * This example will show 2 checkboxes, one with just a label and the second
7562 * one with both a label and an icon. This example also ilustrates how to
7563 * have the checkbox change the value of a variable and how to react to those
7566 * We will start with the usual setup code:
7569 * And now we create our first checkbox, set its label, tell it to change
7570 * the value of @p value when the checkbox stats is changed and ask to be
7571 * notified of state changes:
7574 * For our second checkbox we are going to set an icon so we need to create
7577 * @note For simplicity we are using a rectangle as icon, but any evas object
7580 * And for our second checkbox we set the label, icon and state to true:
7583 * We now do some more setup:
7586 * And finally implement the callback that will be called when the first
7587 * checkbox's state changes. This callback will use @p data to print a
7590 * @note This work because @p data is @p value(from the main function) and @p
7591 * value is changed when the checkbox is changed.
7593 * Our example will look like this:
7595 * @image html screenshots/check_example_01.png
7596 * @image latex screenshots/check_example_01.eps width=\textwidth
7598 * @example check_example_01.c
7601 * @defgroup Check Check
7603 * @image html img/widget/button/preview-00.png
7604 * @image html img/widget/button/preview-01.png
7605 * @image html img/widget/button/preview-02.png
7607 * @brief The check widget allows for toggling a value between true and
7610 * Check objects are a lot like radio objects in layout and functionality
7611 * except they do not work as a group, but independently and only toggle the
7612 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
7613 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
7614 * returns the current state. For convenience, like the radio objects, you
7615 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
7618 * Signals that you can add callbacks for are:
7619 * "changed" - This is called whenever the user changes the state of one of
7620 * the check object(event_info is NULL).
7622 * @ref tutorial_check should give you a firm grasp of how to use this widget.
7626 * @brief Add a new Check object
7628 * @param parent The parent object
7629 * @return The new object or NULL if it cannot be created
7631 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7633 * @brief Set the text label of the check object
7635 * @param obj The check object
7636 * @param label The text label string in UTF-8
7638 * @deprecated use elm_object_text_set() instead.
7640 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7642 * @brief Get the text label of the check object
7644 * @param obj The check object
7645 * @return The text label string in UTF-8
7647 * @deprecated use elm_object_text_get() instead.
7649 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7651 * @brief Set the icon object of the check object
7653 * @param obj The check object
7654 * @param icon The icon object
7656 * Once the icon object is set, a previously set one will be deleted.
7657 * If you want to keep that old content object, use the
7658 * elm_check_icon_unset() function.
7660 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7662 * @brief Get the icon object of the check object
7664 * @param obj The check object
7665 * @return The icon object
7667 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7669 * @brief Unset the icon used for the check object
7671 * @param obj The check object
7672 * @return The icon object that was being used
7674 * Unparent and return the icon object which was set for this widget.
7676 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7678 * @brief Set the on/off state of the check object
7680 * @param obj The check object
7681 * @param state The state to use (1 == on, 0 == off)
7683 * This sets the state of the check. If set
7684 * with elm_check_state_pointer_set() the state of that variable is also
7685 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
7687 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7689 * @brief Get the state of the check object
7691 * @param obj The check object
7692 * @return The boolean state
7694 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7696 * @brief Set a convenience pointer to a boolean to change
7698 * @param obj The check object
7699 * @param statep Pointer to the boolean to modify
7701 * This sets a pointer to a boolean, that, in addition to the check objects
7702 * state will also be modified directly. To stop setting the object pointed
7703 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
7704 * then when this is called, the check objects state will also be modified to
7705 * reflect the value of the boolean @p statep points to, just like calling
7706 * elm_check_state_set().
7708 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7714 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7715 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7716 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7717 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7718 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7719 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7720 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
7721 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
7722 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7723 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
7724 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7725 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
7726 /* smart callbacks called:
7727 * "changed" - when the radio status is changed
7731 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7732 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7733 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
7734 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7735 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7736 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7737 /* available item styles:
7743 /* smart callbacks called:
7744 * "hide,finished" - when the previous page is hided
7747 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
7748 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
7749 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
7750 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
7751 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
7753 struct _Elm_Slideshow_Item_Class
7755 struct _Elm_Slideshow_Item_Class_Func
7757 SlideshowItemGetFunc get;
7758 SlideshowItemDelFunc del;
7762 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7763 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
7764 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);
7765 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
7766 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
7767 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
7768 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7769 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
7770 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7771 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7772 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7773 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
7774 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7775 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7776 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7777 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
7778 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
7779 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7780 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
7781 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
7782 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7783 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
7784 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7785 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
7786 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7787 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
7788 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7789 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7790 /* smart callbacks called:
7791 * "changed" - when the slideshow switch to another item
7795 * @defgroup Fileselector File Selector
7797 * @image html img/icon/fileselector/preview-00.png
7798 * @image latex img/icon/fileselector/preview-00.png
7800 * A file selector is a widget that allows a user to navigate
7801 * through a file system, reporting file selections back via its
7804 * It contains shortcut buttons for home directory (@c ~) and to
7805 * jump one directory upwards (..), as well as cancel/ok buttons to
7806 * confirm/cancel a given selection. After either one of those two
7807 * former actions, the file selector will issue its @c "done" smart
7810 * There's a text entry on it, too, showing the name of the current
7811 * selection. There's the possibility of making it editable, so it
7812 * is useful on file saving dialogs on applications, where one
7813 * gives a file name to save contents to, in a given directory in
7814 * the system. This custom file name will be reported on the @c
7815 * "done" smart callback (explained in sequence).
7817 * Finally, it has a view to display file system items into in two
7822 * If Elementary is built with support of the Ethumb thumbnailing
7823 * library, the second form of view will display preview thumbnails
7824 * of files which it supports.
7826 * Smart callbacks one can register to:
7828 * - @c "selected" - the user has clicked on a file (when not in
7829 * folders-only mode) or directory (when in folders-only mode)
7830 * - @c "directory,open" - the list has been populated with new
7831 * content (@c event_info is a pointer to the directory's
7832 * path, a @b stringshared string)
7833 * - @c "done" - the user has clicked on the "ok" or "cancel"
7834 * buttons (@c event_info is a pointer to the selection's
7835 * path, a @b stringshared string)
7837 * Here is an example on its usage:
7838 * @li @ref fileselector_example
7842 * @addtogroup Fileselector
7847 * Defines how a file selector widget is to layout its contents
7848 * (file system entries).
7850 typedef enum _Elm_Fileselector_Mode
7852 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
7853 ELM_FILESELECTOR_GRID, /**< layout as a grid */
7854 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
7855 } Elm_Fileselector_Mode;
7858 * Add a new file selector widget to the given parent Elementary
7859 * (container) object
7861 * @param parent The parent object
7862 * @return a new file selector widget handle or @c NULL, on errors
7864 * This function inserts a new file selector widget on the canvas.
7866 * @ingroup Fileselector
7868 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7871 * Enable/disable the file name entry box where the user can type
7872 * in a name for a file, in a given file selector widget
7874 * @param obj The file selector object
7875 * @param is_save @c EINA_TRUE to make the file selector a "saving
7876 * dialog", @c EINA_FALSE otherwise
7878 * Having the entry editable is useful on file saving dialogs on
7879 * applications, where one gives a file name to save contents to,
7880 * in a given directory in the system. This custom file name will
7881 * be reported on the @c "done" smart callback.
7883 * @see elm_fileselector_is_save_get()
7885 * @ingroup Fileselector
7887 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
7890 * Get whether the given file selector is in "saving dialog" mode
7892 * @param obj The file selector object
7893 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
7894 * mode, @c EINA_FALSE otherwise (and on errors)
7896 * @see elm_fileselector_is_save_set() for more details
7898 * @ingroup Fileselector
7900 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7903 * Enable/disable folder-only view for a given file selector widget
7905 * @param obj The file selector object
7906 * @param only @c EINA_TRUE to make @p obj only display
7907 * directories, @c EINA_FALSE to make files to be displayed in it
7910 * If enabled, the widget's view will only display folder items,
7913 * @see elm_fileselector_folder_only_get()
7915 * @ingroup Fileselector
7917 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
7920 * Get whether folder-only view is set for a given file selector
7923 * @param obj The file selector object
7924 * @return only @c EINA_TRUE if @p obj is only displaying
7925 * directories, @c EINA_FALSE if files are being displayed in it
7926 * too (and on errors)
7928 * @see elm_fileselector_folder_only_get()
7930 * @ingroup Fileselector
7932 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7935 * Enable/disable the "ok" and "cancel" buttons on a given file
7938 * @param obj The file selector object
7939 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
7941 * @note A file selector without those buttons will never emit the
7942 * @c "done" smart event, and is only usable if one is just hooking
7943 * to the other two events.
7945 * @see elm_fileselector_buttons_ok_cancel_get()
7947 * @ingroup Fileselector
7949 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
7952 * Get whether the "ok" and "cancel" buttons on a given file
7953 * selector widget are being shown.
7955 * @param obj The file selector object
7956 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
7957 * otherwise (and on errors)
7959 * @see elm_fileselector_buttons_ok_cancel_set() for more details
7961 * @ingroup Fileselector
7963 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7966 * Enable/disable a tree view in the given file selector widget,
7967 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
7969 * @param obj The file selector object
7970 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7973 * In a tree view, arrows are created on the sides of directories,
7974 * allowing them to expand in place.
7976 * @note If it's in other mode, the changes made by this function
7977 * will only be visible when one switches back to "list" mode.
7979 * @see elm_fileselector_expandable_get()
7981 * @ingroup Fileselector
7983 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
7986 * Get whether tree view is enabled for the given file selector
7989 * @param obj The file selector object
7990 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
7991 * otherwise (and or errors)
7993 * @see elm_fileselector_expandable_set() for more details
7995 * @ingroup Fileselector
7997 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8000 * Set, programmatically, the @b directory that a given file
8001 * selector widget will display contents from
8003 * @param obj The file selector object
8004 * @param path The path to display in @p obj
8006 * This will change the @b directory that @p obj is displaying. It
8007 * will also clear the text entry area on the @p obj object, which
8008 * displays select files' names.
8010 * @see elm_fileselector_path_get()
8012 * @ingroup Fileselector
8014 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
8017 * Get the parent directory's path that a given file selector
8018 * widget is displaying
8020 * @param obj The file selector object
8021 * @return The (full) path of the directory the file selector is
8022 * displaying, a @b stringshared string
8024 * @see elm_fileselector_path_set()
8026 * @ingroup Fileselector
8028 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8031 * Set, programmatically, the currently selected file/directory in
8032 * the given file selector widget
8034 * @param obj The file selector object
8035 * @param path The (full) path to a file or directory
8036 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
8037 * latter case occurs if the directory or file pointed to do not
8040 * @see elm_fileselector_selected_get()
8042 * @ingroup Fileselector
8044 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
8047 * Get the currently selected item's (full) path, in the given file
8050 * @param obj The file selector object
8051 * @return The absolute path of the selected item, a @b
8052 * stringshared string
8054 * @note Custom editions on @p obj object's text entry, if made,
8055 * will appear on the return string of this function, naturally.
8057 * @see elm_fileselector_selected_set() for more details
8059 * @ingroup Fileselector
8061 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8064 * Set the mode in which a given file selector widget will display
8065 * (layout) file system entries in its view
8067 * @param obj The file selector object
8068 * @param mode The mode of the fileselector, being it one of
8069 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
8070 * first one, naturally, will display the files in a list. The
8071 * latter will make the widget to display its entries in a grid
8074 * @note By using elm_fileselector_expandable_set(), the user may
8075 * trigger a tree view for that list.
8077 * @note If Elementary is built with support of the Ethumb
8078 * thumbnailing library, the second form of view will display
8079 * preview thumbnails of files which it supports. You must have
8080 * elm_need_ethumb() called in your Elementary for thumbnailing to
8083 * @see elm_fileselector_expandable_set().
8084 * @see elm_fileselector_mode_get().
8086 * @ingroup Fileselector
8088 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
8091 * Get the mode in which a given file selector widget is displaying
8092 * (layouting) file system entries in its view
8094 * @param obj The fileselector object
8095 * @return The mode in which the fileselector is at
8097 * @see elm_fileselector_mode_set() for more details
8099 * @ingroup Fileselector
8101 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8108 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8109 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
8110 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8111 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8112 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
8113 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8114 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8115 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8116 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8117 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8118 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8119 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
8120 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8121 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
8122 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8123 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8124 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8125 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
8126 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8127 /* smart callbacks called:
8129 /* available item styles:
8131 * wheel (simple style, no text, no progression, only pulse is available)
8135 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8136 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8137 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8138 /* smart callbacks called:
8142 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8143 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
8144 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8145 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
8146 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
8147 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
8148 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8149 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
8150 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8151 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
8152 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8153 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8154 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8155 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
8156 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
8157 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8158 /* smart callbacks called:
8159 * "changed" - when the spinner value changes
8160 * "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).
8162 /* available item styles:
8164 * vertical (two up/down buttons at the right side and text left aligned)
8168 * @defgroup Index Index
8170 * @image html img/widget/index/preview-00.png
8172 * An index widget gives you an index for fast access to whichever
8173 * group of other UI items one might have. It's a list of text
8174 * items (usually letters, for alphabetically ordered access).
8176 * Index widgets are by default hidden and just appear when the
8177 * user clicks over it's reserved area in the canvas. In its
8178 * default theme, it's an area one @ref Fingers "finger" wide on
8179 * the right side of the index widget's container.
8181 * When items on the index are selected, smart callbacks get
8182 * called, so that its user can make other container objects to
8183 * show a given area or child object depending on the index item
8184 * selected. You'd probably be using an index together with @ref
8185 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
8188 * Smart events one can add callbacks for are:
8189 * - @c "changed" - When the selected index item changes. @c
8190 * event_info is the selected item's data pointer.
8191 * - @c "delay,changed" - When the selected index item changes, but
8192 * after a small idling period. @c event_info is the selected
8193 * item's data pointer.
8194 * - @c "selected" - When the user releases a mouse button and
8195 * selects an item. @c event_info is the selected item's data
8197 * - @c "level,up" - when the user moves a finger from the first
8198 * level to the second level
8199 * - @c "level,down" - when the user moves a finger from the second
8200 * level to the first level
8202 * The @c "delay,changed" event is so that it'll wait a small time
8203 * before actually reporting those events and, moreover, just the
8204 * last event happening on those time frames will actually be
8207 * Here are some examples on its usage:
8208 * @li @ref index_example_01
8209 * @li @ref index_example_02
8217 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
8220 * Add a new index widget to the given parent Elementary
8221 * (container) object
8223 * @param parent The parent object
8224 * @return a new index widget handle or @c NULL, on errors
8226 * This function inserts a new index widget on the canvas.
8230 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8233 * Set whether a given index widget is or not visible,
8236 * @param obj The index object
8237 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
8239 * Not to be confused with visible as in @c evas_object_show() --
8240 * visible with regard to the widget's auto hiding feature.
8242 * @see elm_index_active_get()
8246 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
8249 * Get whether a given index widget is currently visible or not.
8251 * @param obj The index object
8252 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
8254 * @see elm_index_active_set() for more details
8258 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8261 * Set the items level for a given index widget.
8263 * @param obj The index object.
8264 * @param level @c 0 or @c 1, the currently implemented levels.
8266 * @see elm_index_item_level_get()
8270 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
8273 * Get the items level set for a given index widget.
8275 * @param obj The index object.
8276 * @return @c 0 or @c 1, which are the levels @p obj might be at.
8278 * @see elm_index_item_level_set() for more information
8282 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8285 * Returns the last selected item's data, for a given index widget.
8287 * @param obj The index object.
8288 * @return The item @b data associated to the last selected item on
8289 * @p obj (or @c NULL, on errors).
8291 * @warning The returned value is @b not an #Elm_Index_Item item
8292 * handle, but the data associated to it (see the @c item parameter
8293 * in elm_index_item_append(), as an example).
8297 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
8300 * Append a new item on a given index widget.
8302 * @param obj The index object.
8303 * @param letter Letter under which the item should be indexed
8304 * @param item The item data to set for the index's item
8306 * Despite the most common usage of the @p letter argument is for
8307 * single char strings, one could use arbitrary strings as index
8310 * @c item will be the pointer returned back on @c "changed", @c
8311 * "delay,changed" and @c "selected" smart events.
8315 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
8318 * Prepend a new item on a given index widget.
8320 * @param obj The index object.
8321 * @param letter Letter under which the item should be indexed
8322 * @param item The item data to set for the index's item
8324 * Despite the most common usage of the @p letter argument is for
8325 * single char strings, one could use arbitrary strings as index
8328 * @c item will be the pointer returned back on @c "changed", @c
8329 * "delay,changed" and @c "selected" smart events.
8333 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
8336 * Append a new item, on a given index widget, <b>after the item
8337 * having @p relative as data</b>.
8339 * @param obj The index object.
8340 * @param letter Letter under which the item should be indexed
8341 * @param item The item data to set for the index's item
8342 * @param relative The item data of the index item to be the
8343 * predecessor of this new one
8345 * Despite the most common usage of the @p letter argument is for
8346 * single char strings, one could use arbitrary strings as index
8349 * @c item will be the pointer returned back on @c "changed", @c
8350 * "delay,changed" and @c "selected" smart events.
8352 * @note If @p relative is @c NULL or if it's not found to be data
8353 * set on any previous item on @p obj, this function will behave as
8354 * elm_index_item_append().
8358 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
8361 * Prepend a new item, on a given index widget, <b>after the item
8362 * having @p relative as data</b>.
8364 * @param obj The index object.
8365 * @param letter Letter under which the item should be indexed
8366 * @param item The item data to set for the index's item
8367 * @param relative The item data of the index item to be the
8368 * successor of this new one
8370 * Despite the most common usage of the @p letter argument is for
8371 * single char strings, one could use arbitrary strings as index
8374 * @c item will be the pointer returned back on @c "changed", @c
8375 * "delay,changed" and @c "selected" smart events.
8377 * @note If @p relative is @c NULL or if it's not found to be data
8378 * set on any previous item on @p obj, this function will behave as
8379 * elm_index_item_prepend().
8383 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
8386 * Insert a new item into the given index widget, using @p cmp_func
8387 * function to sort items (by item data).
8389 * @param obj The index object.
8390 * @param letter Letter under which the item should be indexed
8391 * @param item The item data to set for the index's item
8392 * @param cmp_func The comparing function to be used to sort index
8393 * items <b>by #Elm_Index_Item item handles</b>
8394 * @param cmp_data_func A @b fallback function to be called for the
8395 * sorting of index items <b>by item data</b>). It will be used
8396 * when @p cmp_func returns @c 0 (equality), which means an index
8397 * item with provided item data already exists. To decide which
8398 * data item should be pointed to by the index item in question, @p
8399 * cmp_data_func will be used. If @p cmp_data_func returns a
8400 * non-negative value, the previous index item data will be
8401 * replaced by the given @p item pointer. If the previous data need
8402 * to be freed, it should be done by the @p cmp_data_func function,
8403 * because all references to it will be lost. If this function is
8404 * not provided (@c NULL is given), index items will be @b
8405 * duplicated, if @p cmp_func returns @c 0.
8407 * Despite the most common usage of the @p letter argument is for
8408 * single char strings, one could use arbitrary strings as index
8411 * @c item will be the pointer returned back on @c "changed", @c
8412 * "delay,changed" and @c "selected" smart events.
8416 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);
8419 * Remove an item from a given index widget, <b>to be referenced by
8420 * it's data value</b>.
8422 * @param obj The index object
8423 * @param item The item's data pointer for the item to be removed
8426 * If a deletion callback is set, via elm_index_item_del_cb_set(),
8427 * that callback function will be called by this one.
8429 * @warning The item to be removed from @p obj will be found via
8430 * its item data pointer, and not by an #Elm_Index_Item handle.
8434 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
8437 * Find a given index widget's item, <b>using item data</b>.
8439 * @param obj The index object
8440 * @param item The item data pointed to by the desired index item
8441 * @return The index item handle, if found, or @c NULL otherwise
8445 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
8448 * Removes @b all items from a given index widget.
8450 * @param obj The index object.
8452 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
8453 * that callback function will be called for each item in @p obj.
8457 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8460 * Go to a given items level on a index widget
8462 * @param obj The index object
8463 * @param level The index level (one of @c 0 or @c 1)
8467 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
8470 * Return the data associated with a given index widget item
8472 * @param it The index widget item handle
8473 * @return The data associated with @p it
8475 * @see elm_index_item_data_set()
8479 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
8482 * Set the data associated with a given index widget item
8484 * @param it The index widget item handle
8485 * @param data The new data pointer to set to @p it
8487 * This sets new item data on @p it.
8489 * @warning The old data pointer won't be touched by this function, so
8490 * the user had better to free that old data himself/herself.
8494 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
8497 * Set the function to be called when a given index widget item is freed.
8499 * @param it The item to set the callback on
8500 * @param func The function to call on the item's deletion
8502 * When called, @p func will have both @c data and @c event_info
8503 * arguments with the @p it item's data value and, naturally, the
8504 * @c obj argument with a handle to the parent index widget.
8508 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
8511 * Get the letter (string) set on a given index widget item.
8513 * @param it The index item handle
8514 * @return The letter string set on @p it
8518 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
8525 typedef enum _Elm_Photocam_Zoom_Mode
8527 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
8528 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
8529 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
8530 ELM_PHOTOCAM_ZOOM_MODE_LAST
8531 } Elm_Photocam_Zoom_Mode;
8533 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8534 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
8535 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8536 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
8537 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8538 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
8539 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8540 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
8541 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8542 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8543 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8544 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
8545 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8546 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8547 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8548 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8549 /* smart callbacks called:
8550 * "clicked" - when image clicked
8551 * "press" - when mouse/finger held down initially on image
8552 * "longpressed" - when mouse/finger held for long time on image
8553 * "clicked,double" - when mouse/finger double-clicked
8554 * "load" - when photo load begins
8555 * "loaded" - when photo load done
8556 * "load,detail" - when detailed image load begins
8557 * "loaded,detail" - when detailed image load done
8558 * "zoom,start" - when zooming started
8559 * "zoom,stop" - when zooming stopped
8560 * "zoom,change" - when auto zoom mode changed zoom level
8561 * "scroll - the content has been scrolled (moved)
8562 * "scroll,anim,start" - scrolling animation has started
8563 * "scroll,anim,stop" - scrolling animation has stopped
8564 * "scroll,drag,start" - dragging the contents around has started
8565 * "scroll,drag,stop" - dragging the contents around has stopped
8569 typedef enum _Elm_Map_Zoom_Mode
8571 ELM_MAP_ZOOM_MODE_MANUAL,
8572 ELM_MAP_ZOOM_MODE_AUTO_FIT,
8573 ELM_MAP_ZOOM_MODE_AUTO_FILL,
8574 ELM_MAP_ZOOM_MODE_LAST
8575 } Elm_Map_Zoom_Mode;
8577 typedef enum _Elm_Map_Route_Sources
8579 ELM_MAP_ROUTE_SOURCE_YOURS,
8580 ELM_MAP_ROUTE_SOURCE_MONAV,
8581 ELM_MAP_ROUTE_SOURCE_ORS,
8582 ELM_MAP_ROUTE_SOURCE_LAST
8583 } Elm_Map_Route_Sources;
8585 typedef enum _Elm_Map_Name_Sources
8587 ELM_MAP_NAME_SOURCE_NOMINATIM,
8588 ELM_MAP_NAME_SOURCE_LAST
8589 } Elm_Map_Name_Sources;
8591 typedef enum _Elm_Map_Route_Type
8593 ELM_MAP_ROUTE_TYPE_MOTOCAR,
8594 ELM_MAP_ROUTE_TYPE_BICYCLE,
8595 ELM_MAP_ROUTE_TYPE_FOOT,
8596 ELM_MAP_ROUTE_TYPE_LAST
8597 } Elm_Map_Route_Type;
8599 typedef enum _Elm_Map_Route_Method
8601 ELM_MAP_ROUTE_METHOD_FASTEST,
8602 ELM_MAP_ROUTE_METHOD_SHORTEST,
8603 ELM_MAP_ROUTE_METHOD_LAST
8604 } Elm_Map_Route_Method;
8606 typedef enum _Elm_Map_Name_Method
8608 ELM_MAP_NAME_METHOD_SEARCH,
8609 ELM_MAP_NAME_METHOD_REVERSE,
8610 ELM_MAP_NAME_METHOD_LAST
8611 } Elm_Map_Name_Method;
8613 typedef struct _Elm_Map_Marker Elm_Map_Marker;
8614 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
8615 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
8616 typedef struct _Elm_Map_Route Elm_Map_Route;
8617 typedef struct _Elm_Map_Name Elm_Map_Name;
8618 typedef struct _Elm_Map_Track Elm_Map_Track;
8620 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
8621 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
8622 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
8623 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
8625 typedef char *(*ElmMapModuleSourceFunc) (void);
8626 typedef int (*ElmMapModuleZoomMinFunc) (void);
8627 typedef int (*ElmMapModuleZoomMaxFunc) (void);
8628 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
8629 typedef int (*ElmMapModuleRouteSourceFunc) (void);
8630 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
8631 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
8632 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
8633 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
8635 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8636 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
8637 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8638 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
8639 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8640 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
8641 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
8642 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
8643 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
8644 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8645 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
8646 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8647 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
8648 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);
8649 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);
8650 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
8651 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
8652 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);
8653 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);
8654 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
8655 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8656 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
8657 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8658 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8659 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
8660 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8661 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8662 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
8663 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
8664 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
8665 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
8666 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
8667 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
8668 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
8669 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
8670 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
8671 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
8672 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
8673 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
8674 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
8675 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8676 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
8677 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8678 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
8679 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8680 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
8681 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8682 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
8683 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8684 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
8685 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8686 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);
8687 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8688 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
8689 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
8690 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8691 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8692 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8693 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
8694 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
8695 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
8696 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
8697 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);
8698 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8699 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8701 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
8703 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
8705 /* smart callbacks called:
8706 * "clicked" - when image clicked
8707 * "press" - when mouse/finger held down initially on image
8708 * "longpressed" - when mouse/finger held for long time on image
8709 * "clicked,double" - when mouse/finger double-clicked
8710 * "load,details" - when detailed image load begins
8711 * "loaded,details" - when detailed image load done
8712 * "zoom,start" - when zooming started
8713 * "zoom,stop" - when zooming stopped
8714 * "zoom,change" - when auto zoom mode changed zoom level
8715 * "scroll - the content has been scrolled (moved)
8716 * "scroll,anim,start" - scrolling animation has started
8717 * "scroll,anim,stop" - scrolling animation has stopped
8718 * "scroll,drag,start" - dragging the contents around has started
8719 * "scroll,drag,stop" - dragging the contents around has stopped
8723 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
8725 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
8727 EAPI double elm_route_lon_min_get(Evas_Object *obj);
8728 EAPI double elm_route_lat_min_get(Evas_Object *obj);
8729 EAPI double elm_route_lon_max_get(Evas_Object *obj);
8730 EAPI double elm_route_lat_max_get(Evas_Object *obj);
8734 typedef enum _Elm_Panel_Orient
8736 ELM_PANEL_ORIENT_TOP,
8737 ELM_PANEL_ORIENT_BOTTOM,
8738 ELM_PANEL_ORIENT_LEFT,
8739 ELM_PANEL_ORIENT_RIGHT,
8742 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8743 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
8744 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8745 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8746 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8747 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8748 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
8749 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8750 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
8756 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
8757 * Add events (move, start ...)
8759 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8760 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8761 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8762 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8763 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8764 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8765 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8766 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8767 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
8768 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8769 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8772 * @defgroup Flip Flip
8774 * This widget holds 2 content objects(Evas_Object): one on the front and one
8775 * on the back. It allows you to flip from front to back and vice-versa using
8776 * various animations.
8778 * If either the front or back contents are not set the flip will treat that
8779 * as transparent. So if you wore to set the front content but not the back,
8780 * and then call elm_flip_go() you would see whatever is below the flip.
8782 * For a list of supported animations see elm_flip_go().
8784 * Signals that you can add callbacks for are:
8785 * "animate,begin" - when a flip animation was started
8786 * "animate,done" - when a flip animation is finished
8788 * @ref tutorial_flip show how to use most of the API.
8792 typedef enum _Elm_Flip_Mode
8794 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
8795 ELM_FLIP_ROTATE_X_CENTER_AXIS,
8796 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
8797 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
8799 ELM_FLIP_CUBE_RIGHT,
8803 ELM_FLIP_PAGE_RIGHT,
8807 typedef enum _Elm_Flip_Interaction
8809 ELM_FLIP_INTERACTION_NONE,
8810 ELM_FLIP_INTERACTION_ROTATE,
8811 ELM_FLIP_INTERACTION_CUBE,
8812 ELM_FLIP_INTERACTION_PAGE
8813 } Elm_Flip_Interaction;
8814 typedef enum _Elm_Flip_Direction
8816 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
8817 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
8818 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
8819 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
8820 } Elm_Flip_Direction;
8822 * @brief Add a new flip to the parent
8824 * @param parent The parent object
8825 * @return The new object or NULL if it cannot be created
8827 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8829 * @brief Set the front content of the flip widget.
8831 * @param obj The flip object
8832 * @param content The new front content object
8834 * Once the content object is set, a previously set one will be deleted.
8835 * If you want to keep that old content object, use the
8836 * elm_flip_content_front_unset() function.
8838 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8840 * @brief Set the back content of the flip widget.
8842 * @param obj The flip object
8843 * @param content The new back content object
8845 * Once the content object is set, a previously set one will be deleted.
8846 * If you want to keep that old content object, use the
8847 * elm_flip_content_back_unset() function.
8849 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8851 * @brief Get the front content used for the flip
8853 * @param obj The flip object
8854 * @return The front content object that is being used
8856 * Return the front content object which is set for this widget.
8858 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8860 * @brief Get the back content used for the flip
8862 * @param obj The flip object
8863 * @return The back content object that is being used
8865 * Return the back content object which is set for this widget.
8867 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8869 * @brief Unset the front content used for the flip
8871 * @param obj The flip object
8872 * @return The front content object that was being used
8874 * Unparent and return the front content object which was set for this widget.
8876 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8878 * @brief Unset the back content used for the flip
8880 * @param obj The flip object
8881 * @return The back content object that was being used
8883 * Unparent and return the back content object which was set for this widget.
8885 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8887 * @brief Get flip front visibility state
8889 * @param obj The flip objct
8890 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
8893 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8895 * @brief Set flip perspective
8897 * @param obj The flip object
8898 * @param foc The coordinate to set the focus on
8899 * @param x The X coordinate
8900 * @param y The Y coordinate
8902 * @warning This function currently does nothing.
8904 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
8906 * @brief Runs the flip animation
8908 * @param obj The flip object
8909 * @param mode The mode type
8911 * Flips the front and back contents using the @p mode animation. This
8912 * efectively hides the currently visible content and shows the hidden one.
8914 * There a number of possible animations to use for the flipping:
8915 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
8916 * around a horizontal axis in the middle of its height, the other content
8917 * is shown as the other side of the flip.
8918 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
8919 * around a vertical axis in the middle of its width, the other content is
8920 * shown as the other side of the flip.
8921 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
8922 * around a diagonal axis in the middle of its width, the other content is
8923 * shown as the other side of the flip.
8924 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
8925 * around a diagonal axis in the middle of its height, the other content is
8926 * shown as the other side of the flip.
8927 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
8928 * as if the flip was a cube, the other content is show as the right face of
8930 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
8931 * right as if the flip was a cube, the other content is show as the left
8933 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
8934 * flip was a cube, the other content is show as the bottom face of the cube.
8935 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
8936 * the flip was a cube, the other content is show as the upper face of the
8938 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
8939 * if the flip was a book, the other content is shown as the page below that.
8940 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
8941 * as if the flip was a book, the other content is shown as the page below
8943 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
8944 * flip was a book, the other content is shown as the page below that.
8945 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
8946 * flip was a book, the other content is shown as the page below that.
8948 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
8950 * @brief Set the interactive flip mode
8952 * @param obj The flip object
8953 * @param mode The interactive flip mode to use
8955 * This sets if the flip should be interactive (allow user to click and
8956 * drag a side of the flip to reveal the back page and cause it to flip).
8957 * By default a flip is not interactive. You may also need to set which
8958 * sides of the flip are "active" for flipping and how much space they use
8959 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
8960 * and elm_flip_interacton_direction_hitsize_set()
8962 * The four avilable mode of interaction are:
8963 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
8964 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
8965 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
8966 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
8968 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
8969 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
8970 * happen, those can only be acheived with elm_flip_go();
8972 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
8974 * @brief Get the interactive flip mode
8976 * @param obj The flip object
8977 * @return The interactive flip mode
8979 * Returns the interactive flip mode set by elm_flip_interaction_set()
8981 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
8983 * @brief Set which directions of the flip respond to interactive flip
8985 * @param obj The flip object
8986 * @param dir The direction to change
8987 * @param enabled If that direction is enabled or not
8989 * By default all directions are disabled, so you may want to enable the
8990 * desired directions for flipping if you need interactive flipping. You must
8991 * call this function once for each direction that should be enabled.
8993 * @see elm_flip_interaction_set()
8995 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
8997 * @brief Get the enabled state of that flip direction
8999 * @param obj The flip object
9000 * @param dir The direction to check
9001 * @return If that direction is enabled or not
9003 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
9005 * @see elm_flip_interaction_set()
9007 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
9009 * @brief Set the amount of the flip that is sensitive to interactive flip
9011 * @param obj The flip object
9012 * @param dir The direction to modify
9013 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
9015 * Set the amount of the flip that is sensitive to interactive flip, with 0
9016 * representing no area in the flip and 1 representing the entire flip. There
9017 * is however a consideration to be made in that the area will never be
9018 * smaller than the finger size set(as set in your Elementary configuration).
9020 * @see elm_flip_interaction_set()
9022 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
9024 * @brief Get the amount of the flip that is sensitive to interactive flip
9026 * @param obj The flip object
9027 * @param dir The direction to check
9028 * @return The size set for that direction
9030 * Returns the amount os sensitive area set by
9031 * elm_flip_interacton_direction_hitsize_set().
9033 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
9039 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9040 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
9041 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9042 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
9043 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9044 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
9045 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9046 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
9047 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9048 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9049 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
9050 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
9051 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
9052 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9053 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
9054 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
9055 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
9056 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
9057 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
9058 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
9059 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
9060 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
9061 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
9062 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
9063 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
9064 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9065 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9066 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9067 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9068 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9069 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9070 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
9071 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
9072 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
9073 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9074 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);
9075 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9076 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9077 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);
9078 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9079 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);
9080 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
9081 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9082 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9083 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9084 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
9085 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9086 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9087 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9088 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);
9089 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);
9090 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);
9091 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);
9092 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);
9093 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);
9094 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
9095 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
9096 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
9097 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
9098 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9099 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9100 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
9103 * @defgroup Conformant Conformant
9104 * @ingroup Elementary
9106 * The aim is to provide a widget that can be used in elementary apps to
9107 * account for space taken up by the indicator, virtual keypad & softkey
9108 * windows when running the illume2 module of E17.
9110 * So conformant content will be sized and positioned considering the
9111 * space required for such stuff, and when they popup, as a keyboard
9112 * shows when an entry is selected, conformant content won't change.
9114 * Available styles for it:
9117 * See how to use this widget in this example:
9118 * @ref conformant_example
9122 * @addtogroup Conformant
9127 * Add a new conformant widget to the given parent Elementary
9128 * (container) object.
9130 * @param parent The parent object.
9131 * @return A new conformant widget handle or @c NULL, on errors.
9133 * This function inserts a new conformant widget on the canvas.
9135 * @ingroup Conformant
9137 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9140 * Set the content of the conformant widget.
9142 * @param obj The conformant object.
9143 * @param content The content to be displayed by the conformant.
9145 * Content will be sized and positioned considering the space required
9146 * to display a virtual keyboard. So it won't fill all the conformant
9147 * size. This way is possible to be sure that content won't resize
9148 * or be re-positioned after the keyboard is displayed.
9150 * Once the content object is set, a previously set one will be deleted.
9151 * If you want to keep that old content object, use the
9152 * elm_conformat_content_unset() function.
9154 * @see elm_conformant_content_unset()
9155 * @see elm_conformant_content_get()
9157 * @ingroup Conformant
9159 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9162 * Get the content of the conformant widget.
9164 * @param obj The conformant object.
9165 * @return The content that is being used.
9167 * Return the content object which is set for this widget.
9168 * It won't be unparent from conformant. For that, use
9169 * elm_conformant_content_unset().
9171 * @see elm_conformant_content_set() for more details.
9172 * @see elm_conformant_content_unset()
9174 * @ingroup Conformant
9176 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9179 * Unset the content of the conformant widget.
9181 * @param obj The conformant object.
9182 * @return The content that was being used.
9184 * Unparent and return the content object which was set for this widget.
9186 * @see elm_conformant_content_set() for more details.
9188 * @ingroup Conformant
9190 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9193 * Returns the Evas_Object that represents the content area.
9195 * @param obj The conformant object.
9196 * @return The content area of the widget.
9198 * @ingroup Conformant
9200 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9207 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9208 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9209 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9210 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9211 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
9212 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9213 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
9214 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9215 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
9216 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9219 * @defgroup Flipselector Flip Selector
9221 * A flip selector is a widget to show a set of @b text items, one
9222 * at a time, with the same sheet switching style as the @ref Clock
9223 * "clock" widget, when one changes the current displaying sheet
9224 * (thus, the "flip" in the name).
9226 * User clicks to flip sheets which are @b held for some time will
9227 * make the flip selector to flip continuosly and automatically for
9228 * the user. The interval between flips will keep growing in time,
9229 * so that it helps the user to reach an item which is distant from
9230 * the current selection.
9232 * Smart callbacks one can register to:
9233 * - @c "selected" - when the widget's selected text item is changed
9234 * - @c "overflowed" - when the widget's current selection is changed
9235 * from the first item in its list to the last
9236 * - @c "underflowed" - when the widget's current selection is changed
9237 * from the last item in its list to the first
9239 * Available styles for it:
9242 * Here is an example on its usage:
9243 * @li @ref flipselector_example
9247 * @addtogroup Flipselector
9251 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
9254 * Add a new flip selector widget to the given parent Elementary
9255 * (container) widget
9257 * @param parent The parent object
9258 * @return a new flip selector widget handle or @c NULL, on errors
9260 * This function inserts a new flip selector widget on the canvas.
9262 * @ingroup Flipselector
9264 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9267 * Programmatically select the next item of a flip selector widget
9269 * @param obj The flipselector object
9271 * @note The selection will be animated. Also, if it reaches the
9272 * end of its list of member items, it will continue with the first
9275 * @ingroup Flipselector
9277 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
9280 * Programmatically select the previous item of a flip selector
9283 * @param obj The flipselector object
9285 * @note The selection will be animated. Also, if it reaches the
9286 * beginning of its list of member items, it will continue with the
9287 * last one backwards.
9289 * @ingroup Flipselector
9291 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
9294 * Append a (text) item to a flip selector widget
9296 * @param obj The flipselector object
9297 * @param label The (text) label of the new item
9298 * @param func Convenience callback function to take place when
9300 * @param data Data passed to @p func, above
9301 * @return A handle to the item added or @c NULL, on errors
9303 * The widget's list of labels to show will be appended with the
9304 * given value. If the user wishes so, a callback function pointer
9305 * can be passed, which will get called when this same item is
9308 * @note The current selection @b won't be modified by appending an
9309 * element to the list.
9311 * @note The maximum length of the text label is going to be
9312 * determined <b>by the widget's theme</b>. Strings larger than
9313 * that value are going to be @b truncated.
9315 * @ingroup Flipselector
9317 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
9320 * Prepend a (text) item to a flip selector widget
9322 * @param obj The flipselector object
9323 * @param label The (text) label of the new item
9324 * @param func Convenience callback function to take place when
9326 * @param data Data passed to @p func, above
9327 * @return A handle to the item added or @c NULL, on errors
9329 * The widget's list of labels to show will be prepended with the
9330 * given value. If the user wishes so, a callback function pointer
9331 * can be passed, which will get called when this same item is
9334 * @note The current selection @b won't be modified by prepending
9335 * an element to the list.
9337 * @note The maximum length of the text label is going to be
9338 * determined <b>by the widget's theme</b>. Strings larger than
9339 * that value are going to be @b truncated.
9341 * @ingroup Flipselector
9343 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
9346 * Get the internal list of items in a given flip selector widget.
9348 * @param obj The flipselector object
9349 * @return The list of items (#Elm_Flipselector_Item as data) or @c
9352 * This list is @b not to be modified in any way and must not be
9353 * freed. Use the list members with functions like
9354 * elm_flipselector_item_label_set(),
9355 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
9356 * elm_flipselector_item_del(),
9357 * elm_flipselector_item_selected_get(),
9358 * elm_flipselector_item_selected_set().
9360 * @warning This list is only valid until @p obj object's internal
9361 * items list is changed. It should be fetched again with another
9362 * call to this function when changes happen.
9364 * @ingroup Flipselector
9366 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9369 * Get the first item in the given flip selector widget's list of
9372 * @param obj The flipselector object
9373 * @return The first item or @c NULL, if it has no items (and on
9376 * @see elm_flipselector_item_append()
9377 * @see elm_flipselector_last_item_get()
9379 * @ingroup Flipselector
9381 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9384 * Get the last item in the given flip selector widget's list of
9387 * @param obj The flipselector object
9388 * @return The last item or @c NULL, if it has no items (and on
9391 * @see elm_flipselector_item_prepend()
9392 * @see elm_flipselector_first_item_get()
9394 * @ingroup Flipselector
9396 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9399 * Get the currently selected item in a flip selector widget.
9401 * @param obj The flipselector object
9402 * @return The selected item or @c NULL, if the widget has no items
9405 * @ingroup Flipselector
9407 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9410 * Set whether a given flip selector widget's item should be the
9411 * currently selected one.
9413 * @param item The flip selector item
9414 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
9416 * This sets whether @p item is or not the selected (thus, under
9417 * display) one. If @p item is different than one under display,
9418 * the latter will be unselected. If the @p item is set to be
9419 * unselected, on the other hand, the @b first item in the widget's
9420 * internal members list will be the new selected one.
9422 * @see elm_flipselector_item_selected_get()
9424 * @ingroup Flipselector
9426 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9429 * Get whether a given flip selector widget's item is the currently
9432 * @param item The flip selector item
9433 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9436 * @see elm_flipselector_item_selected_set()
9438 * @ingroup Flipselector
9440 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9443 * Delete a given item from a flip selector widget.
9445 * @param item The item to delete
9447 * @ingroup Flipselector
9449 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9452 * Get the label of a given flip selector widget's item.
9454 * @param item The item to get label from
9455 * @return The text label of @p item or @c NULL, on errors
9457 * @see elm_flipselector_item_label_set()
9459 * @ingroup Flipselector
9461 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9464 * Set the label of a given flip selector widget's item.
9466 * @param item The item to set label on
9467 * @param label The text label string, in UTF-8 encoding
9469 * @see elm_flipselector_item_label_get()
9471 * @ingroup Flipselector
9473 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
9476 * Gets the item before @p item in a flip selector widget's
9477 * internal list of items.
9479 * @param item The item to fetch previous from
9480 * @return The item before the @p item, in its parent's list. If
9481 * there is no previous item for @p item or there's an
9482 * error, @c NULL is returned.
9484 * @see elm_flipselector_item_next_get()
9486 * @ingroup Flipselector
9488 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9491 * Gets the item after @p item in a flip selector widget's
9492 * internal list of items.
9494 * @param item The item to fetch next from
9495 * @return The item after the @p item, in its parent's list. If
9496 * there is no next item for @p item or there's an
9497 * error, @c NULL is returned.
9499 * @see elm_flipselector_item_next_get()
9501 * @ingroup Flipselector
9503 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9506 * Set the interval on time updates for an user mouse button hold
9507 * on a flip selector widget.
9509 * @param obj The flip selector object
9510 * @param interval The (first) interval value in seconds
9512 * This interval value is @b decreased while the user holds the
9513 * mouse pointer either flipping up or flipping doww a given flip
9516 * This helps the user to get to a given item distant from the
9517 * current one easier/faster, as it will start to flip quicker and
9518 * quicker on mouse button holds.
9520 * The calculation for the next flip interval value, starting from
9521 * the one set with this call, is the previous interval divided by
9522 * 1.05, so it decreases a little bit.
9524 * The default starting interval value for automatic flips is
9527 * @see elm_flipselector_interval_get()
9529 * @ingroup Flipselector
9531 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9534 * Get the interval on time updates for an user mouse button hold
9535 * on a flip selector widget.
9537 * @param obj The flip selector object
9538 * @return The (first) interval value, in seconds, set on it
9540 * @see elm_flipselector_interval_set() for more details
9542 * @ingroup Flipselector
9544 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9551 * @addtogroup Animator Animator
9552 * @ingroup Elementary
9554 * @brief Functions to ease creation of animations.
9556 * elm_animator is designed to provide an easy way to create animations.
9557 * Creating an animation with elm_animator is as simple as setting a
9558 * duration, an operating callback and telling it to run the animation.
9559 * However that is not the full extent of elm_animator's ability, animations
9560 * can be paused and resumed, reversed and the animation need not be linear.
9562 * To run an animation you must specify at least a duration and operation
9563 * callback, not setting any other properties will create a linear animation
9564 * that runs once and is not reversed.
9566 * @ref elm_animator_example_page_01 "This" example should make all of that
9569 * @warning elm_animator is @b not a widget.
9573 * @brief Type of curve desired for animation.
9575 * The speed in which an animation happens doesn't have to be linear, some
9576 * animations will look better if they're accelerating or decelerating, so
9577 * elm_animator provides four options in this regard:
9579 * @image html elm_animator_curve_style.png
9580 * @image latex elm_animator_curve_style.eps width=\textwidth
9581 * As can be seen in the image the speed of the animation will be:
9582 * @li ELM_ANIMATOR_CURVE_LINEAR constant
9583 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
9584 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
9585 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
9589 ELM_ANIMATOR_CURVE_LINEAR,
9590 ELM_ANIMATOR_CURVE_IN_OUT,
9591 ELM_ANIMATOR_CURVE_IN,
9592 ELM_ANIMATOR_CURVE_OUT
9593 } Elm_Animator_Curve_Style;
9594 typedef struct _Elm_Animator Elm_Animator;
9596 * Called back per loop of an elementary animators cycle
9597 * @param data user-data given to elm_animator_operation_callback_set()
9598 * @param animator the animator being run
9599 * @param double the position in the animation
9601 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
9603 * Called back when an elementary animator finishes
9604 * @param data user-data given to elm_animator_completion_callback_set()
9606 typedef void (*Elm_Animator_Completion_Cb) (void *data);
9609 * @brief Create a new animator.
9611 * @param[in] parent Parent object
9613 * The @a parent argument can be set to NULL for no parent. If a parent is set
9614 * there is no need to call elm_animator_del(), when the parent is deleted it
9615 * will delete the animator.
9616 * @deprecated Use @ref Transit instead.
9618 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
9620 * Deletes the animator freeing any resources it used. If the animator was
9621 * created with a NULL parent this must be called, otherwise it will be
9622 * automatically called when the parent is deleted.
9624 * @param[in] animator Animator object
9625 * @deprecated Use @ref Transit instead.
9627 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9629 * Set the duration of the animation.
9631 * @param[in] animator Animator object
9632 * @param[in] duration Duration in second
9633 * @deprecated Use @ref Transit instead.
9635 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
9637 * @brief Set the callback function for animator operation.
9639 * @param[in] animator Animator object
9640 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
9641 * @param[in] data Callback function user argument
9643 * The @p func callback will be called with a frame value in range [0, 1] which
9644 * indicates how far along the animation should be. It is the job of @p func to
9645 * actually change the state of any object(or objects) that are being animated.
9646 * @deprecated Use @ref Transit instead.
9648 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
9650 * Set the callback function for the when the animation ends.
9652 * @param[in] animator Animator object
9653 * @param[in] func Callback function pointe
9654 * @param[in] data Callback function user argument
9656 * @warning @a func will not be executed if elm_animator_stop() is called.
9657 * @deprecated Use @ref Transit instead.
9659 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
9661 * @brief Stop animator.
9663 * @param[in] animator Animator object
9665 * If called before elm_animator_animate() it does nothing. If there is an
9666 * animation in progress the animation will be stopped(the operation callback
9667 * will not be executed again) and it can't be restarted using
9668 * elm_animator_resume().
9669 * @deprecated Use @ref Transit instead.
9671 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9673 * Set the animator repeat count.
9675 * @param[in] animator Animator object
9676 * @param[in] repeat_cnt Repeat count
9677 * @deprecated Use @ref Transit instead.
9679 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
9681 * @brief Start animation.
9683 * @param[in] animator Animator object
9685 * This function starts the animation if the nescessary properties(duration
9686 * and operation callback) have been set. Once started the animation will
9687 * run until complete or elm_animator_stop() is called.
9688 * @deprecated Use @ref Transit instead.
9690 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9692 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
9694 * @param[in] animator Animator object
9695 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
9696 * @deprecated Use @ref Transit instead.
9698 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
9700 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
9702 * @param[in] animator Animator object
9703 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
9704 * @deprecated Use @ref Transit instead.
9706 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9708 * @brief Sets wether the animation should be automatically reversed.
9710 * @param[in] animator Animator object
9711 * @param[in] reverse Reverse or not
9713 * This controls wether the animation will be run on reverse imediately after
9714 * running forward. When this is set together with repetition the animation
9715 * will run in reverse once for each time it ran forward.@n
9716 * Runnin an animation in reverse is accomplished by calling the operation
9717 * callback with a frame value starting at 1 and diminshing until 0.
9718 * @deprecated Use @ref Transit instead.
9720 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
9722 * Gets wether the animation will automatically reversed
9724 * @param[in] animator Animator object
9725 * @deprecated Use @ref Transit instead.
9727 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9729 * Gets the status for the animator operation. The status of the animator @b
9730 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
9731 * only informs if the animation was started and has not ended(either normally
9732 * or through elm_animator_stop()).
9734 * @param[in] animator Animator object
9735 * @deprecated Use @ref Transit instead.
9737 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9739 * Gets how many times the animation will be repeated
9741 * @param[in] animator Animator object
9742 * @deprecated Use @ref Transit instead.
9744 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9746 * Pause the animator.
9748 * @param[in] animator Animator object
9750 * This causes the animation to be temporarily stopped(the operation callback
9751 * will not be called). If the animation is not yet running this is a no-op.
9752 * Once an animation has been paused with this function it can be resumed
9753 * using elm_animator_resume().
9754 * @deprecated Use @ref Transit instead.
9756 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9758 * @brief Resumes the animator.
9760 * @param[in] animator Animator object
9762 * Resumes an animation that was paused using elm_animator_pause(), after
9763 * calling this function calls to the operation callback will happen
9764 * normally. If an animation is stopped by means of elm_animator_stop it
9765 * @b can't be restarted with this function.@n
9767 * @warning When an animation is resumed it doesn't start from where it was paused, it
9768 * will go to where it would have been if it had not been paused. If an
9769 * animation with a duration of 3 seconds is paused after 1 second for 1 second
9770 * it will resume as if it had ben animating for 2 seconds, the operating
9771 * callback will be called with a frame value of aproximately 2/3.
9772 * @deprecated Use @ref Transit instead.
9774 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9780 * @defgroup Calendar Calendar
9781 * @ingroup Elementary
9783 * @image html img/widget/calendar/preview-00.png
9784 * @image latex img/widget/calendar/preview-00.eps
9786 * A calendar is a widget that displays a regular calendar, one
9787 * month at a time, to the user, and can allows the user to select a date.
9789 * It has support to adding check marks (holidays and checks are supported
9790 * by default theme).
9792 * Weekday names and the function used to format month and year to
9793 * be displayed can be set, giving more flexibility to this widget.
9795 * Smart callbacks one can register to:
9796 * - "changed" - emitted when the user selects a day or changes the
9797 * displayed month, what actually changes the selected day as well.
9799 * Available styles for it:
9803 * @li @ref calendar_example_01
9804 * @li @ref calendar_example_02
9805 * @li @ref calendar_example_03
9806 * @li @ref calendar_example_04
9807 * @li @ref calendar_example_05
9808 * @li @ref calendar_example_06
9812 * @addtogroup Calendar
9817 * Event periodicity, used to define if a mark should be repeated
9818 * @b beyond event's day. It's set when a mark is added.
9820 * So, for a mark added to 13th May with periodicity set to WEEKLY,
9821 * there will be marks every week after this date. Marks will be displayed
9822 * at 13th, 20th, 27th, 3rd June ...
9824 * Values don't work as bitmaks, only one can be choosen.
9826 * @see elm_calendar_mark_add()
9830 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
9831 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
9832 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
9833 ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
9834 ELM_CALENDAR_ANNUALLY /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
9835 } Elm_Calendar_Mark_Repeat;
9837 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
9840 * Add a new calendar widget to the given parent Elementary
9841 * (container) object.
9843 * @param parent The parent object.
9844 * @return a new calendar widget handle or @c NULL, on errors.
9846 * This function inserts a new calendar widget on the canvas.
9848 * @ref calendar_example_01
9852 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9855 * Get weekdays names displayed by the calendar.
9857 * @param obj The calendar object.
9858 * @return Array of seven strings to be used as weekday names.
9860 * By default, weekdays abbreviations get from system are displayed:
9861 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
9862 * The first string is related to Sunday, the second to Monday...
9864 * @see elm_calendar_weekdays_name_set()
9866 * @ref calendar_example_05
9870 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9873 * Set weekdays names to be displayed by the calendar.
9875 * @param obj The calendar object.
9876 * @param weedays Array of seven strings to be used as weekday names.
9877 * @warning It must have 7 elements, or it will access invalid memory.
9878 * @warning The strings must be NULL terminated ('@\0').
9880 * By default, weekdays abbreviations get from system are displayed:
9881 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
9883 * The first string should be related to Sunday, the second to Monday...
9885 * The usage should be like this:
9887 * const char *weekdays[] =
9889 * "Sunday", "Monday", "Tuesday", "Wednesday",
9890 * "Thursday", "Friday", "Saturday"
9892 * elm_calendar_weekdays_names_set(calendar, weekdays);
9895 * @see elm_calendar_weekdays_name_get()
9897 * @ref calendar_example_02
9901 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
9904 * Set the minimum and maximum values for the year
9906 * @param obj The calendar object
9907 * @param min The minimum year, greater than 1901;
9908 * @param max The maximum year;
9910 * Maximum must be greater than minimum, except if you don't wan't to set
9912 * Default values are 1902 and -1.
9914 * If the maximum year is a negative value, it will be limited depending
9915 * on the platform architecture (year 2037 for 32 bits);
9917 * @see elm_calendar_min_max_year_get()
9919 * @ref calendar_example_03
9923 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
9926 * Get the minimum and maximum values for the year
9928 * @param obj The calendar object.
9929 * @param min The minimum year.
9930 * @param max The maximum year.
9932 * Default values are 1902 and -1.
9934 * @see elm_calendar_min_max_year_get() for more details.
9936 * @ref calendar_example_05
9940 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
9943 * Enable or disable day selection
9945 * @param obj The calendar object.
9946 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
9949 * Enabled by default. If disabled, the user still can select months,
9950 * but not days. Selected days are highlighted on calendar.
9951 * It should be used if you won't need such selection for the widget usage.
9953 * When a day is selected, or month is changed, smart callbacks for
9954 * signal "changed" will be called.
9956 * @see elm_calendar_day_selection_enable_get()
9958 * @ref calendar_example_04
9962 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
9965 * Get a value whether day selection is enabled or not.
9967 * @see elm_calendar_day_selection_enable_set() for details.
9969 * @param obj The calendar object.
9970 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
9971 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
9973 * @ref calendar_example_05
9977 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9981 * Set selected date to be highlighted on calendar.
9983 * @param obj The calendar object.
9984 * @param selected_time A @b tm struct to represent the selected date.
9986 * Set the selected date, changing the displayed month if needed.
9987 * Selected date changes when the user goes to next/previous month or
9988 * select a day pressing over it on calendar.
9990 * @see elm_calendar_selected_time_get()
9992 * @ref calendar_example_04
9996 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
9999 * Get selected date.
10001 * @param obj The calendar object
10002 * @param selected_time A @b tm struct to point to selected date
10003 * @return EINA_FALSE means an error ocurred and returned time shouldn't
10006 * Get date selected by the user or set by function
10007 * elm_calendar_selected_time_set().
10008 * Selected date changes when the user goes to next/previous month or
10009 * select a day pressing over it on calendar.
10011 * @see elm_calendar_selected_time_get()
10013 * @ref calendar_example_05
10015 * @ingroup Calendar
10017 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
10020 * Set a function to format the string that will be used to display
10023 * @param obj The calendar object
10024 * @param format_function Function to set the month-year string given
10025 * the selected date
10027 * By default it uses strftime with "%B %Y" format string.
10028 * It should allocate the memory that will be used by the string,
10029 * that will be freed by the widget after usage.
10030 * A pointer to the string and a pointer to the time struct will be provided.
10035 * _format_month_year(struct tm *selected_time)
10038 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
10039 * return strdup(buf);
10042 * elm_calendar_format_function_set(calendar, _format_month_year);
10045 * @ref calendar_example_02
10047 * @ingroup Calendar
10049 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
10052 * Add a new mark to the calendar
10054 * @param obj The calendar object
10055 * @param mark_type A string used to define the type of mark. It will be
10056 * emitted to the theme, that should display a related modification on these
10057 * days representation.
10058 * @param mark_time A time struct to represent the date of inclusion of the
10059 * mark. For marks that repeats it will just be displayed after the inclusion
10060 * date in the calendar.
10061 * @param repeat Repeat the event following this periodicity. Can be a unique
10062 * mark (that don't repeat), daily, weekly, monthly or annually.
10063 * @return The created mark or @NULL upon failure.
10065 * Add a mark that will be drawn in the calendar respecting the insertion
10066 * time and periodicity. It will emit the type as signal to the widget theme.
10067 * Default theme supports "holiday" and "checked", but it can be extended.
10069 * It won't immediately update the calendar, drawing the marks.
10070 * For this, call elm_calendar_marks_draw(). However, when user selects
10071 * next or previous month calendar forces marks drawn.
10073 * Marks created with this method can be deleted with
10074 * elm_calendar_mark_del().
10078 * struct tm selected_time;
10079 * time_t current_time;
10081 * current_time = time(NULL) + 5 * 84600;
10082 * localtime_r(¤t_time, &selected_time);
10083 * elm_calendar_mark_add(cal, "holiday", selected_time,
10084 * ELM_CALENDAR_ANNUALLY);
10086 * current_time = time(NULL) + 1 * 84600;
10087 * localtime_r(¤t_time, &selected_time);
10088 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
10090 * elm_calendar_marks_draw(cal);
10093 * @see elm_calendar_marks_draw()
10094 * @see elm_calendar_mark_del()
10096 * @ref calendar_example_06
10098 * @ingroup Calendar
10100 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);
10103 * Delete mark from the calendar.
10105 * @param mark The mark to be deleted.
10107 * If deleting all calendar marks is required, elm_calendar_marks_clear()
10108 * should be used instead of getting marks list and deleting each one.
10110 * @see elm_calendar_mark_add()
10112 * @ref calendar_example_06
10114 * @ingroup Calendar
10116 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
10119 * Remove all calendar's marks
10121 * @param obj The calendar object.
10123 * @see elm_calendar_mark_add()
10124 * @see elm_calendar_mark_del()
10126 * @ingroup Calendar
10128 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10132 * Get a list of all the calendar marks.
10134 * @param obj The calendar object.
10135 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
10137 * @see elm_calendar_mark_add()
10138 * @see elm_calendar_mark_del()
10139 * @see elm_calendar_marks_clear()
10141 * @ingroup Calendar
10143 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10146 * Draw calendar marks.
10148 * @param obj The calendar object.
10150 * Should be used after adding, removing or clearing marks.
10151 * It will go through the entire marks list updating the calendar.
10152 * If lots of marks will be added, add all the marks and then call
10155 * When the month is changed, i.e. user selects next or previous month,
10156 * marks will be drawed.
10158 * @see elm_calendar_mark_add()
10159 * @see elm_calendar_mark_del()
10160 * @see elm_calendar_marks_clear()
10162 * @ref calendar_example_06
10164 * @ingroup Calendar
10166 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
10169 * Set a day text color to the same that represents Saturdays.
10171 * @param obj The calendar object.
10172 * @param pos The text position. Position is the cell counter, from left
10173 * to right, up to down. It starts on 0 and ends on 41.
10175 * @deprecated use elm_calendar_mark_add() instead like:
10178 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
10179 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
10182 * @see elm_calendar_mark_add()
10184 * @ingroup Calendar
10186 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10189 * Set a day text color to the same that represents Sundays.
10191 * @param obj The calendar object.
10192 * @param pos The text position. Position is the cell counter, from left
10193 * to right, up to down. It starts on 0 and ends on 41.
10195 * @deprecated use elm_calendar_mark_add() instead like:
10198 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
10199 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
10202 * @see elm_calendar_mark_add()
10204 * @ingroup Calendar
10206 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10209 * Set a day text color to the same that represents Weekdays.
10211 * @param obj The calendar object
10212 * @param pos The text position. Position is the cell counter, from left
10213 * to right, up to down. It starts on 0 and ends on 41.
10215 * @deprecated use elm_calendar_mark_add() instead like:
10218 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
10220 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
10221 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
10222 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
10223 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
10224 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
10225 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
10226 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
10227 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
10228 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
10231 * @see elm_calendar_mark_add()
10233 * @ingroup Calendar
10235 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10238 * Set the interval on time updates for an user mouse button hold
10239 * on calendar widgets' month selection.
10241 * @param obj The calendar object
10242 * @param interval The (first) interval value in seconds
10244 * This interval value is @b decreased while the user holds the
10245 * mouse pointer either selecting next or previous month.
10247 * This helps the user to get to a given month distant from the
10248 * current one easier/faster, as it will start to change quicker and
10249 * quicker on mouse button holds.
10251 * The calculation for the next change interval value, starting from
10252 * the one set with this call, is the previous interval divided by
10253 * 1.05, so it decreases a little bit.
10255 * The default starting interval value for automatic changes is
10258 * @see elm_calendar_interval_get()
10260 * @ingroup Calendar
10262 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10265 * Get the interval on time updates for an user mouse button hold
10266 * on calendar widgets' month selection.
10268 * @param obj The calendar object
10269 * @return The (first) interval value, in seconds, set on it
10271 * @see elm_calendar_interval_set() for more details
10273 * @ingroup Calendar
10275 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10282 * @defgroup Diskselector Diskselector
10283 * @ingroup Elementary
10285 * A diskselector is a kind of list widget. It scrolls horizontally,
10286 * and can contain label and icon objects. Three items are displayed
10287 * with the selected one in the middle.
10289 * It can act like a circular list with round mode and labels can be
10290 * reduced for a defined length for side items.
10292 * Smart callbacks one can listen to:
10293 * - "selected" - when item is selected, i.e. scroller stops.
10295 * Available styles for it:
10298 * List of examples:
10299 * @li @ref diskselector_example_01
10300 * @li @ref diskselector_example_02
10304 * @addtogroup Diskselector
10308 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item; /**< Item handle for a diskselector item. Created with elm_diskselector_item_append() and deleted with elm_diskselector_item_del(). */
10311 * Add a new diskselector widget to the given parent Elementary
10312 * (container) object.
10314 * @param parent The parent object.
10315 * @return a new diskselector widget handle or @c NULL, on errors.
10317 * This function inserts a new diskselector widget on the canvas.
10319 * @ingroup Diskselector
10321 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10324 * Enable or disable round mode.
10326 * @param obj The diskselector object.
10327 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
10330 * Disabled by default. If round mode is enabled the items list will
10331 * work like a circle list, so when the user reaches the last item,
10332 * the first one will popup.
10334 * @see elm_diskselector_round_get()
10336 * @ingroup Diskselector
10338 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
10341 * Get a value whether round mode is enabled or not.
10343 * @see elm_diskselector_round_set() for details.
10345 * @param obj The diskselector object.
10346 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
10347 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
10349 * @ingroup Diskselector
10351 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10354 * Get the side labels max length.
10356 * @deprecated use elm_diskselector_side_label_length_get() instead:
10358 * @param obj The diskselector object.
10359 * @return The max length defined for side labels, or 0 if not a valid
10362 * @ingroup Diskselector
10364 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10367 * Set the side labels max length.
10369 * @deprecated use elm_diskselector_side_label_length_set() instead:
10371 * @param obj The diskselector object.
10372 * @param len The max length defined for side labels.
10374 * @ingroup Diskselector
10376 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
10379 * Get the side labels max length.
10381 * @see elm_diskselector_side_label_length_set() for details.
10383 * @param obj The diskselector object.
10384 * @return The max length defined for side labels, or 0 if not a valid
10387 * @ingroup Diskselector
10389 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10392 * Set the side labels max length.
10394 * @param obj The diskselector object.
10395 * @param len The max length defined for side labels.
10397 * Length is the number of characters of items' label that will be
10398 * visible when it's set on side positions. It will just crop
10399 * the string after defined size. E.g.:
10401 * An item with label "January" would be displayed on side position as
10402 * "Jan" if max length is set to 3, or "Janu", if this property
10405 * When it's selected, the entire label will be displayed, except for
10406 * width restrictions. In this case label will be cropped and "..."
10407 * will be concatenated.
10409 * Default side label max length is 3.
10411 * This property will be applyed over all items, included before or
10412 * later this function call.
10414 * @ingroup Diskselector
10416 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
10419 * Set the number of items to be displayed.
10421 * @param obj The diskselector object.
10422 * @param num The number of items the diskselector will display.
10424 * Default value is 3, and also it's the minimun. If @p num is less
10425 * than 3, it will be set to 3.
10427 * Also, it can be set on theme, using data item @c display_item_num
10428 * on group "elm/diskselector/item/X", where X is style set.
10431 * group { name: "elm/diskselector/item/X";
10433 * item: "display_item_num" "5";
10436 * @ingroup Diskselector
10438 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
10441 * Set bouncing behaviour when the scrolled content reaches an edge.
10443 * Tell the internal scroller object whether it should bounce or not
10444 * when it reaches the respective edges for each axis.
10446 * @param obj The anchorview object.
10447 * @param h_bounce Whether to bounce or not in the horizontal axis.
10448 * @param v_bounce Whether to bounce or not in the vertical axis.
10450 * @see elm_scroller_bounce_set()
10452 * @ingroup Diskselector
10454 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
10457 * Get the bouncing behaviour of the internal scroller.
10459 * Get whether the internal scroller should bounce when the edge of each
10460 * axis is reached scrolling.
10462 * @param obj The anchorview object.
10463 * @param h_bounce Pointer where to store the bounce state of the horizontal
10465 * @param v_bounce Pointer where to store the bounce state of the vertical
10468 * @see elm_scroller_bounce_get()
10469 * @see elm_diskselector_bounce_set()
10471 * @ingroup Diskselector
10473 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
10476 * Get the scrollbar policy.
10478 * @see elm_diskselector_scroller_policy_get() for details.
10480 * @param obj The diskselector object.
10481 * @param policy_h Pointer where to store horizontal scrollbar policy.
10482 * @param policy_v Pointer where to store vertical scrollbar policy.
10484 * @ingroup Diskselector
10486 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);
10489 * Set the scrollbar policy.
10491 * @param obj The diskselector object.
10492 * @param policy_h Horizontal scrollbar policy.
10493 * @param policy_v Vertical scrollbar policy.
10495 * This sets the scrollbar visibility policy for the given scroller.
10496 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
10497 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
10498 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
10499 * This applies respectively for the horizontal and vertical scrollbars.
10501 * The both are disabled by default, i.e., are set to
10502 * #ELM_SCROLLER_POLICY_OFF.
10504 * @ingroup Diskselector
10506 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
10509 * Remove all diskselector's items.
10511 * @param obj The diskselector object.
10513 * @see elm_diskselector_item_del()
10514 * @see elm_diskselector_item_append()
10516 * @ingroup Diskselector
10518 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10521 * Get a list of all the diskselector items.
10523 * @param obj The diskselector object.
10524 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
10525 * or @c NULL on failure.
10527 * @see elm_diskselector_item_append()
10528 * @see elm_diskselector_item_del()
10529 * @see elm_diskselector_clear()
10531 * @ingroup Diskselector
10533 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10536 * Appends a new item to the diskselector object.
10538 * @param obj The diskselector object.
10539 * @param label The label of the diskselector item.
10540 * @param icon The icon object to use at left side of the item. An
10541 * icon can be any Evas object, but usually it is an icon created
10542 * with elm_icon_add().
10543 * @param func The function to call when the item is selected.
10544 * @param data The data to associate with the item for related callbacks.
10546 * @return The created item or @c NULL upon failure.
10548 * A new item will be created and appended to the diskselector, i.e., will
10549 * be set as last item. Also, if there is no selected item, it will
10550 * be selected. This will always happens for the first appended item.
10552 * If no icon is set, label will be centered on item position, otherwise
10553 * the icon will be placed at left of the label, that will be shifted
10556 * Items created with this method can be deleted with
10557 * elm_diskselector_item_del().
10559 * Associated @p data can be properly freed when item is deleted if a
10560 * callback function is set with elm_diskselector_item_del_cb_set().
10562 * If a function is passed as argument, it will be called everytime this item
10563 * is selected, i.e., the user stops the diskselector with this
10564 * item on center position. If such function isn't needed, just passing
10565 * @c NULL as @p func is enough. The same should be done for @p data.
10567 * Simple example (with no function callback or data associated):
10569 * disk = elm_diskselector_add(win);
10570 * ic = elm_icon_add(win);
10571 * elm_icon_file_set(ic, "path/to/image", NULL);
10572 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
10573 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
10576 * @see elm_diskselector_item_del()
10577 * @see elm_diskselector_item_del_cb_set()
10578 * @see elm_diskselector_clear()
10579 * @see elm_icon_add()
10581 * @ingroup Diskselector
10583 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);
10587 * Delete them item from the diskselector.
10589 * @param it The item of diskselector to be deleted.
10591 * If deleting all diskselector items is required, elm_diskselector_clear()
10592 * should be used instead of getting items list and deleting each one.
10594 * @see elm_diskselector_clear()
10595 * @see elm_diskselector_item_append()
10596 * @see elm_diskselector_item_del_cb_set()
10598 * @ingroup Diskselector
10600 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10603 * Set the function called when a diskselector item is freed.
10605 * @param it The item to set the callback on
10606 * @param func The function called
10608 * If there is a @p func, then it will be called prior item's memory release.
10609 * That will be called with the following arguments:
10611 * @li item's Evas object;
10614 * This way, a data associated to a diskselector item could be properly
10617 * @ingroup Diskselector
10619 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10622 * Get the data associated to the item.
10624 * @param it The diskselector item
10625 * @return The data associated to @p it
10627 * The return value is a pointer to data associated to @item when it was
10628 * created, with function elm_diskselector_item_append(). If no data
10629 * was passed as argument, it will return @c NULL.
10631 * @see elm_diskselector_item_append()
10633 * @ingroup Diskselector
10635 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10638 * Set the icon associated to the item.
10640 * @param it The diskselector item
10641 * @param icon The icon object to associate with @p it
10643 * The icon object to use at left side of the item. An
10644 * icon can be any Evas object, but usually it is an icon created
10645 * with elm_icon_add().
10647 * Once the icon object is set, a previously set one will be deleted.
10648 * @warning Setting the same icon for two items will cause the icon to
10649 * dissapear from the first item.
10651 * If an icon was passed as argument on item creation, with function
10652 * elm_diskselector_item_append(), it will be already
10653 * associated to the item.
10655 * @see elm_diskselector_item_append()
10656 * @see elm_diskselector_item_icon_get()
10658 * @ingroup Diskselector
10660 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
10663 * Get the icon associated to the item.
10665 * @param it The diskselector item
10666 * @return The icon associated to @p it
10668 * The return value is a pointer to the icon associated to @item when it was
10669 * created, with function elm_diskselector_item_append(), or later
10670 * with function elm_diskselector_item_icon_set. If no icon
10671 * was passed as argument, it will return @c NULL.
10673 * @see elm_diskselector_item_append()
10674 * @see elm_diskselector_item_icon_set()
10676 * @ingroup Diskselector
10678 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10682 * Set the label of item.
10684 * @param it The item of diskselector.
10685 * @param label The label of item.
10687 * The label to be displayed by the item.
10689 * If no icon is set, label will be centered on item position, otherwise
10690 * the icon will be placed at left of the label, that will be shifted
10693 * An item with label "January" would be displayed on side position as
10694 * "Jan" if max length is set to 3 with function
10695 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
10698 * When this @item is selected, the entire label will be displayed,
10699 * except for width restrictions.
10700 * In this case label will be cropped and "..." will be concatenated,
10701 * but only for display purposes. It will keep the entire string, so
10702 * if diskselector is resized the remaining characters will be displayed.
10704 * If a label was passed as argument on item creation, with function
10705 * elm_diskselector_item_append(), it will be already
10706 * displayed by the item.
10708 * @see elm_diskselector_side_label_lenght_set()
10709 * @see elm_diskselector_item_label_get()
10710 * @see elm_diskselector_item_append()
10712 * @ingroup Diskselector
10714 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
10717 * Get the label of item.
10719 * @param it The item of diskselector.
10720 * @return The label of item.
10722 * The return value is a pointer to the label associated to @item when it was
10723 * created, with function elm_diskselector_item_append(), or later
10724 * with function elm_diskselector_item_label_set. If no label
10725 * was passed as argument, it will return @c NULL.
10727 * @see elm_diskselector_item_label_set() for more details.
10728 * @see elm_diskselector_item_append()
10730 * @ingroup Diskselector
10732 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10735 * Get the selected item.
10737 * @param obj The diskselector object.
10738 * @return The selected diskselector item.
10740 * The selected item can be unselected with function
10741 * elm_diskselector_item_selected_set(), and the first item of
10742 * diskselector will be selected.
10744 * The selected item always will be centered on diskselector, with
10745 * full label displayed, i.e., max lenght set to side labels won't
10746 * apply on the selected item. More details on
10747 * elm_diskselector_side_label_length_set().
10749 * @ingroup Diskselector
10751 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10754 * Set the selected state of an item.
10756 * @param it The diskselector item
10757 * @param selected The selected state
10759 * This sets the selected state of the given item @p it.
10760 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
10762 * If a new item is selected the previosly selected will be unselected.
10763 * Previoulsy selected item can be get with function
10764 * elm_diskselector_selected_item_get().
10766 * If the item @p it is unselected, the first item of diskselector will
10769 * Selected items will be visible on center position of diskselector.
10770 * So if it was on another position before selected, or was invisible,
10771 * diskselector will animate items until the selected item reaches center
10774 * @see elm_diskselector_item_selected_get()
10775 * @see elm_diskselector_selected_item_get()
10777 * @ingroup Diskselector
10779 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
10782 * Get whether the @p item is selected or not.
10784 * @param it The diskselector item.
10785 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
10786 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
10788 * @see elm_diskselector_selected_item_set() for details.
10789 * @see elm_diskselector_item_selected_get()
10791 * @ingroup Diskselector
10793 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10796 * Get the first item of the diskselector.
10798 * @param obj The diskselector object.
10799 * @return The first item, or @c NULL if none.
10801 * The list of items follows append order. So it will return the first
10802 * item appended to the widget that wasn't deleted.
10804 * @see elm_diskselector_item_append()
10805 * @see elm_diskselector_items_get()
10807 * @ingroup Diskselector
10809 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10812 * Get the last item of the diskselector.
10814 * @param obj The diskselector object.
10815 * @return The last item, or @c NULL if none.
10817 * The list of items follows append order. So it will return last first
10818 * item appended to the widget that wasn't deleted.
10820 * @see elm_diskselector_item_append()
10821 * @see elm_diskselector_items_get()
10823 * @ingroup Diskselector
10825 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10828 * Get the item before @p item in diskselector.
10830 * @param it The diskselector item.
10831 * @return The item before @p item, or @c NULL if none or on failure.
10833 * The list of items follows append order. So it will return item appended
10834 * just before @item and that wasn't deleted.
10836 * If it is the first item, @c NULL will be returned.
10837 * First item can be get by elm_diskselector_first_item_get().
10839 * @see elm_diskselector_item_append()
10840 * @see elm_diskselector_items_get()
10842 * @ingroup Diskselector
10844 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10847 * Get the item after @p item in diskselector.
10849 * @param it The diskselector item.
10850 * @return The item after @p item, or @c NULL if none or on failure.
10852 * The list of items follows append order. So it will return item appended
10853 * just after @item and that wasn't deleted.
10855 * If it is the last item, @c NULL will be returned.
10856 * Last item can be get by elm_diskselector_last_item_get().
10858 * @see elm_diskselector_item_append()
10859 * @see elm_diskselector_items_get()
10861 * @ingroup Diskselector
10863 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10866 * Set the text to be shown in the diskselector item.
10868 * @param item Target item
10869 * @param text The text to set in the content
10871 * Setup the text as tooltip to object. The item can have only one tooltip,
10872 * so any previous tooltip data is removed.
10874 * @see elm_object_tooltip_text_set() for more details.
10876 * @ingroup Diskselector
10878 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
10881 * Set the content to be shown in the tooltip item.
10883 * Setup the tooltip to item. The item can have only one tooltip,
10884 * so any previous tooltip data is removed. @p func(with @p data) will
10885 * be called every time that need show the tooltip and it should
10886 * return a valid Evas_Object. This object is then managed fully by
10887 * tooltip system and is deleted when the tooltip is gone.
10889 * @param item the diskselector item being attached a tooltip.
10890 * @param func the function used to create the tooltip contents.
10891 * @param data what to provide to @a func as callback data/context.
10892 * @param del_cb called when data is not needed anymore, either when
10893 * another callback replaces @func, the tooltip is unset with
10894 * elm_diskselector_item_tooltip_unset() or the owner @a item
10895 * dies. This callback receives as the first parameter the
10896 * given @a data, and @c event_info is the item.
10898 * @see elm_object_tooltip_content_cb_set() for more details.
10900 * @ingroup Diskselector
10902 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);
10905 * Unset tooltip from item.
10907 * @param item diskselector item to remove previously set tooltip.
10909 * Remove tooltip from item. The callback provided as del_cb to
10910 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
10911 * it is not used anymore.
10913 * @see elm_object_tooltip_unset() for more details.
10914 * @see elm_diskselector_item_tooltip_content_cb_set()
10916 * @ingroup Diskselector
10918 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10922 * Sets a different style for this item tooltip.
10924 * @note before you set a style you should define a tooltip with
10925 * elm_diskselector_item_tooltip_content_cb_set() or
10926 * elm_diskselector_item_tooltip_text_set()
10928 * @param item diskselector item with tooltip already set.
10929 * @param style the theme style to use (default, transparent, ...)
10931 * @see elm_object_tooltip_style_set() for more details.
10933 * @ingroup Diskselector
10935 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
10938 * Get the style for this item tooltip.
10940 * @param item diskselector item with tooltip already set.
10941 * @return style the theme style in use, defaults to "default". If the
10942 * object does not have a tooltip set, then NULL is returned.
10944 * @see elm_object_tooltip_style_get() for more details.
10945 * @see elm_diskselector_item_tooltip_style_set()
10947 * @ingroup Diskselector
10949 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10952 * Set the cursor to be shown when mouse is over the diskselector item
10954 * @param item Target item
10955 * @param cursor the cursor name to be used.
10957 * @see elm_object_cursor_set() for more details.
10959 * @ingroup Diskselector
10961 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10964 * Get the cursor to be shown when mouse is over the diskselector item
10966 * @param item diskselector item with cursor already set.
10967 * @return the cursor name.
10969 * @see elm_object_cursor_get() for more details.
10970 * @see elm_diskselector_cursor_set()
10972 * @ingroup Diskselector
10974 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10978 * Unset the cursor to be shown when mouse is over the diskselector item
10980 * @param item Target item
10982 * @see elm_object_cursor_unset() for more details.
10983 * @see elm_diskselector_cursor_set()
10985 * @ingroup Diskselector
10987 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10990 * Sets a different style for this item cursor.
10992 * @note before you set a style you should define a cursor with
10993 * elm_diskselector_item_cursor_set()
10995 * @param item diskselector item with cursor already set.
10996 * @param style the theme style to use (default, transparent, ...)
10998 * @see elm_object_cursor_style_set() for more details.
11000 * @ingroup Diskselector
11002 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
11006 * Get the style for this item cursor.
11008 * @param item diskselector item with cursor already set.
11009 * @return style the theme style in use, defaults to "default". If the
11010 * object does not have a cursor set, then @c NULL is returned.
11012 * @see elm_object_cursor_style_get() for more details.
11013 * @see elm_diskselector_item_cursor_style_set()
11015 * @ingroup Diskselector
11017 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
11021 * Set if the cursor set should be searched on the theme or should use
11022 * the provided by the engine, only.
11024 * @note before you set if should look on theme you should define a cursor
11025 * with elm_diskselector_item_cursor_set().
11026 * By default it will only look for cursors provided by the engine.
11028 * @param item widget item with cursor already set.
11029 * @param engine_only boolean to define if cursors set with
11030 * elm_diskselector_item_cursor_set() should be searched only
11031 * between cursors provided by the engine or searched on widget's
11034 * @see elm_object_cursor_engine_only_set() for more details.
11036 * @ingroup Diskselector
11038 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11041 * Get the cursor engine only usage for this item cursor.
11043 * @param item widget item with cursor already set.
11044 * @return engine_only boolean to define it cursors should be looked only
11045 * between the provided by the engine or searched on widget's theme as well.
11046 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
11048 * @see elm_object_cursor_engine_only_get() for more details.
11049 * @see elm_diskselector_item_cursor_engine_only_set()
11051 * @ingroup Diskselector
11053 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
11060 * @page tutorial_colorselector Color selector example
11061 * @dontinclude colorselector_example_01.c
11063 * This example shows how to change the color of a rectangle using a color
11064 * selector. We aren't going to explain a lot of the code since it's the
11065 * usual setup code:
11066 * @until show(rect)
11068 * Now that we have a window with background and a rectangle we can create
11069 * our color_selector and set it's initial color to fully opaque blue:
11072 * Next we tell ask to be notified whenever the color changes:
11075 * We follow that we some more run of the mill setup code:
11076 * @until ELM_MAIN()
11078 * And now get to the callback that sets the color of the rectangle:
11081 * This example will look like this:
11083 * @image html screenshots/colorselector_example_01.png
11084 * @image latex screenshots/colorselector_example_01.eps width=\textwidth
11086 * @example colorselector_example_01.c
11089 * @defgroup Colorselector Colorselector
11093 * @image html img/widget/colorselector/preview-00.png
11095 * @brief Widget for user to select a color.
11097 * Signals that you can add callbacks for are:
11098 * "changed" - When the color value changes(event_info is NULL).
11100 * See @ref tutorial_colorselector.
11103 * @brief Add a new colorselector to the parent
11105 * @param parent The parent object
11106 * @return The new object or NULL if it cannot be created
11108 * @ingroup Colorselector
11110 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11112 * Set a color for the colorselector
11114 * @param obj Colorselector object
11115 * @param r r-value of color
11116 * @param g g-value of color
11117 * @param b b-value of color
11118 * @param a a-value of color
11120 * @ingroup Colorselector
11122 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
11124 * Get a color from the colorselector
11126 * @param obj Colorselector object
11127 * @param r integer pointer for r-value of color
11128 * @param g integer pointer for g-value of color
11129 * @param b integer pointer for b-value of color
11130 * @param a integer pointer for a-value of color
11132 * @ingroup Colorselector
11134 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
11140 * @defgroup Ctxpopup
11142 * @image html img/widget/ctxpopup/preview-00.png
11143 * @image latex img/widget/ctxpopup/preview-00.eps
11145 * @brief Context popup widet.
11147 * A ctxpopup is a widget that, when shown, pops up a list of items.
11148 * It automatically chooses an area inside its parent object's view
11149 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
11150 * optimally fit into it. In the default theme, it will also point an
11151 * arrow to it's top left position at the time one shows it. Ctxpopup
11152 * items have a label and/or an icon. It is intended for a small
11153 * number of items (hence the use of list, not genlist).
11155 * @note Ctxpopup is a especialization of @ref Hover.
11157 * Signals that you can add callbacks for are:
11158 * "dismissed" - the ctxpopup was dismissed
11160 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
11163 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
11165 typedef enum _Elm_Ctxpopup_Direction
11167 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
11169 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
11170 the clicked area */
11171 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
11172 the clicked area */
11173 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
11175 } Elm_Ctxpopup_Direction;
11178 * @brief Add a new Ctxpopup object to the parent.
11180 * @param parent Parent object
11181 * @return New object or @c NULL, if it cannot be created
11183 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11185 * @brief Set the Ctxpopup's parent
11187 * @param obj The ctxpopup object
11188 * @param area The parent to use
11190 * Set the parent object.
11192 * @note elm_ctxpopup_add() will automatically call this function
11193 * with its @c parent argument.
11195 * @see elm_ctxpopup_add()
11196 * @see elm_hover_parent_set()
11198 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
11200 * @brief Get the Ctxpopup's parent
11202 * @param obj The ctxpopup object
11204 * @see elm_ctxpopup_hover_parent_set() for more information
11206 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11208 * @brief Clear all items in the given ctxpopup object.
11210 * @param obj Ctxpopup object
11212 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11214 * @brief Change the ctxpopup's orientation to horizontal or vertical.
11216 * @param obj Ctxpopup object
11217 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
11219 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
11221 * @brief Get the value of current ctxpopup object's orientation.
11223 * @param obj Ctxpopup object
11224 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
11226 * @see elm_ctxpopup_horizontal_set()
11228 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11230 * @brief Add a new item to a ctxpopup object.
11232 * @param obj Ctxpopup object
11233 * @param icon Icon to be set on new item
11234 * @param label The Label of the new item
11235 * @param func Convenience function called when item selected
11236 * @param data Data passed to @p func
11237 * @return A handle to the item added or @c NULL, on errors
11239 * @warning Ctxpopup can't hold both an item list and a content at the same
11240 * time. When an item is added, any previous content will be removed.
11242 * @see elm_ctxpopup_content_set()
11244 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);
11246 * @brief Delete the given item in a ctxpopup object.
11248 * @param item Ctxpopup item to be deleted
11250 * @see elm_ctxpopup_item_append()
11252 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
11254 * @brief Set the ctxpopup item's state as disabled or enabled.
11256 * @param item Ctxpopup item to be enabled/disabled
11257 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
11259 * When disabled the item is greyed out to indicate it's state.
11261 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11263 * @brief Get the ctxpopup item's disabled/enabled state.
11265 * @param item Ctxpopup item to be enabled/disabled
11266 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
11268 * @see elm_ctxpopup_item_disabled_set()
11270 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
11272 * @brief Get the icon object for the given ctxpopup item.
11274 * @param item Ctxpopup item
11275 * @return icon object or @c NULL, if the item does not have icon or an error
11278 * @see elm_ctxpopup_item_append()
11279 * @see elm_ctxpopup_item_icon_set()
11281 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
11283 * @brief Sets the side icon associated with the ctxpopup item
11285 * @param item Ctxpopup item
11286 * @param icon Icon object to be set
11288 * Once the icon object is set, a previously set one will be deleted.
11289 * @warning Setting the same icon for two items will cause the icon to
11290 * dissapear from the first item.
11292 * @see elm_ctxpopup_item_append()
11294 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
11296 * @brief Get the label for the given ctxpopup item.
11298 * @param item Ctxpopup item
11299 * @return label string or @c NULL, if the item does not have label or an
11302 * @see elm_ctxpopup_item_append()
11303 * @see elm_ctxpopup_item_label_set()
11305 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
11307 * @brief (Re)set the label on the given ctxpopup item.
11309 * @param item Ctxpopup item
11310 * @param label String to set as label
11312 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
11314 * @brief Set an elm widget as the content of the ctxpopup.
11316 * @param obj Ctxpopup object
11317 * @param content Content to be swallowed
11319 * If the content object is already set, a previous one will bedeleted. If
11320 * you want to keep that old content object, use the
11321 * elm_ctxpopup_content_unset() function.
11323 * @warning Ctxpopup can't hold both a item list and a content at the same
11324 * time. When a content is set, any previous items will be removed.
11326 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
11328 * @brief Unset the ctxpopup content
11330 * @param obj Ctxpopup object
11331 * @return The content that was being used
11333 * Unparent and return the content object which was set for this widget.
11335 * @see elm_ctxpopup_content_set()
11337 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11339 * @brief Set the direction priority of a ctxpopup.
11341 * @param obj Ctxpopup object
11342 * @param first 1st priority of direction
11343 * @param second 2nd priority of direction
11344 * @param third 3th priority of direction
11345 * @param fourth 4th priority of direction
11347 * This functions gives a chance to user to set the priority of ctxpopup
11348 * showing direction. This doesn't guarantee the ctxpopup will appear in the
11349 * requested direction.
11351 * @see Elm_Ctxpopup_Direction
11353 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);
11355 * @brief Get the direction priority of a ctxpopup.
11357 * @param obj Ctxpopup object
11358 * @param first 1st priority of direction to be returned
11359 * @param second 2nd priority of direction to be returned
11360 * @param third 3th priority of direction to be returned
11361 * @param fourth 4th priority of direction to be returned
11363 * @see elm_ctxpopup_direction_priority_set() for more information.
11365 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);
11373 * @defgroup Transit Transit
11374 * @ingroup Elementary
11376 * Transit is designed to apply various animated transition effects to @c
11377 * Evas_Object, such like translation, rotation, etc. For using these
11378 * effects, create an @ref Elm_Transit and add the desired transition effects.
11380 * Once the effects are added into transit, they will be automatically
11381 * managed (their callback will be called until the duration is ended, and
11382 * they will be deleted on completion).
11386 * Elm_Transit *trans = elm_transit_add();
11387 * elm_transit_object_add(trans, obj);
11388 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
11389 * elm_transit_duration_set(transit, 1);
11390 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
11391 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
11392 * elm_transit_repeat_times_set(transit, 3);
11395 * Some transition effects are used to change the properties of objects. They
11397 * @li @ref elm_transit_effect_translation_add
11398 * @li @ref elm_transit_effect_color_add
11399 * @li @ref elm_transit_effect_rotation_add
11400 * @li @ref elm_transit_effect_wipe_add
11401 * @li @ref elm_transit_effect_zoom_add
11402 * @li @ref elm_transit_effect_resizing_add
11404 * Other transition effects are used to make one object disappear and another
11405 * object appear on its old place. These effects are:
11407 * @li @ref elm_transit_effect_flip_add
11408 * @li @ref elm_transit_effect_resizable_flip_add
11409 * @li @ref elm_transit_effect_fade_add
11410 * @li @ref elm_transit_effect_blend_add
11412 * It's also possible to make a transition chain with @ref
11413 * elm_transit_chain_transit_add.
11415 * @warning We strongly recommend to use elm_transit just when edje can not do
11416 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
11417 * animations can be manipulated inside the theme.
11419 * List of examples:
11420 * @li @ref transit_example_01_explained
11421 * @li @ref transit_example_02_explained
11422 * @li @ref transit_example_03_c
11423 * @li @ref transit_example_04_c
11429 * @enum Elm_Transit_Tween_Mode
11431 * The type of acceleration used in the transition.
11435 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
11436 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
11437 over time, then decrease again
11439 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
11441 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
11443 } Elm_Transit_Tween_Mode;
11446 * @enum Elm_Transit_Effect_Flip_Axis
11448 * The axis where flip effect should be applied.
11452 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
11453 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
11454 } Elm_Transit_Effect_Flip_Axis;
11456 * @enum Elm_Transit_Effect_Wipe_Dir
11458 * The direction where the wipe effect should occur.
11462 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
11463 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
11464 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
11465 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
11466 } Elm_Transit_Effect_Wipe_Dir;
11467 /** @enum Elm_Transit_Effect_Wipe_Type
11469 * Whether the wipe effect should show or hide the object.
11473 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
11475 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
11477 } Elm_Transit_Effect_Wipe_Type;
11480 * @typedef Elm_Transit
11482 * The Transit created with elm_transit_add(). This type has the information
11483 * about the objects which the transition will be applied, and the
11484 * transition effects that will be used. It also contains info about
11485 * duration, number of repetitions, auto-reverse, etc.
11487 typedef struct _Elm_Transit Elm_Transit;
11488 typedef void Elm_Transit_Effect;
11490 * @typedef Elm_Transit_Effect_Transition_Cb
11492 * Transition callback called for this effect on each transition iteration.
11494 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
11496 * Elm_Transit_Effect_End_Cb
11498 * Transition callback called for this effect when the transition is over.
11500 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
11503 * Elm_Transit_Del_Cb
11505 * A callback called when the transit is deleted.
11507 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
11512 * @note Is not necessary to delete the transit object, it will be deleted at
11513 * the end of its operation.
11514 * @note The transit will start playing when the program enter in the main loop, is not
11515 * necessary to give a start to the transit.
11517 * @return The transit object.
11521 EAPI Elm_Transit *elm_transit_add(void);
11524 * Stops the animation and delete the @p transit object.
11526 * Call this function if you wants to stop the animation before the duration
11527 * time. Make sure the @p transit object is still alive with
11528 * elm_transit_del_cb_set() function.
11529 * All added effects will be deleted, calling its repective data_free_cb
11530 * functions. The function setted by elm_transit_del_cb_set() will be called.
11532 * @see elm_transit_del_cb_set()
11534 * @param transit The transit object to be deleted.
11537 * @warning Just call this function if you are sure the transit is alive.
11539 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
11542 * Add a new effect to the transit.
11544 * @note The cb function and the data are the key to the effect. If you try to
11545 * add an already added effect, nothing is done.
11546 * @note After the first addition of an effect in @p transit, if its
11547 * effect list become empty again, the @p transit will be killed by
11548 * elm_transit_del(transit) function.
11552 * Elm_Transit *transit = elm_transit_add();
11553 * elm_transit_effect_add(transit,
11554 * elm_transit_effect_blend_op,
11555 * elm_transit_effect_blend_context_new(),
11556 * elm_transit_effect_blend_context_free);
11559 * @param transit The transit object.
11560 * @param transition_cb The operation function. It is called when the
11561 * animation begins, it is the function that actually performs the animation.
11562 * It is called with the @p data, @p transit and the time progression of the
11563 * animation (a double value between 0.0 and 1.0).
11564 * @param effect The context data of the effect.
11565 * @param end_cb The function to free the context data, it will be called
11566 * at the end of the effect, it must finalize the animation and free the
11570 * @warning The transit free the context data at the and of the transition with
11571 * the data_free_cb function, do not use the context data in another transit.
11573 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);
11576 * Delete an added effect.
11578 * This function will remove the effect from the @p transit, calling the
11579 * data_free_cb to free the @p data.
11581 * @see elm_transit_effect_add()
11583 * @note If the effect is not found, nothing is done.
11584 * @note If the effect list become empty, this function will call
11585 * elm_transit_del(transit), that is, it will kill the @p transit.
11587 * @param transit The transit object.
11588 * @param transition_cb The operation function.
11589 * @param effect The context data of the effect.
11593 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);
11596 * Add new object to apply the effects.
11598 * @note After the first addition of an object in @p transit, if its
11599 * object list become empty again, the @p transit will be killed by
11600 * elm_transit_del(transit) function.
11601 * @note If the @p obj belongs to another transit, the @p obj will be
11602 * removed from it and it will only belong to the @p transit. If the old
11603 * transit stays without objects, it will die.
11604 * @note When you add an object into the @p transit, its state from
11605 * evas_object_pass_events_get(obj) is saved, and it is applied when the
11606 * transit ends, if you change this state whith evas_object_pass_events_set()
11607 * after add the object, this state will change again when @p transit stops to
11610 * @param transit The transit object.
11611 * @param obj Object to be animated.
11614 * @warning It is not allowed to add a new object after transit begins to go.
11616 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
11619 * Removes an added object from the transit.
11621 * @note If the @p obj is not in the @p transit, nothing is done.
11622 * @note If the list become empty, this function will call
11623 * elm_transit_del(transit), that is, it will kill the @p transit.
11625 * @param transit The transit object.
11626 * @param obj Object to be removed from @p transit.
11629 * @warning It is not allowed to remove objects after transit begins to go.
11631 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
11634 * Get the objects of the transit.
11636 * @param transit The transit object.
11637 * @return a Eina_List with the objects from the transit.
11641 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11644 * Enable/disable keeping up the objects states.
11645 * If it is not kept, the objects states will be reset when transition ends.
11647 * @note @p transit can not be NULL.
11648 * @note One state includes geometry, color, map data.
11650 * @param transit The transit object.
11651 * @param state_keep Keeping or Non Keeping.
11655 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
11658 * Get a value whether the objects states will be reset or not.
11660 * @note @p transit can not be NULL
11662 * @see elm_transit_objects_final_state_keep_set()
11664 * @param transit The transit object.
11665 * @return EINA_TRUE means the states of the objects will be reset.
11666 * If @p transit is NULL, EINA_FALSE is returned
11670 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11673 * Set the event enabled when transit is operating.
11675 * If @p enabled is EINA_TRUE, the objects of the transit will receives
11676 * events from mouse and keyboard during the animation.
11677 * @note When you add an object with elm_transit_object_add(), its state from
11678 * evas_object_pass_events_get(obj) is saved, and it is applied when the
11679 * transit ends, if you change this state with evas_object_pass_events_set()
11680 * after adding the object, this state will change again when @p transit stops
11683 * @param transit The transit object.
11684 * @param enabled Events are received when enabled is @c EINA_TRUE, and
11685 * ignored otherwise.
11689 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11692 * Get the value of event enabled status.
11694 * @see elm_transit_event_enabled_set()
11696 * @param transit The Transit object
11697 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
11698 * EINA_FALSE is returned
11702 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11705 * Set the user-callback function when the transit is deleted.
11707 * @note Using this function twice will overwrite the first function setted.
11708 * @note the @p transit object will be deleted after call @p cb function.
11710 * @param transit The transit object.
11711 * @param cb Callback function pointer. This function will be called before
11712 * the deletion of the transit.
11713 * @param data Callback funtion user data. It is the @p op parameter.
11717 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
11720 * Set reverse effect automatically.
11722 * If auto reverse is setted, after running the effects with the progress
11723 * parameter from 0 to 1, it will call the effecs again with the progress
11724 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
11725 * where the duration was setted with the function elm_transit_add and
11726 * the repeat with the function elm_transit_repeat_times_set().
11728 * @param transit The transit object.
11729 * @param reverse EINA_TRUE means the auto_reverse is on.
11733 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
11736 * Get if the auto reverse is on.
11738 * @see elm_transit_auto_reverse_set()
11740 * @param transit The transit object.
11741 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
11742 * EINA_FALSE is returned
11746 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11749 * Set the transit repeat count. Effect will be repeated by repeat count.
11751 * This function sets the number of repetition the transit will run after
11752 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
11753 * If the @p repeat is a negative number, it will repeat infinite times.
11755 * @note If this function is called during the transit execution, the transit
11756 * will run @p repeat times, ignoring the times it already performed.
11758 * @param transit The transit object
11759 * @param repeat Repeat count
11763 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
11766 * Get the transit repeat count.
11768 * @see elm_transit_repeat_times_set()
11770 * @param transit The Transit object.
11771 * @return The repeat count. If @p transit is NULL
11776 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11779 * Set the transit animation acceleration type.
11781 * This function sets the tween mode of the transit that can be:
11782 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
11783 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
11784 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
11785 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
11787 * @param transit The transit object.
11788 * @param tween_mode The tween type.
11792 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
11795 * Get the transit animation acceleration type.
11797 * @note @p transit can not be NULL
11799 * @param transit The transit object.
11800 * @return The tween type. If @p transit is NULL
11801 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
11805 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11808 * Set the transit animation time
11810 * @note @p transit can not be NULL
11812 * @param transit The transit object.
11813 * @param duration The animation time.
11817 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
11820 * Get the transit animation time
11822 * @note @p transit can not be NULL
11824 * @param transit The transit object.
11826 * @return The transit animation time.
11830 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11833 * Starts the transition.
11834 * Once this API is called, the transit begins to measure the time.
11836 * @note @p transit can not be NULL
11838 * @param transit The transit object.
11842 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
11845 * Pause/Resume the transition.
11847 * If you call elm_transit_go again, the transit will be started from the
11848 * beginning, and will be unpaused.
11850 * @note @p transit can not be NULL
11852 * @param transit The transit object.
11853 * @param paused Whether the transition should be paused or not.
11857 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
11860 * Get the value of paused status.
11862 * @see elm_transit_paused_set()
11864 * @note @p transit can not be NULL
11866 * @param transit The transit object.
11867 * @return EINA_TRUE means transition is paused. If @p transit is NULL
11868 * EINA_FALSE is returned
11872 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11875 * Get the time progression of the animation (a double value between 0.0 and 1.0).
11877 * The value returned is a fraction (current time / total time). It
11878 * represents the progression position relative to the total.
11880 * @note @p transit can not be NULL
11882 * @param transit The transit object.
11884 * @return The time progression value. If @p transit is NULL
11889 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
11892 * Makes the chain relationship between two transits.
11894 * @note @p transit can not be NULL. Transit would have multiple chain transits.
11895 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
11897 * @param transit The transit object.
11898 * @param chain_transit The chain transit object. This transit will be operated
11899 * after transit is done.
11901 * This function adds @p chain_transit transition to a chain after the @p
11902 * transit, and will be started as soon as @p transit ends. See @ref
11903 * transit_example_02_explained for a full example.
11907 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
11910 * Cut off the chain relationship between two transits.
11912 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
11913 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
11915 * @param transit The transit object.
11916 * @param chain_transit The chain transit object.
11918 * This function remove the @p chain_transit transition from the @p transit.
11922 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
11925 * Get the current chain transit list.
11927 * @note @p transit can not be NULL.
11929 * @param transit The transit object.
11930 * @return chain transit list.
11934 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
11937 * Add the Resizing Effect to Elm_Transit.
11939 * @note This API is one of the facades. It creates resizing effect context
11940 * and add it's required APIs to elm_transit_effect_add.
11942 * @see elm_transit_effect_add()
11944 * @param transit Transit object.
11945 * @param from_w Object width size when effect begins.
11946 * @param from_h Object height size when effect begins.
11947 * @param to_w Object width size when effect ends.
11948 * @param to_h Object height size when effect ends.
11949 * @return Resizing effect context data.
11953 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);
11956 * Add the Translation Effect to Elm_Transit.
11958 * @note This API is one of the facades. It creates translation effect context
11959 * and add it's required APIs to elm_transit_effect_add.
11961 * @see elm_transit_effect_add()
11963 * @param transit Transit object.
11964 * @param from_dx X Position variation when effect begins.
11965 * @param from_dy Y Position variation when effect begins.
11966 * @param to_dx X Position variation when effect ends.
11967 * @param to_dy Y Position variation when effect ends.
11968 * @return Translation effect context data.
11971 * @warning It is highly recommended just create a transit with this effect when
11972 * the window that the objects of the transit belongs has already been created.
11973 * This is because this effect needs the geometry information about the objects,
11974 * and if the window was not created yet, it can get a wrong information.
11976 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);
11979 * Add the Zoom Effect to Elm_Transit.
11981 * @note This API is one of the facades. It creates zoom effect context
11982 * and add it's required APIs to elm_transit_effect_add.
11984 * @see elm_transit_effect_add()
11986 * @param transit Transit object.
11987 * @param from_rate Scale rate when effect begins (1 is current rate).
11988 * @param to_rate Scale rate when effect ends.
11989 * @return Zoom effect context data.
11992 * @warning It is highly recommended just create a transit with this effect when
11993 * the window that the objects of the transit belongs has already been created.
11994 * This is because this effect needs the geometry information about the objects,
11995 * and if the window was not created yet, it can get a wrong information.
11997 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
12000 * Add the Flip Effect to Elm_Transit.
12002 * @note This API is one of the facades. It creates flip effect context
12003 * and add it's required APIs to elm_transit_effect_add.
12004 * @note This effect is applied to each pair of objects in the order they are listed
12005 * in the transit list of objects. The first object in the pair will be the
12006 * "front" object and the second will be the "back" object.
12008 * @see elm_transit_effect_add()
12010 * @param transit Transit object.
12011 * @param axis Flipping Axis(X or Y).
12012 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
12013 * @return Flip effect context data.
12016 * @warning It is highly recommended just create a transit with this effect when
12017 * the window that the objects of the transit belongs has already been created.
12018 * This is because this effect needs the geometry information about the objects,
12019 * and if the window was not created yet, it can get a wrong information.
12021 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
12024 * Add the Resizable Flip Effect to Elm_Transit.
12026 * @note This API is one of the facades. It creates resizable flip effect context
12027 * and add it's required APIs to elm_transit_effect_add.
12028 * @note This effect is applied to each pair of objects in the order they are listed
12029 * in the transit list of objects. The first object in the pair will be the
12030 * "front" object and the second will be the "back" object.
12032 * @see elm_transit_effect_add()
12034 * @param transit Transit object.
12035 * @param axis Flipping Axis(X or Y).
12036 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
12037 * @return Resizable flip effect context data.
12040 * @warning It is highly recommended just create a transit with this effect when
12041 * the window that the objects of the transit belongs has already been created.
12042 * This is because this effect needs the geometry information about the objects,
12043 * and if the window was not created yet, it can get a wrong information.
12045 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
12048 * Add the Wipe Effect to Elm_Transit.
12050 * @note This API is one of the facades. It creates wipe effect context
12051 * and add it's required APIs to elm_transit_effect_add.
12053 * @see elm_transit_effect_add()
12055 * @param transit Transit object.
12056 * @param type Wipe type. Hide or show.
12057 * @param dir Wipe Direction.
12058 * @return Wipe effect context data.
12061 * @warning It is highly recommended just create a transit with this effect when
12062 * the window that the objects of the transit belongs has already been created.
12063 * This is because this effect needs the geometry information about the objects,
12064 * and if the window was not created yet, it can get a wrong information.
12066 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
12069 * Add the Color Effect to Elm_Transit.
12071 * @note This API is one of the facades. It creates color effect context
12072 * and add it's required APIs to elm_transit_effect_add.
12074 * @see elm_transit_effect_add()
12076 * @param transit Transit object.
12077 * @param from_r RGB R when effect begins.
12078 * @param from_g RGB G when effect begins.
12079 * @param from_b RGB B when effect begins.
12080 * @param from_a RGB A when effect begins.
12081 * @param to_r RGB R when effect ends.
12082 * @param to_g RGB G when effect ends.
12083 * @param to_b RGB B when effect ends.
12084 * @param to_a RGB A when effect ends.
12085 * @return Color effect context data.
12089 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);
12092 * Add the Fade Effect to Elm_Transit.
12094 * @note This API is one of the facades. It creates fade effect context
12095 * and add it's required APIs to elm_transit_effect_add.
12096 * @note This effect is applied to each pair of objects in the order they are listed
12097 * in the transit list of objects. The first object in the pair will be the
12098 * "before" object and the second will be the "after" object.
12100 * @see elm_transit_effect_add()
12102 * @param transit Transit object.
12103 * @return Fade effect context data.
12106 * @warning It is highly recommended just create a transit with this effect when
12107 * the window that the objects of the transit belongs has already been created.
12108 * This is because this effect needs the color information about the objects,
12109 * and if the window was not created yet, it can get a wrong information.
12111 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
12114 * Add the Blend Effect to Elm_Transit.
12116 * @note This API is one of the facades. It creates blend effect context
12117 * and add it's required APIs to elm_transit_effect_add.
12118 * @note This effect is applied to each pair of objects in the order they are listed
12119 * in the transit list of objects. The first object in the pair will be the
12120 * "before" object and the second will be the "after" object.
12122 * @see elm_transit_effect_add()
12124 * @param transit Transit object.
12125 * @return Blend effect context data.
12128 * @warning It is highly recommended just create a transit with this effect when
12129 * the window that the objects of the transit belongs has already been created.
12130 * This is because this effect needs the color information about the objects,
12131 * and if the window was not created yet, it can get a wrong information.
12133 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
12136 * Add the Rotation Effect to Elm_Transit.
12138 * @note This API is one of the facades. It creates rotation effect context
12139 * and add it's required APIs to elm_transit_effect_add.
12141 * @see elm_transit_effect_add()
12143 * @param transit Transit object.
12144 * @param from_degree Degree when effect begins.
12145 * @param to_degree Degree when effect is ends.
12146 * @return Rotation effect context data.
12149 * @warning It is highly recommended just create a transit with this effect when
12150 * the window that the objects of the transit belongs has already been created.
12151 * This is because this effect needs the geometry information about the objects,
12152 * and if the window was not created yet, it can get a wrong information.
12154 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
12157 * Add the ImageAnimation Effect to Elm_Transit.
12159 * @note This API is one of the facades. It creates image animation effect context
12160 * and add it's required APIs to elm_transit_effect_add.
12161 * The @p images parameter is a list images paths. This list and
12162 * its contents will be deleted at the end of the effect by
12163 * elm_transit_effect_image_animation_context_free() function.
12167 * char buf[PATH_MAX];
12168 * Eina_List *images = NULL;
12169 * Elm_Transit *transi = elm_transit_add();
12171 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
12172 * images = eina_list_append(images, eina_stringshare_add(buf));
12174 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
12175 * images = eina_list_append(images, eina_stringshare_add(buf));
12176 * elm_transit_effect_image_animation_add(transi, images);
12180 * @see elm_transit_effect_add()
12182 * @param transit Transit object.
12183 * @param images Eina_List of images file paths. This list and
12184 * its contents will be deleted at the end of the effect by
12185 * elm_transit_effect_image_animation_context_free() function.
12186 * @return Image Animation effect context data.
12190 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
12195 typedef struct _Elm_Store Elm_Store;
12196 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
12197 typedef struct _Elm_Store_Item Elm_Store_Item;
12198 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
12199 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
12200 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
12201 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
12202 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
12203 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
12204 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
12205 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
12207 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
12208 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
12209 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
12210 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
12214 ELM_STORE_ITEM_MAPPING_NONE = 0,
12215 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
12216 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
12217 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
12218 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
12219 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
12220 // can add more here as needed by common apps
12221 ELM_STORE_ITEM_MAPPING_LAST
12222 } Elm_Store_Item_Mapping_Type;
12224 struct _Elm_Store_Item_Mapping_Icon
12226 // FIXME: allow edje file icons
12228 Elm_Icon_Lookup_Order lookup_order;
12229 Eina_Bool standard_name : 1;
12230 Eina_Bool no_scale : 1;
12231 Eina_Bool smooth : 1;
12232 Eina_Bool scale_up : 1;
12233 Eina_Bool scale_down : 1;
12236 struct _Elm_Store_Item_Mapping_Empty
12241 struct _Elm_Store_Item_Mapping_Photo
12246 struct _Elm_Store_Item_Mapping_Custom
12248 Elm_Store_Item_Mapping_Cb func;
12251 struct _Elm_Store_Item_Mapping
12253 Elm_Store_Item_Mapping_Type type;
12258 Elm_Store_Item_Mapping_Empty empty;
12259 Elm_Store_Item_Mapping_Icon icon;
12260 Elm_Store_Item_Mapping_Photo photo;
12261 Elm_Store_Item_Mapping_Custom custom;
12262 // add more types here
12266 struct _Elm_Store_Item_Info
12268 Elm_Genlist_Item_Class *item_class;
12269 const Elm_Store_Item_Mapping *mapping;
12274 struct _Elm_Store_Item_Info_Filesystem
12276 Elm_Store_Item_Info base;
12280 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
12281 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
12283 EAPI void elm_store_free(Elm_Store *st);
12285 EAPI Elm_Store *elm_store_filesystem_new(void);
12286 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
12287 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
12288 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
12290 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
12292 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
12293 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
12294 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
12295 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
12296 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
12297 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
12299 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
12300 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
12301 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
12302 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
12303 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
12304 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
12305 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
12307 /* SegmentControl */
12308 typedef struct _Elm_Segment_Item Elm_Segment_Item;
12309 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12310 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
12311 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);
12312 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
12313 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
12314 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12315 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
12316 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
12317 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
12318 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
12319 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
12320 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
12321 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
12322 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12323 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
12324 /* smart callbacks called:
12325 * "changed" -when the user clicks on a segment item which is not previously
12326 * selected and get selected. The event_info parameter is the
12327 * segment item index.
12330 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
12331 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
12332 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
12333 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
12334 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
12335 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
12336 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
12337 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
12339 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
12340 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
12342 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
12343 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
12344 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
12345 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
12346 EAPI void elm_video_play(Evas_Object *video);
12347 EAPI void elm_video_pause(Evas_Object *video);
12348 EAPI void elm_video_stop(Evas_Object *video);
12349 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
12350 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
12351 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
12352 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
12353 EAPI double elm_video_audio_level_get(Evas_Object *video);
12354 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
12355 EAPI double elm_video_play_position_get(Evas_Object *video);
12356 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
12357 EAPI double elm_video_play_length_get(Evas_Object *video);
12358 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
12359 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
12360 EAPI const char *elm_video_title_get(Evas_Object *video);
12362 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
12363 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
12366 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
12370 ELM_NAVIFRAME_PREV_BUTTON,
12371 ELM_NAVIFRAME_NEXT_BUTTON
12372 } Elm_Naviframe_Button_Type;
12374 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12375 EAPI Elm_Naviframe_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
12376 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
12377 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
12378 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12379 EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
12380 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
12381 EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
12382 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
12383 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
12384 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
12385 EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12386 EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12387 EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
12388 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
12389 EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
12390 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
12391 EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
12392 EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
12393 EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
12394 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);