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 * @brief Background object, used for setting a solid color, image or Edje
1658 * group as background to a window or any container object.
1660 * The bg object is used for setting a solid background to a window or
1661 * packing into any container object. It works just like an image, but has
1662 * some properties useful to a background, like setting it to tiled,
1663 * centered, scaled or stretched.
1665 * Here is some sample code using it:
1666 * @li @ref bg_01_example_page
1667 * @li @ref bg_02_example_page
1668 * @li @ref bg_03_example_page
1672 typedef enum _Elm_Bg_Option
1674 ELM_BG_OPTION_CENTER, /**< center the background */
1675 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1676 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1677 ELM_BG_OPTION_TILE /**< tile background at its original size */
1681 * Add a new background to the parent
1683 * @param parent The parent object
1684 * @return The new object or NULL if it cannot be created
1688 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1691 * Set the file (image or edje) used for the background
1693 * @param obj The bg object
1694 * @param file The file path
1695 * @param group Optional key (group in Edje) within the file
1697 * This sets the image file used in the background object. The image (or edje)
1698 * will be stretched (retaining aspect if its an image file) to completely fill
1699 * the bg object. This may mean some parts are not visible.
1701 * @note Once the image of @p obj is set, a previously set one will be deleted,
1702 * even if @p file is NULL.
1706 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1709 * Get the file (image or edje) used for the background
1711 * @param obj The bg object
1712 * @param file The file path
1713 * @param group Optional key (group in Edje) within the file
1717 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1720 * Set the option used for the background image
1722 * @param obj The bg object
1723 * @param option The desired background option (TILE, SCALE)
1725 * This sets the option used for manipulating the display of the background
1726 * image. The image can be tiled or scaled.
1730 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1733 * Get the option used for the background image
1735 * @param obj The bg object
1736 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1740 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1742 * Set the option used for the background color
1744 * @param obj The bg object
1749 * This sets the color used for the background rectangle. Its range goes
1754 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1756 * Get the option used for the background color
1758 * @param obj The bg object
1765 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1768 * Set the overlay object used for the background object.
1770 * @param obj The bg object
1771 * @param overlay The overlay object
1773 * This provides a way for elm_bg to have an 'overlay' that will be on top
1774 * of the bg. Once the over object is set, a previously set one will be
1775 * deleted, even if you set the new one to NULL. If you want to keep that
1776 * old content object, use the elm_bg_overlay_unset() function.
1781 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1784 * Get the overlay object used for the background object.
1786 * @param obj The bg object
1787 * @return The content that is being used
1789 * Return the content object which is set for this widget
1793 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1796 * Get the overlay object used for the background object.
1798 * @param obj The bg object
1799 * @return The content that was being used
1801 * Unparent and return the overlay object which was set for this widget
1805 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1808 * Set the size of the pixmap representation of the image.
1810 * This option just makes sense if an image is going to be set in the bg.
1812 * @param obj The bg object
1813 * @param w The new width of the image pixmap representation.
1814 * @param h The new height of the image pixmap representation.
1816 * This function sets a new size for pixmap representation of the given bg
1817 * image. It allows the image to be loaded already in the specified size,
1818 * reducing the memory usage and load time when loading a big image with load
1819 * size set to a smaller size.
1821 * NOTE: this is just a hint, the real size of the pixmap may differ
1822 * depending on the type of image being loaded, being bigger than requested.
1826 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1827 /* smart callbacks called:
1831 * @defgroup Icon Icon
1833 * An object that provides standard icon images (delete, edit, arrows, etc.)
1834 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
1836 * The icon image requested can be in the elementary theme, or in the
1837 * freedesktop.org paths. It's possible to set the order of preference from
1838 * where the image will be used.
1840 * This API is very similar to @ref Image, but with ready to use images.
1842 * Default images provided by the theme are described below.
1844 * The first list contains icons that were first intended to be used in
1845 * toolbars, but can be used in many other places too:
1861 * Now some icons that were designed to be used in menus (but again, you can
1862 * use them anywhere else):
1867 * @li menu/arrow_down
1868 * @li menu/arrow_left
1869 * @li menu/arrow_right
1878 * And here we have some media player specific icons:
1879 * @li media_player/forward
1880 * @li media_player/info
1881 * @li media_player/next
1882 * @li media_player/pause
1883 * @li media_player/play
1884 * @li media_player/prev
1885 * @li media_player/rewind
1886 * @li media_player/stop
1888 * Signals that you can add callbacks for are:
1890 * "clicked" - This is called when a user has clicked the icon
1892 * An example of usage for this API follows:
1893 * @li @ref tutorial_icon
1902 * @enum _Elm_Icon_Lookup_Order
1903 * @typedef Elm_Icon_Lookup_Order
1905 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
1906 * theme, FDO paths, or both?
1910 typedef enum _Elm_Icon_Lookup_Order
1912 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1913 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1914 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1915 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1916 } Elm_Icon_Lookup_Order;
1919 * Add a new icon object to the parent.
1921 * @param parent The parent object
1922 * @return The new object or NULL if it cannot be created
1924 * @see elm_icon_file_set()
1928 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1930 * Set the file that will be used as icon.
1932 * @param obj The icon object
1933 * @param file The path to file that will be used as icon image
1934 * @param group The group that the icon belongs to in edje file
1936 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1938 * @note The icon image set by this function can be changed by
1939 * elm_icon_standard_set().
1941 * @see elm_icon_file_get()
1945 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1947 * Get the file that will be used as icon.
1949 * @param obj The icon object
1950 * @param file The path to file that will be used as icon icon image
1951 * @param group The group that the icon belongs to in edje file
1953 * @see elm_icon_file_set()
1957 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1958 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1960 * Set the icon by icon standards names.
1962 * @param obj The icon object
1963 * @param name The icon name
1965 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1967 * For example, freedesktop.org defines standard icon names such as "home",
1968 * "network", etc. There can be different icon sets to match those icon
1969 * keys. The @p name given as parameter is one of these "keys", and will be
1970 * used to look in the freedesktop.org paths and elementary theme. One can
1971 * change the lookup order with elm_icon_order_lookup_set().
1973 * If name is not found in any of the expected locations and it is the
1974 * absolute path of an image file, this image will be used.
1976 * @note The icon image set by this function can be changed by
1977 * elm_icon_file_set().
1979 * @see elm_icon_standard_get()
1980 * @see elm_icon_file_set()
1984 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1986 * Get the icon name set by icon standard names.
1988 * @param obj The icon object
1989 * @return The icon name
1991 * If the icon image was set using elm_icon_file_set() instead of
1992 * elm_icon_standard_set(), then this function will return @c NULL.
1994 * @see elm_icon_standard_set()
1998 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2000 * Set the smooth effect for an icon object.
2002 * @param obj The icon object
2003 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2004 * otherwise. Default is @c EINA_TRUE.
2006 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2007 * scaling provides a better resulting image, but is slower.
2009 * The smooth scaling should be disabled when making animations that change
2010 * the icon size, since they will be faster. Animations that don't require
2011 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2012 * is already scaled, since the scaled icon image will be cached).
2014 * @see elm_icon_smooth_get()
2018 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2020 * Get the smooth effect for an icon object.
2022 * @param obj The icon object
2023 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2025 * @see elm_icon_smooth_set()
2029 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2031 * Disable scaling of this object.
2033 * @param obj The icon object.
2034 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2035 * otherwise. Default is @c EINA_FALSE.
2037 * This function disables scaling of the icon object through the function
2038 * elm_object_scale_set(). However, this does not affect the object
2039 * size/resize in any way. For that effect, take a look at
2040 * elm_icon_scale_set().
2042 * @see elm_icon_no_scale_get()
2043 * @see elm_icon_scale_set()
2044 * @see elm_object_scale_set()
2048 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2050 * Get whether scaling is disabled on the object.
2052 * @param obj The icon object
2053 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2055 * @see elm_icon_no_scale_set()
2059 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2061 * Set if the object is (up/down) resizeable.
2063 * @param obj The icon object
2064 * @param scale_up A bool to set if the object is resizeable up. Default is
2066 * @param scale_down A bool to set if the object is resizeable down. Default
2069 * This function limits the icon object resize ability. If @p scale_up is set to
2070 * @c EINA_FALSE, the object can't have its height or width resized to a value
2071 * higher than the original icon size. Same is valid for @p scale_down.
2073 * @see elm_icon_scale_get()
2077 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2079 * Get if the object is (up/down) resizeable.
2081 * @param obj The icon object
2082 * @param scale_up A bool to set if the object is resizeable up
2083 * @param scale_down A bool to set if the object is resizeable down
2085 * @see elm_icon_scale_set()
2089 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2091 * Set if the icon fill the entire object area.
2093 * @param obj The icon object
2094 * @param fill_outside @c EINA_TRUE if the object is filled outside,
2095 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2097 * When the icon object is resized to a different aspect ratio from the
2098 * original icon image, the icon image will still keep its aspect. This flag
2099 * tells how the image should fill the object's area. They are: keep the
2100 * entire icon inside the limits of height and width of the object (@p
2101 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
2102 * of the object, and the icon will fill the entire object (@p fill_outside
2105 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
2106 * retain property to false. Thus, the icon image will always keep its
2107 * original aspect ratio.
2109 * @see elm_icon_fill_outside_get()
2110 * @see elm_image_fill_outside_set()
2114 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2116 * Get if the object is filled outside.
2118 * @param obj The icon object
2119 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2121 * @see elm_icon_fill_outside_set()
2125 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2127 * Set the prescale size for the icon.
2129 * @param obj The icon object
2130 * @param size The prescale size. This value is used for both width and
2133 * This function sets a new size for pixmap representation of the given
2134 * icon. It allows the icon to be loaded already in the specified size,
2135 * reducing the memory usage and load time when loading a big icon with load
2136 * size set to a smaller size.
2138 * It's equivalent to the elm_bg_load_size_set() function for bg.
2140 * @note this is just a hint, the real size of the pixmap may differ
2141 * depending on the type of icon being loaded, being bigger than requested.
2143 * @see elm_icon_prescale_get()
2144 * @see elm_bg_load_size_set()
2148 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2150 * Get the prescale size for the icon.
2152 * @param obj The icon object
2153 * @return The prescale size
2155 * @see elm_icon_prescale_set()
2159 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2161 * Sets the icon lookup order used by elm_icon_standard_set().
2163 * @param obj The icon object
2164 * @param order The icon lookup order (can be one of
2165 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
2166 * or ELM_ICON_LOOKUP_THEME)
2168 * @see elm_icon_order_lookup_get()
2169 * @see Elm_Icon_Lookup_Order
2173 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2175 * Gets the icon lookup order.
2177 * @param obj The icon object
2178 * @return The icon lookup order
2180 * @see elm_icon_order_lookup_set()
2181 * @see Elm_Icon_Lookup_Order
2185 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 * @defgroup Image Image
2194 * An object that allows one to load an image file to it. It can be used
2195 * anywhere like any other elementary widget.
2197 * This widget provides most of the functionality provided from @ref Bg or @ref
2198 * Icon, but with a slightly different API (use the one that fits better your
2201 * The features not provided by those two other image widgets are:
2202 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
2203 * @li change the object orientation with elm_image_orient_set();
2204 * @li and turning the image editable with elm_image_editable_set().
2206 * Signals that you can add callbacks for are:
2208 * @li @c "clicked" - This is called when a user has clicked the image
2210 * An example of usage for this API follows:
2211 * @li @ref tutorial_image
2220 * @enum _Elm_Image_Orient
2221 * @typedef Elm_Image_Orient
2223 * Possible orientation options for elm_image_orient_set().
2225 * @image html elm_image_orient_set.png
2226 * @image latex elm_image_orient_set.eps width=\textwidth
2230 typedef enum _Elm_Image_Orient
2232 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
2233 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
2234 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
2235 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
2236 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
2237 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
2238 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
2239 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
2243 * Add a new image to the parent.
2245 * @param parent The parent object
2246 * @return The new object or NULL if it cannot be created
2248 * @see elm_image_file_set()
2252 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2254 * Set the file that will be used as image.
2256 * @param obj The image object
2257 * @param file The path to file that will be used as image
2258 * @param group The group that the image belongs in edje file (if it's an
2261 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2263 * @see elm_image_file_get()
2267 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2269 * Get the file that will be used as image.
2271 * @param obj The image object
2272 * @param file The path to file
2273 * @param group The group that the image belongs in edje file
2275 * @see elm_image_file_set()
2279 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2281 * Set the smooth effect for an image.
2283 * @param obj The image object
2284 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2285 * otherwise. Default is @c EINA_TRUE.
2287 * Set the scaling algorithm to be used when scaling the image. Smooth
2288 * scaling provides a better resulting image, but is slower.
2290 * The smooth scaling should be disabled when making animations that change
2291 * the image size, since it will be faster. Animations that don't require
2292 * resizing of the image can keep the smooth scaling enabled (even if the
2293 * image is already scaled, since the scaled image will be cached).
2295 * @see elm_image_smooth_get()
2299 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2301 * Get the smooth effect for an image.
2303 * @param obj The image object
2304 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2306 * @see elm_image_smooth_get()
2310 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2312 * Gets the current size of the image.
2314 * @param obj The image object.
2315 * @param w Pointer to store width, or NULL.
2316 * @param h Pointer to store height, or NULL.
2318 * This is the real size of the image, not the size of the object.
2320 * On error, neither w or h will be written.
2324 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2326 * Disable scaling of this object.
2328 * @param obj The image object.
2329 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2330 * otherwise. Default is @c EINA_FALSE.
2332 * This function disables scaling of the elm_image widget through the
2333 * function elm_object_scale_set(). However, this does not affect the widget
2334 * size/resize in any way. For that effect, take a look at
2335 * elm_image_scale_set().
2337 * @see elm_image_no_scale_get()
2338 * @see elm_image_scale_set()
2339 * @see elm_object_scale_set()
2343 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2345 * Get whether scaling is disabled on the object.
2347 * @param obj The image object
2348 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2350 * @see elm_image_no_scale_set()
2354 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2356 * Set if the object is (up/down) resizeable.
2358 * @param obj The image object
2359 * @param scale_up A bool to set if the object is resizeable up. Default is
2361 * @param scale_down A bool to set if the object is resizeable down. Default
2364 * This function limits the image resize ability. If @p scale_up is set to
2365 * @c EINA_FALSE, the object can't have its height or width resized to a value
2366 * higher than the original image size. Same is valid for @p scale_down.
2368 * @see elm_image_scale_get()
2372 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2374 * Get if the object is (up/down) resizeable.
2376 * @param obj The image object
2377 * @param scale_up A bool to set if the object is resizeable up
2378 * @param scale_down A bool to set if the object is resizeable down
2380 * @see elm_image_scale_set()
2384 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2386 * Set if the image fill the entire object area when keeping the aspect ratio.
2388 * @param obj The image object
2389 * @param fill_outside @c EINA_TRUE if the object is filled outside,
2390 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2392 * When the image should keep its aspect ratio even if resized to another
2393 * aspect ratio, there are two possibilities to resize it: keep the entire
2394 * image inside the limits of height and width of the object (@p fill_outside
2395 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
2396 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
2398 * @note This option will have no effect if
2399 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
2401 * @see elm_image_fill_outside_get()
2402 * @see elm_image_aspect_ratio_retained_set()
2406 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2408 * Get if the object is filled outside
2410 * @param obj The image object
2411 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2413 * @see elm_image_fill_outside_set()
2417 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2419 * Set the prescale size for the image
2421 * @param obj The image object
2422 * @param size The prescale size. This value is used for both width and
2425 * This function sets a new size for pixmap representation of the given
2426 * image. It allows the image to be loaded already in the specified size,
2427 * reducing the memory usage and load time when loading a big image with load
2428 * size set to a smaller size.
2430 * It's equivalent to the elm_bg_load_size_set() function for bg.
2432 * @note this is just a hint, the real size of the pixmap may differ
2433 * depending on the type of image being loaded, being bigger than requested.
2435 * @see elm_image_prescale_get()
2436 * @see elm_bg_load_size_set()
2440 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2442 * Get the prescale size for the image
2444 * @param obj The image object
2445 * @return The prescale size
2447 * @see elm_image_prescale_set()
2451 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2453 * Set the image orientation.
2455 * @param obj The image object
2456 * @param orient The image orientation
2457 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2458 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2459 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2460 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
2461 * Default is #ELM_IMAGE_ORIENT_NONE.
2463 * This function allows to rotate or flip the given image.
2465 * @see elm_image_orient_get()
2466 * @see @ref Elm_Image_Orient
2470 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2472 * Get the image orientation.
2474 * @param obj The image object
2475 * @return The image orientation
2476 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2477 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2478 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2479 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
2481 * @see elm_image_orient_set()
2482 * @see @ref Elm_Image_Orient
2486 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2488 * Make the image 'editable'.
2490 * @param obj Image object.
2491 * @param set Turn on or off editability. Default is @c EINA_FALSE.
2493 * This means the image is a valid drag target for drag and drop, and can be
2494 * cut or pasted too.
2498 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2500 * Make the image 'editable'.
2502 * @param obj Image object.
2503 * @return Editability.
2505 * This means the image is a valid drag target for drag and drop, and can be
2506 * cut or pasted too.
2510 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2512 * Get the basic Evas_Image object from this object (widget).
2514 * @param obj The image object to get the inlined image from
2515 * @return The inlined image object, or NULL if none exists
2517 * This function allows one to get the underlying @c Evas_Object of type
2518 * Image from this elementary widget. It can be useful to do things like get
2519 * the pixel data, save the image to a file, etc.
2521 * @note Be careful to not manipulate it, as it is under control of
2526 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2528 * Set whether the original aspect ratio of the image should be kept on resize.
2530 * @param obj The image object.
2531 * @param retained @c EINA_TRUE if the image should retain the aspect,
2532 * @c EINA_FALSE otherwise.
2534 * The original aspect ratio (width / height) of the image is usually
2535 * distorted to match the object's size. Enabling this option will retain
2536 * this original aspect, and the way that the image is fit into the object's
2537 * area depends on the option set by elm_image_fill_outside_set().
2539 * @see elm_image_aspect_ratio_retained_get()
2540 * @see elm_image_fill_outside_set()
2544 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2546 * Get if the object retains the original aspect ratio.
2548 * @param obj The image object.
2549 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
2554 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2556 /* smart callbacks called:
2557 * "clicked" - the user clicked the image
2565 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2567 typedef enum _Elm_GLView_Mode
2569 ELM_GLVIEW_ALPHA = 1,
2570 ELM_GLVIEW_DEPTH = 2,
2571 ELM_GLVIEW_STENCIL = 4
2575 * Defines a policy for the glview resizing.
2577 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2579 typedef enum _Elm_GLView_Resize_Policy
2581 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2582 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2583 } Elm_GLView_Resize_Policy;
2585 typedef enum _Elm_GLView_Render_Policy
2587 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2588 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2589 } Elm_GLView_Render_Policy;
2592 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2593 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2594 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2595 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2596 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2597 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2598 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2599 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2600 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2601 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2602 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2603 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2609 * A box arranges objects in a linear fashion, governed by a layout function
2610 * that defines the details of this arrangement.
2612 * By default, the box will use an internal function to set the layout to
2613 * a single row, either vertical or horizontal. This layout is affected
2614 * by a number of parameters, such as the homogeneous flag set by
2615 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2616 * elm_box_align_set() and the hints set to each object in the box.
2618 * For this default layout, it's possible to change the orientation with
2619 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2620 * placing its elements ordered from top to bottom. When horizontal is set,
2621 * the order will go from left to right. If the box is set to be
2622 * homogeneous, every object in it will be assigned the same space, that
2623 * of the largest object. Padding can be used to set some spacing between
2624 * the cell given to each object. The alignment of the box, set with
2625 * elm_box_align_set(), determines how the bounding box of all the elements
2626 * will be placed within the space given to the box widget itself.
2628 * The size hints of each object also affect how they are placed and sized
2629 * within the box. evas_object_size_hint_min_set() will give the minimum
2630 * size the object can have, and the box will use it as the basis for all
2631 * latter calculations. Elementary widgets set their own minimum size as
2632 * needed, so there's rarely any need to use it manually.
2634 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2635 * used to tell whether the object will be allocated the minimum size it
2636 * needs or if the space given to it should be expanded. It's important
2637 * to realize that expanding the size given to the object is not the same
2638 * thing as resizing the object. It could very well end being a small
2639 * widget floating in a much larger empty space. If not set, the weight
2640 * for objects will normally be 0.0 for both axis, meaning the widget will
2641 * not be expanded. To take as much space possible, set the weight to
2642 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2644 * Besides how much space each object is allocated, it's possible to control
2645 * how the widget will be placed within that space using
2646 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2647 * for both axis, meaning the object will be centered, but any value from
2648 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2649 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2650 * is -1.0, means the object will be resized to fill the entire space it
2653 * In addition, customized functions to define the layout can be set, which
2654 * allow the application developer to organize the objects within the box
2655 * in any number of ways.
2657 * The special elm_box_layout_transition() function can be used
2658 * to switch from one layout to another, animating the motion of the
2659 * children of the box.
2661 * @note Objects should not be added to box objects using _add() calls.
2663 * Some examples on how to use boxes follow:
2664 * @li @ref box_example_01
2665 * @li @ref box_example_02
2670 * @typedef Elm_Box_Transition
2672 * Opaque handler containing the parameters to perform an animated
2673 * transition of the layout the box uses.
2675 * @see elm_box_transition_new()
2676 * @see elm_box_layout_set()
2677 * @see elm_box_layout_transition()
2679 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2682 * Add a new box to the parent
2684 * By default, the box will be in vertical mode and non-homogeneous.
2686 * @param parent The parent object
2687 * @return The new object or NULL if it cannot be created
2689 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2691 * Set the horizontal orientation
2693 * By default, box object arranges their contents vertically from top to
2695 * By calling this function with @p horizontal as EINA_TRUE, the box will
2696 * become horizontal, arranging contents from left to right.
2698 * @note This flag is ignored if a custom layout function is set.
2700 * @param obj The box object
2701 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2702 * EINA_FALSE = vertical)
2704 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2706 * Get the horizontal orientation
2708 * @param obj The box object
2709 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
2711 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2713 * Set the box to arrange its children homogeneously
2715 * If enabled, homogeneous layout makes all items the same size, according
2716 * to the size of the largest of its children.
2718 * @note This flag is ignored if a custom layout function is set.
2720 * @param obj The box object
2721 * @param homogeneous The homogeneous flag
2723 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2725 * Get whether the box is using homogeneous mode or not
2727 * @param obj The box object
2728 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2730 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2732 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2734 * Add an object to the beginning of the pack list
2736 * Pack @p subobj into the box @p obj, placing it first in the list of
2737 * children objects. The actual position the object will get on screen
2738 * depends on the layout used. If no custom layout is set, it will be at
2739 * the top or left, depending if the box is vertical or horizontal,
2742 * @param obj The box object
2743 * @param subobj The object to add to the box
2745 * @see elm_box_pack_end()
2746 * @see elm_box_pack_before()
2747 * @see elm_box_pack_after()
2748 * @see elm_box_unpack()
2749 * @see elm_box_unpack_all()
2750 * @see elm_box_clear()
2752 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2754 * Add an object at the end of the pack list
2756 * Pack @p subobj into the box @p obj, placing it last in the list of
2757 * children objects. The actual position the object will get on screen
2758 * depends on the layout used. If no custom layout is set, it will be at
2759 * the bottom or right, depending if the box is vertical or horizontal,
2762 * @param obj The box object
2763 * @param subobj The object to add to the box
2765 * @see elm_box_pack_start()
2766 * @see elm_box_pack_before()
2767 * @see elm_box_pack_after()
2768 * @see elm_box_unpack()
2769 * @see elm_box_unpack_all()
2770 * @see elm_box_clear()
2772 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2774 * Adds an object to the box before the indicated object
2776 * This will add the @p subobj to the box indicated before the object
2777 * indicated with @p before. If @p before is not already in the box, results
2778 * are undefined. Before means either to the left of the indicated object or
2779 * above it depending on orientation.
2781 * @param obj The box object
2782 * @param subobj The object to add to the box
2783 * @param before The object before which to add it
2785 * @see elm_box_pack_start()
2786 * @see elm_box_pack_end()
2787 * @see elm_box_pack_after()
2788 * @see elm_box_unpack()
2789 * @see elm_box_unpack_all()
2790 * @see elm_box_clear()
2792 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2794 * Adds an object to the box after the indicated object
2796 * This will add the @p subobj to the box indicated after the object
2797 * indicated with @p after. If @p after is not already in the box, results
2798 * are undefined. After means either to the right of the indicated object or
2799 * below it depending on orientation.
2801 * @param obj The box object
2802 * @param subobj The object to add to the box
2803 * @param after The object after which to add it
2805 * @see elm_box_pack_start()
2806 * @see elm_box_pack_end()
2807 * @see elm_box_pack_before()
2808 * @see elm_box_unpack()
2809 * @see elm_box_unpack_all()
2810 * @see elm_box_clear()
2812 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2814 * Clear the box of all children
2816 * Remove all the elements contained by the box, deleting the respective
2819 * @param obj The box object
2821 * @see elm_box_unpack()
2822 * @see elm_box_unpack_all()
2824 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2828 * Remove the object given by @p subobj from the box @p obj without
2831 * @param obj The box object
2833 * @see elm_box_unpack_all()
2834 * @see elm_box_clear()
2836 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2838 * Remove all items from the box, without deleting them
2840 * Clear the box from all children, but don't delete the respective objects.
2841 * If no other references of the box children exist, the objects will never
2842 * be deleted, and thus the application will leak the memory. Make sure
2843 * when using this function that you hold a reference to all the objects
2844 * in the box @p obj.
2846 * @param obj The box object
2848 * @see elm_box_clear()
2849 * @see elm_box_unpack()
2851 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2853 * Retrieve a list of the objects packed into the box
2855 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2856 * The order of the list corresponds to the packing order the box uses.
2858 * You must free this list with eina_list_free() once you are done with it.
2860 * @param obj The box object
2862 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2864 * Set the space (padding) between the box's elements.
2866 * Extra space in pixels that will be added between a box child and its
2867 * neighbors after its containing cell has been calculated. This padding
2868 * is set for all elements in the box, besides any possible padding that
2869 * individual elements may have through their size hints.
2871 * @param obj The box object
2872 * @param horizontal The horizontal space between elements
2873 * @param vertical The vertical space between elements
2875 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2877 * Get the space (padding) between the box's elements.
2879 * @param obj The box object
2880 * @param horizontal The horizontal space between elements
2881 * @param vertical The vertical space between elements
2883 * @see elm_box_padding_set()
2885 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2887 * Set the alignment of the whole bouding box of contents.
2889 * Sets how the bounding box containing all the elements of the box, after
2890 * their sizes and position has been calculated, will be aligned within
2891 * the space given for the whole box widget.
2893 * @param obj The box object
2894 * @param horizontal The horizontal alignment of elements
2895 * @param vertical The vertical alignment of elements
2897 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2899 * Get the alignment of the whole bouding box of contents.
2901 * @param obj The box object
2902 * @param horizontal The horizontal alignment of elements
2903 * @param vertical The vertical alignment of elements
2905 * @see elm_box_align_set()
2907 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2910 * Set the layout defining function to be used by the box
2912 * Whenever anything changes that requires the box in @p obj to recalculate
2913 * the size and position of its elements, the function @p cb will be called
2914 * to determine what the layout of the children will be.
2916 * Once a custom function is set, everything about the children layout
2917 * is defined by it. The flags set by elm_box_horizontal_set() and
2918 * elm_box_homogeneous_set() no longer have any meaning, and the values
2919 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2920 * layout function to decide if they are used and how. These last two
2921 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2922 * passed to @p cb. The @c Evas_Object the function receives is not the
2923 * Elementary widget, but the internal Evas Box it uses, so none of the
2924 * functions described here can be used on it.
2926 * Any of the layout functions in @c Evas can be used here, as well as the
2927 * special elm_box_layout_transition().
2929 * The final @p data argument received by @p cb is the same @p data passed
2930 * here, and the @p free_data function will be called to free it
2931 * whenever the box is destroyed or another layout function is set.
2933 * Setting @p cb to NULL will revert back to the default layout function.
2935 * @param obj The box object
2936 * @param cb The callback function used for layout
2937 * @param data Data that will be passed to layout function
2938 * @param free_data Function called to free @p data
2940 * @see elm_box_layout_transition()
2942 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);
2944 * Special layout function that animates the transition from one layout to another
2946 * Normally, when switching the layout function for a box, this will be
2947 * reflected immediately on screen on the next render, but it's also
2948 * possible to do this through an animated transition.
2950 * This is done by creating an ::Elm_Box_Transition and setting the box
2951 * layout to this function.
2955 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2956 * evas_object_box_layout_vertical, // start
2957 * NULL, // data for initial layout
2958 * NULL, // free function for initial data
2959 * evas_object_box_layout_horizontal, // end
2960 * NULL, // data for final layout
2961 * NULL, // free function for final data
2962 * anim_end, // will be called when animation ends
2963 * NULL); // data for anim_end function\
2964 * elm_box_layout_set(box, elm_box_layout_transition, t,
2965 * elm_box_transition_free);
2968 * @note This function can only be used with elm_box_layout_set(). Calling
2969 * it directly will not have the expected results.
2971 * @see elm_box_transition_new
2972 * @see elm_box_transition_free
2973 * @see elm_box_layout_set
2975 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2977 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2979 * If you want to animate the change from one layout to another, you need
2980 * to set the layout function of the box to elm_box_layout_transition(),
2981 * passing as user data to it an instance of ::Elm_Box_Transition with the
2982 * necessary information to perform this animation. The free function to
2983 * set for the layout is elm_box_transition_free().
2985 * The parameters to create an ::Elm_Box_Transition sum up to how long
2986 * will it be, in seconds, a layout function to describe the initial point,
2987 * another for the final position of the children and one function to be
2988 * called when the whole animation ends. This last function is useful to
2989 * set the definitive layout for the box, usually the same as the end
2990 * layout for the animation, but could be used to start another transition.
2992 * @param start_layout The layout function that will be used to start the animation
2993 * @param start_layout_data The data to be passed the @p start_layout function
2994 * @param start_layout_free_data Function to free @p start_layout_data
2995 * @param end_layout The layout function that will be used to end the animation
2996 * @param end_layout_free_data The data to be passed the @p end_layout function
2997 * @param end_layout_free_data Function to free @p end_layout_data
2998 * @param transition_end_cb Callback function called when animation ends
2999 * @param transition_end_data Data to be passed to @p transition_end_cb
3000 * @return An instance of ::Elm_Box_Transition
3002 * @see elm_box_transition_new
3003 * @see elm_box_layout_transition
3005 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);
3007 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3009 * This function is mostly useful as the @c free_data parameter in
3010 * elm_box_layout_set() when elm_box_layout_transition().
3012 * @param data The Elm_Box_Transition instance to be freed.
3014 * @see elm_box_transition_new
3015 * @see elm_box_layout_transition
3017 EAPI void elm_box_transition_free(void *data);
3024 * @defgroup Button Button
3026 * @image html img/widget/button/preview-00.png
3027 * @image html img/widget/button/preview-01.png
3028 * @image html img/widget/button/preview-02.png
3030 * This is a push-button. Press it and run some function. It can contain
3031 * a simple label and icon object and it also has an autorepeat feature.
3033 * This widgets emits the following signals:
3034 * @li "clicked": the user clicked the button (press/release).
3035 * @li "repeated": the user pressed the button without releasing it.
3036 * @li "pressed": button was pressed.
3037 * @li "unpressed": button was released after being pressed.
3038 * In all three cases, the @c event parameter of the callback will be
3041 * Also, defined in the default theme, the button has the following styles
3043 * @li default: a normal button.
3044 * @li anchor: Like default, but the button fades away when the mouse is not
3045 * over it, leaving only the text or icon.
3046 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3047 * continuous look across its options.
3048 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3050 * Follow through a complete example @ref button_example_01 "here".
3054 * Add a new button to the parent's canvas
3056 * @param parent The parent object
3057 * @return The new object or NULL if it cannot be created
3059 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3061 * Set the label used in the button
3063 * The passed @p label can be NULL to clean any existing text in it and
3064 * leave the button as an icon only object.
3066 * @param obj The button object
3067 * @param label The text will be written on the button
3068 * @deprecated use elm_object_text_set() instead.
3070 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3072 * Get the label set for the button
3074 * The string returned is an internal pointer and should not be freed or
3075 * altered. It will also become invalid when the button is destroyed.
3076 * The string returned, if not NULL, is a stringshare, so if you need to
3077 * keep it around even after the button is destroyed, you can use
3078 * eina_stringshare_ref().
3080 * @param obj The button object
3081 * @return The text set to the label, or NULL if nothing is set
3082 * @deprecated use elm_object_text_set() instead.
3084 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3086 * Set the icon used for the button
3088 * Setting a new icon will delete any other that was previously set, making
3089 * any reference to them invalid. If you need to maintain the previous
3090 * object alive, unset it first with elm_button_icon_unset().
3092 * @param obj The button object
3093 * @param icon The icon object for the button
3095 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3097 * Get the icon used for the button
3099 * Return the icon object which is set for this widget. If the button is
3100 * destroyed or another icon is set, the returned object will be deleted
3101 * and any reference to it will be invalid.
3103 * @param obj The button object
3104 * @return The icon object that is being used
3106 * @see elm_button_icon_unset()
3108 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3110 * Remove the icon set without deleting it and return the object
3112 * This function drops the reference the button holds of the icon object
3113 * and returns this last object. It is used in case you want to remove any
3114 * icon, or set another one, without deleting the actual object. The button
3115 * will be left without an icon set.
3117 * @param obj The button object
3118 * @return The icon object that was being used
3120 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3122 * Turn on/off the autorepeat event generated when the button is kept pressed
3124 * When off, no autorepeat is performed and buttons emit a normal @c clicked
3125 * signal when they are clicked.
3127 * When on, keeping a button pressed will continuously emit a @c repeated
3128 * signal until the button is released. The time it takes until it starts
3129 * emitting the signal is given by
3130 * elm_button_autorepeat_initial_timeout_set(), and the time between each
3131 * new emission by elm_button_autorepeat_gap_timeout_set().
3133 * @param obj The button object
3134 * @param on A bool to turn on/off the event
3136 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3138 * Get whether the autorepeat feature is enabled
3140 * @param obj The button object
3141 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3143 * @see elm_button_autorepeat_set()
3145 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3147 * Set the initial timeout before the autorepeat event is generated
3149 * Sets the timeout, in seconds, since the button is pressed until the
3150 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3151 * won't be any delay and the even will be fired the moment the button is
3154 * @param obj The button object
3155 * @param t Timeout in seconds
3157 * @see elm_button_autorepeat_set()
3158 * @see elm_button_autorepeat_gap_timeout_set()
3160 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3162 * Get the initial timeout before the autorepeat event is generated
3164 * @param obj The button object
3165 * @return Timeout in seconds
3167 * @see elm_button_autorepeat_initial_timeout_set()
3169 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3171 * Set the interval between each generated autorepeat event
3173 * After the first @c repeated event is fired, all subsequent ones will
3174 * follow after a delay of @p t seconds for each.
3176 * @param obj The button object
3177 * @param t Interval in seconds
3179 * @see elm_button_autorepeat_initial_timeout_set()
3181 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3183 * Get the interval between each generated autorepeat event
3185 * @param obj The button object
3186 * @return Interval in seconds
3188 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3194 * @defgroup File_Selector_Button File Selector Button
3196 * @image html img/widget/fileselector_button/preview-00.png
3197 * @image html img/widget/fileselector_button/preview-01.png
3198 * @image html img/widget/fileselector_button/preview-02.png
3200 * This is a button that, when clicked, creates an Elementary
3201 * window (or inner window) <b> with a @ref Fileselector "file
3202 * selector widget" within</b>. When a file is chosen, the (inner)
3203 * window is closed and the button emits a signal having the
3204 * selected file as it's @c event_info.
3206 * This widget encapsulates operations on its internal file
3207 * selector on its own API. There is less control over its file
3208 * selector than that one would have instatiating one directly.
3210 * The following styles are available for this button:
3213 * @li @c "hoversel_vertical"
3214 * @li @c "hoversel_vertical_entry"
3216 * Smart callbacks one can register to:
3217 * - @c "file,chosen" - the user has selected a path, whose string
3218 * pointer comes as the @c event_info data (a stringshared
3221 * Here is an example on its usage:
3222 * @li @ref fileselector_button_example
3224 * @see @ref File_Selector_Entry for a similar widget.
3229 * Add a new file selector button widget to the given parent
3230 * Elementary (container) object
3232 * @param parent The parent object
3233 * @return a new file selector button widget handle or @c NULL, on
3236 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3239 * Set the label for a given file selector button widget
3241 * @param obj The file selector button widget
3242 * @param label The text label to be displayed on @p obj
3244 * @deprecated use elm_object_text_set() instead.
3246 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3249 * Get the label set for a given file selector button widget
3251 * @param obj The file selector button widget
3252 * @return The button label
3254 * @deprecated use elm_object_text_set() instead.
3256 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3259 * Set the icon on a given file selector button widget
3261 * @param obj The file selector button widget
3262 * @param icon The icon object for the button
3264 * Once the icon object is set, a previously set one will be
3265 * deleted. If you want to keep the latter, use the
3266 * elm_fileselector_button_icon_unset() function.
3268 * @see elm_fileselector_button_icon_get()
3270 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3273 * Get the icon set for a given file selector button widget
3275 * @param obj The file selector button widget
3276 * @return The icon object currently set on @p obj or @c NULL, if
3279 * @see elm_fileselector_button_icon_set()
3281 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3284 * Unset the icon used in a given file selector button widget
3286 * @param obj The file selector button widget
3287 * @return The icon object that was being used on @p obj or @c
3290 * Unparent and return the icon object which was set for this
3293 * @see elm_fileselector_button_icon_set()
3295 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3298 * Set the title for a given file selector button widget's window
3300 * @param obj The file selector button widget
3301 * @param title The title string
3303 * This will change the window's title, when the file selector pops
3304 * out after a click on the button. Those windows have the default
3305 * (unlocalized) value of @c "Select a file" as titles.
3307 * @note It will only take any effect if the file selector
3308 * button widget is @b not under "inwin mode".
3310 * @see elm_fileselector_button_window_title_get()
3312 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3315 * Get the title set for a given file selector button widget's
3318 * @param obj The file selector button widget
3319 * @return Title of the file selector button's window
3321 * @see elm_fileselector_button_window_title_get() for more details
3323 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3326 * Set the size of a given file selector button widget's window,
3327 * holding the file selector itself.
3329 * @param obj The file selector button widget
3330 * @param width The window's width
3331 * @param height The window's height
3333 * @note it will only take any effect if the file selector button
3334 * widget is @b not under "inwin mode". The default size for the
3335 * window (when applicable) is 400x400 pixels.
3337 * @see elm_fileselector_button_window_size_get()
3339 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3342 * Get the size of a given file selector button widget's window,
3343 * holding the file selector itself.
3345 * @param obj The file selector button widget
3346 * @param width Pointer into which to store the width value
3347 * @param height Pointer into which to store the height value
3349 * @note Use @c NULL pointers on the size values you're not
3350 * interested in: they'll be ignored by the function.
3352 * @see elm_fileselector_button_window_size_set(), for more details
3354 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3357 * Set the initial file system path for a given file selector
3360 * @param obj The file selector button widget
3361 * @param path The path string
3363 * It must be a <b>directory</b> path, which will have the contents
3364 * displayed initially in the file selector's view, when invoked
3365 * from @p obj. The default initial path is the @c "HOME"
3366 * environment variable's value.
3368 * @see elm_fileselector_button_path_get()
3370 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3373 * Get the initial file system path set for a given file selector
3376 * @param obj The file selector button widget
3377 * @return path The path string
3379 * @see elm_fileselector_button_path_set() for more details
3381 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3384 * Enable/disable a tree view in the given file selector button
3385 * widget's internal file selector
3387 * @param obj The file selector button widget
3388 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3391 * This has the same effect as elm_fileselector_expandable_set(),
3392 * but now applied to a file selector button's internal file
3395 * @note There's no way to put a file selector button's internal
3396 * file selector in "grid mode", as one may do with "pure" file
3399 * @see elm_fileselector_expandable_get()
3401 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3404 * Get whether tree view is enabled for the given file selector
3405 * button widget's internal file selector
3407 * @param obj The file selector button widget
3408 * @return @c EINA_TRUE if @p obj widget's internal file selector
3409 * is in tree view, @c EINA_FALSE otherwise (and or errors)
3411 * @see elm_fileselector_expandable_set() for more details
3413 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3416 * Set whether a given file selector button widget's internal file
3417 * selector is to display folders only or the directory contents,
3420 * @param obj The file selector button widget
3421 * @param only @c EINA_TRUE to make @p obj widget's internal file
3422 * selector only display directories, @c EINA_FALSE to make files
3423 * to be displayed in it too
3425 * This has the same effect as elm_fileselector_folder_only_set(),
3426 * but now applied to a file selector button's internal file
3429 * @see elm_fileselector_folder_only_get()
3431 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3434 * Get whether a given file selector button widget's internal file
3435 * selector is displaying folders only or the directory contents,
3438 * @param obj The file selector button widget
3439 * @return @c EINA_TRUE if @p obj widget's internal file
3440 * selector is only displaying directories, @c EINA_FALSE if files
3441 * are being displayed in it too (and on errors)
3443 * @see elm_fileselector_button_folder_only_set() for more details
3445 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3448 * Enable/disable the file name entry box where the user can type
3449 * in a name for a file, in a given file selector button widget's
3450 * internal file selector.
3452 * @param obj The file selector button widget
3453 * @param is_save @c EINA_TRUE to make @p obj widget's internal
3454 * file selector a "saving dialog", @c EINA_FALSE otherwise
3456 * This has the same effect as elm_fileselector_is_save_set(),
3457 * but now applied to a file selector button's internal file
3460 * @see elm_fileselector_is_save_get()
3462 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3465 * Get whether the given file selector button widget's internal
3466 * file selector is in "saving dialog" mode
3468 * @param obj The file selector button widget
3469 * @return @c EINA_TRUE, if @p obj widget's internal file selector
3470 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3473 * @see elm_fileselector_button_is_save_set() for more details
3475 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3478 * Set whether a given file selector button widget's internal file
3479 * selector will raise an Elementary "inner window", instead of a
3480 * dedicated Elementary window. By default, it won't.
3482 * @param obj The file selector button widget
3483 * @param value @c EINA_TRUE to make it use an inner window, @c
3484 * EINA_TRUE to make it use a dedicated window
3486 * @see elm_win_inwin_add() for more information on inner windows
3487 * @see elm_fileselector_button_inwin_mode_get()
3489 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3492 * Get whether a given file selector button widget's internal file
3493 * selector will raise an Elementary "inner window", instead of a
3494 * dedicated Elementary window.
3496 * @param obj The file selector button widget
3497 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3498 * if it will use a dedicated window
3500 * @see elm_fileselector_button_inwin_mode_set() for more details
3502 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3509 * @defgroup File_Selector_Entry File Selector Entry
3511 * This is an entry made to be filled with or display a <b>file
3512 * system path string</b>. Besides the entry itself, the widget has
3513 * a @ref File_Selector_Button "file selector button" on its side,
3514 * which will raise an internal @ref Fileselector "file selector widget",
3515 * when clicked, for path selection aided by file system
3518 * This file selector may appear in an Elementary window or in an
3519 * inner window. When a file is chosen from it, the (inner) window
3520 * is closed and the selected file's path string is exposed both as
3521 * an smart event and as the new text on the entry.
3523 * This widget encapsulates operations on its internal file
3524 * selector on its own API. There is less control over its file
3525 * selector than that one would have instatiating one directly.
3527 * Smart callbacks one can register to:
3528 * - @c "changed" - The text within the entry was changed
3529 * - @c "activated" - The entry has had editing finished and
3530 * changes are to be "committed"
3531 * - @c "press" - The entry has been clicked
3532 * - @c "longpressed" - The entry has been clicked (and held) for a
3534 * - @c "clicked" - The entry has been clicked
3535 * - @c "clicked,double" - The entry has been double clicked
3536 * - @c "focused" - The entry has received focus
3537 * - @c "unfocused" - The entry has lost focus
3538 * - @c "selection,paste" - A paste action has occurred on the
3540 * - @c "selection,copy" - A copy action has occurred on the entry
3541 * - @c "selection,cut" - A cut action has occurred on the entry
3542 * - @c "unpressed" - The file selector entry's button was released
3543 * after being pressed.
3544 * - @c "file,chosen" - The user has selected a path via the file
3545 * selector entry's internal file selector, whose string pointer
3546 * comes as the @c event_info data (a stringshared string)
3548 * Here is an example on its usage:
3549 * @li @ref fileselector_entry_example
3551 * @see @ref File_Selector_Button for a similar widget.
3556 * Add a new file selector entry widget to the given parent
3557 * Elementary (container) object
3559 * @param parent The parent object
3560 * @return a new file selector entry widget handle or @c NULL, on
3563 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3566 * Set the label for a given file selector entry widget's button
3568 * @param obj The file selector entry widget
3569 * @param label The text label to be displayed on @p obj widget's
3572 * @deprecated use elm_object_text_set() instead.
3574 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3577 * Get the label set for a given file selector entry widget's button
3579 * @param obj The file selector entry widget
3580 * @return The widget button's label
3582 * @deprecated use elm_object_text_set() instead.
3584 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3587 * Set the icon on a given file selector entry widget's button
3589 * @param obj The file selector entry widget
3590 * @param icon The icon object for the entry's button
3592 * Once the icon object is set, a previously set one will be
3593 * deleted. If you want to keep the latter, use the
3594 * elm_fileselector_entry_button_icon_unset() function.
3596 * @see elm_fileselector_entry_button_icon_get()
3598 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3601 * Get the icon set for a given file selector entry widget's button
3603 * @param obj The file selector entry widget
3604 * @return The icon object currently set on @p obj widget's button
3605 * or @c NULL, if none is
3607 * @see elm_fileselector_entry_button_icon_set()
3609 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3612 * Unset the icon used in a given file selector entry widget's
3615 * @param obj The file selector entry widget
3616 * @return The icon object that was being used on @p obj widget's
3617 * button or @c NULL, on errors
3619 * Unparent and return the icon object which was set for this
3622 * @see elm_fileselector_entry_button_icon_set()
3624 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3627 * Set the title for a given file selector entry widget's window
3629 * @param obj The file selector entry widget
3630 * @param title The title string
3632 * This will change the window's title, when the file selector pops
3633 * out after a click on the entry's button. Those windows have the
3634 * default (unlocalized) value of @c "Select a file" as titles.
3636 * @note It will only take any effect if the file selector
3637 * entry widget is @b not under "inwin mode".
3639 * @see elm_fileselector_entry_window_title_get()
3641 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3644 * Get the title set for a given file selector entry widget's
3647 * @param obj The file selector entry widget
3648 * @return Title of the file selector entry's window
3650 * @see elm_fileselector_entry_window_title_get() for more details
3652 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3655 * Set the size of a given file selector entry widget's window,
3656 * holding the file selector itself.
3658 * @param obj The file selector entry widget
3659 * @param width The window's width
3660 * @param height The window's height
3662 * @note it will only take any effect if the file selector entry
3663 * widget is @b not under "inwin mode". The default size for the
3664 * window (when applicable) is 400x400 pixels.
3666 * @see elm_fileselector_entry_window_size_get()
3668 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3671 * Get the size of a given file selector entry widget's window,
3672 * holding the file selector itself.
3674 * @param obj The file selector entry widget
3675 * @param width Pointer into which to store the width value
3676 * @param height Pointer into which to store the height value
3678 * @note Use @c NULL pointers on the size values you're not
3679 * interested in: they'll be ignored by the function.
3681 * @see elm_fileselector_entry_window_size_set(), for more details
3683 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3686 * Set the initial file system path and the entry's path string for
3687 * a given file selector entry widget
3689 * @param obj The file selector entry widget
3690 * @param path The path string
3692 * It must be a <b>directory</b> path, which will have the contents
3693 * displayed initially in the file selector's view, when invoked
3694 * from @p obj. The default initial path is the @c "HOME"
3695 * environment variable's value.
3697 * @see elm_fileselector_entry_path_get()
3699 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3702 * Get the entry's path string for a given file selector entry
3705 * @param obj The file selector entry widget
3706 * @return path The path string
3708 * @see elm_fileselector_entry_path_set() for more details
3710 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3713 * Enable/disable a tree view in the given file selector entry
3714 * widget's internal file selector
3716 * @param obj The file selector entry widget
3717 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3720 * This has the same effect as elm_fileselector_expandable_set(),
3721 * but now applied to a file selector entry's internal file
3724 * @note There's no way to put a file selector entry's internal
3725 * file selector in "grid mode", as one may do with "pure" file
3728 * @see elm_fileselector_expandable_get()
3730 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3733 * Get whether tree view is enabled for the given file selector
3734 * entry widget's internal file selector
3736 * @param obj The file selector entry widget
3737 * @return @c EINA_TRUE if @p obj widget's internal file selector
3738 * is in tree view, @c EINA_FALSE otherwise (and or errors)
3740 * @see elm_fileselector_expandable_set() for more details
3742 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3745 * Set whether a given file selector entry widget's internal file
3746 * selector is to display folders only or the directory contents,
3749 * @param obj The file selector entry widget
3750 * @param only @c EINA_TRUE to make @p obj widget's internal file
3751 * selector only display directories, @c EINA_FALSE to make files
3752 * to be displayed in it too
3754 * This has the same effect as elm_fileselector_folder_only_set(),
3755 * but now applied to a file selector entry's internal file
3758 * @see elm_fileselector_folder_only_get()
3760 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3763 * Get whether a given file selector entry widget's internal file
3764 * selector is displaying folders only or the directory contents,
3767 * @param obj The file selector entry widget
3768 * @return @c EINA_TRUE if @p obj widget's internal file
3769 * selector is only displaying directories, @c EINA_FALSE if files
3770 * are being displayed in it too (and on errors)
3772 * @see elm_fileselector_entry_folder_only_set() for more details
3774 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777 * Enable/disable the file name entry box where the user can type
3778 * in a name for a file, in a given file selector entry widget's
3779 * internal file selector.
3781 * @param obj The file selector entry widget
3782 * @param is_save @c EINA_TRUE to make @p obj widget's internal
3783 * file selector a "saving dialog", @c EINA_FALSE otherwise
3785 * This has the same effect as elm_fileselector_is_save_set(),
3786 * but now applied to a file selector entry's internal file
3789 * @see elm_fileselector_is_save_get()
3791 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3794 * Get whether the given file selector entry widget's internal
3795 * file selector is in "saving dialog" mode
3797 * @param obj The file selector entry widget
3798 * @return @c EINA_TRUE, if @p obj widget's internal file selector
3799 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3802 * @see elm_fileselector_entry_is_save_set() for more details
3804 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3807 * Set whether a given file selector entry widget's internal file
3808 * selector will raise an Elementary "inner window", instead of a
3809 * dedicated Elementary window. By default, it won't.
3811 * @param obj The file selector entry widget
3812 * @param value @c EINA_TRUE to make it use an inner window, @c
3813 * EINA_TRUE to make it use a dedicated window
3815 * @see elm_win_inwin_add() for more information on inner windows
3816 * @see elm_fileselector_entry_inwin_mode_get()
3818 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3821 * Get whether a given file selector entry widget's internal file
3822 * selector will raise an Elementary "inner window", instead of a
3823 * dedicated Elementary window.
3825 * @param obj The file selector entry widget
3826 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3827 * if it will use a dedicated window
3829 * @see elm_fileselector_entry_inwin_mode_set() for more details
3831 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3834 * Set the initial file system path for a given file selector entry
3837 * @param obj The file selector entry widget
3838 * @param path The path string
3840 * It must be a <b>directory</b> path, which will have the contents
3841 * displayed initially in the file selector's view, when invoked
3842 * from @p obj. The default initial path is the @c "HOME"
3843 * environment variable's value.
3845 * @see elm_fileselector_entry_path_get()
3847 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3850 * Get the parent directory's path to the latest file selection on
3851 * a given filer selector entry widget
3853 * @param obj The file selector object
3854 * @return The (full) path of the directory of the last selection
3855 * on @p obj widget, a @b stringshared string
3857 * @see elm_fileselector_entry_path_set()
3859 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3865 /* scroller policy */
3866 typedef enum _Elm_Scroller_Policy
3868 ELM_SCROLLER_POLICY_AUTO = 0,
3869 ELM_SCROLLER_POLICY_ON,
3870 ELM_SCROLLER_POLICY_OFF,
3871 ELM_SCROLLER_POLICY_LAST
3872 } Elm_Scroller_Policy;
3874 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3875 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3876 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3877 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3878 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3879 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3880 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);
3881 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3882 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3883 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);
3884 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3885 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3886 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3887 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3888 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3889 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);
3890 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3891 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
3892 /* smart callbacks called:
3893 * "edge,left" - the left edge of the content has been reached
3894 * "edge,right" - the right edge of the content has been reached
3895 * "edge,top" - the top edge of the content has been reached
3896 * "edge,bottom" - the bottom edge of the content has been reached
3897 * "scroll" - the content has been scrolled (moved)
3898 * "scroll,anim,start" - scrolling animation has started
3899 * "scroll,anim,stop" - scrolling animation has stopped
3900 * "scroll,drag,start" - dragging the contents around has started
3901 * "scroll,drag,stop" - dragging the contents around has stopped
3905 * @defgroup Label Label
3907 * @brief Widget to display text, with simple html-like markup.
3909 * The Label widget @b doesn't allow text to overflow its boundaries, if the
3910 * text doesn't fit the geometry of the label it will be ellipsized or be
3911 * cut. Elementary provides several themes for this widget:
3912 * @li default - No animation
3913 * @li marker - Centers the text in the label and make it bold by default
3914 * @li slide_long - The entire text appears from the right of the screen and
3915 * slides until it disappears in the left of the screen(reappering on the
3917 * @li slide_short - The text appears in the left of the label and slides to
3918 * the right to show the overflow. When all of the text has been shown the
3919 * position is reset.
3920 * @li slide_bounce - The text appears in the left of the label and slides to
3921 * the right to show the overflow. When all of the text has been shown the
3922 * animation reverses, moving the text to the left.
3924 * Custom themes can of course invent new markup tags and style them any way
3927 * See @ref tutorial_label for a demonstration of how to use a label widget.
3931 * @brief Add a new label to the parent
3933 * @param parent The parent object
3934 * @return The new object or NULL if it cannot be created
3936 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3938 * @brief Set the label on the label object
3940 * @param obj The label object
3941 * @param label The label will be used on the label object
3942 * @deprecated See elm_object_text_set()
3944 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 */
3946 * @brief Get the label used on the label object
3948 * @param obj The label object
3949 * @return The string inside the label
3950 * @deprecated See elm_object_text_get()
3952 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3954 * @brief Set the wrapping behavior of the label
3956 * @param obj The label object
3957 * @param wrap To wrap text or not
3959 * By default no wrapping is done. Possible values for @p wrap are:
3960 * @li ELM_WRAP_NONE - No wrapping
3961 * @li ELM_WRAP_CHAR - wrap between characters
3962 * @li ELM_WRAP_WORD - wrap between words
3963 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
3965 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3967 * @brief Get the wrapping behavior of the label
3969 * @param obj The label object
3972 * @see elm_label_line_wrap_set()
3974 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3976 * @brief Set wrap width of the label
3978 * @param obj The label object
3979 * @param w The wrap width in pixels at a minimum where words need to wrap
3981 * This function sets the maximum width size hint of the label.
3983 * @warning This is only relevant if the label is inside a container.
3985 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3987 * @brief Get wrap width of the label
3989 * @param obj The label object
3990 * @return The wrap width in pixels at a minimum where words need to wrap
3992 * @see elm_label_wrap_width_set()
3994 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3996 * @brief Set wrap height of the label
3998 * @param obj The label object
3999 * @param h The wrap height in pixels at a minimum where words need to wrap
4001 * This function sets the maximum height size hint of the label.
4003 * @warning This is only relevant if the label is inside a container.
4005 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
4007 * @brief get wrap width of the label
4009 * @param obj The label object
4010 * @return The wrap height in pixels at a minimum where words need to wrap
4012 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4014 * @brief Set the font size on the label object.
4016 * @param obj The label object
4017 * @param size font size
4019 * @warning NEVER use this. It is for hyper-special cases only. use styles
4020 * instead. e.g. "big", "medium", "small" - or better name them by use:
4021 * "title", "footnote", "quote" etc.
4023 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
4025 * @brief Set the text color on the label object
4027 * @param obj The label object
4028 * @param r Red property background color of The label object
4029 * @param g Green property background color of The label object
4030 * @param b Blue property background color of The label object
4031 * @param a Alpha property background color of The label object
4033 * @warning NEVER use this. It is for hyper-special cases only. use styles
4034 * instead. e.g. "big", "medium", "small" - or better name them by use:
4035 * "title", "footnote", "quote" etc.
4037 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);
4039 * @brief Set the text align on the label object
4041 * @param obj The label object
4042 * @param align align mode ("left", "center", "right")
4044 * @warning NEVER use this. It is for hyper-special cases only. use styles
4045 * instead. e.g. "big", "medium", "small" - or better name them by use:
4046 * "title", "footnote", "quote" etc.
4048 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
4050 * @brief Set background color of the label
4052 * @param obj The label object
4053 * @param r Red property background color of The label object
4054 * @param g Green property background color of The label object
4055 * @param b Blue property background color of The label object
4056 * @param a Alpha property background alpha of The label object
4058 * @warning NEVER use this. It is for hyper-special cases only. use styles
4059 * instead. e.g. "big", "medium", "small" - or better name them by use:
4060 * "title", "footnote", "quote" etc.
4062 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);
4064 * @brief Set the ellipsis behavior of the label
4066 * @param obj The label object
4067 * @param ellipsis To ellipsis text or not
4069 * If set to true and the text doesn't fit in the label an ellipsis("...")
4070 * will be shown at the end of the widget.
4072 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
4073 * choosen wrap method was ELM_WRAP_WORD.
4075 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
4077 * @brief Set the text slide of the label
4079 * @param obj The label object
4080 * @param slide To start slide or stop
4082 * If set to true the text of the label will slide throught the length of
4085 * @warning This must be called before elm_label_slide_set().
4086 * @warning This only work with the themes "slide_short", "slide_long" and
4089 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
4091 * @brief Get the text slide mode of the label
4093 * @param obj The label object
4094 * @return slide slide mode value
4096 * @see elm_label_slide_set()
4098 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4100 * @brief Set the slide duration(speed) of the label
4102 * @param obj The label object
4103 * @return The duration in seconds in moving text from slide begin position
4104 * to slide end position
4106 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
4108 * @brief Get the slide duration(speed) of the label
4110 * @param obj The label object
4111 * @return The duration time in moving text from slide begin position to slide end position
4113 * @see elm_label_slide_duration_set()
4115 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4121 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4122 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4123 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4124 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4125 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4126 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4127 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
4128 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
4129 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4130 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4131 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
4132 /* smart callbacks called:
4133 * "changed" - Whenever the toggle value has been changed. Is not called
4134 * until the toggle is released by the cursor (assuming it has been triggered
4135 * by the cursor in the first place).
4139 * @page tutorial_frame Frame example
4140 * @dontinclude frame_example_01.c
4142 * In this example we are going to create 4 Frames with different styles and
4143 * add a rectangle of different color in each.
4145 * We start we the usual setup code:
4148 * And then create one rectangle:
4151 * To add it in our first frame, which since it doesn't have it's style
4152 * specifically set uses the default style:
4155 * And then create another rectangle:
4158 * To add it in our second frame, which uses the "pad_small" style, note that
4159 * even tough we are setting a text for this frame it won't be show, only the
4160 * default style shows the Frame's title:
4162 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
4163 * very similar, their only difference is the size of the empty area around
4164 * the content of the frame.
4166 * And then create yet another rectangle:
4169 * To add it in our third frame, which uses the "outdent_top" style, note
4170 * that even tough we are setting a text for this frame it won't be show,
4171 * only the default style shows the Frame's title:
4174 * And then create one last rectangle:
4177 * To add it in our fourth and final frame, which uses the "outdent_bottom"
4178 * style, note that even tough we are setting a text for this frame it won't
4179 * be show, only the default style shows the Frame's title:
4182 * And now we are left with just some more setup code:
4185 * Our example will look like this:
4187 * @image html screenshots/frame_example_01.png
4188 * @image latex screenshots/frame_example_01.eps width=\textwidth
4190 * @example frame_example_01.c
4193 * @defgroup Frame Frame
4195 * @brief Frame is a widget that holds some content and has a title.
4197 * The default look is a frame with a title, but Frame supports multple
4205 * @li outdent_bottom
4207 * Of all this styles only default shows the title. Frame emits no signals.
4209 * For a detailed example see the @ref tutorial_frame.
4214 * @brief Add a new frame to the parent
4216 * @param parent The parent object
4217 * @return The new object or NULL if it cannot be created
4219 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4221 * @brief Set the frame label
4223 * @param obj The frame object
4224 * @param label The label of this frame object
4226 * @deprecated use elm_object_text_set() instead.
4228 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4230 * @brief Get the frame label
4232 * @param obj The frame object
4234 * @return The label of this frame objet or NULL if unable to get frame
4236 * @deprecated use elm_object_text_get() instead.
4238 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240 * @brief Set the content of the frame widget
4242 * Once the content object is set, a previously set one will be deleted.
4243 * If you want to keep that old content object, use the
4244 * elm_frame_content_unset() function.
4246 * @param obj The frame object
4247 * @param content The content will be filled in this frame object
4249 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4251 * @brief Get the content of the frame widget
4253 * Return the content object which is set for this widget
4255 * @param obj The frame object
4256 * @return The content that is being used
4258 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4260 * @brief Unset the content of the frame widget
4262 * Unparent and return the content object which was set for this widget
4264 * @param obj The frame object
4265 * @return The content that was being used
4267 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4273 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4274 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4275 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4276 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4277 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4278 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4279 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4280 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4281 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4282 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
4283 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4284 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4287 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
4288 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
4289 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
4290 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
4291 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
4292 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
4293 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
4295 struct _Elm_Gengrid_Item_Class
4297 const char *item_style;
4298 struct _Elm_Gengrid_Item_Class_Func
4300 GridItemLabelGetFunc label_get;
4301 GridItemIconGetFunc icon_get;
4302 GridItemStateGetFunc state_get;
4303 GridItemDelFunc del;
4307 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4308 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4309 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4310 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
4311 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
4313 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
4314 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4316 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4317 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4318 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4319 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4320 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4321 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4322 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4323 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
4324 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
4325 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
4326 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
4327 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4332 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4333 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4334 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4335 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4336 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4337 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4338 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
4339 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4340 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
4341 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
4342 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4343 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4344 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4345 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4346 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4347 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4348 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4350 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
4351 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);
4352 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4353 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
4354 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4355 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4356 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4357 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4358 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
4359 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4360 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4361 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
4363 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4364 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4365 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367 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);
4368 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);
4369 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);
4370 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);
4371 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);
4372 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);
4373 /* smart callbacks called:
4375 * selected - User has selected an item.
4376 * unselected - User has unselected an item.
4377 * clicked,double - User has double-clicked or pressed enter on an item.
4378 * realized - An evas object for an item was built.
4379 * unrealized - An evas object for an item was deleted.
4380 * changed - An item has been added, removed, resized or moved,
4381 * or gengrid has been resized or horizontal property has been changed.
4382 * scroll - the content has been scrolled (moved).
4383 * "scroll,drag,start" - dragging the contents around has started.
4384 * "scroll,drag,stop" - dragging the contents around has stopped.
4385 * drag - Gengrid is being dragged.
4386 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
4387 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
4388 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
4389 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
4390 * "drag,stop" - Gengrid is not being dragged.
4394 * @defgroup Clock Clock
4396 * This is a @b digital clock widget. In its default theme, it has a
4397 * vintage "flipping numbers clock" appearance, which will animate
4398 * sheets of individual algarisms individually as time goes by.
4400 * A newly created clock will fetch system's time (already
4401 * considering local time adjustments) to start with, and will tick
4402 * accondingly. It may or may not show seconds.
4404 * Clocks have an @b edition mode. When in it, the sheets will
4405 * display extra arrow indications on the top and bottom and the
4406 * user may click on them to raise or lower the time values. After
4407 * it's told to exit edition mode, it will keep ticking with that
4408 * new time set (it keeps the difference from local time).
4410 * Also, when under edition mode, user clicks on the cited arrows
4411 * which are @b held for some time will make the clock to flip the
4412 * sheet, thus editing the time, continuosly and automatically for
4413 * the user. The interval between sheet flips will keep growing in
4414 * time, so that it helps the user to reach a time which is distant
4417 * The time display is, by default, in military mode (24h), but an
4418 * am/pm indicator may be optionally shown, too, when it will
4421 * Smart callbacks one can register to:
4422 * - "changed" - the clock's user changed the time
4424 * Here is an example on its usage:
4425 * @li @ref clock_example
4434 * Identifiers for which clock digits should be editable, when a
4435 * clock widget is in edition mode. Values may be ORed together to
4436 * make a mask, naturally.
4438 * @see elm_clock_edit_set()
4439 * @see elm_clock_digit_edit_set()
4441 typedef enum _Elm_Clock_Digedit
4443 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
4444 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
4445 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
4446 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
4447 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
4448 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
4449 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
4450 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
4451 } Elm_Clock_Digedit;
4454 * Add a new clock widget to the given parent Elementary
4455 * (container) object
4457 * @param parent The parent object
4458 * @return a new clock widget handle or @c NULL, on errors
4460 * This function inserts a new clock widget on the canvas.
4464 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4467 * Set a clock widget's time, programmatically
4469 * @param obj The clock widget object
4470 * @param hrs The hours to set
4471 * @param min The minutes to set
4472 * @param sec The secondes to set
4474 * This function updates the time that is showed by the clock
4477 * Values @b must be set within the following ranges:
4478 * - 0 - 23, for hours
4479 * - 0 - 59, for minutes
4480 * - 0 - 59, for seconds,
4482 * even if the clock is not in "military" mode.
4484 * @warning The behavior for values set out of those ranges is @b
4489 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
4492 * Get a clock widget's time values
4494 * @param obj The clock object
4495 * @param[out] hrs Pointer to the variable to get the hours value
4496 * @param[out] min Pointer to the variable to get the minutes value
4497 * @param[out] sec Pointer to the variable to get the seconds value
4499 * This function gets the time set for @p obj, returning
4500 * it on the variables passed as the arguments to function
4502 * @note Use @c NULL pointers on the time values you're not
4503 * interested in: they'll be ignored by the function.
4507 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
4510 * Set whether a given clock widget is under <b>edition mode</b> or
4511 * under (default) displaying-only mode.
4513 * @param obj The clock object
4514 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
4515 * put it back to "displaying only" mode
4517 * This function makes a clock's time to be editable or not <b>by
4518 * user interaction</b>. When in edition mode, clocks @b stop
4519 * ticking, until one brings them back to canonical mode. The
4520 * elm_clock_digit_edit_set() function will influence which digits
4521 * of the clock will be editable. By default, all of them will be
4522 * (#ELM_CLOCK_NONE).
4524 * @note am/pm sheets, if being shown, will @b always be editable
4525 * under edition mode.
4527 * @see elm_clock_edit_get()
4531 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4534 * Retrieve whether a given clock widget is under <b>edition
4535 * mode</b> or under (default) displaying-only mode.
4537 * @param obj The clock object
4538 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
4541 * This function retrieves whether the clock's time can be edited
4542 * or not by user interaction.
4544 * @see elm_clock_edit_set() for more details
4548 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4551 * Set what digits of the given clock widget should be editable
4552 * when in edition mode.
4554 * @param obj The clock object
4555 * @param digedit Bit mask indicating the digits to be editable
4556 * (values in #Elm_Clock_Digedit).
4558 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
4559 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
4562 * @see elm_clock_digit_edit_get()
4566 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
4569 * Retrieve what digits of the given clock widget should be
4570 * editable when in edition mode.
4572 * @param obj The clock object
4573 * @return Bit mask indicating the digits to be editable
4574 * (values in #Elm_Clock_Digedit).
4576 * @see elm_clock_digit_edit_set() for more details
4580 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4583 * Set if the given clock widget must show hours in military or
4586 * @param obj The clock object
4587 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
4590 * This function sets if the clock must show hours in military or
4591 * am/pm mode. In some countries like Brazil the military mode
4592 * (00-24h-format) is used, in opposition to the USA, where the
4593 * am/pm mode is more commonly used.
4595 * @see elm_clock_show_am_pm_get()
4599 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
4602 * Get if the given clock widget shows hours in military or am/pm
4605 * @param obj The clock object
4606 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
4609 * This function gets if the clock shows hours in military or am/pm
4612 * @see elm_clock_show_am_pm_set() for more details
4616 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4619 * Set if the given clock widget must show time with seconds or not
4621 * @param obj The clock object
4622 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
4624 * This function sets if the given clock must show or not elapsed
4625 * seconds. By default, they are @b not shown.
4627 * @see elm_clock_show_seconds_get()
4631 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
4634 * Get whether the given clock widget is showing time with seconds
4637 * @param obj The clock object
4638 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
4640 * This function gets whether @p obj is showing or not the elapsed
4643 * @see elm_clock_show_seconds_set()
4647 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650 * Set the interval on time updates for an user mouse button hold
4651 * on clock widgets' time edition.
4653 * @param obj The clock object
4654 * @param interval The (first) interval value in seconds
4656 * This interval value is @b decreased while the user holds the
4657 * mouse pointer either incrementing or decrementing a given the
4658 * clock digit's value.
4660 * This helps the user to get to a given time distant from the
4661 * current one easier/faster, as it will start to flip quicker and
4662 * quicker on mouse button holds.
4664 * The calculation for the next flip interval value, starting from
4665 * the one set with this call, is the previous interval divided by
4666 * 1.05, so it decreases a little bit.
4668 * The default starting interval value for automatic flips is
4671 * @see elm_clock_interval_get()
4675 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4678 * Get the interval on time updates for an user mouse button hold
4679 * on clock widgets' time edition.
4681 * @param obj The clock object
4682 * @return The (first) interval value, in seconds, set on it
4684 * @see elm_clock_interval_set() for more details
4688 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4695 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4696 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4697 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
4698 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4699 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4700 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4701 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
4702 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
4703 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4704 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4705 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
4706 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
4707 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
4708 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
4709 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);
4710 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
4711 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
4712 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4713 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
4714 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
4715 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
4716 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4717 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4718 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
4719 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4720 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);
4721 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4723 * @def elm_layout_icon_set
4724 * Convienience macro to set the icon object in a layout that follows the
4725 * Elementary naming convention for its parts.
4729 #define elm_layout_icon_set(_ly, _obj) \
4732 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
4733 if ((_obj)) sig = "elm,state,icon,visible"; \
4734 else sig = "elm,state,icon,hidden"; \
4735 elm_object_signal_emit((_ly), sig, "elm"); \
4739 * @def elm_layout_icon_get
4740 * Convienience macro to get the icon object from a layout that follows the
4741 * Elementary naming convention for its parts.
4745 #define elm_layout_icon_get(_ly) \
4746 elm_layout_content_get((_ly), "elm.swallow.icon")
4749 * @def elm_layout_end_set
4750 * Convienience macro to set the end object in a layout that follows the
4751 * Elementary naming convention for its parts.
4755 #define elm_layout_end_set(_ly, _obj) \
4758 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
4759 if ((_obj)) sig = "elm,state,end,visible"; \
4760 else sig = "elm,state,end,hidden"; \
4761 elm_object_signal_emit((_ly), sig, "elm"); \
4765 * @def elm_layout_end_get
4766 * Convienience macro to get the end object in a layout that follows the
4767 * Elementary naming convention for its parts.
4771 #define elm_layout_end_get(_ly) \
4772 elm_layout_content_get((_ly), "elm.swallow.end")
4775 * @def elm_layout_label_set
4776 * Convienience macro to set the label in a layout that follows the
4777 * Elementary naming convention for its parts.
4780 * @deprecate use elm_object_text_* instead.
4782 #define elm_layout_label_set(_ly, _txt) \
4783 elm_layout_text_set((_ly), "elm.text", (_txt))
4786 * @def elm_layout_label_get
4787 * Convienience macro to get the label in a layout that follows the
4788 * Elementary naming convention for its parts.
4791 * @deprecate use elm_object_text_* instead.
4793 #define elm_layout_label_get(_ly) \
4794 elm_layout_text_get((_ly), "elm.text")
4796 /* smart callbacks called:
4800 typedef enum _Elm_Notify_Orient
4802 ELM_NOTIFY_ORIENT_TOP,
4803 ELM_NOTIFY_ORIENT_CENTER,
4804 ELM_NOTIFY_ORIENT_BOTTOM,
4805 ELM_NOTIFY_ORIENT_LEFT,
4806 ELM_NOTIFY_ORIENT_RIGHT,
4807 ELM_NOTIFY_ORIENT_TOP_LEFT,
4808 ELM_NOTIFY_ORIENT_TOP_RIGHT,
4809 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
4810 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
4811 ELM_NOTIFY_ORIENT_LAST
4812 } Elm_Notify_Orient;
4813 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4814 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4815 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4816 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4817 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4818 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4819 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
4820 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4821 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4822 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4823 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
4824 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4825 /* smart callbacks called:
4826 * "timeout" - when timeout happens on notify and it's hidden
4827 * "block,clicked" - when it's hidden by a click outside of the notify's view
4831 * @defgroup Hover Hover
4833 * A Hover object will hover over its @p parent object at the @p target
4834 * location. Anything in the background will be given a darker coloring to
4835 * indicate that the hover object is on top (at the default theme). When the
4836 * hover is clicked it is dismissed(hidden), if the contents of the hover are
4837 * clicked that @b doesn't cause the hover to be dismissed.
4839 * @note The hover object will take up the entire space of @p target
4842 * Elementary has the following styles for the hover widget:
4846 * @li hoversel_vertical
4848 * The following are the available position for content:
4860 * Signals that you can add callbacks for are:
4861 * @li "clicked" - the user clicked the empty space in the hover to dismiss
4862 * @li "smart,changed" - a content object placed under the "smart"
4863 * policy was replaced to a new slot direction.
4865 * See @ref tutorial_hover for more information.
4869 typedef enum _Elm_Hover_Axis
4871 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
4872 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
4873 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
4874 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
4877 * @brief Adds a hover object to @p parent
4879 * @param parent The parent object
4880 * @return The hover object or NULL if one could not be created
4882 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4884 * @brief Sets the target object for the hover.
4886 * @param obj The hover object
4887 * @param target The object to center the hover onto. The hover
4889 * This function will cause the hover to be centered on the target object.
4891 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
4893 * @brief Gets the target object for the hover.
4895 * @param obj The hover object
4896 * @param parent The object to locate the hover over.
4898 * @see elm_hover_target_set()
4900 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4902 * @brief Sets the parent object for the hover.
4904 * @param obj The hover object
4905 * @param parent The object to locate the hover over.
4907 * This function will cause the hover to take up the entire space that the
4908 * parent object fills.
4910 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4912 * @brief Gets the parent object for the hover.
4914 * @param obj The hover object
4915 * @return The parent object to locate the hover over.
4917 * @see elm_hover_parent_set()
4919 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4921 * @brief Sets the content of the hover object and the direction in which it
4924 * @param obj The hover object
4925 * @param swallow The direction that the object will be displayed
4926 * at. Accepted values are "left", "top-left", "top", "top-right",
4927 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
4929 * @param content The content to place at @p swallow
4931 * Once the content object is set for a given direction, a previously
4932 * set one (on the same direction) will be deleted. If you want to
4933 * keep that old content object, use the elm_hover_content_unset()
4936 * All directions may have contents at the same time, except for
4937 * "smart". This is a special placement hint and its use case
4938 * independs of the calculations coming from
4939 * elm_hover_best_content_location_get(). Its use is for cases when
4940 * one desires only one hover content, but with a dinamic special
4941 * placement within the hover area. The content's geometry, whenever
4942 * it changes, will be used to decide on a best location not
4943 * extrapolating the hover's parent object view to show it in (still
4944 * being the hover's target determinant of its medium part -- move and
4945 * resize it to simulate finger sizes, for example). If one of the
4946 * directions other than "smart" are used, a previously content set
4947 * using it will be deleted, and vice-versa.
4949 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4951 * @brief Get the content of the hover object, in a given direction.
4953 * Return the content object which was set for this widget in the
4954 * @p swallow direction.
4956 * @param obj The hover object
4957 * @param swallow The direction that the object was display at.
4958 * @return The content that was being used
4960 * @see elm_hover_content_set()
4962 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4964 * @brief Unset the content of the hover object, in a given direction.
4966 * Unparent and return the content object set at @p swallow direction.
4968 * @param obj The hover object
4969 * @param swallow The direction that the object was display at.
4970 * @return The content that was being used.
4972 * @see elm_hover_content_set()
4974 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4976 * @brief Returns the best swallow location for content in the hover.
4978 * @param obj The hover object
4979 * @param pref_axis The preferred orientation axis for the hover object to use
4980 * @return The edje location to place content into the hover or @c
4983 * Best is defined here as the location at which there is the most available
4986 * @p pref_axis may be one of
4987 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
4988 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
4989 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
4990 * - @c ELM_HOVER_AXIS_BOTH -- both
4992 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
4993 * nescessarily be along the horizontal axis("left" or "right"). If
4994 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
4995 * be along the vertical axis("top" or "bottom"). Chossing
4996 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
4997 * returned position may be in either axis.
4999 * @see elm_hover_content_set()
5001 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
5007 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
5008 struct _Elm_Entry_Anchor_Info
5012 Evas_Coord x, y, w, h;
5014 typedef enum _Elm_Icon_Type
5020 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
5022 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5023 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
5024 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5025 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
5026 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5027 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5028 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5029 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5030 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5031 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5032 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
5033 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5034 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5035 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5036 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5037 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
5038 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5039 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5040 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
5041 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
5042 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
5043 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5044 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5045 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5046 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5047 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5048 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5049 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5050 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5051 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5052 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);
5053 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5054 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5055 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
5056 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
5057 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
5058 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5059 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);
5060 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5061 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5062 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);
5063 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);
5064 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);
5065 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);
5066 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);
5067 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);
5068 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
5069 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
5070 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
5071 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
5072 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
5073 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
5074 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5075 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
5076 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5077 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
5078 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
5079 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
5080 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
5081 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
5082 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
5083 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
5084 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
5085 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
5086 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
5087 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
5088 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
5089 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
5091 /* pre-made filters for entries */
5092 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
5093 struct _Elm_Entry_Filter_Limit_Size
5098 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
5099 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
5100 struct _Elm_Entry_Filter_Accept_Set
5102 const char *accepted;
5103 const char *rejected;
5105 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
5106 /* smart callbacks called:
5107 * "changed" - the text content changed
5108 * "selection,start" - the user started selecting text
5109 * "selection,changed" - the user modified the selection size/location
5110 * "selection,cleared" - the user cleared the selection
5111 * "selection,paste" - the user requested a paste of text
5112 * "selection,copy" - the user copied the text
5113 * "selection,cut" - the user cut the text
5114 * "cursor,changed" - the cursor changed position
5115 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
5116 * "activated" - when the enter key is pressed (useful for single line)
5117 * "press" - when finger/mouse is pressed down
5118 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
5119 * "clicked,double" - when finger/mouse is double-pressed
5120 * "longpressed" - the entry has been longpressed
5121 * "focused" - the entry has received keyboard focus
5122 * "unfocused" - keyboard focus is gone
5125 /* composite widgets - these basically put together basic widgets above
5126 * in convenient packages that do more than basic stuff */
5130 * @defgroup Anchorview Anchorview
5132 * Anchorview is for displaying text that contains markup with anchors
5133 * like <c>\<a href=1234\>something\</\></c> in it.
5135 * Besides being styled differently, the anchorview widget provides the
5136 * necessary functionality so that clicking on these anchors brings up a
5137 * popup with user defined content such as "call", "add to contacts" or
5138 * "open web page". This popup is provided using the @ref Hover widget.
5140 * This widget is very similar to @ref Anchorblock, so refer to that
5141 * widget for an example. The only difference Anchorview has is that the
5142 * widget is already provided with scrolling functionality, so if the
5143 * text set to it is too large to fit in the given space, it will scroll,
5144 * whereas the @ref Anchorblock widget will keep growing to ensure all the
5145 * text can be displayed.
5147 * This widget emits the following signals:
5148 * @li "anchor,clicked": will be called when an anchor is clicked. The
5149 * @p event_info parameter on the callback will be a pointer of type
5150 * ::Elm_Entry_Anchorview_Info.
5152 * See @ref Anchorblock for an example on how to use both of them.
5161 * @typedef Elm_Entry_Anchorview_Info
5163 * The info sent in the callback for "anchor,clicked" signals emitted by
5164 * the Anchorview widget.
5166 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
5168 * @struct _Elm_Entry_Anchorview_Info
5170 * The info sent in the callback for "anchor,clicked" signals emitted by
5171 * the Anchorview widget.
5173 struct _Elm_Entry_Anchorview_Info
5175 const char *name; /**< Name of the anchor, as indicated in its href
5177 int button; /**< The mouse button used to click on it */
5178 Evas_Object *hover; /**< The hover object to use for the popup */
5180 Evas_Coord x, y, w, h;
5181 } anchor, /**< Geometry selection of text used as anchor */
5182 hover_parent; /**< Geometry of the object used as parent by the
5184 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
5185 for content on the left side of
5186 the hover. Before calling the
5187 callback, the widget will make the
5188 necessary calculations to check
5189 which sides are fit to be set with
5190 content, based on the position the
5191 hover is activated and its distance
5192 to the edges of its parent object
5194 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
5195 the right side of the hover.
5196 See @ref hover_left */
5197 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
5198 of the hover. See @ref hover_left */
5199 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
5200 below the hover. See @ref
5204 * Add a new Anchorview object
5206 * @param parent The parent object
5207 * @return The new object or NULL if it cannot be created
5209 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5211 * Set the text to show in the anchorview
5213 * Sets the text of the anchorview to @p text. This text can include markup
5214 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
5215 * text that will be specially styled and react to click events, ended with
5216 * either of \</a\> or \</\>. When clicked, the anchor will emit an
5217 * "anchor,clicked" signal that you can attach a callback to with
5218 * evas_object_smart_callback_add(). The name of the anchor given in the
5219 * event info struct will be the one set in the href attribute, in this
5222 * Other markup can be used to style the text in different ways, but it's
5223 * up to the style defined in the theme which tags do what.
5224 * @deprecated use elm_object_text_set() instead.
5226 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
5228 * Get the markup text set for the anchorview
5230 * Retrieves the text set on the anchorview, with markup tags included.
5232 * @param obj The anchorview object
5233 * @return The markup text set or @c NULL if nothing was set or an error
5235 * @deprecated use elm_object_text_set() instead.
5237 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5239 * Set the parent of the hover popup
5241 * Sets the parent object to use by the hover created by the anchorview
5242 * when an anchor is clicked. See @ref Hover for more details on this.
5243 * If no parent is set, the same anchorview object will be used.
5245 * @param obj The anchorview object
5246 * @param parent The object to use as parent for the hover
5248 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5250 * Get the parent of the hover popup
5252 * Get the object used as parent for the hover created by the anchorview
5253 * widget. See @ref Hover for more details on this.
5255 * @param obj The anchorview object
5256 * @return The object used as parent for the hover, NULL if none is set.
5258 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5260 * Set the style that the hover should use
5262 * When creating the popup hover, anchorview will request that it's
5263 * themed according to @p style.
5265 * @param obj The anchorview object
5266 * @param style The style to use for the underlying hover
5268 * @see elm_object_style_set()
5270 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5272 * Get the style that the hover should use
5274 * Get the style the hover created by anchorview will use.
5276 * @param obj The anchorview object
5277 * @return The style to use by the hover. NULL means the default is used.
5279 * @see elm_object_style_set()
5281 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5283 * Ends the hover popup in the anchorview
5285 * When an anchor is clicked, the anchorview widget will create a hover
5286 * object to use as a popup with user provided content. This function
5287 * terminates this popup, returning the anchorview to its normal state.
5289 * @param obj The anchorview object
5291 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5293 * Set bouncing behaviour when the scrolled content reaches an edge
5295 * Tell the internal scroller object whether it should bounce or not
5296 * when it reaches the respective edges for each axis.
5298 * @param obj The anchorview object
5299 * @param h_bounce Whether to bounce or not in the horizontal axis
5300 * @param v_bounce Whether to bounce or not in the vertical axis
5302 * @see elm_scroller_bounce_set()
5304 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5306 * Get the set bouncing behaviour of the internal scroller
5308 * Get whether the internal scroller should bounce when the edge of each
5309 * axis is reached scrolling.
5311 * @param obj The anchorview object
5312 * @param h_bounce Pointer where to store the bounce state of the horizontal
5314 * @param v_bounce Pointer where to store the bounce state of the vertical
5317 * @see elm_scroller_bounce_get()
5319 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5321 * Appends a custom item provider to the given anchorview
5323 * Appends the given function to the list of items providers. This list is
5324 * called, one function at a time, with the given @p data pointer, the
5325 * anchorview object and, in the @p item parameter, the item name as
5326 * referenced in its href string. Following functions in the list will be
5327 * called in order until one of them returns something different to NULL,
5328 * which should be an Evas_Object which will be used in place of the item
5331 * Items in the markup text take the form \<item relsize=16x16 vsize=full
5332 * href=item/name\>\</item\>
5334 * @param obj The anchorview object
5335 * @param func The function to add to the list of providers
5336 * @param data User data that will be passed to the callback function
5338 * @see elm_entry_item_provider_append()
5340 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);
5342 * Prepend a custom item provider to the given anchorview
5344 * Like elm_anchorview_item_provider_append(), but it adds the function
5345 * @p func to the beginning of the list, instead of the end.
5347 * @param obj The anchorview object
5348 * @param func The function to add to the list of providers
5349 * @param data User data that will be passed to the callback function
5351 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);
5353 * Remove a custom item provider from the list of the given anchorview
5355 * Removes the function and data pairing that matches @p func and @p data.
5356 * That is, unless the same function and same user data are given, the
5357 * function will not be removed from the list. This allows us to add the
5358 * same callback several times, with different @p data pointers and be
5359 * able to remove them later without conflicts.
5361 * @param obj The anchorview object
5362 * @param func The function to remove from the list
5363 * @param data The data matching the function to remove from the list
5365 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);
5372 * @defgroup Anchorblock Anchorblock
5374 * Anchorblock is for displaying text that contains markup with anchors
5375 * like <c>\<a href=1234\>something\</\></c> in it.
5377 * Besides being styled differently, the anchorblock widget provides the
5378 * necessary functionality so that clicking on these anchors brings up a
5379 * popup with user defined content such as "call", "add to contacts" or
5380 * "open web page". This popup is provided using the @ref Hover widget.
5382 * This widget emits the following signals:
5383 * @li "anchor,clicked": will be called when an anchor is clicked. The
5384 * @p event_info parameter on the callback will be a pointer of type
5385 * ::Elm_Entry_Anchorblock_Info.
5391 * Since examples are usually better than plain words, we might as well
5392 * try @ref tutorial_anchorblock_example "one".
5395 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
5396 * This example will show both Anchorblock and @ref Anchorview,
5397 * since both are very similar and it's easier to show them once and side
5398 * by side, so the difference is more clear.
5400 * We'll show the relevant snippets of the code here, but the full example
5401 * can be found here... sorry, @ref anchorblock_example_01.c "here".
5403 * As for the actual example, it's just a simple window with an anchorblock
5404 * and an anchorview, both containing the same text. After including
5405 * Elementary.h and declaring some functions we'll need, we jump to our
5406 * elm_main (see ELM_MAIN) and create our window.
5407 * @dontinclude anchorblock_example_01.c
5412 * With the needed variables declared, we'll create the window and a box to
5413 * hold our widgets, but we don't need to go through that here.
5415 * In order to make clear where the anchorblock ends and the anchorview
5416 * begins, they'll be each inside a @ref Frame. After creating the frame,
5417 * the anchorblock follows.
5418 * @skip elm_frame_add
5419 * @until elm_frame_content_set
5421 * Nothing out of the ordinary there. What's worth mentioning is the call
5422 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
5423 * when an anchor is clicked, the hover for the popup will cover the entire
5424 * window. This affects the area that will be obscured by the hover and
5425 * where clicking will dismiss it, as well as the calculations it does to
5426 * inform the best locations where to insert the popups content.
5427 * Other than that, the code is pretty standard. We also need to set our
5428 * callback for when an anchor is clicked, since it's our task to populate
5429 * the popup. There's no default for it.
5431 * The anchorview is no different, we only change a few things so it looks
5433 * @until elm_frame_content_set
5435 * Then we run, so stuff works and close our main function in the usual way.
5438 * Now, a little note. Normally you would use either one of anchorblock or
5439 * anchorview, set your one callback to clicks and do your stuff in there.
5440 * In this example, however, there are a few tricks to make it easier to
5441 * show both widgets in one go (and to save me some typing). So we have
5442 * two callbacks, one per widget, that will call a common function to do
5443 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
5444 * anchorview too, since both are equal, and passing a callback to use
5445 * for our buttons to end the hover, because each widget has a different
5447 * @until _anchorview_clicked_cb
5450 * The meat of our popup is in the following function. We check what kind
5451 * of menu we need to show, based on the name set to the anchor in the
5452 * markup text. If there's no type (something went wrong, no valid contact
5453 * in the address list) we are just putting a button that does nothing, but
5454 * it's perfectly reasonable to just end the hover and call it quits.
5456 * Our popup will consist of one main button in the middle of our hover,
5457 * and possibly a secondary button and a list of other options. We'll create
5458 * first our main button and check what kind of popup we need afterwards.
5461 * @until eina_stringshare_add
5464 * Each button has two callbacks, one is our hack to close the hover
5465 * properly based on which widget it belongs to, the other a simple
5466 * printf that will show the action with the anchors own data. This is
5467 * not how you would usually do it. Instead, the common case is to have
5468 * one callback for the button that will know which function to call to end
5469 * things, but since we are doing it this way it's worth noting that
5470 * smart callbacks will be called in reverse in respect to the order they
5471 * were added, and since our @c btn_end_cb will close the hover, and thus
5472 * delete our buttons, the other callback wouldn't be called if we had
5475 * After our telephone popup, there are a few others that are practically
5476 * the same, so they won't be shown here.
5478 * Once we are done with that, it's time to place our actions into our
5479 * hover. Main button goes in the middle without much questioning, and then
5480 * we see if we have a secondary button and a box of extra options.
5481 * Because I said so, secondary button goes on either side and box of
5482 * options either on top or below the main one, but to choose which
5483 * exactly, we use the hints our callback info has, which saves us from
5484 * having to do the math and see which side has more space available, with
5485 * a little special case where we delete our extra stuff if there's nowhere
5489 * @skip evas_object_smart
5490 * @until evas_object_del(box)
5494 * The example will look like this:
5496 * @image html screenshots/anchorblock_01.png
5497 * @image latex screenshots/anchorblock_01.eps width=\textwidth
5499 * @example anchorblock_example_01.c
5502 * @addtogroup Anchorblock
5506 * @typedef Elm_Entry_Anchorblock_Info
5508 * The info sent in the callback for "anchor,clicked" signals emitted by
5509 * the Anchorblock widget.
5511 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
5513 * @struct _Elm_Entry_Anchorblock_Info
5515 * The info sent in the callback for "anchor,clicked" signals emitted by
5516 * the Anchorblock widget.
5518 struct _Elm_Entry_Anchorblock_Info
5520 const char *name; /**< Name of the anchor, as indicated in its href
5522 int button; /**< The mouse button used to click on it */
5523 Evas_Object *hover; /**< The hover object to use for the popup */
5525 Evas_Coord x, y, w, h;
5526 } anchor, /**< Geometry selection of text used as anchor */
5527 hover_parent; /**< Geometry of the object used as parent by the
5529 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
5530 for content on the left side of
5531 the hover. Before calling the
5532 callback, the widget will make the
5533 necessary calculations to check
5534 which sides are fit to be set with
5535 content, based on the position the
5536 hover is activated and its distance
5537 to the edges of its parent object
5539 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
5540 the right side of the hover.
5541 See @ref hover_left */
5542 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
5543 of the hover. See @ref hover_left */
5544 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
5545 below the hover. See @ref
5549 * Add a new Anchorblock object
5551 * @param parent The parent object
5552 * @return The new object or NULL if it cannot be created
5554 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5556 * Set the text to show in the anchorblock
5558 * Sets the text of the anchorblock to @p text. This text can include markup
5559 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
5560 * of text that will be specially styled and react to click events, ended
5561 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
5562 * "anchor,clicked" signal that you can attach a callback to with
5563 * evas_object_smart_callback_add(). The name of the anchor given in the
5564 * event info struct will be the one set in the href attribute, in this
5567 * Other markup can be used to style the text in different ways, but it's
5568 * up to the style defined in the theme which tags do what.
5569 * @deprecated use elm_object_text_set() instead.
5571 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
5573 * Get the markup text set for the anchorblock
5575 * Retrieves the text set on the anchorblock, with markup tags included.
5577 * @param obj The anchorblock object
5578 * @return The markup text set or @c NULL if nothing was set or an error
5580 * @deprecated use elm_object_text_set() instead.
5582 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584 * Set the parent of the hover popup
5586 * Sets the parent object to use by the hover created by the anchorblock
5587 * when an anchor is clicked. See @ref Hover for more details on this.
5589 * @param obj The anchorblock object
5590 * @param parent The object to use as parent for the hover
5592 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5594 * Get the parent of the hover popup
5596 * Get the object used as parent for the hover created by the anchorblock
5597 * widget. See @ref Hover for more details on this.
5598 * If no parent is set, the same anchorblock object will be used.
5600 * @param obj The anchorblock object
5601 * @return The object used as parent for the hover, NULL if none is set.
5603 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5605 * Set the style that the hover should use
5607 * When creating the popup hover, anchorblock will request that it's
5608 * themed according to @p style.
5610 * @param obj The anchorblock object
5611 * @param style The style to use for the underlying hover
5613 * @see elm_object_style_set()
5615 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5617 * Get the style that the hover should use
5619 * Get the style the hover created by anchorblock will use.
5621 * @param obj The anchorblock object
5622 * @return The style to use by the hover. NULL means the default is used.
5624 * @see elm_object_style_set()
5626 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5628 * Ends the hover popup in the anchorblock
5630 * When an anchor is clicked, the anchorblock widget will create a hover
5631 * object to use as a popup with user provided content. This function
5632 * terminates this popup, returning the anchorblock to its normal state.
5634 * @param obj The anchorblock object
5636 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5638 * Appends a custom item provider to the given anchorblock
5640 * Appends the given function to the list of items providers. This list is
5641 * called, one function at a time, with the given @p data pointer, the
5642 * anchorblock object and, in the @p item parameter, the item name as
5643 * referenced in its href string. Following functions in the list will be
5644 * called in order until one of them returns something different to NULL,
5645 * which should be an Evas_Object which will be used in place of the item
5648 * Items in the markup text take the form \<item relsize=16x16 vsize=full
5649 * href=item/name\>\</item\>
5651 * @param obj The anchorblock object
5652 * @param func The function to add to the list of providers
5653 * @param data User data that will be passed to the callback function
5655 * @see elm_entry_item_provider_append()
5657 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);
5659 * Prepend a custom item provider to the given anchorblock
5661 * Like elm_anchorblock_item_provider_append(), but it adds the function
5662 * @p func to the beginning of the list, instead of the end.
5664 * @param obj The anchorblock object
5665 * @param func The function to add to the list of providers
5666 * @param data User data that will be passed to the callback function
5668 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);
5670 * Remove a custom item provider from the list of the given anchorblock
5672 * Removes the function and data pairing that matches @p func and @p data.
5673 * That is, unless the same function and same user data are given, the
5674 * function will not be removed from the list. This allows us to add the
5675 * same callback several times, with different @p data pointers and be
5676 * able to remove them later without conflicts.
5678 * @param obj The anchorblock object
5679 * @param func The function to remove from the list
5680 * @param data The data matching the function to remove from the list
5682 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);
5688 * @defgroup Bubble Bubble
5690 * @image html img/widget/bubble/preview-00.png
5691 * @image html img/widget/bubble/preview-01.png
5692 * @image html img/widget/bubble/preview-02.png
5694 * @brief The Bubble is a widget to show text similarly to how speech is
5695 * represented in comics.
5697 * The bubble widget contains 5 important visual elements:
5698 * @li The frame is a rectangle with rounded rectangles and an "arrow".
5699 * @li The @p icon is an image to which the frame's arrow points to.
5700 * @li The @p label is a text which appears to the right of the icon if the
5701 * corner is "top_left" or "bottom_left" and is right aligned to the frame
5703 * @li The @p info is a text which appears to the right of the label. Info's
5704 * font is of a ligther color than label.
5705 * @li The @p content is an evas object that is shown inside the frame.
5707 * The position of the arrow, icon, label and info depends on which corner is
5708 * selected. The four available corners are:
5709 * @li "top_left" - Default
5712 * @li "bottom_right"
5714 * Signals that you can add callbacks for are:
5715 * @li "clicked" - This is called when a user has clicked the bubble.
5717 * For an example of using a buble see @ref bubble_01_example_page "this".
5722 * Add a new bubble to the parent
5724 * @param parent The parent object
5725 * @return The new object or NULL if it cannot be created
5727 * This function adds a text bubble to the given parent evas object.
5729 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5731 * Set the label of the bubble
5733 * @param obj The bubble object
5734 * @param label The string to set in the label
5736 * This function sets the title of the bubble. Where this appears depends on
5737 * the selected corner.
5738 * @deprecated use elm_object_text_set() instead.
5740 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5742 * Get the label of the bubble
5744 * @param obj The bubble object
5745 * @return The string of set in the label
5747 * This function gets the title of the bubble.
5748 * @deprecated use elm_object_text_set() instead.
5750 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5752 * Set the info of the bubble
5754 * @param obj The bubble object
5755 * @param info The given info about the bubble
5757 * This function sets the info of the bubble. Where this appears depends on
5758 * the selected corner.
5759 * @deprecated use elm_object_text_set() instead.
5761 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
5763 * Get the info of the bubble
5765 * @param obj The bubble object
5767 * @return The "info" string of the bubble
5769 * This function gets the info text.
5770 * @deprecated use elm_object_text_set() instead.
5772 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5774 * Set the content to be shown in the bubble
5776 * Once the content object is set, a previously set one will be deleted.
5777 * If you want to keep the old content object, use the
5778 * elm_bubble_content_unset() function.
5780 * @param obj The bubble object
5781 * @param content The given content of the bubble
5783 * This function sets the content shown on the middle of the bubble.
5785 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5787 * Get the content shown in the bubble
5789 * Return the content object which is set for this widget.
5791 * @param obj The bubble object
5792 * @return The content that is being used
5794 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5796 * Unset the content shown in the bubble
5798 * Unparent and return the content object which was set for this widget.
5800 * @param obj The bubble object
5801 * @return The content that was being used
5803 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 * Set the icon of the bubble
5807 * Once the icon object is set, a previously set one will be deleted.
5808 * If you want to keep the old content object, use the
5809 * elm_icon_content_unset() function.
5811 * @param obj The bubble object
5812 * @param icon The given icon for the bubble
5814 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5816 * Get the icon of the bubble
5818 * @param obj The bubble object
5819 * @return The icon for the bubble
5821 * This function gets the icon shown on the top left of bubble.
5823 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825 * Unset the icon of the bubble
5827 * Unparent and return the icon object which was set for this widget.
5829 * @param obj The bubble object
5830 * @return The icon that was being used
5832 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5834 * Set the corner of the bubble
5836 * @param obj The bubble object.
5837 * @param corner The given corner for the bubble.
5839 * This function sets the corner of the bubble. The corner will be used to
5840 * determine where the arrow in the frame points to and where label, icon and
5843 * Possible values for corner are:
5844 * @li "top_left" - Default
5847 * @li "bottom_right"
5849 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
5851 * Get the corner of the bubble
5853 * @param obj The bubble object.
5854 * @return The given corner for the bubble.
5856 * This function gets the selected corner of the bubble.
5858 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5864 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5865 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5866 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5867 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
5868 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5869 /* smart callbacks called:
5870 * "clicked" - the user clicked the icon
5871 * "drag,start" - Someone started dragging the image out of the object
5872 * "drag,end" - Dragged item was dropped (somewhere)
5876 /** @defgroup Elm_Gesture_Layer Gesture Layer */
5878 * @enum _Elm_Gesture_Types
5879 * Emum of supported gesture types.
5880 * @ingroup Elm_Gesture_Layer
5882 enum _Elm_Gesture_Types
5884 ELM_GESTURE_FIRST = 0,
5886 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
5887 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
5888 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
5890 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
5892 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
5893 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
5895 ELM_GESTURE_ZOOM, /**< Zoom */
5896 ELM_GESTURE_ROTATE, /**< Rotate */
5902 * @typedef Elm_Gesture_Types
5903 * Type for Emum of supported gesture types.
5904 * @ingroup Elm_Gesture_Layer
5906 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
5909 * @enum _Elm_Gesture_State
5910 * Emum of gesture states.
5911 * @ingroup Elm_Gesture_Layer
5913 enum _Elm_Gesture_State
5915 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
5916 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
5917 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
5918 ELM_GESTURE_STATE_END, /**< Gesture completed */
5919 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
5922 * @typedef Elm_Gesture_State
5924 * @ingroup Elm_Gesture_Layer
5926 typedef enum _Elm_Gesture_State Elm_Gesture_State;
5929 * @struct _Elm_Gesture_Taps_Info
5930 * Struct holds taps info for user
5931 * @ingroup Elm_Gesture_Layer
5933 struct _Elm_Gesture_Taps_Info
5935 Evas_Coord x, y; /**< Holds center point between fingers */
5936 unsigned int n; /**< Number of fingers tapped */
5937 unsigned int timestamp; /**< event timestamp */
5941 * @typedef Elm_Gesture_Taps_Info
5942 * holds taps info for user
5943 * @ingroup Elm_Gesture_Layer
5945 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
5948 * @struct _Elm_Gesture_Momentum_Info
5949 * Struct holds momentum info for user
5950 * x1 and y1 are not necessarily in sync
5951 * x1 holds x value of x direction starting point
5952 * and same holds for y1.
5953 * This is noticeable when doing V-shape movement
5954 * @ingroup Elm_Gesture_Layer
5956 struct _Elm_Gesture_Momentum_Info
5957 { /* Report line ends, timestamps, and momentum computed */
5958 Evas_Coord x1; /**< Final-swipe direction starting point on X */
5959 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
5960 Evas_Coord x2; /**< Final-swipe direction ending point on X */
5961 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
5963 unsigned int tx; /**< Timestamp of start of final x-swipe */
5964 unsigned int ty; /**< Timestamp of start of final y-swipe */
5966 Evas_Coord mx; /**< Momentum on X */
5967 Evas_Coord my; /**< Momentum on Y */
5971 * @typedef Elm_Gesture_Momentum_Info
5972 * holds momentum info for user
5973 * @ingroup Elm_Gesture_Layer
5975 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
5978 * @struct _Elm_Gesture_Line_Info
5979 * Struct holds line info for user
5980 * @ingroup Elm_Gesture_Layer
5982 struct _Elm_Gesture_Line_Info
5983 { /* Report line ends, timestamps, and momentum computed */
5984 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
5985 unsigned int n; /**< Number of fingers (lines) */
5986 /* FIXME should be radians, bot degrees */
5987 double angle; /**< Angle (direction) of lines */
5991 * @typedef _Elm_Gesture_Line_Info
5992 * Holds line info for user
5993 * @ingroup Elm_Gesture_Layer
5995 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
5998 * @struct _Elm_Gesture_Zoom_Info
5999 * Struct holds zoom info for user
6000 * @ingroup Elm_Gesture_Layer
6002 struct _Elm_Gesture_Zoom_Info
6004 Evas_Coord x, y; /**< Holds zoom center point reported to user */
6005 Evas_Coord radius; /**< Holds radius between fingers reported to user */
6006 double zoom; /**< Zoom value: 1.0 means no zoom */
6007 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
6011 * @typedef Elm_Gesture_Zoom_Info
6012 * Holds zoom info for user
6013 * @ingroup Elm_Gesture_Layer
6015 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
6018 * @struct _Elm_Gesture_Rotate_Info
6019 * Struct holds rotation info for user
6020 * @ingroup Elm_Gesture_Layer
6022 struct _Elm_Gesture_Rotate_Info
6024 Evas_Coord x, y; /**< Holds zoom center point reported to user */
6025 Evas_Coord radius; /**< Holds radius between fingers reported to user */
6026 double base_angle; /**< Holds start-angle */
6027 double angle; /**< Rotation value: 0.0 means no rotation */
6028 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
6032 * @typedef Elm_Gesture_Rotate_Info
6033 * Holds rotation info for user
6034 * @ingroup Elm_Gesture_Layer
6036 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
6039 * @typedef Elm_Gesture_Event_Cb
6040 * User callback used to stream gesture info from gesture layer
6041 * @param data user data
6042 * @param event_info gesture report info
6043 * Returns a flag field to be applied on the causing event.
6044 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
6045 * upon the event, in an irreversible way.
6047 * @ingroup Elm_Gesture_Layer
6049 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
6052 * Use function to set callbacks to be notified about
6053 * change of state of gesture.
6054 * When a user registers a callback with this function
6055 * this means this gesture has to be tested.
6057 * When ALL callbacks for a gesture are set to NULL
6058 * it means user isn't interested in gesture-state
6059 * and it will not be tested.
6061 * @param obj Pointer to gesture-layer.
6062 * @param idx The gesture you would like to track its state.
6063 * @param cb callback function pointer.
6064 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
6065 * @param data user info to be sent to callback (usually, Smart Data)
6067 * @ingroup Elm_Gesture_Layer
6069 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);
6072 * Call this function to get repeat-events settings.
6074 * @param obj Pointer to gesture-layer.
6076 * @return repeat events settings.
6077 * @see elm_gesture_layer_hold_events_set()
6078 * @ingroup Elm_Gesture_Layer
6080 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6083 * This function called in order to make gesture-layer repeat events.
6084 * Set this of you like to get the raw events only if gestures were not detected.
6085 * Clear this if you like gesture layer to fwd events as testing gestures.
6087 * @param obj Pointer to gesture-layer.
6088 * @param r Repeat: TRUE/FALSE
6090 * @ingroup Elm_Gesture_Layer
6092 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
6095 * This function sets step-value for zoom action.
6096 * Set step to any positive value.
6097 * Cancel step setting by setting to 0.0
6099 * @param obj Pointer to gesture-layer.
6100 * @param s new zoom step value.
6102 * @ingroup Elm_Gesture_Layer
6104 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
6107 * This function sets step-value for rotate action.
6108 * Set step to any positive value.
6109 * Cancel step setting by setting to 0.0
6111 * @param obj Pointer to gesture-layer.
6112 * @param s new roatate step value.
6114 * @ingroup Elm_Gesture_Layer
6116 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
6119 * This function called to attach gesture-layer to an Evas_Object.
6120 * @param obj Pointer to gesture-layer.
6121 * @param t Pointer to underlying object (AKA Target)
6123 * @return TRUE, FALSE on success, failure.
6125 * @ingroup Elm_Gesture_Layer
6127 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
6130 * Call this function to construct a new gesture-layer object.
6131 * This does not activate the gesture layer. You have to
6132 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
6134 * @param parent the parent object.
6136 * @return Pointer to new gesture-layer object.
6138 * @ingroup Elm_Gesture_Layer
6140 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6143 typedef enum _Elm_Thumb_Animation_Setting
6145 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
6146 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
6147 ELM_THUMB_ANIMATION_STOP,
6148 ELM_THUMB_ANIMATION_LAST
6149 } Elm_Thumb_Animation_Setting;
6151 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6152 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
6153 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
6154 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
6155 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
6156 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
6157 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6158 EAPI void *elm_thumb_ethumb_client_get(void);
6159 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
6160 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
6161 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6162 /* available styles:
6166 /* smart callbacks called:
6167 * "clicked" - This is called when a user has clicked the thumb without dragging around.
6168 * "clicked,double" - This is called when a user has double-clicked the thumb.
6169 * "press" - This is called when a user has pressed down the thumb.
6170 * "generate,start" - The thumbnail generation started.
6171 * "generate,stop" - The generation process stopped.
6172 * "generate,error" - The generation failed.
6173 * "load,error" - The thumbnail image loading failed.
6177 * @defgroup Hoversel
6179 * A hoversel is a button that pops up a list of items (automatically
6180 * choosing the direction to display) that have a label and, optionally, an
6181 * icon to select from. It is a convenience widget to avoid the need to do
6182 * all the piecing together yourself. It is intended for a small number of
6183 * items in the hoversel menu (no more than 8), though is capable of many
6186 * Signals that you can add callbacks for are:
6187 * "clicked" - the user clicked the hoversel button and popped up the sel
6188 * "selected" - an item in the hoversel list is selected. event_info is the item
6189 * "dismissed" - the hover is dismissed
6191 * See @ref tutorial_hoversel for an example.
6195 * @brief Add a new Hoversel object
6197 * @param parent The parent object
6198 * @return The new object or NULL if it cannot be created
6200 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6202 * @brief This sets the hoversel to expand horizontally.
6204 * @param obj The hoversel object
6205 * @param horizontal If true, the hover will expand horizontally to the
6208 * @note The initial button will display horizontally regardless of this
6211 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6213 * @brief This returns whether the hoversel is set to expand horizontally.
6215 * @param obj The hoversel object
6216 * @return If true, the hover will expand horizontally to the right.
6218 * @see elm_hoversel_horizontal_set()
6220 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6222 * @brief Set the Hover parent
6224 * @param obj The hoversel object
6225 * @param parent The parent to use
6227 * Sets the hover parent object, the area that will be darkened when the
6228 * hoversel is clicked. Should probably be the window that the hoversel is
6229 * in. See @ref Hover objects for more information.
6231 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6233 * @brief Get the Hover parent
6235 * @param obj The hoversel object
6236 * @return The used parent
6238 * Gets the hover parent object.
6240 * @see elm_hoversel_hover_parent_set()
6242 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6244 * @brief Set the hoversel button label
6246 * @param obj The hoversel object
6247 * @param label The label text.
6249 * This sets the label of the button that is always visible (before it is
6250 * clicked and expanded).
6252 * @deprecated elm_object_text_set()
6254 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6256 * @brief Get the hoversel button label
6258 * @param obj The hoversel object
6259 * @return The label text.
6261 * @deprecated elm_object_text_get()
6263 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6265 * @brief Set the icon of the hoversel button
6267 * @param obj The hoversel object
6268 * @param icon The icon object
6270 * Sets the icon of the button that is always visible (before it is clicked
6271 * and expanded). Once the icon object is set, a previously set one will be
6272 * deleted, if you want to keep that old content object, use the
6273 * elm_hoversel_icon_unset() function.
6275 * @see elm_button_icon_set()
6277 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6279 * @brief Get the icon of the hoversel button
6281 * @param obj The hoversel object
6282 * @return The icon object
6284 * Get the icon of the button that is always visible (before it is clicked
6285 * and expanded). Also see elm_button_icon_get().
6287 * @see elm_hoversel_icon_set()
6289 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291 * @brief Get and unparent the icon of the hoversel button
6293 * @param obj The hoversel object
6294 * @return The icon object that was being used
6296 * Unparent and return the icon of the button that is always visible
6297 * (before it is clicked and expanded).
6299 * @see elm_hoversel_icon_set()
6300 * @see elm_button_icon_unset()
6302 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6304 * @brief This triggers the hoversel popup from code, the same as if the user
6305 * had clicked the button.
6307 * @param obj The hoversel object
6309 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6311 * @brief This dismisses the hoversel popup as if the user had clicked
6312 * outside the hover.
6314 * @param obj The hoversel object
6316 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6318 * @brief Returns whether the hoversel is expanded.
6320 * @param obj The hoversel object
6321 * @return This will return EINA_TRUE if the hoversel is expanded or
6322 * EINA_FALSE if it is not expanded.
6324 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6326 * @brief This will remove all the children items from the hoversel.
6328 * @param obj The hoversel object
6330 * @warning Should @b not be called while the hoversel is active; use
6331 * elm_hoversel_expanded_get() to check first.
6333 * @see elm_hoversel_item_del_cb_set()
6334 * @see elm_hoversel_item_del()
6336 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6338 * @brief Get the list of items within the given hoversel.
6340 * @param obj The hoversel object
6341 * @return Returns a list of Elm_Hoversel_Item*
6343 * @see elm_hoversel_item_add()
6345 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6347 * @brief Add an item to the hoversel button
6349 * @param obj The hoversel object
6350 * @param label The text label to use for the item (NULL if not desired)
6351 * @param icon_file An image file path on disk to use for the icon or standard
6352 * icon name (NULL if not desired)
6353 * @param icon_type The icon type if relevant
6354 * @param func Convenience function to call when this item is selected
6355 * @param data Data to pass to item-related functions
6356 * @return A handle to the item added.
6358 * This adds an item to the hoversel to show when it is clicked. Note: if you
6359 * need to use an icon from an edje file then use
6360 * elm_hoversel_item_icon_set() right after the this function, and set
6361 * icon_file to NULL here.
6363 * For more information on what @p icon_file and @p icon_type are see the
6364 * @ref Icon "icon documentation".
6366 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);
6368 * @brief Delete an item from the hoversel
6370 * @param item The item to delete
6372 * This deletes the item from the hoversel (should not be called while the
6373 * hoversel is active; use elm_hoversel_expanded_get() to check first).
6375 * @see elm_hoversel_item_add()
6376 * @see elm_hoversel_item_del_cb_set()
6378 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
6380 * @brief Set the function to be called when an item from the hoversel is
6383 * @param item The item to set the callback on
6384 * @param func The function called
6386 * That function will receive these parameters:
6387 * @li void *item_data
6388 * @li Evas_Object *the_item_object
6389 * @li Elm_Hoversel_Item *the_object_struct
6391 * @see elm_hoversel_item_add()
6393 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6395 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
6396 * that will be passed to associated function callbacks.
6398 * @param item The item to get the data from
6399 * @return The data pointer set with elm_hoversel_item_add()
6401 * @see elm_hoversel_item_add()
6403 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
6405 * @brief This returns the label text of the given hoversel item.
6407 * @param item The item to get the label
6408 * @return The label text of the hoversel item
6410 * @see elm_hoversel_item_add()
6412 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
6414 * @brief This sets the icon for the given hoversel item.
6416 * @param item The item to set the icon
6417 * @param icon_file An image file path on disk to use for the icon or standard
6419 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
6420 * to NULL if the icon is not an edje file
6421 * @param icon_type The icon type
6423 * The icon can be loaded from the standard set, from an image file, or from
6426 * @see elm_hoversel_item_add()
6428 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);
6430 * @brief Get the icon object of the hoversel item
6432 * @param item The item to get the icon from
6433 * @param icon_file The image file path on disk used for the icon or standard
6435 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
6436 * if the icon is not an edje file
6437 * @param icon_type The icon type
6439 * @see elm_hoversel_item_icon_set()
6440 * @see elm_hoversel_item_add()
6442 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);
6448 typedef enum _Elm_Toolbar_Shrink_Mode
6450 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
6451 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
6452 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
6453 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
6454 } Elm_Toolbar_Shrink_Mode;
6456 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
6457 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
6459 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6460 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
6461 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6462 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
6463 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6464 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6465 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6466 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);
6467 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);
6468 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);
6469 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);
6470 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6471 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6472 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6473 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6474 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6475 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
6476 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6477 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6478 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6479 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
6480 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6481 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
6482 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6483 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6484 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6485 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6486 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
6487 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6488 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6489 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6490 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6491 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
6492 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6493 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
6494 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6495 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6496 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6497 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6498 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6499 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6500 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6501 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
6502 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6503 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
6504 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6505 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);
6506 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
6507 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
6508 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
6509 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
6510 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
6511 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
6512 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
6513 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);
6514 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6515 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
6516 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6517 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6518 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6519 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6520 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
6521 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6522 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6523 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
6524 /* smart callbacks called:
6525 * "clicked" - when the user clicks on a toolbar item and becomes selected
6527 /* available styles:
6529 * transparent (no background or shadow, just show the provided content)
6533 EAPI double elm_tooltip_delay_get(void);
6534 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
6535 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
6536 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
6537 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
6538 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);
6539 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6540 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
6541 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6542 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
6543 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6544 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6545 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
6546 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6547 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6548 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6551 EAPI int elm_cursor_engine_only_get(void);
6552 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
6555 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
6556 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6557 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6558 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6560 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6561 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6562 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
6563 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);
6564 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
6565 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6566 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
6567 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6568 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6569 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6570 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6571 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6572 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6573 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
6574 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6575 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6576 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6577 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
6578 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
6579 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
6580 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
6581 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
6582 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
6583 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
6584 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
6586 /* smart callbacks called:
6587 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
6591 typedef enum _Elm_List_Mode
6593 ELM_LIST_COMPRESS = 0,
6599 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
6600 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6601 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);
6602 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);
6603 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);
6604 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);
6605 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);
6606 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6607 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
6608 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6609 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6610 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
6611 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6612 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6613 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6614 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6615 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6616 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6617 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6618 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6619 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
6620 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
6621 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6622 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6623 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
6624 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
6625 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
6626 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6627 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6628 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6629 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6630 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6631 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
6632 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6633 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6634 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
6635 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
6636 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
6637 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
6638 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);
6639 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
6640 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
6641 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6642 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6643 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6644 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
6645 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
6646 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6647 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6648 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
6649 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6650 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
6651 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6652 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6653 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6654 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);
6655 /* smart callbacks called:
6656 * "clicked,double" - when the user double-clicked an item
6657 * "selected" - when the user selected an item
6658 * "unselected" - when the user selected an item
6659 * "longpressed" - an item in the hoversel list is long-pressed
6660 * "scroll,edge,top" - the list is scrolled until the top edge
6661 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
6662 * "scroll,edge,left" - the list is scrolled until the left edge
6663 * "scroll,edge,right" - the list is scrolled until the right edge
6667 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6668 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6669 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6670 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6671 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6672 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6673 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
6674 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6675 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6676 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
6677 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6678 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
6679 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6680 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
6681 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6682 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);
6683 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);
6684 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6685 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6686 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
6687 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
6688 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6689 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
6691 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6692 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
6693 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6694 /* smart callbacks called:
6695 * "changed" - Whenever the slider value is changed by the user.
6696 * "slider,drag,start" - dragging the slider indicator around has started
6697 * "slider,drag,stop" - dragging the slider indicator around has stopped
6698 * "delay,changed" - A short time after the value is changed by the user.
6699 * This will be called only when the user stops dragging for a very short
6700 * period or when they release their finger/mouse, so it avoids possibly
6701 * expensive reactions to the value change.
6705 * @addtogroup Actionslider Actionslider
6707 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
6708 * properties. The indicator is the element the user drags to choose a label.
6709 * When the position is set with magnet, when released the indicator will be
6710 * moved to it if it's nearest the magnetized position.
6712 * @note By default all positions are set as enabled.
6714 * Signals that you can add callbacks for are:
6716 * "selected" - when user selects an enabled position (the label is passed
6719 * "pos_changed" - when the indicator reaches any of the positions("left",
6720 * "right" or "center").
6722 * See an example of actionslider usage @ref actionslider_example_page "here"
6725 typedef enum _Elm_Actionslider_Pos
6727 ELM_ACTIONSLIDER_NONE = 0,
6728 ELM_ACTIONSLIDER_LEFT = 1 << 0,
6729 ELM_ACTIONSLIDER_CENTER = 1 << 1,
6730 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
6731 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
6732 } Elm_Actionslider_Pos;
6735 * Add a new actionslider to the parent.
6737 * @param parent The parent object
6738 * @return The new actionslider object or NULL if it cannot be created
6740 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6742 * Set actionslider labels.
6744 * @param obj The actionslider object
6745 * @param left_label The label to be set on the left.
6746 * @param center_label The label to be set on the center.
6747 * @param right_label The label to be set on the right.
6748 * @deprecated use elm_object_text_set() instead.
6750 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);
6752 * Get actionslider labels.
6754 * @param obj The actionslider object
6755 * @param left_label A char** to place the left_label of @p obj into.
6756 * @param center_label A char** to place the center_label of @p obj into.
6757 * @param right_label A char** to place the right_label of @p obj into.
6758 * @deprecated use elm_object_text_set() instead.
6760 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);
6762 * Get actionslider selected label.
6764 * @param obj The actionslider object
6765 * @return The selected label
6767 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6769 * Set actionslider indicator position.
6771 * @param obj The actionslider object.
6772 * @param pos The position of the indicator.
6774 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
6776 * Get actionslider indicator position.
6778 * @param obj The actionslider object.
6779 * @return The position of the indicator.
6781 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6783 * Set actionslider magnet position. To make multiple positions magnets @c or
6784 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
6786 * @param obj The actionslider object.
6787 * @param pos Bit mask indicating the magnet positions.
6789 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
6791 * Get actionslider magnet position.
6793 * @param obj The actionslider object.
6794 * @return The positions with magnet property.
6796 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6798 * Set actionslider enabled position. To set multiple positions as enabled @c or
6799 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
6801 * @note All the positions are enabled by default.
6803 * @param obj The actionslider object.
6804 * @param pos Bit mask indicating the enabled positions.
6806 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
6808 * Get actionslider enabled position.
6810 * @param obj The actionslider object.
6811 * @return The enabled positions.
6813 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6815 * Set the label used on the indicator.
6817 * @param obj The actionslider object
6818 * @param label The label to be set on the indicator.
6819 * @deprecated use elm_object_text_set() instead.
6821 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6823 * Get the label used on the indicator object.
6825 * @param obj The actionslider object
6826 * @return The indicator label
6827 * @deprecated use elm_object_text_set() instead.
6829 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6835 typedef enum _Elm_Genlist_Item_Flags
6837 ELM_GENLIST_ITEM_NONE = 0,
6838 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
6839 ELM_GENLIST_ITEM_GROUP = (1 << 1)
6840 } Elm_Genlist_Item_Flags;
6841 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
6842 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
6843 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
6844 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
6845 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
6846 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
6847 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
6848 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
6850 struct _Elm_Genlist_Item_Class
6852 const char *item_style;
6855 GenlistItemLabelGetFunc label_get;
6856 GenlistItemIconGetFunc icon_get;
6857 GenlistItemStateGetFunc state_get;
6858 GenlistItemDelFunc del;
6859 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
6861 const char *mode_item_style;
6864 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6865 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6866 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6867 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6868 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
6869 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6870 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6871 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6872 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6873 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6874 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
6875 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6876 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
6877 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6878 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6879 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6880 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6881 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6882 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
6883 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6884 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6885 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6886 /* operations to add items */
6887 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);
6888 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);
6889 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);
6890 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);
6891 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);
6892 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);
6893 /* operations to retrieve existing items */
6894 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6895 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6896 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6897 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);
6898 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6899 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6900 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6901 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);
6902 /* available item styles:
6904 * default_style - The text part is a textblock
6906 * icon_top_text_bottom
6908 /* Genlist Item operation */
6909 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6910 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6911 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6912 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6913 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6914 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6915 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6916 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
6917 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6918 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6919 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6920 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6921 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
6922 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6923 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6924 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6925 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6926 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6927 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6928 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6929 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6930 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6931 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
6932 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6933 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6934 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6935 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
6936 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6937 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
6938 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);
6939 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6940 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
6941 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6942 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6943 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6944 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6945 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
6946 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6947 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6948 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6949 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
6950 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
6951 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6952 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6953 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6954 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6955 /* Signals that you can add callbacks for are:
6956 * "clicked,double" - This is called when a user has double-clicked an item.
6957 * The event_info parameter is the genlist item that was
6959 * "selected" - This is called when a user has made an item selected. The
6960 * event_info parameter is the genlist item that was selected.
6961 * "unselected" - This is called when a user has made an item unselected. The
6962 * event_info parameter is the genlist item that was
6964 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
6965 * and the item is now meant to be expanded. The event_info
6966 * parameter is the genlist item that was indicated to expand.
6967 * It is the job of this callback to then fill in the child
6969 * "contracted" - This is called when elm_genlist_item_expanded_set() is
6970 * called and the item is now meant to be contracted. The
6971 * event_info parameter is the genlist item that was indicated
6972 * to contract. It is the job of this callback to then delete
6974 * "expand,request" - This is called when a user has indicated they want to
6975 * expand a tree branch item. The callback should decide
6976 * if the item can expand (has any children) and then call
6977 * elm_genlist_item_expanded_set() appropriately to set
6978 * the state. The event_info parameter is the genlist item
6979 * that was indicated to expand.
6980 * "contract,request" - This is called when a user has indicated they want to
6981 * contract a tree branch item. The callback should
6982 * decide if the item can contract (has any children)
6983 * and then call elm_genlist_item_expanded_set()
6984 * appropriately to set the state. The event_info
6985 * parameter is the genlist item that was indicated to
6987 * "realized" - This is called when the item in the list is created as a real
6988 * evas object. event_info parameter is the genlist item that
6989 * was created. The object may be deleted at any time, so it is
6990 * up to the caller to not use the object pointer from
6991 * elm_genlist_item_object_get() in a way where it may point to
6993 * "unrealized" - This is called just before an item is unrealized. After
6994 * this call icon objects provided will be deleted and the
6995 * item object itself delete or be put into a floating cache.
6996 * "drag,start,up" - This is called when the item in the list has been
6997 * dragged (not scrolled) up.
6998 * "drag,start,down" - This is called when the item in the list has been
6999 * dragged (not scrolled) down.
7000 * "drag,start,left" - This is called when the item in the list has been
7001 * dragged (not scrolled) left.
7002 * "drag,start,right" - This is called when the item in the list has been
7003 * dragged (not scrolled) right.
7004 * "drag,stop" - This is called when the item in the list has stopped being
7006 * "drag" - This is called when the item in the list is being dragged.
7007 * "longpressed" - This is called when the item is pressed for a certain
7008 * amount of time. By default it's 1 second.
7009 * "scroll,edge,top" - This is called when the genlist is scrolled until the
7011 * "scroll,edge,bottom" - This is called when the genlist is scrolled until
7013 * "scroll,edge,left" - This is called when the genlist is scrolled until the
7015 * "scroll,edge,right" - This is called when the genlist is scrolled until
7017 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
7019 * "multi,swipe,right" - This is called when the genlist is multi-touch
7021 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
7023 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
7025 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
7027 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
7029 * "swipe" - This is called when the genlist is swiped.
7033 * @page tutorial_check Check example
7034 * @dontinclude check_example_01.c
7036 * This example will show 2 checkboxes, one with just a label and the second
7037 * one with both a label and an icon. This example also ilustrates how to
7038 * have the checkbox change the value of a variable and how to react to those
7041 * We will start with the usual setup code:
7044 * And now we create our first checkbox, set its label, tell it to change
7045 * the value of @p value when the checkbox stats is changed and ask to be
7046 * notified of state changes:
7049 * For our second checkbox we are going to set an icon so we need to create
7052 * @note For simplicity we are using a rectangle as icon, but any evas object
7055 * And for our second checkbox we set the label, icon and state to true:
7058 * We now do some more setup:
7061 * And finally implement the callback that will be called when the first
7062 * checkbox's state changes. This callback will use @p data to print a
7065 * @note This work because @p data is @p value(from the main function) and @p
7066 * value is changed when the checkbox is changed.
7068 * Our example will look like this:
7070 * @image html screenshots/check_example_01.png
7071 * @image latex screenshots/check_example_01.eps width=\textwidth
7073 * @example check_example_01.c
7076 * @defgroup Check Check
7078 * @image html img/widget/button/preview-00.png
7079 * @image html img/widget/button/preview-01.png
7080 * @image html img/widget/button/preview-02.png
7082 * @brief The check widget allows for toggling a value between true and
7085 * Check objects are a lot like radio objects in layout and functionality
7086 * except they do not work as a group, but independently and only toggle the
7087 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
7088 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
7089 * returns the current state. For convenience, like the radio objects, you
7090 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
7093 * Signals that you can add callbacks for are:
7094 * "changed" - This is called whenever the user changes the state of one of
7095 * the check object(event_info is NULL).
7097 * @ref tutorial_check should give you a firm grasp of how to use this widget.
7101 * @brief Add a new Check object
7103 * @param parent The parent object
7104 * @return The new object or NULL if it cannot be created
7106 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7108 * @brief Set the text label of the check object
7110 * @param obj The check object
7111 * @param label The text label string in UTF-8
7113 * @deprecated use elm_object_text_set() instead.
7115 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7117 * @brief Get the text label of the check object
7119 * @param obj The check object
7120 * @return The text label string in UTF-8
7122 * @deprecated use elm_object_text_get() instead.
7124 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7126 * @brief Set the icon object of the check object
7128 * @param obj The check object
7129 * @param icon The icon object
7131 * Once the icon object is set, a previously set one will be deleted.
7132 * If you want to keep that old content object, use the
7133 * elm_check_icon_unset() function.
7135 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7137 * @brief Get the icon object of the check object
7139 * @param obj The check object
7140 * @return The icon object
7142 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7144 * @brief Unset the icon used for the check object
7146 * @param obj The check object
7147 * @return The icon object that was being used
7149 * Unparent and return the icon object which was set for this widget.
7151 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7153 * @brief Set the on/off state of the check object
7155 * @param obj The check object
7156 * @param state The state to use (1 == on, 0 == off)
7158 * This sets the state of the check. If set
7159 * with elm_check_state_pointer_set() the state of that variable is also
7160 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
7162 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7164 * @brief Get the state of the check object
7166 * @param obj The check object
7167 * @return The boolean state
7169 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7171 * @brief Set a convenience pointer to a boolean to change
7173 * @param obj The check object
7174 * @param statep Pointer to the boolean to modify
7176 * This sets a pointer to a boolean, that, in addition to the check objects
7177 * state will also be modified directly. To stop setting the object pointed
7178 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
7179 * then when this is called, the check objects state will also be modified to
7180 * reflect the value of the boolean @p statep points to, just like calling
7181 * elm_check_state_set().
7183 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7189 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7190 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7191 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7192 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7193 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7194 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7195 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
7196 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
7197 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7198 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
7199 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7200 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
7201 /* smart callbacks called:
7202 * "changed" - when the radio status is changed
7206 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7207 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7208 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
7209 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7210 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7211 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7212 /* available item styles:
7218 /* smart callbacks called:
7219 * "hide,finished" - when the previous page is hided
7222 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
7223 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
7224 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
7225 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
7226 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
7228 struct _Elm_Slideshow_Item_Class
7230 struct _Elm_Slideshow_Item_Class_Func
7232 SlideshowItemGetFunc get;
7233 SlideshowItemDelFunc del;
7237 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7238 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
7239 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);
7240 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
7241 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
7242 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
7243 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7244 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
7245 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7246 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7247 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7248 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
7249 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7250 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7251 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7252 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
7253 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
7254 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7255 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
7256 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
7257 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7258 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
7259 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7260 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
7261 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7262 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
7263 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7264 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7265 /* smart callbacks called:
7266 * "changed" - when the slideshow switch to another item
7270 * @defgroup Fileselector File Selector
7272 * A file selector is a widget that allows a user to navigate
7273 * through a file system, reporting file selections back via its
7276 * It contains shortcut buttons for home directory (@c ~) and to
7277 * jump one directory upwards (..), as well as cancel/ok buttons to
7278 * confirm/cancel a given selection. After either one of those two
7279 * former actions, the file selector will issue its @c "done" smart
7282 * There's a text entry on it, too, showing the name of the current
7283 * selection. There's the possibility of making it editable, so it
7284 * is useful on file saving dialogs on applications, where one
7285 * gives a file name to save contents to, in a given directory in
7286 * the system. This custom file name will be reported on the @c
7287 * "done" smart callback (explained in sequence).
7289 * Finally, it has a view to display file system items into in two
7294 * If Elementary is built with support of the Ethumb thumbnailing
7295 * library, the second form of view will display preview thumbnails
7296 * of files which it supports.
7298 * Smart callbacks one can register to:
7300 * - @c "selected" - the user has clicked on a file (when not in
7301 * folders-only mode) or directory (when in folders-only mode)
7302 * - @c "directory,open" - the list has been populated with new
7303 * content (@c event_info is a pointer to the directory's
7304 * path, a @b stringshared string)
7305 * - @c "done" - the user has clicked on the "ok" or "cancel"
7306 * buttons (@c event_info is a pointer to the selection's
7307 * path, a @b stringshared string)
7309 * Here is an example on its usage:
7310 * @li @ref fileselector_example
7314 * @addtogroup Fileselector
7319 * Defines how a file selector widget is to layout its contents
7320 * (file system entries).
7322 typedef enum _Elm_Fileselector_Mode
7324 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
7325 ELM_FILESELECTOR_GRID, /**< layout as a grid */
7326 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
7327 } Elm_Fileselector_Mode;
7330 * Add a new file selector widget to the given parent Elementary
7331 * (container) object
7333 * @param parent The parent object
7334 * @return a new file selector widget handle or @c NULL, on errors
7336 * This function inserts a new file selector widget on the canvas.
7338 * @ingroup Fileselector
7340 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7343 * Enable/disable the file name entry box where the user can type
7344 * in a name for a file, in a given file selector widget
7346 * @param obj The file selector object
7347 * @param is_save @c EINA_TRUE to make the file selector a "saving
7348 * dialog", @c EINA_FALSE otherwise
7350 * Having the entry editable is useful on file saving dialogs on
7351 * applications, where one gives a file name to save contents to,
7352 * in a given directory in the system. This custom file name will
7353 * be reported on the @c "done" smart callback.
7355 * @see elm_fileselector_is_save_get()
7357 * @ingroup Fileselector
7359 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
7362 * Get whether the given file selector is in "saving dialog" mode
7364 * @param obj The file selector object
7365 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
7366 * mode, @c EINA_FALSE otherwise (and on errors)
7368 * @see elm_fileselector_is_save_set() for more details
7370 * @ingroup Fileselector
7372 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7375 * Enable/disable folder-only view for a given file selector widget
7377 * @param obj The file selector object
7378 * @param only @c EINA_TRUE to make @p obj only display
7379 * directories, @c EINA_FALSE to make files to be displayed in it
7382 * If enabled, the widget's view will only display folder items,
7385 * @see elm_fileselector_folder_only_get()
7387 * @ingroup Fileselector
7389 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
7392 * Get whether folder-only view is set for a given file selector
7395 * @param obj The file selector object
7396 * @return only @c EINA_TRUE if @p obj is only displaying
7397 * directories, @c EINA_FALSE if files are being displayed in it
7398 * too (and on errors)
7400 * @see elm_fileselector_folder_only_get()
7402 * @ingroup Fileselector
7404 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7407 * Enable/disable the "ok" and "cancel" buttons on a given file
7410 * @param obj The file selector object
7411 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
7413 * @note A file selector without those buttons will never emit the
7414 * @c "done" smart event, and is only usable if one is just hooking
7415 * to the other two events.
7417 * @see elm_fileselector_buttons_ok_cancel_get()
7419 * @ingroup Fileselector
7421 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
7424 * Get whether the "ok" and "cancel" buttons on a given file
7425 * selector widget are being shown.
7427 * @param obj The file selector object
7428 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
7429 * otherwise (and on errors)
7431 * @see elm_fileselector_buttons_ok_cancel_set() for more details
7433 * @ingroup Fileselector
7435 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7438 * Enable/disable a tree view in the given file selector widget,
7439 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
7441 * @param obj The file selector object
7442 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7445 * In a tree view, arrows are created on the sides of directories,
7446 * allowing them to expand in place.
7448 * @note If it's in other mode, the changes made by this function
7449 * will only be visible when one switches back to "list" mode.
7451 * @see elm_fileselector_expandable_get()
7453 * @ingroup Fileselector
7455 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
7458 * Get whether tree view is enabled for the given file selector
7461 * @param obj The file selector object
7462 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
7463 * otherwise (and or errors)
7465 * @see elm_fileselector_expandable_set() for more details
7467 * @ingroup Fileselector
7469 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7472 * Set, programmatically, the @b directory that a given file
7473 * selector widget will display contents from
7475 * @param obj The file selector object
7476 * @param path The path to display in @p obj
7478 * This will change the @b directory that @p obj is displaying. It
7479 * will also clear the text entry area on the @p obj object, which
7480 * displays select files' names.
7482 * @see elm_fileselector_path_get()
7484 * @ingroup Fileselector
7486 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7489 * Get the parent directory's path that a given file selector
7490 * widget is displaying
7492 * @param obj The file selector object
7493 * @return The (full) path of the directory the file selector is
7494 * displaying, a @b stringshared string
7496 * @see elm_fileselector_path_set()
7498 * @ingroup Fileselector
7500 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7503 * Set, programmatically, the currently selected file/directory in
7504 * the given file selector widget
7506 * @param obj The file selector object
7507 * @param path The (full) path to a file or directory
7508 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
7509 * latter case occurs if the directory or file pointed to do not
7512 * @see elm_fileselector_selected_get()
7514 * @ingroup Fileselector
7516 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7519 * Get the currently selected item's (full) path, in the given file
7522 * @param obj The file selector object
7523 * @return The absolute path of the selected item, a @b
7524 * stringshared string
7526 * @note Custom editions on @p obj object's text entry, if made,
7527 * will appear on the return string of this function, naturally.
7529 * @see elm_fileselector_selected_set() for more details
7531 * @ingroup Fileselector
7533 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7536 * Set the mode in which a given file selector widget will display
7537 * (layout) file system entries in its view
7539 * @param obj The file selector object
7540 * @param mode The mode of the fileselector, being it one of
7541 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
7542 * first one, naturally, will display the files in a list. The
7543 * latter will make the widget to display its entries in a grid
7546 * @note By using elm_fileselector_expandable_set(), the user may
7547 * trigger a tree view for that list.
7549 * @note If Elementary is built with support of the Ethumb
7550 * thumbnailing library, the second form of view will display
7551 * preview thumbnails of files which it supports. You must have
7552 * elm_need_ethumb() called in your Elementary for thumbnailing to
7555 * @see elm_fileselector_expandable_set().
7556 * @see elm_fileselector_mode_get().
7558 * @ingroup Fileselector
7560 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
7563 * Get the mode in which a given file selector widget is displaying
7564 * (layouting) file system entries in its view
7566 * @param obj The fileselector object
7567 * @return The mode in which the fileselector is at
7569 * @see elm_fileselector_mode_set() for more details
7571 * @ingroup Fileselector
7573 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7580 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7581 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
7582 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7583 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7584 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
7585 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7586 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7587 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7588 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7589 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7590 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7591 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
7592 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7593 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
7594 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7595 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7596 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7597 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
7598 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7599 /* smart callbacks called:
7601 /* available item styles:
7603 * wheel (simple style, no text, no progression, only pulse is available)
7607 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7608 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7609 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7610 /* smart callbacks called:
7614 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7615 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
7616 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7617 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
7618 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
7619 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
7620 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7621 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
7622 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7623 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
7624 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7625 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
7626 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7627 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
7628 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7629 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7630 /* smart callbacks called:
7631 * "changed" - when the spinner value changes
7632 * "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).
7634 /* available item styles:
7636 * vertical (two up/down buttons at the right side and text left aligned)
7640 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
7642 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7643 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
7644 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7645 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
7646 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7647 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
7648 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
7649 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
7650 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
7651 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
7652 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);
7653 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
7654 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
7655 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7656 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
7657 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
7658 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
7659 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7660 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
7661 /* smart callbacks called:
7662 * "changed" - when the selected index item changes
7663 * "delay,changed" - when the selected index item changes, but after some small idle period
7664 * "selected" - when the user releases a finger and selects an item
7665 * "level,up" - when the user moves a finger from the first level to the second level
7666 * "level,down" - when the user moves a finger from the second level to the first level
7670 typedef enum _Elm_Photocam_Zoom_Mode
7672 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
7673 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
7674 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
7675 ELM_PHOTOCAM_ZOOM_MODE_LAST
7676 } Elm_Photocam_Zoom_Mode;
7678 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7679 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
7680 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7681 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
7682 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7683 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
7684 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7685 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
7686 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7687 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7688 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7689 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
7690 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7691 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7692 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7693 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7694 /* smart callbacks called:
7695 * "clicked" - when image clicked
7696 * "press" - when mouse/finger held down initially on image
7697 * "longpressed" - when mouse/finger held for long time on image
7698 * "clicked,double" - when mouse/finger double-clicked
7699 * "load" - when photo load begins
7700 * "loaded" - when photo load done
7701 * "load,detail" - when detailed image load begins
7702 * "loaded,detail" - when detailed image load done
7703 * "zoom,start" - when zooming started
7704 * "zoom,stop" - when zooming stopped
7705 * "zoom,change" - when auto zoom mode changed zoom level
7706 * "scroll - the content has been scrolled (moved)
7707 * "scroll,anim,start" - scrolling animation has started
7708 * "scroll,anim,stop" - scrolling animation has stopped
7709 * "scroll,drag,start" - dragging the contents around has started
7710 * "scroll,drag,stop" - dragging the contents around has stopped
7714 typedef enum _Elm_Map_Zoom_Mode
7716 ELM_MAP_ZOOM_MODE_MANUAL,
7717 ELM_MAP_ZOOM_MODE_AUTO_FIT,
7718 ELM_MAP_ZOOM_MODE_AUTO_FILL,
7719 ELM_MAP_ZOOM_MODE_LAST
7720 } Elm_Map_Zoom_Mode;
7722 typedef enum _Elm_Map_Route_Sources
7724 ELM_MAP_ROUTE_SOURCE_YOURS,
7725 ELM_MAP_ROUTE_SOURCE_MONAV,
7726 ELM_MAP_ROUTE_SOURCE_ORS,
7727 ELM_MAP_ROUTE_SOURCE_LAST
7728 } Elm_Map_Route_Sources;
7730 typedef enum _Elm_Map_Name_Sources
7732 ELM_MAP_NAME_SOURCE_NOMINATIM,
7733 ELM_MAP_NAME_SOURCE_LAST
7734 } Elm_Map_Name_Sources;
7736 typedef enum _Elm_Map_Route_Type
7738 ELM_MAP_ROUTE_TYPE_MOTOCAR,
7739 ELM_MAP_ROUTE_TYPE_BICYCLE,
7740 ELM_MAP_ROUTE_TYPE_FOOT,
7741 ELM_MAP_ROUTE_TYPE_LAST
7742 } Elm_Map_Route_Type;
7744 typedef enum _Elm_Map_Route_Method
7746 ELM_MAP_ROUTE_METHOD_FASTEST,
7747 ELM_MAP_ROUTE_METHOD_SHORTEST,
7748 ELM_MAP_ROUTE_METHOD_LAST
7749 } Elm_Map_Route_Method;
7751 typedef enum _Elm_Map_Name_Method
7753 ELM_MAP_NAME_METHOD_SEARCH,
7754 ELM_MAP_NAME_METHOD_REVERSE,
7755 ELM_MAP_NAME_METHOD_LAST
7756 } Elm_Map_Name_Method;
7758 typedef struct _Elm_Map_Marker Elm_Map_Marker;
7759 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
7760 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
7761 typedef struct _Elm_Map_Route Elm_Map_Route;
7762 typedef struct _Elm_Map_Name Elm_Map_Name;
7763 typedef struct _Elm_Map_Track Elm_Map_Track;
7765 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
7766 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
7767 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
7768 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
7770 typedef char *(*ElmMapModuleSourceFunc) (void);
7771 typedef int (*ElmMapModuleZoomMinFunc) (void);
7772 typedef int (*ElmMapModuleZoomMaxFunc) (void);
7773 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
7774 typedef int (*ElmMapModuleRouteSourceFunc) (void);
7775 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
7776 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
7777 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
7778 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
7780 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7781 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
7782 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7783 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
7784 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7785 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
7786 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
7787 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
7788 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
7789 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7790 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
7791 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7792 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
7793 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);
7794 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);
7795 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
7796 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
7797 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);
7798 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);
7799 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
7800 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
7801 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
7802 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
7803 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
7804 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
7805 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
7806 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
7807 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
7808 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
7809 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
7810 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
7811 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
7812 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
7813 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
7814 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
7815 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
7816 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
7817 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
7818 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
7819 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
7820 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7821 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
7822 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7823 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
7824 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7825 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
7826 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7827 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
7828 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7829 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
7830 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7831 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);
7832 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
7833 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7834 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7835 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
7836 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
7837 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
7838 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
7839 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
7840 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
7841 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
7842 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);
7843 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7844 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7846 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
7848 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
7850 /* smart callbacks called:
7851 * "clicked" - when image clicked
7852 * "press" - when mouse/finger held down initially on image
7853 * "longpressed" - when mouse/finger held for long time on image
7854 * "clicked,double" - when mouse/finger double-clicked
7855 * "load,details" - when detailed image load begins
7856 * "loaded,details" - when detailed image load done
7857 * "zoom,start" - when zooming started
7858 * "zoom,stop" - when zooming stopped
7859 * "zoom,change" - when auto zoom mode changed zoom level
7860 * "scroll - the content has been scrolled (moved)
7861 * "scroll,anim,start" - scrolling animation has started
7862 * "scroll,anim,stop" - scrolling animation has stopped
7863 * "scroll,drag,start" - dragging the contents around has started
7864 * "scroll,drag,stop" - dragging the contents around has stopped
7868 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
7870 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
7872 EAPI double elm_route_lon_min_get(Evas_Object *obj);
7873 EAPI double elm_route_lat_min_get(Evas_Object *obj);
7874 EAPI double elm_route_lon_max_get(Evas_Object *obj);
7875 EAPI double elm_route_lat_max_get(Evas_Object *obj);
7879 typedef enum _Elm_Panel_Orient
7881 ELM_PANEL_ORIENT_TOP,
7882 ELM_PANEL_ORIENT_BOTTOM,
7883 ELM_PANEL_ORIENT_LEFT,
7884 ELM_PANEL_ORIENT_RIGHT,
7887 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7888 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
7889 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7890 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7891 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7892 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7893 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
7894 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7895 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
7901 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
7902 * Add events (move, start ...)
7904 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7905 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7906 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7907 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7908 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7909 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7910 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7911 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7912 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
7913 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7914 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7917 * @defgroup Flip Flip
7919 * This widget holds 2 content objects(Evas_Object): one on the front and one
7920 * on the back. It allows you to flip from front to back and vice-versa using
7921 * various animations.
7923 * If either the front or back contents are not set the flip will treat that
7924 * as transparent. So if you wore to set the front content but not the back,
7925 * and then call elm_flip_go() you would see whatever is below the flip.
7927 * For a list of supported animations see elm_flip_go().
7929 * Signals that you can add callbacks for are:
7930 * "animate,begin" - when a flip animation was started
7931 * "animate,done" - when a flip animation is finished
7933 * @ref tutorial_flip show how to use most of the API.
7937 typedef enum _Elm_Flip_Mode
7939 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
7940 ELM_FLIP_ROTATE_X_CENTER_AXIS,
7941 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
7942 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
7944 ELM_FLIP_CUBE_RIGHT,
7948 ELM_FLIP_PAGE_RIGHT,
7952 typedef enum _Elm_Flip_Interaction
7954 ELM_FLIP_INTERACTION_NONE,
7955 ELM_FLIP_INTERACTION_ROTATE,
7956 ELM_FLIP_INTERACTION_CUBE,
7957 ELM_FLIP_INTERACTION_PAGE
7958 } Elm_Flip_Interaction;
7959 typedef enum _Elm_Flip_Direction
7961 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
7962 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
7963 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
7964 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
7965 } Elm_Flip_Direction;
7967 * @brief Add a new flip to the parent
7969 * @param parent The parent object
7970 * @return The new object or NULL if it cannot be created
7972 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7974 * @brief Set the front content of the flip widget.
7976 * @param obj The flip object
7977 * @param content The new front content object
7979 * Once the content object is set, a previously set one will be deleted.
7980 * If you want to keep that old content object, use the
7981 * elm_flip_content_front_unset() function.
7983 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7985 * @brief Set the back content of the flip widget.
7987 * @param obj The flip object
7988 * @param content The new back content object
7990 * Once the content object is set, a previously set one will be deleted.
7991 * If you want to keep that old content object, use the
7992 * elm_flip_content_back_unset() function.
7994 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7996 * @brief Get the front content used for the flip
7998 * @param obj The flip object
7999 * @return The front content object that is being used
8001 * Return the front content object which is set for this widget.
8003 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8005 * @brief Get the back content used for the flip
8007 * @param obj The flip object
8008 * @return The back content object that is being used
8010 * Return the back content object which is set for this widget.
8012 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8014 * @brief Unset the front content used for the flip
8016 * @param obj The flip object
8017 * @return The front content object that was being used
8019 * Unparent and return the front content object which was set for this widget.
8021 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8023 * @brief Unset the back content used for the flip
8025 * @param obj The flip object
8026 * @return The back content object that was being used
8028 * Unparent and return the back content object which was set for this widget.
8030 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8032 * @brief Get flip front visibility state
8034 * @param obj The flip objct
8035 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
8038 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8040 * @brief Set flip perspective
8042 * @param obj The flip object
8043 * @param foc The coordinate to set the focus on
8044 * @param x The X coordinate
8045 * @param y The Y coordinate
8047 * @warning This function currently does nothing.
8049 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
8051 * @brief Runs the flip animation
8053 * @param obj The flip object
8054 * @param mode The mode type
8056 * Flips the front and back contents using the @p mode animation. This
8057 * efectively hides the currently visible content and shows the hidden one.
8059 * There a number of possible animations to use for the flipping:
8060 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
8061 * around a horizontal axis in the middle of its height, the other content
8062 * is shown as the other side of the flip.
8063 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
8064 * around a vertical axis in the middle of its width, the other content is
8065 * shown as the other side of the flip.
8066 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
8067 * around a diagonal axis in the middle of its width, the other content is
8068 * shown as the other side of the flip.
8069 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
8070 * around a diagonal axis in the middle of its height, the other content is
8071 * shown as the other side of the flip.
8072 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
8073 * as if the flip was a cube, the other content is show as the right face of
8075 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
8076 * right as if the flip was a cube, the other content is show as the left
8078 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
8079 * flip was a cube, the other content is show as the bottom face of the cube.
8080 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
8081 * the flip was a cube, the other content is show as the upper face of the
8083 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
8084 * if the flip was a book, the other content is shown as the page below that.
8085 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
8086 * as if the flip was a book, the other content is shown as the page below
8088 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
8089 * flip was a book, the other content is shown as the page below that.
8090 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
8091 * flip was a book, the other content is shown as the page below that.
8093 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
8095 * @brief Set the interactive flip mode
8097 * @param obj The flip object
8098 * @param mode The interactive flip mode to use
8100 * This sets if the flip should be interactive (allow user to click and
8101 * drag a side of the flip to reveal the back page and cause it to flip).
8102 * By default a flip is not interactive. You may also need to set which
8103 * sides of the flip are "active" for flipping and how much space they use
8104 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
8105 * and elm_flip_interacton_direction_hitsize_set()
8107 * The four avilable mode of interaction are:
8108 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
8109 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
8110 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
8111 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
8113 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
8114 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
8115 * happen, those can only be acheived with elm_flip_go();
8117 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
8119 * @brief Get the interactive flip mode
8121 * @param obj The flip object
8122 * @return The interactive flip mode
8124 * Returns the interactive flip mode set by elm_flip_interaction_set()
8126 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
8128 * @brief Set which directions of the flip respond to interactive flip
8130 * @param obj The flip object
8131 * @param dir The direction to change
8132 * @param enabled If that direction is enabled or not
8134 * By default all directions are disabled, so you may want to enable the
8135 * desired directions for flipping if you need interactive flipping. You must
8136 * call this function once for each direction that should be enabled.
8138 * @see elm_flip_interaction_set()
8140 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
8142 * @brief Get the enabled state of that flip direction
8144 * @param obj The flip object
8145 * @param dir The direction to check
8146 * @return If that direction is enabled or not
8148 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
8150 * @see elm_flip_interaction_set()
8152 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
8154 * @brief Set the amount of the flip that is sensitive to interactive flip
8156 * @param obj The flip object
8157 * @param dir The direction to modify
8158 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
8160 * Set the amount of the flip that is sensitive to interactive flip, with 0
8161 * representing no area in the flip and 1 representing the entire flip. There
8162 * is however a consideration to be made in that the area will never be
8163 * smaller than the finger size set(as set in your Elementary configuration).
8165 * @see elm_flip_interaction_set()
8167 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
8169 * @brief Get the amount of the flip that is sensitive to interactive flip
8171 * @param obj The flip object
8172 * @param dir The direction to check
8173 * @return The size set for that direction
8175 * Returns the amount os sensitive area set by
8176 * elm_flip_interacton_direction_hitsize_set().
8178 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
8184 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8185 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8186 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8187 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8188 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8189 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8190 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8191 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8192 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8193 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8194 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8195 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8196 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8197 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8198 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8199 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8200 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8201 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8202 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8203 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8204 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8205 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8206 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8207 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8208 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8209 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8210 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8211 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8212 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8213 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8214 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8215 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8216 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8217 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8218 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8219 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);
8220 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8221 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8222 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);
8223 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8224 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);
8225 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
8226 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8227 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8228 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8229 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
8230 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8231 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8232 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8233 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);
8234 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);
8235 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);
8236 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);
8237 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);
8238 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);
8239 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8240 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8241 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8242 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8243 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8244 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
8245 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8248 * @defgroup Conformant Conformant
8249 * @ingroup Elementary
8251 * The aim is to provide a widget that can be used in elementary apps to
8252 * account for space taken up by the indicator, virtual keypad & softkey
8253 * windows when running the illume2 module of E17.
8255 * So conformant content will be sized and positioned considering the
8256 * space required for such stuff, and when they popup, as a keyboard
8257 * shows when an entry is selected, conformant content won't change.
8259 * Available styles for it:
8262 * See how to use this widget in this example:
8263 * @ref conformant_example
8267 * @addtogroup Conformant
8272 * Add a new conformant widget to the given parent Elementary
8273 * (container) object.
8275 * @param parent The parent object.
8276 * @return A new conformant widget handle or @c NULL, on errors.
8278 * This function inserts a new conformant widget on the canvas.
8280 * @ingroup Conformant
8282 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8285 * Set the content of the conformant widget.
8287 * @param obj The conformant object.
8288 * @param content The content to be displayed by the conformant.
8290 * Content will be sized and positioned considering the space required
8291 * to display a virtual keyboard. So it won't fill all the conformant
8292 * size. This way is possible to be sure that content won't resize
8293 * or be re-positioned after the keyboard is displayed.
8295 * Once the content object is set, a previously set one will be deleted.
8296 * If you want to keep that old content object, use the
8297 * elm_conformat_content_unset() function.
8299 * @see elm_conformant_content_unset()
8300 * @see elm_conformant_content_get()
8302 * @ingroup Conformant
8304 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8307 * Get the content of the conformant widget.
8309 * @param obj The conformant object.
8310 * @return The content that is being used.
8312 * Return the content object which is set for this widget.
8313 * It won't be unparent from conformant. For that, use
8314 * elm_conformant_content_unset().
8316 * @see elm_conformant_content_set() for more details.
8317 * @see elm_conformant_content_unset()
8319 * @ingroup Conformant
8321 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8324 * Unset the content of the conformant widget.
8326 * @param obj The conformant object.
8327 * @return The content that was being used.
8329 * Unparent and return the content object which was set for this widget.
8331 * @see elm_conformant_content_set() for more details.
8333 * @ingroup Conformant
8335 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8338 * Returns the Evas_Object that represents the content area.
8340 * @param obj The conformant object.
8341 * @return The content area of the widget.
8343 * @ingroup Conformant
8345 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8352 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8353 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8354 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8355 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8356 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
8357 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8358 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
8359 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8360 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
8361 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8364 * @defgroup Flipselector Flip Selector
8366 * A flip selector is a widget to show a set of @b text items, one
8367 * at a time, with the same sheet switching style as the @ref Clock
8368 * "clock" widget, when one changes the current displaying sheet
8369 * (thus, the "flip" in the name).
8371 * User clicks to flip sheets which are @b held for some time will
8372 * make the flip selector to flip continuosly and automatically for
8373 * the user. The interval between flips will keep growing in time,
8374 * so that it helps the user to reach an item which is distant from
8375 * the current selection.
8377 * Smart callbacks one can register to:
8378 * - @c "selected" - when the widget's selected text item is changed
8379 * - @c "overflowed" - when the widget's current selection is changed
8380 * from the first item in its list to the last
8381 * - @c "underflowed" - when the widget's current selection is changed
8382 * from the last item in its list to the first
8384 * Available styles for it:
8387 * Here is an example on its usage:
8388 * @li @ref flipselector_example
8392 * @addtogroup Flipselector
8396 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
8399 * Add a new flip selector widget to the given parent Elementary
8400 * (container) widget
8402 * @param parent The parent object
8403 * @return a new flip selector widget handle or @c NULL, on errors
8405 * This function inserts a new flip selector widget on the canvas.
8407 * @ingroup Flipselector
8409 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8412 * Programmatically select the next item of a flip selector widget
8414 * @param obj The flipselector object
8416 * @note The selection will be animated. Also, if it reaches the
8417 * end of its list of member items, it will continue with the first
8420 * @ingroup Flipselector
8422 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8425 * Programmatically select the previous item of a flip selector
8428 * @param obj The flipselector object
8430 * @note The selection will be animated. Also, if it reaches the
8431 * beginning of its list of member items, it will continue with the
8432 * last one backwards.
8434 * @ingroup Flipselector
8436 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8439 * Append a (text) item to a flip selector widget
8441 * @param obj The flipselector object
8442 * @param label The (text) label of the new item
8443 * @param func Convenience callback function to take place when
8445 * @param data Data passed to @p func, above
8446 * @return A handle to the item added or @c NULL, on errors
8448 * The widget's list of labels to show will be appended with the
8449 * given value. If the user wishes so, a callback function pointer
8450 * can be passed, which will get called when this same item is
8453 * @note The current selection @b won't be modified by appending an
8454 * element to the list.
8456 * @note The maximum length of the text label is going to be
8457 * determined <b>by the widget's theme</b>. Strings larger than
8458 * that value are going to be @b truncated.
8460 * @ingroup Flipselector
8462 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
8465 * Prepend a (text) item to a flip selector widget
8467 * @param obj The flipselector object
8468 * @param label The (text) label of the new item
8469 * @param func Convenience callback function to take place when
8471 * @param data Data passed to @p func, above
8472 * @return A handle to the item added or @c NULL, on errors
8474 * The widget's list of labels to show will be prepended with the
8475 * given value. If the user wishes so, a callback function pointer
8476 * can be passed, which will get called when this same item is
8479 * @note The current selection @b won't be modified by prepending
8480 * an element to the list.
8482 * @note The maximum length of the text label is going to be
8483 * determined <b>by the widget's theme</b>. Strings larger than
8484 * that value are going to be @b truncated.
8486 * @ingroup Flipselector
8488 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
8491 * Get the internal list of items in a given flip selector widget.
8493 * @param obj The flipselector object
8494 * @return The list of items (#Elm_Flipselector_Item as data) or @c
8497 * This list is @b not to be modified in any way and must not be
8498 * freed. Use the list members with functions like
8499 * elm_flipselector_item_label_set(),
8500 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
8501 * elm_flipselector_item_del(),
8502 * elm_flipselector_item_selected_get(),
8503 * elm_flipselector_item_selected_set().
8505 * @warning This list is only valid until @p obj object's internal
8506 * items list is changed. It should be fetched again with another
8507 * call to this function when changes happen.
8509 * @ingroup Flipselector
8511 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8514 * Get the first item in the given flip selector widget's list of
8517 * @param obj The flipselector object
8518 * @return The first item or @c NULL, if it has no items (and on
8521 * @see elm_flipselector_item_append()
8522 * @see elm_flipselector_last_item_get()
8524 * @ingroup Flipselector
8526 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8529 * Get the last item in the given flip selector widget's list of
8532 * @param obj The flipselector object
8533 * @return The last item or @c NULL, if it has no items (and on
8536 * @see elm_flipselector_item_prepend()
8537 * @see elm_flipselector_first_item_get()
8539 * @ingroup Flipselector
8541 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8544 * Get the currently selected item in a flip selector widget.
8546 * @param obj The flipselector object
8547 * @return The selected item or @c NULL, if the widget has no items
8550 * @ingroup Flipselector
8552 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8555 * Set whether a given flip selector widget's item should be the
8556 * currently selected one.
8558 * @param item The flip selector item
8559 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
8561 * This sets whether @p item is or not the selected (thus, under
8562 * display) one. If @p item is different than one under display,
8563 * the latter will be unselected. If the @p item is set to be
8564 * unselected, on the other hand, the @b first item in the widget's
8565 * internal members list will be the new selected one.
8567 * @see elm_flipselector_item_selected_get()
8569 * @ingroup Flipselector
8571 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8574 * Get whether a given flip selector widget's item is the currently
8577 * @param item The flip selector item
8578 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8581 * @see elm_flipselector_item_selected_set()
8583 * @ingroup Flipselector
8585 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
8588 * Delete a given item from a flip selector widget.
8590 * @param item The item to delete
8592 * @ingroup Flipselector
8594 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
8597 * Get the label of a given flip selector widget's item.
8599 * @param item The item to get label from
8600 * @return The text label of @p item or @c NULL, on errors
8602 * @see elm_flipselector_item_label_set()
8604 * @ingroup Flipselector
8606 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
8609 * Set the label of a given flip selector widget's item.
8611 * @param item The item to set label on
8612 * @param label The text label string, in UTF-8 encoding
8614 * @see elm_flipselector_item_label_get()
8616 * @ingroup Flipselector
8618 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
8621 * Gets the item before @p item in a flip selector widget's
8622 * internal list of items.
8624 * @param item The item to fetch previous from
8625 * @return The item before the @p item, in its parent's list. If
8626 * there is no previous item for @p item or there's an
8627 * error, @c NULL is returned.
8629 * @see elm_flipselector_item_next_get()
8631 * @ingroup Flipselector
8633 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
8636 * Gets the item after @p item in a flip selector widget's
8637 * internal list of items.
8639 * @param item The item to fetch next from
8640 * @return The item after the @p item, in its parent's list. If
8641 * there is no next item for @p item or there's an
8642 * error, @c NULL is returned.
8644 * @see elm_flipselector_item_next_get()
8646 * @ingroup Flipselector
8648 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
8651 * Set the interval on time updates for an user mouse button hold
8652 * on a flip selector widget.
8654 * @param obj The flip selector object
8655 * @param interval The (first) interval value in seconds
8657 * This interval value is @b decreased while the user holds the
8658 * mouse pointer either flipping up or flipping doww a given flip
8661 * This helps the user to get to a given item distant from the
8662 * current one easier/faster, as it will start to flip quicker and
8663 * quicker on mouse button holds.
8665 * The calculation for the next flip interval value, starting from
8666 * the one set with this call, is the previous interval divided by
8667 * 1.05, so it decreases a little bit.
8669 * The default starting interval value for automatic flips is
8672 * @see elm_flipselector_interval_get()
8674 * @ingroup Flipselector
8676 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
8679 * Get the interval on time updates for an user mouse button hold
8680 * on a flip selector widget.
8682 * @param obj The flip selector object
8683 * @return The (first) interval value, in seconds, set on it
8685 * @see elm_flipselector_interval_set() for more details
8687 * @ingroup Flipselector
8689 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8696 * @addtogroup Animator Animator
8697 * @ingroup Elementary
8699 * @brief Functions to ease creation of animations.
8701 * elm_animator is designed to provide an easy way to create animations.
8702 * Creating an animation with elm_animator is as simple as setting a
8703 * duration, an operating callback and telling it to run the animation.
8704 * However that is not the full extent of elm_animator's ability, animations
8705 * can be paused and resumed, reversed and the animation need not be linear.
8707 * To run an animation you must specify at least a duration and operation
8708 * callback, not setting any other properties will create a linear animation
8709 * that runs once and is not reversed.
8711 * @ref elm_animator_example_page_01 "This" example should make all of that
8714 * @warning elm_animator is @b not a widget.
8718 * @brief Type of curve desired for animation.
8720 * The speed in which an animation happens doesn't have to be linear, some
8721 * animations will look better if they're accelerating or decelerating, so
8722 * elm_animator provides four options in this regard:
8724 * @image html elm_animator_curve_style.png
8725 * @image latex elm_animator_curve_style.eps width=\textwidth
8726 * As can be seen in the image the speed of the animation will be:
8727 * @li ELM_ANIMATOR_CURVE_LINEAR constant
8728 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
8729 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
8730 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
8734 ELM_ANIMATOR_CURVE_LINEAR,
8735 ELM_ANIMATOR_CURVE_IN_OUT,
8736 ELM_ANIMATOR_CURVE_IN,
8737 ELM_ANIMATOR_CURVE_OUT
8738 } Elm_Animator_Curve_Style;
8739 typedef struct _Elm_Animator Elm_Animator;
8741 * Called back per loop of an elementary animators cycle
8742 * @param data user-data given to elm_animator_operation_callback_set()
8743 * @param animator the animator being run
8744 * @param double the position in the animation
8746 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
8748 * Called back when an elementary animator finishes
8749 * @param data user-data given to elm_animator_completion_callback_set()
8751 typedef void (*Elm_Animator_Completion_Cb) (void *data);
8754 * @brief Create a new animator.
8756 * @param[in] parent Parent object
8758 * The @a parent argument can be set to NULL for no parent. If a parent is set
8759 * there is no need to call elm_animator_del(), when the parent is deleted it
8760 * will delete the animator.
8761 * @deprecated Use @ref Transit instead.
8763 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
8765 * Deletes the animator freeing any resources it used. If the animator was
8766 * created with a NULL parent this must be called, otherwise it will be
8767 * automatically called when the parent is deleted.
8769 * @param[in] animator Animator object
8770 * @deprecated Use @ref Transit instead.
8772 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
8774 * Set the duration of the animation.
8776 * @param[in] animator Animator object
8777 * @param[in] duration Duration in second
8778 * @deprecated Use @ref Transit instead.
8780 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
8782 * @brief Set the callback function for animator operation.
8784 * @param[in] animator Animator object
8785 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
8786 * @param[in] data Callback function user argument
8788 * The @p func callback will be called with a frame value in range [0, 1] which
8789 * indicates how far along the animation should be. It is the job of @p func to
8790 * actually change the state of any object(or objects) that are being animated.
8791 * @deprecated Use @ref Transit instead.
8793 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
8795 * Set the callback function for the when the animation ends.
8797 * @param[in] animator Animator object
8798 * @param[in] func Callback function pointe
8799 * @param[in] data Callback function user argument
8801 * @warning @a func will not be executed if elm_animator_stop() is called.
8802 * @deprecated Use @ref Transit instead.
8804 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
8806 * @brief Stop animator.
8808 * @param[in] animator Animator object
8810 * If called before elm_animator_animate() it does nothing. If there is an
8811 * animation in progress the animation will be stopped(the operation callback
8812 * will not be executed again) and it can't be restarted using
8813 * elm_animator_resume().
8814 * @deprecated Use @ref Transit instead.
8816 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
8818 * Set the animator repeat count.
8820 * @param[in] animator Animator object
8821 * @param[in] repeat_cnt Repeat count
8822 * @deprecated Use @ref Transit instead.
8824 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
8826 * @brief Start animation.
8828 * @param[in] animator Animator object
8830 * This function starts the animation if the nescessary properties(duration
8831 * and operation callback) have been set. Once started the animation will
8832 * run until complete or elm_animator_stop() is called.
8833 * @deprecated Use @ref Transit instead.
8835 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
8837 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
8839 * @param[in] animator Animator object
8840 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
8841 * @deprecated Use @ref Transit instead.
8843 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
8845 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
8847 * @param[in] animator Animator object
8848 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
8849 * @deprecated Use @ref Transit instead.
8851 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
8853 * @brief Sets wether the animation should be automatically reversed.
8855 * @param[in] animator Animator object
8856 * @param[in] reverse Reverse or not
8858 * This controls wether the animation will be run on reverse imediately after
8859 * running forward. When this is set together with repetition the animation
8860 * will run in reverse once for each time it ran forward.@n
8861 * Runnin an animation in reverse is accomplished by calling the operation
8862 * callback with a frame value starting at 1 and diminshing until 0.
8863 * @deprecated Use @ref Transit instead.
8865 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
8867 * Gets wether the animation will automatically reversed
8869 * @param[in] animator Animator object
8870 * @deprecated Use @ref Transit instead.
8872 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
8874 * Gets the status for the animator operation. The status of the animator @b
8875 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
8876 * only informs if the animation was started and has not ended(either normally
8877 * or through elm_animator_stop()).
8879 * @param[in] animator Animator object
8880 * @deprecated Use @ref Transit instead.
8882 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
8884 * Gets how many times the animation will be repeated
8886 * @param[in] animator Animator object
8887 * @deprecated Use @ref Transit instead.
8889 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
8891 * Pause the animator.
8893 * @param[in] animator Animator object
8895 * This causes the animation to be temporarily stopped(the operation callback
8896 * will not be called). If the animation is not yet running this is a no-op.
8897 * Once an animation has been paused with this function it can be resumed
8898 * using elm_animator_resume().
8899 * @deprecated Use @ref Transit instead.
8901 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
8903 * @brief Resumes the animator.
8905 * @param[in] animator Animator object
8907 * Resumes an animation that was paused using elm_animator_pause(), after
8908 * calling this function calls to the operation callback will happen
8909 * normally. If an animation is stopped by means of elm_animator_stop it
8910 * @b can't be restarted with this function.@n
8912 * @warning When an animation is resumed it doesn't start from where it was paused, it
8913 * will go to where it would have been if it had not been paused. If an
8914 * animation with a duration of 3 seconds is paused after 1 second for 1 second
8915 * it will resume as if it had ben animating for 2 seconds, the operating
8916 * callback will be called with a frame value of aproximately 2/3.
8917 * @deprecated Use @ref Transit instead.
8919 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
8925 * @defgroup Calendar Calendar
8926 * @ingroup Elementary
8928 * A calendar is a widget that displays a regular calendar, one
8929 * month at a time, to the user, and can allows the user to select a date.
8931 * It has support to adding check marks (holidays and checks are supported
8932 * by default theme).
8934 * Weekday names and the function used to format month and year to
8935 * be displayed can be set, giving more flexibility to this widget.
8937 * Smart callbacks one can register to:
8938 * - "changed" - emitted when the user selects a day or changes the
8939 * displayed month, what actually changes the selected day as well.
8941 * Available styles for it:
8945 * @li @ref calendar_example_01
8946 * @li @ref calendar_example_02
8947 * @li @ref calendar_example_03
8948 * @li @ref calendar_example_04
8949 * @li @ref calendar_example_05
8950 * @li @ref calendar_example_06
8954 * @addtogroup Calendar
8959 * Event periodicity, used to define if a mark should be repeated
8960 * @b beyond event's day. It's set when a mark is added.
8962 * So, for a mark added to 13th May with periodicity set to WEEKLY,
8963 * there will be marks every week after this date. Marks will be displayed
8964 * at 13th, 20th, 27th, 3rd June ...
8966 * Values don't work as bitmaks, only one can be choosen.
8968 * @see elm_calendar_mark_add()
8972 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
8973 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
8974 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
8975 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*/
8976 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. */
8977 } Elm_Calendar_Mark_Repeat;
8979 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(). */
8982 * Add a new calendar widget to the given parent Elementary
8983 * (container) object.
8985 * @param parent The parent object.
8986 * @return a new calendar widget handle or @c NULL, on errors.
8988 * This function inserts a new calendar widget on the canvas.
8990 * @ref calendar_example_01
8994 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8997 * Get weekdays names displayed by the calendar.
8999 * @param obj The calendar object.
9000 * @return Array of seven strings to be used as weekday names.
9002 * By default, weekdays abbreviations get from system are displayed:
9003 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
9004 * The first string is related to Sunday, the second to Monday...
9006 * @see elm_calendar_weekdays_name_set()
9008 * @ref calendar_example_05
9012 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9015 * Set weekdays names to be displayed by the calendar.
9017 * @param obj The calendar object.
9018 * @param weedays Array of seven strings to be used as weekday names.
9019 * @warning It must have 7 elements, or it will access invalid memory.
9020 * @warning The strings must be NULL terminated ('@\0').
9022 * By default, weekdays abbreviations get from system are displayed:
9023 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
9025 * The first string should be related to Sunday, the second to Monday...
9027 * The usage should be like this:
9029 * const char *weekdays[] =
9031 * "Sunday", "Monday", "Tuesday", "Wednesday",
9032 * "Thursday", "Friday", "Saturday"
9034 * elm_calendar_weekdays_names_set(calendar, weekdays);
9037 * @see elm_calendar_weekdays_name_get()
9039 * @ref calendar_example_02
9043 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
9046 * Set the minimum and maximum values for the year
9048 * @param obj The calendar object
9049 * @param min The minimum year, greater than 1901;
9050 * @param max The maximum year;
9052 * Maximum must be greater than minimum, except if you don't wan't to set
9054 * Default values are 1902 and -1.
9056 * If the maximum year is a negative value, it will be limited depending
9057 * on the platform architecture (year 2037 for 32 bits);
9059 * @see elm_calendar_min_max_year_get()
9061 * @ref calendar_example_03
9065 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
9068 * Get the minimum and maximum values for the year
9070 * @param obj The calendar object.
9071 * @param min The minimum year.
9072 * @param max The maximum year.
9074 * Default values are 1902 and -1.
9076 * @see elm_calendar_min_max_year_get() for more details.
9078 * @ref calendar_example_05
9082 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
9085 * Enable or disable day selection
9087 * @param obj The calendar object.
9088 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
9091 * Enabled by default. If disabled, the user still can select months,
9092 * but not days. Selected days are highlighted on calendar.
9093 * It should be used if you won't need such selection for the widget usage.
9095 * When a day is selected, or month is changed, smart callbacks for
9096 * signal "changed" will be called.
9098 * @see elm_calendar_day_selection_enable_get()
9100 * @ref calendar_example_04
9104 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
9107 * Get a value whether day selection is enabled or not.
9109 * @see elm_calendar_day_selection_enable_set() for details.
9111 * @param obj The calendar object.
9112 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
9113 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
9115 * @ref calendar_example_05
9119 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9123 * Set selected date to be highlighted on calendar.
9125 * @param obj The calendar object.
9126 * @param selected_time A @b tm struct to represent the selected date.
9128 * Set the selected date, changing the displayed month if needed.
9129 * Selected date changes when the user goes to next/previous month or
9130 * select a day pressing over it on calendar.
9132 * @see elm_calendar_selected_time_get()
9134 * @ref calendar_example_04
9138 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
9141 * Get selected date.
9143 * @param obj The calendar object
9144 * @param selected_time A @b tm struct to point to selected date
9145 * @return EINA_FALSE means an error ocurred and returned time shouldn't
9148 * Get date selected by the user or set by function
9149 * elm_calendar_selected_time_set().
9150 * Selected date changes when the user goes to next/previous month or
9151 * select a day pressing over it on calendar.
9153 * @see elm_calendar_selected_time_get()
9155 * @ref calendar_example_05
9159 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
9162 * Set a function to format the string that will be used to display
9165 * @param obj The calendar object
9166 * @param format_function Function to set the month-year string given
9169 * By default it uses strftime with "%B %Y" format string.
9170 * It should allocate the memory that will be used by the string,
9171 * that will be freed by the widget after usage.
9172 * A pointer to the string and a pointer to the time struct will be provided.
9177 * _format_month_year(struct tm *selected_time)
9180 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
9181 * return strdup(buf);
9184 * elm_calendar_format_function_set(calendar, _format_month_year);
9187 * @ref calendar_example_02
9191 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
9194 * Add a new mark to the calendar
9196 * @param obj The calendar object
9197 * @param mark_type A string used to define the type of mark. It will be
9198 * emitted to the theme, that should display a related modification on these
9199 * days representation.
9200 * @param mark_time A time struct to represent the date of inclusion of the
9201 * mark. For marks that repeats it will just be displayed after the inclusion
9202 * date in the calendar.
9203 * @param repeat Repeat the event following this periodicity. Can be a unique
9204 * mark (that don't repeat), daily, weekly, monthly or annually.
9205 * @return The created mark or @NULL upon failure.
9207 * Add a mark that will be drawn in the calendar respecting the insertion
9208 * time and periodicity. It will emit the type as signal to the widget theme.
9209 * Default theme supports "holiday" and "checked", but it can be extended.
9211 * It won't immediately update the calendar, drawing the marks.
9212 * For this, call elm_calendar_marks_draw(). However, when user selects
9213 * next or previous month calendar forces marks drawn.
9215 * Marks created with this method can be deleted with
9216 * elm_calendar_mark_del().
9220 * struct tm selected_time;
9221 * time_t current_time;
9223 * current_time = time(NULL) + 5 * 84600;
9224 * localtime_r(¤t_time, &selected_time);
9225 * elm_calendar_mark_add(cal, "holiday", selected_time,
9226 * ELM_CALENDAR_ANNUALLY);
9228 * current_time = time(NULL) + 1 * 84600;
9229 * localtime_r(¤t_time, &selected_time);
9230 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
9232 * elm_calendar_marks_draw(cal);
9235 * @see elm_calendar_marks_draw()
9236 * @see elm_calendar_mark_del()
9238 * @ref calendar_example_06
9242 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);
9245 * Delete mark from the calendar.
9247 * @param mark The mark to be deleted.
9249 * If deleting all calendar marks is required, elm_calendar_marks_clear()
9250 * should be used instead of getting marks list and deleting each one.
9252 * @see elm_calendar_mark_add()
9254 * @ref calendar_example_06
9258 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
9261 * Remove all calendar's marks
9263 * @param obj The calendar object.
9265 * @see elm_calendar_mark_add()
9266 * @see elm_calendar_mark_del()
9270 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9274 * Get a list of all the calendar marks.
9276 * @param obj The calendar object.
9277 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
9279 * @see elm_calendar_mark_add()
9280 * @see elm_calendar_mark_del()
9281 * @see elm_calendar_marks_clear()
9285 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9288 * Draw calendar marks.
9290 * @param obj The calendar object.
9292 * Should be used after adding, removing or clearing marks.
9293 * It will go through the entire marks list updating the calendar.
9294 * If lots of marks will be added, add all the marks and then call
9297 * When the month is changed, i.e. user selects next or previous month,
9298 * marks will be drawed.
9300 * @see elm_calendar_mark_add()
9301 * @see elm_calendar_mark_del()
9302 * @see elm_calendar_marks_clear()
9304 * @ref calendar_example_06
9308 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
9311 * Set a day text color to the same that represents Saturdays.
9313 * @param obj The calendar object.
9314 * @param pos The text position. Position is the cell counter, from left
9315 * to right, up to down. It starts on 0 and ends on 41.
9317 * @deprecated use elm_calendar_mark_add() instead like:
9320 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
9321 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
9324 * @see elm_calendar_mark_add()
9328 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9331 * Set a day text color to the same that represents Sundays.
9333 * @param obj The calendar object.
9334 * @param pos The text position. Position is the cell counter, from left
9335 * to right, up to down. It starts on 0 and ends on 41.
9337 * @deprecated use elm_calendar_mark_add() instead like:
9340 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
9341 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
9344 * @see elm_calendar_mark_add()
9348 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9351 * Set a day text color to the same that represents Weekdays.
9353 * @param obj The calendar object
9354 * @param pos The text position. Position is the cell counter, from left
9355 * to right, up to down. It starts on 0 and ends on 41.
9357 * @deprecated use elm_calendar_mark_add() instead like:
9360 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
9362 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
9363 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
9364 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
9365 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
9366 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
9367 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
9368 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
9369 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
9370 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
9373 * @see elm_calendar_mark_add()
9377 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9380 * Set the interval on time updates for an user mouse button hold
9381 * on calendar widgets' month selection.
9383 * @param obj The calendar object
9384 * @param interval The (first) interval value in seconds
9386 * This interval value is @b decreased while the user holds the
9387 * mouse pointer either selecting next or previous month.
9389 * This helps the user to get to a given month distant from the
9390 * current one easier/faster, as it will start to change quicker and
9391 * quicker on mouse button holds.
9393 * The calculation for the next change interval value, starting from
9394 * the one set with this call, is the previous interval divided by
9395 * 1.05, so it decreases a little bit.
9397 * The default starting interval value for automatic changes is
9400 * @see elm_calendar_interval_get()
9404 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9407 * Get the interval on time updates for an user mouse button hold
9408 * on calendar widgets' month selection.
9410 * @param obj The calendar object
9411 * @return The (first) interval value, in seconds, set on it
9413 * @see elm_calendar_interval_set() for more details
9417 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9424 * @defgroup Diskselector Diskselector
9425 * @ingroup Elementary
9427 * A diskselector is a kind of list widget. It scrolls horizontally,
9428 * and can contain label and icon objects. Three items are displayed
9429 * with the selected one in the middle.
9431 * It can act like a circular list with round mode and labels can be
9432 * reduced for a defined length for side items.
9434 * Smart callbacks one can listen to:
9435 * - "selected" - when item is selected, i.e. scroller stops.
9437 * Available styles for it:
9441 * @li @ref diskselector_example_01
9442 * @li @ref diskselector_example_02
9446 * @addtogroup Diskselector
9450 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(). */
9453 * Add a new diskselector widget to the given parent Elementary
9454 * (container) object.
9456 * @param parent The parent object.
9457 * @return a new diskselector widget handle or @c NULL, on errors.
9459 * This function inserts a new diskselector widget on the canvas.
9461 * @ingroup Diskselector
9463 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9466 * Enable or disable round mode.
9468 * @param obj The diskselector object.
9469 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
9472 * Disabled by default. If round mode is enabled the items list will
9473 * work like a circle list, so when the user reaches the last item,
9474 * the first one will popup.
9476 * @see elm_diskselector_round_get()
9478 * @ingroup Diskselector
9480 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
9483 * Get a value whether round mode is enabled or not.
9485 * @see elm_diskselector_round_set() for details.
9487 * @param obj The diskselector object.
9488 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
9489 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
9491 * @ingroup Diskselector
9493 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9496 * Get the side labels max length.
9498 * @deprecated use elm_diskselector_side_label_length_get() instead:
9500 * @param obj The diskselector object.
9501 * @return The max length defined for side labels, or 0 if not a valid
9504 * @ingroup Diskselector
9506 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9509 * Set the side labels max length.
9511 * @deprecated use elm_diskselector_side_label_length_set() instead:
9513 * @param obj The diskselector object.
9514 * @param len The max length defined for side labels.
9516 * @ingroup Diskselector
9518 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
9521 * Get the side labels max length.
9523 * @see elm_diskselector_side_label_length_set() for details.
9525 * @param obj The diskselector object.
9526 * @return The max length defined for side labels, or 0 if not a valid
9529 * @ingroup Diskselector
9531 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9534 * Set the side labels max length.
9536 * @param obj The diskselector object.
9537 * @param len The max length defined for side labels.
9539 * Length is the number of characters of items' label that will be
9540 * visible when it's set on side positions. It will just crop
9541 * the string after defined size. E.g.:
9543 * An item with label "January" would be displayed on side position as
9544 * "Jan" if max length is set to 3, or "Janu", if this property
9547 * When it's selected, the entire label will be displayed, except for
9548 * width restrictions. In this case label will be cropped and "..."
9549 * will be concatenated.
9551 * Default side label max length is 3.
9553 * This property will be applyed over all items, included before or
9554 * later this function call.
9556 * @ingroup Diskselector
9558 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
9561 * Set the number of items to be displayed.
9563 * @param obj The diskselector object.
9564 * @param num The number of items the diskselector will display.
9566 * Default value is 3, and also it's the minimun. If @p num is less
9567 * than 3, it will be set to 3.
9569 * Also, it can be set on theme, using data item @c display_item_num
9570 * on group "elm/diskselector/item/X", where X is style set.
9573 * group { name: "elm/diskselector/item/X";
9575 * item: "display_item_num" "5";
9578 * @ingroup Diskselector
9580 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
9583 * Set bouncing behaviour when the scrolled content reaches an edge.
9585 * Tell the internal scroller object whether it should bounce or not
9586 * when it reaches the respective edges for each axis.
9588 * @param obj The anchorview object.
9589 * @param h_bounce Whether to bounce or not in the horizontal axis.
9590 * @param v_bounce Whether to bounce or not in the vertical axis.
9592 * @see elm_scroller_bounce_set()
9594 * @ingroup Diskselector
9596 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9599 * Get the bouncing behaviour of the internal scroller.
9601 * Get whether the internal scroller should bounce when the edge of each
9602 * axis is reached scrolling.
9604 * @param obj The anchorview object.
9605 * @param h_bounce Pointer where to store the bounce state of the horizontal
9607 * @param v_bounce Pointer where to store the bounce state of the vertical
9610 * @see elm_scroller_bounce_get()
9611 * @see elm_diskselector_bounce_set()
9613 * @ingroup Diskselector
9615 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9618 * Get the scrollbar policy.
9620 * @see elm_diskselector_scroller_policy_get() for details.
9622 * @param obj The diskselector object.
9623 * @param policy_h Pointer where to store horizontal scrollbar policy.
9624 * @param policy_v Pointer where to store vertical scrollbar policy.
9626 * @ingroup Diskselector
9628 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);
9631 * Set the scrollbar policy.
9633 * @param obj The diskselector object.
9634 * @param policy_h Horizontal scrollbar policy.
9635 * @param policy_v Vertical scrollbar policy.
9637 * This sets the scrollbar visibility policy for the given scroller.
9638 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
9639 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
9640 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
9641 * This applies respectively for the horizontal and vertical scrollbars.
9643 * The both are disabled by default, i.e., are set to
9644 * #ELM_SCROLLER_POLICY_OFF.
9646 * @ingroup Diskselector
9648 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
9651 * Remove all diskselector's items.
9653 * @param obj The diskselector object.
9655 * @see elm_diskselector_item_del()
9656 * @see elm_diskselector_item_append()
9658 * @ingroup Diskselector
9660 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9663 * Get a list of all the diskselector items.
9665 * @param obj The diskselector object.
9666 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
9667 * or @c NULL on failure.
9669 * @see elm_diskselector_item_append()
9670 * @see elm_diskselector_item_del()
9671 * @see elm_diskselector_clear()
9673 * @ingroup Diskselector
9675 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9678 * Appends a new item to the diskselector object.
9680 * @param obj The diskselector object.
9681 * @param label The label of the diskselector item.
9682 * @param icon The icon object to use at left side of the item. An
9683 * icon can be any Evas object, but usually it is an icon created
9684 * with elm_icon_add().
9685 * @param func The function to call when the item is selected.
9686 * @param data The data to associate with the item for related callbacks.
9688 * @return The created item or @c NULL upon failure.
9690 * A new item will be created and appended to the diskselector, i.e., will
9691 * be set as last item. Also, if there is no selected item, it will
9692 * be selected. This will always happens for the first appended item.
9694 * If no icon is set, label will be centered on item position, otherwise
9695 * the icon will be placed at left of the label, that will be shifted
9698 * Items created with this method can be deleted with
9699 * elm_diskselector_item_del().
9701 * Associated @p data can be properly freed when item is deleted if a
9702 * callback function is set with elm_diskselector_item_del_cb_set().
9704 * If a function is passed as argument, it will be called everytime this item
9705 * is selected, i.e., the user stops the diskselector with this
9706 * item on center position. If such function isn't needed, just passing
9707 * @c NULL as @p func is enough. The same should be done for @p data.
9709 * Simple example (with no function callback or data associated):
9711 * disk = elm_diskselector_add(win);
9712 * ic = elm_icon_add(win);
9713 * elm_icon_file_set(ic, "path/to/image", NULL);
9714 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
9715 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
9718 * @see elm_diskselector_item_del()
9719 * @see elm_diskselector_item_del_cb_set()
9720 * @see elm_diskselector_clear()
9721 * @see elm_icon_add()
9723 * @ingroup Diskselector
9725 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);
9729 * Delete them item from the diskselector.
9731 * @param it The item of diskselector to be deleted.
9733 * If deleting all diskselector items is required, elm_diskselector_clear()
9734 * should be used instead of getting items list and deleting each one.
9736 * @see elm_diskselector_clear()
9737 * @see elm_diskselector_item_append()
9738 * @see elm_diskselector_item_del_cb_set()
9740 * @ingroup Diskselector
9742 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9745 * Set the function called when a diskselector item is freed.
9747 * @param it The item to set the callback on
9748 * @param func The function called
9750 * If there is a @p func, then it will be called prior item's memory release.
9751 * That will be called with the following arguments:
9753 * @li item's Evas object;
9756 * This way, a data associated to a diskselector item could be properly
9759 * @ingroup Diskselector
9761 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9764 * Get the data associated to the item.
9766 * @param it The diskselector item
9767 * @return The data associated to @p it
9769 * The return value is a pointer to data associated to @item when it was
9770 * created, with function elm_diskselector_item_append(). If no data
9771 * was passed as argument, it will return @c NULL.
9773 * @see elm_diskselector_item_append()
9775 * @ingroup Diskselector
9777 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9780 * Set the icon associated to the item.
9782 * @param it The diskselector item
9783 * @param icon The icon object to associate with @p it
9785 * The icon object to use at left side of the item. An
9786 * icon can be any Evas object, but usually it is an icon created
9787 * with elm_icon_add().
9789 * Once the icon object is set, a previously set one will be deleted.
9790 * You probably don't want, then, to have the @b same icon object set
9791 * for more than one item of the diskselector.
9793 * If an icon was passed as argument on item creation, with function
9794 * elm_diskselector_item_append(), it will be already
9795 * associated to the item.
9797 * @see elm_diskselector_item_append()
9798 * @see elm_diskselector_item_icon_get()
9800 * @ingroup Diskselector
9802 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
9805 * Get the icon associated to the item.
9807 * @param it The diskselector item
9808 * @return The icon associated to @p it
9810 * The return value is a pointer to the icon associated to @item when it was
9811 * created, with function elm_diskselector_item_append(), or later
9812 * with function elm_diskselector_item_icon_set. If no icon
9813 * was passed as argument, it will return @c NULL.
9815 * @see elm_diskselector_item_append()
9816 * @see elm_diskselector_item_icon_set()
9818 * @ingroup Diskselector
9820 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9824 * Set the label of item.
9826 * @param it The item of diskselector.
9827 * @param label The label of item.
9829 * The label to be displayed by the item.
9831 * If no icon is set, label will be centered on item position, otherwise
9832 * the icon will be placed at left of the label, that will be shifted
9835 * An item with label "January" would be displayed on side position as
9836 * "Jan" if max length is set to 3 with function
9837 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
9840 * When this @item is selected, the entire label will be displayed,
9841 * except for width restrictions.
9842 * In this case label will be cropped and "..." will be concatenated,
9843 * but only for display purposes. It will keep the entire string, so
9844 * if diskselector is resized the remaining characters will be displayed.
9846 * If a label was passed as argument on item creation, with function
9847 * elm_diskselector_item_append(), it will be already
9848 * displayed by the item.
9850 * @see elm_diskselector_side_label_lenght_set()
9851 * @see elm_diskselector_item_label_get()
9852 * @see elm_diskselector_item_append()
9854 * @ingroup Diskselector
9856 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
9859 * Get the label of item.
9861 * @param it The item of diskselector.
9862 * @return The label of item.
9864 * The return value is a pointer to the label associated to @item when it was
9865 * created, with function elm_diskselector_item_append(), or later
9866 * with function elm_diskselector_item_label_set. If no label
9867 * was passed as argument, it will return @c NULL.
9869 * @see elm_diskselector_item_label_set() for more details.
9870 * @see elm_diskselector_item_append()
9872 * @ingroup Diskselector
9874 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9877 * Get the selected item.
9879 * @param obj The diskselector object.
9880 * @return The selected diskselector item.
9882 * The selected item can be unselected with function
9883 * elm_diskselector_item_selected_set(), and the first item of
9884 * diskselector will be selected.
9886 * The selected item always will be centered on diskselector, with
9887 * full label displayed, i.e., max lenght set to side labels won't
9888 * apply on the selected item. More details on
9889 * elm_diskselector_side_label_length_set().
9891 * @ingroup Diskselector
9893 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9896 * Set the selected state of an item.
9898 * @param it The diskselector item
9899 * @param selected The selected state
9901 * This sets the selected state of the given item @p it.
9902 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
9904 * If a new item is selected the previosly selected will be unselected.
9905 * Previoulsy selected item can be get with function
9906 * elm_diskselector_selected_item_get().
9908 * If the item @p it is unselected, the first item of diskselector will
9911 * Selected items will be visible on center position of diskselector.
9912 * So if it was on another position before selected, or was invisible,
9913 * diskselector will animate items until the selected item reaches center
9916 * @see elm_diskselector_item_selected_get()
9917 * @see elm_diskselector_selected_item_get()
9919 * @ingroup Diskselector
9921 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9924 * Get whether the @p item is selected or not.
9926 * @param it The diskselector item.
9927 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
9928 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
9930 * @see elm_diskselector_selected_item_set() for details.
9931 * @see elm_diskselector_item_selected_get()
9933 * @ingroup Diskselector
9935 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9938 * Get the first item of the diskselector.
9940 * @param obj The diskselector object.
9941 * @return The first item, or @c NULL if none.
9943 * The list of items follows append order. So it will return the first
9944 * item appended to the widget that wasn't deleted.
9946 * @see elm_diskselector_item_append()
9947 * @see elm_diskselector_items_get()
9949 * @ingroup Diskselector
9951 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9954 * Get the last item of the diskselector.
9956 * @param obj The diskselector object.
9957 * @return The last item, or @c NULL if none.
9959 * The list of items follows append order. So it will return last first
9960 * item appended to the widget that wasn't deleted.
9962 * @see elm_diskselector_item_append()
9963 * @see elm_diskselector_items_get()
9965 * @ingroup Diskselector
9967 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9970 * Get the item before @p item in diskselector.
9972 * @param it The diskselector item.
9973 * @return The item before @p item, or @c NULL if none or on failure.
9975 * The list of items follows append order. So it will return item appended
9976 * just before @item and that wasn't deleted.
9978 * If it is the first item, @c NULL will be returned.
9979 * First item can be get by elm_diskselector_first_item_get().
9981 * @see elm_diskselector_item_append()
9982 * @see elm_diskselector_items_get()
9984 * @ingroup Diskselector
9986 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9989 * Get the item after @p item in diskselector.
9991 * @param it The diskselector item.
9992 * @return The item after @p item, or @c NULL if none or on failure.
9994 * The list of items follows append order. So it will return item appended
9995 * just after @item and that wasn't deleted.
9997 * If it is the last item, @c NULL will be returned.
9998 * Last item can be get by elm_diskselector_last_item_get().
10000 * @see elm_diskselector_item_append()
10001 * @see elm_diskselector_items_get()
10003 * @ingroup Diskselector
10005 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10008 * Set the text to be shown in the diskselector item.
10010 * @param item Target item
10011 * @param text The text to set in the content
10013 * Setup the text as tooltip to object. The item can have only one tooltip,
10014 * so any previous tooltip data is removed.
10016 * @see elm_object_tooltip_text_set() for more details.
10018 * @ingroup Diskselector
10020 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
10023 * Set the content to be shown in the tooltip item.
10025 * Setup the tooltip to item. The item can have only one tooltip,
10026 * so any previous tooltip data is removed. @p func(with @p data) will
10027 * be called every time that need show the tooltip and it should
10028 * return a valid Evas_Object. This object is then managed fully by
10029 * tooltip system and is deleted when the tooltip is gone.
10031 * @param item the diskselector item being attached a tooltip.
10032 * @param func the function used to create the tooltip contents.
10033 * @param data what to provide to @a func as callback data/context.
10034 * @param del_cb called when data is not needed anymore, either when
10035 * another callback replaces @func, the tooltip is unset with
10036 * elm_diskselector_item_tooltip_unset() or the owner @a item
10037 * dies. This callback receives as the first parameter the
10038 * given @a data, and @c event_info is the item.
10040 * @see elm_object_tooltip_content_cb_set() for more details.
10042 * @ingroup Diskselector
10044 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);
10047 * Unset tooltip from item.
10049 * @param item diskselector item to remove previously set tooltip.
10051 * Remove tooltip from item. The callback provided as del_cb to
10052 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
10053 * it is not used anymore.
10055 * @see elm_object_tooltip_unset() for more details.
10056 * @see elm_diskselector_item_tooltip_content_cb_set()
10058 * @ingroup Diskselector
10060 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10064 * Sets a different style for this item tooltip.
10066 * @note before you set a style you should define a tooltip with
10067 * elm_diskselector_item_tooltip_content_cb_set() or
10068 * elm_diskselector_item_tooltip_text_set()
10070 * @param item diskselector item with tooltip already set.
10071 * @param style the theme style to use (default, transparent, ...)
10073 * @see elm_object_tooltip_style_set() for more details.
10075 * @ingroup Diskselector
10077 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
10080 * Get the style for this item tooltip.
10082 * @param item diskselector item with tooltip already set.
10083 * @return style the theme style in use, defaults to "default". If the
10084 * object does not have a tooltip set, then NULL is returned.
10086 * @see elm_object_tooltip_style_get() for more details.
10087 * @see elm_diskselector_item_tooltip_style_set()
10089 * @ingroup Diskselector
10091 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10094 * Set the cursor to be shown when mouse is over the diskselector item
10096 * @param item Target item
10097 * @param cursor the cursor name to be used.
10099 * @see elm_object_cursor_set() for more details.
10101 * @ingroup Diskselector
10103 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10106 * Get the cursor to be shown when mouse is over the diskselector item
10108 * @param item diskselector item with cursor already set.
10109 * @return the cursor name.
10111 * @see elm_object_cursor_get() for more details.
10112 * @see elm_diskselector_cursor_set()
10114 * @ingroup Diskselector
10116 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10120 * Unset the cursor to be shown when mouse is over the diskselector item
10122 * @param item Target item
10124 * @see elm_object_cursor_unset() for more details.
10125 * @see elm_diskselector_cursor_set()
10127 * @ingroup Diskselector
10129 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10132 * Sets a different style for this item cursor.
10134 * @note before you set a style you should define a cursor with
10135 * elm_diskselector_item_cursor_set()
10137 * @param item diskselector item with cursor already set.
10138 * @param style the theme style to use (default, transparent, ...)
10140 * @see elm_object_cursor_style_set() for more details.
10142 * @ingroup Diskselector
10144 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
10148 * Get the style for this item cursor.
10150 * @param item diskselector item with cursor already set.
10151 * @return style the theme style in use, defaults to "default". If the
10152 * object does not have a cursor set, then @c NULL is returned.
10154 * @see elm_object_cursor_style_get() for more details.
10155 * @see elm_diskselector_item_cursor_style_set()
10157 * @ingroup Diskselector
10159 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10163 * Set if the cursor set should be searched on the theme or should use
10164 * the provided by the engine, only.
10166 * @note before you set if should look on theme you should define a cursor
10167 * with elm_diskselector_item_cursor_set().
10168 * By default it will only look for cursors provided by the engine.
10170 * @param item widget item with cursor already set.
10171 * @param engine_only boolean to define if cursors set with
10172 * elm_diskselector_item_cursor_set() should be searched only
10173 * between cursors provided by the engine or searched on widget's
10176 * @see elm_object_cursor_engine_only_set() for more details.
10178 * @ingroup Diskselector
10180 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10183 * Get the cursor engine only usage for this item cursor.
10185 * @param item widget item with cursor already set.
10186 * @return engine_only boolean to define it cursors should be looked only
10187 * between the provided by the engine or searched on widget's theme as well.
10188 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
10190 * @see elm_object_cursor_engine_only_get() for more details.
10191 * @see elm_diskselector_item_cursor_engine_only_set()
10193 * @ingroup Diskselector
10195 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
10202 * @page tutorial_colorselector Color selector example
10203 * @dontinclude colorselector_example_01.c
10205 * This example shows how to change the color of a rectangle using a color
10206 * selector. We aren't going to explain a lot of the code since it's the
10207 * usual setup code:
10208 * @until show(rect)
10210 * Now that we have a window with background and a rectangle we can create
10211 * our color_selector and set it's initial color to fully opaque blue:
10214 * Next we tell ask to be notified whenever the color changes:
10217 * We follow that we some more run of the mill setup code:
10218 * @until ELM_MAIN()
10220 * And now get to the callback that sets the color of the rectangle:
10223 * This example will look like this:
10225 * @image html screenshots/colorselector_example_01.png
10226 * @image latex screenshots/colorselector_example_01.eps width=\textwidth
10228 * @example colorselector_example_01.c
10231 * @defgroup Colorselector Colorselector
10235 * @image html img/widget/colorselector/preview-00.png
10237 * @brief Widget for user to select a color.
10239 * Signals that you can add callbacks for are:
10240 * "changed" - When the color value changes(event_info is NULL).
10242 * See @ref tutorial_colorselector.
10245 * @brief Add a new colorselector to the parent
10247 * @param parent The parent object
10248 * @return The new object or NULL if it cannot be created
10250 * @ingroup Colorselector
10252 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10254 * Set a color for the colorselector
10256 * @param obj Colorselector object
10257 * @param r r-value of color
10258 * @param g g-value of color
10259 * @param b b-value of color
10260 * @param a a-value of color
10262 * @ingroup Colorselector
10264 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
10266 * Get a color from the colorselector
10268 * @param obj Colorselector object
10269 * @param r integer pointer for r-value of color
10270 * @param g integer pointer for g-value of color
10271 * @param b integer pointer for b-value of color
10272 * @param a integer pointer for a-value of color
10274 * @ingroup Colorselector
10276 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
10281 /* Contextual Popup */
10282 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
10284 typedef enum _Elm_Ctxpopup_Direction
10286 ELM_CTXPOPUP_DIRECTION_DOWN,
10287 ELM_CTXPOPUP_DIRECTION_RIGHT,
10288 ELM_CTXPOPUP_DIRECTION_LEFT,
10289 ELM_CTXPOPUP_DIRECTION_UP,
10290 } Elm_Ctxpopup_Direction;
10292 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10293 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
10294 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
10295 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
10296 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
10297 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
10298 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10299 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10300 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10301 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10302 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);
10303 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
10304 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10305 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
10306 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
10307 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10308 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);
10309 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);
10310 /* smart callbacks called:
10311 * "dismissed" - the ctxpopup was dismissed
10317 * @defgroup Transit Transit
10318 * @ingroup Elementary
10320 * Transit is designed to apply various animated transition effects to @c
10321 * Evas_Object, such like translation, rotation, etc. For using these
10322 * effects, create an @ref Elm_Transit and add the desired transition effects.
10324 * Once the effects are added into transit, they will be automatically
10325 * managed (their callback will be called until the duration is ended, and
10326 * they will be deleted on completion).
10330 * Elm_Transit *trans = elm_transit_add();
10331 * elm_transit_object_add(trans, obj);
10332 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
10333 * elm_transit_duration_set(transit, 1);
10334 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
10335 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
10336 * elm_transit_repeat_times_set(transit, 3);
10339 * Some transition effects are used to change the properties of objects. They
10341 * @li @ref elm_transit_effect_translation_add
10342 * @li @ref elm_transit_effect_color_add
10343 * @li @ref elm_transit_effect_rotation_add
10344 * @li @ref elm_transit_effect_wipe_add
10345 * @li @ref elm_transit_effect_zoom_add
10346 * @li @ref elm_transit_effect_resizing_add
10348 * Other transition effects are used to make one object disappear and another
10349 * object appear on its old place. These effects are:
10351 * @li @ref elm_transit_effect_flip_add
10352 * @li @ref elm_transit_effect_resizable_flip_add
10353 * @li @ref elm_transit_effect_fade_add
10354 * @li @ref elm_transit_effect_blend_add
10356 * It's also possible to make a transition chain with @ref
10357 * elm_transit_chain_transit_add.
10359 * @warning We strongly recommend to use elm_transit just when edje can not do
10360 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
10361 * animations can be manipulated inside the theme.
10363 * List of examples:
10364 * @li @ref transit_example_01_explained
10365 * @li @ref transit_example_02_explained
10366 * @li @ref transit_example_03_c
10367 * @li @ref transit_example_04_c
10373 * @enum Elm_Transit_Tween_Mode
10375 * The type of acceleration used in the transition.
10379 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
10380 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
10381 over time, then decrease again
10383 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
10385 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
10387 } Elm_Transit_Tween_Mode;
10390 * @enum Elm_Transit_Effect_Flip_Axis
10392 * The axis where flip effect should be applied.
10396 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
10397 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
10398 } Elm_Transit_Effect_Flip_Axis;
10400 * @enum Elm_Transit_Effect_Wipe_Dir
10402 * The direction where the wipe effect should occur.
10406 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
10407 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
10408 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
10409 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
10410 } Elm_Transit_Effect_Wipe_Dir;
10411 /** @enum Elm_Transit_Effect_Wipe_Type
10413 * Whether the wipe effect should show or hide the object.
10417 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
10419 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
10421 } Elm_Transit_Effect_Wipe_Type;
10424 * @typedef Elm_Transit
10426 * The Transit created with elm_transit_add(). This type has the information
10427 * about the objects which the transition will be applied, and the
10428 * transition effects that will be used. It also contains info about
10429 * duration, number of repetitions, auto-reverse, etc.
10431 typedef struct _Elm_Transit Elm_Transit;
10432 typedef void Elm_Transit_Effect;
10434 * @typedef Elm_Transit_Effect_Transition_Cb
10436 * Transition callback called for this effect on each transition iteration.
10438 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
10440 * Elm_Transit_Effect_End_Cb
10442 * Transition callback called for this effect when the transition is over.
10444 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
10447 * Elm_Transit_Del_Cb
10449 * A callback called when the transit is deleted.
10451 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
10456 * @note Is not necessary to delete the transit object, it will be deleted at
10457 * the end of its operation.
10458 * @note The transit will start playing when the program enter in the main loop, is not
10459 * necessary to give a start to the transit.
10461 * @return The transit object.
10465 EAPI Elm_Transit *elm_transit_add(void);
10468 * Stops the animation and delete the @p transit object.
10470 * Call this function if you wants to stop the animation before the duration
10471 * time. Make sure the @p transit object is still alive with
10472 * elm_transit_del_cb_set() function.
10473 * All added effects will be deleted, calling its repective data_free_cb
10474 * functions. The function setted by elm_transit_del_cb_set() will be called.
10476 * @see elm_transit_del_cb_set()
10478 * @param transit The transit object to be deleted.
10481 * @warning Just call this function if you are sure the transit is alive.
10483 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
10486 * Add a new effect to the transit.
10488 * @note The cb function and the data are the key to the effect. If you try to
10489 * add an already added effect, nothing is done.
10490 * @note After the first addition of an effect in @p transit, if its
10491 * effect list become empty again, the @p transit will be killed by
10492 * elm_transit_del(transit) function.
10496 * Elm_Transit *transit = elm_transit_add();
10497 * elm_transit_effect_add(transit,
10498 * elm_transit_effect_blend_op,
10499 * elm_transit_effect_blend_context_new(),
10500 * elm_transit_effect_blend_context_free);
10503 * @param transit The transit object.
10504 * @param transition_cb The operation function. It is called when the
10505 * animation begins, it is the function that actually performs the animation.
10506 * It is called with the @p data, @p transit and the time progression of the
10507 * animation (a double value between 0.0 and 1.0).
10508 * @param effect The context data of the effect.
10509 * @param end_cb The function to free the context data, it will be called
10510 * at the end of the effect, it must finalize the animation and free the
10514 * @warning The transit free the context data at the and of the transition with
10515 * the data_free_cb function, do not use the context data in another transit.
10517 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);
10520 * Delete an added effect.
10522 * This function will remove the effect from the @p transit, calling the
10523 * data_free_cb to free the @p data.
10525 * @see elm_transit_effect_add()
10527 * @note If the effect is not found, nothing is done.
10528 * @note If the effect list become empty, this function will call
10529 * elm_transit_del(transit), that is, it will kill the @p transit.
10531 * @param transit The transit object.
10532 * @param transition_cb The operation function.
10533 * @param effect The context data of the effect.
10537 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);
10540 * Add new object to apply the effects.
10542 * @note After the first addition of an object in @p transit, if its
10543 * object list become empty again, the @p transit will be killed by
10544 * elm_transit_del(transit) function.
10545 * @note If the @p obj belongs to another transit, the @p obj will be
10546 * removed from it and it will only belong to the @p transit. If the old
10547 * transit stays without objects, it will die.
10548 * @note When you add an object into the @p transit, its state from
10549 * evas_object_pass_events_get(obj) is saved, and it is applied when the
10550 * transit ends, if you change this state whith evas_object_pass_events_set()
10551 * after add the object, this state will change again when @p transit stops to
10554 * @param transit The transit object.
10555 * @param obj Object to be animated.
10558 * @warning It is not allowed to add a new object after transit begins to go.
10560 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
10563 * Removes an added object from the transit.
10565 * @note If the @p obj is not in the @p transit, nothing is done.
10566 * @note If the list become empty, this function will call
10567 * elm_transit_del(transit), that is, it will kill the @p transit.
10569 * @param transit The transit object.
10570 * @param obj Object to be removed from @p transit.
10573 * @warning It is not allowed to remove objects after transit begins to go.
10575 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
10578 * Get the objects of the transit.
10580 * @param transit The transit object.
10581 * @return a Eina_List with the objects from the transit.
10585 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10588 * Enable/disable keeping up the objects states.
10589 * If it is not kept, the objects states will be reset when transition ends.
10591 * @note @p transit can not be NULL.
10592 * @note One state includes geometry, color, map data.
10594 * @param transit The transit object.
10595 * @param state_keep Keeping or Non Keeping.
10599 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
10602 * Get a value whether the objects states will be reset or not.
10604 * @note @p transit can not be NULL
10606 * @see elm_transit_objects_final_state_keep_set()
10608 * @param transit The transit object.
10609 * @return EINA_TRUE means the states of the objects will be reset.
10610 * If @p transit is NULL, EINA_FALSE is returned
10614 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10617 * Set the event enabled when transit is operating.
10619 * If @p enabled is EINA_TRUE, the objects of the transit will receives
10620 * events from mouse and keyboard during the animation.
10621 * @note When you add an object with elm_transit_object_add(), its state from
10622 * evas_object_pass_events_get(obj) is saved, and it is applied when the
10623 * transit ends, if you change this state with evas_object_pass_events_set()
10624 * after adding the object, this state will change again when @p transit stops
10627 * @param transit The transit object.
10628 * @param enabled Events are received when enabled is @c EINA_TRUE, and
10629 * ignored otherwise.
10633 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
10636 * Get the value of event enabled status.
10638 * @see elm_transit_event_enabled_set()
10640 * @param transit The Transit object
10641 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
10642 * EINA_FALSE is returned
10646 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10649 * Set the user-callback function when the transit is deleted.
10651 * @note Using this function twice will overwrite the first function setted.
10652 * @note the @p transit object will be deleted after call @p cb function.
10654 * @param transit The transit object.
10655 * @param cb Callback function pointer. This function will be called before
10656 * the deletion of the transit.
10657 * @param data Callback funtion user data. It is the @p op parameter.
10661 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
10664 * Set reverse effect automatically.
10666 * If auto reverse is setted, after running the effects with the progress
10667 * parameter from 0 to 1, it will call the effecs again with the progress
10668 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
10669 * where the duration was setted with the function elm_transit_add and
10670 * the repeat with the function elm_transit_repeat_times_set().
10672 * @param transit The transit object.
10673 * @param reverse EINA_TRUE means the auto_reverse is on.
10677 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
10680 * Get if the auto reverse is on.
10682 * @see elm_transit_auto_reverse_set()
10684 * @param transit The transit object.
10685 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
10686 * EINA_FALSE is returned
10690 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10693 * Set the transit repeat count. Effect will be repeated by repeat count.
10695 * This function sets the number of repetition the transit will run after
10696 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
10697 * If the @p repeat is a negative number, it will repeat infinite times.
10699 * @note If this function is called during the transit execution, the transit
10700 * will run @p repeat times, ignoring the times it already performed.
10702 * @param transit The transit object
10703 * @param repeat Repeat count
10707 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
10710 * Get the transit repeat count.
10712 * @see elm_transit_repeat_times_set()
10714 * @param transit The Transit object.
10715 * @return The repeat count. If @p transit is NULL
10720 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10723 * Set the transit animation acceleration type.
10725 * This function sets the tween mode of the transit that can be:
10726 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
10727 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
10728 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
10729 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
10731 * @param transit The transit object.
10732 * @param tween_mode The tween type.
10736 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
10739 * Get the transit animation acceleration type.
10741 * @note @p transit can not be NULL
10743 * @param transit The transit object.
10744 * @return The tween type. If @p transit is NULL
10745 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
10749 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10752 * Set the transit animation time
10754 * @note @p transit can not be NULL
10756 * @param transit The transit object.
10757 * @param duration The animation time.
10761 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
10764 * Get the transit animation time
10766 * @note @p transit can not be NULL
10768 * @param transit The transit object.
10770 * @return The transit animation time.
10774 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10777 * Starts the transition.
10778 * Once this API is called, the transit begins to measure the time.
10780 * @note @p transit can not be NULL
10782 * @param transit The transit object.
10786 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
10789 * Pause/Resume the transition.
10791 * If you call elm_transit_go again, the transit will be started from the
10792 * beginning, and will be unpaused.
10794 * @note @p transit can not be NULL
10796 * @param transit The transit object.
10797 * @param paused Whether the transition should be paused or not.
10801 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
10804 * Get the value of paused status.
10806 * @see elm_transit_paused_set()
10808 * @note @p transit can not be NULL
10810 * @param transit The transit object.
10811 * @return EINA_TRUE means transition is paused. If @p transit is NULL
10812 * EINA_FALSE is returned
10816 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10819 * Get the time progression of the animation (a double value between 0.0 and 1.0).
10821 * The value returned is a fraction (current time / total time). It
10822 * represents the progression position relative to the total.
10824 * @note @p transit can not be NULL
10826 * @param transit The transit object.
10828 * @return The time progression value. If @p transit is NULL
10833 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10836 * Makes the chain relationship between two transits.
10838 * @note @p transit can not be NULL. Transit would have multiple chain transits.
10839 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
10841 * @param transit The transit object.
10842 * @param chain_transit The chain transit object. This transit will be operated
10843 * after transit is done.
10845 * This function adds @p chain_transit transition to a chain after the @p
10846 * transit, and will be started as soon as @p transit ends. See @ref
10847 * transit_example_02_explained for a full example.
10851 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
10854 * Cut off the chain relationship between two transits.
10856 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
10857 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
10859 * @param transit The transit object.
10860 * @param chain_transit The chain transit object.
10862 * This function remove the @p chain_transit transition from the @p transit.
10866 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
10869 * Get the current chain transit list.
10871 * @note @p transit can not be NULL.
10873 * @param transit The transit object.
10874 * @return chain transit list.
10878 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
10881 * Add the Resizing Effect to Elm_Transit.
10883 * @note This API is one of the facades. It creates resizing effect context
10884 * and add it's required APIs to elm_transit_effect_add.
10886 * @see elm_transit_effect_add()
10888 * @param transit Transit object.
10889 * @param from_w Object width size when effect begins.
10890 * @param from_h Object height size when effect begins.
10891 * @param to_w Object width size when effect ends.
10892 * @param to_h Object height size when effect ends.
10893 * @return Resizing effect context data.
10897 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);
10900 * Add the Translation Effect to Elm_Transit.
10902 * @note This API is one of the facades. It creates translation effect context
10903 * and add it's required APIs to elm_transit_effect_add.
10905 * @see elm_transit_effect_add()
10907 * @param transit Transit object.
10908 * @param from_dx X Position variation when effect begins.
10909 * @param from_dy Y Position variation when effect begins.
10910 * @param to_dx X Position variation when effect ends.
10911 * @param to_dy Y Position variation when effect ends.
10912 * @return Translation effect context data.
10915 * @warning It is highly recommended just create a transit with this effect when
10916 * the window that the objects of the transit belongs has already been created.
10917 * This is because this effect needs the geometry information about the objects,
10918 * and if the window was not created yet, it can get a wrong information.
10920 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);
10923 * Add the Zoom Effect to Elm_Transit.
10925 * @note This API is one of the facades. It creates zoom effect context
10926 * and add it's required APIs to elm_transit_effect_add.
10928 * @see elm_transit_effect_add()
10930 * @param transit Transit object.
10931 * @param from_rate Scale rate when effect begins (1 is current rate).
10932 * @param to_rate Scale rate when effect ends.
10933 * @return Zoom effect context data.
10936 * @warning It is highly recommended just create a transit with this effect when
10937 * the window that the objects of the transit belongs has already been created.
10938 * This is because this effect needs the geometry information about the objects,
10939 * and if the window was not created yet, it can get a wrong information.
10941 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
10944 * Add the Flip Effect to Elm_Transit.
10946 * @note This API is one of the facades. It creates flip effect context
10947 * and add it's required APIs to elm_transit_effect_add.
10948 * @note This effect is applied to each pair of objects in the order they are listed
10949 * in the transit list of objects. The first object in the pair will be the
10950 * "front" object and the second will be the "back" object.
10952 * @see elm_transit_effect_add()
10954 * @param transit Transit object.
10955 * @param axis Flipping Axis(X or Y).
10956 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
10957 * @return Flip effect context data.
10960 * @warning It is highly recommended just create a transit with this effect when
10961 * the window that the objects of the transit belongs has already been created.
10962 * This is because this effect needs the geometry information about the objects,
10963 * and if the window was not created yet, it can get a wrong information.
10965 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
10968 * Add the Resizable Flip Effect to Elm_Transit.
10970 * @note This API is one of the facades. It creates resizable flip effect context
10971 * and add it's required APIs to elm_transit_effect_add.
10972 * @note This effect is applied to each pair of objects in the order they are listed
10973 * in the transit list of objects. The first object in the pair will be the
10974 * "front" object and the second will be the "back" object.
10976 * @see elm_transit_effect_add()
10978 * @param transit Transit object.
10979 * @param axis Flipping Axis(X or Y).
10980 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
10981 * @return Resizable flip effect context data.
10984 * @warning It is highly recommended just create a transit with this effect when
10985 * the window that the objects of the transit belongs has already been created.
10986 * This is because this effect needs the geometry information about the objects,
10987 * and if the window was not created yet, it can get a wrong information.
10989 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
10992 * Add the Wipe Effect to Elm_Transit.
10994 * @note This API is one of the facades. It creates wipe effect context
10995 * and add it's required APIs to elm_transit_effect_add.
10997 * @see elm_transit_effect_add()
10999 * @param transit Transit object.
11000 * @param type Wipe type. Hide or show.
11001 * @param dir Wipe Direction.
11002 * @return Wipe effect context data.
11005 * @warning It is highly recommended just create a transit with this effect when
11006 * the window that the objects of the transit belongs has already been created.
11007 * This is because this effect needs the geometry information about the objects,
11008 * and if the window was not created yet, it can get a wrong information.
11010 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
11013 * Add the Color Effect to Elm_Transit.
11015 * @note This API is one of the facades. It creates color effect context
11016 * and add it's required APIs to elm_transit_effect_add.
11018 * @see elm_transit_effect_add()
11020 * @param transit Transit object.
11021 * @param from_r RGB R when effect begins.
11022 * @param from_g RGB G when effect begins.
11023 * @param from_b RGB B when effect begins.
11024 * @param from_a RGB A when effect begins.
11025 * @param to_r RGB R when effect ends.
11026 * @param to_g RGB G when effect ends.
11027 * @param to_b RGB B when effect ends.
11028 * @param to_a RGB A when effect ends.
11029 * @return Color effect context data.
11033 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);
11036 * Add the Fade Effect to Elm_Transit.
11038 * @note This API is one of the facades. It creates fade effect context
11039 * and add it's required APIs to elm_transit_effect_add.
11040 * @note This effect is applied to each pair of objects in the order they are listed
11041 * in the transit list of objects. The first object in the pair will be the
11042 * "before" object and the second will be the "after" object.
11044 * @see elm_transit_effect_add()
11046 * @param transit Transit object.
11047 * @return Fade effect context data.
11050 * @warning It is highly recommended just create a transit with this effect when
11051 * the window that the objects of the transit belongs has already been created.
11052 * This is because this effect needs the color information about the objects,
11053 * and if the window was not created yet, it can get a wrong information.
11055 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
11058 * Add the Blend Effect to Elm_Transit.
11060 * @note This API is one of the facades. It creates blend effect context
11061 * and add it's required APIs to elm_transit_effect_add.
11062 * @note This effect is applied to each pair of objects in the order they are listed
11063 * in the transit list of objects. The first object in the pair will be the
11064 * "before" object and the second will be the "after" object.
11066 * @see elm_transit_effect_add()
11068 * @param transit Transit object.
11069 * @return Blend effect context data.
11072 * @warning It is highly recommended just create a transit with this effect when
11073 * the window that the objects of the transit belongs has already been created.
11074 * This is because this effect needs the color information about the objects,
11075 * and if the window was not created yet, it can get a wrong information.
11077 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
11080 * Add the Rotation Effect to Elm_Transit.
11082 * @note This API is one of the facades. It creates rotation effect context
11083 * and add it's required APIs to elm_transit_effect_add.
11085 * @see elm_transit_effect_add()
11087 * @param transit Transit object.
11088 * @param from_degree Degree when effect begins.
11089 * @param to_degree Degree when effect is ends.
11090 * @return Rotation effect context data.
11093 * @warning It is highly recommended just create a transit with this effect when
11094 * the window that the objects of the transit belongs has already been created.
11095 * This is because this effect needs the geometry information about the objects,
11096 * and if the window was not created yet, it can get a wrong information.
11098 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
11101 * Add the ImageAnimation Effect to Elm_Transit.
11103 * @note This API is one of the facades. It creates image animation effect context
11104 * and add it's required APIs to elm_transit_effect_add.
11105 * The @p images parameter is a list images paths. This list and
11106 * its contents will be deleted at the end of the effect by
11107 * elm_transit_effect_image_animation_context_free() function.
11111 * char buf[PATH_MAX];
11112 * Eina_List *images = NULL;
11113 * Elm_Transit *transi = elm_transit_add();
11115 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
11116 * images = eina_list_append(images, eina_stringshare_add(buf));
11118 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
11119 * images = eina_list_append(images, eina_stringshare_add(buf));
11120 * elm_transit_effect_image_animation_add(transi, images);
11124 * @see elm_transit_effect_add()
11126 * @param transit Transit object.
11127 * @param images Eina_List of images file paths. This list and
11128 * its contents will be deleted at the end of the effect by
11129 * elm_transit_effect_image_animation_context_free() function.
11130 * @return Image Animation effect context data.
11134 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
11139 typedef struct _Elm_Store Elm_Store;
11140 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
11141 typedef struct _Elm_Store_Item Elm_Store_Item;
11142 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
11143 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
11144 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
11145 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
11146 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
11147 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
11148 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
11149 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
11151 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
11152 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
11153 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
11154 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
11158 ELM_STORE_ITEM_MAPPING_NONE = 0,
11159 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
11160 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
11161 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
11162 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
11163 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
11164 // can add more here as needed by common apps
11165 ELM_STORE_ITEM_MAPPING_LAST
11166 } Elm_Store_Item_Mapping_Type;
11168 struct _Elm_Store_Item_Mapping_Icon
11170 // FIXME: allow edje file icons
11172 Elm_Icon_Lookup_Order lookup_order;
11173 Eina_Bool standard_name : 1;
11174 Eina_Bool no_scale : 1;
11175 Eina_Bool smooth : 1;
11176 Eina_Bool scale_up : 1;
11177 Eina_Bool scale_down : 1;
11180 struct _Elm_Store_Item_Mapping_Empty
11185 struct _Elm_Store_Item_Mapping_Photo
11190 struct _Elm_Store_Item_Mapping_Custom
11192 Elm_Store_Item_Mapping_Cb func;
11195 struct _Elm_Store_Item_Mapping
11197 Elm_Store_Item_Mapping_Type type;
11202 Elm_Store_Item_Mapping_Empty empty;
11203 Elm_Store_Item_Mapping_Icon icon;
11204 Elm_Store_Item_Mapping_Photo photo;
11205 Elm_Store_Item_Mapping_Custom custom;
11206 // add more types here
11210 struct _Elm_Store_Item_Info
11212 Elm_Genlist_Item_Class *item_class;
11213 const Elm_Store_Item_Mapping *mapping;
11218 struct _Elm_Store_Item_Info_Filesystem
11220 Elm_Store_Item_Info base;
11224 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
11225 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
11227 EAPI void elm_store_free(Elm_Store *st);
11229 EAPI Elm_Store *elm_store_filesystem_new(void);
11230 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
11231 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
11232 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
11234 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
11236 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
11237 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
11238 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
11239 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
11240 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
11241 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
11243 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
11244 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
11245 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
11246 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
11247 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
11248 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
11249 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
11251 /* SegmentControl */
11252 typedef struct _Elm_Segment_Item Elm_Segment_Item;
11253 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11254 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
11255 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);
11256 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
11257 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
11258 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
11260 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
11261 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
11262 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
11263 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
11264 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
11265 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
11266 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11267 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
11268 /* smart callbacks called:
11269 * "changed" -when the user clicks on a segment item which is not previously
11270 * selected and get selected. The event_info parameter is the
11271 * segment item index.
11274 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
11275 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
11276 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
11277 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
11278 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
11279 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
11280 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
11281 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
11283 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
11284 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
11286 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
11287 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
11288 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
11289 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
11290 EAPI void elm_video_play(Evas_Object *video);
11291 EAPI void elm_video_pause(Evas_Object *video);
11292 EAPI void elm_video_stop(Evas_Object *video);
11293 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
11294 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
11295 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
11296 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
11297 EAPI double elm_video_audio_level_get(Evas_Object *video);
11298 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
11299 EAPI double elm_video_play_position_get(Evas_Object *video);
11300 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
11301 EAPI double elm_video_play_length_get(Evas_Object *video);
11302 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
11303 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
11304 EAPI const char *elm_video_title_get(Evas_Object *video);
11306 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
11307 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
11310 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
11314 ELM_NAVIFRAME_PREV_BUTTON,
11315 ELM_NAVIFRAME_NEXT_BUTTON
11316 } Elm_Naviframe_Button_Type;
11318 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11319 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);
11320 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
11321 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
11322 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11323 EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
11324 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
11325 EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
11326 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
11327 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
11328 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
11329 EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11330 EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11331 EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
11332 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
11333 EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
11334 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
11335 EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
11336 EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
11337 EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
11338 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);