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, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
1132 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
1134 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1135 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1138 * Adjust size of an element for finger usage.
1140 * @param times_w How many fingers should fit horizontally
1141 * @param w Pointer to the width size to adjust
1142 * @param times_h How many fingers should fit vertically
1143 * @param h Pointer to the height size to adjust
1145 * This takes width and height sizes (in pixels) as input and a
1146 * size multiple (which is how many fingers you want to place
1147 * within the area, being "finger" the size set by
1148 * elm_finger_size_set()), and adjusts the size to be large enough
1149 * to accommodate the resulting size -- if it doesn't already
1150 * accommodate it. On return the @p w and @p h sizes pointed to by
1151 * these parameters will be modified, on those conditions.
1153 * @note This is kind of a low level Elementary call, most useful
1154 * on size evaluation times for widgets. An external user wouldn't
1155 * be calling, most of the time.
1159 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1161 EAPI double elm_longpress_timeout_get(void);
1162 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1165 * don't use it unless you are sure
1167 EAPI void elm_object_tree_dump(const Evas_Object *top);
1168 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1173 * @defgroup Theme Theme
1175 * Elementary uses Edje to theme its widgets, naturally. But for the most
1176 * part this is hidden behind a simpler interface that lets the user set
1177 * extensions and choose the style of widgets in a much easier way.
1179 * Instead of thinking in terms of paths to Edje files and their groups
1180 * each time you want to change the appearance of a widget, Elementary
1181 * works so you can add any theme file with extensions or replace the
1182 * main theme at one point in the application, and then just set the style
1183 * of widgets with elm_object_style_set() and related functions. Elementary
1184 * will then look in its list of themes for a matching group and apply it,
1185 * and when the theme changes midway through the application, all widgets
1186 * will be updated accordingly.
1188 * There are three concepts you need to know to understand how Elementary
1189 * theming works: default theme, extensions and overlays.
1191 * Default theme, obviously enough, is the one that provides the default
1192 * look of all widgets. End users can change the theme used by Elementary
1193 * by setting the @c ELM_THEME environment variable before running an
1194 * application, or globally for all programs using the @c elementary_config
1195 * utility. Applications can change the default theme using elm_theme_set(),
1196 * but this can go against the user wishes, so it's not an adviced practice.
1198 * Ideally, applications should find everything they need in the already
1199 * provided theme, but there may be occasions when that's not enough and
1200 * custom styles are required to correctly express the idea. For this
1201 * cases, Elementary has extensions.
1203 * Extensions allow the application developer to write styles of its own
1204 * to apply to some widgets. This requires knowledge of how each widget
1205 * is themed, as extensions will always replace the entire group used by
1206 * the widget, so important signals and parts need to be there for the
1207 * object to behave properly (see documentation of Edje for details).
1208 * Once the theme for the extension is done, the application needs to add
1209 * it to the list of themes Elementary will look into, using
1210 * elm_theme_extension_add(), and set the style of the desired widgets as
1211 * he would normally with elm_object_style_set().
1213 * Overlays, on the other hand, can replace the look of all widgets by
1214 * overriding the default style. Like extensions, it's up to the application
1215 * developer to write the theme for the widgets it wants, the difference
1216 * being that when looking for the theme, Elementary will check first the
1217 * list of overlays, then the set theme and lastly the list of extensions,
1218 * so with overlays it's possible to replace the default view and every
1219 * widget will be affected. This is very much alike to setting the whole
1220 * theme for the application and will probably clash with the end user
1221 * options, not to mention the risk of ending up with not matching styles
1222 * across the program. Unless there's a very special reason to use them,
1223 * overlays should be avoided for the resons exposed before.
1225 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1226 * keeps one default internally and every function that receives one of
1227 * these can be called with NULL to refer to this default (except for
1228 * elm_theme_free()). It's possible to create a new instance of a
1229 * ::Elm_Theme to set other theme for a specific widget (and all of its
1230 * children), but this is as discouraged, if not even more so, than using
1231 * overlays. Don't use this unless you really know what you are doing.
1233 * But to be less negative about things, you can look at the following
1235 * @li @ref theme_example_01 "Using extensions"
1236 * @li @ref theme_example_02 "Using overlays"
1241 * @typedef Elm_Theme
1243 * Opaque handler for the list of themes Elementary looks for when
1244 * rendering widgets.
1246 * Stay out of this unless you really know what you are doing. For most
1247 * cases, sticking to the default is all a developer needs.
1249 typedef struct _Elm_Theme Elm_Theme;
1252 * Create a new specific theme
1254 * This creates an empty specific theme that only uses the default theme. A
1255 * specific theme has its own private set of extensions and overlays too
1256 * (which are empty by default). Specific themes do not fall back to themes
1257 * of parent objects. They are not intended for this use. Use styles, overlays
1258 * and extensions when needed, but avoid specific themes unless there is no
1259 * other way (example: you want to have a preview of a new theme you are
1260 * selecting in a "theme selector" window. The preview is inside a scroller
1261 * and should display what the theme you selected will look like, but not
1262 * actually apply it yet. The child of the scroller will have a specific
1263 * theme set to show this preview before the user decides to apply it to all
1266 EAPI Elm_Theme *elm_theme_new(void);
1268 * Free a specific theme
1270 * @param th The theme to free
1272 * This frees a theme created with elm_theme_new().
1274 EAPI void elm_theme_free(Elm_Theme *th);
1276 * Copy the theme fom the source to the destination theme
1278 * @param th The source theme to copy from
1279 * @param thdst The destination theme to copy data to
1281 * This makes a one-time static copy of all the theme config, extensions
1282 * and overlays from @p th to @p thdst. If @p th references a theme, then
1283 * @p thdst is also set to reference it, with all the theme settings,
1284 * overlays and extensions that @p th had.
1286 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1288 * Tell the source theme to reference the ref theme
1290 * @param th The theme that will do the referencing
1291 * @param thref The theme that is the reference source
1293 * This clears @p th to be empty and then sets it to refer to @p thref
1294 * so @p th acts as an override to @p thref, but where its overrides
1295 * don't apply, it will fall through to @pthref for configuration.
1297 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1299 * Return the theme referred to
1301 * @param th The theme to get the reference from
1302 * @return The referenced theme handle
1304 * This gets the theme set as the reference theme by elm_theme_ref_set().
1305 * If no theme is set as a reference, NULL is returned.
1307 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1309 * Return the default theme
1311 * @return The default theme handle
1313 * This returns the internal default theme setup handle that all widgets
1314 * use implicitly unless a specific theme is set. This is also often use
1315 * as a shorthand of NULL.
1317 EAPI Elm_Theme *elm_theme_default_get(void);
1319 * Prepends a theme overlay to the list of overlays
1321 * @param th The theme to add to, or if NULL, the default theme
1322 * @param item The Edje file path to be used
1324 * Use this if your application needs to provide some custom overlay theme
1325 * (An Edje file that replaces some default styles of widgets) where adding
1326 * new styles, or changing system theme configuration is not possible. Do
1327 * NOT use this instead of a proper system theme configuration. Use proper
1328 * configuration files, profiles, environment variables etc. to set a theme
1329 * so that the theme can be altered by simple confiugration by a user. Using
1330 * this call to achieve that effect is abusing the API and will create lots
1333 * @see elm_theme_extension_add()
1335 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1337 * Delete a theme overlay from the list of overlays
1339 * @param th The theme to delete from, or if NULL, the default theme
1340 * @param item The name of the theme overlay
1342 * @see elm_theme_overlay_add()
1344 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1346 * Appends a theme extension to the list of extensions.
1348 * @param th The theme to add to, or if NULL, the default theme
1349 * @param item The Edje file path to be used
1351 * This is intended when an application needs more styles of widgets or new
1352 * widget themes that the default does not provide (or may not provide). The
1353 * application has "extended" usage by coming up with new custom style names
1354 * for widgets for specific uses, but as these are not "standard", they are
1355 * not guaranteed to be provided by a default theme. This means the
1356 * application is required to provide these extra elements itself in specific
1357 * Edje files. This call adds one of those Edje files to the theme search
1358 * path to be search after the default theme. The use of this call is
1359 * encouraged when default styles do not meet the needs of the application.
1360 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1362 * @see elm_object_style_set()
1364 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1366 * Deletes a theme extension from the list of extensions.
1368 * @param th The theme to delete from, or if NULL, the default theme
1369 * @param item The name of the theme extension
1371 * @see elm_theme_extension_add()
1373 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1375 * Set the theme search order for the given theme
1377 * @param th The theme to set the search order, or if NULL, the default theme
1378 * @param theme Theme search string
1380 * This sets the search string for the theme in path-notation from first
1381 * theme to search, to last, delimited by the : character. Example:
1383 * "shiny:/path/to/file.edj:default"
1385 * See the ELM_THEME environment variable for more information.
1387 * @see elm_theme_get()
1388 * @see elm_theme_list_get()
1390 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1392 * Return the theme search order
1394 * @param th The theme to get the search order, or if NULL, the default theme
1395 * @return The internal search order path
1397 * This function returns a colon separated string of theme elements as
1398 * returned by elm_theme_list_get().
1400 * @see elm_theme_set()
1401 * @see elm_theme_list_get()
1403 EAPI const char *elm_theme_get(Elm_Theme *th);
1405 * Return a list of theme elements to be used in a theme.
1407 * @param th Theme to get the list of theme elements from.
1408 * @return The internal list of theme elements
1410 * This returns the internal list of theme elements (will only be valid as
1411 * long as the theme is not modified by elm_theme_set() or theme is not
1412 * freed by elm_theme_free(). This is a list of strings which must not be
1413 * altered as they are also internal. If @p th is NULL, then the default
1414 * theme element list is returned.
1416 * A theme element can consist of a full or relative path to a .edj file,
1417 * or a name, without extension, for a theme to be searched in the known
1418 * theme paths for Elemementary.
1420 * @see elm_theme_set()
1421 * @see elm_theme_get()
1423 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1425 * Return the full patrh for a theme element
1427 * @param f The theme element name
1428 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1429 * @return The full path to the file found.
1431 * This returns a string you should free with free() on success, NULL on
1432 * failure. This will search for the given theme element, and if it is a
1433 * full or relative path element or a simple searchable name. The returned
1434 * path is the full path to the file, if searched, and the file exists, or it
1435 * is simply the full path given in the element or a resolved path if
1436 * relative to home. The @p in_search_path boolean pointed to is set to
1437 * EINA_TRUE if the file was a searchable file andis in the search path,
1438 * and EINA_FALSE otherwise.
1440 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1442 * Flush the current theme.
1444 * @param th Theme to flush
1446 * This flushes caches that let elementary know where to find theme elements
1447 * in the given theme. If @p th is NULL, then the default theme is flushed.
1448 * Call this function if source theme data has changed in such a way as to
1449 * make any caches Elementary kept invalid.
1451 EAPI void elm_theme_flush(Elm_Theme *th);
1453 * This flushes all themes (default and specific ones).
1455 * This will flush all themes in the current application context, by calling
1456 * elm_theme_flush() on each of them.
1458 EAPI void elm_theme_full_flush(void);
1460 * Set the theme for all elementary using applications on the current display
1462 * @param theme The name of the theme to use. Format same as the ELM_THEME
1463 * environment variable.
1465 EAPI void elm_theme_all_set(const char *theme);
1467 * Return a list of theme elements in the theme search path
1469 * @return A list of strings that are the theme element names.
1471 * This lists all available theme files in the standard Elementary search path
1472 * for theme elements, and returns them in alphabetical order as theme
1473 * element names in a list of strings. Free this with
1474 * elm_theme_name_available_list_free() when you are done with the list.
1476 EAPI Eina_List *elm_theme_name_available_list_new(void);
1478 * Free the list returned by elm_theme_name_available_list_new()
1480 * This frees the list of themes returned by
1481 * elm_theme_name_available_list_new(). Once freed the list should no longer
1482 * be used. a new list mys be created.
1484 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1486 * Set a specific theme to be used for this object and its children
1488 * @param obj The object to set the theme on
1489 * @param th The theme to set
1491 * This sets a specific theme that will be used for the given object and any
1492 * child objects it has. If @p th is NULL then the theme to be used is
1493 * cleared and the object will inherit its theme from its parent (which
1494 * ultimately will use the default theme if no specific themes are set).
1496 * Use special themes with great care as this will annoy users and make
1497 * configuration difficult. Avoid any custom themes at all if it can be
1500 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1502 * Get the specific theme to be used
1504 * @param obj The object to get the specific theme from
1505 * @return The specifc theme set.
1507 * This will return a specific theme set, or NULL if no specific theme is
1508 * set on that object. It will not return inherited themes from parents, only
1509 * the specific theme set for that specific object. See elm_object_theme_set()
1510 * for more information.
1512 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1518 typedef enum _Elm_Win_Type
1521 ELM_WIN_DIALOG_BASIC,
1528 ELM_WIN_DROPDOWN_MENU,
1531 ELM_WIN_NOTIFICATION,
1534 ELM_WIN_INLINED_IMAGE,
1537 typedef enum _Elm_Win_Keyboard_Mode
1539 ELM_WIN_KEYBOARD_UNKNOWN,
1540 ELM_WIN_KEYBOARD_OFF,
1541 ELM_WIN_KEYBOARD_ON,
1542 ELM_WIN_KEYBOARD_ALPHA,
1543 ELM_WIN_KEYBOARD_NUMERIC,
1544 ELM_WIN_KEYBOARD_PIN,
1545 ELM_WIN_KEYBOARD_PHONE_NUMBER,
1546 ELM_WIN_KEYBOARD_HEX,
1547 ELM_WIN_KEYBOARD_TERMINAL,
1548 ELM_WIN_KEYBOARD_PASSWORD,
1549 ELM_WIN_KEYBOARD_IP,
1550 ELM_WIN_KEYBOARD_HOST,
1551 ELM_WIN_KEYBOARD_FILE,
1552 ELM_WIN_KEYBOARD_URL,
1553 ELM_WIN_KEYBOARD_KEYPAD,
1554 ELM_WIN_KEYBOARD_J2ME
1555 } Elm_Win_Keyboard_Mode;
1557 typedef enum _Elm_Illume_Command
1559 ELM_ILLUME_COMMAND_FOCUS_BACK,
1560 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1561 ELM_ILLUME_COMMAND_FOCUS_HOME,
1562 ELM_ILLUME_COMMAND_CLOSE
1563 } Elm_Illume_Command;
1565 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1566 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1567 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1568 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1569 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1570 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1571 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1572 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1573 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1574 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1575 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1576 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1578 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1580 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1581 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1582 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1583 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1584 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1585 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1586 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1587 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1588 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1589 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1590 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1592 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1593 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1594 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1595 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1596 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1597 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1598 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1599 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1600 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1601 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1602 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1603 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1604 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1605 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1606 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1607 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1608 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1609 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1610 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1611 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1612 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1613 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1614 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1616 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1617 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1618 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1619 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1620 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1621 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1622 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1624 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1625 * (blank mouse, private mouse obj, defaultmouse)
1628 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1629 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1630 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1631 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1633 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1635 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1636 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1637 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1638 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1639 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1640 /* available styles:
1645 /* X specific calls - won't work on non-x engines (return 0) */
1646 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1647 /* smart callbacks called:
1648 * "delete,request" - the user requested to delete the window
1649 * "focus,in" - window got focus
1650 * "focus,out" - window lost focus
1651 * "moved" - window that holds the canvas was moved
1657 * @image html img/icon/bg/preview-00.png
1658 * @image latex img/icon/bg/preview-00.png
1660 * @brief Background object, used for setting a solid color, image or Edje
1661 * group as background to a window or any container object.
1663 * The bg object is used for setting a solid background to a window or
1664 * packing into any container object. It works just like an image, but has
1665 * some properties useful to a background, like setting it to tiled,
1666 * centered, scaled or stretched.
1668 * Here is some sample code using it:
1669 * @li @ref bg_01_example_page
1670 * @li @ref bg_02_example_page
1671 * @li @ref bg_03_example_page
1675 typedef enum _Elm_Bg_Option
1677 ELM_BG_OPTION_CENTER, /**< center the background */
1678 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
1679 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1680 ELM_BG_OPTION_TILE /**< tile background at its original size */
1684 * Add a new background to the parent
1686 * @param parent The parent object
1687 * @return The new object or NULL if it cannot be created
1691 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1694 * Set the file (image or edje) used for the background
1696 * @param obj The bg object
1697 * @param file The file path
1698 * @param group Optional key (group in Edje) within the file
1700 * This sets the image file used in the background object. The image (or edje)
1701 * will be stretched (retaining aspect if its an image file) to completely fill
1702 * the bg object. This may mean some parts are not visible.
1704 * @note Once the image of @p obj is set, a previously set one will be deleted,
1705 * even if @p file is NULL.
1709 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1712 * Get the file (image or edje) used for the background
1714 * @param obj The bg object
1715 * @param file The file path
1716 * @param group Optional key (group in Edje) within the file
1720 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1723 * Set the option used for the background image
1725 * @param obj The bg object
1726 * @param option The desired background option (TILE, SCALE)
1728 * This sets the option used for manipulating the display of the background
1729 * image. The image can be tiled or scaled.
1733 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1736 * Get the option used for the background image
1738 * @param obj The bg object
1739 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1743 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1745 * Set the option used for the background color
1747 * @param obj The bg object
1752 * This sets the color used for the background rectangle. Its range goes
1757 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1759 * Get the option used for the background color
1761 * @param obj The bg object
1768 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1771 * Set the overlay object used for the background object.
1773 * @param obj The bg object
1774 * @param overlay The overlay object
1776 * This provides a way for elm_bg to have an 'overlay' that will be on top
1777 * of the bg. Once the over object is set, a previously set one will be
1778 * deleted, even if you set the new one to NULL. If you want to keep that
1779 * old content object, use the elm_bg_overlay_unset() function.
1784 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1787 * Get the overlay object used for the background object.
1789 * @param obj The bg object
1790 * @return The content that is being used
1792 * Return the content object which is set for this widget
1796 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1799 * Get the overlay object used for the background object.
1801 * @param obj The bg object
1802 * @return The content that was being used
1804 * Unparent and return the overlay object which was set for this widget
1808 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1811 * Set the size of the pixmap representation of the image.
1813 * This option just makes sense if an image is going to be set in the bg.
1815 * @param obj The bg object
1816 * @param w The new width of the image pixmap representation.
1817 * @param h The new height of the image pixmap representation.
1819 * This function sets a new size for pixmap representation of the given bg
1820 * image. It allows the image to be loaded already in the specified size,
1821 * reducing the memory usage and load time when loading a big image with load
1822 * size set to a smaller size.
1824 * NOTE: this is just a hint, the real size of the pixmap may differ
1825 * depending on the type of image being loaded, being bigger than requested.
1829 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1830 /* smart callbacks called:
1834 * @defgroup Icon Icon
1836 * @image html img/icon/button/preview-00.png
1837 * @image latex img/icon/button/preview-00.png
1839 * An object that provides standard icon images (delete, edit, arrows, etc.)
1840 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
1842 * The icon image requested can be in the elementary theme, or in the
1843 * freedesktop.org paths. It's possible to set the order of preference from
1844 * where the image will be used.
1846 * This API is very similar to @ref Image, but with ready to use images.
1848 * Default images provided by the theme are described below.
1850 * The first list contains icons that were first intended to be used in
1851 * toolbars, but can be used in many other places too:
1867 * Now some icons that were designed to be used in menus (but again, you can
1868 * use them anywhere else):
1873 * @li menu/arrow_down
1874 * @li menu/arrow_left
1875 * @li menu/arrow_right
1884 * And here we have some media player specific icons:
1885 * @li media_player/forward
1886 * @li media_player/info
1887 * @li media_player/next
1888 * @li media_player/pause
1889 * @li media_player/play
1890 * @li media_player/prev
1891 * @li media_player/rewind
1892 * @li media_player/stop
1894 * Signals that you can add callbacks for are:
1896 * "clicked" - This is called when a user has clicked the icon
1898 * An example of usage for this API follows:
1899 * @li @ref tutorial_icon
1907 typedef enum _Elm_Icon_Type
1914 * @enum _Elm_Icon_Lookup_Order
1915 * @typedef Elm_Icon_Lookup_Order
1917 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
1918 * theme, FDO paths, or both?
1922 typedef enum _Elm_Icon_Lookup_Order
1924 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1925 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1926 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
1927 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
1928 } Elm_Icon_Lookup_Order;
1931 * Add a new icon object to the parent.
1933 * @param parent The parent object
1934 * @return The new object or NULL if it cannot be created
1936 * @see elm_icon_file_set()
1940 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1942 * Set the file that will be used as icon.
1944 * @param obj The icon object
1945 * @param file The path to file that will be used as icon image
1946 * @param group The group that the icon belongs to in edje file
1948 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1950 * @note The icon image set by this function can be changed by
1951 * elm_icon_standard_set().
1953 * @see elm_icon_file_get()
1957 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1959 * Set a location in memory to be used as an icon
1961 * @param obj The icon object
1962 * @param img The binary data that will be used as an image
1963 * @param size The size of binary data @p img
1964 * @param format Optional format of @p img to pass to the image loader
1965 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
1967 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1969 * @note The icon image set by this function can be changed by
1970 * elm_icon_standard_set().
1974 EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
1976 * Get the file that will be used as icon.
1978 * @param obj The icon object
1979 * @param file The path to file that will be used as icon icon image
1980 * @param group The group that the icon belongs to in edje file
1982 * @see elm_icon_file_set()
1986 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1987 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1989 * Set the icon by icon standards names.
1991 * @param obj The icon object
1992 * @param name The icon name
1994 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
1996 * For example, freedesktop.org defines standard icon names such as "home",
1997 * "network", etc. There can be different icon sets to match those icon
1998 * keys. The @p name given as parameter is one of these "keys", and will be
1999 * used to look in the freedesktop.org paths and elementary theme. One can
2000 * change the lookup order with elm_icon_order_lookup_set().
2002 * If name is not found in any of the expected locations and it is the
2003 * absolute path of an image file, this image will be used.
2005 * @note The icon image set by this function can be changed by
2006 * elm_icon_file_set().
2008 * @see elm_icon_standard_get()
2009 * @see elm_icon_file_set()
2013 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2015 * Get the icon name set by icon standard names.
2017 * @param obj The icon object
2018 * @return The icon name
2020 * If the icon image was set using elm_icon_file_set() instead of
2021 * elm_icon_standard_set(), then this function will return @c NULL.
2023 * @see elm_icon_standard_set()
2027 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2029 * Set the smooth effect for an icon object.
2031 * @param obj The icon object
2032 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2033 * otherwise. Default is @c EINA_TRUE.
2035 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2036 * scaling provides a better resulting image, but is slower.
2038 * The smooth scaling should be disabled when making animations that change
2039 * the icon size, since they will be faster. Animations that don't require
2040 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2041 * is already scaled, since the scaled icon image will be cached).
2043 * @see elm_icon_smooth_get()
2047 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2049 * Get the smooth effect for an icon object.
2051 * @param obj The icon object
2052 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2054 * @see elm_icon_smooth_set()
2058 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2060 * Disable scaling of this object.
2062 * @param obj The icon object.
2063 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2064 * otherwise. Default is @c EINA_FALSE.
2066 * This function disables scaling of the icon object through the function
2067 * elm_object_scale_set(). However, this does not affect the object
2068 * size/resize in any way. For that effect, take a look at
2069 * elm_icon_scale_set().
2071 * @see elm_icon_no_scale_get()
2072 * @see elm_icon_scale_set()
2073 * @see elm_object_scale_set()
2077 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2079 * Get whether scaling is disabled on the object.
2081 * @param obj The icon object
2082 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2084 * @see elm_icon_no_scale_set()
2088 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2090 * Set if the object is (up/down) resizeable.
2092 * @param obj The icon object
2093 * @param scale_up A bool to set if the object is resizeable up. Default is
2095 * @param scale_down A bool to set if the object is resizeable down. Default
2098 * This function limits the icon object resize ability. If @p scale_up is set to
2099 * @c EINA_FALSE, the object can't have its height or width resized to a value
2100 * higher than the original icon size. Same is valid for @p scale_down.
2102 * @see elm_icon_scale_get()
2106 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2108 * Get if the object is (up/down) resizeable.
2110 * @param obj The icon object
2111 * @param scale_up A bool to set if the object is resizeable up
2112 * @param scale_down A bool to set if the object is resizeable down
2114 * @see elm_icon_scale_set()
2118 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2120 * Set if the icon fill the entire object area.
2122 * @param obj The icon object
2123 * @param fill_outside @c EINA_TRUE if the object is filled outside,
2124 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2126 * When the icon object is resized to a different aspect ratio from the
2127 * original icon image, the icon image will still keep its aspect. This flag
2128 * tells how the image should fill the object's area. They are: keep the
2129 * entire icon inside the limits of height and width of the object (@p
2130 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
2131 * of the object, and the icon will fill the entire object (@p fill_outside
2134 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
2135 * retain property to false. Thus, the icon image will always keep its
2136 * original aspect ratio.
2138 * @see elm_icon_fill_outside_get()
2139 * @see elm_image_fill_outside_set()
2143 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2145 * Get if the object is filled outside.
2147 * @param obj The icon object
2148 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2150 * @see elm_icon_fill_outside_set()
2154 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2156 * Set the prescale size for the icon.
2158 * @param obj The icon object
2159 * @param size The prescale size. This value is used for both width and
2162 * This function sets a new size for pixmap representation of the given
2163 * icon. It allows the icon to be loaded already in the specified size,
2164 * reducing the memory usage and load time when loading a big icon with load
2165 * size set to a smaller size.
2167 * It's equivalent to the elm_bg_load_size_set() function for bg.
2169 * @note this is just a hint, the real size of the pixmap may differ
2170 * depending on the type of icon being loaded, being bigger than requested.
2172 * @see elm_icon_prescale_get()
2173 * @see elm_bg_load_size_set()
2177 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2179 * Get the prescale size for the icon.
2181 * @param obj The icon object
2182 * @return The prescale size
2184 * @see elm_icon_prescale_set()
2188 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2190 * Sets the icon lookup order used by elm_icon_standard_set().
2192 * @param obj The icon object
2193 * @param order The icon lookup order (can be one of
2194 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
2195 * or ELM_ICON_LOOKUP_THEME)
2197 * @see elm_icon_order_lookup_get()
2198 * @see Elm_Icon_Lookup_Order
2202 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2204 * Gets the icon lookup order.
2206 * @param obj The icon object
2207 * @return The icon lookup order
2209 * @see elm_icon_order_lookup_set()
2210 * @see Elm_Icon_Lookup_Order
2214 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2221 * @defgroup Image Image
2223 * @image html img/image/button/preview-00.png
2224 * @image latex img/image/button/preview-00.png
2226 * An object that allows one to load an image file to it. It can be used
2227 * anywhere like any other elementary widget.
2229 * This widget provides most of the functionality provided from @ref Bg or @ref
2230 * Icon, but with a slightly different API (use the one that fits better your
2233 * The features not provided by those two other image widgets are:
2234 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
2235 * @li change the object orientation with elm_image_orient_set();
2236 * @li and turning the image editable with elm_image_editable_set().
2238 * Signals that you can add callbacks for are:
2240 * @li @c "clicked" - This is called when a user has clicked the image
2242 * An example of usage for this API follows:
2243 * @li @ref tutorial_image
2252 * @enum _Elm_Image_Orient
2253 * @typedef Elm_Image_Orient
2255 * Possible orientation options for elm_image_orient_set().
2257 * @image html elm_image_orient_set.png
2258 * @image latex elm_image_orient_set.eps width=\textwidth
2262 typedef enum _Elm_Image_Orient
2264 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
2265 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
2266 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
2267 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
2268 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
2269 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
2270 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
2271 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
2275 * Add a new image to the parent.
2277 * @param parent The parent object
2278 * @return The new object or NULL if it cannot be created
2280 * @see elm_image_file_set()
2284 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2286 * Set the file that will be used as image.
2288 * @param obj The image object
2289 * @param file The path to file that will be used as image
2290 * @param group The group that the image belongs in edje file (if it's an
2293 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2295 * @see elm_image_file_get()
2299 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2301 * Get the file that will be used as image.
2303 * @param obj The image object
2304 * @param file The path to file
2305 * @param group The group that the image belongs in edje file
2307 * @see elm_image_file_set()
2311 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2313 * Set the smooth effect for an image.
2315 * @param obj The image object
2316 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2317 * otherwise. Default is @c EINA_TRUE.
2319 * Set the scaling algorithm to be used when scaling the image. Smooth
2320 * scaling provides a better resulting image, but is slower.
2322 * The smooth scaling should be disabled when making animations that change
2323 * the image size, since it will be faster. Animations that don't require
2324 * resizing of the image can keep the smooth scaling enabled (even if the
2325 * image is already scaled, since the scaled image will be cached).
2327 * @see elm_image_smooth_get()
2331 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2333 * Get the smooth effect for an image.
2335 * @param obj The image object
2336 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2338 * @see elm_image_smooth_get()
2342 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2344 * Gets the current size of the image.
2346 * @param obj The image object.
2347 * @param w Pointer to store width, or NULL.
2348 * @param h Pointer to store height, or NULL.
2350 * This is the real size of the image, not the size of the object.
2352 * On error, neither w or h will be written.
2356 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2358 * Disable scaling of this object.
2360 * @param obj The image object.
2361 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2362 * otherwise. Default is @c EINA_FALSE.
2364 * This function disables scaling of the elm_image widget through the
2365 * function elm_object_scale_set(). However, this does not affect the widget
2366 * size/resize in any way. For that effect, take a look at
2367 * elm_image_scale_set().
2369 * @see elm_image_no_scale_get()
2370 * @see elm_image_scale_set()
2371 * @see elm_object_scale_set()
2375 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2377 * Get whether scaling is disabled on the object.
2379 * @param obj The image object
2380 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2382 * @see elm_image_no_scale_set()
2386 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2388 * Set if the object is (up/down) resizeable.
2390 * @param obj The image object
2391 * @param scale_up A bool to set if the object is resizeable up. Default is
2393 * @param scale_down A bool to set if the object is resizeable down. Default
2396 * This function limits the image resize ability. If @p scale_up is set to
2397 * @c EINA_FALSE, the object can't have its height or width resized to a value
2398 * higher than the original image size. Same is valid for @p scale_down.
2400 * @see elm_image_scale_get()
2404 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2406 * Get if the object is (up/down) resizeable.
2408 * @param obj The image object
2409 * @param scale_up A bool to set if the object is resizeable up
2410 * @param scale_down A bool to set if the object is resizeable down
2412 * @see elm_image_scale_set()
2416 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2418 * Set if the image fill the entire object area when keeping the aspect ratio.
2420 * @param obj The image object
2421 * @param fill_outside @c EINA_TRUE if the object is filled outside,
2422 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
2424 * When the image should keep its aspect ratio even if resized to another
2425 * aspect ratio, there are two possibilities to resize it: keep the entire
2426 * image inside the limits of height and width of the object (@p fill_outside
2427 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
2428 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
2430 * @note This option will have no effect if
2431 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
2433 * @see elm_image_fill_outside_get()
2434 * @see elm_image_aspect_ratio_retained_set()
2438 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2440 * Get if the object is filled outside
2442 * @param obj The image object
2443 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
2445 * @see elm_image_fill_outside_set()
2449 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2451 * Set the prescale size for the image
2453 * @param obj The image object
2454 * @param size The prescale size. This value is used for both width and
2457 * This function sets a new size for pixmap representation of the given
2458 * image. It allows the image to be loaded already in the specified size,
2459 * reducing the memory usage and load time when loading a big image with load
2460 * size set to a smaller size.
2462 * It's equivalent to the elm_bg_load_size_set() function for bg.
2464 * @note this is just a hint, the real size of the pixmap may differ
2465 * depending on the type of image being loaded, being bigger than requested.
2467 * @see elm_image_prescale_get()
2468 * @see elm_bg_load_size_set()
2472 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2474 * Get the prescale size for the image
2476 * @param obj The image object
2477 * @return The prescale size
2479 * @see elm_image_prescale_set()
2483 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2485 * Set the image orientation.
2487 * @param obj The image object
2488 * @param orient The image orientation
2489 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2490 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2491 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2492 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
2493 * Default is #ELM_IMAGE_ORIENT_NONE.
2495 * This function allows to rotate or flip the given image.
2497 * @see elm_image_orient_get()
2498 * @see @ref Elm_Image_Orient
2502 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2504 * Get the image orientation.
2506 * @param obj The image object
2507 * @return The image orientation
2508 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
2509 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
2510 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
2511 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
2513 * @see elm_image_orient_set()
2514 * @see @ref Elm_Image_Orient
2518 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2520 * Make the image 'editable'.
2522 * @param obj Image object.
2523 * @param set Turn on or off editability. Default is @c EINA_FALSE.
2525 * This means the image is a valid drag target for drag and drop, and can be
2526 * cut or pasted too.
2530 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2532 * Make the image 'editable'.
2534 * @param obj Image object.
2535 * @return Editability.
2537 * This means the image is a valid drag target for drag and drop, and can be
2538 * cut or pasted too.
2542 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2544 * Get the basic Evas_Image object from this object (widget).
2546 * @param obj The image object to get the inlined image from
2547 * @return The inlined image object, or NULL if none exists
2549 * This function allows one to get the underlying @c Evas_Object of type
2550 * Image from this elementary widget. It can be useful to do things like get
2551 * the pixel data, save the image to a file, etc.
2553 * @note Be careful to not manipulate it, as it is under control of
2558 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2560 * Set whether the original aspect ratio of the image should be kept on resize.
2562 * @param obj The image object.
2563 * @param retained @c EINA_TRUE if the image should retain the aspect,
2564 * @c EINA_FALSE otherwise.
2566 * The original aspect ratio (width / height) of the image is usually
2567 * distorted to match the object's size. Enabling this option will retain
2568 * this original aspect, and the way that the image is fit into the object's
2569 * area depends on the option set by elm_image_fill_outside_set().
2571 * @see elm_image_aspect_ratio_retained_get()
2572 * @see elm_image_fill_outside_set()
2576 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2578 * Get if the object retains the original aspect ratio.
2580 * @param obj The image object.
2581 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
2586 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2588 /* smart callbacks called:
2589 * "clicked" - the user clicked the image
2597 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
2599 typedef enum _Elm_GLView_Mode
2601 ELM_GLVIEW_ALPHA = 1,
2602 ELM_GLVIEW_DEPTH = 2,
2603 ELM_GLVIEW_STENCIL = 4
2607 * Defines a policy for the glview resizing.
2609 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2611 typedef enum _Elm_GLView_Resize_Policy
2613 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2614 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2615 } Elm_GLView_Resize_Policy;
2617 typedef enum _Elm_GLView_Render_Policy
2619 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2620 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2621 } Elm_GLView_Render_Policy;
2624 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2625 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2626 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2627 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2628 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2629 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2630 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2631 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2632 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2633 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2634 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
2635 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2641 * A box arranges objects in a linear fashion, governed by a layout function
2642 * that defines the details of this arrangement.
2644 * By default, the box will use an internal function to set the layout to
2645 * a single row, either vertical or horizontal. This layout is affected
2646 * by a number of parameters, such as the homogeneous flag set by
2647 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2648 * elm_box_align_set() and the hints set to each object in the box.
2650 * For this default layout, it's possible to change the orientation with
2651 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2652 * placing its elements ordered from top to bottom. When horizontal is set,
2653 * the order will go from left to right. If the box is set to be
2654 * homogeneous, every object in it will be assigned the same space, that
2655 * of the largest object. Padding can be used to set some spacing between
2656 * the cell given to each object. The alignment of the box, set with
2657 * elm_box_align_set(), determines how the bounding box of all the elements
2658 * will be placed within the space given to the box widget itself.
2660 * The size hints of each object also affect how they are placed and sized
2661 * within the box. evas_object_size_hint_min_set() will give the minimum
2662 * size the object can have, and the box will use it as the basis for all
2663 * latter calculations. Elementary widgets set their own minimum size as
2664 * needed, so there's rarely any need to use it manually.
2666 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2667 * used to tell whether the object will be allocated the minimum size it
2668 * needs or if the space given to it should be expanded. It's important
2669 * to realize that expanding the size given to the object is not the same
2670 * thing as resizing the object. It could very well end being a small
2671 * widget floating in a much larger empty space. If not set, the weight
2672 * for objects will normally be 0.0 for both axis, meaning the widget will
2673 * not be expanded. To take as much space possible, set the weight to
2674 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2676 * Besides how much space each object is allocated, it's possible to control
2677 * how the widget will be placed within that space using
2678 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2679 * for both axis, meaning the object will be centered, but any value from
2680 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2681 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2682 * is -1.0, means the object will be resized to fill the entire space it
2685 * In addition, customized functions to define the layout can be set, which
2686 * allow the application developer to organize the objects within the box
2687 * in any number of ways.
2689 * The special elm_box_layout_transition() function can be used
2690 * to switch from one layout to another, animating the motion of the
2691 * children of the box.
2693 * @note Objects should not be added to box objects using _add() calls.
2695 * Some examples on how to use boxes follow:
2696 * @li @ref box_example_01
2697 * @li @ref box_example_02
2702 * @typedef Elm_Box_Transition
2704 * Opaque handler containing the parameters to perform an animated
2705 * transition of the layout the box uses.
2707 * @see elm_box_transition_new()
2708 * @see elm_box_layout_set()
2709 * @see elm_box_layout_transition()
2711 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2714 * Add a new box to the parent
2716 * By default, the box will be in vertical mode and non-homogeneous.
2718 * @param parent The parent object
2719 * @return The new object or NULL if it cannot be created
2721 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2723 * Set the horizontal orientation
2725 * By default, box object arranges their contents vertically from top to
2727 * By calling this function with @p horizontal as EINA_TRUE, the box will
2728 * become horizontal, arranging contents from left to right.
2730 * @note This flag is ignored if a custom layout function is set.
2732 * @param obj The box object
2733 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2734 * EINA_FALSE = vertical)
2736 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2738 * Get the horizontal orientation
2740 * @param obj The box object
2741 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
2743 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2745 * Set the box to arrange its children homogeneously
2747 * If enabled, homogeneous layout makes all items the same size, according
2748 * to the size of the largest of its children.
2750 * @note This flag is ignored if a custom layout function is set.
2752 * @param obj The box object
2753 * @param homogeneous The homogeneous flag
2755 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2757 * Get whether the box is using homogeneous mode or not
2759 * @param obj The box object
2760 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2762 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2763 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2764 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2766 * Add an object to the beginning of the pack list
2768 * Pack @p subobj into the box @p obj, placing it first in the list of
2769 * children objects. The actual position the object will get on screen
2770 * depends on the layout used. If no custom layout is set, it will be at
2771 * the top or left, depending if the box is vertical or horizontal,
2774 * @param obj The box object
2775 * @param subobj The object to add to the box
2777 * @see elm_box_pack_end()
2778 * @see elm_box_pack_before()
2779 * @see elm_box_pack_after()
2780 * @see elm_box_unpack()
2781 * @see elm_box_unpack_all()
2782 * @see elm_box_clear()
2784 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2786 * Add an object at the end of the pack list
2788 * Pack @p subobj into the box @p obj, placing it last in the list of
2789 * children objects. The actual position the object will get on screen
2790 * depends on the layout used. If no custom layout is set, it will be at
2791 * the bottom or right, depending if the box is vertical or horizontal,
2794 * @param obj The box object
2795 * @param subobj The object to add to the box
2797 * @see elm_box_pack_start()
2798 * @see elm_box_pack_before()
2799 * @see elm_box_pack_after()
2800 * @see elm_box_unpack()
2801 * @see elm_box_unpack_all()
2802 * @see elm_box_clear()
2804 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2806 * Adds an object to the box before the indicated object
2808 * This will add the @p subobj to the box indicated before the object
2809 * indicated with @p before. If @p before is not already in the box, results
2810 * are undefined. Before means either to the left of the indicated object or
2811 * above it depending on orientation.
2813 * @param obj The box object
2814 * @param subobj The object to add to the box
2815 * @param before The object before which to add it
2817 * @see elm_box_pack_start()
2818 * @see elm_box_pack_end()
2819 * @see elm_box_pack_after()
2820 * @see elm_box_unpack()
2821 * @see elm_box_unpack_all()
2822 * @see elm_box_clear()
2824 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2826 * Adds an object to the box after the indicated object
2828 * This will add the @p subobj to the box indicated after the object
2829 * indicated with @p after. If @p after is not already in the box, results
2830 * are undefined. After means either to the right of the indicated object or
2831 * below it depending on orientation.
2833 * @param obj The box object
2834 * @param subobj The object to add to the box
2835 * @param after The object after which to add it
2837 * @see elm_box_pack_start()
2838 * @see elm_box_pack_end()
2839 * @see elm_box_pack_before()
2840 * @see elm_box_unpack()
2841 * @see elm_box_unpack_all()
2842 * @see elm_box_clear()
2844 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2846 * Clear the box of all children
2848 * Remove all the elements contained by the box, deleting the respective
2851 * @param obj The box object
2853 * @see elm_box_unpack()
2854 * @see elm_box_unpack_all()
2856 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2860 * Remove the object given by @p subobj from the box @p obj without
2863 * @param obj The box object
2865 * @see elm_box_unpack_all()
2866 * @see elm_box_clear()
2868 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2870 * Remove all items from the box, without deleting them
2872 * Clear the box from all children, but don't delete the respective objects.
2873 * If no other references of the box children exist, the objects will never
2874 * be deleted, and thus the application will leak the memory. Make sure
2875 * when using this function that you hold a reference to all the objects
2876 * in the box @p obj.
2878 * @param obj The box object
2880 * @see elm_box_clear()
2881 * @see elm_box_unpack()
2883 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2885 * Retrieve a list of the objects packed into the box
2887 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2888 * The order of the list corresponds to the packing order the box uses.
2890 * You must free this list with eina_list_free() once you are done with it.
2892 * @param obj The box object
2894 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2896 * Set the space (padding) between the box's elements.
2898 * Extra space in pixels that will be added between a box child and its
2899 * neighbors after its containing cell has been calculated. This padding
2900 * is set for all elements in the box, besides any possible padding that
2901 * individual elements may have through their size hints.
2903 * @param obj The box object
2904 * @param horizontal The horizontal space between elements
2905 * @param vertical The vertical space between elements
2907 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2909 * Get the space (padding) between the box's elements.
2911 * @param obj The box object
2912 * @param horizontal The horizontal space between elements
2913 * @param vertical The vertical space between elements
2915 * @see elm_box_padding_set()
2917 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2919 * Set the alignment of the whole bouding box of contents.
2921 * Sets how the bounding box containing all the elements of the box, after
2922 * their sizes and position has been calculated, will be aligned within
2923 * the space given for the whole box widget.
2925 * @param obj The box object
2926 * @param horizontal The horizontal alignment of elements
2927 * @param vertical The vertical alignment of elements
2929 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2931 * Get the alignment of the whole bouding box of contents.
2933 * @param obj The box object
2934 * @param horizontal The horizontal alignment of elements
2935 * @param vertical The vertical alignment of elements
2937 * @see elm_box_align_set()
2939 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2942 * Set the layout defining function to be used by the box
2944 * Whenever anything changes that requires the box in @p obj to recalculate
2945 * the size and position of its elements, the function @p cb will be called
2946 * to determine what the layout of the children will be.
2948 * Once a custom function is set, everything about the children layout
2949 * is defined by it. The flags set by elm_box_horizontal_set() and
2950 * elm_box_homogeneous_set() no longer have any meaning, and the values
2951 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2952 * layout function to decide if they are used and how. These last two
2953 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2954 * passed to @p cb. The @c Evas_Object the function receives is not the
2955 * Elementary widget, but the internal Evas Box it uses, so none of the
2956 * functions described here can be used on it.
2958 * Any of the layout functions in @c Evas can be used here, as well as the
2959 * special elm_box_layout_transition().
2961 * The final @p data argument received by @p cb is the same @p data passed
2962 * here, and the @p free_data function will be called to free it
2963 * whenever the box is destroyed or another layout function is set.
2965 * Setting @p cb to NULL will revert back to the default layout function.
2967 * @param obj The box object
2968 * @param cb The callback function used for layout
2969 * @param data Data that will be passed to layout function
2970 * @param free_data Function called to free @p data
2972 * @see elm_box_layout_transition()
2974 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);
2976 * Special layout function that animates the transition from one layout to another
2978 * Normally, when switching the layout function for a box, this will be
2979 * reflected immediately on screen on the next render, but it's also
2980 * possible to do this through an animated transition.
2982 * This is done by creating an ::Elm_Box_Transition and setting the box
2983 * layout to this function.
2987 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2988 * evas_object_box_layout_vertical, // start
2989 * NULL, // data for initial layout
2990 * NULL, // free function for initial data
2991 * evas_object_box_layout_horizontal, // end
2992 * NULL, // data for final layout
2993 * NULL, // free function for final data
2994 * anim_end, // will be called when animation ends
2995 * NULL); // data for anim_end function\
2996 * elm_box_layout_set(box, elm_box_layout_transition, t,
2997 * elm_box_transition_free);
3000 * @note This function can only be used with elm_box_layout_set(). Calling
3001 * it directly will not have the expected results.
3003 * @see elm_box_transition_new
3004 * @see elm_box_transition_free
3005 * @see elm_box_layout_set
3007 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3009 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3011 * If you want to animate the change from one layout to another, you need
3012 * to set the layout function of the box to elm_box_layout_transition(),
3013 * passing as user data to it an instance of ::Elm_Box_Transition with the
3014 * necessary information to perform this animation. The free function to
3015 * set for the layout is elm_box_transition_free().
3017 * The parameters to create an ::Elm_Box_Transition sum up to how long
3018 * will it be, in seconds, a layout function to describe the initial point,
3019 * another for the final position of the children and one function to be
3020 * called when the whole animation ends. This last function is useful to
3021 * set the definitive layout for the box, usually the same as the end
3022 * layout for the animation, but could be used to start another transition.
3024 * @param start_layout The layout function that will be used to start the animation
3025 * @param start_layout_data The data to be passed the @p start_layout function
3026 * @param start_layout_free_data Function to free @p start_layout_data
3027 * @param end_layout The layout function that will be used to end the animation
3028 * @param end_layout_free_data The data to be passed the @p end_layout function
3029 * @param end_layout_free_data Function to free @p end_layout_data
3030 * @param transition_end_cb Callback function called when animation ends
3031 * @param transition_end_data Data to be passed to @p transition_end_cb
3032 * @return An instance of ::Elm_Box_Transition
3034 * @see elm_box_transition_new
3035 * @see elm_box_layout_transition
3037 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);
3039 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3041 * This function is mostly useful as the @c free_data parameter in
3042 * elm_box_layout_set() when elm_box_layout_transition().
3044 * @param data The Elm_Box_Transition instance to be freed.
3046 * @see elm_box_transition_new
3047 * @see elm_box_layout_transition
3049 EAPI void elm_box_transition_free(void *data);
3056 * @defgroup Button Button
3058 * @image html img/widget/button/preview-00.png
3059 * @image html img/widget/button/preview-01.png
3060 * @image html img/widget/button/preview-02.png
3062 * This is a push-button. Press it and run some function. It can contain
3063 * a simple label and icon object and it also has an autorepeat feature.
3065 * This widgets emits the following signals:
3066 * @li "clicked": the user clicked the button (press/release).
3067 * @li "repeated": the user pressed the button without releasing it.
3068 * @li "pressed": button was pressed.
3069 * @li "unpressed": button was released after being pressed.
3070 * In all three cases, the @c event parameter of the callback will be
3073 * Also, defined in the default theme, the button has the following styles
3075 * @li default: a normal button.
3076 * @li anchor: Like default, but the button fades away when the mouse is not
3077 * over it, leaving only the text or icon.
3078 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3079 * continuous look across its options.
3080 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3082 * Follow through a complete example @ref button_example_01 "here".
3086 * Add a new button to the parent's canvas
3088 * @param parent The parent object
3089 * @return The new object or NULL if it cannot be created
3091 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3093 * Set the label used in the button
3095 * The passed @p label can be NULL to clean any existing text in it and
3096 * leave the button as an icon only object.
3098 * @param obj The button object
3099 * @param label The text will be written on the button
3100 * @deprecated use elm_object_text_set() instead.
3102 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3104 * Get the label set for the button
3106 * The string returned is an internal pointer and should not be freed or
3107 * altered. It will also become invalid when the button is destroyed.
3108 * The string returned, if not NULL, is a stringshare, so if you need to
3109 * keep it around even after the button is destroyed, you can use
3110 * eina_stringshare_ref().
3112 * @param obj The button object
3113 * @return The text set to the label, or NULL if nothing is set
3114 * @deprecated use elm_object_text_set() instead.
3116 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3118 * Set the icon used for the button
3120 * Setting a new icon will delete any other that was previously set, making
3121 * any reference to them invalid. If you need to maintain the previous
3122 * object alive, unset it first with elm_button_icon_unset().
3124 * @param obj The button object
3125 * @param icon The icon object for the button
3127 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3129 * Get the icon used for the button
3131 * Return the icon object which is set for this widget. If the button is
3132 * destroyed or another icon is set, the returned object will be deleted
3133 * and any reference to it will be invalid.
3135 * @param obj The button object
3136 * @return The icon object that is being used
3138 * @see elm_button_icon_unset()
3140 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3142 * Remove the icon set without deleting it and return the object
3144 * This function drops the reference the button holds of the icon object
3145 * and returns this last object. It is used in case you want to remove any
3146 * icon, or set another one, without deleting the actual object. The button
3147 * will be left without an icon set.
3149 * @param obj The button object
3150 * @return The icon object that was being used
3152 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3154 * Turn on/off the autorepeat event generated when the button is kept pressed
3156 * When off, no autorepeat is performed and buttons emit a normal @c clicked
3157 * signal when they are clicked.
3159 * When on, keeping a button pressed will continuously emit a @c repeated
3160 * signal until the button is released. The time it takes until it starts
3161 * emitting the signal is given by
3162 * elm_button_autorepeat_initial_timeout_set(), and the time between each
3163 * new emission by elm_button_autorepeat_gap_timeout_set().
3165 * @param obj The button object
3166 * @param on A bool to turn on/off the event
3168 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3170 * Get whether the autorepeat feature is enabled
3172 * @param obj The button object
3173 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3175 * @see elm_button_autorepeat_set()
3177 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3179 * Set the initial timeout before the autorepeat event is generated
3181 * Sets the timeout, in seconds, since the button is pressed until the
3182 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3183 * won't be any delay and the even will be fired the moment the button is
3186 * @param obj The button object
3187 * @param t Timeout in seconds
3189 * @see elm_button_autorepeat_set()
3190 * @see elm_button_autorepeat_gap_timeout_set()
3192 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3194 * Get the initial timeout before the autorepeat event is generated
3196 * @param obj The button object
3197 * @return Timeout in seconds
3199 * @see elm_button_autorepeat_initial_timeout_set()
3201 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3203 * Set the interval between each generated autorepeat event
3205 * After the first @c repeated event is fired, all subsequent ones will
3206 * follow after a delay of @p t seconds for each.
3208 * @param obj The button object
3209 * @param t Interval in seconds
3211 * @see elm_button_autorepeat_initial_timeout_set()
3213 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3215 * Get the interval between each generated autorepeat event
3217 * @param obj The button object
3218 * @return Interval in seconds
3220 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3226 * @defgroup File_Selector_Button File Selector Button
3228 * @image html img/widget/fileselector_button/preview-00.png
3229 * @image html img/widget/fileselector_button/preview-01.png
3230 * @image html img/widget/fileselector_button/preview-02.png
3232 * This is a button that, when clicked, creates an Elementary
3233 * window (or inner window) <b> with a @ref Fileselector "file
3234 * selector widget" within</b>. When a file is chosen, the (inner)
3235 * window is closed and the button emits a signal having the
3236 * selected file as it's @c event_info.
3238 * This widget encapsulates operations on its internal file
3239 * selector on its own API. There is less control over its file
3240 * selector than that one would have instatiating one directly.
3242 * The following styles are available for this button:
3245 * @li @c "hoversel_vertical"
3246 * @li @c "hoversel_vertical_entry"
3248 * Smart callbacks one can register to:
3249 * - @c "file,chosen" - the user has selected a path, whose string
3250 * pointer comes as the @c event_info data (a stringshared
3253 * Here is an example on its usage:
3254 * @li @ref fileselector_button_example
3256 * @see @ref File_Selector_Entry for a similar widget.
3261 * Add a new file selector button widget to the given parent
3262 * Elementary (container) object
3264 * @param parent The parent object
3265 * @return a new file selector button widget handle or @c NULL, on
3268 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3271 * Set the label for a given file selector button widget
3273 * @param obj The file selector button widget
3274 * @param label The text label to be displayed on @p obj
3276 * @deprecated use elm_object_text_set() instead.
3278 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3281 * Get the label set for a given file selector button widget
3283 * @param obj The file selector button widget
3284 * @return The button label
3286 * @deprecated use elm_object_text_set() instead.
3288 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3291 * Set the icon on a given file selector button widget
3293 * @param obj The file selector button widget
3294 * @param icon The icon object for the button
3296 * Once the icon object is set, a previously set one will be
3297 * deleted. If you want to keep the latter, use the
3298 * elm_fileselector_button_icon_unset() function.
3300 * @see elm_fileselector_button_icon_get()
3302 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3305 * Get the icon set for a given file selector button widget
3307 * @param obj The file selector button widget
3308 * @return The icon object currently set on @p obj or @c NULL, if
3311 * @see elm_fileselector_button_icon_set()
3313 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3316 * Unset the icon used in a given file selector button widget
3318 * @param obj The file selector button widget
3319 * @return The icon object that was being used on @p obj or @c
3322 * Unparent and return the icon object which was set for this
3325 * @see elm_fileselector_button_icon_set()
3327 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3330 * Set the title for a given file selector button widget's window
3332 * @param obj The file selector button widget
3333 * @param title The title string
3335 * This will change the window's title, when the file selector pops
3336 * out after a click on the button. Those windows have the default
3337 * (unlocalized) value of @c "Select a file" as titles.
3339 * @note It will only take any effect if the file selector
3340 * button widget is @b not under "inwin mode".
3342 * @see elm_fileselector_button_window_title_get()
3344 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3347 * Get the title set for a given file selector button widget's
3350 * @param obj The file selector button widget
3351 * @return Title of the file selector button's window
3353 * @see elm_fileselector_button_window_title_get() for more details
3355 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3358 * Set the size of a given file selector button widget's window,
3359 * holding the file selector itself.
3361 * @param obj The file selector button widget
3362 * @param width The window's width
3363 * @param height The window's height
3365 * @note it will only take any effect if the file selector button
3366 * widget is @b not under "inwin mode". The default size for the
3367 * window (when applicable) is 400x400 pixels.
3369 * @see elm_fileselector_button_window_size_get()
3371 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3374 * Get the size of a given file selector button widget's window,
3375 * holding the file selector itself.
3377 * @param obj The file selector button widget
3378 * @param width Pointer into which to store the width value
3379 * @param height Pointer into which to store the height value
3381 * @note Use @c NULL pointers on the size values you're not
3382 * interested in: they'll be ignored by the function.
3384 * @see elm_fileselector_button_window_size_set(), for more details
3386 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3389 * Set the initial file system path for a given file selector
3392 * @param obj The file selector button widget
3393 * @param path The path string
3395 * It must be a <b>directory</b> path, which will have the contents
3396 * displayed initially in the file selector's view, when invoked
3397 * from @p obj. The default initial path is the @c "HOME"
3398 * environment variable's value.
3400 * @see elm_fileselector_button_path_get()
3402 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3405 * Get the initial file system path set for a given file selector
3408 * @param obj The file selector button widget
3409 * @return path The path string
3411 * @see elm_fileselector_button_path_set() for more details
3413 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3416 * Enable/disable a tree view in the given file selector button
3417 * widget's internal file selector
3419 * @param obj The file selector button widget
3420 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3423 * This has the same effect as elm_fileselector_expandable_set(),
3424 * but now applied to a file selector button's internal file
3427 * @note There's no way to put a file selector button's internal
3428 * file selector in "grid mode", as one may do with "pure" file
3431 * @see elm_fileselector_expandable_get()
3433 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3436 * Get whether tree view is enabled for the given file selector
3437 * button widget's internal file selector
3439 * @param obj The file selector button widget
3440 * @return @c EINA_TRUE if @p obj widget's internal file selector
3441 * is in tree view, @c EINA_FALSE otherwise (and or errors)
3443 * @see elm_fileselector_expandable_set() for more details
3445 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3448 * Set whether a given file selector button widget's internal file
3449 * selector is to display folders only or the directory contents,
3452 * @param obj The file selector button widget
3453 * @param only @c EINA_TRUE to make @p obj widget's internal file
3454 * selector only display directories, @c EINA_FALSE to make files
3455 * to be displayed in it too
3457 * This has the same effect as elm_fileselector_folder_only_set(),
3458 * but now applied to a file selector button's internal file
3461 * @see elm_fileselector_folder_only_get()
3463 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3466 * Get whether a given file selector button widget's internal file
3467 * selector is displaying folders only or the directory contents,
3470 * @param obj The file selector button widget
3471 * @return @c EINA_TRUE if @p obj widget's internal file
3472 * selector is only displaying directories, @c EINA_FALSE if files
3473 * are being displayed in it too (and on errors)
3475 * @see elm_fileselector_button_folder_only_set() for more details
3477 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3480 * Enable/disable the file name entry box where the user can type
3481 * in a name for a file, in a given file selector button widget's
3482 * internal file selector.
3484 * @param obj The file selector button widget
3485 * @param is_save @c EINA_TRUE to make @p obj widget's internal
3486 * file selector a "saving dialog", @c EINA_FALSE otherwise
3488 * This has the same effect as elm_fileselector_is_save_set(),
3489 * but now applied to a file selector button's internal file
3492 * @see elm_fileselector_is_save_get()
3494 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3497 * Get whether the given file selector button widget's internal
3498 * file selector is in "saving dialog" mode
3500 * @param obj The file selector button widget
3501 * @return @c EINA_TRUE, if @p obj widget's internal file selector
3502 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3505 * @see elm_fileselector_button_is_save_set() for more details
3507 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3510 * Set whether a given file selector button widget's internal file
3511 * selector will raise an Elementary "inner window", instead of a
3512 * dedicated Elementary window. By default, it won't.
3514 * @param obj The file selector button widget
3515 * @param value @c EINA_TRUE to make it use an inner window, @c
3516 * EINA_TRUE to make it use a dedicated window
3518 * @see elm_win_inwin_add() for more information on inner windows
3519 * @see elm_fileselector_button_inwin_mode_get()
3521 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3524 * Get whether a given file selector button widget's internal file
3525 * selector will raise an Elementary "inner window", instead of a
3526 * dedicated Elementary window.
3528 * @param obj The file selector button widget
3529 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3530 * if it will use a dedicated window
3532 * @see elm_fileselector_button_inwin_mode_set() for more details
3534 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3541 * @defgroup File_Selector_Entry File Selector Entry
3543 * @image html img/widget/fileselector_entry/preview-00.png
3544 * @image latex img/widget/fileselector_entry/preview-00.eps
3546 * This is an entry made to be filled with or display a <b>file
3547 * system path string</b>. Besides the entry itself, the widget has
3548 * a @ref File_Selector_Button "file selector button" on its side,
3549 * which will raise an internal @ref Fileselector "file selector widget",
3550 * when clicked, for path selection aided by file system
3553 * This file selector may appear in an Elementary window or in an
3554 * inner window. When a file is chosen from it, the (inner) window
3555 * is closed and the selected file's path string is exposed both as
3556 * an smart event and as the new text on the entry.
3558 * This widget encapsulates operations on its internal file
3559 * selector on its own API. There is less control over its file
3560 * selector than that one would have instatiating one directly.
3562 * Smart callbacks one can register to:
3563 * - @c "changed" - The text within the entry was changed
3564 * - @c "activated" - The entry has had editing finished and
3565 * changes are to be "committed"
3566 * - @c "press" - The entry has been clicked
3567 * - @c "longpressed" - The entry has been clicked (and held) for a
3569 * - @c "clicked" - The entry has been clicked
3570 * - @c "clicked,double" - The entry has been double clicked
3571 * - @c "focused" - The entry has received focus
3572 * - @c "unfocused" - The entry has lost focus
3573 * - @c "selection,paste" - A paste action has occurred on the
3575 * - @c "selection,copy" - A copy action has occurred on the entry
3576 * - @c "selection,cut" - A cut action has occurred on the entry
3577 * - @c "unpressed" - The file selector entry's button was released
3578 * after being pressed.
3579 * - @c "file,chosen" - The user has selected a path via the file
3580 * selector entry's internal file selector, whose string pointer
3581 * comes as the @c event_info data (a stringshared string)
3583 * Here is an example on its usage:
3584 * @li @ref fileselector_entry_example
3586 * @see @ref File_Selector_Button for a similar widget.
3591 * Add a new file selector entry widget to the given parent
3592 * Elementary (container) object
3594 * @param parent The parent object
3595 * @return a new file selector entry widget handle or @c NULL, on
3598 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3601 * Set the label for a given file selector entry widget's button
3603 * @param obj The file selector entry widget
3604 * @param label The text label to be displayed on @p obj widget's
3607 * @deprecated use elm_object_text_set() instead.
3609 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3612 * Get the label set for a given file selector entry widget's button
3614 * @param obj The file selector entry widget
3615 * @return The widget button's label
3617 * @deprecated use elm_object_text_set() instead.
3619 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3622 * Set the icon on a given file selector entry widget's button
3624 * @param obj The file selector entry widget
3625 * @param icon The icon object for the entry's button
3627 * Once the icon object is set, a previously set one will be
3628 * deleted. If you want to keep the latter, use the
3629 * elm_fileselector_entry_button_icon_unset() function.
3631 * @see elm_fileselector_entry_button_icon_get()
3633 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3636 * Get the icon set for a given file selector entry widget's button
3638 * @param obj The file selector entry widget
3639 * @return The icon object currently set on @p obj widget's button
3640 * or @c NULL, if none is
3642 * @see elm_fileselector_entry_button_icon_set()
3644 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3647 * Unset the icon used in a given file selector entry widget's
3650 * @param obj The file selector entry widget
3651 * @return The icon object that was being used on @p obj widget's
3652 * button or @c NULL, on errors
3654 * Unparent and return the icon object which was set for this
3657 * @see elm_fileselector_entry_button_icon_set()
3659 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3662 * Set the title for a given file selector entry widget's window
3664 * @param obj The file selector entry widget
3665 * @param title The title string
3667 * This will change the window's title, when the file selector pops
3668 * out after a click on the entry's button. Those windows have the
3669 * default (unlocalized) value of @c "Select a file" as titles.
3671 * @note It will only take any effect if the file selector
3672 * entry widget is @b not under "inwin mode".
3674 * @see elm_fileselector_entry_window_title_get()
3676 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3679 * Get the title set for a given file selector entry widget's
3682 * @param obj The file selector entry widget
3683 * @return Title of the file selector entry's window
3685 * @see elm_fileselector_entry_window_title_get() for more details
3687 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3690 * Set the size of a given file selector entry widget's window,
3691 * holding the file selector itself.
3693 * @param obj The file selector entry widget
3694 * @param width The window's width
3695 * @param height The window's height
3697 * @note it will only take any effect if the file selector entry
3698 * widget is @b not under "inwin mode". The default size for the
3699 * window (when applicable) is 400x400 pixels.
3701 * @see elm_fileselector_entry_window_size_get()
3703 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3706 * Get the size of a given file selector entry widget's window,
3707 * holding the file selector itself.
3709 * @param obj The file selector entry widget
3710 * @param width Pointer into which to store the width value
3711 * @param height Pointer into which to store the height value
3713 * @note Use @c NULL pointers on the size values you're not
3714 * interested in: they'll be ignored by the function.
3716 * @see elm_fileselector_entry_window_size_set(), for more details
3718 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3721 * Set the initial file system path and the entry's path string for
3722 * a given file selector entry widget
3724 * @param obj The file selector entry widget
3725 * @param path The path string
3727 * It must be a <b>directory</b> path, which will have the contents
3728 * displayed initially in the file selector's view, when invoked
3729 * from @p obj. The default initial path is the @c "HOME"
3730 * environment variable's value.
3732 * @see elm_fileselector_entry_path_get()
3734 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3737 * Get the entry's path string for a given file selector entry
3740 * @param obj The file selector entry widget
3741 * @return path The path string
3743 * @see elm_fileselector_entry_path_set() for more details
3745 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3748 * Enable/disable a tree view in the given file selector entry
3749 * widget's internal file selector
3751 * @param obj The file selector entry widget
3752 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
3755 * This has the same effect as elm_fileselector_expandable_set(),
3756 * but now applied to a file selector entry's internal file
3759 * @note There's no way to put a file selector entry's internal
3760 * file selector in "grid mode", as one may do with "pure" file
3763 * @see elm_fileselector_expandable_get()
3765 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3768 * Get whether tree view is enabled for the given file selector
3769 * entry widget's internal file selector
3771 * @param obj The file selector entry widget
3772 * @return @c EINA_TRUE if @p obj widget's internal file selector
3773 * is in tree view, @c EINA_FALSE otherwise (and or errors)
3775 * @see elm_fileselector_expandable_set() for more details
3777 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3780 * Set whether a given file selector entry widget's internal file
3781 * selector is to display folders only or the directory contents,
3784 * @param obj The file selector entry widget
3785 * @param only @c EINA_TRUE to make @p obj widget's internal file
3786 * selector only display directories, @c EINA_FALSE to make files
3787 * to be displayed in it too
3789 * This has the same effect as elm_fileselector_folder_only_set(),
3790 * but now applied to a file selector entry's internal file
3793 * @see elm_fileselector_folder_only_get()
3795 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3798 * Get whether a given file selector entry widget's internal file
3799 * selector is displaying folders only or the directory contents,
3802 * @param obj The file selector entry widget
3803 * @return @c EINA_TRUE if @p obj widget's internal file
3804 * selector is only displaying directories, @c EINA_FALSE if files
3805 * are being displayed in it too (and on errors)
3807 * @see elm_fileselector_entry_folder_only_set() for more details
3809 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3812 * Enable/disable the file name entry box where the user can type
3813 * in a name for a file, in a given file selector entry widget's
3814 * internal file selector.
3816 * @param obj The file selector entry widget
3817 * @param is_save @c EINA_TRUE to make @p obj widget's internal
3818 * file selector a "saving dialog", @c EINA_FALSE otherwise
3820 * This has the same effect as elm_fileselector_is_save_set(),
3821 * but now applied to a file selector entry's internal file
3824 * @see elm_fileselector_is_save_get()
3826 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3829 * Get whether the given file selector entry widget's internal
3830 * file selector is in "saving dialog" mode
3832 * @param obj The file selector entry widget
3833 * @return @c EINA_TRUE, if @p obj widget's internal file selector
3834 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
3837 * @see elm_fileselector_entry_is_save_set() for more details
3839 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3842 * Set whether a given file selector entry widget's internal file
3843 * selector will raise an Elementary "inner window", instead of a
3844 * dedicated Elementary window. By default, it won't.
3846 * @param obj The file selector entry widget
3847 * @param value @c EINA_TRUE to make it use an inner window, @c
3848 * EINA_TRUE to make it use a dedicated window
3850 * @see elm_win_inwin_add() for more information on inner windows
3851 * @see elm_fileselector_entry_inwin_mode_get()
3853 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3856 * Get whether a given file selector entry widget's internal file
3857 * selector will raise an Elementary "inner window", instead of a
3858 * dedicated Elementary window.
3860 * @param obj The file selector entry widget
3861 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
3862 * if it will use a dedicated window
3864 * @see elm_fileselector_entry_inwin_mode_set() for more details
3866 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869 * Set the initial file system path for a given file selector entry
3872 * @param obj The file selector entry widget
3873 * @param path The path string
3875 * It must be a <b>directory</b> path, which will have the contents
3876 * displayed initially in the file selector's view, when invoked
3877 * from @p obj. The default initial path is the @c "HOME"
3878 * environment variable's value.
3880 * @see elm_fileselector_entry_path_get()
3882 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3885 * Get the parent directory's path to the latest file selection on
3886 * a given filer selector entry widget
3888 * @param obj The file selector object
3889 * @return The (full) path of the directory of the last selection
3890 * on @p obj widget, a @b stringshared string
3892 * @see elm_fileselector_entry_path_set()
3894 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3900 /* scroller policy */
3901 typedef enum _Elm_Scroller_Policy
3903 ELM_SCROLLER_POLICY_AUTO = 0,
3904 ELM_SCROLLER_POLICY_ON,
3905 ELM_SCROLLER_POLICY_OFF,
3906 ELM_SCROLLER_POLICY_LAST
3907 } Elm_Scroller_Policy;
3909 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3910 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3911 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3912 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3913 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3914 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3915 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);
3916 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3917 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3918 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);
3919 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3920 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3921 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3922 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3923 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3924 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);
3925 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3926 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
3927 /* smart callbacks called:
3928 * "edge,left" - the left edge of the content has been reached
3929 * "edge,right" - the right edge of the content has been reached
3930 * "edge,top" - the top edge of the content has been reached
3931 * "edge,bottom" - the bottom edge of the content has been reached
3932 * "scroll" - the content has been scrolled (moved)
3933 * "scroll,anim,start" - scrolling animation has started
3934 * "scroll,anim,stop" - scrolling animation has stopped
3935 * "scroll,drag,start" - dragging the contents around has started
3936 * "scroll,drag,stop" - dragging the contents around has stopped
3940 * @defgroup Label Label
3942 * @image html img/widget/label/preview-00.png
3943 * @image latex img/widget/label/preview-00.eps
3945 * @brief Widget to display text, with simple html-like markup.
3947 * The Label widget @b doesn't allow text to overflow its boundaries, if the
3948 * text doesn't fit the geometry of the label it will be ellipsized or be
3949 * cut. Elementary provides several themes for this widget:
3950 * @li default - No animation
3951 * @li marker - Centers the text in the label and make it bold by default
3952 * @li slide_long - The entire text appears from the right of the screen and
3953 * slides until it disappears in the left of the screen(reappering on the
3955 * @li slide_short - The text appears in the left of the label and slides to
3956 * the right to show the overflow. When all of the text has been shown the
3957 * position is reset.
3958 * @li slide_bounce - The text appears in the left of the label and slides to
3959 * the right to show the overflow. When all of the text has been shown the
3960 * animation reverses, moving the text to the left.
3962 * Custom themes can of course invent new markup tags and style them any way
3965 * See @ref tutorial_label for a demonstration of how to use a label widget.
3969 * @brief Add a new label to the parent
3971 * @param parent The parent object
3972 * @return The new object or NULL if it cannot be created
3974 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3976 * @brief Set the label on the label object
3978 * @param obj The label object
3979 * @param label The label will be used on the label object
3980 * @deprecated See elm_object_text_set()
3982 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 */
3984 * @brief Get the label used on the label object
3986 * @param obj The label object
3987 * @return The string inside the label
3988 * @deprecated See elm_object_text_get()
3990 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3992 * @brief Set the wrapping behavior of the label
3994 * @param obj The label object
3995 * @param wrap To wrap text or not
3997 * By default no wrapping is done. Possible values for @p wrap are:
3998 * @li ELM_WRAP_NONE - No wrapping
3999 * @li ELM_WRAP_CHAR - wrap between characters
4000 * @li ELM_WRAP_WORD - wrap between words
4001 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
4003 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4005 * @brief Get the wrapping behavior of the label
4007 * @param obj The label object
4010 * @see elm_label_line_wrap_set()
4012 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4014 * @brief Set wrap width of the label
4016 * @param obj The label object
4017 * @param w The wrap width in pixels at a minimum where words need to wrap
4019 * This function sets the maximum width size hint of the label.
4021 * @warning This is only relevant if the label is inside a container.
4023 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
4025 * @brief Get wrap width of the label
4027 * @param obj The label object
4028 * @return The wrap width in pixels at a minimum where words need to wrap
4030 * @see elm_label_wrap_width_set()
4032 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4034 * @brief Set wrap height of the label
4036 * @param obj The label object
4037 * @param h The wrap height in pixels at a minimum where words need to wrap
4039 * This function sets the maximum height size hint of the label.
4041 * @warning This is only relevant if the label is inside a container.
4043 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
4045 * @brief get wrap width of the label
4047 * @param obj The label object
4048 * @return The wrap height in pixels at a minimum where words need to wrap
4050 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4052 * @brief Set the font size on the label object.
4054 * @param obj The label object
4055 * @param size font size
4057 * @warning NEVER use this. It is for hyper-special cases only. use styles
4058 * instead. e.g. "big", "medium", "small" - or better name them by use:
4059 * "title", "footnote", "quote" etc.
4061 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
4063 * @brief Set the text color on the label object
4065 * @param obj The label object
4066 * @param r Red property background color of The label object
4067 * @param g Green property background color of The label object
4068 * @param b Blue property background color of The label object
4069 * @param a Alpha property background color of The label object
4071 * @warning NEVER use this. It is for hyper-special cases only. use styles
4072 * instead. e.g. "big", "medium", "small" - or better name them by use:
4073 * "title", "footnote", "quote" etc.
4075 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);
4077 * @brief Set the text align on the label object
4079 * @param obj The label object
4080 * @param align align mode ("left", "center", "right")
4082 * @warning NEVER use this. It is for hyper-special cases only. use styles
4083 * instead. e.g. "big", "medium", "small" - or better name them by use:
4084 * "title", "footnote", "quote" etc.
4086 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
4088 * @brief Set background color of the label
4090 * @param obj The label object
4091 * @param r Red property background color of The label object
4092 * @param g Green property background color of The label object
4093 * @param b Blue property background color of The label object
4094 * @param a Alpha property background alpha of The label object
4096 * @warning NEVER use this. It is for hyper-special cases only. use styles
4097 * instead. e.g. "big", "medium", "small" - or better name them by use:
4098 * "title", "footnote", "quote" etc.
4100 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);
4102 * @brief Set the ellipsis behavior of the label
4104 * @param obj The label object
4105 * @param ellipsis To ellipsis text or not
4107 * If set to true and the text doesn't fit in the label an ellipsis("...")
4108 * will be shown at the end of the widget.
4110 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
4111 * choosen wrap method was ELM_WRAP_WORD.
4113 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
4115 * @brief Set the text slide of the label
4117 * @param obj The label object
4118 * @param slide To start slide or stop
4120 * If set to true the text of the label will slide throught the length of
4123 * @warning This must be called before elm_label_slide_set().
4124 * @warning This only work with the themes "slide_short", "slide_long" and
4127 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
4129 * @brief Get the text slide mode of the label
4131 * @param obj The label object
4132 * @return slide slide mode value
4134 * @see elm_label_slide_set()
4136 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 * @brief Set the slide duration(speed) of the label
4140 * @param obj The label object
4141 * @return The duration in seconds in moving text from slide begin position
4142 * to slide end position
4144 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
4146 * @brief Get the slide duration(speed) of the label
4148 * @param obj The label object
4149 * @return The duration time in moving text from slide begin position to slide end position
4151 * @see elm_label_slide_duration_set()
4153 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4161 * @image html img/widget/toggle/preview-00.png
4162 * @image latex img/widget/toggle/preview-00.eps
4164 * @brief A toggle is a slider which can be used to toggle between
4165 * two values. It has two states: on and off.
4167 * Signals that you can add callbacks for are:
4168 * @li "changed" - Whenever the toggle value has been changed. Is not called
4169 * until the toggle is released by the cursor (assuming it
4170 * has been triggered by the cursor in the first place).
4172 * @ref tutorial_toggle show how to use a toggle.
4176 * @brief Add a toggle to @p parent.
4178 * @param parent The parent object
4180 * @return The toggle object
4182 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4184 * @brief Sets the label to be displayed with the toggle.
4186 * @param obj The toggle object
4187 * @param label The label to be displayed
4189 * @deprecated use elm_object_text_set() instead.
4191 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4193 * @brief Gets the label of the toggle
4195 * @param obj toggle object
4196 * @return The label of the toggle
4198 * @deprecated use elm_object_text_get() instead.
4200 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4202 * @brief Set the icon used for the toggle
4204 * @param obj The toggle object
4205 * @param icon The icon object for the button
4207 * Once the icon object is set, a previously set one will be deleted
4208 * If you want to keep that old content object, use the
4209 * elm_toggle_icon_unset() function.
4211 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4213 * @brief Get the icon used for the toggle
4215 * @param obj The toggle object
4216 * @return The icon object that is being used
4218 * Return the icon object which is set for this widget.
4220 * @see elm_toggle_icon_set()
4222 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4224 * @brief Unset the icon used for the toggle
4226 * @param obj The toggle object
4227 * @return The icon object that was being used
4229 * Unparent and return the icon object which was set for this widget.
4231 * @see elm_toggle_icon_set()
4233 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4235 * @brief Sets the labels to be associated with the on and off states of the toggle.
4237 * @param obj The toggle object
4238 * @param onlabel The label displayed when the toggle is in the "on" state
4239 * @param offlabel The label displayed when the toggle is in the "off" state
4241 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
4243 * @brief Gets the labels associated with the on and off states of the toggle.
4245 * @param obj The toggle object
4246 * @param onlabel A char** to place the onlabel of @p obj into
4247 * @param offlabel A char** to place the offlabel of @p obj into
4249 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
4251 * @brief Sets the state of the toggle to @p state.
4253 * @param obj The toggle object
4254 * @param state The state of @p obj
4256 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4258 * @brief Gets the state of the toggle to @p state.
4260 * @param obj The toggle object
4261 * @return The state of @p obj
4263 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4265 * @brief Sets the state pointer of the toggle to @p statep.
4267 * @param obj The toggle object
4268 * @param statep The state pointer of @p obj
4270 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
4276 * @page tutorial_frame Frame example
4277 * @dontinclude frame_example_01.c
4279 * In this example we are going to create 4 Frames with different styles and
4280 * add a rectangle of different color in each.
4282 * We start we the usual setup code:
4285 * And then create one rectangle:
4288 * To add it in our first frame, which since it doesn't have it's style
4289 * specifically set uses the default style:
4292 * And then create another rectangle:
4295 * To add it in our second frame, which uses the "pad_small" style, note that
4296 * even tough we are setting a text for this frame it won't be show, only the
4297 * default style shows the Frame's title:
4299 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
4300 * very similar, their only difference is the size of the empty area around
4301 * the content of the frame.
4303 * And then create yet another rectangle:
4306 * To add it in our third frame, which uses the "outdent_top" style, note
4307 * that even tough we are setting a text for this frame it won't be show,
4308 * only the default style shows the Frame's title:
4311 * And then create one last rectangle:
4314 * To add it in our fourth and final frame, which uses the "outdent_bottom"
4315 * style, note that even tough we are setting a text for this frame it won't
4316 * be show, only the default style shows the Frame's title:
4319 * And now we are left with just some more setup code:
4322 * Our example will look like this:
4324 * @image html screenshots/frame_example_01.png
4325 * @image latex screenshots/frame_example_01.eps width=\textwidth
4327 * @example frame_example_01.c
4330 * @defgroup Frame Frame
4332 * @image html img/widget/frame/preview-00.png
4333 * @image latex img/widget/frame/preview-00.eps
4335 * @brief Frame is a widget that holds some content and has a title.
4337 * The default look is a frame with a title, but Frame supports multple
4345 * @li outdent_bottom
4347 * Of all this styles only default shows the title. Frame emits no signals.
4349 * For a detailed example see the @ref tutorial_frame.
4354 * @brief Add a new frame to the parent
4356 * @param parent The parent object
4357 * @return The new object or NULL if it cannot be created
4359 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4361 * @brief Set the frame label
4363 * @param obj The frame object
4364 * @param label The label of this frame object
4366 * @deprecated use elm_object_text_set() instead.
4368 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4370 * @brief Get the frame label
4372 * @param obj The frame object
4374 * @return The label of this frame objet or NULL if unable to get frame
4376 * @deprecated use elm_object_text_get() instead.
4378 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4380 * @brief Set the content of the frame widget
4382 * Once the content object is set, a previously set one will be deleted.
4383 * If you want to keep that old content object, use the
4384 * elm_frame_content_unset() function.
4386 * @param obj The frame object
4387 * @param content The content will be filled in this frame object
4389 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4391 * @brief Get the content of the frame widget
4393 * Return the content object which is set for this widget
4395 * @param obj The frame object
4396 * @return The content that is being used
4398 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4400 * @brief Unset the content of the frame widget
4402 * Unparent and return the content object which was set for this widget
4404 * @param obj The frame object
4405 * @return The content that was being used
4407 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4413 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4414 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4415 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4416 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4417 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4418 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4419 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4420 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4421 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4422 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
4423 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4424 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4427 * @defgroup Gengrid Gengrid (Generic grid)
4429 * This widget aims to position objects in a grid layout while
4430 * actually creating and rendering only the visible ones, using the
4431 * same idea as the @ref Genlist "genlist": the user defines a @b
4432 * class for each item, specifying functions that will be called at
4433 * object creation, deletion, etc. When those items are selected by
4434 * the user, a callback function is issued. Users may interact with
4435 * a gengrid via the mouse (by clicking on items to select them and
4436 * clicking on the grid's viewport and swiping to pan the whole
4437 * view) or via the keyboard, navigating through item with the
4440 * @section Gengrid_Layouts Gengrid layouts
4442 * Gengrids may layout its items in one of two possible layouts:
4446 * When in "horizontal mode", items will be placed in @b columns,
4447 * from top to bottom and, when the space for a column is filled,
4448 * another one is started on the right, thus expanding the grid
4449 * horizontally, making for horizontal scrolling. When in "vertical
4450 * mode" , though, items will be placed in @b rows, from left to
4451 * right and, when the space for a row is filled, another one is
4452 * started below, thus expanding the grid vertically (and making
4453 * for vertical scrolling).
4455 * @section Gengrid_Items Gengrid items
4457 * An item in a gengrid can have 0 or more text labels (they can be
4458 * regular text or textblock Evas objects - that's up to the style
4459 * to determine), 0 or more icons (which are simply objects
4460 * swallowed into the gengrid item's theming Edje object) and 0 or
4461 * more <b>boolean states</b>, which have the behavior left to the
4462 * user to define. The Edje part names for each of these properties
4463 * will be looked up, in the theme file for the gengrid, under the
4464 * Edje (string) data items named @c "labels", @c "icons" and @c
4465 * "states", respectively. For each of those properties, if more
4466 * than one part is provided, they must have names listed separated
4467 * by spaces in the data fields. For the default gengrid item
4468 * theme, we have @b one label part (@c "elm.text"), @b two icon
4469 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
4472 * A gengrid item may be at one of several styles. Elementary
4473 * provides one by default - "default", but this can be extended by
4474 * system or application custom themes/overlays/extensions (see
4475 * @ref Theme "themes" for more details).
4477 * @section Gengrid_Item_Class Gengrid item classes
4479 * In order to have the ability to add and delete items on the fly,
4480 * gengrid implements a class (callback) system where the
4481 * application provides a structure with information about that
4482 * type of item (gengrid may contain multiple different items with
4483 * different classes, states and styles). Gengrid will call the
4484 * functions in this struct (methods) when an item is "realized"
4485 * (i.e., created dynamically, while the user is scrolling the
4486 * grid). All objects will simply be deleted when no longer needed
4487 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
4488 * contains the following members:
4489 * - @c item_style - This is a constant string and simply defines
4490 * the name of the item style. It @b must be specified and the
4491 * default should be @c "default".
4492 * - @c func.label_get - This function is called when an item
4493 * object is actually created. The @c data parameter will point to
4494 * the same data passed to elm_gengrid_item_append() and related
4495 * item creation functions. The @c obj parameter is the gengrid
4496 * object itself, while the @c part one is the name string of one
4497 * of the existing text parts in the Edje group implementing the
4498 * item's theme. This function @b must return a strdup'()ed string,
4499 * as the caller will free() it when done. See
4500 * #GridItemLabelGetFunc.
4501 * - @c func.icon_get - This function is called when an item object
4502 * is actually created. The @c data parameter will point to the
4503 * same data passed to elm_gengrid_item_append() and related item
4504 * creation functions. The @c obj parameter is the gengrid object
4505 * itself, while the @c part one is the name string of one of the
4506 * existing (icon) swallow parts in the Edje group implementing the
4507 * item's theme. It must return @c NULL, when no icon is desired,
4508 * or a valid object handle, otherwise. The object will be deleted
4509 * by the gengrid on its deletion or when the item is "unrealized".
4510 * See #GridItemIconGetFunc.
4511 * - @c func.state_get - This function is called when an item
4512 * object is actually created. The @c data parameter will point to
4513 * the same data passed to elm_gengrid_item_append() and related
4514 * item creation functions. The @c obj parameter is the gengrid
4515 * object itself, while the @c part one is the name string of one
4516 * of the state parts in the Edje group implementing the item's
4517 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
4518 * true/on. Gengrids will emit a signal to its theming Edje object
4519 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
4520 * "source" arguments, respectively, when the state is true (the
4521 * default is false), where @c XXX is the name of the (state) part.
4522 * See #GridItemStateGetFunc.
4523 * - @c func.del - This is called when elm_gengrid_item_del() is
4524 * called on an item or elm_gengrid_clear() is called on the
4525 * gengrid. This is intended for use when gengrid items are
4526 * deleted, so any data attached to the item (e.g. its data
4527 * parameter on creation) can be deleted. See #GridItemDelFunc.
4529 * @section Gengrid_Usage_Hints Usage hints
4531 * If the user wants to have multiple items selected at the same
4532 * time, elm_gengrid_multi_select_set() will permit it. If the
4533 * gengrid is single-selection only (the default), then
4534 * elm_gengrid_select_item_get() will return the selected item or
4535 * @c NULL, if none is selected. If the gengrid is under
4536 * multi-selection, then elm_gengrid_selected_items_get() will
4537 * return a list (that is only valid as long as no items are
4538 * modified (added, deleted, selected or unselected) of child items
4541 * If an item changes (internal (boolean) state, label or icon
4542 * changes), then use elm_gengrid_item_update() to have gengrid
4543 * update the item with the new state. A gengrid will re-"realize"
4544 * the item, thus calling the functions in the
4545 * #Elm_Gengrid_Item_Class set for that item.
4547 * To programmatically (un)select an item, use
4548 * elm_gengrid_item_selected_set(). To get its selected state use
4549 * elm_gengrid_item_selected_get(). To make an item disabled
4550 * (unable to be selected and appear differently) use
4551 * elm_gengrid_item_disabled_set() to set this and
4552 * elm_gengrid_item_disabled_get() to get the disabled state.
4554 * Grid cells will only have their selection smart callbacks called
4555 * when firstly getting selected. Any further clicks will do
4556 * nothing, unless you enable the "always select mode", with
4557 * elm_gengrid_always_select_mode_set(), thus making every click to
4558 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
4559 * turn off the ability to select items entirely in the widget and
4560 * they will neither appear selected nor call the selection smart
4563 * Remember that you can create new styles and add your own theme
4564 * augmentation per application with elm_theme_extension_add(). If
4565 * you absolutely must have a specific style that overrides any
4566 * theme the user or system sets up you can use
4567 * elm_theme_overlay_add() to add such a file.
4569 * @section Gengrid_Smart_Events Gengrid smart events
4571 * Smart events that you can add callbacks for are:
4572 * - @c "clicked,double" - The user has double-clicked or pressed
4573 * enter on an item. The @c event_info parameter is the gengrid
4574 * item that was double-clicked.
4575 * - @c "selected" - The user has made an item selected. The
4576 * @c event_info parameter is the gengrid item that was selected.
4577 * - @c "unselected" - The user has made an item unselected. The
4578 * @c event_info parameter is the gengrid item that was unselected.
4579 * - @c "realized" - This is called when the item in the gengrid
4580 * has its implementing Evas object instantiated, de facto. @c
4581 * event_info is the gengrid item that was created. The object
4582 * may be deleted at any time, so it is highly advised to the
4583 * caller @b not to use the object pointer returned from
4584 * elm_gengrid_item_object_get(), because it may point to freed
4586 * - @c "unrealized" - This is called when the implementing Evas
4587 * object for this item is deleted. @c event_info is the gengrid
4588 * item that was deleted.
4589 * - @c "changed" - Called when an item is added, removed, resized
4590 * or moved and when the gengrid is resized or gets "horizontal"
4592 * - @c "drag,start,up" - Called when the item in the gengrid has
4593 * been dragged (not scrolled) up.
4594 * - @c "drag,start,down" - Called when the item in the gengrid has
4595 * been dragged (not scrolled) down.
4596 * - @c "drag,start,left" - Called when the item in the gengrid has
4597 * been dragged (not scrolled) left.
4598 * - @c "drag,start,right" - Called when the item in the gengrid has
4599 * been dragged (not scrolled) right.
4600 * - @c "drag,stop" - Called when the item in the gengrid has
4601 * stopped being dragged.
4602 * - @c "drag" - Called when the item in the gengrid is being
4604 * - @c "scroll" - called when the content has been scrolled
4606 * - @c "scroll,drag,start" - called when dragging the content has
4608 * - @c "scroll,drag,stop" - called when dragging the content has
4611 * List of gendrid examples:
4612 * @li @ref gengrid_example
4615 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
4616 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
4617 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
4618 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
4619 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
4620 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
4621 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
4624 * @struct _Elm_Gengrid_Item_Class
4626 * Gengrid item class definition. See @ref Gengrid_Item_Class for
4629 struct _Elm_Gengrid_Item_Class
4631 const char *item_style;
4632 struct _Elm_Gengrid_Item_Class_Func
4634 GridItemLabelGetFunc label_get;
4635 GridItemIconGetFunc icon_get;
4636 GridItemStateGetFunc state_get;
4637 GridItemDelFunc del;
4639 }; /**< #Elm_Gengrid_Item_Class member definitions */
4642 * Add a new gengrid widget to the given parent Elementary
4643 * (container) object
4645 * @param parent The parent object
4646 * @return a new gengrid widget handle or @c NULL, on errors
4648 * This function inserts a new gengrid widget on the canvas.
4650 * @see elm_gengrid_item_size_set()
4651 * @see elm_gengrid_horizontal_set()
4652 * @see elm_gengrid_item_append()
4653 * @see elm_gengrid_item_del()
4654 * @see elm_gengrid_clear()
4658 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4661 * Set the size for the items of a given gengrid widget
4663 * @param obj The gengrid object.
4664 * @param w The items' width.
4665 * @param h The items' height;
4667 * A gengrid, after creation, has still no information on the size
4668 * to give to each of its cells. So, you most probably will end up
4669 * with squares one @ref Fingers "finger" wide, the default
4670 * size. Use this function to force a custom size for you items,
4671 * making them as big as you wish.
4673 * @see elm_gengrid_item_size_get()
4677 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4680 * Get the size set for the items of a given gengrid widget
4682 * @param obj The gengrid object.
4683 * @param w Pointer to a variable where to store the items' width.
4684 * @param h Pointer to a variable where to store the items' height.
4686 * @note Use @c NULL pointers on the size values you're not
4687 * interested in: they'll be ignored by the function.
4689 * @see elm_gengrid_item_size_get() for more details
4693 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4696 * Set the items grid's alignment within a given gengrid widget
4698 * @param obj The gengrid object.
4699 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
4700 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
4702 * This sets the alignment of the whole grid of items of a gengrid
4703 * within its given viewport. By default, those values are both
4704 * 0.5, meaning that the gengrid will have its items grid placed
4705 * exactly in the middle of its viewport.
4707 * @note If given alignment values are out of the cited ranges,
4708 * they'll be changed to the nearest boundary values on the valid
4711 * @see elm_gengrid_align_get()
4715 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
4718 * Get the items grid's alignment values within a given gengrid
4721 * @param obj The gengrid object.
4722 * @param align_x Pointer to a variable where to store the
4723 * horizontal alignment.
4724 * @param align_y Pointer to a variable where to store the vertical
4727 * @note Use @c NULL pointers on the alignment values you're not
4728 * interested in: they'll be ignored by the function.
4730 * @see elm_gengrid_align_set() for more details
4734 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
4737 * Set whether a given gengrid widget is or not able have items
4740 * @param obj The gengrid object
4741 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
4742 * @c EINA_FALSE to turn it off
4744 * If a gengrid is set to allow reordering, a click held for more
4745 * than 0.5 over a given item will highlight it specially,
4746 * signalling the gengrid has entered the reordering state. From
4747 * that time on, the user will be able to, while still holding the
4748 * mouse button down, move the item freely in the gengrid's
4749 * viewport, replacing to said item to the locations it goes to.
4750 * The replacements will be animated and, whenever the user
4751 * releases the mouse button, the item being replaced gets a new
4752 * definitive place in the grid.
4754 * @see elm_gengrid_reorder_mode_get()
4758 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
4761 * Get whether a given gengrid widget is or not able have items
4764 * @param obj The gengrid object
4765 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
4768 * @see elm_gengrid_reorder_mode_set() for more details
4772 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4775 * Append a new item in a given gengrid widget.
4777 * @param obj The gengrid object.
4778 * @param gic The item class for the item.
4779 * @param data The item data.
4780 * @param func Convenience function called when the item is
4782 * @param func_data Data to be passed to @p func.
4783 * @return A handle to the item added or @c NULL, on errors.
4785 * This adds an item to the beginning of the gengrid.
4787 * @see elm_gengrid_item_prepend()
4788 * @see elm_gengrid_item_insert_before()
4789 * @see elm_gengrid_item_insert_after()
4790 * @see elm_gengrid_item_del()
4794 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);
4797 * Prepend a new item in a given gengrid widget.
4799 * @param obj The gengrid object.
4800 * @param gic The item class for the item.
4801 * @param data The item data.
4802 * @param func Convenience function called when the item is
4804 * @param func_data Data to be passed to @p func.
4805 * @return A handle to the item added or @c NULL, on errors.
4807 * This adds an item to the end of the gengrid.
4809 * @see elm_gengrid_item_append()
4810 * @see elm_gengrid_item_insert_before()
4811 * @see elm_gengrid_item_insert_after()
4812 * @see elm_gengrid_item_del()
4816 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);
4819 * Insert an item before another in a gengrid widget
4821 * @param obj The gengrid object.
4822 * @param gic The item class for the item.
4823 * @param data The item data.
4824 * @param relative The item to place this new one before.
4825 * @param func Convenience function called when the item is
4827 * @param func_data Data to be passed to @p func.
4828 * @return A handle to the item added or @c NULL, on errors.
4830 * This inserts an item before another in the gengrid.
4832 * @see elm_gengrid_item_append()
4833 * @see elm_gengrid_item_prepend()
4834 * @see elm_gengrid_item_insert_after()
4835 * @see elm_gengrid_item_del()
4839 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);
4842 * Insert an item after another in a gengrid widget
4844 * @param obj The gengrid object.
4845 * @param gic The item class for the item.
4846 * @param data The item data.
4847 * @param relative The item to place this new one after.
4848 * @param func Convenience function called when the item is
4850 * @param func_data Data to be passed to @p func.
4851 * @return A handle to the item added or @c NULL, on errors.
4853 * This inserts an item after another in the gengrid.
4855 * @see elm_gengrid_item_append()
4856 * @see elm_gengrid_item_prepend()
4857 * @see elm_gengrid_item_insert_after()
4858 * @see elm_gengrid_item_del()
4862 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);
4864 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);
4866 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);
4869 * Set whether items on a given gengrid widget are to get their
4870 * selection callbacks issued for @b every subsequent selection
4871 * click on them or just for the first click.
4873 * @param obj The gengrid object
4874 * @param always_select @c EINA_TRUE to make items "always
4875 * selected", @c EINA_FALSE, otherwise
4877 * By default, grid items will only call their selection callback
4878 * function when firstly getting selected, any subsequent further
4879 * clicks will do nothing. With this call, you make those
4880 * subsequent clicks also to issue the selection callbacks.
4882 * @note <b>Double clicks</b> will @b always be reported on items.
4884 * @see elm_gengrid_always_select_mode_get()
4888 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4891 * Get whether items on a given gengrid widget have their selection
4892 * callbacks issued for @b every subsequent selection click on them
4893 * or just for the first click.
4895 * @param obj The gengrid object.
4896 * @return @c EINA_TRUE if the gengrid items are "always selected",
4897 * @c EINA_FALSE, otherwise
4899 * @see elm_gengrid_always_select_mode_set() for more details
4903 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4906 * Set whether items on a given gengrid widget can be selected or not.
4908 * @param obj The gengrid object
4909 * @param no_select @c EINA_TRUE to make items selectable,
4910 * @c EINA_FALSE otherwise
4912 * This will make items in @obj selectable or not. In the latter
4913 * case, any user interacion on the gendrid items will neither make
4914 * them appear selected nor them call their selection callback
4917 * @see elm_gengrid_no_select_mode_get()
4921 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4924 * Get whether items on a given gengrid widget can be selected or
4927 * @param obj The gengrid object
4928 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
4931 * @see elm_gengrid_no_select_mode_set() for more details
4935 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4938 * Enable or disable multi-selection in a given gengrid widget
4940 * @param obj The gengrid object.
4941 * @param multi @c EINA_TRUE, to enable multi-selection,
4942 * @c EINA_FALSE to disable it.
4944 * Multi-selection is the ability for one to have @b more than one
4945 * item selected, on a given gengrid, simultaneously. When it is
4946 * enabled, a sequence of clicks on different items will make them
4947 * all selected, progressively. A click on an already selected item
4948 * will unselect it. If interecting via the keyboard,
4949 * multi-selection is enabled while holding the "Shift" key.
4951 * @note By default, multi-selection is @b disabled on gengrids
4953 * @see elm_gengrid_multi_select_get()
4957 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4960 * Get whether multi-selection is enabled or disabled for a given
4963 * @param obj The gengrid object.
4964 * @return @c EINA_TRUE, if multi-selection is enabled, @c
4965 * EINA_FALSE otherwise
4967 * @see elm_gengrid_multi_select_set() for more details
4971 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4974 * Enable or disable bouncing effect for a given gengrid widget
4976 * @param obj The gengrid object
4977 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
4978 * @c EINA_FALSE to disable it
4979 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
4980 * @c EINA_FALSE to disable it
4982 * The bouncing effect occurs whenever one reaches the gengrid's
4983 * edge's while panning it -- it will scroll past its limits a
4984 * little bit and return to the edge again, in a animated for,
4987 * @note By default, gengrids have bouncing enabled on both axis
4989 * @see elm_gengrid_bounce_get()
4993 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4996 * Get whether bouncing effects are enabled or disabled, for a
4997 * given gengrid widget, on each axis
4999 * @param obj The gengrid object
5000 * @param h_bounce Pointer to a variable where to store the
5001 * horizontal bouncing flag.
5002 * @param v_bounce Pointer to a variable where to store the
5003 * vertical bouncing flag.
5005 * @see elm_gengrid_bounce_set() for more details
5009 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5012 * Set a given gengrid widget's scrolling page size, relative to
5013 * its viewport size.
5015 * @param obj The gengrid object
5016 * @param h_pagerel The horizontal page (relative) size
5017 * @param v_pagerel The vertical page (relative) size
5019 * The gengrid's scroller is capable of binding scrolling by the
5020 * user to "pages". It means that, while scrolling and, specially
5021 * after releasing the mouse button, the grid will @b snap to the
5022 * nearest displaying page's area. When page sizes are set, the
5023 * grid's continuous content area is split into (equal) page sized
5026 * This function sets the size of a page <b>relatively to the
5027 * viewport dimensions</b> of the gengrid, for each axis. A value
5028 * @c 1.0 means "the exact viewport's size", in that axis, while @c
5029 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
5030 * a viewport". Sane usable values are, than, between @c 0.0 and @c
5031 * 1.0. Values beyond those will make it behave behave
5032 * inconsistently. If you only want one axis to snap to pages, use
5033 * the value @c 0.0 for the other one.
5035 * There is a function setting page size values in @b absolute
5036 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
5037 * is mutually exclusive to this one.
5039 * @see elm_gengrid_page_relative_get()
5043 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5046 * Get a given gengrid widget's scrolling page size, relative to
5047 * its viewport size.
5049 * @param obj The gengrid object
5050 * @param h_pagerel Pointer to a variable where to store the
5051 * horizontal page (relative) size
5052 * @param v_pagerel Pointer to a variable where to store the
5053 * vertical page (relative) size
5055 * @see elm_gengrid_page_relative_set() for more details
5059 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
5062 * Set a given gengrid widget's scrolling page size
5064 * @param obj The gengrid object
5065 * @param h_pagerel The horizontal page size, in pixels
5066 * @param v_pagerel The vertical page size, in pixels
5068 * The gengrid's scroller is capable of binding scrolling by the
5069 * user to "pages". It means that, while scrolling and, specially
5070 * after releasing the mouse button, the grid will @b snap to the
5071 * nearest displaying page's area. When page sizes are set, the
5072 * grid's continuous content area is split into (equal) page sized
5075 * This function sets the size of a page of the gengrid, in pixels,
5076 * for each axis. Sane usable values are, between @c 0 and the
5077 * dimensions of @p obj, for each axis. Values beyond those will
5078 * make it behave behave inconsistently. If you only want one axis
5079 * to snap to pages, use the value @c 0 for the other one.
5081 * There is a function setting page size values in @b relative
5082 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
5083 * use is mutually exclusive to this one.
5087 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5090 * Set for what direction a given gengrid widget will expand while
5091 * placing its items.
5093 * @param obj The gengrid object.
5094 * @param setting @c EINA_TRUE to make the gengrid expand
5095 * horizontally, @c EINA_FALSE to expand vertically.
5097 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
5098 * in @b columns, from top to bottom and, when the space for a
5099 * column is filled, another one is started on the right, thus
5100 * expanding the grid horizontally. When in "vertical mode"
5101 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
5102 * to right and, when the space for a row is filled, another one is
5103 * started below, thus expanding the grid vertically.
5105 * @see elm_gengrid_horizontal_get()
5109 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
5112 * Get for what direction a given gengrid widget will expand while
5113 * placing its items.
5115 * @param obj The gengrid object.
5116 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
5117 * @c EINA_FALSE if it's set to expand vertically.
5119 * @see elm_gengrid_horizontal_set() for more detais
5123 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5126 * Get the first item in a given gengrid widget
5128 * @param obj The gengrid object
5129 * @return The first item's handle or @c NULL, if there are no
5130 * items in @p obj (and on errors)
5132 * This returns the first item in the @p obj's internal list of
5135 * @see elm_gengrid_last_item_get()
5139 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142 * Get the last item in a given gengrid widget
5144 * @param obj The gengrid object
5145 * @return The last item's handle or @c NULL, if there are no
5146 * items in @p obj (and on errors)
5148 * This returns the last item in the @p obj's internal list of
5151 * @see elm_gengrid_first_item_get()
5155 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5158 * Get the @b next item in a gengrid widget's internal list of items,
5159 * given a handle to one of those items.
5161 * @param item The gengrid item to fetch next from
5162 * @return The item after @p item, or @c NULL if there's none (and
5165 * This returns the item placed after the @p item, on the container
5168 * @see elm_gengrid_item_prev_get()
5172 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5175 * Get the @b previous item in a gengrid widget's internal list of items,
5176 * given a handle to one of those items.
5178 * @param item The gengrid item to fetch previous from
5179 * @return The item before @p item, or @c NULL if there's none (and
5182 * This returns the item placed before the @p item, on the container
5185 * @see elm_gengrid_item_next_get()
5189 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5192 * Get the gengrid object's handle which contains a given gengrid
5195 * @param item The item to fetch the container from
5196 * @return The gengrid (parent) object
5198 * This returns the gengrid object itself that an item belongs to.
5202 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5205 * Remove a gengrid item from the its parent, deleting it.
5207 * @param item The item to be removed.
5208 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
5210 * @see elm_gengrid_clear(), to remove all items in a gengrid at
5215 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5218 * Update the contents of a given gengrid item
5220 * @param item The gengrid item
5222 * This updates an item by calling all the item class functions
5223 * again to get the icons, labels and states. Use this when the
5224 * original item data has changed and you want thta changes to be
5229 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5230 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5231 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
5234 * Return the data associated to a given gengrid item
5236 * @param item The gengrid item.
5237 * @return the data associated to this item.
5239 * This returns the @c data value passed on the
5240 * elm_gengrid_item_append() and related item addition calls.
5242 * @see elm_gengrid_item_append()
5243 * @see elm_gengrid_item_data_set()
5247 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5250 * Set the data associated to a given gengrid item
5252 * @param item The gengrid item
5253 * @param data The new data pointer to set on it
5255 * This @b overrides the @c data value passed on the
5256 * elm_gengrid_item_append() and related item addition calls. This
5257 * function @b won't call elm_gengrid_item_update() automatically,
5258 * so you'd issue it afterwards if you want to hove the item
5259 * updated to reflect the that new data.
5261 * @see elm_gengrid_item_data_get()
5265 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
5268 * Get a given gengrid item's position, relative to the whole
5269 * gengrid's grid area.
5271 * @param item The Gengrid item.
5272 * @param x Pointer to variable where to store the item's <b>row
5274 * @param y Pointer to variable where to store the item's <b>column
5277 * This returns the "logical" position of the item whithin the
5278 * gengrid. For example, @c (0, 1) would stand for first row,
5283 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
5286 * Set whether a given gengrid item is selected or not
5288 * @param item The gengrid item
5289 * @param selected Use @c EINA_TRUE, to make it selected, @c
5290 * EINA_FALSE to make it unselected
5292 * This sets the selected state of an item. If multi selection is
5293 * not enabled on the containing gengrid and @p selected is @c
5294 * EINA_TRUE, any other previously selected items will get
5295 * unselected in favor of this new one.
5297 * @see elm_gengrid_item_selected_get()
5301 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5304 * Get whether a given gengrid item is selected or not
5306 * @param item The gengrid item
5307 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
5309 * @see elm_gengrid_item_selected_set() for more details
5313 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5316 * Get the real Evas object created to implement the view of a
5317 * given gengrid item
5319 * @param item The gengrid item.
5320 * @return the Evas object implementing this item's view.
5322 * This returns the actual Evas object used to implement the
5323 * specified gengrid item's view. This may be @c NULL, as it may
5324 * not have been created or may have been deleted, at any time, by
5325 * the gengrid. <b>Do not modify this object</b> (move, resize,
5326 * show, hide, etc.), as the gengrid is controlling it. This
5327 * function is for querying, emitting custom signals or hooking
5328 * lower level callbacks for events on that object. Do not delete
5329 * this object under any circumstances.
5331 * @see elm_gengrid_item_data_get()
5335 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5338 * Show the portion of a gengrid's internal grid containing a given
5339 * item, @b immediately.
5341 * @param item The item to display
5343 * This causes gengrid to @b redraw its viewport's contents to the
5344 * region contining the given @p item item, if it is not fully
5347 * @see elm_gengrid_item_bring_in()
5351 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5354 * Animatedly bring in, to the visible are of a gengrid, a given
5357 * @param item The gengrid item to display
5359 * This causes gengrig to jump to the given @p item item and show
5360 * it (by scrolling), if it is not fully visible. This will use
5361 * animation to do so and take a period of time to complete.
5363 * @see elm_gengrid_item_show()
5367 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5370 * Set whether a given gengrid item is disabled or not.
5372 * @param item The gengrid item
5373 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
5374 * to enable it back.
5376 * A disabled item cannot be selected or unselected. It will also
5377 * change its appearance, to signal the user it's disabled.
5379 * @see elm_gengrid_item_disabled_get()
5383 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5386 * Get whether a given gengrid item is disabled or not.
5388 * @param item The gengrid item
5389 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
5392 * @see elm_gengrid_item_disabled_set() for more details
5396 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5399 * Set the text to be shown in a given gengrid item's tooltips.
5401 * @param item The gengrid item
5402 * @param text The text to set in the content
5404 * This call will setup the text to be used as tooltip to that item
5405 * (analogous to elm_object_tooltip_text_set(), but being item
5406 * tooltips with higher precedence than object tooltips). It can
5407 * have only one tooltip at a time, so any previous tooltip data
5412 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
5415 * Set the content to be shown in a given gengrid item's tooltips
5417 * @param item The gengrid item.
5418 * @param func The function returning the tooltip contents.
5419 * @param data What to provide to @a func as callback data/context.
5420 * @param del_cb Called when data is not needed anymore, either when
5421 * another callback replaces @func, the tooltip is unset with
5422 * elm_gengrid_item_tooltip_unset() or the owner @p item
5423 * dies. This callback receives as its first parameter the
5424 * given @p data, being @c event_info the item handle.
5426 * This call will setup the tooltip's contents to @p item
5427 * (analogous to elm_object_tooltip_content_cb_set(), but being
5428 * item tooltips with higher precedence than object tooltips). It
5429 * can have only one tooltip at a time, so any previous tooltip
5430 * content will get removed. @p func (with @p data) will be called
5431 * every time Elementary needs to show the tooltip and it should
5432 * return a valid Evas object, which will be fully managed by the
5433 * tooltip system, getting deleted when the tooltip is gone.
5437 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);
5440 * Unset a tooltip from a given gengrid item
5442 * @param item gengrid item to remove a previously set tooltip from.
5444 * This call removes any tooltip set on @p item. The callback
5445 * provided as @c del_cb to
5446 * elm_gengrid_item_tooltip_content_cb_set() will be called to
5447 * notify it is not used anymore (and have resources cleaned, if
5450 * @see elm_gengrid_item_tooltip_content_cb_set()
5454 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5457 * Set a different @b style for a given gengrid item's tooltip.
5459 * @param item gengrid item with tooltip set
5460 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
5461 * "default", @c "transparent", etc)
5463 * Tooltips can have <b>alternate styles</b> to be displayed on,
5464 * which are defined by the theme set on Elementary. This function
5465 * works analogously as elm_object_tooltip_style_set(), but here
5466 * applied only to gengrid item objects. The default style for
5467 * tooltips is @c "default".
5469 * @note before you set a style you should define a tooltip with
5470 * elm_gengrid_item_tooltip_content_cb_set() or
5471 * elm_gengrid_item_tooltip_text_set()
5473 * @see elm_gengrid_item_tooltip_style_get()
5477 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5480 * Get the style set a given gengrid item's tooltip.
5482 * @param item gengrid item with tooltip already set on.
5483 * @return style the theme style in use, which defaults to
5484 * "default". If the object does not have a tooltip set,
5485 * then @c NULL is returned.
5487 * @see elm_gengrid_item_tooltip_style_set() for more details
5491 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5494 * Set the type of mouse pointer/cursor decoration to be shown,
5495 * when the mouse pointer is over the given gengrid widget item
5497 * @param item gengrid item to customize cursor on
5498 * @param cursor the cursor type's name
5500 * This function works analogously as elm_object_cursor_set(), but
5501 * here the cursor's changing area is restricted to the item's
5502 * area, and not the whole widget's. Note that that item cursors
5503 * have precedence over widget cursors, so that a mouse over @p
5504 * item will always show cursor @p type.
5506 * If this function is called twice for an object, a previously set
5507 * cursor will be unset on the second call.
5509 * @see elm_object_cursor_set()
5510 * @see elm_gengrid_item_cursor_get()
5511 * @see elm_gengrid_item_cursor_unset()
5515 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5518 * Get the type of mouse pointer/cursor decoration set to be shown,
5519 * when the mouse pointer is over the given gengrid widget item
5521 * @param item gengrid item with custom cursor set
5522 * @return the cursor type's name or @c NULL, if no custom cursors
5523 * were set to @p item (and on errors)
5525 * @see elm_object_cursor_get()
5526 * @see elm_gengrid_item_cursor_set() for more details
5527 * @see elm_gengrid_item_cursor_unset()
5531 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5534 * Unset any custom mouse pointer/cursor decoration set to be
5535 * shown, when the mouse pointer is over the given gengrid widget
5536 * item, thus making it show the @b default cursor again.
5538 * @param item a gengrid item
5540 * Use this call to undo any custom settings on this item's cursor
5541 * decoration, bringing it back to defaults (no custom style set).
5543 * @see elm_object_cursor_unset()
5544 * @see elm_gengrid_item_cursor_set() for more details
5548 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5551 * Set a different @b style for a given custom cursor set for a
5554 * @param item gengrid item with custom cursor set
5555 * @param style the <b>theme style</b> to use (e.g. @c "default",
5556 * @c "transparent", etc)
5558 * This function only makes sense when one is using custom mouse
5559 * cursor decorations <b>defined in a theme file</b> , which can
5560 * have, given a cursor name/type, <b>alternate styles</b> on
5561 * it. It works analogously as elm_object_cursor_style_set(), but
5562 * here applied only to gengrid item objects.
5564 * @warning Before you set a cursor style you should have defined a
5565 * custom cursor previously on the item, with
5566 * elm_gengrid_item_cursor_set()
5568 * @see elm_gengrid_item_cursor_engine_only_set()
5569 * @see elm_gengrid_item_cursor_style_get()
5573 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5576 * Get the current @b style set for a given gengrid item's custom
5579 * @param item gengrid item with custom cursor set.
5580 * @return style the cursor style in use. If the object does not
5581 * have a cursor set, then @c NULL is returned.
5583 * @see elm_gengrid_item_cursor_style_set() for more details
5587 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5590 * Set if the (custom) cursor for a given gengrid item should be
5591 * searched in its theme, also, or should only rely on the
5594 * @param item item with custom (custom) cursor already set on
5595 * @param engine_only Use @c EINA_TRUE to have cursors looked for
5596 * only on those provided by the rendering engine, @c EINA_FALSE to
5597 * have them searched on the widget's theme, as well.
5599 * @note This call is of use only if you've set a custom cursor
5600 * for gengrid items, with elm_gengrid_item_cursor_set().
5602 * @note By default, cursors will only be looked for between those
5603 * provided by the rendering engine.
5607 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5610 * Get if the (custom) cursor for a given gengrid item is being
5611 * searched in its theme, also, or is only relying on the rendering
5614 * @param item a gengrid item
5615 * @return @c EINA_TRUE, if cursors are being looked for only on
5616 * those provided by the rendering engine, @c EINA_FALSE if they
5617 * are being searched on the widget's theme, as well.
5619 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
5623 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5626 * Remove all items from a given gengrid widget
5628 * @param obj The gengrid object.
5630 * This removes (and deletes) all items in @p obj, leaving it
5633 * @see elm_gengrid_item_del(), to remove just one item.
5637 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5640 * Get the selected item in a given gengrid widget
5642 * @param obj The gengrid object.
5643 * @return The selected item's handleor @c NULL, if none is
5644 * selected at the moment (and on errors)
5646 * This returns the selected item in @p obj. If multi selection is
5647 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
5648 * the first item in the list is selected, which might not be very
5649 * useful. For that case, see elm_gengrid_selected_items_get().
5653 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5656 * Get <b>a list</b> of selected items in a given gengrid
5658 * @param obj The gengrid object.
5659 * @return The list of selected items or @c NULL, if none is
5660 * selected at the moment (and on errors)
5662 * This returns a list of the selected items, in the order that
5663 * they appear in the grid. This list is only valid as long as no
5664 * more items are selected or unselected (or unselected implictly
5665 * by deletion). The list contains #Elm_Gengrid_Item pointers as
5668 * @see @elm_gengrid_selected_item_get()
5672 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5675 * @defgroup Clock Clock
5677 * @image html img/widget/clock/preview-00.png
5678 * @image latex img/widget/clock/preview-00.eps
5680 * This is a @b digital clock widget. In its default theme, it has a
5681 * vintage "flipping numbers clock" appearance, which will animate
5682 * sheets of individual algarisms individually as time goes by.
5684 * A newly created clock will fetch system's time (already
5685 * considering local time adjustments) to start with, and will tick
5686 * accondingly. It may or may not show seconds.
5688 * Clocks have an @b edition mode. When in it, the sheets will
5689 * display extra arrow indications on the top and bottom and the
5690 * user may click on them to raise or lower the time values. After
5691 * it's told to exit edition mode, it will keep ticking with that
5692 * new time set (it keeps the difference from local time).
5694 * Also, when under edition mode, user clicks on the cited arrows
5695 * which are @b held for some time will make the clock to flip the
5696 * sheet, thus editing the time, continuosly and automatically for
5697 * the user. The interval between sheet flips will keep growing in
5698 * time, so that it helps the user to reach a time which is distant
5701 * The time display is, by default, in military mode (24h), but an
5702 * am/pm indicator may be optionally shown, too, when it will
5705 * Smart callbacks one can register to:
5706 * - "changed" - the clock's user changed the time
5708 * Here is an example on its usage:
5709 * @li @ref clock_example
5718 * Identifiers for which clock digits should be editable, when a
5719 * clock widget is in edition mode. Values may be ORed together to
5720 * make a mask, naturally.
5722 * @see elm_clock_edit_set()
5723 * @see elm_clock_digit_edit_set()
5725 typedef enum _Elm_Clock_Digedit
5727 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
5728 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
5729 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
5730 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
5731 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
5732 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
5733 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
5734 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
5735 } Elm_Clock_Digedit;
5738 * Add a new clock widget to the given parent Elementary
5739 * (container) object
5741 * @param parent The parent object
5742 * @return a new clock widget handle or @c NULL, on errors
5744 * This function inserts a new clock widget on the canvas.
5748 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5751 * Set a clock widget's time, programmatically
5753 * @param obj The clock widget object
5754 * @param hrs The hours to set
5755 * @param min The minutes to set
5756 * @param sec The secondes to set
5758 * This function updates the time that is showed by the clock
5761 * Values @b must be set within the following ranges:
5762 * - 0 - 23, for hours
5763 * - 0 - 59, for minutes
5764 * - 0 - 59, for seconds,
5766 * even if the clock is not in "military" mode.
5768 * @warning The behavior for values set out of those ranges is @b
5773 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
5776 * Get a clock widget's time values
5778 * @param obj The clock object
5779 * @param[out] hrs Pointer to the variable to get the hours value
5780 * @param[out] min Pointer to the variable to get the minutes value
5781 * @param[out] sec Pointer to the variable to get the seconds value
5783 * This function gets the time set for @p obj, returning
5784 * it on the variables passed as the arguments to function
5786 * @note Use @c NULL pointers on the time values you're not
5787 * interested in: they'll be ignored by the function.
5791 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
5794 * Set whether a given clock widget is under <b>edition mode</b> or
5795 * under (default) displaying-only mode.
5797 * @param obj The clock object
5798 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
5799 * put it back to "displaying only" mode
5801 * This function makes a clock's time to be editable or not <b>by
5802 * user interaction</b>. When in edition mode, clocks @b stop
5803 * ticking, until one brings them back to canonical mode. The
5804 * elm_clock_digit_edit_set() function will influence which digits
5805 * of the clock will be editable. By default, all of them will be
5806 * (#ELM_CLOCK_NONE).
5808 * @note am/pm sheets, if being shown, will @b always be editable
5809 * under edition mode.
5811 * @see elm_clock_edit_get()
5815 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5818 * Retrieve whether a given clock widget is under <b>edition
5819 * mode</b> or under (default) displaying-only mode.
5821 * @param obj The clock object
5822 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
5825 * This function retrieves whether the clock's time can be edited
5826 * or not by user interaction.
5828 * @see elm_clock_edit_set() for more details
5832 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835 * Set what digits of the given clock widget should be editable
5836 * when in edition mode.
5838 * @param obj The clock object
5839 * @param digedit Bit mask indicating the digits to be editable
5840 * (values in #Elm_Clock_Digedit).
5842 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
5843 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
5846 * @see elm_clock_digit_edit_get()
5850 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
5853 * Retrieve what digits of the given clock widget should be
5854 * editable when in edition mode.
5856 * @param obj The clock object
5857 * @return Bit mask indicating the digits to be editable
5858 * (values in #Elm_Clock_Digedit).
5860 * @see elm_clock_digit_edit_set() for more details
5864 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5867 * Set if the given clock widget must show hours in military or
5870 * @param obj The clock object
5871 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
5874 * This function sets if the clock must show hours in military or
5875 * am/pm mode. In some countries like Brazil the military mode
5876 * (00-24h-format) is used, in opposition to the USA, where the
5877 * am/pm mode is more commonly used.
5879 * @see elm_clock_show_am_pm_get()
5883 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
5886 * Get if the given clock widget shows hours in military or am/pm
5889 * @param obj The clock object
5890 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
5893 * This function gets if the clock shows hours in military or am/pm
5896 * @see elm_clock_show_am_pm_set() for more details
5900 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5903 * Set if the given clock widget must show time with seconds or not
5905 * @param obj The clock object
5906 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
5908 * This function sets if the given clock must show or not elapsed
5909 * seconds. By default, they are @b not shown.
5911 * @see elm_clock_show_seconds_get()
5915 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
5918 * Get whether the given clock widget is showing time with seconds
5921 * @param obj The clock object
5922 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
5924 * This function gets whether @p obj is showing or not the elapsed
5927 * @see elm_clock_show_seconds_set()
5931 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5934 * Set the interval on time updates for an user mouse button hold
5935 * on clock widgets' time edition.
5937 * @param obj The clock object
5938 * @param interval The (first) interval value in seconds
5940 * This interval value is @b decreased while the user holds the
5941 * mouse pointer either incrementing or decrementing a given the
5942 * clock digit's value.
5944 * This helps the user to get to a given time distant from the
5945 * current one easier/faster, as it will start to flip quicker and
5946 * quicker on mouse button holds.
5948 * The calculation for the next flip interval value, starting from
5949 * the one set with this call, is the previous interval divided by
5950 * 1.05, so it decreases a little bit.
5952 * The default starting interval value for automatic flips is
5955 * @see elm_clock_interval_get()
5959 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5962 * Get the interval on time updates for an user mouse button hold
5963 * on clock widgets' time edition.
5965 * @param obj The clock object
5966 * @return The (first) interval value, in seconds, set on it
5968 * @see elm_clock_interval_set() for more details
5972 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5979 * @defgroup Layout Layout
5981 * @image html img/widget/layout/preview-00.png
5982 * @image latex img/widget/layout/preview-00.eps width=\textwidth
5984 * @image html img/layout-predefined.png
5985 * @image latex img/layout-predefined.eps width=\textwidth
5987 * This is a container widget that takes a standard Edje design file and
5988 * wraps it very thinly in a widget.
5990 * An Edje design (theme) file has a very wide range of possibilities to
5991 * describe the behavior of elements added to the Layout. Check out the Edje
5992 * documentation and the EDC reference to get more information about what can
5993 * be done with Edje.
5995 * Just like @ref List, @ref Box, and other container widgets, any
5996 * object added to the Layout will become its child, meaning that it will be
5997 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
5999 * The Layout widget can contain as many Contents, Boxes or Tables as
6000 * described in its theme file. For instance, objects can be added to
6001 * different Tables by specifying the respective Table part names. The same
6002 * is valid for Content and Box.
6004 * The objects added as child of the Layout will behave as described in the
6005 * part description where they were added. There are 3 possible types of
6006 * parts where a child can be added:
6008 * @section secContent Content (SWALLOW part)
6010 * Only one object can be added to the @c SWALLOW part (but you still can
6011 * have many @c SWALLOW parts and one object on each of them). Use the @c
6012 * elm_layout_content_* set of functions to set, retrieve and unset objects
6013 * as content of the @c SWALLOW. After being set to this part, the object
6014 * size, position, visibility, clipping and other description properties
6015 * will be totally controled by the description of the given part (inside
6016 * the Edje theme file).
6018 * One can use @c evas_object_size_hint_* functions on the child to have some
6019 * kind of control over its behavior, but the resulting behavior will still
6020 * depend heavily on the @c SWALLOW part description.
6022 * The Edje theme also can change the part description, based on signals or
6023 * scripts running inside the theme. This change can also be animated. All of
6024 * this will affect the child object set as content accordingly. The object
6025 * size will be changed if the part size is changed, it will animate move if
6026 * the part is moving, and so on.
6028 * The following picture demonstrates a Layout widget with a child object
6029 * added to its @c SWALLOW:
6031 * @image html layout_swallow.png
6032 * @image latex layout_swallow.png width=\textwidth
6034 * @section secBox Box (BOX part)
6036 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
6037 * allows one to add objects to the box and have them distributed along its
6038 * area, accordingly to the specified @a layout property (now by @a layout we
6039 * mean the chosen layouting design of the Box, not the Layout widget
6042 * A similar effect for having a box with its position, size and other things
6043 * controled by the Layout theme would be to create an Elementary @ref Box
6044 * widget and add it as a Content in the @c SWALLOW part.
6046 * The main difference of using the Layout Box is that its behavior, the box
6047 * properties like layouting format, padding, align, etc. will be all
6048 * controled by the theme. This means, for example, that a signal could be
6049 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
6050 * handled the signal by changing the box padding, or align, or both. Using
6051 * the Elementary @ref Box widget is not necessarily harder or easier, it
6052 * just depends on the circunstances and requirements.
6054 * The Layout Box can be used through the @c elm_layout_box_* set of
6057 * The following picture demonstrates a Layout widget with many child objects
6058 * added to its @c BOX part:
6060 * @image html layout_box.png
6061 * @image latex layout_box.png width=\textwidth
6063 * @section secTable Table (TABLE part)
6065 * Just like the @ref secBox, the Layout Table is very similar to the
6066 * Elementary @ref Table widget. It allows one to add objects to the Table
6067 * specifying the row and column where the object should be added, and any
6068 * column or row span if necessary.
6070 * Again, we could have this design by adding a @ref Table widget to the @c
6071 * SWALLOW part using elm_layout_content_set(). The same difference happens
6072 * here when choosing to use the Layout Table (a @c TABLE part) instead of
6073 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
6075 * The Layout Table can be used through the @c elm_layout_table_* set of
6078 * The following picture demonstrates a Layout widget with many child objects
6079 * added to its @c TABLE part:
6081 * @image html layout_table.png
6082 * @image latex layout_table.png width=\textwidth
6084 * @section secPredef Predefined Layouts
6086 * Another interesting thing about the Layout widget is that it offers some
6087 * predefined themes that come with the default Elementary theme. These
6088 * themes can be set by the call elm_layout_theme_set(), and provide some
6089 * basic functionality depending on the theme used.
6091 * Most of them already send some signals, some already provide a toolbar or
6092 * back and next buttons.
6094 * These are available predefined theme layouts. All of them have class = @c
6095 * layout, group = @c application, and style = one of the following options:
6097 * @li @c toolbar-content - application with toolbar and main content area
6098 * @li @c toolbar-content-back - application with toolbar and main content
6099 * area with a back button and title area
6100 * @li @c toolbar-content-back-next - application with toolbar and main
6101 * content area with a back and next buttons and title area
6102 * @li @c content-back - application with a main content area with a back
6103 * button and title area
6104 * @li @c content-back-next - application with a main content area with a
6105 * back and next buttons and title area
6106 * @li @c toolbar-vbox - application with toolbar and main content area as a
6108 * @li @c toolbar-table - application with toolbar and main content area as a
6111 * @section secExamples Examples
6113 * Some examples of the Layout widget can be found here:
6114 * @li @ref layout_example_01
6115 * @li @ref layout_example_02
6116 * @li @ref layout_example_03
6117 * @li @ref layout_example_edc
6122 * Add a new layout to the parent
6124 * @param parent The parent object
6125 * @return The new object or NULL if it cannot be created
6127 * @see elm_layout_file_set()
6128 * @see elm_layout_theme_set()
6132 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6134 * Set the file that will be used as layout
6136 * @param obj The layout object
6137 * @param file The path to file (edj) that will be used as layout
6138 * @param group The group that the layout belongs in edje file
6140 * @return (1 = success, 0 = error)
6144 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
6146 * Set the edje group from the elementary theme that will be used as layout
6148 * @param obj The layout object
6149 * @param clas the clas of the group
6150 * @param group the group
6151 * @param style the style to used
6153 * @return (1 = success, 0 = error)
6157 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
6159 * Set the layout content.
6161 * @param obj The layout object
6162 * @param swallow The swallow part name in the edje file
6163 * @param content The child that will be added in this layout object
6165 * Once the content object is set, a previously set one will be deleted.
6166 * If you want to keep that old content object, use the
6167 * elm_layout_content_unset() function.
6169 * @note In an Edje theme, the part used as a content container is called @c
6170 * SWALLOW. This is why the parameter name is called @p swallow, but it is
6171 * expected to be a part name just like the second parameter of
6172 * elm_layout_box_append().
6174 * @see elm_layout_box_append()
6175 * @see elm_layout_content_get()
6176 * @see elm_layout_content_unset()
6181 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6183 * Get the child object in the given content part.
6185 * @param obj The layout object
6186 * @param swallow The SWALLOW part to get its content
6188 * @return The swallowed object or NULL if none or an error occurred
6190 * @see elm_layout_content_set()
6194 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6196 * Unset the layout content.
6198 * @param obj The layout object
6199 * @param swallow The swallow part name in the edje file
6200 * @return The content that was being used
6202 * Unparent and return the content object which was set for this part.
6204 * @see elm_layout_content_set()
6208 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6210 * Set the text of the given part
6212 * @param obj The layout object
6213 * @param part The TEXT part where to set the text
6214 * @param text The text to set
6217 * @deprecated use elm_object_text_* instead.
6219 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
6221 * Get the text set in the given part
6223 * @param obj The layout object
6224 * @param part The TEXT part to retrieve the text off
6226 * @return The text set in @p part
6229 * @deprecated use elm_object_text_* instead.
6231 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
6233 * Append child to layout box part.
6235 * @param obj the layout object
6236 * @param part the box part to which the object will be appended.
6237 * @param child the child object to append to box.
6239 * Once the object is appended, it will become child of the layout. Its
6240 * lifetime will be bound to the layout, whenever the layout dies the child
6241 * will be deleted automatically. One should use elm_layout_box_remove() to
6242 * make this layout forget about the object.
6244 * @see elm_layout_box_prepend()
6245 * @see elm_layout_box_insert_before()
6246 * @see elm_layout_box_insert_at()
6247 * @see elm_layout_box_remove()
6251 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6253 * Prepend child to layout box part.
6255 * @param obj the layout object
6256 * @param part the box part to prepend.
6257 * @param child the child object to prepend to box.
6259 * Once the object is prepended, it will become child of the layout. Its
6260 * lifetime will be bound to the layout, whenever the layout dies the child
6261 * will be deleted automatically. One should use elm_layout_box_remove() to
6262 * make this layout forget about the object.
6264 * @see elm_layout_box_append()
6265 * @see elm_layout_box_insert_before()
6266 * @see elm_layout_box_insert_at()
6267 * @see elm_layout_box_remove()
6271 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6273 * Insert child to layout box part before a reference object.
6275 * @param obj the layout object
6276 * @param part the box part to insert.
6277 * @param child the child object to insert into box.
6278 * @param reference another reference object to insert before in box.
6280 * Once the object is inserted, it will become child of the layout. Its
6281 * lifetime will be bound to the layout, whenever the layout dies the child
6282 * will be deleted automatically. One should use elm_layout_box_remove() to
6283 * make this layout forget about the object.
6285 * @see elm_layout_box_append()
6286 * @see elm_layout_box_prepend()
6287 * @see elm_layout_box_insert_before()
6288 * @see elm_layout_box_remove()
6292 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
6294 * Insert child to layout box part at a given position.
6296 * @param obj the layout object
6297 * @param part the box part to insert.
6298 * @param child the child object to insert into box.
6299 * @param pos the numeric position >=0 to insert the child.
6301 * Once the object is inserted, it will become child of the layout. Its
6302 * lifetime will be bound to the layout, whenever the layout dies the child
6303 * will be deleted automatically. One should use elm_layout_box_remove() to
6304 * make this layout forget about the object.
6306 * @see elm_layout_box_append()
6307 * @see elm_layout_box_prepend()
6308 * @see elm_layout_box_insert_before()
6309 * @see elm_layout_box_remove()
6313 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
6315 * Remove a child of the given part box.
6317 * @param obj The layout object
6318 * @param part The box part name to remove child.
6319 * @param child The object to remove from box.
6320 * @return The object that was being used, or NULL if not found.
6322 * The object will be removed from the box part and its lifetime will
6323 * not be handled by the layout anymore. This is equivalent to
6324 * elm_layout_content_unset() for box.
6326 * @see elm_layout_box_append()
6327 * @see elm_layout_box_remove_all()
6331 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
6333 * Remove all child of the given part box.
6335 * @param obj The layout object
6336 * @param part The box part name to remove child.
6337 * @param clear If EINA_TRUE, then all objects will be deleted as
6338 * well, otherwise they will just be removed and will be
6339 * dangling on the canvas.
6341 * The objects will be removed from the box part and their lifetime will
6342 * not be handled by the layout anymore. This is equivalent to
6343 * elm_layout_box_remove() for all box children.
6345 * @see elm_layout_box_append()
6346 * @see elm_layout_box_remove()
6350 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6352 * Insert child to layout table part.
6354 * @param obj the layout object
6355 * @param part the box part to pack child.
6356 * @param child_obj the child object to pack into table.
6357 * @param col the column to which the child should be added. (>= 0)
6358 * @param row the row to which the child should be added. (>= 0)
6359 * @param colspan how many columns should be used to store this object. (>=
6361 * @param rowspan how many rows should be used to store this object. (>= 1)
6363 * Once the object is inserted, it will become child of the table. Its
6364 * lifetime will be bound to the layout, and whenever the layout dies the
6365 * child will be deleted automatically. One should use
6366 * elm_layout_table_remove() to make this layout forget about the object.
6368 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
6369 * more space than a single cell. For instance, the following code:
6371 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
6374 * Would result in an object being added like the following picture:
6376 * @image html layout_colspan.png
6377 * @image latex layout_colspan.eps width=\textwidth
6379 * @see elm_layout_table_unpack()
6380 * @see elm_layout_table_clear()
6384 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);
6386 * Unpack (remove) a child of the given part table.
6388 * @param obj The layout object
6389 * @param part The table part name to remove child.
6390 * @param child_obj The object to remove from table.
6391 * @return The object that was being used, or NULL if not found.
6393 * The object will be unpacked from the table part and its lifetime
6394 * will not be handled by the layout anymore. This is equivalent to
6395 * elm_layout_content_unset() for table.
6397 * @see elm_layout_table_pack()
6398 * @see elm_layout_table_clear()
6402 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
6404 * Remove all child of the given part table.
6406 * @param obj The layout object
6407 * @param part The table part name to remove child.
6408 * @param clear If EINA_TRUE, then all objects will be deleted as
6409 * well, otherwise they will just be removed and will be
6410 * dangling on the canvas.
6412 * The objects will be removed from the table part and their lifetime will
6413 * not be handled by the layout anymore. This is equivalent to
6414 * elm_layout_table_unpack() for all table children.
6416 * @see elm_layout_table_pack()
6417 * @see elm_layout_table_unpack()
6421 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6423 * Get the edje layout
6425 * @param obj The layout object
6427 * @return A Evas_Object with the edje layout settings loaded
6428 * with function elm_layout_file_set
6430 * This returns the edje object. It is not expected to be used to then
6431 * swallow objects via edje_object_part_swallow() for example. Use
6432 * elm_layout_content_set() instead so child object handling and sizing is
6435 * @note This function should only be used if you really need to call some
6436 * low level Edje function on this edje object. All the common stuff (setting
6437 * text, emitting signals, hooking callbacks to signals, etc.) can be done
6438 * with proper elementary functions.
6440 * @see elm_object_signal_callback_add()
6441 * @see elm_object_signal_emit()
6442 * @see elm_object_text_part_set()
6443 * @see elm_layout_content_set()
6444 * @see elm_layout_box_append()
6445 * @see elm_layout_table_pack()
6446 * @see elm_layout_data_get()
6450 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6452 * Get the edje data from the given layout
6454 * @param obj The layout object
6455 * @param key The data key
6457 * @return The edje data string
6459 * This function fetches data specified inside the edje theme of this layout.
6460 * This function return NULL if data is not found.
6462 * In EDC this comes from a data block within the group block that @p
6463 * obj was loaded from. E.g.
6470 * item: "key1" "value1";
6471 * item: "key2" "value2";
6479 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
6483 * @param obj The layout object
6485 * Manually forces a sizing re-evaluation. This is useful when the minimum
6486 * size required by the edje theme of this layout has changed. The change on
6487 * the minimum size required by the edje theme is not immediately reported to
6488 * the elementary layout, so one needs to call this function in order to tell
6489 * the widget (layout) that it needs to reevaluate its own size.
6491 * The minimum size of the theme is calculated based on minimum size of
6492 * parts, the size of elements inside containers like box and table, etc. All
6493 * of this can change due to state changes, and that's when this function
6496 * Also note that a standard signal of "size,eval" "elm" emitted from the
6497 * edje object will cause this to happen too.
6501 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
6502 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
6503 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6504 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6505 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
6506 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6507 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);
6508 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6510 * @def elm_layout_icon_set
6511 * Convienience macro to set the icon object in a layout that follows the
6512 * Elementary naming convention for its parts.
6516 #define elm_layout_icon_set(_ly, _obj) \
6519 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
6520 if ((_obj)) sig = "elm,state,icon,visible"; \
6521 else sig = "elm,state,icon,hidden"; \
6522 elm_object_signal_emit((_ly), sig, "elm"); \
6526 * @def elm_layout_icon_get
6527 * Convienience macro to get the icon object from a layout that follows the
6528 * Elementary naming convention for its parts.
6532 #define elm_layout_icon_get(_ly) \
6533 elm_layout_content_get((_ly), "elm.swallow.icon")
6536 * @def elm_layout_end_set
6537 * Convienience macro to set the end object in a layout that follows the
6538 * Elementary naming convention for its parts.
6542 #define elm_layout_end_set(_ly, _obj) \
6545 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
6546 if ((_obj)) sig = "elm,state,end,visible"; \
6547 else sig = "elm,state,end,hidden"; \
6548 elm_object_signal_emit((_ly), sig, "elm"); \
6552 * @def elm_layout_end_get
6553 * Convienience macro to get the end object in a layout that follows the
6554 * Elementary naming convention for its parts.
6558 #define elm_layout_end_get(_ly) \
6559 elm_layout_content_get((_ly), "elm.swallow.end")
6562 * @def elm_layout_label_set
6563 * Convienience macro to set the label in a layout that follows the
6564 * Elementary naming convention for its parts.
6567 * @deprecate use elm_object_text_* instead.
6569 #define elm_layout_label_set(_ly, _txt) \
6570 elm_layout_text_set((_ly), "elm.text", (_txt))
6573 * @def elm_layout_label_get
6574 * Convienience macro to get the label in a layout that follows the
6575 * Elementary naming convention for its parts.
6578 * @deprecate use elm_object_text_* instead.
6580 #define elm_layout_label_get(_ly) \
6581 elm_layout_text_get((_ly), "elm.text")
6583 /* smart callbacks called:
6584 * "theme,changed" - when elm theme is changed.
6588 typedef enum _Elm_Notify_Orient
6590 ELM_NOTIFY_ORIENT_TOP,
6591 ELM_NOTIFY_ORIENT_CENTER,
6592 ELM_NOTIFY_ORIENT_BOTTOM,
6593 ELM_NOTIFY_ORIENT_LEFT,
6594 ELM_NOTIFY_ORIENT_RIGHT,
6595 ELM_NOTIFY_ORIENT_TOP_LEFT,
6596 ELM_NOTIFY_ORIENT_TOP_RIGHT,
6597 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
6598 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
6599 ELM_NOTIFY_ORIENT_LAST
6600 } Elm_Notify_Orient;
6601 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6602 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6603 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6604 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6605 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6606 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6607 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
6608 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6609 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6610 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6611 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
6612 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6613 /* smart callbacks called:
6614 * "timeout" - when timeout happens on notify and it's hidden
6615 * "block,clicked" - when it's hidden by a click outside of the notify's view
6619 * @defgroup Hover Hover
6621 * @image html img/widget/hover/preview-00.png
6622 * @image latex img/widget/hover/preview-00.eps
6624 * A Hover object will hover over its @p parent object at the @p target
6625 * location. Anything in the background will be given a darker coloring to
6626 * indicate that the hover object is on top (at the default theme). When the
6627 * hover is clicked it is dismissed(hidden), if the contents of the hover are
6628 * clicked that @b doesn't cause the hover to be dismissed.
6630 * @note The hover object will take up the entire space of @p target
6633 * Elementary has the following styles for the hover widget:
6637 * @li hoversel_vertical
6639 * The following are the available position for content:
6651 * Signals that you can add callbacks for are:
6652 * @li "clicked" - the user clicked the empty space in the hover to dismiss
6653 * @li "smart,changed" - a content object placed under the "smart"
6654 * policy was replaced to a new slot direction.
6656 * See @ref tutorial_hover for more information.
6660 typedef enum _Elm_Hover_Axis
6662 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
6663 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
6664 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
6665 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
6668 * @brief Adds a hover object to @p parent
6670 * @param parent The parent object
6671 * @return The hover object or NULL if one could not be created
6673 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6675 * @brief Sets the target object for the hover.
6677 * @param obj The hover object
6678 * @param target The object to center the hover onto. The hover
6680 * This function will cause the hover to be centered on the target object.
6682 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
6684 * @brief Gets the target object for the hover.
6686 * @param obj The hover object
6687 * @param parent The object to locate the hover over.
6689 * @see elm_hover_target_set()
6691 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6693 * @brief Sets the parent object for the hover.
6695 * @param obj The hover object
6696 * @param parent The object to locate the hover over.
6698 * This function will cause the hover to take up the entire space that the
6699 * parent object fills.
6701 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6703 * @brief Gets the parent object for the hover.
6705 * @param obj The hover object
6706 * @return The parent object to locate the hover over.
6708 * @see elm_hover_parent_set()
6710 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6712 * @brief Sets the content of the hover object and the direction in which it
6715 * @param obj The hover object
6716 * @param swallow The direction that the object will be displayed
6717 * at. Accepted values are "left", "top-left", "top", "top-right",
6718 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
6720 * @param content The content to place at @p swallow
6722 * Once the content object is set for a given direction, a previously
6723 * set one (on the same direction) will be deleted. If you want to
6724 * keep that old content object, use the elm_hover_content_unset()
6727 * All directions may have contents at the same time, except for
6728 * "smart". This is a special placement hint and its use case
6729 * independs of the calculations coming from
6730 * elm_hover_best_content_location_get(). Its use is for cases when
6731 * one desires only one hover content, but with a dinamic special
6732 * placement within the hover area. The content's geometry, whenever
6733 * it changes, will be used to decide on a best location not
6734 * extrapolating the hover's parent object view to show it in (still
6735 * being the hover's target determinant of its medium part -- move and
6736 * resize it to simulate finger sizes, for example). If one of the
6737 * directions other than "smart" are used, a previously content set
6738 * using it will be deleted, and vice-versa.
6740 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6742 * @brief Get the content of the hover object, in a given direction.
6744 * Return the content object which was set for this widget in the
6745 * @p swallow direction.
6747 * @param obj The hover object
6748 * @param swallow The direction that the object was display at.
6749 * @return The content that was being used
6751 * @see elm_hover_content_set()
6753 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6755 * @brief Unset the content of the hover object, in a given direction.
6757 * Unparent and return the content object set at @p swallow direction.
6759 * @param obj The hover object
6760 * @param swallow The direction that the object was display at.
6761 * @return The content that was being used.
6763 * @see elm_hover_content_set()
6765 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6767 * @brief Returns the best swallow location for content in the hover.
6769 * @param obj The hover object
6770 * @param pref_axis The preferred orientation axis for the hover object to use
6771 * @return The edje location to place content into the hover or @c
6774 * Best is defined here as the location at which there is the most available
6777 * @p pref_axis may be one of
6778 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
6779 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
6780 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
6781 * - @c ELM_HOVER_AXIS_BOTH -- both
6783 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
6784 * nescessarily be along the horizontal axis("left" or "right"). If
6785 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
6786 * be along the vertical axis("top" or "bottom"). Chossing
6787 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
6788 * returned position may be in either axis.
6790 * @see elm_hover_content_set()
6792 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
6799 * @defgroup Entry Entry
6801 * @image html img/widget/entry/preview-00.png
6802 * @image latex img/widget/entry/preview-00.eps width=\textwidth
6803 * @image html img/widget/entry/preview-01.png
6804 * @image latex img/widget/entry/preview-01.eps width=\textwidth
6805 * @image html img/widget/entry/preview-02.png
6806 * @image latex img/widget/entry/preview-02.eps width=\textwidth
6807 * @image html img/widget/entry/preview-03.png
6808 * @image latex img/widget/entry/preview-03.eps width=\textwidth
6810 * An entry is a convenience widget which shows a box that the user can
6811 * enter text into. Entries by default don't scroll, so they grow to
6812 * accomodate the entire text, resizing the parent window as needed. This
6813 * can be changed with the elm_entry_scrollable_set() function.
6815 * They can also be single line or multi line (the default) and when set
6816 * to multi line mode they support text wrapping in any of the modes
6817 * indicated by #Elm_Wrap_Type.
6819 * Other features include password mode, filtering of inserted text with
6820 * elm_entry_text_filter_append() and related functions, inline "items" and
6821 * formatted markup text.
6823 * @section entry-markup Formatted text
6825 * The markup tags supported by the Entry are defined by the theme, but
6826 * even when writing new themes or extensions it's a good idea to stick to
6827 * a sane default, to maintain coherency and avoid application breakages.
6828 * Currently defined by the default theme are the following tags:
6829 * @li \<br\>: Inserts a line break.
6830 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
6832 * @li \<tab\>: Inserts a tab.
6833 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
6835 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
6836 * @li \<link\>...\</link\>: Underlines the enclosed text.
6837 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
6839 * @section entry-special Special markups
6841 * Besides those used to format text, entries support two special markup
6842 * tags used to insert clickable portions of text or items inlined within
6845 * @subsection entry-anchors Anchors
6847 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
6848 * \</a\> tags and an event will be generated when this text is clicked,
6852 * This text is outside <a href=anc-01>but this one is an anchor</a>
6855 * The @c href attribute in the opening tag gives the name that will be
6856 * used to identify the anchor and it can be any valid utf8 string.
6858 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
6859 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
6860 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
6861 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
6864 * @subsection entry-items Items
6866 * Inlined in the text, any other @c Evas_Object can be inserted by using
6867 * \<item\> tags this way:
6870 * <item size=16x16 vsize=full href=emoticon/haha></item>
6873 * Just like with anchors, the @c href identifies each item, but these need,
6874 * in addition, to indicate their size, which is done using any one of
6875 * @c size, @c absize or @c relsize attributes. These attributes take their
6876 * value in the WxH format, where W is the width and H the height of the
6879 * @li absize: Absolute pixel size for the item. Whatever value is set will
6880 * be the item's size regardless of any scale value the object may have
6881 * been set to. The final line height will be adjusted to fit larger items.
6882 * @li size: Similar to @c absize, but it's adjusted to the scale value set
6884 * @li relsize: Size is adjusted for the item to fit within the current
6887 * Besides their size, items are specificed a @c vsize value that affects
6888 * how their final size and position are calculated. The possible values
6890 * @li ascent: Item will be placed within the line's baseline and its
6891 * ascent. That is, the height between the line where all characters are
6892 * positioned and the highest point in the line. For @c size and @c absize
6893 * items, the descent value will be added to the total line height to make
6894 * them fit. @c relsize items will be adjusted to fit within this space.
6895 * @li full: Items will be placed between the descent and ascent, or the
6896 * lowest point in the line and its highest.
6898 * After the size for an item is calculated, the entry will request an
6899 * object to place in its space. For this, the functions set with
6900 * elm_entry_item_provider_append() and related functions will be called
6901 * in order until one of them returns a @c non-NULL value. If no providers
6902 * are available, or all of them return @c NULL, then the entry falls back
6903 * to one of the internal defaults, provided the name matches with one of
6906 * All of the following are currently supported:
6909 * - emoticon/angry-shout
6910 * - emoticon/crazy-laugh
6911 * - emoticon/evil-laugh
6913 * - emoticon/goggle-smile
6915 * - emoticon/grumpy-smile
6917 * - emoticon/guilty-smile
6919 * - emoticon/half-smile
6920 * - emoticon/happy-panting
6922 * - emoticon/indifferent
6924 * - emoticon/knowing-grin
6926 * - emoticon/little-bit-sorry
6927 * - emoticon/love-lots
6929 * - emoticon/minimal-smile
6930 * - emoticon/not-happy
6931 * - emoticon/not-impressed
6933 * - emoticon/opensmile
6936 * - emoticon/squint-laugh
6937 * - emoticon/surprised
6938 * - emoticon/suspicious
6939 * - emoticon/tongue-dangling
6940 * - emoticon/tongue-poke
6942 * - emoticon/unhappy
6943 * - emoticon/very-sorry
6946 * - emoticon/worried
6949 * Alternatively, an item may reference an image by its path, using
6950 * the URI form @c file:///path/to/an/image.png and the entry will then
6951 * use that image for the item.
6953 * @section entry-files Loading and saving files
6955 * Entries have convinience functions to load text from a file and save
6956 * changes back to it after a short delay. The automatic saving is enabled
6957 * by default, but can be disabled with elm_entry_autosave_set() and files
6958 * can be loaded directly as plain text or have any markup in them
6959 * recognized. See elm_entry_file_set() for more details.
6961 * @section entry-signals Emitted signals
6963 * This widget emits the following signals:
6965 * @li "changed": The text within the entry was changed.
6966 * @li "activated": The enter key was pressed on a single line entry.
6967 * @li "press": A mouse button has been pressed on the entry.
6968 * @li "longpressed": A mouse button has been pressed and held for a couple
6970 * @li "clicked": The entry has been clicked (mouse press and release).
6971 * @li "clicked,double": The entry has been double clicked.
6972 * @li "clicked,triple": The entry has been triple clicked.
6973 * @li "focused": The entry has received focus.
6974 * @li "unfocused": The entry has lost focus.
6975 * @li "selection,paste": A paste of the clipboard contents was requested.
6976 * @li "selection,copy": A copy of the selected text into the clipboard was
6978 * @li "selection,cut": A cut of the selected text into the clipboard was
6980 * @li "selection,start": A selection has begun and no previous selection
6982 * @li "selection,changed": The current selection has changed.
6983 * @li "selection,cleared": The current selection has been cleared.
6984 * @li "cursor,changed": The cursor has changed position.
6985 * @li "anchor,clicked": An anchor has been clicked. The event_info
6986 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6987 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
6988 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6989 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
6990 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6991 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
6992 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6993 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
6994 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
6995 * @li "preedit,changed": The preedit string has changed.
7000 * @typedef Elm_Entry_Anchor_Info
7002 * The info sent in the callback for the "anchor,clicked" signals emitted
7005 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
7007 * @struct _Elm_Entry_Anchor_Info
7009 * The info sent in the callback for the "anchor,clicked" signals emitted
7012 struct _Elm_Entry_Anchor_Info
7014 const char *name; /**< The name of the anchor, as stated in its href */
7015 int button; /**< The mouse button used to click on it */
7016 Evas_Coord x, /**< Anchor geometry, relative to canvas */
7017 y, /**< Anchor geometry, relative to canvas */
7018 w, /**< Anchor geometry, relative to canvas */
7019 h; /**< Anchor geometry, relative to canvas */
7022 * @typedef Elm_Entry_Filter_Cb
7023 * This callback type is used by entry filters to modify text.
7024 * @param data The data specified as the last param when adding the filter
7025 * @param entry The entry object
7026 * @param text A pointer to the location of the text being filtered. This data can be modified,
7027 * but any additional allocations must be managed by the user.
7028 * @see elm_entry_text_filter_append
7029 * @see elm_entry_text_filter_prepend
7031 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
7034 * This adds an entry to @p parent object.
7036 * By default, entries are:
7040 * @li autosave is enabled
7042 * @param parent The parent object
7043 * @return The new object or NULL if it cannot be created
7045 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7047 * Sets the entry to single line mode.
7049 * In single line mode, entries don't ever wrap when the text reaches the
7050 * edge, and instead they keep growing horizontally. Pressing the @c Enter
7051 * key will generate an @c "activate" event instead of adding a new line.
7053 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
7054 * and pressing enter will break the text into a different line
7055 * without generating any events.
7057 * @param obj The entry object
7058 * @param single_line If true, the text in the entry
7059 * will be on a single line.
7061 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
7063 * Gets whether the entry is set to be single line.
7065 * @param obj The entry object
7066 * @return single_line If true, the text in the entry is set to display
7069 * @see elm_entry_single_line_set()
7071 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7073 * Sets the entry to password mode.
7075 * In password mode, entries are implicitly single line and the display of
7076 * any text in them is replaced with asterisks (*).
7078 * @param obj The entry object
7079 * @param password If true, password mode is enabled.
7081 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
7083 * Gets whether the entry is set to password mode.
7085 * @param obj The entry object
7086 * @return If true, the entry is set to display all characters
7089 * @see elm_entry_password_set()
7091 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7093 * This sets the text displayed within the entry to @p entry.
7095 * @param obj The entry object
7096 * @param entry The text to be displayed
7098 * @deprecated Use elm_object_text_set() instead.
7100 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7102 * This returns the text currently shown in object @p entry.
7103 * See also elm_entry_entry_set().
7105 * @param obj The entry object
7106 * @return The currently displayed text or NULL on failure
7108 * @deprecated Use elm_object_text_get() instead.
7110 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7112 * Appends @p entry to the text of the entry.
7114 * Adds the text in @p entry to the end of any text already present in the
7117 * The appended text is subject to any filters set for the widget.
7119 * @param obj The entry object
7120 * @param entry The text to be displayed
7122 * @see elm_entry_text_filter_append()
7124 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7126 * Gets whether the entry is empty.
7128 * Empty means no text at all. If there are any markup tags, like an item
7129 * tag for which no provider finds anything, and no text is displayed, this
7130 * function still returns EINA_FALSE.
7132 * @param obj The entry object
7133 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
7135 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7137 * Gets any selected text within the entry.
7139 * If there's any selected text in the entry, this function returns it as
7140 * a string in markup format. NULL is returned if no selection exists or
7141 * if an error occurred.
7143 * The returned value points to an internal string and should not be freed
7144 * or modified in any way. If the @p entry object is deleted or its
7145 * contents are changed, the returned pointer should be considered invalid.
7147 * @param obj The entry object
7148 * @return The selected text within the entry or NULL on failure
7150 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7152 * Inserts the given text into the entry at the current cursor position.
7154 * This inserts text at the cursor position as if it was typed
7155 * by the user (note that this also allows markup which a user
7156 * can't just "type" as it would be converted to escaped text, so this
7157 * call can be used to insert things like emoticon items or bold push/pop
7158 * tags, other font and color change tags etc.)
7160 * If any selection exists, it will be replaced by the inserted text.
7162 * The inserted text is subject to any filters set for the widget.
7164 * @param obj The entry object
7165 * @param entry The text to insert
7167 * @see elm_entry_text_filter_append()
7169 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
7171 * Set the line wrap type to use on multi-line entries.
7173 * Sets the wrap type used by the entry to any of the specified in
7174 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
7175 * line (without inserting a line break or paragraph separator) when it
7176 * reaches the far edge of the widget.
7178 * Note that this only makes sense for multi-line entries. A widget set
7179 * to be single line will never wrap.
7181 * @param obj The entry object
7182 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
7184 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7186 * Gets the wrap mode the entry was set to use.
7188 * @param obj The entry object
7191 * @see also elm_entry_line_wrap_set()
7193 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7195 * Sets if the entry is to be editable or not.
7197 * By default, entries are editable and when focused, any text input by the
7198 * user will be inserted at the current cursor position. But calling this
7199 * function with @p editable as EINA_FALSE will prevent the user from
7200 * inputting text into the entry.
7202 * The only way to change the text of a non-editable entry is to use
7203 * elm_object_text_set(), elm_entry_entry_insert() and other related
7206 * @param obj The entry object
7207 * @param editable If EINA_TRUE, user input will be inserted in the entry,
7208 * if not, the entry is read-only and no user input is allowed.
7210 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
7212 * Gets whether the entry is editable or not.
7214 * @param obj The entry object
7215 * @return If true, the entry is editable by the user.
7216 * If false, it is not editable by the user
7218 * @see elm_entry_editable_set()
7220 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7222 * This drops any existing text selection within the entry.
7224 * @param obj The entry object
7226 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
7228 * This selects all text within the entry.
7230 * @param obj The entry object
7232 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
7234 * This moves the cursor one place to the right within the entry.
7236 * @param obj The entry object
7237 * @return EINA_TRUE upon success, EINA_FALSE upon failure
7239 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
7241 * This moves the cursor one place to the left within the entry.
7243 * @param obj The entry object
7244 * @return EINA_TRUE upon success, EINA_FALSE upon failure
7246 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
7248 * This moves the cursor one line up within the entry.
7250 * @param obj The entry object
7251 * @return EINA_TRUE upon success, EINA_FALSE upon failure
7253 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
7255 * This moves the cursor one line down within the entry.
7257 * @param obj The entry object
7258 * @return EINA_TRUE upon success, EINA_FALSE upon failure
7260 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
7262 * This moves the cursor to the beginning of the entry.
7264 * @param obj The entry object
7266 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7268 * This moves the cursor to the end of the entry.
7270 * @param obj The entry object
7272 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7274 * This moves the cursor to the beginning of the current line.
7276 * @param obj The entry object
7278 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7280 * This moves the cursor to the end of the current line.
7282 * @param obj The entry object
7284 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
7286 * This begins a selection within the entry as though
7287 * the user were holding down the mouse button to make a selection.
7289 * @param obj The entry object
7291 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
7293 * This ends a selection within the entry as though
7294 * the user had just released the mouse button while making a selection.
7296 * @param obj The entry object
7298 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
7300 * TODO: fill this in
7302 * @param obj The entry object
7303 * @return TODO: fill this in
7305 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7307 * This returns whether the cursor is visible.
7309 * @param obj The entry object
7310 * @return If true, the cursor is visible.
7312 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7314 * TODO: fill this in
7316 * @param obj The entry object
7317 * @return TODO: fill this in
7319 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7321 * This function returns the geometry of the cursor.
7323 * It's useful if you want to draw something on the cursor (or where it is),
7324 * or for example in the case of scrolled entry where you want to show the
7327 * @param obj The entry object
7328 * @param x returned geometry
7329 * @param y returned geometry
7330 * @param w returned geometry
7331 * @param h returned geometry
7332 * @return EINA_TRUE upon success, EINA_FALSE upon failure
7334 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);
7336 * Sets the cursor position in the entry to the given value
7338 * @param obj The entry object
7339 * @param pos The position of the cursor
7341 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7343 * Retrieves the current position of the cursor in the entry
7345 * @param obj The entry object
7346 * @return The cursor position
7348 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7350 * This executes a "cut" action on the selected text in the entry.
7352 * @param obj The entry object
7354 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
7356 * This executes a "copy" action on the selected text in the entry.
7358 * @param obj The entry object
7360 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
7362 * This executes a "paste" action in the entry.
7364 * @param obj The entry object
7366 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
7368 * This clears and frees the items in a entry's contextual (longpress)
7371 * @param obj The entry object
7373 * @see elm_entry_context_menu_item_add()
7375 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7377 * This adds an item to the entry's contextual menu.
7379 * A longpress on an entry will make the contextual menu show up, if this
7380 * hasn't been disabled with elm_entry_context_menu_disabled_set().
7381 * By default, this menu provides a few options like enabling selection mode,
7382 * which is useful on embedded devices that need to be explicit about it,
7383 * and when a selection exists it also shows the copy and cut actions.
7385 * With this function, developers can add other options to this menu to
7386 * perform any action they deem necessary.
7388 * @param obj The entry object
7389 * @param label The item's text label
7390 * @param icon_file The item's icon file
7391 * @param icon_type The item's icon type
7392 * @param func The callback to execute when the item is clicked
7393 * @param data The data to associate with the item for related functions
7395 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);
7397 * This disables the entry's contextual (longpress) menu.
7399 * @param obj The entry object
7400 * @param disabled If true, the menu is disabled
7402 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7404 * This returns whether the entry's contextual (longpress) menu is
7407 * @param obj The entry object
7408 * @return If true, the menu is disabled
7410 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7412 * This appends a custom item provider to the list for that entry
7414 * This appends the given callback. The list is walked from beginning to end
7415 * with each function called given the item href string in the text. If the
7416 * function returns an object handle other than NULL (it should create an
7417 * object to do this), then this object is used to replace that item. If
7418 * not the next provider is called until one provides an item object, or the
7419 * default provider in entry does.
7421 * @param obj The entry object
7422 * @param func The function called to provide the item object
7423 * @param data The data passed to @p func
7425 * @see @ref entry-items
7427 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);
7429 * This prepends a custom item provider to the list for that entry
7431 * This prepends the given callback. See elm_entry_item_provider_append() for
7434 * @param obj The entry object
7435 * @param func The function called to provide the item object
7436 * @param data The data passed to @p func
7438 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);
7440 * This removes a custom item provider to the list for that entry
7442 * This removes the given callback. See elm_entry_item_provider_append() for
7445 * @param obj The entry object
7446 * @param func The function called to provide the item object
7447 * @param data The data passed to @p func
7449 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);
7451 * Append a filter function for text inserted in the entry
7453 * Append the given callback to the list. This functions will be called
7454 * whenever any text is inserted into the entry, with the text to be inserted
7455 * as a parameter. The callback function is free to alter the text in any way
7456 * it wants, but it must remember to free the given pointer and update it.
7457 * If the new text is to be discarded, the function can free it and set its
7458 * text parameter to NULL. This will also prevent any following filters from
7461 * @param obj The entry object
7462 * @param func The function to use as text filter
7463 * @param data User data to pass to @p func
7465 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
7467 * Prepend a filter function for text insdrted in the entry
7469 * Prepend the given callback to the list. See elm_entry_text_filter_append()
7470 * for more information
7472 * @param obj The entry object
7473 * @param func The function to use as text filter
7474 * @param data User data to pass to @p func
7476 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
7478 * Remove a filter from the list
7480 * Removes the given callback from the filter list. See
7481 * elm_entry_text_filter_append() for more information.
7483 * @param obj The entry object
7484 * @param func The filter function to remove
7485 * @param data The user data passed when adding the function
7487 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
7489 * This converts a markup (HTML-like) string into UTF-8.
7491 * The returned string is a malloc'ed buffer and it should be freed when
7492 * not needed anymore.
7494 * @param s The string (in markup) to be converted
7495 * @return The converted string (in UTF-8). It should be freed.
7497 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
7499 * This converts a UTF-8 string into markup (HTML-like).
7501 * The returned string is a malloc'ed buffer and it should be freed when
7502 * not needed anymore.
7504 * @param s The string (in UTF-8) to be converted
7505 * @return The converted string (in markup). It should be freed.
7507 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
7509 * This sets the file (and implicitly loads it) for the text to display and
7510 * then edit. All changes are written back to the file after a short delay if
7511 * the entry object is set to autosave (which is the default).
7513 * If the entry had any other file set previously, any changes made to it
7514 * will be saved if the autosave feature is enabled, otherwise, the file
7515 * will be silently discarded and any non-saved changes will be lost.
7517 * @param obj The entry object
7518 * @param file The path to the file to load and save
7519 * @param format The file format
7521 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
7523 * Gets the file being edited by the entry.
7525 * This function can be used to retrieve any file set on the entry for
7526 * edition, along with the format used to load and save it.
7528 * @param obj The entry object
7529 * @param file The path to the file to load and save
7530 * @param format The file format
7532 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
7534 * This function writes any changes made to the file set with
7535 * elm_entry_file_set()
7537 * @param obj The entry object
7539 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
7541 * This sets the entry object to 'autosave' the loaded text file or not.
7543 * @param obj The entry object
7544 * @param autosave Autosave the loaded file or not
7546 * @see elm_entry_file_set()
7548 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
7550 * This gets the entry object's 'autosave' status.
7552 * @param obj The entry object
7553 * @return Autosave the loaded file or not
7555 * @see elm_entry_file_set()
7557 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7559 * Control pasting of text and images for the widget.
7561 * Normally the entry allows both text and images to be pasted. By setting
7562 * textonly to be true, this prevents images from being pasted.
7564 * Note this only changes the behaviour of text.
7566 * @param obj The entry object
7567 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
7570 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
7572 * Getting elm_entry text paste/drop mode.
7574 * In textonly mode, only text may be pasted or dropped into the widget.
7576 * @param obj The entry object
7577 * @return If the widget only accepts text from pastes.
7579 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7581 * Enable or disable scrolling in entry
7583 * Normally the entry is not scrollable unless you enable it with this call.
7585 * @param obj The entry object
7586 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
7588 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
7590 * Get the scrollable state of the entry
7592 * Normally the entry is not scrollable. This gets the scrollable state
7593 * of the entry. See elm_entry_scrollable_set() for more information.
7595 * @param obj The entry object
7596 * @return The scrollable state
7598 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
7600 * This sets a widget to be displayed to the left of a scrolled entry.
7602 * @param obj The scrolled entry object
7603 * @param icon The widget to display on the left side of the scrolled
7606 * @note A previously set widget will be destroyed.
7607 * @note If the object being set does not have minimum size hints set,
7608 * it won't get properly displayed.
7610 * @see elm_entry_end_set()
7612 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
7614 * Gets the leftmost widget of the scrolled entry. This object is
7615 * owned by the scrolled entry and should not be modified.
7617 * @param obj The scrolled entry object
7618 * @return the left widget inside the scroller
7620 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
7622 * Unset the leftmost widget of the scrolled entry, unparenting and
7625 * @param obj The scrolled entry object
7626 * @return the previously set icon sub-object of this entry, on
7629 * @see elm_entry_icon_set()
7631 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
7633 * Sets the visibility of the left-side widget of the scrolled entry,
7634 * set by @elm_entry_icon_set().
7636 * @param obj The scrolled entry object
7637 * @param setting EINA_TRUE if the object should be displayed,
7638 * EINA_FALSE if not.
7640 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
7642 * This sets a widget to be displayed to the end of a scrolled entry.
7644 * @param obj The scrolled entry object
7645 * @param end The widget to display on the right side of the scrolled
7648 * @note A previously set widget will be destroyed.
7649 * @note If the object being set does not have minimum size hints set,
7650 * it won't get properly displayed.
7652 * @see elm_entry_icon_set
7654 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
7656 * Gets the endmost widget of the scrolled entry. This object is owned
7657 * by the scrolled entry and should not be modified.
7659 * @param obj The scrolled entry object
7660 * @return the right widget inside the scroller
7662 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
7664 * Unset the endmost widget of the scrolled entry, unparenting and
7667 * @param obj The scrolled entry object
7668 * @return the previously set icon sub-object of this entry, on
7671 * @see elm_entry_icon_set()
7673 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
7675 * Sets the visibility of the end widget of the scrolled entry, set by
7676 * @elm_entry_end_set().
7678 * @param obj The scrolled entry object
7679 * @param setting EINA_TRUE if the object should be displayed,
7680 * EINA_FALSE if not.
7682 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
7684 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
7687 * Setting an entry to single-line mode with elm_entry_single_line_set()
7688 * will automatically disable the display of scrollbars when the entry
7689 * moves inside its scroller.
7691 * @param obj The scrolled entry object
7692 * @param h The horizontal scrollbar policy to apply
7693 * @param v The vertical scrollbar policy to apply
7695 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
7697 * This enables/disables bouncing within the entry.
7699 * This function sets whether the entry will bounce when scrolling reaches
7700 * the end of the contained entry.
7702 * @param obj The scrolled entry object
7703 * @param h The horizontal bounce state
7704 * @param v The vertical bounce state
7706 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7708 * Get the bounce mode
7710 * @param obj The Entry object
7711 * @param h_bounce Allow bounce horizontally
7712 * @param v_bounce Allow bounce vertically
7714 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7716 /* pre-made filters for entries */
7718 * @typedef Elm_Entry_Filter_Limit_Size
7720 * Data for the elm_entry_filter_limit_size() entry filter.
7722 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
7724 * @struct _Elm_Entry_Filter_Limit_Size
7726 * Data for the elm_entry_filter_limit_size() entry filter.
7728 struct _Elm_Entry_Filter_Limit_Size
7730 int max_char_count; /**< The maximum number of characters allowed. */
7731 int max_byte_count; /**< The maximum number of bytes allowed*/
7734 * Filter inserted text based on user defined character and byte limits
7736 * Add this filter to an entry to limit the characters that it will accept
7737 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
7738 * The funtion works on the UTF-8 representation of the string, converting
7739 * it from the set markup, thus not accounting for any format in it.
7741 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
7742 * it as data when setting the filter. In it, it's possible to set limits
7743 * by character count or bytes (any of them is disabled if 0), and both can
7744 * be set at the same time. In that case, it first checks for characters,
7747 * The function will cut the inserted text in order to allow only the first
7748 * number of characters that are still allowed. The cut is made in
7749 * characters, even when limiting by bytes, in order to always contain
7750 * valid ones and avoid half unicode characters making it in.
7752 * This filter, like any others, does not apply when setting the entry text
7753 * directly with elm_object_text_set() (or the deprecated
7754 * elm_entry_entry_set()).
7756 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
7758 * @typedef Elm_Entry_Filter_Accept_Set
7760 * Data for the elm_entry_filter_accept_set() entry filter.
7762 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
7764 * @struct _Elm_Entry_Filter_Accept_Set
7766 * Data for the elm_entry_filter_accept_set() entry filter.
7768 struct _Elm_Entry_Filter_Accept_Set
7770 const char *accepted; /**< Set of characters accepted in the entry. */
7771 const char *rejected; /**< Set of characters rejected from the entry. */
7774 * Filter inserted text based on accepted or rejected sets of characters
7776 * Add this filter to an entry to restrict the set of accepted characters
7777 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
7778 * This structure contains both accepted and rejected sets, but they are
7779 * mutually exclusive.
7781 * The @c accepted set takes preference, so if it is set, the filter will
7782 * only work based on the accepted characters, ignoring anything in the
7783 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
7785 * In both cases, the function filters by matching utf8 characters to the
7786 * raw markup text, so it can be used to remove formatting tags.
7788 * This filter, like any others, does not apply when setting the entry text
7789 * directly with elm_object_text_set() (or the deprecated
7790 * elm_entry_entry_set()).
7792 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
7797 /* composite widgets - these basically put together basic widgets above
7798 * in convenient packages that do more than basic stuff */
7802 * @defgroup Anchorview Anchorview
7804 * @image html img/widget/anchorview/preview-00.png
7805 * @image latex img/widget/anchorview/preview-00.eps
7807 * Anchorview is for displaying text that contains markup with anchors
7808 * like <c>\<a href=1234\>something\</\></c> in it.
7810 * Besides being styled differently, the anchorview widget provides the
7811 * necessary functionality so that clicking on these anchors brings up a
7812 * popup with user defined content such as "call", "add to contacts" or
7813 * "open web page". This popup is provided using the @ref Hover widget.
7815 * This widget is very similar to @ref Anchorblock, so refer to that
7816 * widget for an example. The only difference Anchorview has is that the
7817 * widget is already provided with scrolling functionality, so if the
7818 * text set to it is too large to fit in the given space, it will scroll,
7819 * whereas the @ref Anchorblock widget will keep growing to ensure all the
7820 * text can be displayed.
7822 * This widget emits the following signals:
7823 * @li "anchor,clicked": will be called when an anchor is clicked. The
7824 * @p event_info parameter on the callback will be a pointer of type
7825 * ::Elm_Entry_Anchorview_Info.
7827 * See @ref Anchorblock for an example on how to use both of them.
7836 * @typedef Elm_Entry_Anchorview_Info
7838 * The info sent in the callback for "anchor,clicked" signals emitted by
7839 * the Anchorview widget.
7841 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
7843 * @struct _Elm_Entry_Anchorview_Info
7845 * The info sent in the callback for "anchor,clicked" signals emitted by
7846 * the Anchorview widget.
7848 struct _Elm_Entry_Anchorview_Info
7850 const char *name; /**< Name of the anchor, as indicated in its href
7852 int button; /**< The mouse button used to click on it */
7853 Evas_Object *hover; /**< The hover object to use for the popup */
7855 Evas_Coord x, y, w, h;
7856 } anchor, /**< Geometry selection of text used as anchor */
7857 hover_parent; /**< Geometry of the object used as parent by the
7859 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
7860 for content on the left side of
7861 the hover. Before calling the
7862 callback, the widget will make the
7863 necessary calculations to check
7864 which sides are fit to be set with
7865 content, based on the position the
7866 hover is activated and its distance
7867 to the edges of its parent object
7869 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
7870 the right side of the hover.
7871 See @ref hover_left */
7872 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
7873 of the hover. See @ref hover_left */
7874 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
7875 below the hover. See @ref
7879 * Add a new Anchorview object
7881 * @param parent The parent object
7882 * @return The new object or NULL if it cannot be created
7884 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7886 * Set the text to show in the anchorview
7888 * Sets the text of the anchorview to @p text. This text can include markup
7889 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
7890 * text that will be specially styled and react to click events, ended with
7891 * either of \</a\> or \</\>. When clicked, the anchor will emit an
7892 * "anchor,clicked" signal that you can attach a callback to with
7893 * evas_object_smart_callback_add(). The name of the anchor given in the
7894 * event info struct will be the one set in the href attribute, in this
7897 * Other markup can be used to style the text in different ways, but it's
7898 * up to the style defined in the theme which tags do what.
7899 * @deprecated use elm_object_text_set() instead.
7901 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
7903 * Get the markup text set for the anchorview
7905 * Retrieves the text set on the anchorview, with markup tags included.
7907 * @param obj The anchorview object
7908 * @return The markup text set or @c NULL if nothing was set or an error
7910 * @deprecated use elm_object_text_set() instead.
7912 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7914 * Set the parent of the hover popup
7916 * Sets the parent object to use by the hover created by the anchorview
7917 * when an anchor is clicked. See @ref Hover for more details on this.
7918 * If no parent is set, the same anchorview object will be used.
7920 * @param obj The anchorview object
7921 * @param parent The object to use as parent for the hover
7923 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7925 * Get the parent of the hover popup
7927 * Get the object used as parent for the hover created by the anchorview
7928 * widget. See @ref Hover for more details on this.
7930 * @param obj The anchorview object
7931 * @return The object used as parent for the hover, NULL if none is set.
7933 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7935 * Set the style that the hover should use
7937 * When creating the popup hover, anchorview will request that it's
7938 * themed according to @p style.
7940 * @param obj The anchorview object
7941 * @param style The style to use for the underlying hover
7943 * @see elm_object_style_set()
7945 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
7947 * Get the style that the hover should use
7949 * Get the style the hover created by anchorview will use.
7951 * @param obj The anchorview object
7952 * @return The style to use by the hover. NULL means the default is used.
7954 * @see elm_object_style_set()
7956 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7958 * Ends the hover popup in the anchorview
7960 * When an anchor is clicked, the anchorview widget will create a hover
7961 * object to use as a popup with user provided content. This function
7962 * terminates this popup, returning the anchorview to its normal state.
7964 * @param obj The anchorview object
7966 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
7968 * Set bouncing behaviour when the scrolled content reaches an edge
7970 * Tell the internal scroller object whether it should bounce or not
7971 * when it reaches the respective edges for each axis.
7973 * @param obj The anchorview object
7974 * @param h_bounce Whether to bounce or not in the horizontal axis
7975 * @param v_bounce Whether to bounce or not in the vertical axis
7977 * @see elm_scroller_bounce_set()
7979 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7981 * Get the set bouncing behaviour of the internal scroller
7983 * Get whether the internal scroller should bounce when the edge of each
7984 * axis is reached scrolling.
7986 * @param obj The anchorview object
7987 * @param h_bounce Pointer where to store the bounce state of the horizontal
7989 * @param v_bounce Pointer where to store the bounce state of the vertical
7992 * @see elm_scroller_bounce_get()
7994 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7996 * Appends a custom item provider to the given anchorview
7998 * Appends the given function to the list of items providers. This list is
7999 * called, one function at a time, with the given @p data pointer, the
8000 * anchorview object and, in the @p item parameter, the item name as
8001 * referenced in its href string. Following functions in the list will be
8002 * called in order until one of them returns something different to NULL,
8003 * which should be an Evas_Object which will be used in place of the item
8006 * Items in the markup text take the form \<item relsize=16x16 vsize=full
8007 * href=item/name\>\</item\>
8009 * @param obj The anchorview object
8010 * @param func The function to add to the list of providers
8011 * @param data User data that will be passed to the callback function
8013 * @see elm_entry_item_provider_append()
8015 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);
8017 * Prepend a custom item provider to the given anchorview
8019 * Like elm_anchorview_item_provider_append(), but it adds the function
8020 * @p func to the beginning of the list, instead of the end.
8022 * @param obj The anchorview object
8023 * @param func The function to add to the list of providers
8024 * @param data User data that will be passed to the callback function
8026 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);
8028 * Remove a custom item provider from the list of the given anchorview
8030 * Removes the function and data pairing that matches @p func and @p data.
8031 * That is, unless the same function and same user data are given, the
8032 * function will not be removed from the list. This allows us to add the
8033 * same callback several times, with different @p data pointers and be
8034 * able to remove them later without conflicts.
8036 * @param obj The anchorview object
8037 * @param func The function to remove from the list
8038 * @param data The data matching the function to remove from the list
8040 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);
8047 * @defgroup Anchorblock Anchorblock
8049 * @image html img/widget/anchorblock/preview-00.png
8050 * @image latex img/widget/anchorblock/preview-00.eps
8052 * Anchorblock is for displaying text that contains markup with anchors
8053 * like <c>\<a href=1234\>something\</\></c> in it.
8055 * Besides being styled differently, the anchorblock widget provides the
8056 * necessary functionality so that clicking on these anchors brings up a
8057 * popup with user defined content such as "call", "add to contacts" or
8058 * "open web page". This popup is provided using the @ref Hover widget.
8060 * This widget emits the following signals:
8061 * @li "anchor,clicked": will be called when an anchor is clicked. The
8062 * @p event_info parameter on the callback will be a pointer of type
8063 * ::Elm_Entry_Anchorblock_Info.
8069 * Since examples are usually better than plain words, we might as well
8070 * try @ref tutorial_anchorblock_example "one".
8073 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
8074 * This example will show both Anchorblock and @ref Anchorview,
8075 * since both are very similar and it's easier to show them once and side
8076 * by side, so the difference is more clear.
8078 * We'll show the relevant snippets of the code here, but the full example
8079 * can be found here... sorry, @ref anchorblock_example_01.c "here".
8081 * As for the actual example, it's just a simple window with an anchorblock
8082 * and an anchorview, both containing the same text. After including
8083 * Elementary.h and declaring some functions we'll need, we jump to our
8084 * elm_main (see ELM_MAIN) and create our window.
8085 * @dontinclude anchorblock_example_01.c
8090 * With the needed variables declared, we'll create the window and a box to
8091 * hold our widgets, but we don't need to go through that here.
8093 * In order to make clear where the anchorblock ends and the anchorview
8094 * begins, they'll be each inside a @ref Frame. After creating the frame,
8095 * the anchorblock follows.
8096 * @skip elm_frame_add
8097 * @until elm_frame_content_set
8099 * Nothing out of the ordinary there. What's worth mentioning is the call
8100 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
8101 * when an anchor is clicked, the hover for the popup will cover the entire
8102 * window. This affects the area that will be obscured by the hover and
8103 * where clicking will dismiss it, as well as the calculations it does to
8104 * inform the best locations where to insert the popups content.
8105 * Other than that, the code is pretty standard. We also need to set our
8106 * callback for when an anchor is clicked, since it's our task to populate
8107 * the popup. There's no default for it.
8109 * The anchorview is no different, we only change a few things so it looks
8111 * @until elm_frame_content_set
8113 * Then we run, so stuff works and close our main function in the usual way.
8116 * Now, a little note. Normally you would use either one of anchorblock or
8117 * anchorview, set your one callback to clicks and do your stuff in there.
8118 * In this example, however, there are a few tricks to make it easier to
8119 * show both widgets in one go (and to save me some typing). So we have
8120 * two callbacks, one per widget, that will call a common function to do
8121 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
8122 * anchorview too, since both are equal, and passing a callback to use
8123 * for our buttons to end the hover, because each widget has a different
8125 * @until _anchorview_clicked_cb
8128 * The meat of our popup is in the following function. We check what kind
8129 * of menu we need to show, based on the name set to the anchor in the
8130 * markup text. If there's no type (something went wrong, no valid contact
8131 * in the address list) we are just putting a button that does nothing, but
8132 * it's perfectly reasonable to just end the hover and call it quits.
8134 * Our popup will consist of one main button in the middle of our hover,
8135 * and possibly a secondary button and a list of other options. We'll create
8136 * first our main button and check what kind of popup we need afterwards.
8139 * @until eina_stringshare_add
8142 * Each button has two callbacks, one is our hack to close the hover
8143 * properly based on which widget it belongs to, the other a simple
8144 * printf that will show the action with the anchors own data. This is
8145 * not how you would usually do it. Instead, the common case is to have
8146 * one callback for the button that will know which function to call to end
8147 * things, but since we are doing it this way it's worth noting that
8148 * smart callbacks will be called in reverse in respect to the order they
8149 * were added, and since our @c btn_end_cb will close the hover, and thus
8150 * delete our buttons, the other callback wouldn't be called if we had
8153 * After our telephone popup, there are a few others that are practically
8154 * the same, so they won't be shown here.
8156 * Once we are done with that, it's time to place our actions into our
8157 * hover. Main button goes in the middle without much questioning, and then
8158 * we see if we have a secondary button and a box of extra options.
8159 * Because I said so, secondary button goes on either side and box of
8160 * options either on top or below the main one, but to choose which
8161 * exactly, we use the hints our callback info has, which saves us from
8162 * having to do the math and see which side has more space available, with
8163 * a little special case where we delete our extra stuff if there's nowhere
8167 * @skip evas_object_smart
8168 * @until evas_object_del(box)
8172 * The example will look like this:
8174 * @image html screenshots/anchorblock_01.png
8175 * @image latex screenshots/anchorblock_01.eps width=\textwidth
8177 * @example anchorblock_example_01.c
8180 * @addtogroup Anchorblock
8184 * @typedef Elm_Entry_Anchorblock_Info
8186 * The info sent in the callback for "anchor,clicked" signals emitted by
8187 * the Anchorblock widget.
8189 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
8191 * @struct _Elm_Entry_Anchorblock_Info
8193 * The info sent in the callback for "anchor,clicked" signals emitted by
8194 * the Anchorblock widget.
8196 struct _Elm_Entry_Anchorblock_Info
8198 const char *name; /**< Name of the anchor, as indicated in its href
8200 int button; /**< The mouse button used to click on it */
8201 Evas_Object *hover; /**< The hover object to use for the popup */
8203 Evas_Coord x, y, w, h;
8204 } anchor, /**< Geometry selection of text used as anchor */
8205 hover_parent; /**< Geometry of the object used as parent by the
8207 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
8208 for content on the left side of
8209 the hover. Before calling the
8210 callback, the widget will make the
8211 necessary calculations to check
8212 which sides are fit to be set with
8213 content, based on the position the
8214 hover is activated and its distance
8215 to the edges of its parent object
8217 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
8218 the right side of the hover.
8219 See @ref hover_left */
8220 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
8221 of the hover. See @ref hover_left */
8222 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
8223 below the hover. See @ref
8227 * Add a new Anchorblock object
8229 * @param parent The parent object
8230 * @return The new object or NULL if it cannot be created
8232 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8234 * Set the text to show in the anchorblock
8236 * Sets the text of the anchorblock to @p text. This text can include markup
8237 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
8238 * of text that will be specially styled and react to click events, ended
8239 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
8240 * "anchor,clicked" signal that you can attach a callback to with
8241 * evas_object_smart_callback_add(). The name of the anchor given in the
8242 * event info struct will be the one set in the href attribute, in this
8245 * Other markup can be used to style the text in different ways, but it's
8246 * up to the style defined in the theme which tags do what.
8247 * @deprecated use elm_object_text_set() instead.
8249 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
8251 * Get the markup text set for the anchorblock
8253 * Retrieves the text set on the anchorblock, with markup tags included.
8255 * @param obj The anchorblock object
8256 * @return The markup text set or @c NULL if nothing was set or an error
8258 * @deprecated use elm_object_text_set() instead.
8260 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8262 * Set the parent of the hover popup
8264 * Sets the parent object to use by the hover created by the anchorblock
8265 * when an anchor is clicked. See @ref Hover for more details on this.
8267 * @param obj The anchorblock object
8268 * @param parent The object to use as parent for the hover
8270 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8272 * Get the parent of the hover popup
8274 * Get the object used as parent for the hover created by the anchorblock
8275 * widget. See @ref Hover for more details on this.
8276 * If no parent is set, the same anchorblock object will be used.
8278 * @param obj The anchorblock object
8279 * @return The object used as parent for the hover, NULL if none is set.
8281 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8283 * Set the style that the hover should use
8285 * When creating the popup hover, anchorblock will request that it's
8286 * themed according to @p style.
8288 * @param obj The anchorblock object
8289 * @param style The style to use for the underlying hover
8291 * @see elm_object_style_set()
8293 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
8295 * Get the style that the hover should use
8297 * Get the style the hover created by anchorblock will use.
8299 * @param obj The anchorblock object
8300 * @return The style to use by the hover. NULL means the default is used.
8302 * @see elm_object_style_set()
8304 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8306 * Ends the hover popup in the anchorblock
8308 * When an anchor is clicked, the anchorblock widget will create a hover
8309 * object to use as a popup with user provided content. This function
8310 * terminates this popup, returning the anchorblock to its normal state.
8312 * @param obj The anchorblock object
8314 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8316 * Appends a custom item provider to the given anchorblock
8318 * Appends the given function to the list of items providers. This list is
8319 * called, one function at a time, with the given @p data pointer, the
8320 * anchorblock object and, in the @p item parameter, the item name as
8321 * referenced in its href string. Following functions in the list will be
8322 * called in order until one of them returns something different to NULL,
8323 * which should be an Evas_Object which will be used in place of the item
8326 * Items in the markup text take the form \<item relsize=16x16 vsize=full
8327 * href=item/name\>\</item\>
8329 * @param obj The anchorblock object
8330 * @param func The function to add to the list of providers
8331 * @param data User data that will be passed to the callback function
8333 * @see elm_entry_item_provider_append()
8335 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);
8337 * Prepend a custom item provider to the given anchorblock
8339 * Like elm_anchorblock_item_provider_append(), but it adds the function
8340 * @p func to the beginning of the list, instead of the end.
8342 * @param obj The anchorblock object
8343 * @param func The function to add to the list of providers
8344 * @param data User data that will be passed to the callback function
8346 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);
8348 * Remove a custom item provider from the list of the given anchorblock
8350 * Removes the function and data pairing that matches @p func and @p data.
8351 * That is, unless the same function and same user data are given, the
8352 * function will not be removed from the list. This allows us to add the
8353 * same callback several times, with different @p data pointers and be
8354 * able to remove them later without conflicts.
8356 * @param obj The anchorblock object
8357 * @param func The function to remove from the list
8358 * @param data The data matching the function to remove from the list
8360 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);
8366 * @defgroup Bubble Bubble
8368 * @image html img/widget/bubble/preview-00.png
8369 * @image html img/widget/bubble/preview-01.png
8370 * @image html img/widget/bubble/preview-02.png
8372 * @brief The Bubble is a widget to show text similarly to how speech is
8373 * represented in comics.
8375 * The bubble widget contains 5 important visual elements:
8376 * @li The frame is a rectangle with rounded rectangles and an "arrow".
8377 * @li The @p icon is an image to which the frame's arrow points to.
8378 * @li The @p label is a text which appears to the right of the icon if the
8379 * corner is "top_left" or "bottom_left" and is right aligned to the frame
8381 * @li The @p info is a text which appears to the right of the label. Info's
8382 * font is of a ligther color than label.
8383 * @li The @p content is an evas object that is shown inside the frame.
8385 * The position of the arrow, icon, label and info depends on which corner is
8386 * selected. The four available corners are:
8387 * @li "top_left" - Default
8390 * @li "bottom_right"
8392 * Signals that you can add callbacks for are:
8393 * @li "clicked" - This is called when a user has clicked the bubble.
8395 * For an example of using a buble see @ref bubble_01_example_page "this".
8400 * Add a new bubble to the parent
8402 * @param parent The parent object
8403 * @return The new object or NULL if it cannot be created
8405 * This function adds a text bubble to the given parent evas object.
8407 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8409 * Set the label of the bubble
8411 * @param obj The bubble object
8412 * @param label The string to set in the label
8414 * This function sets the title of the bubble. Where this appears depends on
8415 * the selected corner.
8416 * @deprecated use elm_object_text_set() instead.
8418 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8420 * Get the label of the bubble
8422 * @param obj The bubble object
8423 * @return The string of set in the label
8425 * This function gets the title of the bubble.
8426 * @deprecated use elm_object_text_set() instead.
8428 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8430 * Set the info of the bubble
8432 * @param obj The bubble object
8433 * @param info The given info about the bubble
8435 * This function sets the info of the bubble. Where this appears depends on
8436 * the selected corner.
8437 * @deprecated use elm_object_text_set() instead.
8439 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
8441 * Get the info of the bubble
8443 * @param obj The bubble object
8445 * @return The "info" string of the bubble
8447 * This function gets the info text.
8448 * @deprecated use elm_object_text_set() instead.
8450 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8452 * Set the content to be shown in the bubble
8454 * Once the content object is set, a previously set one will be deleted.
8455 * If you want to keep the old content object, use the
8456 * elm_bubble_content_unset() function.
8458 * @param obj The bubble object
8459 * @param content The given content of the bubble
8461 * This function sets the content shown on the middle of the bubble.
8463 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8465 * Get the content shown in the bubble
8467 * Return the content object which is set for this widget.
8469 * @param obj The bubble object
8470 * @return The content that is being used
8472 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8474 * Unset the content shown in the bubble
8476 * Unparent and return the content object which was set for this widget.
8478 * @param obj The bubble object
8479 * @return The content that was being used
8481 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8483 * Set the icon of the bubble
8485 * Once the icon object is set, a previously set one will be deleted.
8486 * If you want to keep the old content object, use the
8487 * elm_icon_content_unset() function.
8489 * @param obj The bubble object
8490 * @param icon The given icon for the bubble
8492 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8494 * Get the icon of the bubble
8496 * @param obj The bubble object
8497 * @return The icon for the bubble
8499 * This function gets the icon shown on the top left of bubble.
8501 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8503 * Unset the icon of the bubble
8505 * Unparent and return the icon object which was set for this widget.
8507 * @param obj The bubble object
8508 * @return The icon that was being used
8510 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8512 * Set the corner of the bubble
8514 * @param obj The bubble object.
8515 * @param corner The given corner for the bubble.
8517 * This function sets the corner of the bubble. The corner will be used to
8518 * determine where the arrow in the frame points to and where label, icon and
8521 * Possible values for corner are:
8522 * @li "top_left" - Default
8525 * @li "bottom_right"
8527 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
8529 * Get the corner of the bubble
8531 * @param obj The bubble object.
8532 * @return The given corner for the bubble.
8534 * This function gets the selected corner of the bubble.
8536 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8542 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8543 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
8544 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
8545 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
8546 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
8547 /* smart callbacks called:
8548 * "clicked" - the user clicked the icon
8549 * "drag,start" - Someone started dragging the image out of the object
8550 * "drag,end" - Dragged item was dropped (somewhere)
8554 /** @defgroup Elm_Gesture_Layer Gesture Layer */
8556 * @enum _Elm_Gesture_Types
8557 * Enum of supported gesture types.
8558 * @ingroup Elm_Gesture_Layer
8560 typedef enum _Elm_Gesture_Types
8562 ELM_GESTURE_FIRST = 0,
8564 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
8565 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
8566 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
8568 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
8570 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
8571 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
8573 ELM_GESTURE_ZOOM, /**< Zoom */
8574 ELM_GESTURE_ROTATE, /**< Rotate */
8577 } Elm_Gesture_Types;
8580 * @enum _Elm_Gesture_State
8581 * Enum of gesture states.
8582 * @ingroup Elm_Gesture_Layer
8584 typedef enum _Elm_Gesture_State
8586 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
8587 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
8588 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
8589 ELM_GESTURE_STATE_END, /**< Gesture completed */
8590 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
8591 } Elm_Gesture_State;
8594 * @struct _Elm_Gesture_Taps_Info
8595 * Struct holds taps info for user
8596 * @ingroup Elm_Gesture_Layer
8598 struct _Elm_Gesture_Taps_Info
8600 Evas_Coord x, y; /**< Holds center point between fingers */
8601 unsigned int n; /**< Number of fingers tapped */
8602 unsigned int timestamp; /**< event timestamp */
8606 * @typedef Elm_Gesture_Taps_Info
8607 * holds taps info for user
8608 * @ingroup Elm_Gesture_Layer
8610 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
8613 * @struct _Elm_Gesture_Momentum_Info
8614 * Struct holds momentum info for user
8615 * x1 and y1 are not necessarily in sync
8616 * x1 holds x value of x direction starting point
8617 * and same holds for y1.
8618 * This is noticeable when doing V-shape movement
8619 * @ingroup Elm_Gesture_Layer
8621 struct _Elm_Gesture_Momentum_Info
8622 { /* Report line ends, timestamps, and momentum computed */
8623 Evas_Coord x1; /**< Final-swipe direction starting point on X */
8624 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
8625 Evas_Coord x2; /**< Final-swipe direction ending point on X */
8626 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
8628 unsigned int tx; /**< Timestamp of start of final x-swipe */
8629 unsigned int ty; /**< Timestamp of start of final y-swipe */
8631 Evas_Coord mx; /**< Momentum on X */
8632 Evas_Coord my; /**< Momentum on Y */
8636 * @typedef Elm_Gesture_Momentum_Info
8637 * holds momentum info for user
8638 * @ingroup Elm_Gesture_Layer
8640 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
8643 * @struct _Elm_Gesture_Line_Info
8644 * Struct holds line info for user
8645 * @ingroup Elm_Gesture_Layer
8647 struct _Elm_Gesture_Line_Info
8648 { /* Report line ends, timestamps, and momentum computed */
8649 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
8650 unsigned int n; /**< Number of fingers (lines) */
8651 /* FIXME should be radians, bot degrees */
8652 double angle; /**< Angle (direction) of lines */
8656 * @typedef _Elm_Gesture_Line_Info
8657 * Holds line info for user
8658 * @ingroup Elm_Gesture_Layer
8660 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
8663 * @struct _Elm_Gesture_Zoom_Info
8664 * Struct holds zoom info for user
8665 * @ingroup Elm_Gesture_Layer
8667 struct _Elm_Gesture_Zoom_Info
8669 Evas_Coord x, y; /**< Holds zoom center point reported to user */
8670 Evas_Coord radius; /**< Holds radius between fingers reported to user */
8671 double zoom; /**< Zoom value: 1.0 means no zoom */
8672 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
8676 * @typedef Elm_Gesture_Zoom_Info
8677 * Holds zoom info for user
8678 * @ingroup Elm_Gesture_Layer
8680 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
8683 * @struct _Elm_Gesture_Rotate_Info
8684 * Struct holds rotation info for user
8685 * @ingroup Elm_Gesture_Layer
8687 struct _Elm_Gesture_Rotate_Info
8689 Evas_Coord x, y; /**< Holds zoom center point reported to user */
8690 Evas_Coord radius; /**< Holds radius between fingers reported to user */
8691 double base_angle; /**< Holds start-angle */
8692 double angle; /**< Rotation value: 0.0 means no rotation */
8693 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
8697 * @typedef Elm_Gesture_Rotate_Info
8698 * Holds rotation info for user
8699 * @ingroup Elm_Gesture_Layer
8701 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
8704 * @typedef Elm_Gesture_Event_Cb
8705 * User callback used to stream gesture info from gesture layer
8706 * @param data user data
8707 * @param event_info gesture report info
8708 * Returns a flag field to be applied on the causing event.
8709 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
8710 * upon the event, in an irreversible way.
8712 * @ingroup Elm_Gesture_Layer
8714 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
8717 * Use function to set callbacks to be notified about
8718 * change of state of gesture.
8719 * When a user registers a callback with this function
8720 * this means this gesture has to be tested.
8722 * When ALL callbacks for a gesture are set to NULL
8723 * it means user isn't interested in gesture-state
8724 * and it will not be tested.
8726 * @param obj Pointer to gesture-layer.
8727 * @param idx The gesture you would like to track its state.
8728 * @param cb callback function pointer.
8729 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
8730 * @param data user info to be sent to callback (usually, Smart Data)
8732 * @ingroup Elm_Gesture_Layer
8734 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);
8737 * Call this function to get repeat-events settings.
8739 * @param obj Pointer to gesture-layer.
8741 * @return repeat events settings.
8742 * @see elm_gesture_layer_hold_events_set()
8743 * @ingroup Elm_Gesture_Layer
8745 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8748 * This function called in order to make gesture-layer repeat events.
8749 * Set this of you like to get the raw events only if gestures were not detected.
8750 * Clear this if you like gesture layer to fwd events as testing gestures.
8752 * @param obj Pointer to gesture-layer.
8753 * @param r Repeat: TRUE/FALSE
8755 * @ingroup Elm_Gesture_Layer
8757 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
8760 * This function sets step-value for zoom action.
8761 * Set step to any positive value.
8762 * Cancel step setting by setting to 0.0
8764 * @param obj Pointer to gesture-layer.
8765 * @param s new zoom step value.
8767 * @ingroup Elm_Gesture_Layer
8769 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
8772 * This function sets step-value for rotate action.
8773 * Set step to any positive value.
8774 * Cancel step setting by setting to 0.0
8776 * @param obj Pointer to gesture-layer.
8777 * @param s new roatate step value.
8779 * @ingroup Elm_Gesture_Layer
8781 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
8784 * This function called to attach gesture-layer to an Evas_Object.
8785 * @param obj Pointer to gesture-layer.
8786 * @param t Pointer to underlying object (AKA Target)
8788 * @return TRUE, FALSE on success, failure.
8790 * @ingroup Elm_Gesture_Layer
8792 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
8795 * Call this function to construct a new gesture-layer object.
8796 * This does not activate the gesture layer. You have to
8797 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
8799 * @param parent the parent object.
8801 * @return Pointer to new gesture-layer object.
8803 * @ingroup Elm_Gesture_Layer
8805 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8808 typedef enum _Elm_Thumb_Animation_Setting
8810 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
8811 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
8812 ELM_THUMB_ANIMATION_STOP,
8813 ELM_THUMB_ANIMATION_LAST
8814 } Elm_Thumb_Animation_Setting;
8816 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8817 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
8818 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
8819 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
8820 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
8821 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
8822 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8823 EAPI void *elm_thumb_ethumb_client_get(void);
8824 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
8825 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8826 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8827 /* available styles:
8831 /* smart callbacks called:
8832 * "clicked" - This is called when a user has clicked the thumb without dragging around.
8833 * "clicked,double" - This is called when a user has double-clicked the thumb.
8834 * "press" - This is called when a user has pressed down the thumb.
8835 * "generate,start" - The thumbnail generation started.
8836 * "generate,stop" - The generation process stopped.
8837 * "generate,error" - The generation failed.
8838 * "load,error" - The thumbnail image loading failed.
8842 * @defgroup Hoversel
8844 * @image html img/widget/hoversel/preview-00.png
8845 * @image latex img/widget/hoversel/preview-00.eps
8847 * A hoversel is a button that pops up a list of items (automatically
8848 * choosing the direction to display) that have a label and, optionally, an
8849 * icon to select from. It is a convenience widget to avoid the need to do
8850 * all the piecing together yourself. It is intended for a small number of
8851 * items in the hoversel menu (no more than 8), though is capable of many
8854 * Signals that you can add callbacks for are:
8855 * "clicked" - the user clicked the hoversel button and popped up the sel
8856 * "selected" - an item in the hoversel list is selected. event_info is the item
8857 * "dismissed" - the hover is dismissed
8859 * See @ref tutorial_hoversel for an example.
8862 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
8864 * @brief Add a new Hoversel object
8866 * @param parent The parent object
8867 * @return The new object or NULL if it cannot be created
8869 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8871 * @brief This sets the hoversel to expand horizontally.
8873 * @param obj The hoversel object
8874 * @param horizontal If true, the hover will expand horizontally to the
8877 * @note The initial button will display horizontally regardless of this
8880 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8882 * @brief This returns whether the hoversel is set to expand horizontally.
8884 * @param obj The hoversel object
8885 * @return If true, the hover will expand horizontally to the right.
8887 * @see elm_hoversel_horizontal_set()
8889 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8891 * @brief Set the Hover parent
8893 * @param obj The hoversel object
8894 * @param parent The parent to use
8896 * Sets the hover parent object, the area that will be darkened when the
8897 * hoversel is clicked. Should probably be the window that the hoversel is
8898 * in. See @ref Hover objects for more information.
8900 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8902 * @brief Get the Hover parent
8904 * @param obj The hoversel object
8905 * @return The used parent
8907 * Gets the hover parent object.
8909 * @see elm_hoversel_hover_parent_set()
8911 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8913 * @brief Set the hoversel button label
8915 * @param obj The hoversel object
8916 * @param label The label text.
8918 * This sets the label of the button that is always visible (before it is
8919 * clicked and expanded).
8921 * @deprecated elm_object_text_set()
8923 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8925 * @brief Get the hoversel button label
8927 * @param obj The hoversel object
8928 * @return The label text.
8930 * @deprecated elm_object_text_get()
8932 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8934 * @brief Set the icon of the hoversel button
8936 * @param obj The hoversel object
8937 * @param icon The icon object
8939 * Sets the icon of the button that is always visible (before it is clicked
8940 * and expanded). Once the icon object is set, a previously set one will be
8941 * deleted, if you want to keep that old content object, use the
8942 * elm_hoversel_icon_unset() function.
8944 * @see elm_button_icon_set()
8946 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8948 * @brief Get the icon of the hoversel button
8950 * @param obj The hoversel object
8951 * @return The icon object
8953 * Get the icon of the button that is always visible (before it is clicked
8954 * and expanded). Also see elm_button_icon_get().
8956 * @see elm_hoversel_icon_set()
8958 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8960 * @brief Get and unparent the icon of the hoversel button
8962 * @param obj The hoversel object
8963 * @return The icon object that was being used
8965 * Unparent and return the icon of the button that is always visible
8966 * (before it is clicked and expanded).
8968 * @see elm_hoversel_icon_set()
8969 * @see elm_button_icon_unset()
8971 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8973 * @brief This triggers the hoversel popup from code, the same as if the user
8974 * had clicked the button.
8976 * @param obj The hoversel object
8978 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8980 * @brief This dismisses the hoversel popup as if the user had clicked
8981 * outside the hover.
8983 * @param obj The hoversel object
8985 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8987 * @brief Returns whether the hoversel is expanded.
8989 * @param obj The hoversel object
8990 * @return This will return EINA_TRUE if the hoversel is expanded or
8991 * EINA_FALSE if it is not expanded.
8993 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8995 * @brief This will remove all the children items from the hoversel.
8997 * @param obj The hoversel object
8999 * @warning Should @b not be called while the hoversel is active; use
9000 * elm_hoversel_expanded_get() to check first.
9002 * @see elm_hoversel_item_del_cb_set()
9003 * @see elm_hoversel_item_del()
9005 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9007 * @brief Get the list of items within the given hoversel.
9009 * @param obj The hoversel object
9010 * @return Returns a list of Elm_Hoversel_Item*
9012 * @see elm_hoversel_item_add()
9014 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9016 * @brief Add an item to the hoversel button
9018 * @param obj The hoversel object
9019 * @param label The text label to use for the item (NULL if not desired)
9020 * @param icon_file An image file path on disk to use for the icon or standard
9021 * icon name (NULL if not desired)
9022 * @param icon_type The icon type if relevant
9023 * @param func Convenience function to call when this item is selected
9024 * @param data Data to pass to item-related functions
9025 * @return A handle to the item added.
9027 * This adds an item to the hoversel to show when it is clicked. Note: if you
9028 * need to use an icon from an edje file then use
9029 * elm_hoversel_item_icon_set() right after the this function, and set
9030 * icon_file to NULL here.
9032 * For more information on what @p icon_file and @p icon_type are see the
9033 * @ref Icon "icon documentation".
9035 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);
9037 * @brief Delete an item from the hoversel
9039 * @param item The item to delete
9041 * This deletes the item from the hoversel (should not be called while the
9042 * hoversel is active; use elm_hoversel_expanded_get() to check first).
9044 * @see elm_hoversel_item_add()
9045 * @see elm_hoversel_item_del_cb_set()
9047 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
9049 * @brief Set the function to be called when an item from the hoversel is
9052 * @param item The item to set the callback on
9053 * @param func The function called
9055 * That function will receive these parameters:
9056 * @li void *item_data
9057 * @li Evas_Object *the_item_object
9058 * @li Elm_Hoversel_Item *the_object_struct
9060 * @see elm_hoversel_item_add()
9062 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9064 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
9065 * that will be passed to associated function callbacks.
9067 * @param item The item to get the data from
9068 * @return The data pointer set with elm_hoversel_item_add()
9070 * @see elm_hoversel_item_add()
9072 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
9074 * @brief This returns the label text of the given hoversel item.
9076 * @param item The item to get the label
9077 * @return The label text of the hoversel item
9079 * @see elm_hoversel_item_add()
9081 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
9083 * @brief This sets the icon for the given hoversel item.
9085 * @param item The item to set the icon
9086 * @param icon_file An image file path on disk to use for the icon or standard
9088 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
9089 * to NULL if the icon is not an edje file
9090 * @param icon_type The icon type
9092 * The icon can be loaded from the standard set, from an image file, or from
9095 * @see elm_hoversel_item_add()
9097 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);
9099 * @brief Get the icon object of the hoversel item
9101 * @param item The item to get the icon from
9102 * @param icon_file The image file path on disk used for the icon or standard
9104 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
9105 * if the icon is not an edje file
9106 * @param icon_type The icon type
9108 * @see elm_hoversel_item_icon_set()
9109 * @see elm_hoversel_item_add()
9111 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);
9117 typedef enum _Elm_Toolbar_Shrink_Mode
9119 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
9120 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
9121 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
9122 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
9123 } Elm_Toolbar_Shrink_Mode;
9125 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
9126 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
9128 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9129 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
9130 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9131 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
9132 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9133 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9134 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9135 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);
9136 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);
9137 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);
9138 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);
9139 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9140 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9141 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9142 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9143 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9144 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
9145 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9146 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9147 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9148 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
9149 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9150 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
9151 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9152 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9153 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9154 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9155 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
9156 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9157 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9158 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9159 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9160 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
9161 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9162 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
9163 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9164 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
9165 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9166 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
9167 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9168 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9169 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9170 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
9171 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9172 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
9173 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9174 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);
9175 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
9176 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
9177 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9178 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9179 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9180 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
9181 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
9182 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);
9183 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9184 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
9185 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9186 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9187 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9188 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9189 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
9190 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9191 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9192 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
9193 /* smart callbacks called:
9194 * "clicked" - when the user clicks on a toolbar item and becomes selected
9196 /* available styles:
9198 * transparent (no background or shadow, just show the provided content)
9202 EAPI double elm_tooltip_delay_get(void);
9203 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
9204 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
9205 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
9206 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
9207 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);
9208 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9209 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9210 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9211 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
9212 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9213 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9214 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9215 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9216 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9217 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9220 EAPI int elm_cursor_engine_only_get(void);
9221 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
9224 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
9225 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9226 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9227 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9228 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
9229 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
9230 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9231 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9232 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);
9233 EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
9234 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
9235 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9236 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
9237 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9238 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9239 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9240 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9241 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9242 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9243 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
9244 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9245 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9246 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9247 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9248 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
9249 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
9250 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9251 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9252 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
9253 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9254 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
9256 /* smart callbacks called:
9257 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
9261 * @defgroup List List
9262 * @ingroup Elementary
9264 * @image html img/widget/list/preview-00.png
9265 * @image latex img/widget/list/preview-00.eps width=\textwidth
9267 * @image html img/list.png
9268 * @image latex img/list.eps width=\textwidth
9270 * A list widget is a container whose children are displayed vertically or
9271 * horizontally, in order, and can be selected.
9272 * The list can accept only one or multiple items selection. Also has many
9273 * modes of items displaying.
9275 * A list is a very simple type of list widget. For more robust
9276 * lists, @ref Genlist should probably be used.
9278 * Smart callbacks one can listen to:
9279 * - "clicked,double" - when the user double-clicked an item
9280 * - "selected" - when the user selected an item
9281 * - "unselected" - when the user unselected an item
9282 * - "longpressed" - an item in the list is long-pressed
9283 * - "scroll,edge,top" - the list is scrolled until the top edge
9284 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
9285 * - "scroll,edge,left" - the list is scrolled until the left edge
9286 * - "scroll,edge,right" - the list is scrolled until the right edge
9288 * Available styles for it:
9292 * @li @ref list_example_01
9293 * @li @ref list_example_02
9294 * @li @ref list_example_03
9303 * @enum _Elm_List_Mode
9304 * @typedef Elm_List_Mode
9306 * Set list's resize behavior, transverse axis scroll and
9307 * items cropping. See each mode's description for more details.
9309 * @note Default value is #ELM_LIST_SCROLL.
9311 * Values <b> don't </b> work as bitmaks, only one can be choosen.
9313 * @see elm_list_mode_set()
9314 * @see elm_list_mode_get()
9318 typedef enum _Elm_List_Mode
9320 ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
9321 ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
9322 ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
9323 ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
9324 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
9327 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del(). */
9330 * Add a new list widget to the given parent Elementary
9331 * (container) object.
9333 * @param parent The parent object.
9334 * @return a new list widget handle or @c NULL, on errors.
9336 * This function inserts a new list widget on the canvas.
9340 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9345 * @param obj The list object
9347 * @note Call before running show() on the list object.
9348 * @warning If not called, it won't display the list properly.
9351 * li = elm_list_add(win);
9352 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
9353 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
9355 * evas_object_show(li);
9360 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
9363 * Enable or disable multiple items selection on the list object.
9365 * @param obj The list object
9366 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
9369 * Disabled by default. If disabled, the user can select a single item of
9370 * the list each time. Selected items are highlighted on list.
9371 * If enabled, many items can be selected.
9373 * If a selected item is selected again, it will be unselected.
9375 * @see elm_list_multi_select_get()
9379 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9382 * Get a value whether multiple items selection is enabled or not.
9384 * @see elm_list_multi_select_set() for details.
9386 * @param obj The list object.
9387 * @return @c EINA_TRUE means multiple items selection is enabled.
9388 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9389 * @c EINA_FALSE is returned.
9393 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9396 * Set which mode to use for the list object.
9398 * @param obj The list object
9399 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
9400 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
9402 * Set list's resize behavior, transverse axis scroll and
9403 * items cropping. See each mode's description for more details.
9405 * @note Default value is #ELM_LIST_SCROLL.
9407 * Only one can be set, if a previous one was set, it will be changed
9408 * by the new mode set. Bitmask won't work as well.
9410 * @see elm_list_mode_get()
9414 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
9417 * Get the mode the list is at.
9419 * @param obj The list object
9420 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
9421 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
9423 * @note see elm_list_mode_set() for more information.
9427 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9430 * Enable or disable horizontal mode on the list object.
9432 * @param obj The list object.
9433 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
9434 * disable it, i.e., to enable vertical mode.
9436 * @note Vertical mode is set by default.
9438 * On horizontal mode items are displayed on list from left to right,
9439 * instead of from top to bottom. Also, the list will scroll horizontally.
9440 * Each item will presents left icon on top and right icon, or end, at
9443 * @see elm_list_horizontal_get()
9447 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
9450 * Get a value whether horizontal mode is enabled or not.
9452 * @param obj The list object.
9453 * @return @c EINA_TRUE means horizontal mode selection is enabled.
9454 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9455 * @c EINA_FALSE is returned.
9457 * @see elm_list_horizontal_set() for details.
9461 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9464 * Enable or disable always select mode on the list object.
9466 * @param obj The list object
9467 * @param always_select @c EINA_TRUE to enable always select mode or
9468 * @c EINA_FALSE to disable it.
9470 * @note Always select mode is disabled by default.
9472 * Default behavior of list items is to only call its callback function
9473 * the first time it's pressed, i.e., when it is selected. If a selected
9474 * item is pressed again, and multi-select is disabled, it won't call
9475 * this function (if multi-select is enabled it will unselect the item).
9477 * If always select is enabled, it will call the callback function
9478 * everytime a item is pressed, so it will call when the item is selected,
9479 * and again when a selected item is pressed.
9481 * @see elm_list_always_select_mode_get()
9482 * @see elm_list_multi_select_set()
9486 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9489 * Get a value whether always select mode is enabled or not, meaning that
9490 * an item will always call its callback function, even if already selected.
9492 * @param obj The list object
9493 * @return @c EINA_TRUE means horizontal mode selection is enabled.
9494 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
9495 * @c EINA_FALSE is returned.
9497 * @see elm_list_always_select_mode_set() for details.
9501 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9504 * Set bouncing behaviour when the scrolled content reaches an edge.
9506 * Tell the internal scroller object whether it should bounce or not
9507 * when it reaches the respective edges for each axis.
9509 * @param obj The list object
9510 * @param h_bounce Whether to bounce or not in the horizontal axis.
9511 * @param v_bounce Whether to bounce or not in the vertical axis.
9513 * @see elm_scroller_bounce_set()
9517 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9520 * Get the bouncing behaviour of the internal scroller.
9522 * Get whether the internal scroller should bounce when the edge of each
9523 * axis is reached scrolling.
9525 * @param obj The list object.
9526 * @param h_bounce Pointer where to store the bounce state of the horizontal
9528 * @param v_bounce Pointer where to store the bounce state of the vertical
9531 * @see elm_scroller_bounce_get()
9532 * @see elm_list_bounce_set()
9536 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9539 * Set the scrollbar policy.
9541 * @param obj The list object
9542 * @param policy_h Horizontal scrollbar policy.
9543 * @param policy_v Vertical scrollbar policy.
9545 * This sets the scrollbar visibility policy for the given scroller.
9546 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
9547 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
9548 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
9549 * This applies respectively for the horizontal and vertical scrollbars.
9551 * The both are disabled by default, i.e., are set to
9552 * #ELM_SCROLLER_POLICY_OFF.
9556 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
9559 * Get the scrollbar policy.
9561 * @see elm_list_scroller_policy_get() for details.
9563 * @param obj The list object.
9564 * @param policy_h Pointer where to store horizontal scrollbar policy.
9565 * @param policy_v Pointer where to store vertical scrollbar policy.
9569 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);
9572 * Append a new item to the list object.
9574 * @param obj The list object.
9575 * @param label The label of the list item.
9576 * @param icon The icon object to use for the left side of the item. An
9577 * icon can be any Evas object, but usually it is an icon created
9578 * with elm_icon_add().
9579 * @param end The icon object to use for the right side of the item. An
9580 * icon can be any Evas object.
9581 * @param func The function to call when the item is clicked.
9582 * @param data The data to associate with the item for related callbacks.
9584 * @return The created item or @c NULL upon failure.
9586 * A new item will be created and appended to the list, i.e., will
9587 * be set as @b last item.
9589 * Items created with this method can be deleted with
9590 * elm_list_item_del().
9592 * Associated @p data can be properly freed when item is deleted if a
9593 * callback function is set with elm_list_item_del_cb_set().
9595 * If a function is passed as argument, it will be called everytime this item
9596 * is selected, i.e., the user clicks over an unselected item.
9597 * If always select is enabled it will call this function every time
9598 * user clicks over an item (already selected or not).
9599 * If such function isn't needed, just passing
9600 * @c NULL as @p func is enough. The same should be done for @p data.
9602 * Simple example (with no function callback or data associated):
9604 * li = elm_list_add(win);
9605 * ic = elm_icon_add(win);
9606 * elm_icon_file_set(ic, "path/to/image", NULL);
9607 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
9608 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
9610 * evas_object_show(li);
9613 * @see elm_list_always_select_mode_set()
9614 * @see elm_list_item_del()
9615 * @see elm_list_item_del_cb_set()
9616 * @see elm_list_clear()
9617 * @see elm_icon_add()
9621 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);
9624 * Prepend a new item to the list object.
9626 * @param obj The list object.
9627 * @param label The label of the list item.
9628 * @param icon The icon object to use for the left side of the item. An
9629 * icon can be any Evas object, but usually it is an icon created
9630 * with elm_icon_add().
9631 * @param end The icon object to use for the right side of the item. An
9632 * icon can be any Evas object.
9633 * @param func The function to call when the item is clicked.
9634 * @param data The data to associate with the item for related callbacks.
9636 * @return The created item or @c NULL upon failure.
9638 * A new item will be created and prepended to the list, i.e., will
9639 * be set as @b first item.
9641 * Items created with this method can be deleted with
9642 * elm_list_item_del().
9644 * Associated @p data can be properly freed when item is deleted if a
9645 * callback function is set with elm_list_item_del_cb_set().
9647 * If a function is passed as argument, it will be called everytime this item
9648 * is selected, i.e., the user clicks over an unselected item.
9649 * If always select is enabled it will call this function every time
9650 * user clicks over an item (already selected or not).
9651 * If such function isn't needed, just passing
9652 * @c NULL as @p func is enough. The same should be done for @p data.
9654 * @see elm_list_item_append() for a simple code example.
9655 * @see elm_list_always_select_mode_set()
9656 * @see elm_list_item_del()
9657 * @see elm_list_item_del_cb_set()
9658 * @see elm_list_clear()
9659 * @see elm_icon_add()
9663 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);
9666 * Insert a new item into the list object before item @p before.
9668 * @param obj The list object.
9669 * @param before The list item to insert before.
9670 * @param label The label of the list item.
9671 * @param icon The icon object to use for the left side of the item. An
9672 * icon can be any Evas object, but usually it is an icon created
9673 * with elm_icon_add().
9674 * @param end The icon object to use for the right side of the item. An
9675 * icon can be any Evas object.
9676 * @param func The function to call when the item is clicked.
9677 * @param data The data to associate with the item for related callbacks.
9679 * @return The created item or @c NULL upon failure.
9681 * A new item will be created and added to the list. Its position in
9682 * this list will be just before item @p before.
9684 * Items created with this method can be deleted with
9685 * elm_list_item_del().
9687 * Associated @p data can be properly freed when item is deleted if a
9688 * callback function is set with elm_list_item_del_cb_set().
9690 * If a function is passed as argument, it will be called everytime this item
9691 * is selected, i.e., the user clicks over an unselected item.
9692 * If always select is enabled it will call this function every time
9693 * user clicks over an item (already selected or not).
9694 * If such function isn't needed, just passing
9695 * @c NULL as @p func is enough. The same should be done for @p data.
9697 * @see elm_list_item_append() for a simple code example.
9698 * @see elm_list_always_select_mode_set()
9699 * @see elm_list_item_del()
9700 * @see elm_list_item_del_cb_set()
9701 * @see elm_list_clear()
9702 * @see elm_icon_add()
9706 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);
9709 * Insert a new item into the list object after item @p after.
9711 * @param obj The list object.
9712 * @param after The list item to insert after.
9713 * @param label The label of the list item.
9714 * @param icon The icon object to use for the left side of the item. An
9715 * icon can be any Evas object, but usually it is an icon created
9716 * with elm_icon_add().
9717 * @param end The icon object to use for the right side of the item. An
9718 * icon can be any Evas object.
9719 * @param func The function to call when the item is clicked.
9720 * @param data The data to associate with the item for related callbacks.
9722 * @return The created item or @c NULL upon failure.
9724 * A new item will be created and added to the list. Its position in
9725 * this list will be just after item @p after.
9727 * Items created with this method can be deleted with
9728 * elm_list_item_del().
9730 * Associated @p data can be properly freed when item is deleted if a
9731 * callback function is set with elm_list_item_del_cb_set().
9733 * If a function is passed as argument, it will be called everytime this item
9734 * is selected, i.e., the user clicks over an unselected item.
9735 * If always select is enabled it will call this function every time
9736 * user clicks over an item (already selected or not).
9737 * If such function isn't needed, just passing
9738 * @c NULL as @p func is enough. The same should be done for @p data.
9740 * @see elm_list_item_append() for a simple code example.
9741 * @see elm_list_always_select_mode_set()
9742 * @see elm_list_item_del()
9743 * @see elm_list_item_del_cb_set()
9744 * @see elm_list_clear()
9745 * @see elm_icon_add()
9749 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);
9752 * Insert a new item into the sorted list object.
9754 * @param obj The list object.
9755 * @param label The label of the list item.
9756 * @param icon The icon object to use for the left side of the item. An
9757 * icon can be any Evas object, but usually it is an icon created
9758 * with elm_icon_add().
9759 * @param end The icon object to use for the right side of the item. An
9760 * icon can be any Evas object.
9761 * @param func The function to call when the item is clicked.
9762 * @param data The data to associate with the item for related callbacks.
9763 * @param cmp_func The comparing function to be used to sort list
9764 * items <b>by #Elm_List_Item item handles</b>. This function will
9765 * receive two items and compare them, returning a non-negative integer
9766 * if the second item should be place after the first, or negative value
9767 * if should be placed before.
9769 * @return The created item or @c NULL upon failure.
9771 * @note This function inserts values into a list object assuming it was
9772 * sorted and the result will be sorted.
9774 * A new item will be created and added to the list. Its position in
9775 * this list will be found comparing the new item with previously inserted
9776 * items using function @p cmp_func.
9778 * Items created with this method can be deleted with
9779 * elm_list_item_del().
9781 * Associated @p data can be properly freed when item is deleted if a
9782 * callback function is set with elm_list_item_del_cb_set().
9784 * If a function is passed as argument, it will be called everytime this item
9785 * is selected, i.e., the user clicks over an unselected item.
9786 * If always select is enabled it will call this function every time
9787 * user clicks over an item (already selected or not).
9788 * If such function isn't needed, just passing
9789 * @c NULL as @p func is enough. The same should be done for @p data.
9791 * @see elm_list_item_append() for a simple code example.
9792 * @see elm_list_always_select_mode_set()
9793 * @see elm_list_item_del()
9794 * @see elm_list_item_del_cb_set()
9795 * @see elm_list_clear()
9796 * @see elm_icon_add()
9800 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);
9803 * Remove all list's items.
9805 * @param obj The list object
9807 * @see elm_list_item_del()
9808 * @see elm_list_item_append()
9812 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9815 * Get a list of all the list items.
9817 * @param obj The list object
9818 * @return An @c Eina_List of list items, #Elm_List_Item,
9819 * or @c NULL on failure.
9821 * @see elm_list_item_append()
9822 * @see elm_list_item_del()
9823 * @see elm_list_clear()
9827 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9830 * Get the selected item.
9832 * @param obj The list object.
9833 * @return The selected list item.
9835 * The selected item can be unselected with function
9836 * elm_list_item_selected_set().
9838 * The selected item always will be highlighted on list.
9840 * @see elm_list_selected_items_get()
9844 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9847 * Return a list of the currently selected list items.
9849 * @param obj The list object.
9850 * @return An @c Eina_List of list items, #Elm_List_Item,
9851 * or @c NULL on failure.
9853 * Multiple items can be selected if multi select is enabled. It can be
9854 * done with elm_list_multi_select_set().
9856 * @see elm_list_selected_item_get()
9857 * @see elm_list_multi_select_set()
9861 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9864 * Set the selected state of an item.
9866 * @param item The list item
9867 * @param selected The selected state
9869 * This sets the selected state of the given item @p it.
9870 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
9872 * If a new item is selected the previosly selected will be unselected,
9873 * unless multiple selection is enabled with elm_list_multi_select_set().
9874 * Previoulsy selected item can be get with function
9875 * elm_list_selected_item_get().
9877 * Selected items will be highlighted.
9879 * @see elm_list_item_selected_get()
9880 * @see elm_list_selected_item_get()
9881 * @see elm_list_multi_select_set()
9885 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9888 * Get whether the @p item is selected or not.
9890 * @param item The list item.
9891 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
9892 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
9894 * @see elm_list_selected_item_set() for details.
9895 * @see elm_list_item_selected_get()
9899 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
9902 * Set or unset item as a separator.
9904 * @param it The list item.
9905 * @param setting @c EINA_TRUE to set item @p it as separator or
9906 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
9908 * Items aren't set as separator by default.
9910 * If set as separator it will display separator theme, so won't display
9913 * @see elm_list_item_separator_get()
9917 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
9920 * Get a value whether item is a separator or not.
9922 * @see elm_list_item_separator_set() for details.
9924 * @param it The list item.
9925 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
9926 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
9930 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
9933 * Show @p item in the list view.
9935 * @param item The list item to be shown.
9937 * It won't animate list until item is visible. If such behavior is wanted,
9938 * use elm_list_bring_in() intead.
9942 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
9945 * Bring in the given item to list view.
9947 * @param item The item.
9949 * This causes list to jump to the given item @p item and show it
9950 * (by scrolling), if it is not fully visible.
9952 * This may use animation to do so and take a period of time.
9954 * If animation isn't wanted, elm_list_item_show() can be used.
9958 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
9961 * Delete them item from the list.
9963 * @param item The item of list to be deleted.
9965 * If deleting all list items is required, elm_list_clear()
9966 * should be used instead of getting items list and deleting each one.
9968 * @see elm_list_clear()
9969 * @see elm_list_item_append()
9970 * @see elm_list_item_del_cb_set()
9974 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
9977 * Set the function called when a list item is freed.
9979 * @param item The item to set the callback on
9980 * @param func The function called
9982 * If there is a @p func, then it will be called prior item's memory release.
9983 * That will be called with the following arguments:
9985 * @li item's Evas object;
9988 * This way, a data associated to a list item could be properly freed.
9992 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9995 * Get the data associated to the item.
9997 * @param item The list item
9998 * @return The data associated to @p item
10000 * The return value is a pointer to data associated to @p item when it was
10001 * created, with function elm_list_item_append() or similar. If no data
10002 * was passed as argument, it will return @c NULL.
10004 * @see elm_list_item_append()
10008 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10011 * Get the left side icon associated to the item.
10013 * @param item The list item
10014 * @return The left side icon associated to @p item
10016 * The return value is a pointer to the icon associated to @p item when
10018 * created, with function elm_list_item_append() or similar, or later
10019 * with function elm_list_item_icon_set(). If no icon
10020 * was passed as argument, it will return @c NULL.
10022 * @see elm_list_item_append()
10023 * @see elm_list_item_icon_set()
10027 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10030 * Set the left side icon associated to the item.
10032 * @param item The list item
10033 * @param icon The left side icon object to associate with @p item
10035 * The icon object to use at left side of the item. An
10036 * icon can be any Evas object, but usually it is an icon created
10037 * with elm_icon_add().
10039 * Once the icon object is set, a previously set one will be deleted.
10040 * @warning Setting the same icon for two items will cause the icon to
10041 * dissapear from the first item.
10043 * If an icon was passed as argument on item creation, with function
10044 * elm_list_item_append() or similar, it will be already
10045 * associated to the item.
10047 * @see elm_list_item_append()
10048 * @see elm_list_item_icon_get()
10052 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
10055 * Get the right side icon associated to the item.
10057 * @param item The list item
10058 * @return The right side icon associated to @p item
10060 * The return value is a pointer to the icon associated to @p item when
10062 * created, with function elm_list_item_append() or similar, or later
10063 * with function elm_list_item_icon_set(). If no icon
10064 * was passed as argument, it will return @c NULL.
10066 * @see elm_list_item_append()
10067 * @see elm_list_item_icon_set()
10071 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10074 * Set the right side icon associated to the item.
10076 * @param item The list item
10077 * @param end The right side icon object to associate with @p item
10079 * The icon object to use at right side of the item. An
10080 * icon can be any Evas object, but usually it is an icon created
10081 * with elm_icon_add().
10083 * Once the icon object is set, a previously set one will be deleted.
10084 * @warning Setting the same icon for two items will cause the icon to
10085 * dissapear from the first item.
10087 * If an icon was passed as argument on item creation, with function
10088 * elm_list_item_append() or similar, it will be already
10089 * associated to the item.
10091 * @see elm_list_item_append()
10092 * @see elm_list_item_end_get()
10096 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
10099 * Gets the base object of the item.
10101 * @param item The list item
10102 * @return The base object associated with @p item
10104 * Base object is the @c Evas_Object that represents that item.
10108 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10111 * Get the label of item.
10113 * @param item The item of list.
10114 * @return The label of item.
10116 * The return value is a pointer to the label associated to @p item when
10117 * it was created, with function elm_list_item_append(), or later
10118 * with function elm_list_item_label_set. If no label
10119 * was passed as argument, it will return @c NULL.
10121 * @see elm_list_item_label_set() for more details.
10122 * @see elm_list_item_append()
10126 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10129 * Set the label of item.
10131 * @param item The item of list.
10132 * @param text The label of item.
10134 * The label to be displayed by the item.
10135 * Label will be placed between left and right side icons (if set).
10137 * If a label was passed as argument on item creation, with function
10138 * elm_list_item_append() or similar, it will be already
10139 * displayed by the item.
10141 * @see elm_list_item_label_get()
10142 * @see elm_list_item_append()
10146 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
10150 * Get the item before @p it in list.
10152 * @param it The list item.
10153 * @return The item before @p it, or @c NULL if none or on failure.
10155 * @note If it is the first item, @c NULL will be returned.
10157 * @see elm_list_item_append()
10158 * @see elm_list_items_get()
10162 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10165 * Get the item after @p it in list.
10167 * @param it The list item.
10168 * @return The item after @p it, or @c NULL if none or on failure.
10170 * @note If it is the last item, @c NULL will be returned.
10172 * @see elm_list_item_append()
10173 * @see elm_list_items_get()
10177 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10180 * Sets the disabled/enabled state of a list item.
10182 * @param it The item.
10183 * @param disabled The disabled state.
10185 * A disabled item cannot be selected or unselected. It will also
10186 * change its appearance (generally greyed out). This sets the
10187 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
10192 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10195 * Get a value whether list item is disabled or not.
10197 * @param it The item.
10198 * @return The disabled state.
10200 * @see elm_list_item_disabled_set() for more details.
10204 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
10207 * Set the text to be shown in a given list item's tooltips.
10209 * @param item Target item.
10210 * @param text The text to set in the content.
10212 * Setup the text as tooltip to object. The item can have only one tooltip,
10213 * so any previous tooltip data - set with this function or
10214 * elm_list_item_tooltip_content_cb_set() - is removed.
10216 * @see elm_object_tooltip_text_set() for more details.
10220 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
10223 * Set the content to be shown in the tooltip item.
10225 * Setup the tooltip to item. The item can have only one tooltip,
10226 * so any previous tooltip data is removed. @p func(with @p data) will
10227 * be called every time that need show the tooltip and it should
10228 * return a valid Evas_Object. This object is then managed fully by
10229 * tooltip system and is deleted when the tooltip is gone.
10231 * @param item the list item being attached a tooltip.
10232 * @param func the function used to create the tooltip contents.
10233 * @param data what to provide to @a func as callback data/context.
10234 * @param del_cb called when data is not needed anymore, either when
10235 * another callback replaces @a func, the tooltip is unset with
10236 * elm_list_item_tooltip_unset() or the owner @a item
10237 * dies. This callback receives as the first parameter the
10238 * given @a data, and @c event_info is the item.
10240 * @see elm_object_tooltip_content_cb_set() for more details.
10244 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);
10247 * Unset tooltip from item.
10249 * @param item list item to remove previously set tooltip.
10251 * Remove tooltip from item. The callback provided as del_cb to
10252 * elm_list_item_tooltip_content_cb_set() will be called to notify
10253 * it is not used anymore.
10255 * @see elm_object_tooltip_unset() for more details.
10256 * @see elm_list_item_tooltip_content_cb_set()
10260 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10263 * Sets a different style for this item tooltip.
10265 * @note before you set a style you should define a tooltip with
10266 * elm_list_item_tooltip_content_cb_set() or
10267 * elm_list_item_tooltip_text_set()
10269 * @param item list item with tooltip already set.
10270 * @param style the theme style to use (default, transparent, ...)
10272 * @see elm_object_tooltip_style_set() for more details.
10276 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
10279 * Get the style for this item tooltip.
10281 * @param item list item with tooltip already set.
10282 * @return style the theme style in use, defaults to "default". If the
10283 * object does not have a tooltip set, then NULL is returned.
10285 * @see elm_object_tooltip_style_get() for more details.
10286 * @see elm_list_item_tooltip_style_set()
10290 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10293 * Set the type of mouse pointer/cursor decoration to be shown,
10294 * when the mouse pointer is over the given list widget item
10296 * @param item list item to customize cursor on
10297 * @param cursor the cursor type's name
10299 * This function works analogously as elm_object_cursor_set(), but
10300 * here the cursor's changing area is restricted to the item's
10301 * area, and not the whole widget's. Note that that item cursors
10302 * have precedence over widget cursors, so that a mouse over an
10303 * item with custom cursor set will always show @b that cursor.
10305 * If this function is called twice for an object, a previously set
10306 * cursor will be unset on the second call.
10308 * @see elm_object_cursor_set()
10309 * @see elm_list_item_cursor_get()
10310 * @see elm_list_item_cursor_unset()
10314 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10317 * Get the type of mouse pointer/cursor decoration set to be shown,
10318 * when the mouse pointer is over the given list widget item
10320 * @param item list item with custom cursor set
10321 * @return the cursor type's name or @c NULL, if no custom cursors
10322 * were set to @p item (and on errors)
10324 * @see elm_object_cursor_get()
10325 * @see elm_list_item_cursor_set()
10326 * @see elm_list_item_cursor_unset()
10330 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10333 * Unset any custom mouse pointer/cursor decoration set to be
10334 * shown, when the mouse pointer is over the given list widget
10335 * item, thus making it show the @b default cursor again.
10337 * @param item a list item
10339 * Use this call to undo any custom settings on this item's cursor
10340 * decoration, bringing it back to defaults (no custom style set).
10342 * @see elm_object_cursor_unset()
10343 * @see elm_list_item_cursor_set()
10347 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
10350 * Set a different @b style for a given custom cursor set for a
10353 * @param item list item with custom cursor set
10354 * @param style the <b>theme style</b> to use (e.g. @c "default",
10355 * @c "transparent", etc)
10357 * This function only makes sense when one is using custom mouse
10358 * cursor decorations <b>defined in a theme file</b>, which can have,
10359 * given a cursor name/type, <b>alternate styles</b> on it. It
10360 * works analogously as elm_object_cursor_style_set(), but here
10361 * applyed only to list item objects.
10363 * @warning Before you set a cursor style you should have definen a
10364 * custom cursor previously on the item, with
10365 * elm_list_item_cursor_set()
10367 * @see elm_list_item_cursor_engine_only_set()
10368 * @see elm_list_item_cursor_style_get()
10372 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
10375 * Get the current @b style set for a given list item's custom
10378 * @param item list item with custom cursor set.
10379 * @return style the cursor style in use. If the object does not
10380 * have a cursor set, then @c NULL is returned.
10382 * @see elm_list_item_cursor_style_set() for more details
10386 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10389 * Set if the (custom)cursor for a given list item should be
10390 * searched in its theme, also, or should only rely on the
10391 * rendering engine.
10393 * @param item item with custom (custom) cursor already set on
10394 * @param engine_only Use @c EINA_TRUE to have cursors looked for
10395 * only on those provided by the rendering engine, @c EINA_FALSE to
10396 * have them searched on the widget's theme, as well.
10398 * @note This call is of use only if you've set a custom cursor
10399 * for list items, with elm_list_item_cursor_set().
10401 * @note By default, cursors will only be looked for between those
10402 * provided by the rendering engine.
10406 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10409 * Get if the (custom) cursor for a given list item is being
10410 * searched in its theme, also, or is only relying on the rendering
10413 * @param item a list item
10414 * @return @c EINA_TRUE, if cursors are being looked for only on
10415 * those provided by the rendering engine, @c EINA_FALSE if they
10416 * are being searched on the widget's theme, as well.
10418 * @see elm_list_item_cursor_engine_only_set(), for more details
10422 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
10429 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10430 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10431 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10432 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10433 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10434 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10435 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
10436 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10437 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10438 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
10439 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10440 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
10441 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10442 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
10443 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10444 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);
10445 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);
10446 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10447 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10448 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
10449 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
10450 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
10451 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10452 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
10453 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10454 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
10455 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10456 /* smart callbacks called:
10457 * "changed" - Whenever the slider value is changed by the user.
10458 * "slider,drag,start" - dragging the slider indicator around has started
10459 * "slider,drag,stop" - dragging the slider indicator around has stopped
10460 * "delay,changed" - A short time after the value is changed by the user.
10461 * This will be called only when the user stops dragging for a very short
10462 * period or when they release their finger/mouse, so it avoids possibly
10463 * expensive reactions to the value change.
10467 * @addtogroup Actionslider Actionslider
10469 * @image html img/icon/actionslider/preview-00.png
10470 * @image latex img/icon/actionslider/preview-00.png
10472 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
10473 * properties. The indicator is the element the user drags to choose a label.
10474 * When the position is set with magnet, when released the indicator will be
10475 * moved to it if it's nearest the magnetized position.
10477 * @note By default all positions are set as enabled.
10479 * Signals that you can add callbacks for are:
10481 * "selected" - when user selects an enabled position (the label is passed
10484 * "pos_changed" - when the indicator reaches any of the positions("left",
10485 * "right" or "center").
10487 * See an example of actionslider usage @ref actionslider_example_page "here"
10490 typedef enum _Elm_Actionslider_Pos
10492 ELM_ACTIONSLIDER_NONE = 0,
10493 ELM_ACTIONSLIDER_LEFT = 1 << 0,
10494 ELM_ACTIONSLIDER_CENTER = 1 << 1,
10495 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
10496 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
10497 } Elm_Actionslider_Pos;
10500 * Add a new actionslider to the parent.
10502 * @param parent The parent object
10503 * @return The new actionslider object or NULL if it cannot be created
10505 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10507 * Set actionslider labels.
10509 * @param obj The actionslider object
10510 * @param left_label The label to be set on the left.
10511 * @param center_label The label to be set on the center.
10512 * @param right_label The label to be set on the right.
10513 * @deprecated use elm_object_text_set() instead.
10515 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);
10517 * Get actionslider labels.
10519 * @param obj The actionslider object
10520 * @param left_label A char** to place the left_label of @p obj into.
10521 * @param center_label A char** to place the center_label of @p obj into.
10522 * @param right_label A char** to place the right_label of @p obj into.
10523 * @deprecated use elm_object_text_set() instead.
10525 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);
10527 * Get actionslider selected label.
10529 * @param obj The actionslider object
10530 * @return The selected label
10532 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10534 * Set actionslider indicator position.
10536 * @param obj The actionslider object.
10537 * @param pos The position of the indicator.
10539 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
10541 * Get actionslider indicator position.
10543 * @param obj The actionslider object.
10544 * @return The position of the indicator.
10546 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10548 * Set actionslider magnet position. To make multiple positions magnets @c or
10549 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
10551 * @param obj The actionslider object.
10552 * @param pos Bit mask indicating the magnet positions.
10554 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
10556 * Get actionslider magnet position.
10558 * @param obj The actionslider object.
10559 * @return The positions with magnet property.
10561 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10563 * Set actionslider enabled position. To set multiple positions as enabled @c or
10564 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
10566 * @note All the positions are enabled by default.
10568 * @param obj The actionslider object.
10569 * @param pos Bit mask indicating the enabled positions.
10571 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
10573 * Get actionslider enabled position.
10575 * @param obj The actionslider object.
10576 * @return The enabled positions.
10578 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10580 * Set the label used on the indicator.
10582 * @param obj The actionslider object
10583 * @param label The label to be set on the indicator.
10584 * @deprecated use elm_object_text_set() instead.
10586 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10588 * Get the label used on the indicator object.
10590 * @param obj The actionslider object
10591 * @return The indicator label
10592 * @deprecated use elm_object_text_set() instead.
10594 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10600 typedef enum _Elm_Genlist_Item_Flags
10602 ELM_GENLIST_ITEM_NONE = 0,
10603 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
10604 ELM_GENLIST_ITEM_GROUP = (1 << 1)
10605 } Elm_Genlist_Item_Flags;
10606 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
10607 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
10608 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
10609 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
10610 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
10611 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
10612 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
10613 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
10615 struct _Elm_Genlist_Item_Class
10617 const char *item_style;
10620 GenlistItemLabelGetFunc label_get;
10621 GenlistItemIconGetFunc icon_get;
10622 GenlistItemStateGetFunc state_get;
10623 GenlistItemDelFunc del;
10624 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
10626 const char *mode_item_style;
10629 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10630 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10631 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
10632 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10633 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
10634 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10635 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
10636 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10637 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10638 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10639 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
10640 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10641 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
10642 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10643 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
10644 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
10645 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
10646 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10647 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
10648 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10649 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10650 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10651 /* operations to add items */
10652 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);
10653 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);
10654 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);
10655 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);
10656 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);
10657 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);
10658 /* operations to retrieve existing items */
10659 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10660 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10661 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10662 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);
10663 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10664 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10665 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
10666 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);
10667 /* available item styles:
10669 * default_style - The text part is a textblock
10671 * icon_top_text_bottom
10673 /* Genlist Item operation */
10674 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10675 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10676 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10677 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10678 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10679 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
10680 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10681 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
10682 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10683 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10684 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10685 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10686 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
10687 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10688 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10689 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10690 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10691 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10692 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10693 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10694 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10695 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10696 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
10697 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10698 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10699 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10700 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
10701 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
10702 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
10703 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);
10704 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10705 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
10706 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10707 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10708 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10709 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10710 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
10711 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10712 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10713 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
10714 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
10715 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
10716 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10717 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10718 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
10719 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10720 /* Signals that you can add callbacks for are:
10721 * "clicked,double" - This is called when a user has double-clicked an item.
10722 * The event_info parameter is the genlist item that was
10724 * "selected" - This is called when a user has made an item selected. The
10725 * event_info parameter is the genlist item that was selected.
10726 * "unselected" - This is called when a user has made an item unselected. The
10727 * event_info parameter is the genlist item that was
10729 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
10730 * and the item is now meant to be expanded. The event_info
10731 * parameter is the genlist item that was indicated to expand.
10732 * It is the job of this callback to then fill in the child
10734 * "contracted" - This is called when elm_genlist_item_expanded_set() is
10735 * called and the item is now meant to be contracted. The
10736 * event_info parameter is the genlist item that was indicated
10737 * to contract. It is the job of this callback to then delete
10739 * "expand,request" - This is called when a user has indicated they want to
10740 * expand a tree branch item. The callback should decide
10741 * if the item can expand (has any children) and then call
10742 * elm_genlist_item_expanded_set() appropriately to set
10743 * the state. The event_info parameter is the genlist item
10744 * that was indicated to expand.
10745 * "contract,request" - This is called when a user has indicated they want to
10746 * contract a tree branch item. The callback should
10747 * decide if the item can contract (has any children)
10748 * and then call elm_genlist_item_expanded_set()
10749 * appropriately to set the state. The event_info
10750 * parameter is the genlist item that was indicated to
10752 * "realized" - This is called when the item in the list is created as a real
10753 * evas object. event_info parameter is the genlist item that
10754 * was created. The object may be deleted at any time, so it is
10755 * up to the caller to not use the object pointer from
10756 * elm_genlist_item_object_get() in a way where it may point to
10758 * "unrealized" - This is called just before an item is unrealized. After
10759 * this call icon objects provided will be deleted and the
10760 * item object itself delete or be put into a floating cache.
10761 * "drag,start,up" - This is called when the item in the list has been
10762 * dragged (not scrolled) up.
10763 * "drag,start,down" - This is called when the item in the list has been
10764 * dragged (not scrolled) down.
10765 * "drag,start,left" - This is called when the item in the list has been
10766 * dragged (not scrolled) left.
10767 * "drag,start,right" - This is called when the item in the list has been
10768 * dragged (not scrolled) right.
10769 * "drag,stop" - This is called when the item in the list has stopped being
10771 * "drag" - This is called when the item in the list is being dragged.
10772 * "longpressed" - This is called when the item is pressed for a certain
10773 * amount of time. By default it's 1 second.
10774 * "scroll,edge,top" - This is called when the genlist is scrolled until the
10776 * "scroll,edge,bottom" - This is called when the genlist is scrolled until
10778 * "scroll,edge,left" - This is called when the genlist is scrolled until the
10780 * "scroll,edge,right" - This is called when the genlist is scrolled until
10782 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
10784 * "multi,swipe,right" - This is called when the genlist is multi-touch
10786 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
10788 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
10790 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
10792 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
10794 * "swipe" - This is called when the genlist is swiped.
10798 * @page tutorial_check Check example
10799 * @dontinclude check_example_01.c
10801 * This example will show 2 checkboxes, one with just a label and the second
10802 * one with both a label and an icon. This example also ilustrates how to
10803 * have the checkbox change the value of a variable and how to react to those
10806 * We will start with the usual setup code:
10809 * And now we create our first checkbox, set its label, tell it to change
10810 * the value of @p value when the checkbox stats is changed and ask to be
10811 * notified of state changes:
10814 * For our second checkbox we are going to set an icon so we need to create
10817 * @note For simplicity we are using a rectangle as icon, but any evas object
10820 * And for our second checkbox we set the label, icon and state to true:
10823 * We now do some more setup:
10826 * And finally implement the callback that will be called when the first
10827 * checkbox's state changes. This callback will use @p data to print a
10830 * @note This work because @p data is @p value(from the main function) and @p
10831 * value is changed when the checkbox is changed.
10833 * Our example will look like this:
10835 * @image html screenshots/check_example_01.png
10836 * @image latex screenshots/check_example_01.eps width=\textwidth
10838 * @example check_example_01.c
10841 * @defgroup Check Check
10843 * @image html img/widget/button/preview-00.png
10844 * @image html img/widget/button/preview-01.png
10845 * @image html img/widget/button/preview-02.png
10847 * @brief The check widget allows for toggling a value between true and
10850 * Check objects are a lot like radio objects in layout and functionality
10851 * except they do not work as a group, but independently and only toggle the
10852 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
10853 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
10854 * returns the current state. For convenience, like the radio objects, you
10855 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
10856 * for it to modify.
10858 * Signals that you can add callbacks for are:
10859 * "changed" - This is called whenever the user changes the state of one of
10860 * the check object(event_info is NULL).
10862 * @ref tutorial_check should give you a firm grasp of how to use this widget.
10866 * @brief Add a new Check object
10868 * @param parent The parent object
10869 * @return The new object or NULL if it cannot be created
10871 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10873 * @brief Set the text label of the check object
10875 * @param obj The check object
10876 * @param label The text label string in UTF-8
10878 * @deprecated use elm_object_text_set() instead.
10880 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10882 * @brief Get the text label of the check object
10884 * @param obj The check object
10885 * @return The text label string in UTF-8
10887 * @deprecated use elm_object_text_get() instead.
10889 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10891 * @brief Set the icon object of the check object
10893 * @param obj The check object
10894 * @param icon The icon object
10896 * Once the icon object is set, a previously set one will be deleted.
10897 * If you want to keep that old content object, use the
10898 * elm_check_icon_unset() function.
10900 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10902 * @brief Get the icon object of the check object
10904 * @param obj The check object
10905 * @return The icon object
10907 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10909 * @brief Unset the icon used for the check object
10911 * @param obj The check object
10912 * @return The icon object that was being used
10914 * Unparent and return the icon object which was set for this widget.
10916 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * @brief Set the on/off state of the check object
10920 * @param obj The check object
10921 * @param state The state to use (1 == on, 0 == off)
10923 * This sets the state of the check. If set
10924 * with elm_check_state_pointer_set() the state of that variable is also
10925 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
10927 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
10929 * @brief Get the state of the check object
10931 * @param obj The check object
10932 * @return The boolean state
10934 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10936 * @brief Set a convenience pointer to a boolean to change
10938 * @param obj The check object
10939 * @param statep Pointer to the boolean to modify
10941 * This sets a pointer to a boolean, that, in addition to the check objects
10942 * state will also be modified directly. To stop setting the object pointed
10943 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
10944 * then when this is called, the check objects state will also be modified to
10945 * reflect the value of the boolean @p statep points to, just like calling
10946 * elm_check_state_set().
10948 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
10954 * @defgroup Radio Radio
10956 * @image html img/widget/radio/preview-00.png
10957 * @image latex img/widget/radio/preview-00.eps
10959 * @brief Radio is a widget that allows for 1 or more options to be displayed
10960 * and have the user choose only 1 of them.
10962 * A radio object contains an indicator, an optional Label and an optional
10963 * icon object. While it's possible to have a group of only one radio they,
10964 * are normally used in groups of 2 or more. To add a radio to a group use
10965 * elm_radio_group_add(). The radio object(s) will select from one of a set
10966 * of integer values, so any value they are configuring needs to be mapped to
10967 * a set of integers. To configure what value that radio object represents,
10968 * use elm_radio_state_value_set() to set the integer it represents. To set
10969 * the value the whole group(which one is currently selected) is to indicate
10970 * use elm_radio_value_set() on any group member, and to get the groups value
10971 * use elm_radio_value_get(). For convenience the radio objects are also able
10972 * to directly set an integer(int) to the value that is selected. To specify
10973 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
10974 * The radio objects will modify this directly. That implies the pointer must
10975 * point to valid memory for as long as the radio objects exist.
10977 * Signals that you can add callbacks for are:
10978 * @li changed - This is called whenever the user changes the state of one of
10979 * the radio objects within the group of radio objects that work together.
10981 * @ref tutorial_radio show most of this API in action.
10985 * @brief Add a new radio to the parent
10987 * @param parent The parent object
10988 * @return The new object or NULL if it cannot be created
10990 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10992 * @brief Set the text label of the radio object
10994 * @param obj The radio object
10995 * @param label The text label string in UTF-8
10997 * @deprecated use elm_object_text_set() instead.
10999 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11001 * @brief Get the text label of the radio object
11003 * @param obj The radio object
11004 * @return The text label string in UTF-8
11006 * @deprecated use elm_object_text_set() instead.
11008 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11010 * @brief Set the icon object of the radio object
11012 * @param obj The radio object
11013 * @param icon The icon object
11015 * Once the icon object is set, a previously set one will be deleted. If you
11016 * want to keep that old content object, use the elm_radio_icon_unset()
11019 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11021 * @brief Get the icon object of the radio object
11023 * @param obj The radio object
11024 * @return The icon object
11026 * @see elm_radio_icon_set()
11028 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11030 * @brief Unset the icon used for the radio object
11032 * @param obj The radio object
11033 * @return The icon object that was being used
11035 * Unparent and return the icon object which was set for this widget.
11037 * @see elm_radio_icon_set()
11039 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11041 * @brief Add this radio to a group of other radio objects
11043 * @param obj The radio object
11044 * @param group Any object whose group the @p obj is to join.
11046 * Radio objects work in groups. Each member should have a different integer
11047 * value assigned. In order to have them work as a group, they need to know
11048 * about each other. This adds the given radio object to the group of which
11049 * the group object indicated is a member.
11051 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
11053 * @brief Set the integer value that this radio object represents
11055 * @param obj The radio object
11056 * @param value The value to use if this radio object is selected
11058 * This sets the value of the radio.
11060 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
11062 * @brief Get the integer value that this radio object represents
11064 * @param obj The radio object
11065 * @return The value used if this radio object is selected
11067 * This gets the value of the radio.
11069 * @see elm_radio_value_set()
11071 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11073 * @brief Set the value of the radio.
11075 * @param obj The radio object
11076 * @param value The value to use for the group
11078 * This sets the value of the radio group and will also set the value if
11079 * pointed to, to the value supplied, but will not call any callbacks.
11081 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
11083 * @brief Get the state of the radio object
11085 * @param obj The radio object
11086 * @return The integer state
11088 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11090 * @brief Set a convenience pointer to a integer to change
11092 * @param obj The radio object
11093 * @param valuep Pointer to the integer to modify
11095 * This sets a pointer to a integer, that, in addition to the radio objects
11096 * state will also be modified directly. To stop setting the object pointed
11097 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
11098 * when this is called, the radio objects state will also be modified to
11099 * reflect the value of the integer valuep points to, just like calling
11100 * elm_radio_value_set().
11102 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
11108 * @defgroup Pager Pager
11110 * @image html img/widget/pager/preview-00.png
11111 * @image latex img/widget/pager/preview-00.eps
11113 * @brief Widget that allows flipping between 1 or more “pages” of objects.
11115 * The flipping between “pages” of objects is animated. All content in pager
11116 * is kept in a stack, the last content to be added will be on the top of the
11117 * stack(be visible).
11119 * Objects can be pushed or popped from the stack or deleted as normal.
11120 * Pushes and pops will animate (and a pop will delete the object once the
11121 * animation is finished). Any object already in the pager can be promoted to
11122 * the top(from its current stacking position) through the use of
11123 * elm_pager_content_promote(). Objects are pushed to the top with
11124 * elm_pager_content_push() and when the top item is no longer wanted, simply
11125 * pop it with elm_pager_content_pop() and it will also be deleted. If an
11126 * object is no longer needed and is not the top item, just delete it as
11127 * normal. You can query which objects are the top and bottom with
11128 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
11130 * Signals that you can add callbacks for are:
11131 * "hide,finished" - when the previous page is hided
11133 * This widget has the following styles available:
11136 * @li fade_translucide
11137 * @li fade_invisible
11138 * @note This styles affect only the flipping animations, the appearance when
11139 * not animating is unaffected by styles.
11141 * @ref tutorial_pager gives a good overview of the usage of the API.
11145 * Add a new pager to the parent
11147 * @param parent The parent object
11148 * @return The new object or NULL if it cannot be created
11152 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11154 * @brief Push an object to the top of the pager stack (and show it).
11156 * @param obj The pager object
11157 * @param content The object to push
11159 * The object pushed becomes a child of the pager, it will be controlled and
11160 * deleted when the pager is deleted.
11162 * @note If the content is already in the stack use
11163 * elm_pager_content_promote().
11164 * @warning Using this function on @p content already in the stack results in
11165 * undefined behavior.
11167 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11169 * @brief Pop the object that is on top of the stack
11171 * @param obj The pager object
11173 * This pops the object that is on the top(visible) of the pager, makes it
11174 * disappear, then deletes the object. The object that was underneath it on
11175 * the stack will become visible.
11177 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
11179 * @brief Moves an object already in the pager stack to the top of the stack.
11181 * @param obj The pager object
11182 * @param content The object to promote
11184 * This will take the @p content and move it to the top of the stack as
11185 * if it had been pushed there.
11187 * @note If the content isn't already in the stack use
11188 * elm_pager_content_push().
11189 * @warning Using this function on @p content not already in the stack
11190 * results in undefined behavior.
11192 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11194 * @brief Return the object at the bottom of the pager stack
11196 * @param obj The pager object
11197 * @return The bottom object or NULL if none
11199 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11201 * @brief Return the object at the top of the pager stack
11203 * @param obj The pager object
11204 * @return The top object or NULL if none
11206 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11211 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
11212 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
11213 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
11214 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
11215 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
11217 struct _Elm_Slideshow_Item_Class
11219 struct _Elm_Slideshow_Item_Class_Func
11221 SlideshowItemGetFunc get;
11222 SlideshowItemDelFunc del;
11226 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11227 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
11228 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);
11229 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
11230 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11231 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
11232 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11233 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
11234 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11235 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11236 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11237 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
11238 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11239 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11240 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11241 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
11242 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
11243 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11244 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
11245 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
11246 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11247 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
11248 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11249 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
11250 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11251 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
11252 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11253 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11254 /* smart callbacks called:
11255 * "changed" - when the slideshow switch to another item
11259 * @defgroup Fileselector File Selector
11261 * @image html img/icon/fileselector/preview-00.png
11262 * @image latex img/icon/fileselector/preview-00.png
11264 * A file selector is a widget that allows a user to navigate
11265 * through a file system, reporting file selections back via its
11268 * It contains shortcut buttons for home directory (@c ~) and to
11269 * jump one directory upwards (..), as well as cancel/ok buttons to
11270 * confirm/cancel a given selection. After either one of those two
11271 * former actions, the file selector will issue its @c "done" smart
11274 * There's a text entry on it, too, showing the name of the current
11275 * selection. There's the possibility of making it editable, so it
11276 * is useful on file saving dialogs on applications, where one
11277 * gives a file name to save contents to, in a given directory in
11278 * the system. This custom file name will be reported on the @c
11279 * "done" smart callback (explained in sequence).
11281 * Finally, it has a view to display file system items into in two
11286 * If Elementary is built with support of the Ethumb thumbnailing
11287 * library, the second form of view will display preview thumbnails
11288 * of files which it supports.
11290 * Smart callbacks one can register to:
11292 * - @c "selected" - the user has clicked on a file (when not in
11293 * folders-only mode) or directory (when in folders-only mode)
11294 * - @c "directory,open" - the list has been populated with new
11295 * content (@c event_info is a pointer to the directory's
11296 * path, a @b stringshared string)
11297 * - @c "done" - the user has clicked on the "ok" or "cancel"
11298 * buttons (@c event_info is a pointer to the selection's
11299 * path, a @b stringshared string)
11301 * Here is an example on its usage:
11302 * @li @ref fileselector_example
11306 * @addtogroup Fileselector
11311 * Defines how a file selector widget is to layout its contents
11312 * (file system entries).
11314 typedef enum _Elm_Fileselector_Mode
11316 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
11317 ELM_FILESELECTOR_GRID, /**< layout as a grid */
11318 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
11319 } Elm_Fileselector_Mode;
11322 * Add a new file selector widget to the given parent Elementary
11323 * (container) object
11325 * @param parent The parent object
11326 * @return a new file selector widget handle or @c NULL, on errors
11328 * This function inserts a new file selector widget on the canvas.
11330 * @ingroup Fileselector
11332 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11335 * Enable/disable the file name entry box where the user can type
11336 * in a name for a file, in a given file selector widget
11338 * @param obj The file selector object
11339 * @param is_save @c EINA_TRUE to make the file selector a "saving
11340 * dialog", @c EINA_FALSE otherwise
11342 * Having the entry editable is useful on file saving dialogs on
11343 * applications, where one gives a file name to save contents to,
11344 * in a given directory in the system. This custom file name will
11345 * be reported on the @c "done" smart callback.
11347 * @see elm_fileselector_is_save_get()
11349 * @ingroup Fileselector
11351 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
11354 * Get whether the given file selector is in "saving dialog" mode
11356 * @param obj The file selector object
11357 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
11358 * mode, @c EINA_FALSE otherwise (and on errors)
11360 * @see elm_fileselector_is_save_set() for more details
11362 * @ingroup Fileselector
11364 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11367 * Enable/disable folder-only view for a given file selector widget
11369 * @param obj The file selector object
11370 * @param only @c EINA_TRUE to make @p obj only display
11371 * directories, @c EINA_FALSE to make files to be displayed in it
11374 * If enabled, the widget's view will only display folder items,
11377 * @see elm_fileselector_folder_only_get()
11379 * @ingroup Fileselector
11381 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
11384 * Get whether folder-only view is set for a given file selector
11387 * @param obj The file selector object
11388 * @return only @c EINA_TRUE if @p obj is only displaying
11389 * directories, @c EINA_FALSE if files are being displayed in it
11390 * too (and on errors)
11392 * @see elm_fileselector_folder_only_get()
11394 * @ingroup Fileselector
11396 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11399 * Enable/disable the "ok" and "cancel" buttons on a given file
11402 * @param obj The file selector object
11403 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
11405 * @note A file selector without those buttons will never emit the
11406 * @c "done" smart event, and is only usable if one is just hooking
11407 * to the other two events.
11409 * @see elm_fileselector_buttons_ok_cancel_get()
11411 * @ingroup Fileselector
11413 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
11416 * Get whether the "ok" and "cancel" buttons on a given file
11417 * selector widget are being shown.
11419 * @param obj The file selector object
11420 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
11421 * otherwise (and on errors)
11423 * @see elm_fileselector_buttons_ok_cancel_set() for more details
11425 * @ingroup Fileselector
11427 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11430 * Enable/disable a tree view in the given file selector widget,
11431 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
11433 * @param obj The file selector object
11434 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
11437 * In a tree view, arrows are created on the sides of directories,
11438 * allowing them to expand in place.
11440 * @note If it's in other mode, the changes made by this function
11441 * will only be visible when one switches back to "list" mode.
11443 * @see elm_fileselector_expandable_get()
11445 * @ingroup Fileselector
11447 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
11450 * Get whether tree view is enabled for the given file selector
11453 * @param obj The file selector object
11454 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
11455 * otherwise (and or errors)
11457 * @see elm_fileselector_expandable_set() for more details
11459 * @ingroup Fileselector
11461 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11464 * Set, programmatically, the @b directory that a given file
11465 * selector widget will display contents from
11467 * @param obj The file selector object
11468 * @param path The path to display in @p obj
11470 * This will change the @b directory that @p obj is displaying. It
11471 * will also clear the text entry area on the @p obj object, which
11472 * displays select files' names.
11474 * @see elm_fileselector_path_get()
11476 * @ingroup Fileselector
11478 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
11481 * Get the parent directory's path that a given file selector
11482 * widget is displaying
11484 * @param obj The file selector object
11485 * @return The (full) path of the directory the file selector is
11486 * displaying, a @b stringshared string
11488 * @see elm_fileselector_path_set()
11490 * @ingroup Fileselector
11492 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11495 * Set, programmatically, the currently selected file/directory in
11496 * the given file selector widget
11498 * @param obj The file selector object
11499 * @param path The (full) path to a file or directory
11500 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
11501 * latter case occurs if the directory or file pointed to do not
11504 * @see elm_fileselector_selected_get()
11506 * @ingroup Fileselector
11508 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
11511 * Get the currently selected item's (full) path, in the given file
11514 * @param obj The file selector object
11515 * @return The absolute path of the selected item, a @b
11516 * stringshared string
11518 * @note Custom editions on @p obj object's text entry, if made,
11519 * will appear on the return string of this function, naturally.
11521 * @see elm_fileselector_selected_set() for more details
11523 * @ingroup Fileselector
11525 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11528 * Set the mode in which a given file selector widget will display
11529 * (layout) file system entries in its view
11531 * @param obj The file selector object
11532 * @param mode The mode of the fileselector, being it one of
11533 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
11534 * first one, naturally, will display the files in a list. The
11535 * latter will make the widget to display its entries in a grid
11538 * @note By using elm_fileselector_expandable_set(), the user may
11539 * trigger a tree view for that list.
11541 * @note If Elementary is built with support of the Ethumb
11542 * thumbnailing library, the second form of view will display
11543 * preview thumbnails of files which it supports. You must have
11544 * elm_need_ethumb() called in your Elementary for thumbnailing to
11547 * @see elm_fileselector_expandable_set().
11548 * @see elm_fileselector_mode_get().
11550 * @ingroup Fileselector
11552 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
11555 * Get the mode in which a given file selector widget is displaying
11556 * (layouting) file system entries in its view
11558 * @param obj The fileselector object
11559 * @return The mode in which the fileselector is at
11561 * @see elm_fileselector_mode_set() for more details
11563 * @ingroup Fileselector
11565 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11572 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11573 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
11574 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11575 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
11576 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
11577 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11578 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11579 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11580 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11581 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11582 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11583 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
11584 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11585 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
11586 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11587 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
11588 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11589 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
11590 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11591 /* smart callbacks called:
11593 /* available item styles:
11595 * wheel (simple style, no text, no progression, only pulse is available)
11599 * @defgroup Separator Separator
11601 * @brief Separator is a very thin object used to separate other objects.
11603 * A separator can be vertical or horizontal.
11605 * @ref tutorial_separator is a good example of how to use a separator.
11609 * @brief Add a separator object to @p parent
11611 * @param parent The parent object
11613 * @return The separator object, or NULL upon failure
11615 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11617 * @brief Set the horizontal mode of a separator object
11619 * @param obj The separator object
11620 * @param horizontal If true, the separator is horizontal
11622 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
11624 * @brief Get the horizontal mode of a separator object
11626 * @param obj The separator object
11627 * @return If true, the separator is horizontal
11629 * @see elm_separator_horizontal_set()
11631 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11637 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11638 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
11639 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11640 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
11641 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
11642 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
11643 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11644 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
11645 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11646 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11647 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11648 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11649 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11650 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
11651 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
11652 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11653 /* smart callbacks called:
11654 * "changed" - when the spinner value changes
11655 * "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).
11657 /* available item styles:
11659 * vertical (two up/down buttons at the right side and text left aligned)
11663 * @defgroup Index Index
11665 * @image html img/widget/index/preview-00.png
11667 * An index widget gives you an index for fast access to whichever
11668 * group of other UI items one might have. It's a list of text
11669 * items (usually letters, for alphabetically ordered access).
11671 * Index widgets are by default hidden and just appear when the
11672 * user clicks over it's reserved area in the canvas. In its
11673 * default theme, it's an area one @ref Fingers "finger" wide on
11674 * the right side of the index widget's container.
11676 * When items on the index are selected, smart callbacks get
11677 * called, so that its user can make other container objects to
11678 * show a given area or child object depending on the index item
11679 * selected. You'd probably be using an index together with @ref
11680 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
11683 * Smart events one can add callbacks for are:
11684 * - @c "changed" - When the selected index item changes. @c
11685 * event_info is the selected item's data pointer.
11686 * - @c "delay,changed" - When the selected index item changes, but
11687 * after a small idling period. @c event_info is the selected
11688 * item's data pointer.
11689 * - @c "selected" - When the user releases a mouse button and
11690 * selects an item. @c event_info is the selected item's data
11692 * - @c "level,up" - when the user moves a finger from the first
11693 * level to the second level
11694 * - @c "level,down" - when the user moves a finger from the second
11695 * level to the first level
11697 * The @c "delay,changed" event is so that it'll wait a small time
11698 * before actually reporting those events and, moreover, just the
11699 * last event happening on those time frames will actually be
11702 * Here are some examples on its usage:
11703 * @li @ref index_example_01
11704 * @li @ref index_example_02
11708 * @addtogroup Index
11712 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
11715 * Add a new index widget to the given parent Elementary
11716 * (container) object
11718 * @param parent The parent object
11719 * @return a new index widget handle or @c NULL, on errors
11721 * This function inserts a new index widget on the canvas.
11725 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11728 * Set whether a given index widget is or not visible,
11731 * @param obj The index object
11732 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
11734 * Not to be confused with visible as in @c evas_object_show() --
11735 * visible with regard to the widget's auto hiding feature.
11737 * @see elm_index_active_get()
11741 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
11744 * Get whether a given index widget is currently visible or not.
11746 * @param obj The index object
11747 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
11749 * @see elm_index_active_set() for more details
11753 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11756 * Set the items level for a given index widget.
11758 * @param obj The index object.
11759 * @param level @c 0 or @c 1, the currently implemented levels.
11761 * @see elm_index_item_level_get()
11765 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
11768 * Get the items level set for a given index widget.
11770 * @param obj The index object.
11771 * @return @c 0 or @c 1, which are the levels @p obj might be at.
11773 * @see elm_index_item_level_set() for more information
11777 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11780 * Returns the last selected item's data, for a given index widget.
11782 * @param obj The index object.
11783 * @return The item @b data associated to the last selected item on
11784 * @p obj (or @c NULL, on errors).
11786 * @warning The returned value is @b not an #Elm_Index_Item item
11787 * handle, but the data associated to it (see the @c item parameter
11788 * in elm_index_item_append(), as an example).
11792 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
11795 * Append a new item on a given index widget.
11797 * @param obj The index object.
11798 * @param letter Letter under which the item should be indexed
11799 * @param item The item data to set for the index's item
11801 * Despite the most common usage of the @p letter argument is for
11802 * single char strings, one could use arbitrary strings as index
11805 * @c item will be the pointer returned back on @c "changed", @c
11806 * "delay,changed" and @c "selected" smart events.
11810 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
11813 * Prepend a new item on a given index widget.
11815 * @param obj The index object.
11816 * @param letter Letter under which the item should be indexed
11817 * @param item The item data to set for the index's item
11819 * Despite the most common usage of the @p letter argument is for
11820 * single char strings, one could use arbitrary strings as index
11823 * @c item will be the pointer returned back on @c "changed", @c
11824 * "delay,changed" and @c "selected" smart events.
11828 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
11831 * Append a new item, on a given index widget, <b>after the item
11832 * having @p relative as data</b>.
11834 * @param obj The index object.
11835 * @param letter Letter under which the item should be indexed
11836 * @param item The item data to set for the index's item
11837 * @param relative The item data of the index item to be the
11838 * predecessor of this new one
11840 * Despite the most common usage of the @p letter argument is for
11841 * single char strings, one could use arbitrary strings as index
11844 * @c item will be the pointer returned back on @c "changed", @c
11845 * "delay,changed" and @c "selected" smart events.
11847 * @note If @p relative is @c NULL or if it's not found to be data
11848 * set on any previous item on @p obj, this function will behave as
11849 * elm_index_item_append().
11853 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
11856 * Prepend a new item, on a given index widget, <b>after the item
11857 * having @p relative as data</b>.
11859 * @param obj The index object.
11860 * @param letter Letter under which the item should be indexed
11861 * @param item The item data to set for the index's item
11862 * @param relative The item data of the index item to be the
11863 * successor of this new one
11865 * Despite the most common usage of the @p letter argument is for
11866 * single char strings, one could use arbitrary strings as index
11869 * @c item will be the pointer returned back on @c "changed", @c
11870 * "delay,changed" and @c "selected" smart events.
11872 * @note If @p relative is @c NULL or if it's not found to be data
11873 * set on any previous item on @p obj, this function will behave as
11874 * elm_index_item_prepend().
11878 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
11881 * Insert a new item into the given index widget, using @p cmp_func
11882 * function to sort items (by item data).
11884 * @param obj The index object.
11885 * @param letter Letter under which the item should be indexed
11886 * @param item The item data to set for the index's item
11887 * @param cmp_func The comparing function to be used to sort index
11888 * items <b>by #Elm_Index_Item item handles</b>
11889 * @param cmp_data_func A @b fallback function to be called for the
11890 * sorting of index items <b>by item data</b>). It will be used
11891 * when @p cmp_func returns @c 0 (equality), which means an index
11892 * item with provided item data already exists. To decide which
11893 * data item should be pointed to by the index item in question, @p
11894 * cmp_data_func will be used. If @p cmp_data_func returns a
11895 * non-negative value, the previous index item data will be
11896 * replaced by the given @p item pointer. If the previous data need
11897 * to be freed, it should be done by the @p cmp_data_func function,
11898 * because all references to it will be lost. If this function is
11899 * not provided (@c NULL is given), index items will be @b
11900 * duplicated, if @p cmp_func returns @c 0.
11902 * Despite the most common usage of the @p letter argument is for
11903 * single char strings, one could use arbitrary strings as index
11906 * @c item will be the pointer returned back on @c "changed", @c
11907 * "delay,changed" and @c "selected" smart events.
11911 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);
11914 * Remove an item from a given index widget, <b>to be referenced by
11915 * it's data value</b>.
11917 * @param obj The index object
11918 * @param item The item's data pointer for the item to be removed
11921 * If a deletion callback is set, via elm_index_item_del_cb_set(),
11922 * that callback function will be called by this one.
11924 * @warning The item to be removed from @p obj will be found via
11925 * its item data pointer, and not by an #Elm_Index_Item handle.
11929 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
11932 * Find a given index widget's item, <b>using item data</b>.
11934 * @param obj The index object
11935 * @param item The item data pointed to by the desired index item
11936 * @return The index item handle, if found, or @c NULL otherwise
11940 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
11943 * Removes @b all items from a given index widget.
11945 * @param obj The index object.
11947 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
11948 * that callback function will be called for each item in @p obj.
11952 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11955 * Go to a given items level on a index widget
11957 * @param obj The index object
11958 * @param level The index level (one of @c 0 or @c 1)
11962 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
11965 * Return the data associated with a given index widget item
11967 * @param it The index widget item handle
11968 * @return The data associated with @p it
11970 * @see elm_index_item_data_set()
11974 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
11977 * Set the data associated with a given index widget item
11979 * @param it The index widget item handle
11980 * @param data The new data pointer to set to @p it
11982 * This sets new item data on @p it.
11984 * @warning The old data pointer won't be touched by this function, so
11985 * the user had better to free that old data himself/herself.
11989 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
11992 * Set the function to be called when a given index widget item is freed.
11994 * @param it The item to set the callback on
11995 * @param func The function to call on the item's deletion
11997 * When called, @p func will have both @c data and @c event_info
11998 * arguments with the @p it item's data value and, naturally, the
11999 * @c obj argument with a handle to the parent index widget.
12003 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12006 * Get the letter (string) set on a given index widget item.
12008 * @param it The index item handle
12009 * @return The letter string set on @p it
12013 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
12020 typedef enum _Elm_Photocam_Zoom_Mode
12022 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
12023 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
12024 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
12025 ELM_PHOTOCAM_ZOOM_MODE_LAST
12026 } Elm_Photocam_Zoom_Mode;
12028 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12029 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12030 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12031 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
12032 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12033 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
12034 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12035 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
12036 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
12037 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
12038 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
12039 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
12040 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12041 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12042 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12043 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12044 /* smart callbacks called:
12045 * "clicked" - when image clicked
12046 * "press" - when mouse/finger held down initially on image
12047 * "longpressed" - when mouse/finger held for long time on image
12048 * "clicked,double" - when mouse/finger double-clicked
12049 * "load" - when photo load begins
12050 * "loaded" - when photo load done
12051 * "load,detail" - when detailed image load begins
12052 * "loaded,detail" - when detailed image load done
12053 * "zoom,start" - when zooming started
12054 * "zoom,stop" - when zooming stopped
12055 * "zoom,change" - when auto zoom mode changed zoom level
12056 * "scroll - the content has been scrolled (moved)
12057 * "scroll,anim,start" - scrolling animation has started
12058 * "scroll,anim,stop" - scrolling animation has stopped
12059 * "scroll,drag,start" - dragging the contents around has started
12060 * "scroll,drag,stop" - dragging the contents around has stopped
12064 typedef enum _Elm_Map_Zoom_Mode
12066 ELM_MAP_ZOOM_MODE_MANUAL,
12067 ELM_MAP_ZOOM_MODE_AUTO_FIT,
12068 ELM_MAP_ZOOM_MODE_AUTO_FILL,
12069 ELM_MAP_ZOOM_MODE_LAST
12070 } Elm_Map_Zoom_Mode;
12072 typedef enum _Elm_Map_Route_Sources
12074 ELM_MAP_ROUTE_SOURCE_YOURS,
12075 ELM_MAP_ROUTE_SOURCE_MONAV,
12076 ELM_MAP_ROUTE_SOURCE_ORS,
12077 ELM_MAP_ROUTE_SOURCE_LAST
12078 } Elm_Map_Route_Sources;
12080 typedef enum _Elm_Map_Name_Sources
12082 ELM_MAP_NAME_SOURCE_NOMINATIM,
12083 ELM_MAP_NAME_SOURCE_LAST
12084 } Elm_Map_Name_Sources;
12086 typedef enum _Elm_Map_Route_Type
12088 ELM_MAP_ROUTE_TYPE_MOTOCAR,
12089 ELM_MAP_ROUTE_TYPE_BICYCLE,
12090 ELM_MAP_ROUTE_TYPE_FOOT,
12091 ELM_MAP_ROUTE_TYPE_LAST
12092 } Elm_Map_Route_Type;
12094 typedef enum _Elm_Map_Route_Method
12096 ELM_MAP_ROUTE_METHOD_FASTEST,
12097 ELM_MAP_ROUTE_METHOD_SHORTEST,
12098 ELM_MAP_ROUTE_METHOD_LAST
12099 } Elm_Map_Route_Method;
12101 typedef enum _Elm_Map_Name_Method
12103 ELM_MAP_NAME_METHOD_SEARCH,
12104 ELM_MAP_NAME_METHOD_REVERSE,
12105 ELM_MAP_NAME_METHOD_LAST
12106 } Elm_Map_Name_Method;
12108 typedef struct _Elm_Map_Marker Elm_Map_Marker;
12109 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
12110 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
12111 typedef struct _Elm_Map_Route Elm_Map_Route;
12112 typedef struct _Elm_Map_Name Elm_Map_Name;
12113 typedef struct _Elm_Map_Track Elm_Map_Track;
12115 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
12116 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
12117 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
12118 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
12120 typedef char *(*ElmMapModuleSourceFunc) (void);
12121 typedef int (*ElmMapModuleZoomMinFunc) (void);
12122 typedef int (*ElmMapModuleZoomMaxFunc) (void);
12123 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
12124 typedef int (*ElmMapModuleRouteSourceFunc) (void);
12125 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
12126 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
12127 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
12128 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
12130 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12131 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
12132 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12133 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
12134 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12135 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
12136 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
12137 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
12138 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
12139 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12140 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
12141 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12142 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
12143 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);
12144 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);
12145 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
12146 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
12147 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);
12148 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);
12149 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
12150 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12151 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
12152 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12153 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12154 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
12155 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12156 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
12157 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12158 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
12159 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
12160 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
12161 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
12162 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
12163 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
12164 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
12165 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
12166 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
12167 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
12168 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
12169 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
12170 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12171 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
12172 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12173 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
12174 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12175 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
12176 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12177 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
12178 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12179 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
12180 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12181 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);
12182 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12183 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
12184 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
12185 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12186 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12187 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
12188 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
12189 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
12190 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
12191 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
12192 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);
12193 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12194 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12196 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
12198 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
12200 /* smart callbacks called:
12201 * "clicked" - when image clicked
12202 * "press" - when mouse/finger held down initially on image
12203 * "longpressed" - when mouse/finger held for long time on image
12204 * "clicked,double" - when mouse/finger double-clicked
12205 * "load,details" - when detailed image load begins
12206 * "loaded,details" - when detailed image load done
12207 * "zoom,start" - when zooming started
12208 * "zoom,stop" - when zooming stopped
12209 * "zoom,change" - when auto zoom mode changed zoom level
12210 * "scroll - the content has been scrolled (moved)
12211 * "scroll,anim,start" - scrolling animation has started
12212 * "scroll,anim,stop" - scrolling animation has stopped
12213 * "scroll,drag,start" - dragging the contents around has started
12214 * "scroll,drag,stop" - dragging the contents around has stopped
12218 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
12220 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
12222 EAPI double elm_route_lon_min_get(Evas_Object *obj);
12223 EAPI double elm_route_lat_min_get(Evas_Object *obj);
12224 EAPI double elm_route_lon_max_get(Evas_Object *obj);
12225 EAPI double elm_route_lat_max_get(Evas_Object *obj);
12229 * @defgroup Panel Panel
12231 * @image html img/widget/panel/preview-00.png
12232 * @image latex img/widget/panel/preview-00.eps
12234 * @brief A panel is a type of animated container that contains subobjects.
12235 * It can be expanded or contracted by clicking the button on it's edge.
12237 * Orientations are as follows:
12238 * @li ELM_PANEL_ORIENT_TOP
12239 * @li ELM_PANEL_ORIENT_LEFT
12240 * @li ELM_PANEL_ORIENT_RIGHT
12242 * @ref tutorial_panel shows one way to use this widget.
12245 typedef enum _Elm_Panel_Orient
12247 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
12248 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
12249 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
12250 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
12251 } Elm_Panel_Orient;
12253 * @brief Adds a panel object
12255 * @param parent The parent object
12257 * @return The panel object, or NULL on failure
12259 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12261 * @brief Sets the orientation of the panel
12263 * @param parent The parent object
12264 * @param orient The panel orientation. Can be one of the following:
12265 * @li ELM_PANEL_ORIENT_TOP
12266 * @li ELM_PANEL_ORIENT_LEFT
12267 * @li ELM_PANEL_ORIENT_RIGHT
12269 * Sets from where the panel will (dis)appear.
12271 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
12273 * @brief Get the orientation of the panel.
12275 * @param obj The panel object
12276 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
12278 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12280 * @brief Set the content of the panel.
12282 * @param obj The panel object
12283 * @param content The panel content
12285 * Once the content object is set, a previously set one will be deleted.
12286 * If you want to keep that old content object, use the
12287 * elm_panel_content_unset() function.
12289 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12291 * @brief Get the content of the panel.
12293 * @param obj The panel object
12294 * @return The content that is being used
12296 * Return the content object which is set for this widget.
12298 * @see elm_panel_content_set()
12300 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12302 * @brief Unset the content of the panel.
12304 * @param obj The panel object
12305 * @return The content that was being used
12307 * Unparent and return the content object which was set for this widget.
12309 * @see elm_panel_content_set()
12311 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12313 * @brief Set the state of the panel.
12315 * @param obj The panel object
12316 * @param hidden If true, the panel will run the animation to contract
12318 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
12320 * @brief Get the state of the panel.
12322 * @param obj The panel object
12323 * @param hidden If true, the panel is in the "hide" state
12325 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12327 * @brief Toggle the hidden state of the panel from code
12329 * @param obj The panel object
12331 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
12340 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
12341 * Add events (move, start ...)
12343 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12344 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12345 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12346 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12347 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12348 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12349 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12350 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12351 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
12352 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12353 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12356 * @defgroup Flip Flip
12358 * @image html img/widget/flip/preview-00.png
12359 * @image latex img/widget/flip/preview-00.eps
12361 * This widget holds 2 content objects(Evas_Object): one on the front and one
12362 * on the back. It allows you to flip from front to back and vice-versa using
12363 * various animations.
12365 * If either the front or back contents are not set the flip will treat that
12366 * as transparent. So if you wore to set the front content but not the back,
12367 * and then call elm_flip_go() you would see whatever is below the flip.
12369 * For a list of supported animations see elm_flip_go().
12371 * Signals that you can add callbacks for are:
12372 * "animate,begin" - when a flip animation was started
12373 * "animate,done" - when a flip animation is finished
12375 * @ref tutorial_flip show how to use most of the API.
12379 typedef enum _Elm_Flip_Mode
12381 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
12382 ELM_FLIP_ROTATE_X_CENTER_AXIS,
12383 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
12384 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
12385 ELM_FLIP_CUBE_LEFT,
12386 ELM_FLIP_CUBE_RIGHT,
12388 ELM_FLIP_CUBE_DOWN,
12389 ELM_FLIP_PAGE_LEFT,
12390 ELM_FLIP_PAGE_RIGHT,
12394 typedef enum _Elm_Flip_Interaction
12396 ELM_FLIP_INTERACTION_NONE,
12397 ELM_FLIP_INTERACTION_ROTATE,
12398 ELM_FLIP_INTERACTION_CUBE,
12399 ELM_FLIP_INTERACTION_PAGE
12400 } Elm_Flip_Interaction;
12401 typedef enum _Elm_Flip_Direction
12403 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
12404 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
12405 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
12406 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
12407 } Elm_Flip_Direction;
12409 * @brief Add a new flip to the parent
12411 * @param parent The parent object
12412 * @return The new object or NULL if it cannot be created
12414 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12416 * @brief Set the front content of the flip widget.
12418 * @param obj The flip object
12419 * @param content The new front content object
12421 * Once the content object is set, a previously set one will be deleted.
12422 * If you want to keep that old content object, use the
12423 * elm_flip_content_front_unset() function.
12425 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12427 * @brief Set the back content of the flip widget.
12429 * @param obj The flip object
12430 * @param content The new back content object
12432 * Once the content object is set, a previously set one will be deleted.
12433 * If you want to keep that old content object, use the
12434 * elm_flip_content_back_unset() function.
12436 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12438 * @brief Get the front content used for the flip
12440 * @param obj The flip object
12441 * @return The front content object that is being used
12443 * Return the front content object which is set for this widget.
12445 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12447 * @brief Get the back content used for the flip
12449 * @param obj The flip object
12450 * @return The back content object that is being used
12452 * Return the back content object which is set for this widget.
12454 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12456 * @brief Unset the front content used for the flip
12458 * @param obj The flip object
12459 * @return The front content object that was being used
12461 * Unparent and return the front content object which was set for this widget.
12463 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12465 * @brief Unset the back content used for the flip
12467 * @param obj The flip object
12468 * @return The back content object that was being used
12470 * Unparent and return the back content object which was set for this widget.
12472 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12474 * @brief Get flip front visibility state
12476 * @param obj The flip objct
12477 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
12480 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12482 * @brief Set flip perspective
12484 * @param obj The flip object
12485 * @param foc The coordinate to set the focus on
12486 * @param x The X coordinate
12487 * @param y The Y coordinate
12489 * @warning This function currently does nothing.
12491 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12493 * @brief Runs the flip animation
12495 * @param obj The flip object
12496 * @param mode The mode type
12498 * Flips the front and back contents using the @p mode animation. This
12499 * efectively hides the currently visible content and shows the hidden one.
12501 * There a number of possible animations to use for the flipping:
12502 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
12503 * around a horizontal axis in the middle of its height, the other content
12504 * is shown as the other side of the flip.
12505 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
12506 * around a vertical axis in the middle of its width, the other content is
12507 * shown as the other side of the flip.
12508 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
12509 * around a diagonal axis in the middle of its width, the other content is
12510 * shown as the other side of the flip.
12511 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
12512 * around a diagonal axis in the middle of its height, the other content is
12513 * shown as the other side of the flip.
12514 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
12515 * as if the flip was a cube, the other content is show as the right face of
12517 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
12518 * right as if the flip was a cube, the other content is show as the left
12519 * face of the cube.
12520 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
12521 * flip was a cube, the other content is show as the bottom face of the cube.
12522 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
12523 * the flip was a cube, the other content is show as the upper face of the
12525 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
12526 * if the flip was a book, the other content is shown as the page below that.
12527 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
12528 * as if the flip was a book, the other content is shown as the page below
12530 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
12531 * flip was a book, the other content is shown as the page below that.
12532 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
12533 * flip was a book, the other content is shown as the page below that.
12535 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
12537 * @brief Set the interactive flip mode
12539 * @param obj The flip object
12540 * @param mode The interactive flip mode to use
12542 * This sets if the flip should be interactive (allow user to click and
12543 * drag a side of the flip to reveal the back page and cause it to flip).
12544 * By default a flip is not interactive. You may also need to set which
12545 * sides of the flip are "active" for flipping and how much space they use
12546 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
12547 * and elm_flip_interacton_direction_hitsize_set()
12549 * The four avilable mode of interaction are:
12550 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
12551 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
12552 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
12553 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
12555 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
12556 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
12557 * happen, those can only be acheived with elm_flip_go();
12559 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
12561 * @brief Get the interactive flip mode
12563 * @param obj The flip object
12564 * @return The interactive flip mode
12566 * Returns the interactive flip mode set by elm_flip_interaction_set()
12568 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
12570 * @brief Set which directions of the flip respond to interactive flip
12572 * @param obj The flip object
12573 * @param dir The direction to change
12574 * @param enabled If that direction is enabled or not
12576 * By default all directions are disabled, so you may want to enable the
12577 * desired directions for flipping if you need interactive flipping. You must
12578 * call this function once for each direction that should be enabled.
12580 * @see elm_flip_interaction_set()
12582 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
12584 * @brief Get the enabled state of that flip direction
12586 * @param obj The flip object
12587 * @param dir The direction to check
12588 * @return If that direction is enabled or not
12590 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
12592 * @see elm_flip_interaction_set()
12594 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
12596 * @brief Set the amount of the flip that is sensitive to interactive flip
12598 * @param obj The flip object
12599 * @param dir The direction to modify
12600 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
12602 * Set the amount of the flip that is sensitive to interactive flip, with 0
12603 * representing no area in the flip and 1 representing the entire flip. There
12604 * is however a consideration to be made in that the area will never be
12605 * smaller than the finger size set(as set in your Elementary configuration).
12607 * @see elm_flip_interaction_set()
12609 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
12611 * @brief Get the amount of the flip that is sensitive to interactive flip
12613 * @param obj The flip object
12614 * @param dir The direction to check
12615 * @return The size set for that direction
12617 * Returns the amount os sensitive area set by
12618 * elm_flip_interacton_direction_hitsize_set().
12620 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
12625 /* scrolledentry */
12626 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12627 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
12628 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12629 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
12630 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12631 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12632 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12633 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12634 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12635 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12636 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12637 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12638 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12639 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12640 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12641 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12642 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12643 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12644 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12645 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12646 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12647 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12648 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12649 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12650 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12651 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12652 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12653 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12654 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12655 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12656 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12657 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12658 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12659 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12660 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12661 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);
12662 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12663 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12664 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);
12665 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12666 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);
12667 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
12668 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12669 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12670 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
12671 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
12672 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12673 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12674 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
12675 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);
12676 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);
12677 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);
12678 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);
12679 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);
12680 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);
12681 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12682 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12683 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12684 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12685 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12686 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12687 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12690 * @defgroup Conformant Conformant
12691 * @ingroup Elementary
12693 * @image html img/widget/conformant/preview-00.png
12694 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
12696 * @image html img/conformant.png
12697 * @image latex img/conformant.eps width=\textwidth
12699 * The aim is to provide a widget that can be used in elementary apps to
12700 * account for space taken up by the indicator, virtual keypad & softkey
12701 * windows when running the illume2 module of E17.
12703 * So conformant content will be sized and positioned considering the
12704 * space required for such stuff, and when they popup, as a keyboard
12705 * shows when an entry is selected, conformant content won't change.
12707 * Available styles for it:
12710 * See how to use this widget in this example:
12711 * @ref conformant_example
12715 * @addtogroup Conformant
12720 * Add a new conformant widget to the given parent Elementary
12721 * (container) object.
12723 * @param parent The parent object.
12724 * @return A new conformant widget handle or @c NULL, on errors.
12726 * This function inserts a new conformant widget on the canvas.
12728 * @ingroup Conformant
12730 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12733 * Set the content of the conformant widget.
12735 * @param obj The conformant object.
12736 * @param content The content to be displayed by the conformant.
12738 * Content will be sized and positioned considering the space required
12739 * to display a virtual keyboard. So it won't fill all the conformant
12740 * size. This way is possible to be sure that content won't resize
12741 * or be re-positioned after the keyboard is displayed.
12743 * Once the content object is set, a previously set one will be deleted.
12744 * If you want to keep that old content object, use the
12745 * elm_conformat_content_unset() function.
12747 * @see elm_conformant_content_unset()
12748 * @see elm_conformant_content_get()
12750 * @ingroup Conformant
12752 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12755 * Get the content of the conformant widget.
12757 * @param obj The conformant object.
12758 * @return The content that is being used.
12760 * Return the content object which is set for this widget.
12761 * It won't be unparent from conformant. For that, use
12762 * elm_conformant_content_unset().
12764 * @see elm_conformant_content_set() for more details.
12765 * @see elm_conformant_content_unset()
12767 * @ingroup Conformant
12769 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12772 * Unset the content of the conformant widget.
12774 * @param obj The conformant object.
12775 * @return The content that was being used.
12777 * Unparent and return the content object which was set for this widget.
12779 * @see elm_conformant_content_set() for more details.
12781 * @ingroup Conformant
12783 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12786 * Returns the Evas_Object that represents the content area.
12788 * @param obj The conformant object.
12789 * @return The content area of the widget.
12791 * @ingroup Conformant
12793 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12800 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12801 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12802 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12803 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12804 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12805 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12806 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
12807 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12808 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
12809 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12812 * @defgroup Flipselector Flip Selector
12814 * @image html img/widget/flipselector/preview-00.png
12815 * @image latex img/widget/flipselector/preview-00.eps
12817 * A flip selector is a widget to show a set of @b text items, one
12818 * at a time, with the same sheet switching style as the @ref Clock
12819 * "clock" widget, when one changes the current displaying sheet
12820 * (thus, the "flip" in the name).
12822 * User clicks to flip sheets which are @b held for some time will
12823 * make the flip selector to flip continuosly and automatically for
12824 * the user. The interval between flips will keep growing in time,
12825 * so that it helps the user to reach an item which is distant from
12826 * the current selection.
12828 * Smart callbacks one can register to:
12829 * - @c "selected" - when the widget's selected text item is changed
12830 * - @c "overflowed" - when the widget's current selection is changed
12831 * from the first item in its list to the last
12832 * - @c "underflowed" - when the widget's current selection is changed
12833 * from the last item in its list to the first
12835 * Available styles for it:
12838 * Here is an example on its usage:
12839 * @li @ref flipselector_example
12843 * @addtogroup Flipselector
12847 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
12850 * Add a new flip selector widget to the given parent Elementary
12851 * (container) widget
12853 * @param parent The parent object
12854 * @return a new flip selector widget handle or @c NULL, on errors
12856 * This function inserts a new flip selector widget on the canvas.
12858 * @ingroup Flipselector
12860 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12863 * Programmatically select the next item of a flip selector widget
12865 * @param obj The flipselector object
12867 * @note The selection will be animated. Also, if it reaches the
12868 * end of its list of member items, it will continue with the first
12871 * @ingroup Flipselector
12873 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12876 * Programmatically select the previous item of a flip selector
12879 * @param obj The flipselector object
12881 * @note The selection will be animated. Also, if it reaches the
12882 * beginning of its list of member items, it will continue with the
12883 * last one backwards.
12885 * @ingroup Flipselector
12887 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12890 * Append a (text) item to a flip selector widget
12892 * @param obj The flipselector object
12893 * @param label The (text) label of the new item
12894 * @param func Convenience callback function to take place when
12896 * @param data Data passed to @p func, above
12897 * @return A handle to the item added or @c NULL, on errors
12899 * The widget's list of labels to show will be appended with the
12900 * given value. If the user wishes so, a callback function pointer
12901 * can be passed, which will get called when this same item is
12904 * @note The current selection @b won't be modified by appending an
12905 * element to the list.
12907 * @note The maximum length of the text label is going to be
12908 * determined <b>by the widget's theme</b>. Strings larger than
12909 * that value are going to be @b truncated.
12911 * @ingroup Flipselector
12913 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
12916 * Prepend a (text) item to a flip selector widget
12918 * @param obj The flipselector object
12919 * @param label The (text) label of the new item
12920 * @param func Convenience callback function to take place when
12922 * @param data Data passed to @p func, above
12923 * @return A handle to the item added or @c NULL, on errors
12925 * The widget's list of labels to show will be prepended with the
12926 * given value. If the user wishes so, a callback function pointer
12927 * can be passed, which will get called when this same item is
12930 * @note The current selection @b won't be modified by prepending
12931 * an element to the list.
12933 * @note The maximum length of the text label is going to be
12934 * determined <b>by the widget's theme</b>. Strings larger than
12935 * that value are going to be @b truncated.
12937 * @ingroup Flipselector
12939 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
12942 * Get the internal list of items in a given flip selector widget.
12944 * @param obj The flipselector object
12945 * @return The list of items (#Elm_Flipselector_Item as data) or @c
12948 * This list is @b not to be modified in any way and must not be
12949 * freed. Use the list members with functions like
12950 * elm_flipselector_item_label_set(),
12951 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
12952 * elm_flipselector_item_del(),
12953 * elm_flipselector_item_selected_get(),
12954 * elm_flipselector_item_selected_set().
12956 * @warning This list is only valid until @p obj object's internal
12957 * items list is changed. It should be fetched again with another
12958 * call to this function when changes happen.
12960 * @ingroup Flipselector
12962 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12965 * Get the first item in the given flip selector widget's list of
12968 * @param obj The flipselector object
12969 * @return The first item or @c NULL, if it has no items (and on
12972 * @see elm_flipselector_item_append()
12973 * @see elm_flipselector_last_item_get()
12975 * @ingroup Flipselector
12977 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12980 * Get the last item in the given flip selector widget's list of
12983 * @param obj The flipselector object
12984 * @return The last item or @c NULL, if it has no items (and on
12987 * @see elm_flipselector_item_prepend()
12988 * @see elm_flipselector_first_item_get()
12990 * @ingroup Flipselector
12992 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12995 * Get the currently selected item in a flip selector widget.
12997 * @param obj The flipselector object
12998 * @return The selected item or @c NULL, if the widget has no items
13001 * @ingroup Flipselector
13003 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13006 * Set whether a given flip selector widget's item should be the
13007 * currently selected one.
13009 * @param item The flip selector item
13010 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
13012 * This sets whether @p item is or not the selected (thus, under
13013 * display) one. If @p item is different than one under display,
13014 * the latter will be unselected. If the @p item is set to be
13015 * unselected, on the other hand, the @b first item in the widget's
13016 * internal members list will be the new selected one.
13018 * @see elm_flipselector_item_selected_get()
13020 * @ingroup Flipselector
13022 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13025 * Get whether a given flip selector widget's item is the currently
13028 * @param item The flip selector item
13029 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
13032 * @see elm_flipselector_item_selected_set()
13034 * @ingroup Flipselector
13036 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13039 * Delete a given item from a flip selector widget.
13041 * @param item The item to delete
13043 * @ingroup Flipselector
13045 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13048 * Get the label of a given flip selector widget's item.
13050 * @param item The item to get label from
13051 * @return The text label of @p item or @c NULL, on errors
13053 * @see elm_flipselector_item_label_set()
13055 * @ingroup Flipselector
13057 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13060 * Set the label of a given flip selector widget's item.
13062 * @param item The item to set label on
13063 * @param label The text label string, in UTF-8 encoding
13065 * @see elm_flipselector_item_label_get()
13067 * @ingroup Flipselector
13069 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
13072 * Gets the item before @p item in a flip selector widget's
13073 * internal list of items.
13075 * @param item The item to fetch previous from
13076 * @return The item before the @p item, in its parent's list. If
13077 * there is no previous item for @p item or there's an
13078 * error, @c NULL is returned.
13080 * @see elm_flipselector_item_next_get()
13082 * @ingroup Flipselector
13084 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13087 * Gets the item after @p item in a flip selector widget's
13088 * internal list of items.
13090 * @param item The item to fetch next from
13091 * @return The item after the @p item, in its parent's list. If
13092 * there is no next item for @p item or there's an
13093 * error, @c NULL is returned.
13095 * @see elm_flipselector_item_next_get()
13097 * @ingroup Flipselector
13099 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
13102 * Set the interval on time updates for an user mouse button hold
13103 * on a flip selector widget.
13105 * @param obj The flip selector object
13106 * @param interval The (first) interval value in seconds
13108 * This interval value is @b decreased while the user holds the
13109 * mouse pointer either flipping up or flipping doww a given flip
13112 * This helps the user to get to a given item distant from the
13113 * current one easier/faster, as it will start to flip quicker and
13114 * quicker on mouse button holds.
13116 * The calculation for the next flip interval value, starting from
13117 * the one set with this call, is the previous interval divided by
13118 * 1.05, so it decreases a little bit.
13120 * The default starting interval value for automatic flips is
13123 * @see elm_flipselector_interval_get()
13125 * @ingroup Flipselector
13127 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
13130 * Get the interval on time updates for an user mouse button hold
13131 * on a flip selector widget.
13133 * @param obj The flip selector object
13134 * @return The (first) interval value, in seconds, set on it
13136 * @see elm_flipselector_interval_set() for more details
13138 * @ingroup Flipselector
13140 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13147 * @addtogroup Animator Animator
13148 * @ingroup Elementary
13150 * @brief Functions to ease creation of animations.
13152 * elm_animator is designed to provide an easy way to create animations.
13153 * Creating an animation with elm_animator is as simple as setting a
13154 * duration, an operating callback and telling it to run the animation.
13155 * However that is not the full extent of elm_animator's ability, animations
13156 * can be paused and resumed, reversed and the animation need not be linear.
13158 * To run an animation you must specify at least a duration and operation
13159 * callback, not setting any other properties will create a linear animation
13160 * that runs once and is not reversed.
13162 * @ref elm_animator_example_page_01 "This" example should make all of that
13165 * @warning elm_animator is @b not a widget.
13169 * @brief Type of curve desired for animation.
13171 * The speed in which an animation happens doesn't have to be linear, some
13172 * animations will look better if they're accelerating or decelerating, so
13173 * elm_animator provides four options in this regard:
13175 * @image html elm_animator_curve_style.png
13176 * @image latex elm_animator_curve_style.eps width=\textwidth
13177 * As can be seen in the image the speed of the animation will be:
13178 * @li ELM_ANIMATOR_CURVE_LINEAR constant
13179 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
13180 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
13181 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
13185 ELM_ANIMATOR_CURVE_LINEAR,
13186 ELM_ANIMATOR_CURVE_IN_OUT,
13187 ELM_ANIMATOR_CURVE_IN,
13188 ELM_ANIMATOR_CURVE_OUT
13189 } Elm_Animator_Curve_Style;
13190 typedef struct _Elm_Animator Elm_Animator;
13192 * Called back per loop of an elementary animators cycle
13193 * @param data user-data given to elm_animator_operation_callback_set()
13194 * @param animator the animator being run
13195 * @param double the position in the animation
13197 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
13199 * Called back when an elementary animator finishes
13200 * @param data user-data given to elm_animator_completion_callback_set()
13202 typedef void (*Elm_Animator_Completion_Cb) (void *data);
13205 * @brief Create a new animator.
13207 * @param[in] parent Parent object
13209 * The @a parent argument can be set to NULL for no parent. If a parent is set
13210 * there is no need to call elm_animator_del(), when the parent is deleted it
13211 * will delete the animator.
13212 * @deprecated Use @ref Transit instead.
13214 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
13216 * Deletes the animator freeing any resources it used. If the animator was
13217 * created with a NULL parent this must be called, otherwise it will be
13218 * automatically called when the parent is deleted.
13220 * @param[in] animator Animator object
13221 * @deprecated Use @ref Transit instead.
13223 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13225 * Set the duration of the animation.
13227 * @param[in] animator Animator object
13228 * @param[in] duration Duration in second
13229 * @deprecated Use @ref Transit instead.
13231 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
13233 * @brief Set the callback function for animator operation.
13235 * @param[in] animator Animator object
13236 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
13237 * @param[in] data Callback function user argument
13239 * The @p func callback will be called with a frame value in range [0, 1] which
13240 * indicates how far along the animation should be. It is the job of @p func to
13241 * actually change the state of any object(or objects) that are being animated.
13242 * @deprecated Use @ref Transit instead.
13244 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
13246 * Set the callback function for the when the animation ends.
13248 * @param[in] animator Animator object
13249 * @param[in] func Callback function pointe
13250 * @param[in] data Callback function user argument
13252 * @warning @a func will not be executed if elm_animator_stop() is called.
13253 * @deprecated Use @ref Transit instead.
13255 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
13257 * @brief Stop animator.
13259 * @param[in] animator Animator object
13261 * If called before elm_animator_animate() it does nothing. If there is an
13262 * animation in progress the animation will be stopped(the operation callback
13263 * will not be executed again) and it can't be restarted using
13264 * elm_animator_resume().
13265 * @deprecated Use @ref Transit instead.
13267 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13269 * Set the animator repeat count.
13271 * @param[in] animator Animator object
13272 * @param[in] repeat_cnt Repeat count
13273 * @deprecated Use @ref Transit instead.
13275 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
13277 * @brief Start animation.
13279 * @param[in] animator Animator object
13281 * This function starts the animation if the nescessary properties(duration
13282 * and operation callback) have been set. Once started the animation will
13283 * run until complete or elm_animator_stop() is called.
13284 * @deprecated Use @ref Transit instead.
13286 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13288 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
13290 * @param[in] animator Animator object
13291 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
13292 * @deprecated Use @ref Transit instead.
13294 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
13296 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
13298 * @param[in] animator Animator object
13299 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
13300 * @deprecated Use @ref Transit instead.
13302 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13304 * @brief Sets wether the animation should be automatically reversed.
13306 * @param[in] animator Animator object
13307 * @param[in] reverse Reverse or not
13309 * This controls wether the animation will be run on reverse imediately after
13310 * running forward. When this is set together with repetition the animation
13311 * will run in reverse once for each time it ran forward.@n
13312 * Runnin an animation in reverse is accomplished by calling the operation
13313 * callback with a frame value starting at 1 and diminshing until 0.
13314 * @deprecated Use @ref Transit instead.
13316 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
13318 * Gets wether the animation will automatically reversed
13320 * @param[in] animator Animator object
13321 * @deprecated Use @ref Transit instead.
13323 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13325 * Gets the status for the animator operation. The status of the animator @b
13326 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
13327 * only informs if the animation was started and has not ended(either normally
13328 * or through elm_animator_stop()).
13330 * @param[in] animator Animator object
13331 * @deprecated Use @ref Transit instead.
13333 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13335 * Gets how many times the animation will be repeated
13337 * @param[in] animator Animator object
13338 * @deprecated Use @ref Transit instead.
13340 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
13342 * Pause the animator.
13344 * @param[in] animator Animator object
13346 * This causes the animation to be temporarily stopped(the operation callback
13347 * will not be called). If the animation is not yet running this is a no-op.
13348 * Once an animation has been paused with this function it can be resumed
13349 * using elm_animator_resume().
13350 * @deprecated Use @ref Transit instead.
13352 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13354 * @brief Resumes the animator.
13356 * @param[in] animator Animator object
13358 * Resumes an animation that was paused using elm_animator_pause(), after
13359 * calling this function calls to the operation callback will happen
13360 * normally. If an animation is stopped by means of elm_animator_stop it
13361 * @b can't be restarted with this function.@n
13363 * @warning When an animation is resumed it doesn't start from where it was paused, it
13364 * will go to where it would have been if it had not been paused. If an
13365 * animation with a duration of 3 seconds is paused after 1 second for 1 second
13366 * it will resume as if it had ben animating for 2 seconds, the operating
13367 * callback will be called with a frame value of aproximately 2/3.
13368 * @deprecated Use @ref Transit instead.
13370 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
13376 * @defgroup Calendar Calendar
13377 * @ingroup Elementary
13379 * @image html img/widget/calendar/preview-00.png
13380 * @image latex img/widget/calendar/preview-00.eps
13382 * A calendar is a widget that displays a regular calendar, one
13383 * month at a time, to the user, and can allows the user to select a date.
13385 * It has support to adding check marks (holidays and checks are supported
13386 * by default theme).
13388 * Weekday names and the function used to format month and year to
13389 * be displayed can be set, giving more flexibility to this widget.
13391 * Smart callbacks one can register to:
13392 * - "changed" - emitted when the user selects a day or changes the
13393 * displayed month, what actually changes the selected day as well.
13395 * Available styles for it:
13398 * List of examples:
13399 * @li @ref calendar_example_01
13400 * @li @ref calendar_example_02
13401 * @li @ref calendar_example_03
13402 * @li @ref calendar_example_04
13403 * @li @ref calendar_example_05
13404 * @li @ref calendar_example_06
13408 * @addtogroup Calendar
13413 * @enum _Elm_Calendar_Mark_Repeat
13414 * @typedef Elm_Calendar_Mark_Repeat
13416 * Event periodicity, used to define if a mark should be repeated
13417 * @b beyond event's day. It's set when a mark is added.
13419 * So, for a mark added to 13th May with periodicity set to WEEKLY,
13420 * there will be marks every week after this date. Marks will be displayed
13421 * at 13th, 20th, 27th, 3rd June ...
13423 * Values don't work as bitmaks, only one can be choosen.
13425 * @see elm_calendar_mark_add()
13427 * @ingroup Calendar
13429 typedef enum _Elm_Calendar_Mark_Repeat
13431 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
13432 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
13433 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
13434 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*/
13435 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. */
13436 } Elm_Calendar_Mark_Repeat;
13438 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(). */
13441 * Add a new calendar widget to the given parent Elementary
13442 * (container) object.
13444 * @param parent The parent object.
13445 * @return a new calendar widget handle or @c NULL, on errors.
13447 * This function inserts a new calendar widget on the canvas.
13449 * @ref calendar_example_01
13451 * @ingroup Calendar
13453 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13456 * Get weekdays names displayed by the calendar.
13458 * @param obj The calendar object.
13459 * @return Array of seven strings to be used as weekday names.
13461 * By default, weekdays abbreviations get from system are displayed:
13462 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
13463 * The first string is related to Sunday, the second to Monday...
13465 * @see elm_calendar_weekdays_name_set()
13467 * @ref calendar_example_05
13469 * @ingroup Calendar
13471 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13474 * Set weekdays names to be displayed by the calendar.
13476 * @param obj The calendar object.
13477 * @param weedays Array of seven strings to be used as weekday names.
13478 * @warning It must have 7 elements, or it will access invalid memory.
13479 * @warning The strings must be NULL terminated ('@\0').
13481 * By default, weekdays abbreviations get from system are displayed:
13482 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
13484 * The first string should be related to Sunday, the second to Monday...
13486 * The usage should be like this:
13488 * const char *weekdays[] =
13490 * "Sunday", "Monday", "Tuesday", "Wednesday",
13491 * "Thursday", "Friday", "Saturday"
13493 * elm_calendar_weekdays_names_set(calendar, weekdays);
13496 * @see elm_calendar_weekdays_name_get()
13498 * @ref calendar_example_02
13500 * @ingroup Calendar
13502 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
13505 * Set the minimum and maximum values for the year
13507 * @param obj The calendar object
13508 * @param min The minimum year, greater than 1901;
13509 * @param max The maximum year;
13511 * Maximum must be greater than minimum, except if you don't wan't to set
13513 * Default values are 1902 and -1.
13515 * If the maximum year is a negative value, it will be limited depending
13516 * on the platform architecture (year 2037 for 32 bits);
13518 * @see elm_calendar_min_max_year_get()
13520 * @ref calendar_example_03
13522 * @ingroup Calendar
13524 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
13527 * Get the minimum and maximum values for the year
13529 * @param obj The calendar object.
13530 * @param min The minimum year.
13531 * @param max The maximum year.
13533 * Default values are 1902 and -1.
13535 * @see elm_calendar_min_max_year_get() for more details.
13537 * @ref calendar_example_05
13539 * @ingroup Calendar
13541 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
13544 * Enable or disable day selection
13546 * @param obj The calendar object.
13547 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
13550 * Enabled by default. If disabled, the user still can select months,
13551 * but not days. Selected days are highlighted on calendar.
13552 * It should be used if you won't need such selection for the widget usage.
13554 * When a day is selected, or month is changed, smart callbacks for
13555 * signal "changed" will be called.
13557 * @see elm_calendar_day_selection_enable_get()
13559 * @ref calendar_example_04
13561 * @ingroup Calendar
13563 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
13566 * Get a value whether day selection is enabled or not.
13568 * @see elm_calendar_day_selection_enable_set() for details.
13570 * @param obj The calendar object.
13571 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
13572 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
13574 * @ref calendar_example_05
13576 * @ingroup Calendar
13578 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13582 * Set selected date to be highlighted on calendar.
13584 * @param obj The calendar object.
13585 * @param selected_time A @b tm struct to represent the selected date.
13587 * Set the selected date, changing the displayed month if needed.
13588 * Selected date changes when the user goes to next/previous month or
13589 * select a day pressing over it on calendar.
13591 * @see elm_calendar_selected_time_get()
13593 * @ref calendar_example_04
13595 * @ingroup Calendar
13597 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
13600 * Get selected date.
13602 * @param obj The calendar object
13603 * @param selected_time A @b tm struct to point to selected date
13604 * @return EINA_FALSE means an error ocurred and returned time shouldn't
13607 * Get date selected by the user or set by function
13608 * elm_calendar_selected_time_set().
13609 * Selected date changes when the user goes to next/previous month or
13610 * select a day pressing over it on calendar.
13612 * @see elm_calendar_selected_time_get()
13614 * @ref calendar_example_05
13616 * @ingroup Calendar
13618 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
13621 * Set a function to format the string that will be used to display
13624 * @param obj The calendar object
13625 * @param format_function Function to set the month-year string given
13626 * the selected date
13628 * By default it uses strftime with "%B %Y" format string.
13629 * It should allocate the memory that will be used by the string,
13630 * that will be freed by the widget after usage.
13631 * A pointer to the string and a pointer to the time struct will be provided.
13636 * _format_month_year(struct tm *selected_time)
13639 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
13640 * return strdup(buf);
13643 * elm_calendar_format_function_set(calendar, _format_month_year);
13646 * @ref calendar_example_02
13648 * @ingroup Calendar
13650 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
13653 * Add a new mark to the calendar
13655 * @param obj The calendar object
13656 * @param mark_type A string used to define the type of mark. It will be
13657 * emitted to the theme, that should display a related modification on these
13658 * days representation.
13659 * @param mark_time A time struct to represent the date of inclusion of the
13660 * mark. For marks that repeats it will just be displayed after the inclusion
13661 * date in the calendar.
13662 * @param repeat Repeat the event following this periodicity. Can be a unique
13663 * mark (that don't repeat), daily, weekly, monthly or annually.
13664 * @return The created mark or @NULL upon failure.
13666 * Add a mark that will be drawn in the calendar respecting the insertion
13667 * time and periodicity. It will emit the type as signal to the widget theme.
13668 * Default theme supports "holiday" and "checked", but it can be extended.
13670 * It won't immediately update the calendar, drawing the marks.
13671 * For this, call elm_calendar_marks_draw(). However, when user selects
13672 * next or previous month calendar forces marks drawn.
13674 * Marks created with this method can be deleted with
13675 * elm_calendar_mark_del().
13679 * struct tm selected_time;
13680 * time_t current_time;
13682 * current_time = time(NULL) + 5 * 84600;
13683 * localtime_r(¤t_time, &selected_time);
13684 * elm_calendar_mark_add(cal, "holiday", selected_time,
13685 * ELM_CALENDAR_ANNUALLY);
13687 * current_time = time(NULL) + 1 * 84600;
13688 * localtime_r(¤t_time, &selected_time);
13689 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
13691 * elm_calendar_marks_draw(cal);
13694 * @see elm_calendar_marks_draw()
13695 * @see elm_calendar_mark_del()
13697 * @ref calendar_example_06
13699 * @ingroup Calendar
13701 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);
13704 * Delete mark from the calendar.
13706 * @param mark The mark to be deleted.
13708 * If deleting all calendar marks is required, elm_calendar_marks_clear()
13709 * should be used instead of getting marks list and deleting each one.
13711 * @see elm_calendar_mark_add()
13713 * @ref calendar_example_06
13715 * @ingroup Calendar
13717 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
13720 * Remove all calendar's marks
13722 * @param obj The calendar object.
13724 * @see elm_calendar_mark_add()
13725 * @see elm_calendar_mark_del()
13727 * @ingroup Calendar
13729 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13733 * Get a list of all the calendar marks.
13735 * @param obj The calendar object.
13736 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
13738 * @see elm_calendar_mark_add()
13739 * @see elm_calendar_mark_del()
13740 * @see elm_calendar_marks_clear()
13742 * @ingroup Calendar
13744 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13747 * Draw calendar marks.
13749 * @param obj The calendar object.
13751 * Should be used after adding, removing or clearing marks.
13752 * It will go through the entire marks list updating the calendar.
13753 * If lots of marks will be added, add all the marks and then call
13756 * When the month is changed, i.e. user selects next or previous month,
13757 * marks will be drawed.
13759 * @see elm_calendar_mark_add()
13760 * @see elm_calendar_mark_del()
13761 * @see elm_calendar_marks_clear()
13763 * @ref calendar_example_06
13765 * @ingroup Calendar
13767 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
13770 * Set a day text color to the same that represents Saturdays.
13772 * @param obj The calendar object.
13773 * @param pos The text position. Position is the cell counter, from left
13774 * to right, up to down. It starts on 0 and ends on 41.
13776 * @deprecated use elm_calendar_mark_add() instead like:
13779 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
13780 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
13783 * @see elm_calendar_mark_add()
13785 * @ingroup Calendar
13787 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
13790 * Set a day text color to the same that represents Sundays.
13792 * @param obj The calendar object.
13793 * @param pos The text position. Position is the cell counter, from left
13794 * to right, up to down. It starts on 0 and ends on 41.
13796 * @deprecated use elm_calendar_mark_add() instead like:
13799 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
13800 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
13803 * @see elm_calendar_mark_add()
13805 * @ingroup Calendar
13807 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
13810 * Set a day text color to the same that represents Weekdays.
13812 * @param obj The calendar object
13813 * @param pos The text position. Position is the cell counter, from left
13814 * to right, up to down. It starts on 0 and ends on 41.
13816 * @deprecated use elm_calendar_mark_add() instead like:
13819 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
13821 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
13822 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13823 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
13824 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13825 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
13826 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13827 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
13828 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
13829 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
13832 * @see elm_calendar_mark_add()
13834 * @ingroup Calendar
13836 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
13839 * Set the interval on time updates for an user mouse button hold
13840 * on calendar widgets' month selection.
13842 * @param obj The calendar object
13843 * @param interval The (first) interval value in seconds
13845 * This interval value is @b decreased while the user holds the
13846 * mouse pointer either selecting next or previous month.
13848 * This helps the user to get to a given month distant from the
13849 * current one easier/faster, as it will start to change quicker and
13850 * quicker on mouse button holds.
13852 * The calculation for the next change interval value, starting from
13853 * the one set with this call, is the previous interval divided by
13854 * 1.05, so it decreases a little bit.
13856 * The default starting interval value for automatic changes is
13859 * @see elm_calendar_interval_get()
13861 * @ingroup Calendar
13863 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
13866 * Get the interval on time updates for an user mouse button hold
13867 * on calendar widgets' month selection.
13869 * @param obj The calendar object
13870 * @return The (first) interval value, in seconds, set on it
13872 * @see elm_calendar_interval_set() for more details
13874 * @ingroup Calendar
13876 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13883 * @defgroup Diskselector Diskselector
13884 * @ingroup Elementary
13886 * @image html img/widget/diskselector/preview-00.png
13887 * @image latex img/widget/diskselector/preview-00.eps
13889 * A diskselector is a kind of list widget. It scrolls horizontally,
13890 * and can contain label and icon objects. Three items are displayed
13891 * with the selected one in the middle.
13893 * It can act like a circular list with round mode and labels can be
13894 * reduced for a defined length for side items.
13896 * Smart callbacks one can listen to:
13897 * - "selected" - when item is selected, i.e. scroller stops.
13899 * Available styles for it:
13902 * List of examples:
13903 * @li @ref diskselector_example_01
13904 * @li @ref diskselector_example_02
13908 * @addtogroup Diskselector
13912 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(). */
13915 * Add a new diskselector widget to the given parent Elementary
13916 * (container) object.
13918 * @param parent The parent object.
13919 * @return a new diskselector widget handle or @c NULL, on errors.
13921 * This function inserts a new diskselector widget on the canvas.
13923 * @ingroup Diskselector
13925 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13928 * Enable or disable round mode.
13930 * @param obj The diskselector object.
13931 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
13934 * Disabled by default. If round mode is enabled the items list will
13935 * work like a circle list, so when the user reaches the last item,
13936 * the first one will popup.
13938 * @see elm_diskselector_round_get()
13940 * @ingroup Diskselector
13942 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
13945 * Get a value whether round mode is enabled or not.
13947 * @see elm_diskselector_round_set() for details.
13949 * @param obj The diskselector object.
13950 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
13951 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
13953 * @ingroup Diskselector
13955 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13958 * Get the side labels max length.
13960 * @deprecated use elm_diskselector_side_label_length_get() instead:
13962 * @param obj The diskselector object.
13963 * @return The max length defined for side labels, or 0 if not a valid
13966 * @ingroup Diskselector
13968 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13971 * Set the side labels max length.
13973 * @deprecated use elm_diskselector_side_label_length_set() instead:
13975 * @param obj The diskselector object.
13976 * @param len The max length defined for side labels.
13978 * @ingroup Diskselector
13980 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
13983 * Get the side labels max length.
13985 * @see elm_diskselector_side_label_length_set() for details.
13987 * @param obj The diskselector object.
13988 * @return The max length defined for side labels, or 0 if not a valid
13991 * @ingroup Diskselector
13993 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13996 * Set the side labels max length.
13998 * @param obj The diskselector object.
13999 * @param len The max length defined for side labels.
14001 * Length is the number of characters of items' label that will be
14002 * visible when it's set on side positions. It will just crop
14003 * the string after defined size. E.g.:
14005 * An item with label "January" would be displayed on side position as
14006 * "Jan" if max length is set to 3, or "Janu", if this property
14009 * When it's selected, the entire label will be displayed, except for
14010 * width restrictions. In this case label will be cropped and "..."
14011 * will be concatenated.
14013 * Default side label max length is 3.
14015 * This property will be applyed over all items, included before or
14016 * later this function call.
14018 * @ingroup Diskselector
14020 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
14023 * Set the number of items to be displayed.
14025 * @param obj The diskselector object.
14026 * @param num The number of items the diskselector will display.
14028 * Default value is 3, and also it's the minimun. If @p num is less
14029 * than 3, it will be set to 3.
14031 * Also, it can be set on theme, using data item @c display_item_num
14032 * on group "elm/diskselector/item/X", where X is style set.
14035 * group { name: "elm/diskselector/item/X";
14037 * item: "display_item_num" "5";
14040 * @ingroup Diskselector
14042 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
14045 * Set bouncing behaviour when the scrolled content reaches an edge.
14047 * Tell the internal scroller object whether it should bounce or not
14048 * when it reaches the respective edges for each axis.
14050 * @param obj The diskselector object.
14051 * @param h_bounce Whether to bounce or not in the horizontal axis.
14052 * @param v_bounce Whether to bounce or not in the vertical axis.
14054 * @see elm_scroller_bounce_set()
14056 * @ingroup Diskselector
14058 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14061 * Get the bouncing behaviour of the internal scroller.
14063 * Get whether the internal scroller should bounce when the edge of each
14064 * axis is reached scrolling.
14066 * @param obj The diskselector object.
14067 * @param h_bounce Pointer where to store the bounce state of the horizontal
14069 * @param v_bounce Pointer where to store the bounce state of the vertical
14072 * @see elm_scroller_bounce_get()
14073 * @see elm_diskselector_bounce_set()
14075 * @ingroup Diskselector
14077 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14080 * Get the scrollbar policy.
14082 * @see elm_diskselector_scroller_policy_get() for details.
14084 * @param obj The diskselector object.
14085 * @param policy_h Pointer where to store horizontal scrollbar policy.
14086 * @param policy_v Pointer where to store vertical scrollbar policy.
14088 * @ingroup Diskselector
14090 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);
14093 * Set the scrollbar policy.
14095 * @param obj The diskselector object.
14096 * @param policy_h Horizontal scrollbar policy.
14097 * @param policy_v Vertical scrollbar policy.
14099 * This sets the scrollbar visibility policy for the given scroller.
14100 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14101 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14102 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14103 * This applies respectively for the horizontal and vertical scrollbars.
14105 * The both are disabled by default, i.e., are set to
14106 * #ELM_SCROLLER_POLICY_OFF.
14108 * @ingroup Diskselector
14110 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14113 * Remove all diskselector's items.
14115 * @param obj The diskselector object.
14117 * @see elm_diskselector_item_del()
14118 * @see elm_diskselector_item_append()
14120 * @ingroup Diskselector
14122 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14125 * Get a list of all the diskselector items.
14127 * @param obj The diskselector object.
14128 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
14129 * or @c NULL on failure.
14131 * @see elm_diskselector_item_append()
14132 * @see elm_diskselector_item_del()
14133 * @see elm_diskselector_clear()
14135 * @ingroup Diskselector
14137 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14140 * Appends a new item to the diskselector object.
14142 * @param obj The diskselector object.
14143 * @param label The label of the diskselector item.
14144 * @param icon The icon object to use at left side of the item. An
14145 * icon can be any Evas object, but usually it is an icon created
14146 * with elm_icon_add().
14147 * @param func The function to call when the item is selected.
14148 * @param data The data to associate with the item for related callbacks.
14150 * @return The created item or @c NULL upon failure.
14152 * A new item will be created and appended to the diskselector, i.e., will
14153 * be set as last item. Also, if there is no selected item, it will
14154 * be selected. This will always happens for the first appended item.
14156 * If no icon is set, label will be centered on item position, otherwise
14157 * the icon will be placed at left of the label, that will be shifted
14160 * Items created with this method can be deleted with
14161 * elm_diskselector_item_del().
14163 * Associated @p data can be properly freed when item is deleted if a
14164 * callback function is set with elm_diskselector_item_del_cb_set().
14166 * If a function is passed as argument, it will be called everytime this item
14167 * is selected, i.e., the user stops the diskselector with this
14168 * item on center position. If such function isn't needed, just passing
14169 * @c NULL as @p func is enough. The same should be done for @p data.
14171 * Simple example (with no function callback or data associated):
14173 * disk = elm_diskselector_add(win);
14174 * ic = elm_icon_add(win);
14175 * elm_icon_file_set(ic, "path/to/image", NULL);
14176 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14177 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
14180 * @see elm_diskselector_item_del()
14181 * @see elm_diskselector_item_del_cb_set()
14182 * @see elm_diskselector_clear()
14183 * @see elm_icon_add()
14185 * @ingroup Diskselector
14187 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);
14191 * Delete them item from the diskselector.
14193 * @param it The item of diskselector to be deleted.
14195 * If deleting all diskselector items is required, elm_diskselector_clear()
14196 * should be used instead of getting items list and deleting each one.
14198 * @see elm_diskselector_clear()
14199 * @see elm_diskselector_item_append()
14200 * @see elm_diskselector_item_del_cb_set()
14202 * @ingroup Diskselector
14204 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14207 * Set the function called when a diskselector item is freed.
14209 * @param it The item to set the callback on
14210 * @param func The function called
14212 * If there is a @p func, then it will be called prior item's memory release.
14213 * That will be called with the following arguments:
14215 * @li item's Evas object;
14218 * This way, a data associated to a diskselector item could be properly
14221 * @ingroup Diskselector
14223 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14226 * Get the data associated to the item.
14228 * @param it The diskselector item
14229 * @return The data associated to @p it
14231 * The return value is a pointer to data associated to @item when it was
14232 * created, with function elm_diskselector_item_append(). If no data
14233 * was passed as argument, it will return @c NULL.
14235 * @see elm_diskselector_item_append()
14237 * @ingroup Diskselector
14239 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14242 * Set the icon associated to the item.
14244 * @param it The diskselector item
14245 * @param icon The icon object to associate with @p it
14247 * The icon object to use at left side of the item. An
14248 * icon can be any Evas object, but usually it is an icon created
14249 * with elm_icon_add().
14251 * Once the icon object is set, a previously set one will be deleted.
14252 * @warning Setting the same icon for two items will cause the icon to
14253 * dissapear from the first item.
14255 * If an icon was passed as argument on item creation, with function
14256 * elm_diskselector_item_append(), it will be already
14257 * associated to the item.
14259 * @see elm_diskselector_item_append()
14260 * @see elm_diskselector_item_icon_get()
14262 * @ingroup Diskselector
14264 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
14267 * Get the icon associated to the item.
14269 * @param it The diskselector item
14270 * @return The icon associated to @p it
14272 * The return value is a pointer to the icon associated to @item when it was
14273 * created, with function elm_diskselector_item_append(), or later
14274 * with function elm_diskselector_item_icon_set. If no icon
14275 * was passed as argument, it will return @c NULL.
14277 * @see elm_diskselector_item_append()
14278 * @see elm_diskselector_item_icon_set()
14280 * @ingroup Diskselector
14282 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14285 * Set the label of item.
14287 * @param it The item of diskselector.
14288 * @param label The label of item.
14290 * The label to be displayed by the item.
14292 * If no icon is set, label will be centered on item position, otherwise
14293 * the icon will be placed at left of the label, that will be shifted
14296 * An item with label "January" would be displayed on side position as
14297 * "Jan" if max length is set to 3 with function
14298 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
14301 * When this @item is selected, the entire label will be displayed,
14302 * except for width restrictions.
14303 * In this case label will be cropped and "..." will be concatenated,
14304 * but only for display purposes. It will keep the entire string, so
14305 * if diskselector is resized the remaining characters will be displayed.
14307 * If a label was passed as argument on item creation, with function
14308 * elm_diskselector_item_append(), it will be already
14309 * displayed by the item.
14311 * @see elm_diskselector_side_label_lenght_set()
14312 * @see elm_diskselector_item_label_get()
14313 * @see elm_diskselector_item_append()
14315 * @ingroup Diskselector
14317 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
14320 * Get the label of item.
14322 * @param it The item of diskselector.
14323 * @return The label of item.
14325 * The return value is a pointer to the label associated to @item when it was
14326 * created, with function elm_diskselector_item_append(), or later
14327 * with function elm_diskselector_item_label_set. If no label
14328 * was passed as argument, it will return @c NULL.
14330 * @see elm_diskselector_item_label_set() for more details.
14331 * @see elm_diskselector_item_append()
14333 * @ingroup Diskselector
14335 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14338 * Get the selected item.
14340 * @param obj The diskselector object.
14341 * @return The selected diskselector item.
14343 * The selected item can be unselected with function
14344 * elm_diskselector_item_selected_set(), and the first item of
14345 * diskselector will be selected.
14347 * The selected item always will be centered on diskselector, with
14348 * full label displayed, i.e., max lenght set to side labels won't
14349 * apply on the selected item. More details on
14350 * elm_diskselector_side_label_length_set().
14352 * @ingroup Diskselector
14354 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14357 * Set the selected state of an item.
14359 * @param it The diskselector item
14360 * @param selected The selected state
14362 * This sets the selected state of the given item @p it.
14363 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14365 * If a new item is selected the previosly selected will be unselected.
14366 * Previoulsy selected item can be get with function
14367 * elm_diskselector_selected_item_get().
14369 * If the item @p it is unselected, the first item of diskselector will
14372 * Selected items will be visible on center position of diskselector.
14373 * So if it was on another position before selected, or was invisible,
14374 * diskselector will animate items until the selected item reaches center
14377 * @see elm_diskselector_item_selected_get()
14378 * @see elm_diskselector_selected_item_get()
14380 * @ingroup Diskselector
14382 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14385 * Get whether the @p item is selected or not.
14387 * @param it The diskselector item.
14388 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14389 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14391 * @see elm_diskselector_selected_item_set() for details.
14392 * @see elm_diskselector_item_selected_get()
14394 * @ingroup Diskselector
14396 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14399 * Get the first item of the diskselector.
14401 * @param obj The diskselector object.
14402 * @return The first item, or @c NULL if none.
14404 * The list of items follows append order. So it will return the first
14405 * item appended to the widget that wasn't deleted.
14407 * @see elm_diskselector_item_append()
14408 * @see elm_diskselector_items_get()
14410 * @ingroup Diskselector
14412 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14415 * Get the last item of the diskselector.
14417 * @param obj The diskselector object.
14418 * @return The last item, or @c NULL if none.
14420 * The list of items follows append order. So it will return last first
14421 * item appended to the widget that wasn't deleted.
14423 * @see elm_diskselector_item_append()
14424 * @see elm_diskselector_items_get()
14426 * @ingroup Diskselector
14428 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14431 * Get the item before @p item in diskselector.
14433 * @param it The diskselector item.
14434 * @return The item before @p item, or @c NULL if none or on failure.
14436 * The list of items follows append order. So it will return item appended
14437 * just before @item and that wasn't deleted.
14439 * If it is the first item, @c NULL will be returned.
14440 * First item can be get by elm_diskselector_first_item_get().
14442 * @see elm_diskselector_item_append()
14443 * @see elm_diskselector_items_get()
14445 * @ingroup Diskselector
14447 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14450 * Get the item after @p item in diskselector.
14452 * @param it The diskselector item.
14453 * @return The item after @p item, or @c NULL if none or on failure.
14455 * The list of items follows append order. So it will return item appended
14456 * just after @item and that wasn't deleted.
14458 * If it is the last item, @c NULL will be returned.
14459 * Last item can be get by elm_diskselector_last_item_get().
14461 * @see elm_diskselector_item_append()
14462 * @see elm_diskselector_items_get()
14464 * @ingroup Diskselector
14466 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14469 * Set the text to be shown in the diskselector item.
14471 * @param item Target item
14472 * @param text The text to set in the content
14474 * Setup the text as tooltip to object. The item can have only one tooltip,
14475 * so any previous tooltip data is removed.
14477 * @see elm_object_tooltip_text_set() for more details.
14479 * @ingroup Diskselector
14481 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
14484 * Set the content to be shown in the tooltip item.
14486 * Setup the tooltip to item. The item can have only one tooltip,
14487 * so any previous tooltip data is removed. @p func(with @p data) will
14488 * be called every time that need show the tooltip and it should
14489 * return a valid Evas_Object. This object is then managed fully by
14490 * tooltip system and is deleted when the tooltip is gone.
14492 * @param item the diskselector item being attached a tooltip.
14493 * @param func the function used to create the tooltip contents.
14494 * @param data what to provide to @a func as callback data/context.
14495 * @param del_cb called when data is not needed anymore, either when
14496 * another callback replaces @func, the tooltip is unset with
14497 * elm_diskselector_item_tooltip_unset() or the owner @a item
14498 * dies. This callback receives as the first parameter the
14499 * given @a data, and @c event_info is the item.
14501 * @see elm_object_tooltip_content_cb_set() for more details.
14503 * @ingroup Diskselector
14505 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);
14508 * Unset tooltip from item.
14510 * @param item diskselector item to remove previously set tooltip.
14512 * Remove tooltip from item. The callback provided as del_cb to
14513 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
14514 * it is not used anymore.
14516 * @see elm_object_tooltip_unset() for more details.
14517 * @see elm_diskselector_item_tooltip_content_cb_set()
14519 * @ingroup Diskselector
14521 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14525 * Sets a different style for this item tooltip.
14527 * @note before you set a style you should define a tooltip with
14528 * elm_diskselector_item_tooltip_content_cb_set() or
14529 * elm_diskselector_item_tooltip_text_set()
14531 * @param item diskselector item with tooltip already set.
14532 * @param style the theme style to use (default, transparent, ...)
14534 * @see elm_object_tooltip_style_set() for more details.
14536 * @ingroup Diskselector
14538 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
14541 * Get the style for this item tooltip.
14543 * @param item diskselector item with tooltip already set.
14544 * @return style the theme style in use, defaults to "default". If the
14545 * object does not have a tooltip set, then NULL is returned.
14547 * @see elm_object_tooltip_style_get() for more details.
14548 * @see elm_diskselector_item_tooltip_style_set()
14550 * @ingroup Diskselector
14552 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14555 * Set the cursor to be shown when mouse is over the diskselector item
14557 * @param item Target item
14558 * @param cursor the cursor name to be used.
14560 * @see elm_object_cursor_set() for more details.
14562 * @ingroup Diskselector
14564 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14567 * Get the cursor to be shown when mouse is over the diskselector item
14569 * @param item diskselector item with cursor already set.
14570 * @return the cursor name.
14572 * @see elm_object_cursor_get() for more details.
14573 * @see elm_diskselector_cursor_set()
14575 * @ingroup Diskselector
14577 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14581 * Unset the cursor to be shown when mouse is over the diskselector item
14583 * @param item Target item
14585 * @see elm_object_cursor_unset() for more details.
14586 * @see elm_diskselector_cursor_set()
14588 * @ingroup Diskselector
14590 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14593 * Sets a different style for this item cursor.
14595 * @note before you set a style you should define a cursor with
14596 * elm_diskselector_item_cursor_set()
14598 * @param item diskselector item with cursor already set.
14599 * @param style the theme style to use (default, transparent, ...)
14601 * @see elm_object_cursor_style_set() for more details.
14603 * @ingroup Diskselector
14605 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
14609 * Get the style for this item cursor.
14611 * @param item diskselector item with cursor already set.
14612 * @return style the theme style in use, defaults to "default". If the
14613 * object does not have a cursor set, then @c NULL is returned.
14615 * @see elm_object_cursor_style_get() for more details.
14616 * @see elm_diskselector_item_cursor_style_set()
14618 * @ingroup Diskselector
14620 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14624 * Set if the cursor set should be searched on the theme or should use
14625 * the provided by the engine, only.
14627 * @note before you set if should look on theme you should define a cursor
14628 * with elm_diskselector_item_cursor_set().
14629 * By default it will only look for cursors provided by the engine.
14631 * @param item widget item with cursor already set.
14632 * @param engine_only boolean to define if cursors set with
14633 * elm_diskselector_item_cursor_set() should be searched only
14634 * between cursors provided by the engine or searched on widget's
14637 * @see elm_object_cursor_engine_only_set() for more details.
14639 * @ingroup Diskselector
14641 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14644 * Get the cursor engine only usage for this item cursor.
14646 * @param item widget item with cursor already set.
14647 * @return engine_only boolean to define it cursors should be looked only
14648 * between the provided by the engine or searched on widget's theme as well.
14649 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
14651 * @see elm_object_cursor_engine_only_get() for more details.
14652 * @see elm_diskselector_item_cursor_engine_only_set()
14654 * @ingroup Diskselector
14656 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14663 * @page tutorial_colorselector Color selector example
14664 * @dontinclude colorselector_example_01.c
14666 * This example shows how to change the color of a rectangle using a color
14667 * selector. We aren't going to explain a lot of the code since it's the
14668 * usual setup code:
14669 * @until show(rect)
14671 * Now that we have a window with background and a rectangle we can create
14672 * our color_selector and set it's initial color to fully opaque blue:
14675 * Next we tell ask to be notified whenever the color changes:
14678 * We follow that we some more run of the mill setup code:
14679 * @until ELM_MAIN()
14681 * And now get to the callback that sets the color of the rectangle:
14684 * This example will look like this:
14686 * @image html screenshots/colorselector_example_01.png
14687 * @image latex screenshots/colorselector_example_01.eps width=\textwidth
14689 * @example colorselector_example_01.c
14692 * @defgroup Colorselector Colorselector
14696 * @image html img/widget/colorselector/preview-00.png
14698 * @brief Widget for user to select a color.
14700 * Signals that you can add callbacks for are:
14701 * "changed" - When the color value changes(event_info is NULL).
14703 * See @ref tutorial_colorselector.
14706 * @brief Add a new colorselector to the parent
14708 * @param parent The parent object
14709 * @return The new object or NULL if it cannot be created
14711 * @ingroup Colorselector
14713 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14715 * Set a color for the colorselector
14717 * @param obj Colorselector object
14718 * @param r r-value of color
14719 * @param g g-value of color
14720 * @param b b-value of color
14721 * @param a a-value of color
14723 * @ingroup Colorselector
14725 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
14727 * Get a color from the colorselector
14729 * @param obj Colorselector object
14730 * @param r integer pointer for r-value of color
14731 * @param g integer pointer for g-value of color
14732 * @param b integer pointer for b-value of color
14733 * @param a integer pointer for a-value of color
14735 * @ingroup Colorselector
14737 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
14743 * @defgroup Ctxpopup
14745 * @image html img/widget/ctxpopup/preview-00.png
14746 * @image latex img/widget/ctxpopup/preview-00.eps
14748 * @brief Context popup widet.
14750 * A ctxpopup is a widget that, when shown, pops up a list of items.
14751 * It automatically chooses an area inside its parent object's view
14752 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
14753 * optimally fit into it. In the default theme, it will also point an
14754 * arrow to it's top left position at the time one shows it. Ctxpopup
14755 * items have a label and/or an icon. It is intended for a small
14756 * number of items (hence the use of list, not genlist).
14758 * @note Ctxpopup is a especialization of @ref Hover.
14760 * Signals that you can add callbacks for are:
14761 * "dismissed" - the ctxpopup was dismissed
14763 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
14766 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
14768 typedef enum _Elm_Ctxpopup_Direction
14770 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
14772 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
14773 the clicked area */
14774 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
14775 the clicked area */
14776 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
14778 } Elm_Ctxpopup_Direction;
14781 * @brief Add a new Ctxpopup object to the parent.
14783 * @param parent Parent object
14784 * @return New object or @c NULL, if it cannot be created
14786 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14788 * @brief Set the Ctxpopup's parent
14790 * @param obj The ctxpopup object
14791 * @param area The parent to use
14793 * Set the parent object.
14795 * @note elm_ctxpopup_add() will automatically call this function
14796 * with its @c parent argument.
14798 * @see elm_ctxpopup_add()
14799 * @see elm_hover_parent_set()
14801 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
14803 * @brief Get the Ctxpopup's parent
14805 * @param obj The ctxpopup object
14807 * @see elm_ctxpopup_hover_parent_set() for more information
14809 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14811 * @brief Clear all items in the given ctxpopup object.
14813 * @param obj Ctxpopup object
14815 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14817 * @brief Change the ctxpopup's orientation to horizontal or vertical.
14819 * @param obj Ctxpopup object
14820 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
14822 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14824 * @brief Get the value of current ctxpopup object's orientation.
14826 * @param obj Ctxpopup object
14827 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
14829 * @see elm_ctxpopup_horizontal_set()
14831 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14833 * @brief Add a new item to a ctxpopup object.
14835 * @param obj Ctxpopup object
14836 * @param icon Icon to be set on new item
14837 * @param label The Label of the new item
14838 * @param func Convenience function called when item selected
14839 * @param data Data passed to @p func
14840 * @return A handle to the item added or @c NULL, on errors
14842 * @warning Ctxpopup can't hold both an item list and a content at the same
14843 * time. When an item is added, any previous content will be removed.
14845 * @see elm_ctxpopup_content_set()
14847 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);
14849 * @brief Delete the given item in a ctxpopup object.
14851 * @param item Ctxpopup item to be deleted
14853 * @see elm_ctxpopup_item_append()
14855 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14857 * @brief Set the ctxpopup item's state as disabled or enabled.
14859 * @param item Ctxpopup item to be enabled/disabled
14860 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
14862 * When disabled the item is greyed out to indicate it's state.
14864 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14866 * @brief Get the ctxpopup item's disabled/enabled state.
14868 * @param item Ctxpopup item to be enabled/disabled
14869 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
14871 * @see elm_ctxpopup_item_disabled_set()
14873 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14875 * @brief Get the icon object for the given ctxpopup item.
14877 * @param item Ctxpopup item
14878 * @return icon object or @c NULL, if the item does not have icon or an error
14881 * @see elm_ctxpopup_item_append()
14882 * @see elm_ctxpopup_item_icon_set()
14884 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14886 * @brief Sets the side icon associated with the ctxpopup item
14888 * @param item Ctxpopup item
14889 * @param icon Icon object to be set
14891 * Once the icon object is set, a previously set one will be deleted.
14892 * @warning Setting the same icon for two items will cause the icon to
14893 * dissapear from the first item.
14895 * @see elm_ctxpopup_item_append()
14897 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
14899 * @brief Get the label for the given ctxpopup item.
14901 * @param item Ctxpopup item
14902 * @return label string or @c NULL, if the item does not have label or an
14905 * @see elm_ctxpopup_item_append()
14906 * @see elm_ctxpopup_item_label_set()
14908 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14910 * @brief (Re)set the label on the given ctxpopup item.
14912 * @param item Ctxpopup item
14913 * @param label String to set as label
14915 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
14917 * @brief Set an elm widget as the content of the ctxpopup.
14919 * @param obj Ctxpopup object
14920 * @param content Content to be swallowed
14922 * If the content object is already set, a previous one will bedeleted. If
14923 * you want to keep that old content object, use the
14924 * elm_ctxpopup_content_unset() function.
14926 * @warning Ctxpopup can't hold both a item list and a content at the same
14927 * time. When a content is set, any previous items will be removed.
14929 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
14931 * @brief Unset the ctxpopup content
14933 * @param obj Ctxpopup object
14934 * @return The content that was being used
14936 * Unparent and return the content object which was set for this widget.
14938 * @see elm_ctxpopup_content_set()
14940 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14942 * @brief Set the direction priority of a ctxpopup.
14944 * @param obj Ctxpopup object
14945 * @param first 1st priority of direction
14946 * @param second 2nd priority of direction
14947 * @param third 3th priority of direction
14948 * @param fourth 4th priority of direction
14950 * This functions gives a chance to user to set the priority of ctxpopup
14951 * showing direction. This doesn't guarantee the ctxpopup will appear in the
14952 * requested direction.
14954 * @see Elm_Ctxpopup_Direction
14956 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);
14958 * @brief Get the direction priority of a ctxpopup.
14960 * @param obj Ctxpopup object
14961 * @param first 1st priority of direction to be returned
14962 * @param second 2nd priority of direction to be returned
14963 * @param third 3th priority of direction to be returned
14964 * @param fourth 4th priority of direction to be returned
14966 * @see elm_ctxpopup_direction_priority_set() for more information.
14968 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);
14976 * @defgroup Transit Transit
14977 * @ingroup Elementary
14979 * Transit is designed to apply various animated transition effects to @c
14980 * Evas_Object, such like translation, rotation, etc. For using these
14981 * effects, create an @ref Elm_Transit and add the desired transition effects.
14983 * Once the effects are added into transit, they will be automatically
14984 * managed (their callback will be called until the duration is ended, and
14985 * they will be deleted on completion).
14989 * Elm_Transit *trans = elm_transit_add();
14990 * elm_transit_object_add(trans, obj);
14991 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
14992 * elm_transit_duration_set(transit, 1);
14993 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
14994 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
14995 * elm_transit_repeat_times_set(transit, 3);
14998 * Some transition effects are used to change the properties of objects. They
15000 * @li @ref elm_transit_effect_translation_add
15001 * @li @ref elm_transit_effect_color_add
15002 * @li @ref elm_transit_effect_rotation_add
15003 * @li @ref elm_transit_effect_wipe_add
15004 * @li @ref elm_transit_effect_zoom_add
15005 * @li @ref elm_transit_effect_resizing_add
15007 * Other transition effects are used to make one object disappear and another
15008 * object appear on its old place. These effects are:
15010 * @li @ref elm_transit_effect_flip_add
15011 * @li @ref elm_transit_effect_resizable_flip_add
15012 * @li @ref elm_transit_effect_fade_add
15013 * @li @ref elm_transit_effect_blend_add
15015 * It's also possible to make a transition chain with @ref
15016 * elm_transit_chain_transit_add.
15018 * @warning We strongly recommend to use elm_transit just when edje can not do
15019 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
15020 * animations can be manipulated inside the theme.
15022 * List of examples:
15023 * @li @ref transit_example_01_explained
15024 * @li @ref transit_example_02_explained
15025 * @li @ref transit_example_03_c
15026 * @li @ref transit_example_04_c
15032 * @enum Elm_Transit_Tween_Mode
15034 * The type of acceleration used in the transition.
15038 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
15039 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
15040 over time, then decrease again
15042 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
15044 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
15046 } Elm_Transit_Tween_Mode;
15049 * @enum Elm_Transit_Effect_Flip_Axis
15051 * The axis where flip effect should be applied.
15055 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
15056 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
15057 } Elm_Transit_Effect_Flip_Axis;
15059 * @enum Elm_Transit_Effect_Wipe_Dir
15061 * The direction where the wipe effect should occur.
15065 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
15066 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
15067 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
15068 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
15069 } Elm_Transit_Effect_Wipe_Dir;
15070 /** @enum Elm_Transit_Effect_Wipe_Type
15072 * Whether the wipe effect should show or hide the object.
15076 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
15078 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
15080 } Elm_Transit_Effect_Wipe_Type;
15083 * @typedef Elm_Transit
15085 * The Transit created with elm_transit_add(). This type has the information
15086 * about the objects which the transition will be applied, and the
15087 * transition effects that will be used. It also contains info about
15088 * duration, number of repetitions, auto-reverse, etc.
15090 typedef struct _Elm_Transit Elm_Transit;
15091 typedef void Elm_Transit_Effect;
15093 * @typedef Elm_Transit_Effect_Transition_Cb
15095 * Transition callback called for this effect on each transition iteration.
15097 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
15099 * Elm_Transit_Effect_End_Cb
15101 * Transition callback called for this effect when the transition is over.
15103 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
15106 * Elm_Transit_Del_Cb
15108 * A callback called when the transit is deleted.
15110 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
15115 * @note Is not necessary to delete the transit object, it will be deleted at
15116 * the end of its operation.
15117 * @note The transit will start playing when the program enter in the main loop, is not
15118 * necessary to give a start to the transit.
15120 * @return The transit object.
15124 EAPI Elm_Transit *elm_transit_add(void);
15127 * Stops the animation and delete the @p transit object.
15129 * Call this function if you wants to stop the animation before the duration
15130 * time. Make sure the @p transit object is still alive with
15131 * elm_transit_del_cb_set() function.
15132 * All added effects will be deleted, calling its repective data_free_cb
15133 * functions. The function setted by elm_transit_del_cb_set() will be called.
15135 * @see elm_transit_del_cb_set()
15137 * @param transit The transit object to be deleted.
15140 * @warning Just call this function if you are sure the transit is alive.
15142 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
15145 * Add a new effect to the transit.
15147 * @note The cb function and the data are the key to the effect. If you try to
15148 * add an already added effect, nothing is done.
15149 * @note After the first addition of an effect in @p transit, if its
15150 * effect list become empty again, the @p transit will be killed by
15151 * elm_transit_del(transit) function.
15155 * Elm_Transit *transit = elm_transit_add();
15156 * elm_transit_effect_add(transit,
15157 * elm_transit_effect_blend_op,
15158 * elm_transit_effect_blend_context_new(),
15159 * elm_transit_effect_blend_context_free);
15162 * @param transit The transit object.
15163 * @param transition_cb The operation function. It is called when the
15164 * animation begins, it is the function that actually performs the animation.
15165 * It is called with the @p data, @p transit and the time progression of the
15166 * animation (a double value between 0.0 and 1.0).
15167 * @param effect The context data of the effect.
15168 * @param end_cb The function to free the context data, it will be called
15169 * at the end of the effect, it must finalize the animation and free the
15173 * @warning The transit free the context data at the and of the transition with
15174 * the data_free_cb function, do not use the context data in another transit.
15176 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);
15179 * Delete an added effect.
15181 * This function will remove the effect from the @p transit, calling the
15182 * data_free_cb to free the @p data.
15184 * @see elm_transit_effect_add()
15186 * @note If the effect is not found, nothing is done.
15187 * @note If the effect list become empty, this function will call
15188 * elm_transit_del(transit), that is, it will kill the @p transit.
15190 * @param transit The transit object.
15191 * @param transition_cb The operation function.
15192 * @param effect The context data of the effect.
15196 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);
15199 * Add new object to apply the effects.
15201 * @note After the first addition of an object in @p transit, if its
15202 * object list become empty again, the @p transit will be killed by
15203 * elm_transit_del(transit) function.
15204 * @note If the @p obj belongs to another transit, the @p obj will be
15205 * removed from it and it will only belong to the @p transit. If the old
15206 * transit stays without objects, it will die.
15207 * @note When you add an object into the @p transit, its state from
15208 * evas_object_pass_events_get(obj) is saved, and it is applied when the
15209 * transit ends, if you change this state whith evas_object_pass_events_set()
15210 * after add the object, this state will change again when @p transit stops to
15213 * @param transit The transit object.
15214 * @param obj Object to be animated.
15217 * @warning It is not allowed to add a new object after transit begins to go.
15219 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
15222 * Removes an added object from the transit.
15224 * @note If the @p obj is not in the @p transit, nothing is done.
15225 * @note If the list become empty, this function will call
15226 * elm_transit_del(transit), that is, it will kill the @p transit.
15228 * @param transit The transit object.
15229 * @param obj Object to be removed from @p transit.
15232 * @warning It is not allowed to remove objects after transit begins to go.
15234 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
15237 * Get the objects of the transit.
15239 * @param transit The transit object.
15240 * @return a Eina_List with the objects from the transit.
15244 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15247 * Enable/disable keeping up the objects states.
15248 * If it is not kept, the objects states will be reset when transition ends.
15250 * @note @p transit can not be NULL.
15251 * @note One state includes geometry, color, map data.
15253 * @param transit The transit object.
15254 * @param state_keep Keeping or Non Keeping.
15258 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
15261 * Get a value whether the objects states will be reset or not.
15263 * @note @p transit can not be NULL
15265 * @see elm_transit_objects_final_state_keep_set()
15267 * @param transit The transit object.
15268 * @return EINA_TRUE means the states of the objects will be reset.
15269 * If @p transit is NULL, EINA_FALSE is returned
15273 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15276 * Set the event enabled when transit is operating.
15278 * If @p enabled is EINA_TRUE, the objects of the transit will receives
15279 * events from mouse and keyboard during the animation.
15280 * @note When you add an object with elm_transit_object_add(), its state from
15281 * evas_object_pass_events_get(obj) is saved, and it is applied when the
15282 * transit ends, if you change this state with evas_object_pass_events_set()
15283 * after adding the object, this state will change again when @p transit stops
15286 * @param transit The transit object.
15287 * @param enabled Events are received when enabled is @c EINA_TRUE, and
15288 * ignored otherwise.
15292 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
15295 * Get the value of event enabled status.
15297 * @see elm_transit_event_enabled_set()
15299 * @param transit The Transit object
15300 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
15301 * EINA_FALSE is returned
15305 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15308 * Set the user-callback function when the transit is deleted.
15310 * @note Using this function twice will overwrite the first function setted.
15311 * @note the @p transit object will be deleted after call @p cb function.
15313 * @param transit The transit object.
15314 * @param cb Callback function pointer. This function will be called before
15315 * the deletion of the transit.
15316 * @param data Callback funtion user data. It is the @p op parameter.
15320 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
15323 * Set reverse effect automatically.
15325 * If auto reverse is setted, after running the effects with the progress
15326 * parameter from 0 to 1, it will call the effecs again with the progress
15327 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
15328 * where the duration was setted with the function elm_transit_add and
15329 * the repeat with the function elm_transit_repeat_times_set().
15331 * @param transit The transit object.
15332 * @param reverse EINA_TRUE means the auto_reverse is on.
15336 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
15339 * Get if the auto reverse is on.
15341 * @see elm_transit_auto_reverse_set()
15343 * @param transit The transit object.
15344 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
15345 * EINA_FALSE is returned
15349 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15352 * Set the transit repeat count. Effect will be repeated by repeat count.
15354 * This function sets the number of repetition the transit will run after
15355 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
15356 * If the @p repeat is a negative number, it will repeat infinite times.
15358 * @note If this function is called during the transit execution, the transit
15359 * will run @p repeat times, ignoring the times it already performed.
15361 * @param transit The transit object
15362 * @param repeat Repeat count
15366 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
15369 * Get the transit repeat count.
15371 * @see elm_transit_repeat_times_set()
15373 * @param transit The Transit object.
15374 * @return The repeat count. If @p transit is NULL
15379 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15382 * Set the transit animation acceleration type.
15384 * This function sets the tween mode of the transit that can be:
15385 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
15386 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
15387 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
15388 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
15390 * @param transit The transit object.
15391 * @param tween_mode The tween type.
15395 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
15398 * Get the transit animation acceleration type.
15400 * @note @p transit can not be NULL
15402 * @param transit The transit object.
15403 * @return The tween type. If @p transit is NULL
15404 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
15408 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15411 * Set the transit animation time
15413 * @note @p transit can not be NULL
15415 * @param transit The transit object.
15416 * @param duration The animation time.
15420 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
15423 * Get the transit animation time
15425 * @note @p transit can not be NULL
15427 * @param transit The transit object.
15429 * @return The transit animation time.
15433 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15436 * Starts the transition.
15437 * Once this API is called, the transit begins to measure the time.
15439 * @note @p transit can not be NULL
15441 * @param transit The transit object.
15445 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
15448 * Pause/Resume the transition.
15450 * If you call elm_transit_go again, the transit will be started from the
15451 * beginning, and will be unpaused.
15453 * @note @p transit can not be NULL
15455 * @param transit The transit object.
15456 * @param paused Whether the transition should be paused or not.
15460 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
15463 * Get the value of paused status.
15465 * @see elm_transit_paused_set()
15467 * @note @p transit can not be NULL
15469 * @param transit The transit object.
15470 * @return EINA_TRUE means transition is paused. If @p transit is NULL
15471 * EINA_FALSE is returned
15475 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15478 * Get the time progression of the animation (a double value between 0.0 and 1.0).
15480 * The value returned is a fraction (current time / total time). It
15481 * represents the progression position relative to the total.
15483 * @note @p transit can not be NULL
15485 * @param transit The transit object.
15487 * @return The time progression value. If @p transit is NULL
15492 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15495 * Makes the chain relationship between two transits.
15497 * @note @p transit can not be NULL. Transit would have multiple chain transits.
15498 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
15500 * @param transit The transit object.
15501 * @param chain_transit The chain transit object. This transit will be operated
15502 * after transit is done.
15504 * This function adds @p chain_transit transition to a chain after the @p
15505 * transit, and will be started as soon as @p transit ends. See @ref
15506 * transit_example_02_explained for a full example.
15510 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
15513 * Cut off the chain relationship between two transits.
15515 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
15516 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
15518 * @param transit The transit object.
15519 * @param chain_transit The chain transit object.
15521 * This function remove the @p chain_transit transition from the @p transit.
15525 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
15528 * Get the current chain transit list.
15530 * @note @p transit can not be NULL.
15532 * @param transit The transit object.
15533 * @return chain transit list.
15537 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
15540 * Add the Resizing Effect to Elm_Transit.
15542 * @note This API is one of the facades. It creates resizing effect context
15543 * and add it's required APIs to elm_transit_effect_add.
15545 * @see elm_transit_effect_add()
15547 * @param transit Transit object.
15548 * @param from_w Object width size when effect begins.
15549 * @param from_h Object height size when effect begins.
15550 * @param to_w Object width size when effect ends.
15551 * @param to_h Object height size when effect ends.
15552 * @return Resizing effect context data.
15556 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);
15559 * Add the Translation Effect to Elm_Transit.
15561 * @note This API is one of the facades. It creates translation effect context
15562 * and add it's required APIs to elm_transit_effect_add.
15564 * @see elm_transit_effect_add()
15566 * @param transit Transit object.
15567 * @param from_dx X Position variation when effect begins.
15568 * @param from_dy Y Position variation when effect begins.
15569 * @param to_dx X Position variation when effect ends.
15570 * @param to_dy Y Position variation when effect ends.
15571 * @return Translation effect context data.
15574 * @warning It is highly recommended just create a transit with this effect when
15575 * the window that the objects of the transit belongs has already been created.
15576 * This is because this effect needs the geometry information about the objects,
15577 * and if the window was not created yet, it can get a wrong information.
15579 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);
15582 * Add the Zoom Effect to Elm_Transit.
15584 * @note This API is one of the facades. It creates zoom effect context
15585 * and add it's required APIs to elm_transit_effect_add.
15587 * @see elm_transit_effect_add()
15589 * @param transit Transit object.
15590 * @param from_rate Scale rate when effect begins (1 is current rate).
15591 * @param to_rate Scale rate when effect ends.
15592 * @return Zoom effect context data.
15595 * @warning It is highly recommended just create a transit with this effect when
15596 * the window that the objects of the transit belongs has already been created.
15597 * This is because this effect needs the geometry information about the objects,
15598 * and if the window was not created yet, it can get a wrong information.
15600 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
15603 * Add the Flip Effect to Elm_Transit.
15605 * @note This API is one of the facades. It creates flip effect context
15606 * and add it's required APIs to elm_transit_effect_add.
15607 * @note This effect is applied to each pair of objects in the order they are listed
15608 * in the transit list of objects. The first object in the pair will be the
15609 * "front" object and the second will be the "back" object.
15611 * @see elm_transit_effect_add()
15613 * @param transit Transit object.
15614 * @param axis Flipping Axis(X or Y).
15615 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
15616 * @return Flip effect context data.
15619 * @warning It is highly recommended just create a transit with this effect when
15620 * the window that the objects of the transit belongs has already been created.
15621 * This is because this effect needs the geometry information about the objects,
15622 * and if the window was not created yet, it can get a wrong information.
15624 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
15627 * Add the Resizable Flip Effect to Elm_Transit.
15629 * @note This API is one of the facades. It creates resizable flip effect context
15630 * and add it's required APIs to elm_transit_effect_add.
15631 * @note This effect is applied to each pair of objects in the order they are listed
15632 * in the transit list of objects. The first object in the pair will be the
15633 * "front" object and the second will be the "back" object.
15635 * @see elm_transit_effect_add()
15637 * @param transit Transit object.
15638 * @param axis Flipping Axis(X or Y).
15639 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
15640 * @return Resizable flip effect context data.
15643 * @warning It is highly recommended just create a transit with this effect when
15644 * the window that the objects of the transit belongs has already been created.
15645 * This is because this effect needs the geometry information about the objects,
15646 * and if the window was not created yet, it can get a wrong information.
15648 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
15651 * Add the Wipe Effect to Elm_Transit.
15653 * @note This API is one of the facades. It creates wipe effect context
15654 * and add it's required APIs to elm_transit_effect_add.
15656 * @see elm_transit_effect_add()
15658 * @param transit Transit object.
15659 * @param type Wipe type. Hide or show.
15660 * @param dir Wipe Direction.
15661 * @return Wipe effect context data.
15664 * @warning It is highly recommended just create a transit with this effect when
15665 * the window that the objects of the transit belongs has already been created.
15666 * This is because this effect needs the geometry information about the objects,
15667 * and if the window was not created yet, it can get a wrong information.
15669 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
15672 * Add the Color Effect to Elm_Transit.
15674 * @note This API is one of the facades. It creates color effect context
15675 * and add it's required APIs to elm_transit_effect_add.
15677 * @see elm_transit_effect_add()
15679 * @param transit Transit object.
15680 * @param from_r RGB R when effect begins.
15681 * @param from_g RGB G when effect begins.
15682 * @param from_b RGB B when effect begins.
15683 * @param from_a RGB A when effect begins.
15684 * @param to_r RGB R when effect ends.
15685 * @param to_g RGB G when effect ends.
15686 * @param to_b RGB B when effect ends.
15687 * @param to_a RGB A when effect ends.
15688 * @return Color effect context data.
15692 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);
15695 * Add the Fade Effect to Elm_Transit.
15697 * @note This API is one of the facades. It creates fade effect context
15698 * and add it's required APIs to elm_transit_effect_add.
15699 * @note This effect is applied to each pair of objects in the order they are listed
15700 * in the transit list of objects. The first object in the pair will be the
15701 * "before" object and the second will be the "after" object.
15703 * @see elm_transit_effect_add()
15705 * @param transit Transit object.
15706 * @return Fade effect context data.
15709 * @warning It is highly recommended just create a transit with this effect when
15710 * the window that the objects of the transit belongs has already been created.
15711 * This is because this effect needs the color information about the objects,
15712 * and if the window was not created yet, it can get a wrong information.
15714 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
15717 * Add the Blend Effect to Elm_Transit.
15719 * @note This API is one of the facades. It creates blend effect context
15720 * and add it's required APIs to elm_transit_effect_add.
15721 * @note This effect is applied to each pair of objects in the order they are listed
15722 * in the transit list of objects. The first object in the pair will be the
15723 * "before" object and the second will be the "after" object.
15725 * @see elm_transit_effect_add()
15727 * @param transit Transit object.
15728 * @return Blend effect context data.
15731 * @warning It is highly recommended just create a transit with this effect when
15732 * the window that the objects of the transit belongs has already been created.
15733 * This is because this effect needs the color information about the objects,
15734 * and if the window was not created yet, it can get a wrong information.
15736 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
15739 * Add the Rotation Effect to Elm_Transit.
15741 * @note This API is one of the facades. It creates rotation effect context
15742 * and add it's required APIs to elm_transit_effect_add.
15744 * @see elm_transit_effect_add()
15746 * @param transit Transit object.
15747 * @param from_degree Degree when effect begins.
15748 * @param to_degree Degree when effect is ends.
15749 * @return Rotation effect context data.
15752 * @warning It is highly recommended just create a transit with this effect when
15753 * the window that the objects of the transit belongs has already been created.
15754 * This is because this effect needs the geometry information about the objects,
15755 * and if the window was not created yet, it can get a wrong information.
15757 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
15760 * Add the ImageAnimation Effect to Elm_Transit.
15762 * @note This API is one of the facades. It creates image animation effect context
15763 * and add it's required APIs to elm_transit_effect_add.
15764 * The @p images parameter is a list images paths. This list and
15765 * its contents will be deleted at the end of the effect by
15766 * elm_transit_effect_image_animation_context_free() function.
15770 * char buf[PATH_MAX];
15771 * Eina_List *images = NULL;
15772 * Elm_Transit *transi = elm_transit_add();
15774 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
15775 * images = eina_list_append(images, eina_stringshare_add(buf));
15777 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
15778 * images = eina_list_append(images, eina_stringshare_add(buf));
15779 * elm_transit_effect_image_animation_add(transi, images);
15783 * @see elm_transit_effect_add()
15785 * @param transit Transit object.
15786 * @param images Eina_List of images file paths. This list and
15787 * its contents will be deleted at the end of the effect by
15788 * elm_transit_effect_image_animation_context_free() function.
15789 * @return Image Animation effect context data.
15793 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
15798 typedef struct _Elm_Store Elm_Store;
15799 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
15800 typedef struct _Elm_Store_Item Elm_Store_Item;
15801 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
15802 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
15803 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
15804 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
15805 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
15806 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
15807 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
15808 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
15810 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
15811 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
15812 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
15813 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
15817 ELM_STORE_ITEM_MAPPING_NONE = 0,
15818 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
15819 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
15820 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
15821 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
15822 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
15823 // can add more here as needed by common apps
15824 ELM_STORE_ITEM_MAPPING_LAST
15825 } Elm_Store_Item_Mapping_Type;
15827 struct _Elm_Store_Item_Mapping_Icon
15829 // FIXME: allow edje file icons
15831 Elm_Icon_Lookup_Order lookup_order;
15832 Eina_Bool standard_name : 1;
15833 Eina_Bool no_scale : 1;
15834 Eina_Bool smooth : 1;
15835 Eina_Bool scale_up : 1;
15836 Eina_Bool scale_down : 1;
15839 struct _Elm_Store_Item_Mapping_Empty
15844 struct _Elm_Store_Item_Mapping_Photo
15849 struct _Elm_Store_Item_Mapping_Custom
15851 Elm_Store_Item_Mapping_Cb func;
15854 struct _Elm_Store_Item_Mapping
15856 Elm_Store_Item_Mapping_Type type;
15861 Elm_Store_Item_Mapping_Empty empty;
15862 Elm_Store_Item_Mapping_Icon icon;
15863 Elm_Store_Item_Mapping_Photo photo;
15864 Elm_Store_Item_Mapping_Custom custom;
15865 // add more types here
15869 struct _Elm_Store_Item_Info
15871 Elm_Genlist_Item_Class *item_class;
15872 const Elm_Store_Item_Mapping *mapping;
15877 struct _Elm_Store_Item_Info_Filesystem
15879 Elm_Store_Item_Info base;
15883 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
15884 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
15886 EAPI void elm_store_free(Elm_Store *st);
15888 EAPI Elm_Store *elm_store_filesystem_new(void);
15889 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
15890 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15891 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15893 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
15895 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
15896 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15897 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15898 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15899 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
15900 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15902 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15903 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
15904 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15905 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
15906 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15907 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15908 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15910 /* SegmentControl */
15911 typedef struct _Elm_Segment_Item Elm_Segment_Item;
15912 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15913 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
15914 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);
15915 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15916 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15917 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15918 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15919 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15920 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
15921 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15922 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
15923 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15924 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15925 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15926 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
15927 /* smart callbacks called:
15928 * "changed" -when the user clicks on a segment item which is not previously
15929 * selected and get selected. The event_info parameter is the
15930 * segment item index.
15933 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
15934 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
15935 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
15936 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
15937 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
15938 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
15939 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
15940 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
15942 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
15943 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
15945 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
15946 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
15947 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
15948 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
15949 EAPI void elm_video_play(Evas_Object *video);
15950 EAPI void elm_video_pause(Evas_Object *video);
15951 EAPI void elm_video_stop(Evas_Object *video);
15952 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
15953 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
15954 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
15955 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
15956 EAPI double elm_video_audio_level_get(Evas_Object *video);
15957 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
15958 EAPI double elm_video_play_position_get(Evas_Object *video);
15959 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
15960 EAPI double elm_video_play_length_get(Evas_Object *video);
15961 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
15962 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
15963 EAPI const char *elm_video_title_get(Evas_Object *video);
15965 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
15966 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
15969 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
15973 ELM_NAVIFRAME_PREV_BUTTON,
15974 ELM_NAVIFRAME_NEXT_BUTTON
15975 } Elm_Naviframe_Button_Type;
15977 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15978 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);
15979 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
15980 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
15981 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15982 EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
15983 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15984 EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
15985 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15986 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
15987 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15988 EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15989 EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15990 EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
15991 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
15992 EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
15993 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15994 EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
15995 EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
15996 EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
15997 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);