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>
152 #include <Ecore_Con.h>
161 # include <Efreet_Mime.h>
162 # include <Efreet_Trash.h>
166 # include <Ethumb_Client.h>
178 # ifdef ELEMENTARY_BUILD
180 # define EAPI __declspec(dllexport)
183 # endif /* ! DLL_EXPORT */
185 # define EAPI __declspec(dllimport)
186 # endif /* ! EFL_EVAS_BUILD */
190 # define EAPI __attribute__ ((visibility("default")))
197 #endif /* ! _WIN32 */
200 /* allow usage from c++ */
205 #define ELM_VERSION_MAJOR @VMAJ@
206 #define ELM_VERSION_MINOR @VMIN@
208 typedef struct _Elm_Version
216 EAPI extern Elm_Version *elm_version;
219 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
220 #define ELM_PI 3.14159265358979323846
223 * @defgroup General General
225 * @brief General Elementary API. Functions that don't relate to
226 * Elementary objects specifically.
228 * Here are documented functions which init/shutdown the library,
229 * that apply to generic Elementary objects, that deal with
230 * configuration, et cetera.
232 * @ref general_functions_example_page "This" example contemplates
233 * some of these functions.
237 * @addtogroup General
242 * Defines couple of standard Evas_Object layers to be used
243 * with evas_object_layer_set().
245 * @note whenever extending with new values, try to keep some padding
246 * to siblings so there is room for further extensions.
248 typedef enum _Elm_Object_Layer
250 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
251 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
252 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
253 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
254 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
255 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
258 /**************************************************************************/
259 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
262 * Emitted when any Elementary's policy value is changed.
264 EAPI extern int ELM_EVENT_POLICY_CHANGED;
267 * @typedef Elm_Event_Policy_Changed
269 * Data on the event when an Elementary policy has changed
271 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
274 * @struct _Elm_Event_Policy_Changed
276 * Data on the event when an Elementary policy has changed
278 struct _Elm_Event_Policy_Changed
280 unsigned int policy; /**< the policy identifier */
281 int new_value; /**< value the policy had before the change */
282 int old_value; /**< new value the policy got */
286 * Policy identifiers.
288 typedef enum _Elm_Policy
290 ELM_POLICY_QUIT, /**< under which circunstances the application
291 * should quit automatically. @see
295 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
298 typedef enum _Elm_Policy_Quit
300 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
302 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
304 * window is closed */
305 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
307 typedef enum _Elm_Focus_Direction
311 } Elm_Focus_Direction;
313 typedef enum _Elm_Text_Format
315 ELM_TEXT_FORMAT_PLAIN_UTF8,
316 ELM_TEXT_FORMAT_MARKUP_UTF8
320 * Line wrapping types.
322 typedef enum _Elm_Wrap_Type
324 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
325 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
326 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
327 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
332 * @typedef Elm_Object_Item
333 * An Elementary Object item handle.
336 typedef struct _Elm_Widget_Item Elm_Object_Item;
339 * Called back when a widget's 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 tooltip The tooltip object (affix content to this!)
344 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
347 * Called back when a widget's item tooltip is activated and needs content.
348 * @param data user-data given to elm_object_tooltip_content_cb_set()
349 * @param obj owner widget.
350 * @param tooltip The tooltip object (affix content to this!)
351 * @param item context dependent item. As an example, if tooltip was
352 * set on Elm_List_Item, then it is of this type.
354 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
356 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
358 #ifndef ELM_LIB_QUICKLAUNCH
359 #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 */
361 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
364 /**************************************************************************/
368 * Initialize Elementary
370 * @param[in] argc System's argument count value
371 * @param[in] argv System's pointer to array of argument strings
372 * @return The init counter value.
374 * This function initializes Elementary and increments a counter of
375 * the number of calls to it. It returs the new counter's value.
377 * @warning This call is exported only for use by the @c ELM_MAIN()
378 * macro. There is no need to use this if you use this macro (which
379 * is highly advisable). An elm_main() should contain the entry
380 * point code for your application, having the same prototype as
381 * elm_init(), and @b not being static (putting the @c EAPI symbol
382 * in front of its type declaration is advisable). The @c
383 * ELM_MAIN() call should be placed just after it.
386 * @dontinclude bg_example_01.c
390 * See the full @ref bg_example_01_c "example".
392 * @see elm_shutdown().
395 EAPI int elm_init(int argc, char **argv);
398 * Shut down Elementary
400 * @return The init counter value.
402 * This should be called at the end of your application, just
403 * before it ceases to do any more processing. This will clean up
404 * any permanent resources your application may have allocated via
405 * Elementary that would otherwise persist.
407 * @see elm_init() for an example
411 EAPI int elm_shutdown(void);
414 * Run Elementary's main loop
416 * This call should be issued just after all initialization is
417 * completed. This function will not return until elm_exit() is
418 * called. It will keep looping, running the main
419 * (event/processing) loop for Elementary.
421 * @see elm_init() for an example
425 EAPI void elm_run(void);
428 * Exit Elementary's main loop
430 * If this call is issued, it will flag the main loop to cease
431 * processing and return back to its parent function (usually your
432 * elm_main() function).
434 * @see elm_init() for an example. There, just after a request to
435 * close the window comes, the main loop will be left.
437 * @note By using the #ELM_POLICY_QUIT on your Elementary
438 * applications, you'll this function called automatically for you.
442 EAPI void elm_exit(void);
445 * Provide information in order to make Elementary determine the @b
446 * run time location of the software in question, so other data files
447 * such as images, sound files, executable utilities, libraries,
448 * modules and locale files can be found.
450 * @param mainfunc This is your application's main function name,
451 * whose binary's location is to be found. Providing @c NULL
452 * will make Elementary not to use it
453 * @param dom This will be used as the application's "domain", in the
454 * form of a prefix to any environment variables that may
455 * override prefix detection and the directory name, inside the
456 * standard share or data directories, where the software's
457 * data files will be looked for.
458 * @param checkfile This is an (optional) magic file's path to check
459 * for existence (and it must be located in the data directory,
460 * under the share directory provided above). Its presence will
461 * help determine the prefix found was correct. Pass @c NULL if
462 * the check is not to be done.
464 * This function allows one to re-locate the application somewhere
465 * else after compilation, if the developer wishes for easier
466 * distribution of pre-compiled binaries.
468 * The prefix system is designed to locate where the given software is
469 * installed (under a common path prefix) at run time and then report
470 * specific locations of this prefix and common directories inside
471 * this prefix like the binary, library, data and locale directories,
472 * through the @c elm_app_*_get() family of functions.
474 * Call elm_app_info_set() early on before you change working
475 * directory or anything about @c argv[0], so it gets accurate
478 * It will then try and trace back which file @p mainfunc comes from,
479 * if provided, to determine the application's prefix directory.
481 * The @p dom parameter provides a string prefix to prepend before
482 * environment variables, allowing a fallback to @b specific
483 * environment variables to locate the software. You would most
484 * probably provide a lowercase string there, because it will also
485 * serve as directory domain, explained next. For environment
486 * variables purposes, this string is made uppercase. For example if
487 * @c "myapp" is provided as the prefix, then the program would expect
488 * @c "MYAPP_PREFIX" as a master environment variable to specify the
489 * exact install prefix for the software, or more specific environment
490 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
491 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
492 * the user or scripts before launching. If not provided (@c NULL),
493 * environment variables will not be used to override compiled-in
494 * defaults or auto detections.
496 * The @p dom string also provides a subdirectory inside the system
497 * shared data directory for data files. For example, if the system
498 * directory is @c /usr/local/share, then this directory name is
499 * appended, creating @c /usr/local/share/myapp, if it @p was @c
500 * "myapp". It is expected the application installs data files in
503 * The @p checkfile is a file name or path of something inside the
504 * share or data directory to be used to test that the prefix
505 * detection worked. For example, your app will install a wallpaper
506 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
507 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
510 * @see elm_app_compile_bin_dir_set()
511 * @see elm_app_compile_lib_dir_set()
512 * @see elm_app_compile_data_dir_set()
513 * @see elm_app_compile_locale_set()
514 * @see elm_app_prefix_dir_get()
515 * @see elm_app_bin_dir_get()
516 * @see elm_app_lib_dir_get()
517 * @see elm_app_data_dir_get()
518 * @see elm_app_locale_dir_get()
520 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
523 * Provide information on the @b fallback application's binaries
524 * directory, on scenarios where they get overriden by
525 * elm_app_info_set().
527 * @param dir The path to the default binaries directory (compile time
530 * @note Elementary will as well use this path to determine actual
531 * names of binaries' directory paths, maybe changing it to be @c
532 * something/local/bin instead of @c something/bin, only, for
535 * @warning You should call this function @b before
536 * elm_app_info_set().
538 EAPI void elm_app_compile_bin_dir_set(const char *dir);
541 * Provide information on the @b fallback application's libraries
542 * directory, on scenarios where they get overriden by
543 * elm_app_info_set().
545 * @param dir The path to the default libraries directory (compile
548 * @note Elementary will as well use this path to determine actual
549 * names of libraries' directory paths, maybe changing it to be @c
550 * something/lib32 or @c something/lib64 instead of @c something/lib,
553 * @warning You should call this function @b before
554 * elm_app_info_set().
556 EAPI void elm_app_compile_lib_dir_set(const char *dir);
559 * Provide information on the @b fallback application's data
560 * directory, on scenarios where they get overriden by
561 * elm_app_info_set().
563 * @param dir The path to the default data directory (compile time
566 * @note Elementary will as well use this path to determine actual
567 * names of data directory paths, maybe changing it to be @c
568 * something/local/share instead of @c something/share, only, for
571 * @warning You should call this function @b before
572 * elm_app_info_set().
574 EAPI void elm_app_compile_data_dir_set(const char *dir);
577 * Provide information on the @b fallback application's locale
578 * directory, on scenarios where they get overriden by
579 * elm_app_info_set().
581 * @param dir The path to the default locale directory (compile time
584 * @warning You should call this function @b before
585 * elm_app_info_set().
587 EAPI void elm_app_compile_locale_set(const char *dir);
590 * Retrieve the application's run time prefix directory, as set by
591 * elm_app_info_set() and the way (environment) the application was
594 * @return The directory prefix the application is actually using
596 EAPI const char *elm_app_prefix_dir_get(void);
599 * Retrieve the application's run time binaries prefix directory, as
600 * set by elm_app_info_set() and the way (environment) the application
603 * @return The binaries directory prefix the application is actually
606 EAPI const char *elm_app_bin_dir_get(void);
609 * Retrieve the application's run time libraries prefix directory, as
610 * set by elm_app_info_set() and the way (environment) the application
613 * @return The libraries directory prefix the application is actually
616 EAPI const char *elm_app_lib_dir_get(void);
619 * Retrieve the application's run time data prefix directory, as
620 * set by elm_app_info_set() and the way (environment) the application
623 * @return The data directory prefix the application is actually
626 EAPI const char *elm_app_data_dir_get(void);
629 * Retrieve the application's run time locale prefix directory, as
630 * set by elm_app_info_set() and the way (environment) the application
633 * @return The locale directory prefix the application is actually
636 EAPI const char *elm_app_locale_dir_get(void);
638 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
639 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
640 EAPI int elm_quicklaunch_init(int argc, char **argv);
641 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
642 EAPI int elm_quicklaunch_sub_shutdown(void);
643 EAPI int elm_quicklaunch_shutdown(void);
644 EAPI void elm_quicklaunch_seed(void);
645 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
646 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
647 EAPI void elm_quicklaunch_cleanup(void);
648 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
649 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
651 EAPI Eina_Bool elm_need_efreet(void);
652 EAPI Eina_Bool elm_need_e_dbus(void);
653 EAPI Eina_Bool elm_need_ethumb(void);
656 * Set a new policy's value (for a given policy group/identifier).
658 * @param policy policy identifier, as in @ref Elm_Policy.
659 * @param value policy value, which depends on the identifier
661 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
663 * Elementary policies define applications' behavior,
664 * somehow. These behaviors are divided in policy groups (see
665 * #Elm_Policy enumeration). This call will emit the Ecore event
666 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
667 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
670 * @note Currently, we have only one policy identifier/group
671 * (#ELM_POLICY_QUIT), which has two possible values.
675 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
678 * Gets the policy value set for given policy identifier.
680 * @param policy policy identifier, as in #Elm_Policy.
681 * @return The currently set policy value, for that
682 * identifier. Will be @c 0 if @p policy passed is invalid.
686 EAPI int elm_policy_get(unsigned int policy);
689 * Set a label of an object
691 * @param obj The Elementary object
692 * @param item The label id to set (NULL for the default label)
693 * @param label The new text of the label
695 * @note Elementary objects may have many labels (e.g. Action Slider)
699 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label);
701 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
704 * Get a label of an object
706 * @param obj The Elementary object
707 * @param item The label id to get (NULL for the default label)
708 * @return text of the label or NULL for any error
710 * @note Elementary objects may have many labels (e.g. Action Slider)
714 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *item);
716 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
719 * Set a content of an object
721 * @param obj The Elementary object
722 * @param item The content id to set (NULL for the default content)
723 * @param content The new content of the object
725 * @note Elementary objects may have many contents
729 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *item, Evas_Object *content);
731 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
734 * Get a content of an object
736 * @param obj The Elementary object
737 * @param item The content id to get (NULL for the default content)
738 * @return content of the object or NULL for any error
740 * @note Elementary objects may have many contents
744 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *item);
746 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
749 * Unset a content of an object
751 * @param obj The Elementary object
752 * @param item The content id to unset (NULL for the default content)
754 * @note Elementary objects may have many contents
758 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *item);
760 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
763 * Set a content of an object item
765 * @param it The Elementary object item
766 * @param part The content part name to unset (NULL for the default content)
767 * @param content The new content of the object item
769 * @note Elementary object items may have many contents
773 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
775 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
778 * Get a content of an object item
780 * @param it The Elementary object item
781 * @param part The content part name to unset (NULL for the default content)
782 * @return content of the object item or NULL for any error
784 * @note Elementary object items may have many contents
788 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
790 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
793 * Unset a content of an object item
795 * @param it The Elementary object item
796 * @param part The content part name to unset (NULL for the default content)
798 * @note Elementary object items may have many contents
802 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
804 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
807 * Set a label of an objec itemt
809 * @param it The Elementary object item
810 * @param part The text part name to set (NULL for the default label)
811 * @param label The new text of the label
813 * @note Elementary object items may have many labels
817 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
819 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
822 * Get a label of an object
824 * @param it The Elementary object item
825 * @param part The text part name to get (NULL for the default label)
826 * @return text of the label or NULL for any error
828 * @note Elementary object items may have many labels
832 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
834 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
840 EAPI void elm_all_flush(void);
841 EAPI int elm_cache_flush_interval_get(void);
842 EAPI void elm_cache_flush_interval_set(int size);
843 EAPI void elm_cache_flush_interval_all_set(int size);
844 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
845 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
846 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
847 EAPI int elm_font_cache_get(void);
848 EAPI void elm_font_cache_set(int size);
849 EAPI void elm_font_cache_all_set(int size);
850 EAPI int elm_image_cache_get(void);
851 EAPI void elm_image_cache_set(int size);
852 EAPI void elm_image_cache_all_set(int size);
853 EAPI int elm_edje_file_cache_get(void);
854 EAPI void elm_edje_file_cache_set(int size);
855 EAPI void elm_edje_file_cache_all_set(int size);
856 EAPI int elm_edje_collection_cache_get(void);
857 EAPI void elm_edje_collection_cache_set(int size);
858 EAPI void elm_edje_collection_cache_all_set(int size);
861 * @defgroup Scaling Selective Widget Scaling
863 * Different widgets can be scaled independently. These functions
864 * allow you to manipulate this scaling on a per-widget basis. The
865 * object and all its children get their scaling factors multiplied
866 * by the scale factor set. This is multiplicative, in that if a
867 * child also has a scale size set it is in turn multiplied by its
868 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
869 * double size, @c 0.5 is half, etc.
871 * @ref general_functions_example_page "This" example contemplates
872 * some of these functions.
876 * Set the scaling factor for a given Elementary object
878 * @param obj The Elementary to operate on
879 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
884 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
887 * Get the scaling factor for a given Elementary object
889 * @param obj The object
890 * @return The scaling factor set by elm_object_scale_set()
894 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
895 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
896 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
897 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
898 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
900 * Set the style to use by a widget
902 * Sets the style name that will define the appearance of a widget. Styles
903 * vary from widget to widget and may also be defined by other themes
904 * by means of extensions and overlays.
906 * @param obj The Elementary widget to style
907 * @param style The style name to use
909 * @see elm_theme_extension_add()
910 * @see elm_theme_overlay_add()
914 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
916 * Get the style used by the widget
918 * This gets the style being used for that widget. Note that the string
919 * pointer is only valid as longas the object is valid and the style doesn't
922 * @param obj The Elementary widget to query for its style
923 * @return The style name used
925 * @see elm_object_style_set()
929 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
932 * @defgroup Styles Styles
934 * Widgets can have different styles of look. These generic API's
935 * set styles of widgets, if they support them (and if the theme(s)
938 * @ref general_functions_example_page "This" example contemplates
939 * some of these functions.
943 * Set the disabled state of an Elementary object.
945 * @param obj The Elementary object to operate on
946 * @param disabled The state to put in in: @c EINA_TRUE for
947 * disabled, @c EINA_FALSE for enabled
949 * Elementary objects can be @b disabled, in which state they won't
950 * receive input and, in general, will be themed differently from
951 * their normal state, usually greyed out. Useful for contexts
952 * where you don't want your users to interact with some of the
953 * parts of you interface.
955 * This sets the state for the widget, either disabling it or
960 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
963 * Get the disabled state of an Elementary object.
965 * @param obj The Elementary object to operate on
966 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
967 * if it's enabled (or on errors)
969 * This gets the state of the widget, which might be enabled or disabled.
973 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
976 * @defgroup WidgetNavigation Widget Tree Navigation.
978 * How to check if an Evas Object is an Elementary widget? How to
979 * get the first elementary widget that is parent of the given
980 * object? These are all covered in widget tree navigation.
982 * @ref general_functions_example_page "This" example contemplates
983 * some of these functions.
986 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
989 * Get the first parent of the given object that is an Elementary
992 * @param obj the Elementary object to query parent from.
993 * @return the parent object that is an Elementary widget, or @c
994 * NULL, if it was not found.
996 * Use this to query for an object's parent widget.
998 * @note Most of Elementary users wouldn't be mixing non-Elementary
999 * smart objects in the objects tree of an application, as this is
1000 * an advanced usage of Elementary with Evas. So, except for the
1001 * application's window, which is the root of that tree, all other
1002 * objects would have valid Elementary widget parents.
1004 * @ingroup WidgetNavigation
1006 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1007 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1008 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1010 EAPI double elm_scale_get(void);
1011 EAPI void elm_scale_set(double scale);
1012 EAPI void elm_scale_all_set(double scale);
1014 EAPI Eina_Bool elm_mirrored_get(void);
1015 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1017 EAPI Eina_Bool elm_config_save(void);
1018 EAPI void elm_config_reload(void);
1020 EAPI const char *elm_profile_current_get(void);
1021 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1022 EAPI void elm_profile_dir_free(const char *p_dir);
1023 EAPI Eina_List *elm_profile_list_get(void);
1024 EAPI void elm_profile_list_free(Eina_List *l);
1025 EAPI void elm_profile_set(const char *profile);
1026 EAPI void elm_profile_all_set(const char *profile);
1028 EAPI const char *elm_engine_current_get(void);
1029 EAPI void elm_engine_set(const char *engine);
1031 typedef struct _Elm_Text_Class
1037 typedef struct _Elm_Font_Overlay
1039 const char *text_class;
1041 Evas_Font_Size size;
1044 typedef struct _Elm_Font_Properties
1048 } Elm_Font_Properties;
1050 EAPI const Eina_List *elm_text_classes_list_get(void);
1051 EAPI void elm_text_classes_list_free(const Eina_List *list);
1053 EAPI const Eina_List *elm_font_overlay_list_get(void);
1054 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1055 EAPI void elm_font_overlay_unset(const char *text_class);
1056 EAPI void elm_font_overlay_apply(void);
1057 EAPI void elm_font_overlay_all_apply(void);
1059 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1060 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1061 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1062 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1063 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1064 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1067 * @defgroup Fingers Fingers
1069 * Elementary is designed to be finger-friendly for touchscreens,
1070 * and so in addition to scaling for display resolution, it can
1071 * also scale based on finger "resolution" (or size). You can then
1072 * customize the granularity of the areas meant to receive clicks
1075 * Different profiles may have pre-set values for finger sizes.
1077 * @ref general_functions_example_page "This" example contemplates
1078 * some of these functions.
1082 * Get the configured "finger size"
1084 * @return The finger size
1086 * This gets the globally configured finger size, <b>in pixels</b>
1090 EAPI Evas_Coord elm_finger_size_get(void);
1091 EAPI void elm_finger_size_set(Evas_Coord size);
1092 EAPI void elm_finger_size_all_set(Evas_Coord size);
1095 * @defgroup Focus Focus
1097 * An Elementary application has, at all times, one (and only one)
1098 * @b focused object. This is what determines where the input
1099 * events go to within the application's window. Also, focused
1100 * objects can be decorated differently, in order to signal to the
1101 * user where the input is, at a given moment.
1103 * Elementary applications also have the concept of <b>focus
1104 * chain</b>: one can cycle through all the windows' focusable
1105 * objects by input (tab key) or programmatically. The default
1106 * focus chain for an application is the one define by the order in
1107 * which the widgets where added in code. One will cycle through
1108 * top level widgets, and, for each one containg sub-objects, cycle
1109 * through them all, before returning to the level
1110 * above. Elementary also allows one to set @b custom focus chains
1111 * for their applications.
1113 * Besides the focused decoration a widget may exhibit, when it
1114 * gets focus, Elementary has a @b global focus highlight object
1115 * that can be enabled for a window. If one chooses to do so, this
1116 * extra highlight effect will surround the current focused object,
1119 * @note Some Elementary widgets are @b unfocusable, after
1120 * creation, by their very nature: they are not meant to be
1121 * interacted with input events, but are there just for visual
1124 * @ref general_functions_example_page "This" example contemplates
1125 * some of these functions.
1128 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1129 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1130 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1131 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1134 * Get the whether an Elementary object has the focus or not.
1136 * @param obj The Elementary object to get the information from
1137 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1138 * not (and on errors).
1140 * @see elm_object_focus()
1144 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1147 * Set/unset focus to a given Elementary object.
1149 * @param obj The Elementary object to operate on.
1150 * @param enable @c EINA_TRUE Set focus to a given object,
1151 * @c EINA_FALSE Unset focus to a given object.
1153 * @note When you set focus to this object, if it can handle focus, will
1154 * take the focus away from the one who had it previously and will, for
1155 * now on, be the one receiving input events. Unsetting focus will remove
1156 * the focus from @p obj, passing it back to the previous element in the
1159 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1163 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1166 * Make a given Elementary object the focused one.
1168 * @param obj The Elementary object to make focused.
1170 * @note This object, if it can handle focus, will take the focus
1171 * away from the one who had it previously and will, for now on, be
1172 * the one receiving input events.
1174 * @see elm_object_focus_get()
1175 * @deprecated use elm_object_focus_set() instead.
1179 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1182 * Remove the focus from an Elementary object
1184 * @param obj The Elementary to take focus from
1186 * This removes the focus from @p obj, passing it back to the
1187 * previous element in the focus chain list.
1189 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1190 * @deprecated use elm_object_focus_set() instead.
1194 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1197 * Set the ability for an Element object to be focused
1199 * @param obj The Elementary object to operate on
1200 * @param enable @c EINA_TRUE if the object can be focused, @c
1201 * EINA_FALSE if not (and on errors)
1203 * This sets whether the object @p obj is able to take focus or
1204 * not. Unfocusable objects do nothing when programmatically
1205 * focused, being the nearest focusable parent object the one
1206 * really getting focus. Also, when they receive mouse input, they
1207 * will get the event, but not take away the focus from where it
1212 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1215 * Get whether an Elementary object is focusable or not
1217 * @param obj The Elementary object to operate on
1218 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1219 * EINA_FALSE if not (and on errors)
1221 * @note Objects which are meant to be interacted with by input
1222 * events are created able to be focused, by default. All the
1227 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1229 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1230 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1231 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1232 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1233 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1234 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1235 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1238 * Make the elementary object and its children to be unfocusable (or focusable).
1240 * @param obj The Elementary object to operate on
1241 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1242 * @c EINA_FALSE for focusable.
1244 * This sets whether the object @p obj and its children objects
1245 * are able to take focus or not. If the tree is set as unfocusable,
1246 * newest focused object which is not in this tree will get focus.
1247 * This API can be helpful for an object to be deleted.
1248 * When an object will be deleted soon, it and its children may not
1249 * want to get focus (by focus reverting or by other focus controls).
1250 * Then, just use this API before deleting.
1252 * @see elm_object_tree_unfocusable_get()
1256 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1259 * Get whether an Elementary object and its children are unfocusable or not.
1261 * @param obj The Elementary object to get the information from
1262 * @return @c EINA_TRUE, if the tree is unfocussable,
1263 * @c EINA_FALSE if not (and on errors).
1265 * @see elm_object_tree_unfocusable_set()
1269 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1271 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1272 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1273 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1274 EAPI double elm_scroll_bounce_friction_get(void);
1275 EAPI void elm_scroll_bounce_friction_set(double friction);
1276 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1277 EAPI double elm_scroll_page_scroll_friction_get(void);
1278 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1279 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1280 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1281 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1282 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1283 EAPI double elm_scroll_zoom_friction_get(void);
1284 EAPI void elm_scroll_zoom_friction_set(double friction);
1285 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1286 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1287 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1288 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1289 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1290 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1291 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1292 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1293 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1294 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1295 EAPI double elm_scroll_thumbscroll_friction_get(void);
1296 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1297 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1298 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1299 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1300 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1302 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1303 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1304 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1305 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1306 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1307 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1308 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1309 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1311 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1312 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);
1313 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);
1315 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1316 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1319 * Adjust size of an element for finger usage.
1321 * @param times_w How many fingers should fit horizontally
1322 * @param w Pointer to the width size to adjust
1323 * @param times_h How many fingers should fit vertically
1324 * @param h Pointer to the height size to adjust
1326 * This takes width and height sizes (in pixels) as input and a
1327 * size multiple (which is how many fingers you want to place
1328 * within the area, being "finger" the size set by
1329 * elm_finger_size_set()), and adjusts the size to be large enough
1330 * to accommodate the resulting size -- if it doesn't already
1331 * accommodate it. On return the @p w and @p h sizes pointed to by
1332 * these parameters will be modified, on those conditions.
1334 * @note This is kind of a low level Elementary call, most useful
1335 * on size evaluation times for widgets. An external user wouldn't
1336 * be calling, most of the time.
1340 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1342 EAPI double elm_longpress_timeout_get(void);
1343 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1346 * don't use it unless you are sure
1348 EAPI void elm_object_tree_dump(const Evas_Object *top);
1349 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1354 * @defgroup Theme Theme
1356 * Elementary uses Edje to theme its widgets, naturally. But for the most
1357 * part this is hidden behind a simpler interface that lets the user set
1358 * extensions and choose the style of widgets in a much easier way.
1360 * Instead of thinking in terms of paths to Edje files and their groups
1361 * each time you want to change the appearance of a widget, Elementary
1362 * works so you can add any theme file with extensions or replace the
1363 * main theme at one point in the application, and then just set the style
1364 * of widgets with elm_object_style_set() and related functions. Elementary
1365 * will then look in its list of themes for a matching group and apply it,
1366 * and when the theme changes midway through the application, all widgets
1367 * will be updated accordingly.
1369 * There are three concepts you need to know to understand how Elementary
1370 * theming works: default theme, extensions and overlays.
1372 * Default theme, obviously enough, is the one that provides the default
1373 * look of all widgets. End users can change the theme used by Elementary
1374 * by setting the @c ELM_THEME environment variable before running an
1375 * application, or globally for all programs using the @c elementary_config
1376 * utility. Applications can change the default theme using elm_theme_set(),
1377 * but this can go against the user wishes, so it's not an adviced practice.
1379 * Ideally, applications should find everything they need in the already
1380 * provided theme, but there may be occasions when that's not enough and
1381 * custom styles are required to correctly express the idea. For this
1382 * cases, Elementary has extensions.
1384 * Extensions allow the application developer to write styles of its own
1385 * to apply to some widgets. This requires knowledge of how each widget
1386 * is themed, as extensions will always replace the entire group used by
1387 * the widget, so important signals and parts need to be there for the
1388 * object to behave properly (see documentation of Edje for details).
1389 * Once the theme for the extension is done, the application needs to add
1390 * it to the list of themes Elementary will look into, using
1391 * elm_theme_extension_add(), and set the style of the desired widgets as
1392 * he would normally with elm_object_style_set().
1394 * Overlays, on the other hand, can replace the look of all widgets by
1395 * overriding the default style. Like extensions, it's up to the application
1396 * developer to write the theme for the widgets it wants, the difference
1397 * being that when looking for the theme, Elementary will check first the
1398 * list of overlays, then the set theme and lastly the list of extensions,
1399 * so with overlays it's possible to replace the default view and every
1400 * widget will be affected. This is very much alike to setting the whole
1401 * theme for the application and will probably clash with the end user
1402 * options, not to mention the risk of ending up with not matching styles
1403 * across the program. Unless there's a very special reason to use them,
1404 * overlays should be avoided for the resons exposed before.
1406 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1407 * keeps one default internally and every function that receives one of
1408 * these can be called with NULL to refer to this default (except for
1409 * elm_theme_free()). It's possible to create a new instance of a
1410 * ::Elm_Theme to set other theme for a specific widget (and all of its
1411 * children), but this is as discouraged, if not even more so, than using
1412 * overlays. Don't use this unless you really know what you are doing.
1414 * But to be less negative about things, you can look at the following
1416 * @li @ref theme_example_01 "Using extensions"
1417 * @li @ref theme_example_02 "Using overlays"
1422 * @typedef Elm_Theme
1424 * Opaque handler for the list of themes Elementary looks for when
1425 * rendering widgets.
1427 * Stay out of this unless you really know what you are doing. For most
1428 * cases, sticking to the default is all a developer needs.
1430 typedef struct _Elm_Theme Elm_Theme;
1433 * Create a new specific theme
1435 * This creates an empty specific theme that only uses the default theme. A
1436 * specific theme has its own private set of extensions and overlays too
1437 * (which are empty by default). Specific themes do not fall back to themes
1438 * of parent objects. They are not intended for this use. Use styles, overlays
1439 * and extensions when needed, but avoid specific themes unless there is no
1440 * other way (example: you want to have a preview of a new theme you are
1441 * selecting in a "theme selector" window. The preview is inside a scroller
1442 * and should display what the theme you selected will look like, but not
1443 * actually apply it yet. The child of the scroller will have a specific
1444 * theme set to show this preview before the user decides to apply it to all
1447 EAPI Elm_Theme *elm_theme_new(void);
1449 * Free a specific theme
1451 * @param th The theme to free
1453 * This frees a theme created with elm_theme_new().
1455 EAPI void elm_theme_free(Elm_Theme *th);
1457 * Copy the theme fom the source to the destination theme
1459 * @param th The source theme to copy from
1460 * @param thdst The destination theme to copy data to
1462 * This makes a one-time static copy of all the theme config, extensions
1463 * and overlays from @p th to @p thdst. If @p th references a theme, then
1464 * @p thdst is also set to reference it, with all the theme settings,
1465 * overlays and extensions that @p th had.
1467 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1469 * Tell the source theme to reference the ref theme
1471 * @param th The theme that will do the referencing
1472 * @param thref The theme that is the reference source
1474 * This clears @p th to be empty and then sets it to refer to @p thref
1475 * so @p th acts as an override to @p thref, but where its overrides
1476 * don't apply, it will fall through to @pthref for configuration.
1478 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1480 * Return the theme referred to
1482 * @param th The theme to get the reference from
1483 * @return The referenced theme handle
1485 * This gets the theme set as the reference theme by elm_theme_ref_set().
1486 * If no theme is set as a reference, NULL is returned.
1488 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1490 * Return the default theme
1492 * @return The default theme handle
1494 * This returns the internal default theme setup handle that all widgets
1495 * use implicitly unless a specific theme is set. This is also often use
1496 * as a shorthand of NULL.
1498 EAPI Elm_Theme *elm_theme_default_get(void);
1500 * Prepends a theme overlay to the list of overlays
1502 * @param th The theme to add to, or if NULL, the default theme
1503 * @param item The Edje file path to be used
1505 * Use this if your application needs to provide some custom overlay theme
1506 * (An Edje file that replaces some default styles of widgets) where adding
1507 * new styles, or changing system theme configuration is not possible. Do
1508 * NOT use this instead of a proper system theme configuration. Use proper
1509 * configuration files, profiles, environment variables etc. to set a theme
1510 * so that the theme can be altered by simple confiugration by a user. Using
1511 * this call to achieve that effect is abusing the API and will create lots
1514 * @see elm_theme_extension_add()
1516 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1518 * Delete a theme overlay from the list of overlays
1520 * @param th The theme to delete from, or if NULL, the default theme
1521 * @param item The name of the theme overlay
1523 * @see elm_theme_overlay_add()
1525 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1527 * Appends a theme extension to the list of extensions.
1529 * @param th The theme to add to, or if NULL, the default theme
1530 * @param item The Edje file path to be used
1532 * This is intended when an application needs more styles of widgets or new
1533 * widget themes that the default does not provide (or may not provide). The
1534 * application has "extended" usage by coming up with new custom style names
1535 * for widgets for specific uses, but as these are not "standard", they are
1536 * not guaranteed to be provided by a default theme. This means the
1537 * application is required to provide these extra elements itself in specific
1538 * Edje files. This call adds one of those Edje files to the theme search
1539 * path to be search after the default theme. The use of this call is
1540 * encouraged when default styles do not meet the needs of the application.
1541 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1543 * @see elm_object_style_set()
1545 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1547 * Deletes a theme extension from the list of extensions.
1549 * @param th The theme to delete from, or if NULL, the default theme
1550 * @param item The name of the theme extension
1552 * @see elm_theme_extension_add()
1554 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1556 * Set the theme search order for the given theme
1558 * @param th The theme to set the search order, or if NULL, the default theme
1559 * @param theme Theme search string
1561 * This sets the search string for the theme in path-notation from first
1562 * theme to search, to last, delimited by the : character. Example:
1564 * "shiny:/path/to/file.edj:default"
1566 * See the ELM_THEME environment variable for more information.
1568 * @see elm_theme_get()
1569 * @see elm_theme_list_get()
1571 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1573 * Return the theme search order
1575 * @param th The theme to get the search order, or if NULL, the default theme
1576 * @return The internal search order path
1578 * This function returns a colon separated string of theme elements as
1579 * returned by elm_theme_list_get().
1581 * @see elm_theme_set()
1582 * @see elm_theme_list_get()
1584 EAPI const char *elm_theme_get(Elm_Theme *th);
1586 * Return a list of theme elements to be used in a theme.
1588 * @param th Theme to get the list of theme elements from.
1589 * @return The internal list of theme elements
1591 * This returns the internal list of theme elements (will only be valid as
1592 * long as the theme is not modified by elm_theme_set() or theme is not
1593 * freed by elm_theme_free(). This is a list of strings which must not be
1594 * altered as they are also internal. If @p th is NULL, then the default
1595 * theme element list is returned.
1597 * A theme element can consist of a full or relative path to a .edj file,
1598 * or a name, without extension, for a theme to be searched in the known
1599 * theme paths for Elemementary.
1601 * @see elm_theme_set()
1602 * @see elm_theme_get()
1604 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1606 * Return the full patrh for a theme element
1608 * @param f The theme element name
1609 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1610 * @return The full path to the file found.
1612 * This returns a string you should free with free() on success, NULL on
1613 * failure. This will search for the given theme element, and if it is a
1614 * full or relative path element or a simple searchable name. The returned
1615 * path is the full path to the file, if searched, and the file exists, or it
1616 * is simply the full path given in the element or a resolved path if
1617 * relative to home. The @p in_search_path boolean pointed to is set to
1618 * EINA_TRUE if the file was a searchable file andis in the search path,
1619 * and EINA_FALSE otherwise.
1621 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1623 * Flush the current theme.
1625 * @param th Theme to flush
1627 * This flushes caches that let elementary know where to find theme elements
1628 * in the given theme. If @p th is NULL, then the default theme is flushed.
1629 * Call this function if source theme data has changed in such a way as to
1630 * make any caches Elementary kept invalid.
1632 EAPI void elm_theme_flush(Elm_Theme *th);
1634 * This flushes all themes (default and specific ones).
1636 * This will flush all themes in the current application context, by calling
1637 * elm_theme_flush() on each of them.
1639 EAPI void elm_theme_full_flush(void);
1641 * Set the theme for all elementary using applications on the current display
1643 * @param theme The name of the theme to use. Format same as the ELM_THEME
1644 * environment variable.
1646 EAPI void elm_theme_all_set(const char *theme);
1648 * Return a list of theme elements in the theme search path
1650 * @return A list of strings that are the theme element names.
1652 * This lists all available theme files in the standard Elementary search path
1653 * for theme elements, and returns them in alphabetical order as theme
1654 * element names in a list of strings. Free this with
1655 * elm_theme_name_available_list_free() when you are done with the list.
1657 EAPI Eina_List *elm_theme_name_available_list_new(void);
1659 * Free the list returned by elm_theme_name_available_list_new()
1661 * This frees the list of themes returned by
1662 * elm_theme_name_available_list_new(). Once freed the list should no longer
1663 * be used. a new list mys be created.
1665 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1667 * Set a specific theme to be used for this object and its children
1669 * @param obj The object to set the theme on
1670 * @param th The theme to set
1672 * This sets a specific theme that will be used for the given object and any
1673 * child objects it has. If @p th is NULL then the theme to be used is
1674 * cleared and the object will inherit its theme from its parent (which
1675 * ultimately will use the default theme if no specific themes are set).
1677 * Use special themes with great care as this will annoy users and make
1678 * configuration difficult. Avoid any custom themes at all if it can be
1681 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1683 * Get the specific theme to be used
1685 * @param obj The object to get the specific theme from
1686 * @return The specifc theme set.
1688 * This will return a specific theme set, or NULL if no specific theme is
1689 * set on that object. It will not return inherited themes from parents, only
1690 * the specific theme set for that specific object. See elm_object_theme_set()
1691 * for more information.
1693 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1699 /** @defgroup Win Win
1701 * @image html img/widget/win/preview-00.png
1702 * @image latex img/widget/win/preview-00.eps
1704 * The window class of Elementary. Contains functions to manipulate
1705 * windows. The Evas engine used to render the window contents is specified
1706 * in the system or user elementary config files (whichever is found last),
1707 * and can be overridden with the ELM_ENGINE environment variable for
1708 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1709 * compilation setup and modules actually installed at runtime) are (listed
1710 * in order of best supported and most likely to be complete and work to
1713 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1714 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1716 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1718 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1720 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1722 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1723 * rendering using SDL as the buffer)
1724 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1725 * GDI with software)
1726 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1727 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1728 * grayscale using dedicated 8bit software engine in X11)
1729 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1730 * X11 using 16bit software engine)
1731 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1732 * (Windows CE rendering via GDI with 16bit software renderer)
1733 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1734 * buffer with 16bit software renderer)
1736 * All engines use a simple string to select the engine to render, EXCEPT
1737 * the "shot" engine. This actually encodes the output of the virtual
1738 * screenshot and how long to delay in the engine string. The engine string
1739 * is encoded in the following way:
1741 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1743 * Where options are separated by a ":" char if more than one option is
1744 * given, with delay, if provided being the first option and file the last
1745 * (order is important). The delay specifies how long to wait after the
1746 * window is shown before doing the virtual "in memory" rendering and then
1747 * save the output to the file specified by the file option (and then exit).
1748 * If no delay is given, the default is 0.5 seconds. If no file is given the
1749 * default output file is "out.png". Repeat option is for continous
1750 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1751 * fixed to "out001.png" Some examples of using the shot engine:
1753 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1754 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1755 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1756 * ELM_ENGINE="shot:delay=2.0" elementary_test
1757 * ELM_ENGINE="shot:" elementary_test
1759 * Signals that you can add callbacks for are:
1761 * @li "delete,request": the user requested to close the window. See
1762 * elm_win_autodel_set().
1763 * @li "focus,in": window got focus
1764 * @li "focus,out": window lost focus
1765 * @li "moved": window that holds the canvas was moved
1768 * @li @ref win_example_01
1773 * Defines the types of window that can be created
1775 * These are hints set on the window so that a running Window Manager knows
1776 * how the window should be handled and/or what kind of decorations it
1779 * Currently, only the X11 backed engines use them.
1781 typedef enum _Elm_Win_Type
1783 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1784 window. Almost every window will be created with this
1786 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1787 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1788 window holding desktop icons. */
1789 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1790 be kept on top of any other window by the Window
1792 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1794 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1795 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1797 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1798 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1799 entry in a menubar is clicked. Typically used
1800 with elm_win_override_set(). This hint exists
1801 for completion only, as the EFL way of
1802 implementing a menu would not normally use a
1803 separate window for its contents. */
1804 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1805 triggered by right-clicking an object. */
1806 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1807 explanatory text that typically appear after the
1808 mouse cursor hovers over an object for a while.
1809 Typically used with elm_win_override_set() and also
1810 not very commonly used in the EFL. */
1811 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1812 battery life or a new E-Mail received. */
1813 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1814 usually used in the EFL. */
1815 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1816 object being dragged across different windows, or even
1817 applications. Typically used with
1818 elm_win_override_set(). */
1819 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1820 buffer. No actual window is created for this
1821 type, instead the window and all of its
1822 contents will be rendered to an image buffer.
1823 This allows to have children window inside a
1824 parent one just like any other object would
1825 be, and do other things like applying @c
1826 Evas_Map effects to it. This is the only type
1827 of window that requires the @c parent
1828 parameter of elm_win_add() to be a valid @c
1833 * The differents layouts that can be requested for the virtual keyboard.
1835 * When the application window is being managed by Illume, it may request
1836 * any of the following layouts for the virtual keyboard.
1838 typedef enum _Elm_Win_Keyboard_Mode
1840 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1841 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1842 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1843 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1844 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1845 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1846 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1847 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1848 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1849 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1850 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1851 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1852 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1853 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1854 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1855 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1856 } Elm_Win_Keyboard_Mode;
1859 * Available commands that can be sent to the Illume manager.
1861 * When running under an Illume session, a window may send commands to the
1862 * Illume manager to perform different actions.
1864 typedef enum _Elm_Illume_Command
1866 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1868 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1870 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1872 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1873 } Elm_Illume_Command;
1876 * Adds a window object. If this is the first window created, pass NULL as
1879 * @param parent Parent object to add the window to, or NULL
1880 * @param name The name of the window
1881 * @param type The window type, one of #Elm_Win_Type.
1883 * The @p parent paramter can be @c NULL for every window @p type except
1884 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1885 * which the image object will be created.
1887 * @return The created object, or NULL on failure
1889 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1891 * Add @p subobj as a resize object of window @p obj.
1894 * Setting an object as a resize object of the window means that the
1895 * @p subobj child's size and position will be controlled by the window
1896 * directly. That is, the object will be resized to match the window size
1897 * and should never be moved or resized manually by the developer.
1899 * In addition, resize objects of the window control what the minimum size
1900 * of it will be, as well as whether it can or not be resized by the user.
1902 * For the end user to be able to resize a window by dragging the handles
1903 * or borders provided by the Window Manager, or using any other similar
1904 * mechanism, all of the resize objects in the window should have their
1905 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1907 * @param obj The window object
1908 * @param subobj The resize object to add
1910 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1912 * Delete @p subobj as a resize object of window @p obj.
1914 * This function removes the object @p subobj from the resize objects of
1915 * the window @p obj. It will not delete the object itself, which will be
1916 * left unmanaged and should be deleted by the developer, manually handled
1917 * or set as child of some other container.
1919 * @param obj The window object
1920 * @param subobj The resize object to add
1922 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1924 * Set the title of the window
1926 * @param obj The window object
1927 * @param title The title to set
1929 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1931 * Get the title of the window
1933 * The returned string is an internal one and should not be freed or
1934 * modified. It will also be rendered invalid if a new title is set or if
1935 * the window is destroyed.
1937 * @param obj The window object
1940 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1942 * Set the window's autodel state.
1944 * When closing the window in any way outside of the program control, like
1945 * pressing the X button in the titlebar or using a command from the
1946 * Window Manager, a "delete,request" signal is emitted to indicate that
1947 * this event occurred and the developer can take any action, which may
1948 * include, or not, destroying the window object.
1950 * When the @p autodel parameter is set, the window will be automatically
1951 * destroyed when this event occurs, after the signal is emitted.
1952 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1953 * and is up to the program to do so when it's required.
1955 * @param obj The window object
1956 * @param autodel If true, the window will automatically delete itself when
1959 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1961 * Get the window's autodel state.
1963 * @param obj The window object
1964 * @return If the window will automatically delete itself when closed
1966 * @see elm_win_autodel_set()
1968 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1970 * Activate a window object.
1972 * This function sends a request to the Window Manager to activate the
1973 * window pointed by @p obj. If honored by the WM, the window will receive
1974 * the keyboard focus.
1976 * @note This is just a request that a Window Manager may ignore, so calling
1977 * this function does not ensure in any way that the window will be the
1978 * active one after it.
1980 * @param obj The window object
1982 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1984 * Lower a window object.
1986 * Places the window pointed by @p obj at the bottom of the stack, so that
1987 * no other window is covered by it.
1989 * If elm_win_override_set() is not set, the Window Manager may ignore this
1992 * @param obj The window object
1994 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1996 * Raise a window object.
1998 * Places the window pointed by @p obj at the top of the stack, so that it's
1999 * not covered by any other window.
2001 * If elm_win_override_set() is not set, the Window Manager may ignore this
2004 * @param obj The window object
2006 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2008 * Set the borderless state of a window.
2010 * This function requests the Window Manager to not draw any decoration
2011 * around the window.
2013 * @param obj The window object
2014 * @param borderless If true, the window is borderless
2016 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2018 * Get the borderless state of a window.
2020 * @param obj The window object
2021 * @return If true, the window is borderless
2023 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2025 * Set the shaped state of a window.
2027 * Shaped windows, when supported, will render the parts of the window that
2028 * has no content, transparent.
2030 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2031 * background object or cover the entire window in any other way, or the
2032 * parts of the canvas that have no data will show framebuffer artifacts.
2034 * @param obj The window object
2035 * @param shaped If true, the window is shaped
2037 * @see elm_win_alpha_set()
2039 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2041 * Get the shaped state of a window.
2043 * @param obj The window object
2044 * @return If true, the window is shaped
2046 * @see elm_win_shaped_set()
2048 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2050 * Set the alpha channel state of a window.
2052 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2053 * possibly making parts of the window completely or partially transparent.
2054 * This is also subject to the underlying system supporting it, like for
2055 * example, running under a compositing manager. If no compositing is
2056 * available, enabling this option will instead fallback to using shaped
2057 * windows, with elm_win_shaped_set().
2059 * @param obj The window object
2060 * @param alpha If true, the window has an alpha channel
2062 * @see elm_win_alpha_set()
2064 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2066 * Get the transparency state of a window.
2068 * @param obj The window object
2069 * @return If true, the window is transparent
2071 * @see elm_win_transparent_set()
2073 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2075 * Set the transparency state of a window.
2077 * Use elm_win_alpha_set() instead.
2079 * @param obj The window object
2080 * @param transparent If true, the window is transparent
2082 * @see elm_win_alpha_set()
2084 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2086 * Get the alpha channel state of a window.
2088 * @param obj The window object
2089 * @return If true, the window has an alpha channel
2091 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2093 * Set the override state of a window.
2095 * A window with @p override set to EINA_TRUE will not be managed by the
2096 * Window Manager. This means that no decorations of any kind will be shown
2097 * for it, moving and resizing must be handled by the application, as well
2098 * as the window visibility.
2100 * This should not be used for normal windows, and even for not so normal
2101 * ones, it should only be used when there's a good reason and with a lot
2102 * of care. Mishandling override windows may result situations that
2103 * disrupt the normal workflow of the end user.
2105 * @param obj The window object
2106 * @param override If true, the window is overridden
2108 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2110 * Get the override state of a window.
2112 * @param obj The window object
2113 * @return If true, the window is overridden
2115 * @see elm_win_override_set()
2117 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2119 * Set the fullscreen state of a window.
2121 * @param obj The window object
2122 * @param fullscreen If true, the window is fullscreen
2124 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2126 * Get the fullscreen state of a window.
2128 * @param obj The window object
2129 * @return If true, the window is fullscreen
2131 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2133 * Set the maximized state of a window.
2135 * @param obj The window object
2136 * @param maximized If true, the window is maximized
2138 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2140 * Get the maximized state of a window.
2142 * @param obj The window object
2143 * @return If true, the window is maximized
2145 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2147 * Set the iconified state of a window.
2149 * @param obj The window object
2150 * @param iconified If true, the window is iconified
2152 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2154 * Get the iconified state of a window.
2156 * @param obj The window object
2157 * @return If true, the window is iconified
2159 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2161 * Set the layer of the window.
2163 * What this means exactly will depend on the underlying engine used.
2165 * In the case of X11 backed engines, the value in @p layer has the
2166 * following meanings:
2167 * @li < 3: The window will be placed below all others.
2168 * @li > 5: The window will be placed above all others.
2169 * @li other: The window will be placed in the default layer.
2171 * @param obj The window object
2172 * @param layer The layer of the window
2174 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2176 * Get the layer of the window.
2178 * @param obj The window object
2179 * @return The layer of the window
2181 * @see elm_win_layer_set()
2183 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2185 * Set the rotation of the window.
2187 * Most engines only work with multiples of 90.
2189 * This function is used to set the orientation of the window @p obj to
2190 * match that of the screen. The window itself will be resized to adjust
2191 * to the new geometry of its contents. If you want to keep the window size,
2192 * see elm_win_rotation_with_resize_set().
2194 * @param obj The window object
2195 * @param rotation The rotation of the window, in degrees (0-360),
2196 * counter-clockwise.
2198 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2200 * Rotates the window and resizes it.
2202 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2203 * that they fit inside the current window geometry.
2205 * @param obj The window object
2206 * @param layer The rotation of the window in degrees (0-360),
2207 * counter-clockwise.
2209 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2211 * Get the rotation of the window.
2213 * @param obj The window object
2214 * @return The rotation of the window in degrees (0-360)
2216 * @see elm_win_rotation_set()
2217 * @see elm_win_rotation_with_resize_set()
2219 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2221 * Set the sticky state of the window.
2223 * Hints the Window Manager that the window in @p obj should be left fixed
2224 * at its position even when the virtual desktop it's on moves or changes.
2226 * @param obj The window object
2227 * @param sticky If true, the window's sticky state is enabled
2229 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2231 * Get the sticky state of the window.
2233 * @param obj The window object
2234 * @return If true, the window's sticky state is enabled
2236 * @see elm_win_sticky_set()
2238 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2240 * Set if this window is an illume conformant window
2242 * @param obj The window object
2243 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2245 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2247 * Get if this window is an illume conformant window
2249 * @param obj The window object
2250 * @return A boolean if this window is illume conformant or not
2252 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2254 * Set a window to be an illume quickpanel window
2256 * By default window objects are not quickpanel windows.
2258 * @param obj The window object
2259 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2261 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2263 * Get if this window is a quickpanel or not
2265 * @param obj The window object
2266 * @return A boolean if this window is a quickpanel or not
2268 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2270 * Set the major priority of a quickpanel window
2272 * @param obj The window object
2273 * @param priority The major priority for this quickpanel
2275 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2277 * Get the major priority of a quickpanel window
2279 * @param obj The window object
2280 * @return The major priority of this quickpanel
2282 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2284 * Set the minor priority of a quickpanel window
2286 * @param obj The window object
2287 * @param priority The minor priority for this quickpanel
2289 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2291 * Get the minor priority of a quickpanel window
2293 * @param obj The window object
2294 * @return The minor priority of this quickpanel
2296 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2298 * Set which zone this quickpanel should appear in
2300 * @param obj The window object
2301 * @param zone The requested zone for this quickpanel
2303 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2305 * Get which zone this quickpanel should appear in
2307 * @param obj The window object
2308 * @return The requested zone for this quickpanel
2310 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2312 * Set the window to be skipped by keyboard focus
2314 * This sets the window to be skipped by normal keyboard input. This means
2315 * a window manager will be asked to not focus this window as well as omit
2316 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2318 * Call this and enable it on a window BEFORE you show it for the first time,
2319 * otherwise it may have no effect.
2321 * Use this for windows that have only output information or might only be
2322 * interacted with by the mouse or fingers, and never for typing input.
2323 * Be careful that this may have side-effects like making the window
2324 * non-accessible in some cases unless the window is specially handled. Use
2327 * @param obj The window object
2328 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2330 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2332 * Send a command to the windowing environment
2334 * This is intended to work in touchscreen or small screen device
2335 * environments where there is a more simplistic window management policy in
2336 * place. This uses the window object indicated to select which part of the
2337 * environment to control (the part that this window lives in), and provides
2338 * a command and an optional parameter structure (use NULL for this if not
2341 * @param obj The window object that lives in the environment to control
2342 * @param command The command to send
2343 * @param params Optional parameters for the command
2345 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2347 * Get the inlined image object handle
2349 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2350 * then the window is in fact an evas image object inlined in the parent
2351 * canvas. You can get this object (be careful to not manipulate it as it
2352 * is under control of elementary), and use it to do things like get pixel
2353 * data, save the image to a file, etc.
2355 * @param obj The window object to get the inlined image from
2356 * @return The inlined image object, or NULL if none exists
2358 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2360 * Set the enabled status for the focus highlight in a window
2362 * This function will enable or disable the focus highlight only for the
2363 * given window, regardless of the global setting for it
2365 * @param obj The window where to enable the highlight
2366 * @param enabled The enabled value for the highlight
2368 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2370 * Get the enabled value of the focus highlight for this window
2372 * @param obj The window in which to check if the focus highlight is enabled
2374 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2376 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2378 * Set the style for the focus highlight on this window
2380 * Sets the style to use for theming the highlight of focused objects on
2381 * the given window. If @p style is NULL, the default will be used.
2383 * @param obj The window where to set the style
2384 * @param style The style to set
2386 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2388 * Get the style set for the focus highlight object
2390 * Gets the style set for this windows highilght object, or NULL if none
2393 * @param obj The window to retrieve the highlights style from
2395 * @return The style set or NULL if none was. Default is used in that case.
2397 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2399 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2400 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2401 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2402 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2403 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2404 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2405 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2407 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2408 * (blank mouse, private mouse obj, defaultmouse)
2412 * Sets the keyboard mode of the window.
2414 * @param obj The window object
2415 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2417 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2419 * Gets the keyboard mode of the window.
2421 * @param obj The window object
2422 * @return The mode, one of #Elm_Win_Keyboard_Mode
2424 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2426 * Sets whether the window is a keyboard.
2428 * @param obj The window object
2429 * @param is_keyboard If true, the window is a virtual keyboard
2431 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2433 * Gets whether the window is a keyboard.
2435 * @param obj The window object
2436 * @return If the window is a virtual keyboard
2438 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2441 * Get the screen position of a window.
2443 * @param obj The window object
2444 * @param x The int to store the x coordinate to
2445 * @param y The int to store the y coordinate to
2447 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2453 * @defgroup Inwin Inwin
2455 * @image html img/widget/inwin/preview-00.png
2456 * @image latex img/widget/inwin/preview-00.eps
2457 * @image html img/widget/inwin/preview-01.png
2458 * @image latex img/widget/inwin/preview-01.eps
2459 * @image html img/widget/inwin/preview-02.png
2460 * @image latex img/widget/inwin/preview-02.eps
2462 * An inwin is a window inside a window that is useful for a quick popup.
2463 * It does not hover.
2465 * It works by creating an object that will occupy the entire window, so it
2466 * must be created using an @ref Win "elm_win" as parent only. The inwin
2467 * object can be hidden or restacked below every other object if it's
2468 * needed to show what's behind it without destroying it. If this is done,
2469 * the elm_win_inwin_activate() function can be used to bring it back to
2470 * full visibility again.
2472 * There are three styles available in the default theme. These are:
2473 * @li default: The inwin is sized to take over most of the window it's
2475 * @li minimal: The size of the inwin will be the minimum necessary to show
2477 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2478 * possible, but it's sized vertically the most it needs to fit its\
2481 * Some examples of Inwin can be found in the following:
2482 * @li @ref inwin_example_01
2487 * Adds an inwin to the current window
2489 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2490 * Never call this function with anything other than the top-most window
2491 * as its parameter, unless you are fond of undefined behavior.
2493 * After creating the object, the widget will set itself as resize object
2494 * for the window with elm_win_resize_object_add(), so when shown it will
2495 * appear to cover almost the entire window (how much of it depends on its
2496 * content and the style used). It must not be added into other container
2497 * objects and it needs not be moved or resized manually.
2499 * @param parent The parent object
2500 * @return The new object or NULL if it cannot be created
2502 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2504 * Activates an inwin object, ensuring its visibility
2506 * This function will make sure that the inwin @p obj is completely visible
2507 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2508 * to the front. It also sets the keyboard focus to it, which will be passed
2511 * The object's theme will also receive the signal "elm,action,show" with
2514 * @param obj The inwin to activate
2516 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2518 * Set the content of an inwin object.
2520 * Once the content object is set, a previously set one will be deleted.
2521 * If you want to keep that old content object, use the
2522 * elm_win_inwin_content_unset() function.
2524 * @param obj The inwin object
2525 * @param content The object to set as content
2527 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2529 * Get the content of an inwin object.
2531 * Return the content object which is set for this widget.
2533 * The returned object is valid as long as the inwin is still alive and no
2534 * other content is set on it. Deleting the object will notify the inwin
2535 * about it and this one will be left empty.
2537 * If you need to remove an inwin's content to be reused somewhere else,
2538 * see elm_win_inwin_content_unset().
2540 * @param obj The inwin object
2541 * @return The content that is being used
2543 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2545 * Unset the content of an inwin object.
2547 * Unparent and return the content object which was set for this widget.
2549 * @param obj The inwin object
2550 * @return The content that was being used
2552 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2556 /* X specific calls - won't work on non-x engines (return 0) */
2557 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2558 /* smart callbacks called:
2559 * "delete,request" - the user requested to delete the window
2560 * "focus,in" - window got focus
2561 * "focus,out" - window lost focus
2562 * "moved" - window that holds the canvas was moved
2568 * @image html img/widget/bg/preview-00.png
2569 * @image latex img/widget/bg/preview-00.eps
2571 * @brief Background object, used for setting a solid color, image or Edje
2572 * group as background to a window or any container object.
2574 * The bg object is used for setting a solid background to a window or
2575 * packing into any container object. It works just like an image, but has
2576 * some properties useful to a background, like setting it to tiled,
2577 * centered, scaled or stretched.
2579 * Here is some sample code using it:
2580 * @li @ref bg_01_example_page
2581 * @li @ref bg_02_example_page
2582 * @li @ref bg_03_example_page
2586 typedef enum _Elm_Bg_Option
2588 ELM_BG_OPTION_CENTER, /**< center the background */
2589 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2590 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2591 ELM_BG_OPTION_TILE /**< tile background at its original size */
2595 * Add a new background to the parent
2597 * @param parent The parent object
2598 * @return The new object or NULL if it cannot be created
2602 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2605 * Set the file (image or edje) used for the background
2607 * @param obj The bg object
2608 * @param file The file path
2609 * @param group Optional key (group in Edje) within the file
2611 * This sets the image file used in the background object. The image (or edje)
2612 * will be stretched (retaining aspect if its an image file) to completely fill
2613 * the bg object. This may mean some parts are not visible.
2615 * @note Once the image of @p obj is set, a previously set one will be deleted,
2616 * even if @p file is NULL.
2620 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2623 * Get the file (image or edje) used for the background
2625 * @param obj The bg object
2626 * @param file The file path
2627 * @param group Optional key (group in Edje) within the file
2631 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2634 * Set the option used for the background image
2636 * @param obj The bg object
2637 * @param option The desired background option (TILE, SCALE)
2639 * This sets the option used for manipulating the display of the background
2640 * image. The image can be tiled or scaled.
2644 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2647 * Get the option used for the background image
2649 * @param obj The bg object
2650 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2654 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2656 * Set the option used for the background color
2658 * @param obj The bg object
2663 * This sets the color used for the background rectangle. Its range goes
2668 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2670 * Get the option used for the background color
2672 * @param obj The bg object
2679 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2682 * Set the overlay object used for the background object.
2684 * @param obj The bg object
2685 * @param overlay The overlay object
2687 * This provides a way for elm_bg to have an 'overlay' that will be on top
2688 * of the bg. Once the over object is set, a previously set one will be
2689 * deleted, even if you set the new one to NULL. If you want to keep that
2690 * old content object, use the elm_bg_overlay_unset() function.
2695 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2698 * Get the overlay object used for the background object.
2700 * @param obj The bg object
2701 * @return The content that is being used
2703 * Return the content object which is set for this widget
2707 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2710 * Get the overlay object used for the background object.
2712 * @param obj The bg object
2713 * @return The content that was being used
2715 * Unparent and return the overlay object which was set for this widget
2719 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2722 * Set the size of the pixmap representation of the image.
2724 * This option just makes sense if an image is going to be set in the bg.
2726 * @param obj The bg object
2727 * @param w The new width of the image pixmap representation.
2728 * @param h The new height of the image pixmap representation.
2730 * This function sets a new size for pixmap representation of the given bg
2731 * image. It allows the image to be loaded already in the specified size,
2732 * reducing the memory usage and load time when loading a big image with load
2733 * size set to a smaller size.
2735 * NOTE: this is just a hint, the real size of the pixmap may differ
2736 * depending on the type of image being loaded, being bigger than requested.
2740 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2741 /* smart callbacks called:
2745 * @defgroup Icon Icon
2747 * @image html img/widget/icon/preview-00.png
2748 * @image latex img/widget/icon/preview-00.eps
2750 * An object that provides standard icon images (delete, edit, arrows, etc.)
2751 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2753 * The icon image requested can be in the elementary theme, or in the
2754 * freedesktop.org paths. It's possible to set the order of preference from
2755 * where the image will be used.
2757 * This API is very similar to @ref Image, but with ready to use images.
2759 * Default images provided by the theme are described below.
2761 * The first list contains icons that were first intended to be used in
2762 * toolbars, but can be used in many other places too:
2778 * Now some icons that were designed to be used in menus (but again, you can
2779 * use them anywhere else):
2784 * @li menu/arrow_down
2785 * @li menu/arrow_left
2786 * @li menu/arrow_right
2795 * And here we have some media player specific icons:
2796 * @li media_player/forward
2797 * @li media_player/info
2798 * @li media_player/next
2799 * @li media_player/pause
2800 * @li media_player/play
2801 * @li media_player/prev
2802 * @li media_player/rewind
2803 * @li media_player/stop
2805 * Signals that you can add callbacks for are:
2807 * "clicked" - This is called when a user has clicked the icon
2809 * An example of usage for this API follows:
2810 * @li @ref tutorial_icon
2818 typedef enum _Elm_Icon_Type
2825 * @enum _Elm_Icon_Lookup_Order
2826 * @typedef Elm_Icon_Lookup_Order
2828 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2829 * theme, FDO paths, or both?
2833 typedef enum _Elm_Icon_Lookup_Order
2835 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2836 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2837 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2838 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2839 } Elm_Icon_Lookup_Order;
2842 * Add a new icon object to the parent.
2844 * @param parent The parent object
2845 * @return The new object or NULL if it cannot be created
2847 * @see elm_icon_file_set()
2851 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2853 * Set the file that will be used as icon.
2855 * @param obj The icon object
2856 * @param file The path to file that will be used as icon image
2857 * @param group The group that the icon belongs to in edje file
2859 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2861 * @note The icon image set by this function can be changed by
2862 * elm_icon_standard_set().
2864 * @see elm_icon_file_get()
2868 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2870 * Set a location in memory to be used as an icon
2872 * @param obj The icon object
2873 * @param img The binary data that will be used as an image
2874 * @param size The size of binary data @p img
2875 * @param format Optional format of @p img to pass to the image loader
2876 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2878 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2880 * @note The icon image set by this function can be changed by
2881 * elm_icon_standard_set().
2885 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);
2887 * Get the file that will be used as icon.
2889 * @param obj The icon object
2890 * @param file The path to file that will be used as icon icon image
2891 * @param group The group that the icon belongs to in edje file
2893 * @see elm_icon_file_set()
2897 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2898 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2900 * Set the icon by icon standards names.
2902 * @param obj The icon object
2903 * @param name The icon name
2905 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2907 * For example, freedesktop.org defines standard icon names such as "home",
2908 * "network", etc. There can be different icon sets to match those icon
2909 * keys. The @p name given as parameter is one of these "keys", and will be
2910 * used to look in the freedesktop.org paths and elementary theme. One can
2911 * change the lookup order with elm_icon_order_lookup_set().
2913 * If name is not found in any of the expected locations and it is the
2914 * absolute path of an image file, this image will be used.
2916 * @note The icon image set by this function can be changed by
2917 * elm_icon_file_set().
2919 * @see elm_icon_standard_get()
2920 * @see elm_icon_file_set()
2924 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2926 * Get the icon name set by icon standard names.
2928 * @param obj The icon object
2929 * @return The icon name
2931 * If the icon image was set using elm_icon_file_set() instead of
2932 * elm_icon_standard_set(), then this function will return @c NULL.
2934 * @see elm_icon_standard_set()
2938 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2940 * Set the smooth effect for an icon object.
2942 * @param obj The icon object
2943 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2944 * otherwise. Default is @c EINA_TRUE.
2946 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2947 * scaling provides a better resulting image, but is slower.
2949 * The smooth scaling should be disabled when making animations that change
2950 * the icon size, since they will be faster. Animations that don't require
2951 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2952 * is already scaled, since the scaled icon image will be cached).
2954 * @see elm_icon_smooth_get()
2958 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2960 * Get the smooth effect for an icon object.
2962 * @param obj The icon object
2963 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2965 * @see elm_icon_smooth_set()
2969 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2971 * Disable scaling of this object.
2973 * @param obj The icon object.
2974 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2975 * otherwise. Default is @c EINA_FALSE.
2977 * This function disables scaling of the icon object through the function
2978 * elm_object_scale_set(). However, this does not affect the object
2979 * size/resize in any way. For that effect, take a look at
2980 * elm_icon_scale_set().
2982 * @see elm_icon_no_scale_get()
2983 * @see elm_icon_scale_set()
2984 * @see elm_object_scale_set()
2988 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2990 * Get whether scaling is disabled on the object.
2992 * @param obj The icon object
2993 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2995 * @see elm_icon_no_scale_set()
2999 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3001 * Set if the object is (up/down) resizeable.
3003 * @param obj The icon object
3004 * @param scale_up A bool to set if the object is resizeable up. Default is
3006 * @param scale_down A bool to set if the object is resizeable down. Default
3009 * This function limits the icon object resize ability. If @p scale_up is set to
3010 * @c EINA_FALSE, the object can't have its height or width resized to a value
3011 * higher than the original icon size. Same is valid for @p scale_down.
3013 * @see elm_icon_scale_get()
3017 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3019 * Get if the object is (up/down) resizeable.
3021 * @param obj The icon object
3022 * @param scale_up A bool to set if the object is resizeable up
3023 * @param scale_down A bool to set if the object is resizeable down
3025 * @see elm_icon_scale_set()
3029 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3031 * Get the object's image size
3033 * @param obj The icon object
3034 * @param w A pointer to store the width in
3035 * @param h A pointer to store the height in
3039 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3041 * Set if the icon fill the entire object area.
3043 * @param obj The icon object
3044 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3045 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3047 * When the icon object is resized to a different aspect ratio from the
3048 * original icon image, the icon image will still keep its aspect. This flag
3049 * tells how the image should fill the object's area. They are: keep the
3050 * entire icon inside the limits of height and width of the object (@p
3051 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3052 * of the object, and the icon will fill the entire object (@p fill_outside
3055 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3056 * retain property to false. Thus, the icon image will always keep its
3057 * original aspect ratio.
3059 * @see elm_icon_fill_outside_get()
3060 * @see elm_image_fill_outside_set()
3064 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3066 * Get if the object is filled outside.
3068 * @param obj The icon object
3069 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3071 * @see elm_icon_fill_outside_set()
3075 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3077 * Set the prescale size for the icon.
3079 * @param obj The icon object
3080 * @param size The prescale size. This value is used for both width and
3083 * This function sets a new size for pixmap representation of the given
3084 * icon. It allows the icon to be loaded already in the specified size,
3085 * reducing the memory usage and load time when loading a big icon with load
3086 * size set to a smaller size.
3088 * It's equivalent to the elm_bg_load_size_set() function for bg.
3090 * @note this is just a hint, the real size of the pixmap may differ
3091 * depending on the type of icon being loaded, being bigger than requested.
3093 * @see elm_icon_prescale_get()
3094 * @see elm_bg_load_size_set()
3098 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3100 * Get the prescale size for the icon.
3102 * @param obj The icon object
3103 * @return The prescale size
3105 * @see elm_icon_prescale_set()
3109 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3111 * Sets the icon lookup order used by elm_icon_standard_set().
3113 * @param obj The icon object
3114 * @param order The icon lookup order (can be one of
3115 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3116 * or ELM_ICON_LOOKUP_THEME)
3118 * @see elm_icon_order_lookup_get()
3119 * @see Elm_Icon_Lookup_Order
3123 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3125 * Gets the icon lookup order.
3127 * @param obj The icon object
3128 * @return The icon lookup order
3130 * @see elm_icon_order_lookup_set()
3131 * @see Elm_Icon_Lookup_Order
3135 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3142 * @defgroup Image Image
3144 * @image html img/widget/image/preview-00.png
3145 * @image latex img/widget/image/preview-00.eps
3147 * An object that allows one to load an image file to it. It can be used
3148 * anywhere like any other elementary widget.
3150 * This widget provides most of the functionality provided from @ref Bg or @ref
3151 * Icon, but with a slightly different API (use the one that fits better your
3154 * The features not provided by those two other image widgets are:
3155 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3156 * @li change the object orientation with elm_image_orient_set();
3157 * @li and turning the image editable with elm_image_editable_set().
3159 * Signals that you can add callbacks for are:
3161 * @li @c "clicked" - This is called when a user has clicked the image
3163 * An example of usage for this API follows:
3164 * @li @ref tutorial_image
3173 * @enum _Elm_Image_Orient
3174 * @typedef Elm_Image_Orient
3176 * Possible orientation options for elm_image_orient_set().
3178 * @image html elm_image_orient_set.png
3179 * @image latex elm_image_orient_set.eps width=\textwidth
3183 typedef enum _Elm_Image_Orient
3185 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3186 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3187 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3188 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3189 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3190 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3191 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3192 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3196 * Add a new image to the parent.
3198 * @param parent The parent object
3199 * @return The new object or NULL if it cannot be created
3201 * @see elm_image_file_set()
3205 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3207 * Set the file that will be used as image.
3209 * @param obj The image object
3210 * @param file The path to file that will be used as image
3211 * @param group The group that the image belongs in edje file (if it's an
3214 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3216 * @see elm_image_file_get()
3220 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3222 * Get the file that will be used as image.
3224 * @param obj The image object
3225 * @param file The path to file
3226 * @param group The group that the image belongs in edje file
3228 * @see elm_image_file_set()
3232 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3234 * Set the smooth effect for an image.
3236 * @param obj The image object
3237 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3238 * otherwise. Default is @c EINA_TRUE.
3240 * Set the scaling algorithm to be used when scaling the image. Smooth
3241 * scaling provides a better resulting image, but is slower.
3243 * The smooth scaling should be disabled when making animations that change
3244 * the image size, since it will be faster. Animations that don't require
3245 * resizing of the image can keep the smooth scaling enabled (even if the
3246 * image is already scaled, since the scaled image will be cached).
3248 * @see elm_image_smooth_get()
3252 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3254 * Get the smooth effect for an image.
3256 * @param obj The image object
3257 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3259 * @see elm_image_smooth_get()
3263 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3265 * Gets the current size of the image.
3267 * @param obj The image object.
3268 * @param w Pointer to store width, or NULL.
3269 * @param h Pointer to store height, or NULL.
3271 * This is the real size of the image, not the size of the object.
3273 * On error, neither w or h will be written.
3277 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3279 * Disable scaling of this object.
3281 * @param obj The image object.
3282 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3283 * otherwise. Default is @c EINA_FALSE.
3285 * This function disables scaling of the elm_image widget through the
3286 * function elm_object_scale_set(). However, this does not affect the widget
3287 * size/resize in any way. For that effect, take a look at
3288 * elm_image_scale_set().
3290 * @see elm_image_no_scale_get()
3291 * @see elm_image_scale_set()
3292 * @see elm_object_scale_set()
3296 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3298 * Get whether scaling is disabled on the object.
3300 * @param obj The image object
3301 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3303 * @see elm_image_no_scale_set()
3307 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3309 * Set if the object is (up/down) resizeable.
3311 * @param obj The image object
3312 * @param scale_up A bool to set if the object is resizeable up. Default is
3314 * @param scale_down A bool to set if the object is resizeable down. Default
3317 * This function limits the image resize ability. If @p scale_up is set to
3318 * @c EINA_FALSE, the object can't have its height or width resized to a value
3319 * higher than the original image size. Same is valid for @p scale_down.
3321 * @see elm_image_scale_get()
3325 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3327 * Get if the object is (up/down) resizeable.
3329 * @param obj The image object
3330 * @param scale_up A bool to set if the object is resizeable up
3331 * @param scale_down A bool to set if the object is resizeable down
3333 * @see elm_image_scale_set()
3337 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3339 * Set if the image fill the entire object area when keeping the aspect ratio.
3341 * @param obj The image object
3342 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3343 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3345 * When the image should keep its aspect ratio even if resized to another
3346 * aspect ratio, there are two possibilities to resize it: keep the entire
3347 * image inside the limits of height and width of the object (@p fill_outside
3348 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3349 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3351 * @note This option will have no effect if
3352 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3354 * @see elm_image_fill_outside_get()
3355 * @see elm_image_aspect_ratio_retained_set()
3359 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3361 * Get if the object is filled outside
3363 * @param obj The image object
3364 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3366 * @see elm_image_fill_outside_set()
3370 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3372 * Set the prescale size for the image
3374 * @param obj The image object
3375 * @param size The prescale size. This value is used for both width and
3378 * This function sets a new size for pixmap representation of the given
3379 * image. It allows the image to be loaded already in the specified size,
3380 * reducing the memory usage and load time when loading a big image with load
3381 * size set to a smaller size.
3383 * It's equivalent to the elm_bg_load_size_set() function for bg.
3385 * @note this is just a hint, the real size of the pixmap may differ
3386 * depending on the type of image being loaded, being bigger than requested.
3388 * @see elm_image_prescale_get()
3389 * @see elm_bg_load_size_set()
3393 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3395 * Get the prescale size for the image
3397 * @param obj The image object
3398 * @return The prescale size
3400 * @see elm_image_prescale_set()
3404 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3406 * Set the image orientation.
3408 * @param obj The image object
3409 * @param orient The image orientation
3410 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3411 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3412 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3413 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3414 * Default is #ELM_IMAGE_ORIENT_NONE.
3416 * This function allows to rotate or flip the given image.
3418 * @see elm_image_orient_get()
3419 * @see @ref Elm_Image_Orient
3423 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3425 * Get the image orientation.
3427 * @param obj The image object
3428 * @return The image orientation
3429 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3430 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3431 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3432 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3434 * @see elm_image_orient_set()
3435 * @see @ref Elm_Image_Orient
3439 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3441 * Make the image 'editable'.
3443 * @param obj Image object.
3444 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3446 * This means the image is a valid drag target for drag and drop, and can be
3447 * cut or pasted too.
3451 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3453 * Make the image 'editable'.
3455 * @param obj Image object.
3456 * @return Editability.
3458 * This means the image is a valid drag target for drag and drop, and can be
3459 * cut or pasted too.
3463 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3465 * Get the basic Evas_Image object from this object (widget).
3467 * @param obj The image object to get the inlined image from
3468 * @return The inlined image object, or NULL if none exists
3470 * This function allows one to get the underlying @c Evas_Object of type
3471 * Image from this elementary widget. It can be useful to do things like get
3472 * the pixel data, save the image to a file, etc.
3474 * @note Be careful to not manipulate it, as it is under control of
3479 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3481 * Set whether the original aspect ratio of the image should be kept on resize.
3483 * @param obj The image object.
3484 * @param retained @c EINA_TRUE if the image should retain the aspect,
3485 * @c EINA_FALSE otherwise.
3487 * The original aspect ratio (width / height) of the image is usually
3488 * distorted to match the object's size. Enabling this option will retain
3489 * this original aspect, and the way that the image is fit into the object's
3490 * area depends on the option set by elm_image_fill_outside_set().
3492 * @see elm_image_aspect_ratio_retained_get()
3493 * @see elm_image_fill_outside_set()
3497 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3499 * Get if the object retains the original aspect ratio.
3501 * @param obj The image object.
3502 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3507 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3509 /* smart callbacks called:
3510 * "clicked" - the user clicked the image
3518 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3520 typedef enum _Elm_GLView_Mode
3522 ELM_GLVIEW_ALPHA = 1,
3523 ELM_GLVIEW_DEPTH = 2,
3524 ELM_GLVIEW_STENCIL = 4
3528 * Defines a policy for the glview resizing.
3530 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3532 typedef enum _Elm_GLView_Resize_Policy
3534 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3535 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3536 } Elm_GLView_Resize_Policy;
3538 typedef enum _Elm_GLView_Render_Policy
3540 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3541 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3542 } Elm_GLView_Render_Policy;
3545 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3546 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3547 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3548 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3549 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3550 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3551 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3552 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3553 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3554 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3555 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3556 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3562 * @image html img/widget/box/preview-00.png
3563 * @image latex img/widget/box/preview-00.eps width=\textwidth
3565 * @image html img/box.png
3566 * @image latex img/box.eps width=\textwidth
3568 * A box arranges objects in a linear fashion, governed by a layout function
3569 * that defines the details of this arrangement.
3571 * By default, the box will use an internal function to set the layout to
3572 * a single row, either vertical or horizontal. This layout is affected
3573 * by a number of parameters, such as the homogeneous flag set by
3574 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3575 * elm_box_align_set() and the hints set to each object in the box.
3577 * For this default layout, it's possible to change the orientation with
3578 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3579 * placing its elements ordered from top to bottom. When horizontal is set,
3580 * the order will go from left to right. If the box is set to be
3581 * homogeneous, every object in it will be assigned the same space, that
3582 * of the largest object. Padding can be used to set some spacing between
3583 * the cell given to each object. The alignment of the box, set with
3584 * elm_box_align_set(), determines how the bounding box of all the elements
3585 * will be placed within the space given to the box widget itself.
3587 * The size hints of each object also affect how they are placed and sized
3588 * within the box. evas_object_size_hint_min_set() will give the minimum
3589 * size the object can have, and the box will use it as the basis for all
3590 * latter calculations. Elementary widgets set their own minimum size as
3591 * needed, so there's rarely any need to use it manually.
3593 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3594 * used to tell whether the object will be allocated the minimum size it
3595 * needs or if the space given to it should be expanded. It's important
3596 * to realize that expanding the size given to the object is not the same
3597 * thing as resizing the object. It could very well end being a small
3598 * widget floating in a much larger empty space. If not set, the weight
3599 * for objects will normally be 0.0 for both axis, meaning the widget will
3600 * not be expanded. To take as much space possible, set the weight to
3601 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3603 * Besides how much space each object is allocated, it's possible to control
3604 * how the widget will be placed within that space using
3605 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3606 * for both axis, meaning the object will be centered, but any value from
3607 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3608 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3609 * is -1.0, means the object will be resized to fill the entire space it
3612 * In addition, customized functions to define the layout can be set, which
3613 * allow the application developer to organize the objects within the box
3614 * in any number of ways.
3616 * The special elm_box_layout_transition() function can be used
3617 * to switch from one layout to another, animating the motion of the
3618 * children of the box.
3620 * @note Objects should not be added to box objects using _add() calls.
3622 * Some examples on how to use boxes follow:
3623 * @li @ref box_example_01
3624 * @li @ref box_example_02
3629 * @typedef Elm_Box_Transition
3631 * Opaque handler containing the parameters to perform an animated
3632 * transition of the layout the box uses.
3634 * @see elm_box_transition_new()
3635 * @see elm_box_layout_set()
3636 * @see elm_box_layout_transition()
3638 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3641 * Add a new box to the parent
3643 * By default, the box will be in vertical mode and non-homogeneous.
3645 * @param parent The parent object
3646 * @return The new object or NULL if it cannot be created
3648 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3650 * Set the horizontal orientation
3652 * By default, box object arranges their contents vertically from top to
3654 * By calling this function with @p horizontal as EINA_TRUE, the box will
3655 * become horizontal, arranging contents from left to right.
3657 * @note This flag is ignored if a custom layout function is set.
3659 * @param obj The box object
3660 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3661 * EINA_FALSE = vertical)
3663 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3665 * Get the horizontal orientation
3667 * @param obj The box object
3668 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3670 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3672 * Set the box to arrange its children homogeneously
3674 * If enabled, homogeneous layout makes all items the same size, according
3675 * to the size of the largest of its children.
3677 * @note This flag is ignored if a custom layout function is set.
3679 * @param obj The box object
3680 * @param homogeneous The homogeneous flag
3682 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3684 * Get whether the box is using homogeneous mode or not
3686 * @param obj The box object
3687 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3689 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3690 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3691 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3693 * Add an object to the beginning of the pack list
3695 * Pack @p subobj into the box @p obj, placing it first in the list of
3696 * children objects. The actual position the object will get on screen
3697 * depends on the layout used. If no custom layout is set, it will be at
3698 * the top or left, depending if the box is vertical or horizontal,
3701 * @param obj The box object
3702 * @param subobj The object to add to the box
3704 * @see elm_box_pack_end()
3705 * @see elm_box_pack_before()
3706 * @see elm_box_pack_after()
3707 * @see elm_box_unpack()
3708 * @see elm_box_unpack_all()
3709 * @see elm_box_clear()
3711 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3713 * Add an object at the end of the pack list
3715 * Pack @p subobj into the box @p obj, placing it last in the list of
3716 * children objects. The actual position the object will get on screen
3717 * depends on the layout used. If no custom layout is set, it will be at
3718 * the bottom or right, depending if the box is vertical or horizontal,
3721 * @param obj The box object
3722 * @param subobj The object to add to the box
3724 * @see elm_box_pack_start()
3725 * @see elm_box_pack_before()
3726 * @see elm_box_pack_after()
3727 * @see elm_box_unpack()
3728 * @see elm_box_unpack_all()
3729 * @see elm_box_clear()
3731 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3733 * Adds an object to the box before the indicated object
3735 * This will add the @p subobj to the box indicated before the object
3736 * indicated with @p before. If @p before is not already in the box, results
3737 * are undefined. Before means either to the left of the indicated object or
3738 * above it depending on orientation.
3740 * @param obj The box object
3741 * @param subobj The object to add to the box
3742 * @param before The object before which to add it
3744 * @see elm_box_pack_start()
3745 * @see elm_box_pack_end()
3746 * @see elm_box_pack_after()
3747 * @see elm_box_unpack()
3748 * @see elm_box_unpack_all()
3749 * @see elm_box_clear()
3751 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3753 * Adds an object to the box after the indicated object
3755 * This will add the @p subobj to the box indicated after the object
3756 * indicated with @p after. If @p after is not already in the box, results
3757 * are undefined. After means either to the right of the indicated object or
3758 * below it depending on orientation.
3760 * @param obj The box object
3761 * @param subobj The object to add to the box
3762 * @param after The object after which to add it
3764 * @see elm_box_pack_start()
3765 * @see elm_box_pack_end()
3766 * @see elm_box_pack_before()
3767 * @see elm_box_unpack()
3768 * @see elm_box_unpack_all()
3769 * @see elm_box_clear()
3771 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3773 * Clear the box of all children
3775 * Remove all the elements contained by the box, deleting the respective
3778 * @param obj The box object
3780 * @see elm_box_unpack()
3781 * @see elm_box_unpack_all()
3783 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3787 * Remove the object given by @p subobj from the box @p obj without
3790 * @param obj The box object
3792 * @see elm_box_unpack_all()
3793 * @see elm_box_clear()
3795 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3797 * Remove all items from the box, without deleting them
3799 * Clear the box from all children, but don't delete the respective objects.
3800 * If no other references of the box children exist, the objects will never
3801 * be deleted, and thus the application will leak the memory. Make sure
3802 * when using this function that you hold a reference to all the objects
3803 * in the box @p obj.
3805 * @param obj The box object
3807 * @see elm_box_clear()
3808 * @see elm_box_unpack()
3810 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3812 * Retrieve a list of the objects packed into the box
3814 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3815 * The order of the list corresponds to the packing order the box uses.
3817 * You must free this list with eina_list_free() once you are done with it.
3819 * @param obj The box object
3821 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3823 * Set the space (padding) between the box's elements.
3825 * Extra space in pixels that will be added between a box child and its
3826 * neighbors after its containing cell has been calculated. This padding
3827 * is set for all elements in the box, besides any possible padding that
3828 * individual elements may have through their size hints.
3830 * @param obj The box object
3831 * @param horizontal The horizontal space between elements
3832 * @param vertical The vertical space between elements
3834 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3836 * Get the space (padding) between the box's elements.
3838 * @param obj The box object
3839 * @param horizontal The horizontal space between elements
3840 * @param vertical The vertical space between elements
3842 * @see elm_box_padding_set()
3844 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3846 * Set the alignment of the whole bouding box of contents.
3848 * Sets how the bounding box containing all the elements of the box, after
3849 * their sizes and position has been calculated, will be aligned within
3850 * the space given for the whole box widget.
3852 * @param obj The box object
3853 * @param horizontal The horizontal alignment of elements
3854 * @param vertical The vertical alignment of elements
3856 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3858 * Get the alignment of the whole bouding box of contents.
3860 * @param obj The box object
3861 * @param horizontal The horizontal alignment of elements
3862 * @param vertical The vertical alignment of elements
3864 * @see elm_box_align_set()
3866 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3869 * Set the layout defining function to be used by the box
3871 * Whenever anything changes that requires the box in @p obj to recalculate
3872 * the size and position of its elements, the function @p cb will be called
3873 * to determine what the layout of the children will be.
3875 * Once a custom function is set, everything about the children layout
3876 * is defined by it. The flags set by elm_box_horizontal_set() and
3877 * elm_box_homogeneous_set() no longer have any meaning, and the values
3878 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3879 * layout function to decide if they are used and how. These last two
3880 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3881 * passed to @p cb. The @c Evas_Object the function receives is not the
3882 * Elementary widget, but the internal Evas Box it uses, so none of the
3883 * functions described here can be used on it.
3885 * Any of the layout functions in @c Evas can be used here, as well as the
3886 * special elm_box_layout_transition().
3888 * The final @p data argument received by @p cb is the same @p data passed
3889 * here, and the @p free_data function will be called to free it
3890 * whenever the box is destroyed or another layout function is set.
3892 * Setting @p cb to NULL will revert back to the default layout function.
3894 * @param obj The box object
3895 * @param cb The callback function used for layout
3896 * @param data Data that will be passed to layout function
3897 * @param free_data Function called to free @p data
3899 * @see elm_box_layout_transition()
3901 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);
3903 * Special layout function that animates the transition from one layout to another
3905 * Normally, when switching the layout function for a box, this will be
3906 * reflected immediately on screen on the next render, but it's also
3907 * possible to do this through an animated transition.
3909 * This is done by creating an ::Elm_Box_Transition and setting the box
3910 * layout to this function.
3914 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3915 * evas_object_box_layout_vertical, // start
3916 * NULL, // data for initial layout
3917 * NULL, // free function for initial data
3918 * evas_object_box_layout_horizontal, // end
3919 * NULL, // data for final layout
3920 * NULL, // free function for final data
3921 * anim_end, // will be called when animation ends
3922 * NULL); // data for anim_end function\
3923 * elm_box_layout_set(box, elm_box_layout_transition, t,
3924 * elm_box_transition_free);
3927 * @note This function can only be used with elm_box_layout_set(). Calling
3928 * it directly will not have the expected results.
3930 * @see elm_box_transition_new
3931 * @see elm_box_transition_free
3932 * @see elm_box_layout_set
3934 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3936 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3938 * If you want to animate the change from one layout to another, you need
3939 * to set the layout function of the box to elm_box_layout_transition(),
3940 * passing as user data to it an instance of ::Elm_Box_Transition with the
3941 * necessary information to perform this animation. The free function to
3942 * set for the layout is elm_box_transition_free().
3944 * The parameters to create an ::Elm_Box_Transition sum up to how long
3945 * will it be, in seconds, a layout function to describe the initial point,
3946 * another for the final position of the children and one function to be
3947 * called when the whole animation ends. This last function is useful to
3948 * set the definitive layout for the box, usually the same as the end
3949 * layout for the animation, but could be used to start another transition.
3951 * @param start_layout The layout function that will be used to start the animation
3952 * @param start_layout_data The data to be passed the @p start_layout function
3953 * @param start_layout_free_data Function to free @p start_layout_data
3954 * @param end_layout The layout function that will be used to end the animation
3955 * @param end_layout_free_data The data to be passed the @p end_layout function
3956 * @param end_layout_free_data Function to free @p end_layout_data
3957 * @param transition_end_cb Callback function called when animation ends
3958 * @param transition_end_data Data to be passed to @p transition_end_cb
3959 * @return An instance of ::Elm_Box_Transition
3961 * @see elm_box_transition_new
3962 * @see elm_box_layout_transition
3964 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);
3966 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3968 * This function is mostly useful as the @c free_data parameter in
3969 * elm_box_layout_set() when elm_box_layout_transition().
3971 * @param data The Elm_Box_Transition instance to be freed.
3973 * @see elm_box_transition_new
3974 * @see elm_box_layout_transition
3976 EAPI void elm_box_transition_free(void *data);
3983 * @defgroup Button Button
3985 * @image html img/widget/button/preview-00.png
3986 * @image html img/widget/button/preview-01.png
3987 * @image html img/widget/button/preview-02.png
3989 * This is a push-button. Press it and run some function. It can contain
3990 * a simple label and icon object and it also has an autorepeat feature.
3992 * This widgets emits the following signals:
3993 * @li "clicked": the user clicked the button (press/release).
3994 * @li "repeated": the user pressed the button without releasing it.
3995 * @li "pressed": button was pressed.
3996 * @li "unpressed": button was released after being pressed.
3997 * In all three cases, the @c event parameter of the callback will be
4000 * Also, defined in the default theme, the button has the following styles
4002 * @li default: a normal button.
4003 * @li anchor: Like default, but the button fades away when the mouse is not
4004 * over it, leaving only the text or icon.
4005 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4006 * continuous look across its options.
4007 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4009 * Follow through a complete example @ref button_example_01 "here".
4013 * Add a new button to the parent's canvas
4015 * @param parent The parent object
4016 * @return The new object or NULL if it cannot be created
4018 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4020 * Set the label used in the button
4022 * The passed @p label can be NULL to clean any existing text in it and
4023 * leave the button as an icon only object.
4025 * @param obj The button object
4026 * @param label The text will be written on the button
4027 * @deprecated use elm_object_text_set() instead.
4029 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4031 * Get the label set for the button
4033 * The string returned is an internal pointer and should not be freed or
4034 * altered. It will also become invalid when the button is destroyed.
4035 * The string returned, if not NULL, is a stringshare, so if you need to
4036 * keep it around even after the button is destroyed, you can use
4037 * eina_stringshare_ref().
4039 * @param obj The button object
4040 * @return The text set to the label, or NULL if nothing is set
4041 * @deprecated use elm_object_text_set() instead.
4043 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4045 * Set the icon used for the button
4047 * Setting a new icon will delete any other that was previously set, making
4048 * any reference to them invalid. If you need to maintain the previous
4049 * object alive, unset it first with elm_button_icon_unset().
4051 * @param obj The button object
4052 * @param icon The icon object for the button
4054 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4056 * Get the icon used for the button
4058 * Return the icon object which is set for this widget. If the button is
4059 * destroyed or another icon is set, the returned object will be deleted
4060 * and any reference to it will be invalid.
4062 * @param obj The button object
4063 * @return The icon object that is being used
4065 * @see elm_button_icon_unset()
4067 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4069 * Remove the icon set without deleting it and return the object
4071 * This function drops the reference the button holds of the icon object
4072 * and returns this last object. It is used in case you want to remove any
4073 * icon, or set another one, without deleting the actual object. The button
4074 * will be left without an icon set.
4076 * @param obj The button object
4077 * @return The icon object that was being used
4079 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4081 * Turn on/off the autorepeat event generated when the button is kept pressed
4083 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4084 * signal when they are clicked.
4086 * When on, keeping a button pressed will continuously emit a @c repeated
4087 * signal until the button is released. The time it takes until it starts
4088 * emitting the signal is given by
4089 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4090 * new emission by elm_button_autorepeat_gap_timeout_set().
4092 * @param obj The button object
4093 * @param on A bool to turn on/off the event
4095 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4097 * Get whether the autorepeat feature is enabled
4099 * @param obj The button object
4100 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4102 * @see elm_button_autorepeat_set()
4104 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4106 * Set the initial timeout before the autorepeat event is generated
4108 * Sets the timeout, in seconds, since the button is pressed until the
4109 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4110 * won't be any delay and the even will be fired the moment the button is
4113 * @param obj The button object
4114 * @param t Timeout in seconds
4116 * @see elm_button_autorepeat_set()
4117 * @see elm_button_autorepeat_gap_timeout_set()
4119 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4121 * Get the initial timeout before the autorepeat event is generated
4123 * @param obj The button object
4124 * @return Timeout in seconds
4126 * @see elm_button_autorepeat_initial_timeout_set()
4128 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4130 * Set the interval between each generated autorepeat event
4132 * After the first @c repeated event is fired, all subsequent ones will
4133 * follow after a delay of @p t seconds for each.
4135 * @param obj The button object
4136 * @param t Interval in seconds
4138 * @see elm_button_autorepeat_initial_timeout_set()
4140 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4142 * Get the interval between each generated autorepeat event
4144 * @param obj The button object
4145 * @return Interval in seconds
4147 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4153 * @defgroup File_Selector_Button File Selector Button
4155 * @image html img/widget/fileselector_button/preview-00.png
4156 * @image html img/widget/fileselector_button/preview-01.png
4157 * @image html img/widget/fileselector_button/preview-02.png
4159 * This is a button that, when clicked, creates an Elementary
4160 * window (or inner window) <b> with a @ref Fileselector "file
4161 * selector widget" within</b>. When a file is chosen, the (inner)
4162 * window is closed and the button emits a signal having the
4163 * selected file as it's @c event_info.
4165 * This widget encapsulates operations on its internal file
4166 * selector on its own API. There is less control over its file
4167 * selector than that one would have instatiating one directly.
4169 * The following styles are available for this button:
4172 * @li @c "hoversel_vertical"
4173 * @li @c "hoversel_vertical_entry"
4175 * Smart callbacks one can register to:
4176 * - @c "file,chosen" - the user has selected a path, whose string
4177 * pointer comes as the @c event_info data (a stringshared
4180 * Here is an example on its usage:
4181 * @li @ref fileselector_button_example
4183 * @see @ref File_Selector_Entry for a similar widget.
4188 * Add a new file selector button widget to the given parent
4189 * Elementary (container) object
4191 * @param parent The parent object
4192 * @return a new file selector button widget handle or @c NULL, on
4195 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4198 * Set the label for a given file selector button widget
4200 * @param obj The file selector button widget
4201 * @param label The text label to be displayed on @p obj
4203 * @deprecated use elm_object_text_set() instead.
4205 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4208 * Get the label set for a given file selector button widget
4210 * @param obj The file selector button widget
4211 * @return The button label
4213 * @deprecated use elm_object_text_set() instead.
4215 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4218 * Set the icon on a given file selector button widget
4220 * @param obj The file selector button widget
4221 * @param icon The icon object for the button
4223 * Once the icon object is set, a previously set one will be
4224 * deleted. If you want to keep the latter, use the
4225 * elm_fileselector_button_icon_unset() function.
4227 * @see elm_fileselector_button_icon_get()
4229 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4232 * Get the icon set for a given file selector button widget
4234 * @param obj The file selector button widget
4235 * @return The icon object currently set on @p obj or @c NULL, if
4238 * @see elm_fileselector_button_icon_set()
4240 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4243 * Unset the icon used in a given file selector button widget
4245 * @param obj The file selector button widget
4246 * @return The icon object that was being used on @p obj or @c
4249 * Unparent and return the icon object which was set for this
4252 * @see elm_fileselector_button_icon_set()
4254 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4257 * Set the title for a given file selector button widget's window
4259 * @param obj The file selector button widget
4260 * @param title The title string
4262 * This will change the window's title, when the file selector pops
4263 * out after a click on the button. Those windows have the default
4264 * (unlocalized) value of @c "Select a file" as titles.
4266 * @note It will only take any effect if the file selector
4267 * button widget is @b not under "inwin mode".
4269 * @see elm_fileselector_button_window_title_get()
4271 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4274 * Get the title set for a given file selector button widget's
4277 * @param obj The file selector button widget
4278 * @return Title of the file selector button's window
4280 * @see elm_fileselector_button_window_title_get() for more details
4282 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4285 * Set the size of a given file selector button widget's window,
4286 * holding the file selector itself.
4288 * @param obj The file selector button widget
4289 * @param width The window's width
4290 * @param height The window's height
4292 * @note it will only take any effect if the file selector button
4293 * widget is @b not under "inwin mode". The default size for the
4294 * window (when applicable) is 400x400 pixels.
4296 * @see elm_fileselector_button_window_size_get()
4298 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4301 * Get the size of a given file selector button widget's window,
4302 * holding the file selector itself.
4304 * @param obj The file selector button widget
4305 * @param width Pointer into which to store the width value
4306 * @param height Pointer into which to store the height value
4308 * @note Use @c NULL pointers on the size values you're not
4309 * interested in: they'll be ignored by the function.
4311 * @see elm_fileselector_button_window_size_set(), for more details
4313 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4316 * Set the initial file system path for a given file selector
4319 * @param obj The file selector button widget
4320 * @param path The path string
4322 * It must be a <b>directory</b> path, which will have the contents
4323 * displayed initially in the file selector's view, when invoked
4324 * from @p obj. The default initial path is the @c "HOME"
4325 * environment variable's value.
4327 * @see elm_fileselector_button_path_get()
4329 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4332 * Get the initial file system path set for a given file selector
4335 * @param obj The file selector button widget
4336 * @return path The path string
4338 * @see elm_fileselector_button_path_set() for more details
4340 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4343 * Enable/disable a tree view in the given file selector button
4344 * widget's internal file selector
4346 * @param obj The file selector button widget
4347 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4350 * This has the same effect as elm_fileselector_expandable_set(),
4351 * but now applied to a file selector button's internal file
4354 * @note There's no way to put a file selector button's internal
4355 * file selector in "grid mode", as one may do with "pure" file
4358 * @see elm_fileselector_expandable_get()
4360 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4363 * Get whether tree view is enabled for the given file selector
4364 * button widget's internal file selector
4366 * @param obj The file selector button widget
4367 * @return @c EINA_TRUE if @p obj widget's internal file selector
4368 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4370 * @see elm_fileselector_expandable_set() for more details
4372 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4375 * Set whether a given file selector button widget's internal file
4376 * selector is to display folders only or the directory contents,
4379 * @param obj The file selector button widget
4380 * @param only @c EINA_TRUE to make @p obj widget's internal file
4381 * selector only display directories, @c EINA_FALSE to make files
4382 * to be displayed in it too
4384 * This has the same effect as elm_fileselector_folder_only_set(),
4385 * but now applied to a file selector button's internal file
4388 * @see elm_fileselector_folder_only_get()
4390 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4393 * Get whether a given file selector button widget's internal file
4394 * selector is displaying folders only or the directory contents,
4397 * @param obj The file selector button widget
4398 * @return @c EINA_TRUE if @p obj widget's internal file
4399 * selector is only displaying directories, @c EINA_FALSE if files
4400 * are being displayed in it too (and on errors)
4402 * @see elm_fileselector_button_folder_only_set() for more details
4404 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407 * Enable/disable the file name entry box where the user can type
4408 * in a name for a file, in a given file selector button widget's
4409 * internal file selector.
4411 * @param obj The file selector button widget
4412 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4413 * file selector a "saving dialog", @c EINA_FALSE otherwise
4415 * This has the same effect as elm_fileselector_is_save_set(),
4416 * but now applied to a file selector button's internal file
4419 * @see elm_fileselector_is_save_get()
4421 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4424 * Get whether the given file selector button widget's internal
4425 * file selector is in "saving dialog" mode
4427 * @param obj The file selector button widget
4428 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4429 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4432 * @see elm_fileselector_button_is_save_set() for more details
4434 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4437 * Set whether a given file selector button widget's internal file
4438 * selector will raise an Elementary "inner window", instead of a
4439 * dedicated Elementary window. By default, it won't.
4441 * @param obj The file selector button widget
4442 * @param value @c EINA_TRUE to make it use an inner window, @c
4443 * EINA_TRUE to make it use a dedicated window
4445 * @see elm_win_inwin_add() for more information on inner windows
4446 * @see elm_fileselector_button_inwin_mode_get()
4448 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4451 * Get whether a given file selector button widget's internal file
4452 * selector will raise an Elementary "inner window", instead of a
4453 * dedicated Elementary window.
4455 * @param obj The file selector button widget
4456 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4457 * if it will use a dedicated window
4459 * @see elm_fileselector_button_inwin_mode_set() for more details
4461 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4468 * @defgroup File_Selector_Entry File Selector Entry
4470 * @image html img/widget/fileselector_entry/preview-00.png
4471 * @image latex img/widget/fileselector_entry/preview-00.eps
4473 * This is an entry made to be filled with or display a <b>file
4474 * system path string</b>. Besides the entry itself, the widget has
4475 * a @ref File_Selector_Button "file selector button" on its side,
4476 * which will raise an internal @ref Fileselector "file selector widget",
4477 * when clicked, for path selection aided by file system
4480 * This file selector may appear in an Elementary window or in an
4481 * inner window. When a file is chosen from it, the (inner) window
4482 * is closed and the selected file's path string is exposed both as
4483 * an smart event and as the new text on the entry.
4485 * This widget encapsulates operations on its internal file
4486 * selector on its own API. There is less control over its file
4487 * selector than that one would have instatiating one directly.
4489 * Smart callbacks one can register to:
4490 * - @c "changed" - The text within the entry was changed
4491 * - @c "activated" - The entry has had editing finished and
4492 * changes are to be "committed"
4493 * - @c "press" - The entry has been clicked
4494 * - @c "longpressed" - The entry has been clicked (and held) for a
4496 * - @c "clicked" - The entry has been clicked
4497 * - @c "clicked,double" - The entry has been double clicked
4498 * - @c "focused" - The entry has received focus
4499 * - @c "unfocused" - The entry has lost focus
4500 * - @c "selection,paste" - A paste action has occurred on the
4502 * - @c "selection,copy" - A copy action has occurred on the entry
4503 * - @c "selection,cut" - A cut action has occurred on the entry
4504 * - @c "unpressed" - The file selector entry's button was released
4505 * after being pressed.
4506 * - @c "file,chosen" - The user has selected a path via the file
4507 * selector entry's internal file selector, whose string pointer
4508 * comes as the @c event_info data (a stringshared string)
4510 * Here is an example on its usage:
4511 * @li @ref fileselector_entry_example
4513 * @see @ref File_Selector_Button for a similar widget.
4518 * Add a new file selector entry widget to the given parent
4519 * Elementary (container) object
4521 * @param parent The parent object
4522 * @return a new file selector entry widget handle or @c NULL, on
4525 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4528 * Set the label for a given file selector entry widget's button
4530 * @param obj The file selector entry widget
4531 * @param label The text label to be displayed on @p obj widget's
4534 * @deprecated use elm_object_text_set() instead.
4536 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4539 * Get the label set for a given file selector entry widget's button
4541 * @param obj The file selector entry widget
4542 * @return The widget button's label
4544 * @deprecated use elm_object_text_set() instead.
4546 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4549 * Set the icon on a given file selector entry widget's button
4551 * @param obj The file selector entry widget
4552 * @param icon The icon object for the entry's button
4554 * Once the icon object is set, a previously set one will be
4555 * deleted. If you want to keep the latter, use the
4556 * elm_fileselector_entry_button_icon_unset() function.
4558 * @see elm_fileselector_entry_button_icon_get()
4560 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4563 * Get the icon set for a given file selector entry widget's button
4565 * @param obj The file selector entry widget
4566 * @return The icon object currently set on @p obj widget's button
4567 * or @c NULL, if none is
4569 * @see elm_fileselector_entry_button_icon_set()
4571 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4574 * Unset the icon used in a given file selector entry widget's
4577 * @param obj The file selector entry widget
4578 * @return The icon object that was being used on @p obj widget's
4579 * button or @c NULL, on errors
4581 * Unparent and return the icon object which was set for this
4584 * @see elm_fileselector_entry_button_icon_set()
4586 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4589 * Set the title for a given file selector entry widget's window
4591 * @param obj The file selector entry widget
4592 * @param title The title string
4594 * This will change the window's title, when the file selector pops
4595 * out after a click on the entry's button. Those windows have the
4596 * default (unlocalized) value of @c "Select a file" as titles.
4598 * @note It will only take any effect if the file selector
4599 * entry widget is @b not under "inwin mode".
4601 * @see elm_fileselector_entry_window_title_get()
4603 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4606 * Get the title set for a given file selector entry widget's
4609 * @param obj The file selector entry widget
4610 * @return Title of the file selector entry's window
4612 * @see elm_fileselector_entry_window_title_get() for more details
4614 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4617 * Set the size of a given file selector entry widget's window,
4618 * holding the file selector itself.
4620 * @param obj The file selector entry widget
4621 * @param width The window's width
4622 * @param height The window's height
4624 * @note it will only take any effect if the file selector entry
4625 * widget is @b not under "inwin mode". The default size for the
4626 * window (when applicable) is 400x400 pixels.
4628 * @see elm_fileselector_entry_window_size_get()
4630 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4633 * Get the size of a given file selector entry widget's window,
4634 * holding the file selector itself.
4636 * @param obj The file selector entry widget
4637 * @param width Pointer into which to store the width value
4638 * @param height Pointer into which to store the height value
4640 * @note Use @c NULL pointers on the size values you're not
4641 * interested in: they'll be ignored by the function.
4643 * @see elm_fileselector_entry_window_size_set(), for more details
4645 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4648 * Set the initial file system path and the entry's path string for
4649 * a given file selector entry widget
4651 * @param obj The file selector entry widget
4652 * @param path The path string
4654 * It must be a <b>directory</b> path, which will have the contents
4655 * displayed initially in the file selector's view, when invoked
4656 * from @p obj. The default initial path is the @c "HOME"
4657 * environment variable's value.
4659 * @see elm_fileselector_entry_path_get()
4661 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4664 * Get the entry's path string for a given file selector entry
4667 * @param obj The file selector entry widget
4668 * @return path The path string
4670 * @see elm_fileselector_entry_path_set() for more details
4672 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4675 * Enable/disable a tree view in the given file selector entry
4676 * widget's internal file selector
4678 * @param obj The file selector entry widget
4679 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4682 * This has the same effect as elm_fileselector_expandable_set(),
4683 * but now applied to a file selector entry's internal file
4686 * @note There's no way to put a file selector entry's internal
4687 * file selector in "grid mode", as one may do with "pure" file
4690 * @see elm_fileselector_expandable_get()
4692 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4695 * Get whether tree view is enabled for the given file selector
4696 * entry widget's internal file selector
4698 * @param obj The file selector entry widget
4699 * @return @c EINA_TRUE if @p obj widget's internal file selector
4700 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4702 * @see elm_fileselector_expandable_set() for more details
4704 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4707 * Set whether a given file selector entry widget's internal file
4708 * selector is to display folders only or the directory contents,
4711 * @param obj The file selector entry widget
4712 * @param only @c EINA_TRUE to make @p obj widget's internal file
4713 * selector only display directories, @c EINA_FALSE to make files
4714 * to be displayed in it too
4716 * This has the same effect as elm_fileselector_folder_only_set(),
4717 * but now applied to a file selector entry's internal file
4720 * @see elm_fileselector_folder_only_get()
4722 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4725 * Get whether a given file selector entry widget's internal file
4726 * selector is displaying folders only or the directory contents,
4729 * @param obj The file selector entry widget
4730 * @return @c EINA_TRUE if @p obj widget's internal file
4731 * selector is only displaying directories, @c EINA_FALSE if files
4732 * are being displayed in it too (and on errors)
4734 * @see elm_fileselector_entry_folder_only_set() for more details
4736 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4739 * Enable/disable the file name entry box where the user can type
4740 * in a name for a file, in a given file selector entry widget's
4741 * internal file selector.
4743 * @param obj The file selector entry widget
4744 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4745 * file selector a "saving dialog", @c EINA_FALSE otherwise
4747 * This has the same effect as elm_fileselector_is_save_set(),
4748 * but now applied to a file selector entry's internal file
4751 * @see elm_fileselector_is_save_get()
4753 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4756 * Get whether the given file selector entry widget's internal
4757 * file selector is in "saving dialog" mode
4759 * @param obj The file selector entry widget
4760 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4761 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4764 * @see elm_fileselector_entry_is_save_set() for more details
4766 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4769 * Set whether a given file selector entry widget's internal file
4770 * selector will raise an Elementary "inner window", instead of a
4771 * dedicated Elementary window. By default, it won't.
4773 * @param obj The file selector entry widget
4774 * @param value @c EINA_TRUE to make it use an inner window, @c
4775 * EINA_TRUE to make it use a dedicated window
4777 * @see elm_win_inwin_add() for more information on inner windows
4778 * @see elm_fileselector_entry_inwin_mode_get()
4780 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4783 * Get whether a given file selector entry widget's internal file
4784 * selector will raise an Elementary "inner window", instead of a
4785 * dedicated Elementary window.
4787 * @param obj The file selector entry widget
4788 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4789 * if it will use a dedicated window
4791 * @see elm_fileselector_entry_inwin_mode_set() for more details
4793 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4796 * Set the initial file system path for a given file selector entry
4799 * @param obj The file selector entry widget
4800 * @param path The path string
4802 * It must be a <b>directory</b> path, which will have the contents
4803 * displayed initially in the file selector's view, when invoked
4804 * from @p obj. The default initial path is the @c "HOME"
4805 * environment variable's value.
4807 * @see elm_fileselector_entry_path_get()
4809 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4812 * Get the parent directory's path to the latest file selection on
4813 * a given filer selector entry widget
4815 * @param obj The file selector object
4816 * @return The (full) path of the directory of the last selection
4817 * on @p obj widget, a @b stringshared string
4819 * @see elm_fileselector_entry_path_set()
4821 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4828 * @defgroup Scroller Scroller
4830 * A scroller holds a single object and "scrolls it around". This means that
4831 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4832 * region around, allowing to move through a much larger object that is
4833 * contained in the scroller. The scroiller will always have a small minimum
4834 * size by default as it won't be limited by the contents of the scroller.
4836 * Signals that you can add callbacks for are:
4837 * @li "edge,left" - the left edge of the content has been reached
4838 * @li "edge,right" - the right edge of the content has been reached
4839 * @li "edge,top" - the top edge of the content has been reached
4840 * @li "edge,bottom" - the bottom edge of the content has been reached
4841 * @li "scroll" - the content has been scrolled (moved)
4842 * @li "scroll,anim,start" - scrolling animation has started
4843 * @li "scroll,anim,stop" - scrolling animation has stopped
4844 * @li "scroll,drag,start" - dragging the contents around has started
4845 * @li "scroll,drag,stop" - dragging the contents around has stopped
4846 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4849 * @note When Elemementary is in embedded mode the scrollbars will not be
4850 * dragable, they appear merely as indicators of how much has been scrolled.
4851 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4852 * fingerscroll) won't work.
4854 * In @ref tutorial_scroller you'll find an example of how to use most of
4859 * @brief Type that controls when scrollbars should appear.
4861 * @see elm_scroller_policy_set()
4863 typedef enum _Elm_Scroller_Policy
4865 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4866 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4867 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4868 ELM_SCROLLER_POLICY_LAST
4869 } Elm_Scroller_Policy;
4871 * @brief Add a new scroller to the parent
4873 * @param parent The parent object
4874 * @return The new object or NULL if it cannot be created
4876 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4878 * @brief Set the content of the scroller widget (the object to be scrolled around).
4880 * @param obj The scroller object
4881 * @param content The new content object
4883 * Once the content object is set, a previously set one will be deleted.
4884 * If you want to keep that old content object, use the
4885 * elm_scroller_content_unset() function.
4887 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4889 * @brief Get the content of the scroller widget
4891 * @param obj The slider object
4892 * @return The content that is being used
4894 * Return the content object which is set for this widget
4896 * @see elm_scroller_content_set()
4898 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4900 * @brief Unset the content of the scroller widget
4902 * @param obj The slider object
4903 * @return The content that was being used
4905 * Unparent and return the content object which was set for this widget
4907 * @see elm_scroller_content_set()
4909 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4911 * @brief Set custom theme elements for the scroller
4913 * @param obj The scroller object
4914 * @param widget The widget name to use (default is "scroller")
4915 * @param base The base name to use (default is "base")
4917 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4919 * @brief Make the scroller minimum size limited to the minimum size of the content
4921 * @param obj The scroller object
4922 * @param w Enable limiting minimum size horizontally
4923 * @param h Enable limiting minimum size vertically
4925 * By default the scroller will be as small as its design allows,
4926 * irrespective of its content. This will make the scroller minimum size the
4927 * right size horizontally and/or vertically to perfectly fit its content in
4930 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4932 * @brief Show a specific virtual region within the scroller content object
4934 * @param obj The scroller object
4935 * @param x X coordinate of the region
4936 * @param y Y coordinate of the region
4937 * @param w Width of the region
4938 * @param h Height of the region
4940 * This will ensure all (or part if it does not fit) of the designated
4941 * region in the virtual content object (0, 0 starting at the top-left of the
4942 * virtual content object) is shown within the scroller.
4944 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);
4946 * @brief Set the scrollbar visibility policy
4948 * @param obj The scroller object
4949 * @param policy_h Horizontal scrollbar policy
4950 * @param policy_v Vertical scrollbar policy
4952 * This sets the scrollbar visibility policy for the given scroller.
4953 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4954 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4955 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4956 * respectively for the horizontal and vertical scrollbars.
4958 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4960 * @brief Gets scrollbar visibility policy
4962 * @param obj The scroller object
4963 * @param policy_h Horizontal scrollbar policy
4964 * @param policy_v Vertical scrollbar policy
4966 * @see elm_scroller_policy_set()
4968 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4970 * @brief Get the currently visible content region
4972 * @param obj The scroller object
4973 * @param x X coordinate of the region
4974 * @param y Y coordinate of the region
4975 * @param w Width of the region
4976 * @param h Height of the region
4978 * This gets the current region in the content object that is visible through
4979 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4980 * w, @p h values pointed to.
4982 * @note All coordinates are relative to the content.
4984 * @see elm_scroller_region_show()
4986 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);
4988 * @brief Get the size of the content object
4990 * @param obj The scroller object
4991 * @param w Width return
4992 * @param h Height return
4994 * This gets the size of the content object of the scroller.
4996 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4998 * @brief Set bouncing behavior
5000 * @param obj The scroller object
5001 * @param h_bounce Will the scroller bounce horizontally or not
5002 * @param v_bounce Will the scroller bounce vertically or not
5004 * When scrolling, the scroller may "bounce" when reaching an edge of the
5005 * content object. This is a visual way to indicate the end has been reached.
5006 * This is enabled by default for both axis. This will set if it is enabled
5007 * for that axis with the boolean parameters for each axis.
5009 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5011 * @brief Get the bounce mode
5013 * @param obj The Scroller object
5014 * @param h_bounce Allow bounce horizontally
5015 * @param v_bounce Allow bounce vertically
5017 * @see elm_scroller_bounce_set()
5019 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5021 * @brief Set scroll page size relative to viewport size.
5023 * @param obj The scroller object
5024 * @param h_pagerel The horizontal page relative size
5025 * @param v_pagerel The vertical page relative size
5027 * The scroller is capable of limiting scrolling by the user to "pages". That
5028 * is to jump by and only show a "whole page" at a time as if the continuous
5029 * area of the scroller content is split into page sized pieces. This sets
5030 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5031 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5032 * axis. This is mutually exclusive with page size
5033 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5034 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5035 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5038 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5040 * @brief Set scroll page size.
5042 * @param obj The scroller object
5043 * @param h_pagesize The horizontal page size
5044 * @param v_pagesize The vertical page size
5046 * This sets the page size to an absolute fixed value, with 0 turning it off
5049 * @see elm_scroller_page_relative_set()
5051 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5053 * @brief Show a specific virtual region within the scroller content object.
5055 * @param obj The scroller object
5056 * @param x X coordinate of the region
5057 * @param y Y coordinate of the region
5058 * @param w Width of the region
5059 * @param h Height of the region
5061 * This will ensure all (or part if it does not fit) of the designated
5062 * region in the virtual content object (0, 0 starting at the top-left of the
5063 * virtual content object) is shown within the scroller. Unlike
5064 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5065 * to this location (if configuration in general calls for transitions). It
5066 * may not jump immediately to the new location and make take a while and
5067 * show other content along the way.
5069 * @see elm_scroller_region_show()
5071 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);
5073 * @brief Set event propagation on a scroller
5075 * @param obj The scroller object
5076 * @param propagation If propagation is enabled or not
5078 * This enables or disabled event propagation from the scroller content to
5079 * the scroller and its parent. By default event propagation is disabled.
5081 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5083 * @brief Get event propagation for a scroller
5085 * @param obj The scroller object
5086 * @return The propagation state
5088 * This gets the event propagation for a scroller.
5090 * @see elm_scroller_propagate_events_set()
5092 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5098 * @defgroup Label Label
5100 * @image html img/widget/label/preview-00.png
5101 * @image latex img/widget/label/preview-00.eps
5103 * @brief Widget to display text, with simple html-like markup.
5105 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5106 * text doesn't fit the geometry of the label it will be ellipsized or be
5107 * cut. Elementary provides several themes for this widget:
5108 * @li default - No animation
5109 * @li marker - Centers the text in the label and make it bold by default
5110 * @li slide_long - The entire text appears from the right of the screen and
5111 * slides until it disappears in the left of the screen(reappering on the
5113 * @li slide_short - The text appears in the left of the label and slides to
5114 * the right to show the overflow. When all of the text has been shown the
5115 * position is reset.
5116 * @li slide_bounce - The text appears in the left of the label and slides to
5117 * the right to show the overflow. When all of the text has been shown the
5118 * animation reverses, moving the text to the left.
5120 * Custom themes can of course invent new markup tags and style them any way
5123 * See @ref tutorial_label for a demonstration of how to use a label widget.
5127 * @brief Add a new label to the parent
5129 * @param parent The parent object
5130 * @return The new object or NULL if it cannot be created
5132 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5134 * @brief Set the label on the label object
5136 * @param obj The label object
5137 * @param label The label will be used on the label object
5138 * @deprecated See elm_object_text_set()
5140 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 */
5142 * @brief Get the label used on the label object
5144 * @param obj The label object
5145 * @return The string inside the label
5146 * @deprecated See elm_object_text_get()
5148 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5150 * @brief Set the wrapping behavior of the label
5152 * @param obj The label object
5153 * @param wrap To wrap text or not
5155 * By default no wrapping is done. Possible values for @p wrap are:
5156 * @li ELM_WRAP_NONE - No wrapping
5157 * @li ELM_WRAP_CHAR - wrap between characters
5158 * @li ELM_WRAP_WORD - wrap between words
5159 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5161 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5163 * @brief Get the wrapping behavior of the label
5165 * @param obj The label object
5168 * @see elm_label_line_wrap_set()
5170 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5172 * @brief Set wrap width of the label
5174 * @param obj The label object
5175 * @param w The wrap width in pixels at a minimum where words need to wrap
5177 * This function sets the maximum width size hint of the label.
5179 * @warning This is only relevant if the label is inside a container.
5181 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5183 * @brief Get wrap width of the label
5185 * @param obj The label object
5186 * @return The wrap width in pixels at a minimum where words need to wrap
5188 * @see elm_label_wrap_width_set()
5190 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5192 * @brief Set wrap height of the label
5194 * @param obj The label object
5195 * @param h The wrap height in pixels at a minimum where words need to wrap
5197 * This function sets the maximum height size hint of the label.
5199 * @warning This is only relevant if the label is inside a container.
5201 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5203 * @brief get wrap width of the label
5205 * @param obj The label object
5206 * @return The wrap height in pixels at a minimum where words need to wrap
5208 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 * @brief Set the font size on the label object.
5212 * @param obj The label object
5213 * @param size font size
5215 * @warning NEVER use this. It is for hyper-special cases only. use styles
5216 * instead. e.g. "big", "medium", "small" - or better name them by use:
5217 * "title", "footnote", "quote" etc.
5219 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5221 * @brief Set the text color on the label object
5223 * @param obj The label object
5224 * @param r Red property background color of The label object
5225 * @param g Green property background color of The label object
5226 * @param b Blue property background color of The label object
5227 * @param a Alpha property background color of The label object
5229 * @warning NEVER use this. It is for hyper-special cases only. use styles
5230 * instead. e.g. "big", "medium", "small" - or better name them by use:
5231 * "title", "footnote", "quote" etc.
5233 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);
5235 * @brief Set the text align on the label object
5237 * @param obj The label object
5238 * @param align align mode ("left", "center", "right")
5240 * @warning NEVER use this. It is for hyper-special cases only. use styles
5241 * instead. e.g. "big", "medium", "small" - or better name them by use:
5242 * "title", "footnote", "quote" etc.
5244 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5246 * @brief Set background color of the label
5248 * @param obj The label object
5249 * @param r Red property background color of The label object
5250 * @param g Green property background color of The label object
5251 * @param b Blue property background color of The label object
5252 * @param a Alpha property background alpha of The label object
5254 * @warning NEVER use this. It is for hyper-special cases only. use styles
5255 * instead. e.g. "big", "medium", "small" - or better name them by use:
5256 * "title", "footnote", "quote" etc.
5258 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);
5260 * @brief Set the ellipsis behavior of the label
5262 * @param obj The label object
5263 * @param ellipsis To ellipsis text or not
5265 * If set to true and the text doesn't fit in the label an ellipsis("...")
5266 * will be shown at the end of the widget.
5268 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5269 * choosen wrap method was ELM_WRAP_WORD.
5271 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5273 * @brief Set the text slide of the label
5275 * @param obj The label object
5276 * @param slide To start slide or stop
5278 * If set to true the text of the label will slide throught the length of
5281 * @warning This only work with the themes "slide_short", "slide_long" and
5284 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5286 * @brief Get the text slide mode of the label
5288 * @param obj The label object
5289 * @return slide slide mode value
5291 * @see elm_label_slide_set()
5293 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5295 * @brief Set the slide duration(speed) of the label
5297 * @param obj The label object
5298 * @return The duration in seconds in moving text from slide begin position
5299 * to slide end position
5301 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5303 * @brief Get the slide duration(speed) of the label
5305 * @param obj The label object
5306 * @return The duration time in moving text from slide begin position to slide end position
5308 * @see elm_label_slide_duration_set()
5310 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5318 * @image html img/widget/toggle/preview-00.png
5319 * @image latex img/widget/toggle/preview-00.eps
5321 * @brief A toggle is a slider which can be used to toggle between
5322 * two values. It has two states: on and off.
5324 * Signals that you can add callbacks for are:
5325 * @li "changed" - Whenever the toggle value has been changed. Is not called
5326 * until the toggle is released by the cursor (assuming it
5327 * has been triggered by the cursor in the first place).
5329 * @ref tutorial_toggle show how to use a toggle.
5333 * @brief Add a toggle to @p parent.
5335 * @param parent The parent object
5337 * @return The toggle object
5339 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5341 * @brief Sets the label to be displayed with the toggle.
5343 * @param obj The toggle object
5344 * @param label The label to be displayed
5346 * @deprecated use elm_object_text_set() instead.
5348 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5350 * @brief Gets the label of the toggle
5352 * @param obj toggle object
5353 * @return The label of the toggle
5355 * @deprecated use elm_object_text_get() instead.
5357 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5359 * @brief Set the icon used for the toggle
5361 * @param obj The toggle object
5362 * @param icon The icon object for the button
5364 * Once the icon object is set, a previously set one will be deleted
5365 * If you want to keep that old content object, use the
5366 * elm_toggle_icon_unset() function.
5368 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5370 * @brief Get the icon used for the toggle
5372 * @param obj The toggle object
5373 * @return The icon object that is being used
5375 * Return the icon object which is set for this widget.
5377 * @see elm_toggle_icon_set()
5379 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5381 * @brief Unset the icon used for the toggle
5383 * @param obj The toggle object
5384 * @return The icon object that was being used
5386 * Unparent and return the icon object which was set for this widget.
5388 * @see elm_toggle_icon_set()
5390 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5392 * @brief Sets the labels to be associated with the on and off states of the toggle.
5394 * @param obj The toggle object
5395 * @param onlabel The label displayed when the toggle is in the "on" state
5396 * @param offlabel The label displayed when the toggle is in the "off" state
5398 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5400 * @brief Gets the labels associated with the on and off states of the toggle.
5402 * @param obj The toggle object
5403 * @param onlabel A char** to place the onlabel of @p obj into
5404 * @param offlabel A char** to place the offlabel of @p obj into
5406 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5408 * @brief Sets the state of the toggle to @p state.
5410 * @param obj The toggle object
5411 * @param state The state of @p obj
5413 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5415 * @brief Gets the state of the toggle to @p state.
5417 * @param obj The toggle object
5418 * @return The state of @p obj
5420 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422 * @brief Sets the state pointer of the toggle to @p statep.
5424 * @param obj The toggle object
5425 * @param statep The state pointer of @p obj
5427 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5433 * @defgroup Frame Frame
5435 * @image html img/widget/frame/preview-00.png
5436 * @image latex img/widget/frame/preview-00.eps
5438 * @brief Frame is a widget that holds some content and has a title.
5440 * The default look is a frame with a title, but Frame supports multple
5448 * @li outdent_bottom
5450 * Of all this styles only default shows the title. Frame emits no signals.
5452 * For a detailed example see the @ref tutorial_frame.
5457 * @brief Add a new frame to the parent
5459 * @param parent The parent object
5460 * @return The new object or NULL if it cannot be created
5462 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5464 * @brief Set the frame label
5466 * @param obj The frame object
5467 * @param label The label of this frame object
5469 * @deprecated use elm_object_text_set() instead.
5471 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5473 * @brief Get the frame label
5475 * @param obj The frame object
5477 * @return The label of this frame objet or NULL if unable to get frame
5479 * @deprecated use elm_object_text_get() instead.
5481 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5483 * @brief Set the content of the frame widget
5485 * Once the content object is set, a previously set one will be deleted.
5486 * If you want to keep that old content object, use the
5487 * elm_frame_content_unset() function.
5489 * @param obj The frame object
5490 * @param content The content will be filled in this frame object
5492 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5494 * @brief Get the content of the frame widget
5496 * Return the content object which is set for this widget
5498 * @param obj The frame object
5499 * @return The content that is being used
5501 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503 * @brief Unset the content of the frame widget
5505 * Unparent and return the content object which was set for this widget
5507 * @param obj The frame object
5508 * @return The content that was being used
5510 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5516 * @defgroup Table Table
5518 * A container widget to arrange other widgets in a table where items can
5519 * also span multiple columns or rows - even overlap (and then be raised or
5520 * lowered accordingly to adjust stacking if they do overlap).
5522 * The followin are examples of how to use a table:
5523 * @li @ref tutorial_table_01
5524 * @li @ref tutorial_table_02
5529 * @brief Add a new table to the parent
5531 * @param parent The parent object
5532 * @return The new object or NULL if it cannot be created
5534 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5536 * @brief Set the homogeneous layout in the table
5538 * @param obj The layout object
5539 * @param homogeneous A boolean to set if the layout is homogeneous in the
5540 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5542 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5544 * @brief Get the current table homogeneous mode.
5546 * @param obj The table object
5547 * @return A boolean to indicating if the layout is homogeneous in the table
5548 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5550 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5552 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5554 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5556 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5558 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5560 * @brief Set padding between cells.
5562 * @param obj The layout object.
5563 * @param horizontal set the horizontal padding.
5564 * @param vertical set the vertical padding.
5566 * Default value is 0.
5568 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5570 * @brief Get padding between cells.
5572 * @param obj The layout object.
5573 * @param horizontal set the horizontal padding.
5574 * @param vertical set the vertical padding.
5576 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5578 * @brief Add a subobject on the table with the coordinates passed
5580 * @param obj The table object
5581 * @param subobj The subobject to be added to the table
5582 * @param x Row number
5583 * @param y Column number
5587 * @note All positioning inside the table is relative to rows and columns, so
5588 * a value of 0 for x and y, means the top left cell of the table, and a
5589 * value of 1 for w and h means @p subobj only takes that 1 cell.
5591 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5593 * @brief Remove child from table.
5595 * @param obj The table object
5596 * @param subobj The subobject
5598 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5600 * @brief Faster way to remove all child objects from a table object.
5602 * @param obj The table object
5603 * @param clear If true, will delete children, else just remove from table.
5605 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5607 * @brief Set the packing location of an existing child of the table
5609 * @param subobj The subobject to be modified in the table
5610 * @param x Row number
5611 * @param y Column number
5615 * Modifies the position of an object already in the table.
5617 * @note All positioning inside the table is relative to rows and columns, so
5618 * a value of 0 for x and y, means the top left cell of the table, and a
5619 * value of 1 for w and h means @p subobj only takes that 1 cell.
5621 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5623 * @brief Get the packing location of an existing child of the table
5625 * @param subobj The subobject to be modified in the table
5626 * @param x Row number
5627 * @param y Column number
5631 * @see elm_table_pack_set()
5633 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5639 * @defgroup Gengrid Gengrid (Generic grid)
5641 * This widget aims to position objects in a grid layout while
5642 * actually creating and rendering only the visible ones, using the
5643 * same idea as the @ref Genlist "genlist": the user defines a @b
5644 * class for each item, specifying functions that will be called at
5645 * object creation, deletion, etc. When those items are selected by
5646 * the user, a callback function is issued. Users may interact with
5647 * a gengrid via the mouse (by clicking on items to select them and
5648 * clicking on the grid's viewport and swiping to pan the whole
5649 * view) or via the keyboard, navigating through item with the
5652 * @section Gengrid_Layouts Gengrid layouts
5654 * Gengrids may layout its items in one of two possible layouts:
5658 * When in "horizontal mode", items will be placed in @b columns,
5659 * from top to bottom and, when the space for a column is filled,
5660 * another one is started on the right, thus expanding the grid
5661 * horizontally, making for horizontal scrolling. When in "vertical
5662 * mode" , though, items will be placed in @b rows, from left to
5663 * right and, when the space for a row is filled, another one is
5664 * started below, thus expanding the grid vertically (and making
5665 * for vertical scrolling).
5667 * @section Gengrid_Items Gengrid items
5669 * An item in a gengrid can have 0 or more text labels (they can be
5670 * regular text or textblock Evas objects - that's up to the style
5671 * to determine), 0 or more icons (which are simply objects
5672 * swallowed into the gengrid item's theming Edje object) and 0 or
5673 * more <b>boolean states</b>, which have the behavior left to the
5674 * user to define. The Edje part names for each of these properties
5675 * will be looked up, in the theme file for the gengrid, under the
5676 * Edje (string) data items named @c "labels", @c "icons" and @c
5677 * "states", respectively. For each of those properties, if more
5678 * than one part is provided, they must have names listed separated
5679 * by spaces in the data fields. For the default gengrid item
5680 * theme, we have @b one label part (@c "elm.text"), @b two icon
5681 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5684 * A gengrid item may be at one of several styles. Elementary
5685 * provides one by default - "default", but this can be extended by
5686 * system or application custom themes/overlays/extensions (see
5687 * @ref Theme "themes" for more details).
5689 * @section Gengrid_Item_Class Gengrid item classes
5691 * In order to have the ability to add and delete items on the fly,
5692 * gengrid implements a class (callback) system where the
5693 * application provides a structure with information about that
5694 * type of item (gengrid may contain multiple different items with
5695 * different classes, states and styles). Gengrid will call the
5696 * functions in this struct (methods) when an item is "realized"
5697 * (i.e., created dynamically, while the user is scrolling the
5698 * grid). All objects will simply be deleted when no longer needed
5699 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5700 * contains the following members:
5701 * - @c item_style - This is a constant string and simply defines
5702 * the name of the item style. It @b must be specified and the
5703 * default should be @c "default".
5704 * - @c func.label_get - This function is called when an item
5705 * object is actually created. The @c data parameter will point to
5706 * the same data passed to elm_gengrid_item_append() and related
5707 * item creation functions. The @c obj parameter is the gengrid
5708 * object itself, while the @c part one is the name string of one
5709 * of the existing text parts in the Edje group implementing the
5710 * item's theme. This function @b must return a strdup'()ed string,
5711 * as the caller will free() it when done. See
5712 * #GridItemLabelGetFunc.
5713 * - @c func.icon_get - This function is called when an item object
5714 * is actually created. The @c data parameter will point to the
5715 * same data passed to elm_gengrid_item_append() and related item
5716 * creation functions. The @c obj parameter is the gengrid object
5717 * itself, while the @c part one is the name string of one of the
5718 * existing (icon) swallow parts in the Edje group implementing the
5719 * item's theme. It must return @c NULL, when no icon is desired,
5720 * or a valid object handle, otherwise. The object will be deleted
5721 * by the gengrid on its deletion or when the item is "unrealized".
5722 * See #GridItemIconGetFunc.
5723 * - @c func.state_get - This function is called when an item
5724 * object is actually created. The @c data parameter will point to
5725 * the same data passed to elm_gengrid_item_append() and related
5726 * item creation functions. The @c obj parameter is the gengrid
5727 * object itself, while the @c part one is the name string of one
5728 * of the state parts in the Edje group implementing the item's
5729 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5730 * true/on. Gengrids will emit a signal to its theming Edje object
5731 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5732 * "source" arguments, respectively, when the state is true (the
5733 * default is false), where @c XXX is the name of the (state) part.
5734 * See #GridItemStateGetFunc.
5735 * - @c func.del - This is called when elm_gengrid_item_del() is
5736 * called on an item or elm_gengrid_clear() is called on the
5737 * gengrid. This is intended for use when gengrid items are
5738 * deleted, so any data attached to the item (e.g. its data
5739 * parameter on creation) can be deleted. See #GridItemDelFunc.
5741 * @section Gengrid_Usage_Hints Usage hints
5743 * If the user wants to have multiple items selected at the same
5744 * time, elm_gengrid_multi_select_set() will permit it. If the
5745 * gengrid is single-selection only (the default), then
5746 * elm_gengrid_select_item_get() will return the selected item or
5747 * @c NULL, if none is selected. If the gengrid is under
5748 * multi-selection, then elm_gengrid_selected_items_get() will
5749 * return a list (that is only valid as long as no items are
5750 * modified (added, deleted, selected or unselected) of child items
5753 * If an item changes (internal (boolean) state, label or icon
5754 * changes), then use elm_gengrid_item_update() to have gengrid
5755 * update the item with the new state. A gengrid will re-"realize"
5756 * the item, thus calling the functions in the
5757 * #Elm_Gengrid_Item_Class set for that item.
5759 * To programmatically (un)select an item, use
5760 * elm_gengrid_item_selected_set(). To get its selected state use
5761 * elm_gengrid_item_selected_get(). To make an item disabled
5762 * (unable to be selected and appear differently) use
5763 * elm_gengrid_item_disabled_set() to set this and
5764 * elm_gengrid_item_disabled_get() to get the disabled state.
5766 * Grid cells will only have their selection smart callbacks called
5767 * when firstly getting selected. Any further clicks will do
5768 * nothing, unless you enable the "always select mode", with
5769 * elm_gengrid_always_select_mode_set(), thus making every click to
5770 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5771 * turn off the ability to select items entirely in the widget and
5772 * they will neither appear selected nor call the selection smart
5775 * Remember that you can create new styles and add your own theme
5776 * augmentation per application with elm_theme_extension_add(). If
5777 * you absolutely must have a specific style that overrides any
5778 * theme the user or system sets up you can use
5779 * elm_theme_overlay_add() to add such a file.
5781 * @section Gengrid_Smart_Events Gengrid smart events
5783 * Smart events that you can add callbacks for are:
5784 * - @c "activated" - The user has double-clicked or pressed
5785 * (enter|return|spacebar) on an item. The @c event_info parameter
5786 * is the gengrid item that was activated.
5787 * - @c "clicked,double" - The user has double-clicked an item.
5788 * The @c event_info parameter is the gengrid item that was double-clicked.
5789 * - @c "selected" - The user has made an item selected. The
5790 * @c event_info parameter is the gengrid item that was selected.
5791 * - @c "unselected" - The user has made an item unselected. The
5792 * @c event_info parameter is the gengrid item that was unselected.
5793 * - @c "realized" - This is called when the item in the gengrid
5794 * has its implementing Evas object instantiated, de facto. @c
5795 * event_info is the gengrid item that was created. The object
5796 * may be deleted at any time, so it is highly advised to the
5797 * caller @b not to use the object pointer returned from
5798 * elm_gengrid_item_object_get(), because it may point to freed
5800 * - @c "unrealized" - This is called when the implementing Evas
5801 * object for this item is deleted. @c event_info is the gengrid
5802 * item that was deleted.
5803 * - @c "changed" - Called when an item is added, removed, resized
5804 * or moved and when the gengrid is resized or gets "horizontal"
5806 * - @c "drag,start,up" - Called when the item in the gengrid has
5807 * been dragged (not scrolled) up.
5808 * - @c "drag,start,down" - Called when the item in the gengrid has
5809 * been dragged (not scrolled) down.
5810 * - @c "drag,start,left" - Called when the item in the gengrid has
5811 * been dragged (not scrolled) left.
5812 * - @c "drag,start,right" - Called when the item in the gengrid has
5813 * been dragged (not scrolled) right.
5814 * - @c "drag,stop" - Called when the item in the gengrid has
5815 * stopped being dragged.
5816 * - @c "drag" - Called when the item in the gengrid is being
5818 * - @c "scroll" - called when the content has been scrolled
5820 * - @c "scroll,drag,start" - called when dragging the content has
5822 * - @c "scroll,drag,stop" - called when dragging the content has
5825 * List of gendrid examples:
5826 * @li @ref gengrid_example
5830 * @addtogroup Gengrid
5834 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5835 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5836 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5837 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5838 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5839 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5840 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5843 * @struct _Elm_Gengrid_Item_Class
5845 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5848 struct _Elm_Gengrid_Item_Class
5850 const char *item_style;
5851 struct _Elm_Gengrid_Item_Class_Func
5853 GridItemLabelGetFunc label_get;
5854 GridItemIconGetFunc icon_get;
5855 GridItemStateGetFunc state_get;
5856 GridItemDelFunc del;
5858 }; /**< #Elm_Gengrid_Item_Class member definitions */
5861 * Add a new gengrid widget to the given parent Elementary
5862 * (container) object
5864 * @param parent The parent object
5865 * @return a new gengrid widget handle or @c NULL, on errors
5867 * This function inserts a new gengrid widget on the canvas.
5869 * @see elm_gengrid_item_size_set()
5870 * @see elm_gengrid_horizontal_set()
5871 * @see elm_gengrid_item_append()
5872 * @see elm_gengrid_item_del()
5873 * @see elm_gengrid_clear()
5877 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5880 * Set the size for the items of a given gengrid widget
5882 * @param obj The gengrid object.
5883 * @param w The items' width.
5884 * @param h The items' height;
5886 * A gengrid, after creation, has still no information on the size
5887 * to give to each of its cells. So, you most probably will end up
5888 * with squares one @ref Fingers "finger" wide, the default
5889 * size. Use this function to force a custom size for you items,
5890 * making them as big as you wish.
5892 * @see elm_gengrid_item_size_get()
5896 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5899 * Get the size set for the items of a given gengrid widget
5901 * @param obj The gengrid object.
5902 * @param w Pointer to a variable where to store the items' width.
5903 * @param h Pointer to a variable where to store the items' height.
5905 * @note Use @c NULL pointers on the size values you're not
5906 * interested in: they'll be ignored by the function.
5908 * @see elm_gengrid_item_size_get() for more details
5912 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5915 * Set the items grid's alignment within a given gengrid widget
5917 * @param obj The gengrid object.
5918 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5919 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5921 * This sets the alignment of the whole grid of items of a gengrid
5922 * within its given viewport. By default, those values are both
5923 * 0.5, meaning that the gengrid will have its items grid placed
5924 * exactly in the middle of its viewport.
5926 * @note If given alignment values are out of the cited ranges,
5927 * they'll be changed to the nearest boundary values on the valid
5930 * @see elm_gengrid_align_get()
5934 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5937 * Get the items grid's alignment values within a given gengrid
5940 * @param obj The gengrid object.
5941 * @param align_x Pointer to a variable where to store the
5942 * horizontal alignment.
5943 * @param align_y Pointer to a variable where to store the vertical
5946 * @note Use @c NULL pointers on the alignment values you're not
5947 * interested in: they'll be ignored by the function.
5949 * @see elm_gengrid_align_set() for more details
5953 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5956 * Set whether a given gengrid widget is or not able have items
5959 * @param obj The gengrid object
5960 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5961 * @c EINA_FALSE to turn it off
5963 * If a gengrid is set to allow reordering, a click held for more
5964 * than 0.5 over a given item will highlight it specially,
5965 * signalling the gengrid has entered the reordering state. From
5966 * that time on, the user will be able to, while still holding the
5967 * mouse button down, move the item freely in the gengrid's
5968 * viewport, replacing to said item to the locations it goes to.
5969 * The replacements will be animated and, whenever the user
5970 * releases the mouse button, the item being replaced gets a new
5971 * definitive place in the grid.
5973 * @see elm_gengrid_reorder_mode_get()
5977 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5980 * Get whether a given gengrid widget is or not able have items
5983 * @param obj The gengrid object
5984 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
5987 * @see elm_gengrid_reorder_mode_set() for more details
5991 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5994 * Append a new item in a given gengrid widget.
5996 * @param obj The gengrid object.
5997 * @param gic The item class for the item.
5998 * @param data The item data.
5999 * @param func Convenience function called when the item is
6001 * @param func_data Data to be passed to @p func.
6002 * @return A handle to the item added or @c NULL, on errors.
6004 * This adds an item to the beginning of the gengrid.
6006 * @see elm_gengrid_item_prepend()
6007 * @see elm_gengrid_item_insert_before()
6008 * @see elm_gengrid_item_insert_after()
6009 * @see elm_gengrid_item_del()
6013 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);
6016 * Prepend a new item in a given gengrid widget.
6018 * @param obj The gengrid object.
6019 * @param gic The item class for the item.
6020 * @param data The item data.
6021 * @param func Convenience function called when the item is
6023 * @param func_data Data to be passed to @p func.
6024 * @return A handle to the item added or @c NULL, on errors.
6026 * This adds an item to the end of the gengrid.
6028 * @see elm_gengrid_item_append()
6029 * @see elm_gengrid_item_insert_before()
6030 * @see elm_gengrid_item_insert_after()
6031 * @see elm_gengrid_item_del()
6035 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);
6038 * Insert an item before another in a gengrid widget
6040 * @param obj The gengrid object.
6041 * @param gic The item class for the item.
6042 * @param data The item data.
6043 * @param relative The item to place this new one before.
6044 * @param func Convenience function called when the item is
6046 * @param func_data Data to be passed to @p func.
6047 * @return A handle to the item added or @c NULL, on errors.
6049 * This inserts an item before another in the gengrid.
6051 * @see elm_gengrid_item_append()
6052 * @see elm_gengrid_item_prepend()
6053 * @see elm_gengrid_item_insert_after()
6054 * @see elm_gengrid_item_del()
6058 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);
6061 * Insert an item after another in a gengrid widget
6063 * @param obj The gengrid object.
6064 * @param gic The item class for the item.
6065 * @param data The item data.
6066 * @param relative The item to place this new one after.
6067 * @param func Convenience function called when the item is
6069 * @param func_data Data to be passed to @p func.
6070 * @return A handle to the item added or @c NULL, on errors.
6072 * This inserts an item after another in the gengrid.
6074 * @see elm_gengrid_item_append()
6075 * @see elm_gengrid_item_prepend()
6076 * @see elm_gengrid_item_insert_after()
6077 * @see elm_gengrid_item_del()
6081 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);
6083 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);
6085 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);
6088 * Set whether items on a given gengrid widget are to get their
6089 * selection callbacks issued for @b every subsequent selection
6090 * click on them or just for the first click.
6092 * @param obj The gengrid object
6093 * @param always_select @c EINA_TRUE to make items "always
6094 * selected", @c EINA_FALSE, otherwise
6096 * By default, grid items will only call their selection callback
6097 * function when firstly getting selected, any subsequent further
6098 * clicks will do nothing. With this call, you make those
6099 * subsequent clicks also to issue the selection callbacks.
6101 * @note <b>Double clicks</b> will @b always be reported on items.
6103 * @see elm_gengrid_always_select_mode_get()
6107 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6110 * Get whether items on a given gengrid widget have their selection
6111 * callbacks issued for @b every subsequent selection click on them
6112 * or just for the first click.
6114 * @param obj The gengrid object.
6115 * @return @c EINA_TRUE if the gengrid items are "always selected",
6116 * @c EINA_FALSE, otherwise
6118 * @see elm_gengrid_always_select_mode_set() for more details
6122 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6125 * Set whether items on a given gengrid widget can be selected or not.
6127 * @param obj The gengrid object
6128 * @param no_select @c EINA_TRUE to make items selectable,
6129 * @c EINA_FALSE otherwise
6131 * This will make items in @obj selectable or not. In the latter
6132 * case, any user interacion on the gendrid items will neither make
6133 * them appear selected nor them call their selection callback
6136 * @see elm_gengrid_no_select_mode_get()
6140 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6143 * Get whether items on a given gengrid widget can be selected or
6146 * @param obj The gengrid object
6147 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6150 * @see elm_gengrid_no_select_mode_set() for more details
6154 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6157 * Enable or disable multi-selection in a given gengrid widget
6159 * @param obj The gengrid object.
6160 * @param multi @c EINA_TRUE, to enable multi-selection,
6161 * @c EINA_FALSE to disable it.
6163 * Multi-selection is the ability for one to have @b more than one
6164 * item selected, on a given gengrid, simultaneously. When it is
6165 * enabled, a sequence of clicks on different items will make them
6166 * all selected, progressively. A click on an already selected item
6167 * will unselect it. If interecting via the keyboard,
6168 * multi-selection is enabled while holding the "Shift" key.
6170 * @note By default, multi-selection is @b disabled on gengrids
6172 * @see elm_gengrid_multi_select_get()
6176 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6179 * Get whether multi-selection is enabled or disabled for a given
6182 * @param obj The gengrid object.
6183 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6184 * EINA_FALSE otherwise
6186 * @see elm_gengrid_multi_select_set() for more details
6190 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6193 * Enable or disable bouncing effect for a given gengrid widget
6195 * @param obj The gengrid object
6196 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6197 * @c EINA_FALSE to disable it
6198 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6199 * @c EINA_FALSE to disable it
6201 * The bouncing effect occurs whenever one reaches the gengrid's
6202 * edge's while panning it -- it will scroll past its limits a
6203 * little bit and return to the edge again, in a animated for,
6206 * @note By default, gengrids have bouncing enabled on both axis
6208 * @see elm_gengrid_bounce_get()
6212 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6215 * Get whether bouncing effects are enabled or disabled, for a
6216 * given gengrid widget, on each axis
6218 * @param obj The gengrid object
6219 * @param h_bounce Pointer to a variable where to store the
6220 * horizontal bouncing flag.
6221 * @param v_bounce Pointer to a variable where to store the
6222 * vertical bouncing flag.
6224 * @see elm_gengrid_bounce_set() for more details
6228 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6231 * Set a given gengrid widget's scrolling page size, relative to
6232 * its viewport size.
6234 * @param obj The gengrid object
6235 * @param h_pagerel The horizontal page (relative) size
6236 * @param v_pagerel The vertical page (relative) size
6238 * The gengrid's scroller is capable of binding scrolling by the
6239 * user to "pages". It means that, while scrolling and, specially
6240 * after releasing the mouse button, the grid will @b snap to the
6241 * nearest displaying page's area. When page sizes are set, the
6242 * grid's continuous content area is split into (equal) page sized
6245 * This function sets the size of a page <b>relatively to the
6246 * viewport dimensions</b> of the gengrid, for each axis. A value
6247 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6248 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6249 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6250 * 1.0. Values beyond those will make it behave behave
6251 * inconsistently. If you only want one axis to snap to pages, use
6252 * the value @c 0.0 for the other one.
6254 * There is a function setting page size values in @b absolute
6255 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6256 * is mutually exclusive to this one.
6258 * @see elm_gengrid_page_relative_get()
6262 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6265 * Get a given gengrid widget's scrolling page size, relative to
6266 * its viewport size.
6268 * @param obj The gengrid object
6269 * @param h_pagerel Pointer to a variable where to store the
6270 * horizontal page (relative) size
6271 * @param v_pagerel Pointer to a variable where to store the
6272 * vertical page (relative) size
6274 * @see elm_gengrid_page_relative_set() for more details
6278 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6281 * Set a given gengrid widget's scrolling page size
6283 * @param obj The gengrid object
6284 * @param h_pagerel The horizontal page size, in pixels
6285 * @param v_pagerel The vertical page size, in pixels
6287 * The gengrid's scroller is capable of binding scrolling by the
6288 * user to "pages". It means that, while scrolling and, specially
6289 * after releasing the mouse button, the grid will @b snap to the
6290 * nearest displaying page's area. When page sizes are set, the
6291 * grid's continuous content area is split into (equal) page sized
6294 * This function sets the size of a page of the gengrid, in pixels,
6295 * for each axis. Sane usable values are, between @c 0 and the
6296 * dimensions of @p obj, for each axis. Values beyond those will
6297 * make it behave behave inconsistently. If you only want one axis
6298 * to snap to pages, use the value @c 0 for the other one.
6300 * There is a function setting page size values in @b relative
6301 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6302 * use is mutually exclusive to this one.
6306 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6309 * Set for what direction a given gengrid widget will expand while
6310 * placing its items.
6312 * @param obj The gengrid object.
6313 * @param setting @c EINA_TRUE to make the gengrid expand
6314 * horizontally, @c EINA_FALSE to expand vertically.
6316 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6317 * in @b columns, from top to bottom and, when the space for a
6318 * column is filled, another one is started on the right, thus
6319 * expanding the grid horizontally. When in "vertical mode"
6320 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6321 * to right and, when the space for a row is filled, another one is
6322 * started below, thus expanding the grid vertically.
6324 * @see elm_gengrid_horizontal_get()
6328 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6331 * Get for what direction a given gengrid widget will expand while
6332 * placing its items.
6334 * @param obj The gengrid object.
6335 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6336 * @c EINA_FALSE if it's set to expand vertically.
6338 * @see elm_gengrid_horizontal_set() for more detais
6342 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6345 * Get the first item in a given gengrid widget
6347 * @param obj The gengrid object
6348 * @return The first item's handle or @c NULL, if there are no
6349 * items in @p obj (and on errors)
6351 * This returns the first item in the @p obj's internal list of
6354 * @see elm_gengrid_last_item_get()
6358 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6361 * Get the last item in a given gengrid widget
6363 * @param obj The gengrid object
6364 * @return The last item's handle or @c NULL, if there are no
6365 * items in @p obj (and on errors)
6367 * This returns the last item in the @p obj's internal list of
6370 * @see elm_gengrid_first_item_get()
6374 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6377 * Get the @b next item in a gengrid widget's internal list of items,
6378 * given a handle to one of those items.
6380 * @param item The gengrid item to fetch next from
6381 * @return The item after @p item, or @c NULL if there's none (and
6384 * This returns the item placed after the @p item, on the container
6387 * @see elm_gengrid_item_prev_get()
6391 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6394 * Get the @b previous item in a gengrid widget's internal list of items,
6395 * given a handle to one of those items.
6397 * @param item The gengrid item to fetch previous from
6398 * @return The item before @p item, or @c NULL if there's none (and
6401 * This returns the item placed before the @p item, on the container
6404 * @see elm_gengrid_item_next_get()
6408 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6411 * Get the gengrid object's handle which contains a given gengrid
6414 * @param item The item to fetch the container from
6415 * @return The gengrid (parent) object
6417 * This returns the gengrid object itself that an item belongs to.
6421 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6424 * Remove a gengrid item from the its parent, deleting it.
6426 * @param item The item to be removed.
6427 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6429 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6434 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6437 * Update the contents of a given gengrid item
6439 * @param item The gengrid item
6441 * This updates an item by calling all the item class functions
6442 * again to get the icons, labels and states. Use this when the
6443 * original item data has changed and you want thta changes to be
6448 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6449 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6450 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6453 * Return the data associated to a given gengrid item
6455 * @param item The gengrid item.
6456 * @return the data associated to this item.
6458 * This returns the @c data value passed on the
6459 * elm_gengrid_item_append() and related item addition calls.
6461 * @see elm_gengrid_item_append()
6462 * @see elm_gengrid_item_data_set()
6466 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6469 * Set the data associated to a given gengrid item
6471 * @param item The gengrid item
6472 * @param data The new data pointer to set on it
6474 * This @b overrides the @c data value passed on the
6475 * elm_gengrid_item_append() and related item addition calls. This
6476 * function @b won't call elm_gengrid_item_update() automatically,
6477 * so you'd issue it afterwards if you want to hove the item
6478 * updated to reflect the that new data.
6480 * @see elm_gengrid_item_data_get()
6484 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6487 * Get a given gengrid item's position, relative to the whole
6488 * gengrid's grid area.
6490 * @param item The Gengrid item.
6491 * @param x Pointer to variable where to store the item's <b>row
6493 * @param y Pointer to variable where to store the item's <b>column
6496 * This returns the "logical" position of the item whithin the
6497 * gengrid. For example, @c (0, 1) would stand for first row,
6502 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6505 * Set whether a given gengrid item is selected or not
6507 * @param item The gengrid item
6508 * @param selected Use @c EINA_TRUE, to make it selected, @c
6509 * EINA_FALSE to make it unselected
6511 * This sets the selected state of an item. If multi selection is
6512 * not enabled on the containing gengrid and @p selected is @c
6513 * EINA_TRUE, any other previously selected items will get
6514 * unselected in favor of this new one.
6516 * @see elm_gengrid_item_selected_get()
6520 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6523 * Get whether a given gengrid item is selected or not
6525 * @param item The gengrid item
6526 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6528 * @see elm_gengrid_item_selected_set() for more details
6532 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6535 * Get the real Evas object created to implement the view of a
6536 * given gengrid item
6538 * @param item The gengrid item.
6539 * @return the Evas object implementing this item's view.
6541 * This returns the actual Evas object used to implement the
6542 * specified gengrid item's view. This may be @c NULL, as it may
6543 * not have been created or may have been deleted, at any time, by
6544 * the gengrid. <b>Do not modify this object</b> (move, resize,
6545 * show, hide, etc.), as the gengrid is controlling it. This
6546 * function is for querying, emitting custom signals or hooking
6547 * lower level callbacks for events on that object. Do not delete
6548 * this object under any circumstances.
6550 * @see elm_gengrid_item_data_get()
6554 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6557 * Show the portion of a gengrid's internal grid containing a given
6558 * item, @b immediately.
6560 * @param item The item to display
6562 * This causes gengrid to @b redraw its viewport's contents to the
6563 * region contining the given @p item item, if it is not fully
6566 * @see elm_gengrid_item_bring_in()
6570 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6573 * Animatedly bring in, to the visible are of a gengrid, a given
6576 * @param item The gengrid item to display
6578 * This causes gengrig to jump to the given @p item item and show
6579 * it (by scrolling), if it is not fully visible. This will use
6580 * animation to do so and take a period of time to complete.
6582 * @see elm_gengrid_item_show()
6586 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6589 * Set whether a given gengrid item is disabled or not.
6591 * @param item The gengrid item
6592 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6593 * to enable it back.
6595 * A disabled item cannot be selected or unselected. It will also
6596 * change its appearance, to signal the user it's disabled.
6598 * @see elm_gengrid_item_disabled_get()
6602 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6605 * Get whether a given gengrid item is disabled or not.
6607 * @param item The gengrid item
6608 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6611 * @see elm_gengrid_item_disabled_set() for more details
6615 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6618 * Set the text to be shown in a given gengrid item's tooltips.
6620 * @param item The gengrid item
6621 * @param text The text to set in the content
6623 * This call will setup the text to be used as tooltip to that item
6624 * (analogous to elm_object_tooltip_text_set(), but being item
6625 * tooltips with higher precedence than object tooltips). It can
6626 * have only one tooltip at a time, so any previous tooltip data
6631 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6634 * Set the content to be shown in a given gengrid item's tooltips
6636 * @param item The gengrid item.
6637 * @param func The function returning the tooltip contents.
6638 * @param data What to provide to @a func as callback data/context.
6639 * @param del_cb Called when data is not needed anymore, either when
6640 * another callback replaces @func, the tooltip is unset with
6641 * elm_gengrid_item_tooltip_unset() or the owner @p item
6642 * dies. This callback receives as its first parameter the
6643 * given @p data, being @c event_info the item handle.
6645 * This call will setup the tooltip's contents to @p item
6646 * (analogous to elm_object_tooltip_content_cb_set(), but being
6647 * item tooltips with higher precedence than object tooltips). It
6648 * can have only one tooltip at a time, so any previous tooltip
6649 * content will get removed. @p func (with @p data) will be called
6650 * every time Elementary needs to show the tooltip and it should
6651 * return a valid Evas object, which will be fully managed by the
6652 * tooltip system, getting deleted when the tooltip is gone.
6656 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);
6659 * Unset a tooltip from a given gengrid item
6661 * @param item gengrid item to remove a previously set tooltip from.
6663 * This call removes any tooltip set on @p item. The callback
6664 * provided as @c del_cb to
6665 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6666 * notify it is not used anymore (and have resources cleaned, if
6669 * @see elm_gengrid_item_tooltip_content_cb_set()
6673 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6676 * Set a different @b style for a given gengrid item's tooltip.
6678 * @param item gengrid item with tooltip set
6679 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6680 * "default", @c "transparent", etc)
6682 * Tooltips can have <b>alternate styles</b> to be displayed on,
6683 * which are defined by the theme set on Elementary. This function
6684 * works analogously as elm_object_tooltip_style_set(), but here
6685 * applied only to gengrid item objects. The default style for
6686 * tooltips is @c "default".
6688 * @note before you set a style you should define a tooltip with
6689 * elm_gengrid_item_tooltip_content_cb_set() or
6690 * elm_gengrid_item_tooltip_text_set()
6692 * @see elm_gengrid_item_tooltip_style_get()
6696 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6699 * Get the style set a given gengrid item's tooltip.
6701 * @param item gengrid item with tooltip already set on.
6702 * @return style the theme style in use, which defaults to
6703 * "default". If the object does not have a tooltip set,
6704 * then @c NULL is returned.
6706 * @see elm_gengrid_item_tooltip_style_set() for more details
6710 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6712 * @brief Disable size restrictions on an object's tooltip
6713 * @param item The tooltip's anchor object
6714 * @param disable If EINA_TRUE, size restrictions are disabled
6715 * @return EINA_FALSE on failure, EINA_TRUE on success
6717 * This function allows a tooltip to expand beyond its parant window's canvas.
6718 * It will instead be limited only by the size of the display.
6720 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6722 * @brief Retrieve size restriction state of an object's tooltip
6723 * @param item The tooltip's anchor object
6724 * @return If EINA_TRUE, size restrictions are disabled
6726 * This function returns whether a tooltip is allowed to expand beyond
6727 * its parant window's canvas.
6728 * It will instead be limited only by the size of the display.
6730 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6732 * Set the type of mouse pointer/cursor decoration to be shown,
6733 * when the mouse pointer is over the given gengrid widget item
6735 * @param item gengrid item to customize cursor on
6736 * @param cursor the cursor type's name
6738 * This function works analogously as elm_object_cursor_set(), but
6739 * here the cursor's changing area is restricted to the item's
6740 * area, and not the whole widget's. Note that that item cursors
6741 * have precedence over widget cursors, so that a mouse over @p
6742 * item will always show cursor @p type.
6744 * If this function is called twice for an object, a previously set
6745 * cursor will be unset on the second call.
6747 * @see elm_object_cursor_set()
6748 * @see elm_gengrid_item_cursor_get()
6749 * @see elm_gengrid_item_cursor_unset()
6753 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6756 * Get the type of mouse pointer/cursor decoration set to be shown,
6757 * when the mouse pointer is over the given gengrid widget item
6759 * @param item gengrid item with custom cursor set
6760 * @return the cursor type's name or @c NULL, if no custom cursors
6761 * were set to @p item (and on errors)
6763 * @see elm_object_cursor_get()
6764 * @see elm_gengrid_item_cursor_set() for more details
6765 * @see elm_gengrid_item_cursor_unset()
6769 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6772 * Unset any custom mouse pointer/cursor decoration set to be
6773 * shown, when the mouse pointer is over the given gengrid widget
6774 * item, thus making it show the @b default cursor again.
6776 * @param item a gengrid item
6778 * Use this call to undo any custom settings on this item's cursor
6779 * decoration, bringing it back to defaults (no custom style set).
6781 * @see elm_object_cursor_unset()
6782 * @see elm_gengrid_item_cursor_set() for more details
6786 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6789 * Set a different @b style for a given custom cursor set for a
6792 * @param item gengrid item with custom cursor set
6793 * @param style the <b>theme style</b> to use (e.g. @c "default",
6794 * @c "transparent", etc)
6796 * This function only makes sense when one is using custom mouse
6797 * cursor decorations <b>defined in a theme file</b> , which can
6798 * have, given a cursor name/type, <b>alternate styles</b> on
6799 * it. It works analogously as elm_object_cursor_style_set(), but
6800 * here applied only to gengrid item objects.
6802 * @warning Before you set a cursor style you should have defined a
6803 * custom cursor previously on the item, with
6804 * elm_gengrid_item_cursor_set()
6806 * @see elm_gengrid_item_cursor_engine_only_set()
6807 * @see elm_gengrid_item_cursor_style_get()
6811 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6814 * Get the current @b style set for a given gengrid item's custom
6817 * @param item gengrid item with custom cursor set.
6818 * @return style the cursor style in use. If the object does not
6819 * have a cursor set, then @c NULL is returned.
6821 * @see elm_gengrid_item_cursor_style_set() for more details
6825 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6828 * Set if the (custom) cursor for a given gengrid item should be
6829 * searched in its theme, also, or should only rely on the
6832 * @param item item with custom (custom) cursor already set on
6833 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6834 * only on those provided by the rendering engine, @c EINA_FALSE to
6835 * have them searched on the widget's theme, as well.
6837 * @note This call is of use only if you've set a custom cursor
6838 * for gengrid items, with elm_gengrid_item_cursor_set().
6840 * @note By default, cursors will only be looked for between those
6841 * provided by the rendering engine.
6845 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6848 * Get if the (custom) cursor for a given gengrid item is being
6849 * searched in its theme, also, or is only relying on the rendering
6852 * @param item a gengrid item
6853 * @return @c EINA_TRUE, if cursors are being looked for only on
6854 * those provided by the rendering engine, @c EINA_FALSE if they
6855 * are being searched on the widget's theme, as well.
6857 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6861 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6864 * Remove all items from a given gengrid widget
6866 * @param obj The gengrid object.
6868 * This removes (and deletes) all items in @p obj, leaving it
6871 * @see elm_gengrid_item_del(), to remove just one item.
6875 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6878 * Get the selected item in a given gengrid widget
6880 * @param obj The gengrid object.
6881 * @return The selected item's handleor @c NULL, if none is
6882 * selected at the moment (and on errors)
6884 * This returns the selected item in @p obj. If multi selection is
6885 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6886 * the first item in the list is selected, which might not be very
6887 * useful. For that case, see elm_gengrid_selected_items_get().
6891 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6894 * Get <b>a list</b> of selected items in a given gengrid
6896 * @param obj The gengrid object.
6897 * @return The list of selected items or @c NULL, if none is
6898 * selected at the moment (and on errors)
6900 * This returns a list of the selected items, in the order that
6901 * they appear in the grid. This list is only valid as long as no
6902 * more items are selected or unselected (or unselected implictly
6903 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6906 * @see elm_gengrid_selected_item_get()
6910 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6917 * @defgroup Clock Clock
6919 * @image html img/widget/clock/preview-00.png
6920 * @image latex img/widget/clock/preview-00.eps
6922 * This is a @b digital clock widget. In its default theme, it has a
6923 * vintage "flipping numbers clock" appearance, which will animate
6924 * sheets of individual algarisms individually as time goes by.
6926 * A newly created clock will fetch system's time (already
6927 * considering local time adjustments) to start with, and will tick
6928 * accondingly. It may or may not show seconds.
6930 * Clocks have an @b edition mode. When in it, the sheets will
6931 * display extra arrow indications on the top and bottom and the
6932 * user may click on them to raise or lower the time values. After
6933 * it's told to exit edition mode, it will keep ticking with that
6934 * new time set (it keeps the difference from local time).
6936 * Also, when under edition mode, user clicks on the cited arrows
6937 * which are @b held for some time will make the clock to flip the
6938 * sheet, thus editing the time, continuosly and automatically for
6939 * the user. The interval between sheet flips will keep growing in
6940 * time, so that it helps the user to reach a time which is distant
6943 * The time display is, by default, in military mode (24h), but an
6944 * am/pm indicator may be optionally shown, too, when it will
6947 * Smart callbacks one can register to:
6948 * - "changed" - the clock's user changed the time
6950 * Here is an example on its usage:
6951 * @li @ref clock_example
6960 * Identifiers for which clock digits should be editable, when a
6961 * clock widget is in edition mode. Values may be ORed together to
6962 * make a mask, naturally.
6964 * @see elm_clock_edit_set()
6965 * @see elm_clock_digit_edit_set()
6967 typedef enum _Elm_Clock_Digedit
6969 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6970 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6971 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6972 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6973 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6974 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6975 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
6976 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
6977 } Elm_Clock_Digedit;
6980 * Add a new clock widget to the given parent Elementary
6981 * (container) object
6983 * @param parent The parent object
6984 * @return a new clock widget handle or @c NULL, on errors
6986 * This function inserts a new clock widget on the canvas.
6990 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6993 * Set a clock widget's time, programmatically
6995 * @param obj The clock widget object
6996 * @param hrs The hours to set
6997 * @param min The minutes to set
6998 * @param sec The secondes to set
7000 * This function updates the time that is showed by the clock
7003 * Values @b must be set within the following ranges:
7004 * - 0 - 23, for hours
7005 * - 0 - 59, for minutes
7006 * - 0 - 59, for seconds,
7008 * even if the clock is not in "military" mode.
7010 * @warning The behavior for values set out of those ranges is @b
7015 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7018 * Get a clock widget's time values
7020 * @param obj The clock object
7021 * @param[out] hrs Pointer to the variable to get the hours value
7022 * @param[out] min Pointer to the variable to get the minutes value
7023 * @param[out] sec Pointer to the variable to get the seconds value
7025 * This function gets the time set for @p obj, returning
7026 * it on the variables passed as the arguments to function
7028 * @note Use @c NULL pointers on the time values you're not
7029 * interested in: they'll be ignored by the function.
7033 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7036 * Set whether a given clock widget is under <b>edition mode</b> or
7037 * under (default) displaying-only mode.
7039 * @param obj The clock object
7040 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7041 * put it back to "displaying only" mode
7043 * This function makes a clock's time to be editable or not <b>by
7044 * user interaction</b>. When in edition mode, clocks @b stop
7045 * ticking, until one brings them back to canonical mode. The
7046 * elm_clock_digit_edit_set() function will influence which digits
7047 * of the clock will be editable. By default, all of them will be
7048 * (#ELM_CLOCK_NONE).
7050 * @note am/pm sheets, if being shown, will @b always be editable
7051 * under edition mode.
7053 * @see elm_clock_edit_get()
7057 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7060 * Retrieve whether a given clock widget is under <b>edition
7061 * mode</b> or under (default) displaying-only mode.
7063 * @param obj The clock object
7064 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7067 * This function retrieves whether the clock's time can be edited
7068 * or not by user interaction.
7070 * @see elm_clock_edit_set() for more details
7074 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077 * Set what digits of the given clock widget should be editable
7078 * when in edition mode.
7080 * @param obj The clock object
7081 * @param digedit Bit mask indicating the digits to be editable
7082 * (values in #Elm_Clock_Digedit).
7084 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7085 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7088 * @see elm_clock_digit_edit_get()
7092 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7095 * Retrieve what digits of the given clock widget should be
7096 * editable when in edition mode.
7098 * @param obj The clock object
7099 * @return Bit mask indicating the digits to be editable
7100 * (values in #Elm_Clock_Digedit).
7102 * @see elm_clock_digit_edit_set() for more details
7106 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7109 * Set if the given clock widget must show hours in military or
7112 * @param obj The clock object
7113 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7116 * This function sets if the clock must show hours in military or
7117 * am/pm mode. In some countries like Brazil the military mode
7118 * (00-24h-format) is used, in opposition to the USA, where the
7119 * am/pm mode is more commonly used.
7121 * @see elm_clock_show_am_pm_get()
7125 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7128 * Get if the given clock widget shows hours in military or am/pm
7131 * @param obj The clock object
7132 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7135 * This function gets if the clock shows hours in military or am/pm
7138 * @see elm_clock_show_am_pm_set() for more details
7142 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7145 * Set if the given clock widget must show time with seconds or not
7147 * @param obj The clock object
7148 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7150 * This function sets if the given clock must show or not elapsed
7151 * seconds. By default, they are @b not shown.
7153 * @see elm_clock_show_seconds_get()
7157 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7160 * Get whether the given clock widget is showing time with seconds
7163 * @param obj The clock object
7164 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7166 * This function gets whether @p obj is showing or not the elapsed
7169 * @see elm_clock_show_seconds_set()
7173 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7176 * Set the interval on time updates for an user mouse button hold
7177 * on clock widgets' time edition.
7179 * @param obj The clock object
7180 * @param interval The (first) interval value in seconds
7182 * This interval value is @b decreased while the user holds the
7183 * mouse pointer either incrementing or decrementing a given the
7184 * clock digit's value.
7186 * This helps the user to get to a given time distant from the
7187 * current one easier/faster, as it will start to flip quicker and
7188 * quicker on mouse button holds.
7190 * The calculation for the next flip interval value, starting from
7191 * the one set with this call, is the previous interval divided by
7192 * 1.05, so it decreases a little bit.
7194 * The default starting interval value for automatic flips is
7197 * @see elm_clock_interval_get()
7201 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7204 * Get the interval on time updates for an user mouse button hold
7205 * on clock widgets' time edition.
7207 * @param obj The clock object
7208 * @return The (first) interval value, in seconds, set on it
7210 * @see elm_clock_interval_set() for more details
7214 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7221 * @defgroup Layout Layout
7223 * @image html img/widget/layout/preview-00.png
7224 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7226 * @image html img/layout-predefined.png
7227 * @image latex img/layout-predefined.eps width=\textwidth
7229 * This is a container widget that takes a standard Edje design file and
7230 * wraps it very thinly in a widget.
7232 * An Edje design (theme) file has a very wide range of possibilities to
7233 * describe the behavior of elements added to the Layout. Check out the Edje
7234 * documentation and the EDC reference to get more information about what can
7235 * be done with Edje.
7237 * Just like @ref List, @ref Box, and other container widgets, any
7238 * object added to the Layout will become its child, meaning that it will be
7239 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7241 * The Layout widget can contain as many Contents, Boxes or Tables as
7242 * described in its theme file. For instance, objects can be added to
7243 * different Tables by specifying the respective Table part names. The same
7244 * is valid for Content and Box.
7246 * The objects added as child of the Layout will behave as described in the
7247 * part description where they were added. There are 3 possible types of
7248 * parts where a child can be added:
7250 * @section secContent Content (SWALLOW part)
7252 * Only one object can be added to the @c SWALLOW part (but you still can
7253 * have many @c SWALLOW parts and one object on each of them). Use the @c
7254 * elm_layout_content_* set of functions to set, retrieve and unset objects
7255 * as content of the @c SWALLOW. After being set to this part, the object
7256 * size, position, visibility, clipping and other description properties
7257 * will be totally controled by the description of the given part (inside
7258 * the Edje theme file).
7260 * One can use @c evas_object_size_hint_* functions on the child to have some
7261 * kind of control over its behavior, but the resulting behavior will still
7262 * depend heavily on the @c SWALLOW part description.
7264 * The Edje theme also can change the part description, based on signals or
7265 * scripts running inside the theme. This change can also be animated. All of
7266 * this will affect the child object set as content accordingly. The object
7267 * size will be changed if the part size is changed, it will animate move if
7268 * the part is moving, and so on.
7270 * The following picture demonstrates a Layout widget with a child object
7271 * added to its @c SWALLOW:
7273 * @image html layout_swallow.png
7274 * @image latex layout_swallow.eps width=\textwidth
7276 * @section secBox Box (BOX part)
7278 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7279 * allows one to add objects to the box and have them distributed along its
7280 * area, accordingly to the specified @a layout property (now by @a layout we
7281 * mean the chosen layouting design of the Box, not the Layout widget
7284 * A similar effect for having a box with its position, size and other things
7285 * controled by the Layout theme would be to create an Elementary @ref Box
7286 * widget and add it as a Content in the @c SWALLOW part.
7288 * The main difference of using the Layout Box is that its behavior, the box
7289 * properties like layouting format, padding, align, etc. will be all
7290 * controled by the theme. This means, for example, that a signal could be
7291 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7292 * handled the signal by changing the box padding, or align, or both. Using
7293 * the Elementary @ref Box widget is not necessarily harder or easier, it
7294 * just depends on the circunstances and requirements.
7296 * The Layout Box can be used through the @c elm_layout_box_* set of
7299 * The following picture demonstrates a Layout widget with many child objects
7300 * added to its @c BOX part:
7302 * @image html layout_box.png
7303 * @image latex layout_box.eps width=\textwidth
7305 * @section secTable Table (TABLE part)
7307 * Just like the @ref secBox, the Layout Table is very similar to the
7308 * Elementary @ref Table widget. It allows one to add objects to the Table
7309 * specifying the row and column where the object should be added, and any
7310 * column or row span if necessary.
7312 * Again, we could have this design by adding a @ref Table widget to the @c
7313 * SWALLOW part using elm_layout_content_set(). The same difference happens
7314 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7315 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7317 * The Layout Table can be used through the @c elm_layout_table_* set of
7320 * The following picture demonstrates a Layout widget with many child objects
7321 * added to its @c TABLE part:
7323 * @image html layout_table.png
7324 * @image latex layout_table.eps width=\textwidth
7326 * @section secPredef Predefined Layouts
7328 * Another interesting thing about the Layout widget is that it offers some
7329 * predefined themes that come with the default Elementary theme. These
7330 * themes can be set by the call elm_layout_theme_set(), and provide some
7331 * basic functionality depending on the theme used.
7333 * Most of them already send some signals, some already provide a toolbar or
7334 * back and next buttons.
7336 * These are available predefined theme layouts. All of them have class = @c
7337 * layout, group = @c application, and style = one of the following options:
7339 * @li @c toolbar-content - application with toolbar and main content area
7340 * @li @c toolbar-content-back - application with toolbar and main content
7341 * area with a back button and title area
7342 * @li @c toolbar-content-back-next - application with toolbar and main
7343 * content area with a back and next buttons and title area
7344 * @li @c content-back - application with a main content area with a back
7345 * button and title area
7346 * @li @c content-back-next - application with a main content area with a
7347 * back and next buttons and title area
7348 * @li @c toolbar-vbox - application with toolbar and main content area as a
7350 * @li @c toolbar-table - application with toolbar and main content area as a
7353 * @section secExamples Examples
7355 * Some examples of the Layout widget can be found here:
7356 * @li @ref layout_example_01
7357 * @li @ref layout_example_02
7358 * @li @ref layout_example_03
7359 * @li @ref layout_example_edc
7364 * Add a new layout to the parent
7366 * @param parent The parent object
7367 * @return The new object or NULL if it cannot be created
7369 * @see elm_layout_file_set()
7370 * @see elm_layout_theme_set()
7374 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7376 * Set the file that will be used as layout
7378 * @param obj The layout object
7379 * @param file The path to file (edj) that will be used as layout
7380 * @param group The group that the layout belongs in edje file
7382 * @return (1 = success, 0 = error)
7386 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7388 * Set the edje group from the elementary theme that will be used as layout
7390 * @param obj The layout object
7391 * @param clas the clas of the group
7392 * @param group the group
7393 * @param style the style to used
7395 * @return (1 = success, 0 = error)
7399 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7401 * Set the layout content.
7403 * @param obj The layout object
7404 * @param swallow The swallow part name in the edje file
7405 * @param content The child that will be added in this layout object
7407 * Once the content object is set, a previously set one will be deleted.
7408 * If you want to keep that old content object, use the
7409 * elm_layout_content_unset() function.
7411 * @note In an Edje theme, the part used as a content container is called @c
7412 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7413 * expected to be a part name just like the second parameter of
7414 * elm_layout_box_append().
7416 * @see elm_layout_box_append()
7417 * @see elm_layout_content_get()
7418 * @see elm_layout_content_unset()
7423 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7425 * Get the child object in the given content part.
7427 * @param obj The layout object
7428 * @param swallow The SWALLOW part to get its content
7430 * @return The swallowed object or NULL if none or an error occurred
7432 * @see elm_layout_content_set()
7436 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7438 * Unset the layout content.
7440 * @param obj The layout object
7441 * @param swallow The swallow part name in the edje file
7442 * @return The content that was being used
7444 * Unparent and return the content object which was set for this part.
7446 * @see elm_layout_content_set()
7450 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7452 * Set the text of the given part
7454 * @param obj The layout object
7455 * @param part The TEXT part where to set the text
7456 * @param text The text to set
7459 * @deprecated use elm_object_text_* instead.
7461 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7463 * Get the text set in the given part
7465 * @param obj The layout object
7466 * @param part The TEXT part to retrieve the text off
7468 * @return The text set in @p part
7471 * @deprecated use elm_object_text_* instead.
7473 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7475 * Append child to layout box part.
7477 * @param obj the layout object
7478 * @param part the box part to which the object will be appended.
7479 * @param child the child object to append to box.
7481 * Once the object is appended, it will become child of the layout. Its
7482 * lifetime will be bound to the layout, whenever the layout dies the child
7483 * will be deleted automatically. One should use elm_layout_box_remove() to
7484 * make this layout forget about the object.
7486 * @see elm_layout_box_prepend()
7487 * @see elm_layout_box_insert_before()
7488 * @see elm_layout_box_insert_at()
7489 * @see elm_layout_box_remove()
7493 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7495 * Prepend child to layout box part.
7497 * @param obj the layout object
7498 * @param part the box part to prepend.
7499 * @param child the child object to prepend to box.
7501 * Once the object is prepended, it will become child of the layout. Its
7502 * lifetime will be bound to the layout, whenever the layout dies the child
7503 * will be deleted automatically. One should use elm_layout_box_remove() to
7504 * make this layout forget about the object.
7506 * @see elm_layout_box_append()
7507 * @see elm_layout_box_insert_before()
7508 * @see elm_layout_box_insert_at()
7509 * @see elm_layout_box_remove()
7513 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7515 * Insert child to layout box part before a reference object.
7517 * @param obj the layout object
7518 * @param part the box part to insert.
7519 * @param child the child object to insert into box.
7520 * @param reference another reference object to insert before in box.
7522 * Once the object is inserted, it will become child of the layout. Its
7523 * lifetime will be bound to the layout, whenever the layout dies the child
7524 * will be deleted automatically. One should use elm_layout_box_remove() to
7525 * make this layout forget about the object.
7527 * @see elm_layout_box_append()
7528 * @see elm_layout_box_prepend()
7529 * @see elm_layout_box_insert_before()
7530 * @see elm_layout_box_remove()
7534 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7536 * Insert child to layout box part at a given position.
7538 * @param obj the layout object
7539 * @param part the box part to insert.
7540 * @param child the child object to insert into box.
7541 * @param pos the numeric position >=0 to insert the child.
7543 * Once the object is inserted, it will become child of the layout. Its
7544 * lifetime will be bound to the layout, whenever the layout dies the child
7545 * will be deleted automatically. One should use elm_layout_box_remove() to
7546 * make this layout forget about the object.
7548 * @see elm_layout_box_append()
7549 * @see elm_layout_box_prepend()
7550 * @see elm_layout_box_insert_before()
7551 * @see elm_layout_box_remove()
7555 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7557 * Remove a child of the given part box.
7559 * @param obj The layout object
7560 * @param part The box part name to remove child.
7561 * @param child The object to remove from box.
7562 * @return The object that was being used, or NULL if not found.
7564 * The object will be removed from the box part and its lifetime will
7565 * not be handled by the layout anymore. This is equivalent to
7566 * elm_layout_content_unset() for box.
7568 * @see elm_layout_box_append()
7569 * @see elm_layout_box_remove_all()
7573 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7575 * Remove all child of the given part box.
7577 * @param obj The layout object
7578 * @param part The box part name to remove child.
7579 * @param clear If EINA_TRUE, then all objects will be deleted as
7580 * well, otherwise they will just be removed and will be
7581 * dangling on the canvas.
7583 * The objects will be removed from the box part and their lifetime will
7584 * not be handled by the layout anymore. This is equivalent to
7585 * elm_layout_box_remove() for all box children.
7587 * @see elm_layout_box_append()
7588 * @see elm_layout_box_remove()
7592 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7594 * Insert child to layout table part.
7596 * @param obj the layout object
7597 * @param part the box part to pack child.
7598 * @param child_obj the child object to pack into table.
7599 * @param col the column to which the child should be added. (>= 0)
7600 * @param row the row to which the child should be added. (>= 0)
7601 * @param colspan how many columns should be used to store this object. (>=
7603 * @param rowspan how many rows should be used to store this object. (>= 1)
7605 * Once the object is inserted, it will become child of the table. Its
7606 * lifetime will be bound to the layout, and whenever the layout dies the
7607 * child will be deleted automatically. One should use
7608 * elm_layout_table_remove() to make this layout forget about the object.
7610 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7611 * more space than a single cell. For instance, the following code:
7613 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7616 * Would result in an object being added like the following picture:
7618 * @image html layout_colspan.png
7619 * @image latex layout_colspan.eps width=\textwidth
7621 * @see elm_layout_table_unpack()
7622 * @see elm_layout_table_clear()
7626 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);
7628 * Unpack (remove) a child of the given part table.
7630 * @param obj The layout object
7631 * @param part The table part name to remove child.
7632 * @param child_obj The object to remove from table.
7633 * @return The object that was being used, or NULL if not found.
7635 * The object will be unpacked from the table part and its lifetime
7636 * will not be handled by the layout anymore. This is equivalent to
7637 * elm_layout_content_unset() for table.
7639 * @see elm_layout_table_pack()
7640 * @see elm_layout_table_clear()
7644 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7646 * Remove all child of the given part table.
7648 * @param obj The layout object
7649 * @param part The table part name to remove child.
7650 * @param clear If EINA_TRUE, then all objects will be deleted as
7651 * well, otherwise they will just be removed and will be
7652 * dangling on the canvas.
7654 * The objects will be removed from the table part and their lifetime will
7655 * not be handled by the layout anymore. This is equivalent to
7656 * elm_layout_table_unpack() for all table children.
7658 * @see elm_layout_table_pack()
7659 * @see elm_layout_table_unpack()
7663 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7665 * Get the edje layout
7667 * @param obj The layout object
7669 * @return A Evas_Object with the edje layout settings loaded
7670 * with function elm_layout_file_set
7672 * This returns the edje object. It is not expected to be used to then
7673 * swallow objects via edje_object_part_swallow() for example. Use
7674 * elm_layout_content_set() instead so child object handling and sizing is
7677 * @note This function should only be used if you really need to call some
7678 * low level Edje function on this edje object. All the common stuff (setting
7679 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7680 * with proper elementary functions.
7682 * @see elm_object_signal_callback_add()
7683 * @see elm_object_signal_emit()
7684 * @see elm_object_text_part_set()
7685 * @see elm_layout_content_set()
7686 * @see elm_layout_box_append()
7687 * @see elm_layout_table_pack()
7688 * @see elm_layout_data_get()
7692 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7694 * Get the edje data from the given layout
7696 * @param obj The layout object
7697 * @param key The data key
7699 * @return The edje data string
7701 * This function fetches data specified inside the edje theme of this layout.
7702 * This function return NULL if data is not found.
7704 * In EDC this comes from a data block within the group block that @p
7705 * obj was loaded from. E.g.
7712 * item: "key1" "value1";
7713 * item: "key2" "value2";
7721 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7725 * @param obj The layout object
7727 * Manually forces a sizing re-evaluation. This is useful when the minimum
7728 * size required by the edje theme of this layout has changed. The change on
7729 * the minimum size required by the edje theme is not immediately reported to
7730 * the elementary layout, so one needs to call this function in order to tell
7731 * the widget (layout) that it needs to reevaluate its own size.
7733 * The minimum size of the theme is calculated based on minimum size of
7734 * parts, the size of elements inside containers like box and table, etc. All
7735 * of this can change due to state changes, and that's when this function
7738 * Also note that a standard signal of "size,eval" "elm" emitted from the
7739 * edje object will cause this to happen too.
7743 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7744 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7745 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7746 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7747 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7748 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7749 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);
7750 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7752 * @def elm_layout_icon_set
7753 * Convienience macro to set the icon object in a layout that follows the
7754 * Elementary naming convention for its parts.
7758 #define elm_layout_icon_set(_ly, _obj) \
7761 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7762 if ((_obj)) sig = "elm,state,icon,visible"; \
7763 else sig = "elm,state,icon,hidden"; \
7764 elm_object_signal_emit((_ly), sig, "elm"); \
7768 * @def elm_layout_icon_get
7769 * Convienience macro to get the icon object from a layout that follows the
7770 * Elementary naming convention for its parts.
7774 #define elm_layout_icon_get(_ly) \
7775 elm_layout_content_get((_ly), "elm.swallow.icon")
7778 * @def elm_layout_end_set
7779 * Convienience macro to set the end object in a layout that follows the
7780 * Elementary naming convention for its parts.
7784 #define elm_layout_end_set(_ly, _obj) \
7787 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7788 if ((_obj)) sig = "elm,state,end,visible"; \
7789 else sig = "elm,state,end,hidden"; \
7790 elm_object_signal_emit((_ly), sig, "elm"); \
7794 * @def elm_layout_end_get
7795 * Convienience macro to get the end object in a layout that follows the
7796 * Elementary naming convention for its parts.
7800 #define elm_layout_end_get(_ly) \
7801 elm_layout_content_get((_ly), "elm.swallow.end")
7804 * @def elm_layout_label_set
7805 * Convienience macro to set the label in a layout that follows the
7806 * Elementary naming convention for its parts.
7809 * @deprecate use elm_object_text_* instead.
7811 #define elm_layout_label_set(_ly, _txt) \
7812 elm_layout_text_set((_ly), "elm.text", (_txt))
7815 * @def elm_layout_label_get
7816 * Convienience macro to get the label in a layout that follows the
7817 * Elementary naming convention for its parts.
7820 * @deprecate use elm_object_text_* instead.
7822 #define elm_layout_label_get(_ly) \
7823 elm_layout_text_get((_ly), "elm.text")
7825 /* smart callbacks called:
7826 * "theme,changed" - when elm theme is changed.
7830 * @defgroup Notify Notify
7832 * @image html img/widget/notify/preview-00.png
7833 * @image latex img/widget/notify/preview-00.eps
7835 * Display a container in a particular region of the parent(top, bottom,
7836 * etc. A timeout can be set to automatically hide the notify. This is so
7837 * that, after an evas_object_show() on a notify object, if a timeout was set
7838 * on it, it will @b automatically get hidden after that time.
7840 * Signals that you can add callbacks for are:
7841 * @li "timeout" - when timeout happens on notify and it's hidden
7842 * @li "block,clicked" - when a click outside of the notify happens
7844 * @ref tutorial_notify show usage of the API.
7849 * @brief Possible orient values for notify.
7851 * This values should be used in conjunction to elm_notify_orient_set() to
7852 * set the position in which the notify should appear(relative to its parent)
7853 * and in conjunction with elm_notify_orient_get() to know where the notify
7856 typedef enum _Elm_Notify_Orient
7858 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7859 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7860 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7861 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7862 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7863 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7864 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7865 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7866 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7867 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7868 } Elm_Notify_Orient;
7870 * @brief Add a new notify to the parent
7872 * @param parent The parent object
7873 * @return The new object or NULL if it cannot be created
7875 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7877 * @brief Set the content of the notify widget
7879 * @param obj The notify object
7880 * @param content The content will be filled in this notify object
7882 * Once the content object is set, a previously set one will be deleted. If
7883 * you want to keep that old content object, use the
7884 * elm_notify_content_unset() function.
7886 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7888 * @brief Unset the content of the notify widget
7890 * @param obj The notify object
7891 * @return The content that was being used
7893 * Unparent and return the content object which was set for this widget
7895 * @see elm_notify_content_set()
7897 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7899 * @brief Return the content of the notify widget
7901 * @param obj The notify object
7902 * @return The content that is being used
7904 * @see elm_notify_content_set()
7906 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7908 * @brief Set the notify parent
7910 * @param obj The notify object
7911 * @param content The new parent
7913 * Once the parent object is set, a previously set one will be disconnected
7916 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7918 * @brief Get the notify parent
7920 * @param obj The notify object
7921 * @return The parent
7923 * @see elm_notify_parent_set()
7925 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7927 * @brief Set the orientation
7929 * @param obj The notify object
7930 * @param orient The new orientation
7932 * Sets the position in which the notify will appear in its parent.
7934 * @see @ref Elm_Notify_Orient for possible values.
7936 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7938 * @brief Return the orientation
7939 * @param obj The notify object
7940 * @return The orientation of the notification
7942 * @see elm_notify_orient_set()
7943 * @see Elm_Notify_Orient
7945 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7947 * @brief Set the time interval after which the notify window is going to be
7950 * @param obj The notify object
7951 * @param time The timeout in seconds
7953 * This function sets a timeout and starts the timer controlling when the
7954 * notify is hidden. Since calling evas_object_show() on a notify restarts
7955 * the timer controlling when the notify is hidden, setting this before the
7956 * notify is shown will in effect mean starting the timer when the notify is
7959 * @note Set a value <= 0.0 to disable a running timer.
7961 * @note If the value > 0.0 and the notify is previously visible, the
7962 * timer will be started with this value, canceling any running timer.
7964 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7966 * @brief Return the timeout value (in seconds)
7967 * @param obj the notify object
7969 * @see elm_notify_timeout_set()
7971 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7973 * @brief Sets whether events should be passed to by a click outside
7976 * @param obj The notify object
7977 * @param repeats EINA_TRUE Events are repeats, else no
7979 * When true if the user clicks outside the window the events will be caught
7980 * by the others widgets, else the events are blocked.
7982 * @note The default value is EINA_TRUE.
7984 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
7986 * @brief Return true if events are repeat below the notify object
7987 * @param obj the notify object
7989 * @see elm_notify_repeat_events_set()
7991 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7997 * @defgroup Hover Hover
7999 * @image html img/widget/hover/preview-00.png
8000 * @image latex img/widget/hover/preview-00.eps
8002 * A Hover object will hover over its @p parent object at the @p target
8003 * location. Anything in the background will be given a darker coloring to
8004 * indicate that the hover object is on top (at the default theme). When the
8005 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8006 * clicked that @b doesn't cause the hover to be dismissed.
8008 * @note The hover object will take up the entire space of @p target
8011 * Elementary has the following styles for the hover widget:
8015 * @li hoversel_vertical
8017 * The following are the available position for content:
8029 * Signals that you can add callbacks for are:
8030 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8031 * @li "smart,changed" - a content object placed under the "smart"
8032 * policy was replaced to a new slot direction.
8034 * See @ref tutorial_hover for more information.
8038 typedef enum _Elm_Hover_Axis
8040 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8041 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8042 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8043 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8046 * @brief Adds a hover object to @p parent
8048 * @param parent The parent object
8049 * @return The hover object or NULL if one could not be created
8051 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8053 * @brief Sets the target object for the hover.
8055 * @param obj The hover object
8056 * @param target The object to center the hover onto. The hover
8058 * This function will cause the hover to be centered on the target object.
8060 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8062 * @brief Gets the target object for the hover.
8064 * @param obj The hover object
8065 * @param parent The object to locate the hover over.
8067 * @see elm_hover_target_set()
8069 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8071 * @brief Sets the parent object for the hover.
8073 * @param obj The hover object
8074 * @param parent The object to locate the hover over.
8076 * This function will cause the hover to take up the entire space that the
8077 * parent object fills.
8079 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8081 * @brief Gets the parent object for the hover.
8083 * @param obj The hover object
8084 * @return The parent object to locate the hover over.
8086 * @see elm_hover_parent_set()
8088 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8090 * @brief Sets the content of the hover object and the direction in which it
8093 * @param obj The hover object
8094 * @param swallow The direction that the object will be displayed
8095 * at. Accepted values are "left", "top-left", "top", "top-right",
8096 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8098 * @param content The content to place at @p swallow
8100 * Once the content object is set for a given direction, a previously
8101 * set one (on the same direction) will be deleted. If you want to
8102 * keep that old content object, use the elm_hover_content_unset()
8105 * All directions may have contents at the same time, except for
8106 * "smart". This is a special placement hint and its use case
8107 * independs of the calculations coming from
8108 * elm_hover_best_content_location_get(). Its use is for cases when
8109 * one desires only one hover content, but with a dinamic special
8110 * placement within the hover area. The content's geometry, whenever
8111 * it changes, will be used to decide on a best location not
8112 * extrapolating the hover's parent object view to show it in (still
8113 * being the hover's target determinant of its medium part -- move and
8114 * resize it to simulate finger sizes, for example). If one of the
8115 * directions other than "smart" are used, a previously content set
8116 * using it will be deleted, and vice-versa.
8118 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8120 * @brief Get the content of the hover object, in a given direction.
8122 * Return the content object which was set for this widget in the
8123 * @p swallow direction.
8125 * @param obj The hover object
8126 * @param swallow The direction that the object was display at.
8127 * @return The content that was being used
8129 * @see elm_hover_content_set()
8131 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8133 * @brief Unset the content of the hover object, in a given direction.
8135 * Unparent and return the content object set at @p swallow direction.
8137 * @param obj The hover object
8138 * @param swallow The direction that the object was display at.
8139 * @return The content that was being used.
8141 * @see elm_hover_content_set()
8143 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8145 * @brief Returns the best swallow location for content in the hover.
8147 * @param obj The hover object
8148 * @param pref_axis The preferred orientation axis for the hover object to use
8149 * @return The edje location to place content into the hover or @c
8152 * Best is defined here as the location at which there is the most available
8155 * @p pref_axis may be one of
8156 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8157 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8158 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8159 * - @c ELM_HOVER_AXIS_BOTH -- both
8161 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8162 * nescessarily be along the horizontal axis("left" or "right"). If
8163 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8164 * be along the vertical axis("top" or "bottom"). Chossing
8165 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8166 * returned position may be in either axis.
8168 * @see elm_hover_content_set()
8170 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8177 * @defgroup Entry Entry
8179 * @image html img/widget/entry/preview-00.png
8180 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8181 * @image html img/widget/entry/preview-01.png
8182 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8183 * @image html img/widget/entry/preview-02.png
8184 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8185 * @image html img/widget/entry/preview-03.png
8186 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8188 * An entry is a convenience widget which shows a box that the user can
8189 * enter text into. Entries by default don't scroll, so they grow to
8190 * accomodate the entire text, resizing the parent window as needed. This
8191 * can be changed with the elm_entry_scrollable_set() function.
8193 * They can also be single line or multi line (the default) and when set
8194 * to multi line mode they support text wrapping in any of the modes
8195 * indicated by #Elm_Wrap_Type.
8197 * Other features include password mode, filtering of inserted text with
8198 * elm_entry_text_filter_append() and related functions, inline "items" and
8199 * formatted markup text.
8201 * @section entry-markup Formatted text
8203 * The markup tags supported by the Entry are defined by the theme, but
8204 * even when writing new themes or extensions it's a good idea to stick to
8205 * a sane default, to maintain coherency and avoid application breakages.
8206 * Currently defined by the default theme are the following tags:
8207 * @li \<br\>: Inserts a line break.
8208 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8210 * @li \<tab\>: Inserts a tab.
8211 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8213 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8214 * @li \<link\>...\</link\>: Underlines the enclosed text.
8215 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8217 * @section entry-special Special markups
8219 * Besides those used to format text, entries support two special markup
8220 * tags used to insert clickable portions of text or items inlined within
8223 * @subsection entry-anchors Anchors
8225 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8226 * \</a\> tags and an event will be generated when this text is clicked,
8230 * This text is outside <a href=anc-01>but this one is an anchor</a>
8233 * The @c href attribute in the opening tag gives the name that will be
8234 * used to identify the anchor and it can be any valid utf8 string.
8236 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8237 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8238 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8239 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8242 * @subsection entry-items Items
8244 * Inlined in the text, any other @c Evas_Object can be inserted by using
8245 * \<item\> tags this way:
8248 * <item size=16x16 vsize=full href=emoticon/haha></item>
8251 * Just like with anchors, the @c href identifies each item, but these need,
8252 * in addition, to indicate their size, which is done using any one of
8253 * @c size, @c absize or @c relsize attributes. These attributes take their
8254 * value in the WxH format, where W is the width and H the height of the
8257 * @li absize: Absolute pixel size for the item. Whatever value is set will
8258 * be the item's size regardless of any scale value the object may have
8259 * been set to. The final line height will be adjusted to fit larger items.
8260 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8262 * @li relsize: Size is adjusted for the item to fit within the current
8265 * Besides their size, items are specificed a @c vsize value that affects
8266 * how their final size and position are calculated. The possible values
8268 * @li ascent: Item will be placed within the line's baseline and its
8269 * ascent. That is, the height between the line where all characters are
8270 * positioned and the highest point in the line. For @c size and @c absize
8271 * items, the descent value will be added to the total line height to make
8272 * them fit. @c relsize items will be adjusted to fit within this space.
8273 * @li full: Items will be placed between the descent and ascent, or the
8274 * lowest point in the line and its highest.
8276 * The next image shows different configurations of items and how they
8277 * are the previously mentioned options affect their sizes. In all cases,
8278 * the green line indicates the ascent, blue for the baseline and red for
8281 * @image html entry_item.png
8282 * @image latex entry_item.eps width=\textwidth
8284 * And another one to show how size differs from absize. In the first one,
8285 * the scale value is set to 1.0, while the second one is using one of 2.0.
8287 * @image html entry_item_scale.png
8288 * @image latex entry_item_scale.eps width=\textwidth
8290 * After the size for an item is calculated, the entry will request an
8291 * object to place in its space. For this, the functions set with
8292 * elm_entry_item_provider_append() and related functions will be called
8293 * in order until one of them returns a @c non-NULL value. If no providers
8294 * are available, or all of them return @c NULL, then the entry falls back
8295 * to one of the internal defaults, provided the name matches with one of
8298 * All of the following are currently supported:
8301 * - emoticon/angry-shout
8302 * - emoticon/crazy-laugh
8303 * - emoticon/evil-laugh
8305 * - emoticon/goggle-smile
8307 * - emoticon/grumpy-smile
8309 * - emoticon/guilty-smile
8311 * - emoticon/half-smile
8312 * - emoticon/happy-panting
8314 * - emoticon/indifferent
8316 * - emoticon/knowing-grin
8318 * - emoticon/little-bit-sorry
8319 * - emoticon/love-lots
8321 * - emoticon/minimal-smile
8322 * - emoticon/not-happy
8323 * - emoticon/not-impressed
8325 * - emoticon/opensmile
8328 * - emoticon/squint-laugh
8329 * - emoticon/surprised
8330 * - emoticon/suspicious
8331 * - emoticon/tongue-dangling
8332 * - emoticon/tongue-poke
8334 * - emoticon/unhappy
8335 * - emoticon/very-sorry
8338 * - emoticon/worried
8341 * Alternatively, an item may reference an image by its path, using
8342 * the URI form @c file:///path/to/an/image.png and the entry will then
8343 * use that image for the item.
8345 * @section entry-files Loading and saving files
8347 * Entries have convinience functions to load text from a file and save
8348 * changes back to it after a short delay. The automatic saving is enabled
8349 * by default, but can be disabled with elm_entry_autosave_set() and files
8350 * can be loaded directly as plain text or have any markup in them
8351 * recognized. See elm_entry_file_set() for more details.
8353 * @section entry-signals Emitted signals
8355 * This widget emits the following signals:
8357 * @li "changed": The text within the entry was changed.
8358 * @li "changed,user": The text within the entry was changed because of user interaction.
8359 * @li "activated": The enter key was pressed on a single line entry.
8360 * @li "press": A mouse button has been pressed on the entry.
8361 * @li "longpressed": A mouse button has been pressed and held for a couple
8363 * @li "clicked": The entry has been clicked (mouse press and release).
8364 * @li "clicked,double": The entry has been double clicked.
8365 * @li "clicked,triple": The entry has been triple clicked.
8366 * @li "focused": The entry has received focus.
8367 * @li "unfocused": The entry has lost focus.
8368 * @li "selection,paste": A paste of the clipboard contents was requested.
8369 * @li "selection,copy": A copy of the selected text into the clipboard was
8371 * @li "selection,cut": A cut of the selected text into the clipboard was
8373 * @li "selection,start": A selection has begun and no previous selection
8375 * @li "selection,changed": The current selection has changed.
8376 * @li "selection,cleared": The current selection has been cleared.
8377 * @li "cursor,changed": The cursor has changed position.
8378 * @li "anchor,clicked": An anchor has been clicked. The event_info
8379 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8380 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8381 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8382 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8383 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8384 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8385 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8386 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8387 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8388 * @li "preedit,changed": The preedit string has changed.
8390 * @section entry-examples
8392 * An overview of the Entry API can be seen in @ref entry_example_01
8397 * @typedef Elm_Entry_Anchor_Info
8399 * The info sent in the callback for the "anchor,clicked" signals emitted
8402 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8404 * @struct _Elm_Entry_Anchor_Info
8406 * The info sent in the callback for the "anchor,clicked" signals emitted
8409 struct _Elm_Entry_Anchor_Info
8411 const char *name; /**< The name of the anchor, as stated in its href */
8412 int button; /**< The mouse button used to click on it */
8413 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8414 y, /**< Anchor geometry, relative to canvas */
8415 w, /**< Anchor geometry, relative to canvas */
8416 h; /**< Anchor geometry, relative to canvas */
8419 * @typedef Elm_Entry_Filter_Cb
8420 * This callback type is used by entry filters to modify text.
8421 * @param data The data specified as the last param when adding the filter
8422 * @param entry The entry object
8423 * @param text A pointer to the location of the text being filtered. This data can be modified,
8424 * but any additional allocations must be managed by the user.
8425 * @see elm_entry_text_filter_append
8426 * @see elm_entry_text_filter_prepend
8428 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8431 * This adds an entry to @p parent object.
8433 * By default, entries are:
8437 * @li autosave is enabled
8439 * @param parent The parent object
8440 * @return The new object or NULL if it cannot be created
8442 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8444 * Sets the entry to single line mode.
8446 * In single line mode, entries don't ever wrap when the text reaches the
8447 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8448 * key will generate an @c "activate" event instead of adding a new line.
8450 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8451 * and pressing enter will break the text into a different line
8452 * without generating any events.
8454 * @param obj The entry object
8455 * @param single_line If true, the text in the entry
8456 * will be on a single line.
8458 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8460 * Gets whether the entry is set to be single line.
8462 * @param obj The entry object
8463 * @return single_line If true, the text in the entry is set to display
8466 * @see elm_entry_single_line_set()
8468 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8470 * Sets the entry to password mode.
8472 * In password mode, entries are implicitly single line and the display of
8473 * any text in them is replaced with asterisks (*).
8475 * @param obj The entry object
8476 * @param password If true, password mode is enabled.
8478 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8480 * Gets whether the entry is set to password mode.
8482 * @param obj The entry object
8483 * @return If true, the entry is set to display all characters
8486 * @see elm_entry_password_set()
8488 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8490 * This sets the text displayed within the entry to @p entry.
8492 * @param obj The entry object
8493 * @param entry The text to be displayed
8495 * @deprecated Use elm_object_text_set() instead.
8497 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8499 * This returns the text currently shown in object @p entry.
8500 * See also elm_entry_entry_set().
8502 * @param obj The entry object
8503 * @return The currently displayed text or NULL on failure
8505 * @deprecated Use elm_object_text_get() instead.
8507 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8509 * Appends @p entry to the text of the entry.
8511 * Adds the text in @p entry to the end of any text already present in the
8514 * The appended text is subject to any filters set for the widget.
8516 * @param obj The entry object
8517 * @param entry The text to be displayed
8519 * @see elm_entry_text_filter_append()
8521 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8523 * Gets whether the entry is empty.
8525 * Empty means no text at all. If there are any markup tags, like an item
8526 * tag for which no provider finds anything, and no text is displayed, this
8527 * function still returns EINA_FALSE.
8529 * @param obj The entry object
8530 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8532 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8534 * Gets any selected text within the entry.
8536 * If there's any selected text in the entry, this function returns it as
8537 * a string in markup format. NULL is returned if no selection exists or
8538 * if an error occurred.
8540 * The returned value points to an internal string and should not be freed
8541 * or modified in any way. If the @p entry object is deleted or its
8542 * contents are changed, the returned pointer should be considered invalid.
8544 * @param obj The entry object
8545 * @return The selected text within the entry or NULL on failure
8547 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8549 * Inserts the given text into the entry at the current cursor position.
8551 * This inserts text at the cursor position as if it was typed
8552 * by the user (note that this also allows markup which a user
8553 * can't just "type" as it would be converted to escaped text, so this
8554 * call can be used to insert things like emoticon items or bold push/pop
8555 * tags, other font and color change tags etc.)
8557 * If any selection exists, it will be replaced by the inserted text.
8559 * The inserted text is subject to any filters set for the widget.
8561 * @param obj The entry object
8562 * @param entry The text to insert
8564 * @see elm_entry_text_filter_append()
8566 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8568 * Set the line wrap type to use on multi-line entries.
8570 * Sets the wrap type used by the entry to any of the specified in
8571 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8572 * line (without inserting a line break or paragraph separator) when it
8573 * reaches the far edge of the widget.
8575 * Note that this only makes sense for multi-line entries. A widget set
8576 * to be single line will never wrap.
8578 * @param obj The entry object
8579 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8581 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8583 * Gets the wrap mode the entry was set to use.
8585 * @param obj The entry object
8588 * @see also elm_entry_line_wrap_set()
8590 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8592 * Sets if the entry is to be editable or not.
8594 * By default, entries are editable and when focused, any text input by the
8595 * user will be inserted at the current cursor position. But calling this
8596 * function with @p editable as EINA_FALSE will prevent the user from
8597 * inputting text into the entry.
8599 * The only way to change the text of a non-editable entry is to use
8600 * elm_object_text_set(), elm_entry_entry_insert() and other related
8603 * @param obj The entry object
8604 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8605 * if not, the entry is read-only and no user input is allowed.
8607 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8609 * Gets whether the entry is editable or not.
8611 * @param obj The entry object
8612 * @return If true, the entry is editable by the user.
8613 * If false, it is not editable by the user
8615 * @see elm_entry_editable_set()
8617 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8619 * This drops any existing text selection within the entry.
8621 * @param obj The entry object
8623 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8625 * This selects all text within the entry.
8627 * @param obj The entry object
8629 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8631 * This moves the cursor one place to the right within the entry.
8633 * @param obj The entry object
8634 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8636 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8638 * This moves the cursor one place to the left within the entry.
8640 * @param obj The entry object
8641 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8643 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8645 * This moves the cursor one line up within the entry.
8647 * @param obj The entry object
8648 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8650 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8652 * This moves the cursor one line down within the entry.
8654 * @param obj The entry object
8655 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8657 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8659 * This moves the cursor to the beginning of the entry.
8661 * @param obj The entry object
8663 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8665 * This moves the cursor to the end of the entry.
8667 * @param obj The entry object
8669 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8671 * This moves the cursor to the beginning of the current line.
8673 * @param obj The entry object
8675 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8677 * This moves the cursor to the end of the current line.
8679 * @param obj The entry object
8681 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8683 * This begins a selection within the entry as though
8684 * the user were holding down the mouse button to make a selection.
8686 * @param obj The entry object
8688 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8690 * This ends a selection within the entry as though
8691 * the user had just released the mouse button while making a selection.
8693 * @param obj The entry object
8695 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8697 * Gets whether a format node exists at the current cursor position.
8699 * A format node is anything that defines how the text is rendered. It can
8700 * be a visible format node, such as a line break or a paragraph separator,
8701 * or an invisible one, such as bold begin or end tag.
8702 * This function returns whether any format node exists at the current
8705 * @param obj The entry object
8706 * @return EINA_TRUE if the current cursor position contains a format node,
8707 * EINA_FALSE otherwise.
8709 * @see elm_entry_cursor_is_visible_format_get()
8711 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8713 * Gets if the current cursor position holds a visible format node.
8715 * @param obj The entry object
8716 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8717 * if it's an invisible one or no format exists.
8719 * @see elm_entry_cursor_is_format_get()
8721 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8723 * Gets the character pointed by the cursor at its current position.
8725 * This function returns a string with the utf8 character stored at the
8726 * current cursor position.
8727 * Only the text is returned, any format that may exist will not be part
8728 * of the return value.
8730 * @param obj The entry object
8731 * @return The text pointed by the cursors.
8733 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8735 * This function returns the geometry of the cursor.
8737 * It's useful if you want to draw something on the cursor (or where it is),
8738 * or for example in the case of scrolled entry where you want to show the
8741 * @param obj The entry object
8742 * @param x returned geometry
8743 * @param y returned geometry
8744 * @param w returned geometry
8745 * @param h returned geometry
8746 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8748 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);
8750 * Sets the cursor position in the entry to the given value
8752 * The value in @p pos is the index of the character position within the
8753 * contents of the string as returned by elm_entry_cursor_pos_get().
8755 * @param obj The entry object
8756 * @param pos The position of the cursor
8758 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8760 * Retrieves the current position of the cursor in the entry
8762 * @param obj The entry object
8763 * @return The cursor position
8765 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8767 * This executes a "cut" action on the selected text in the entry.
8769 * @param obj The entry object
8771 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8773 * This executes a "copy" action on the selected text in the entry.
8775 * @param obj The entry object
8777 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8779 * This executes a "paste" action in the entry.
8781 * @param obj The entry object
8783 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8785 * This clears and frees the items in a entry's contextual (longpress)
8788 * @param obj The entry object
8790 * @see elm_entry_context_menu_item_add()
8792 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8794 * This adds an item to the entry's contextual menu.
8796 * A longpress on an entry will make the contextual menu show up, if this
8797 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8798 * By default, this menu provides a few options like enabling selection mode,
8799 * which is useful on embedded devices that need to be explicit about it,
8800 * and when a selection exists it also shows the copy and cut actions.
8802 * With this function, developers can add other options to this menu to
8803 * perform any action they deem necessary.
8805 * @param obj The entry object
8806 * @param label The item's text label
8807 * @param icon_file The item's icon file
8808 * @param icon_type The item's icon type
8809 * @param func The callback to execute when the item is clicked
8810 * @param data The data to associate with the item for related functions
8812 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);
8814 * This disables the entry's contextual (longpress) menu.
8816 * @param obj The entry object
8817 * @param disabled If true, the menu is disabled
8819 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8821 * This returns whether the entry's contextual (longpress) menu is
8824 * @param obj The entry object
8825 * @return If true, the menu is disabled
8827 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8829 * This appends a custom item provider to the list for that entry
8831 * This appends the given callback. The list is walked from beginning to end
8832 * with each function called given the item href string in the text. If the
8833 * function returns an object handle other than NULL (it should create an
8834 * object to do this), then this object is used to replace that item. If
8835 * not the next provider is called until one provides an item object, or the
8836 * default provider in entry does.
8838 * @param obj The entry object
8839 * @param func The function called to provide the item object
8840 * @param data The data passed to @p func
8842 * @see @ref entry-items
8844 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);
8846 * This prepends a custom item provider to the list for that entry
8848 * This prepends the given callback. See elm_entry_item_provider_append() for
8851 * @param obj The entry object
8852 * @param func The function called to provide the item object
8853 * @param data The data passed to @p func
8855 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);
8857 * This removes a custom item provider to the list for that entry
8859 * This removes the given callback. See elm_entry_item_provider_append() for
8862 * @param obj The entry object
8863 * @param func The function called to provide the item object
8864 * @param data The data passed to @p func
8866 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);
8868 * Append a filter function for text inserted in the entry
8870 * Append the given callback to the list. This functions will be called
8871 * whenever any text is inserted into the entry, with the text to be inserted
8872 * as a parameter. The callback function is free to alter the text in any way
8873 * it wants, but it must remember to free the given pointer and update it.
8874 * If the new text is to be discarded, the function can free it and set its
8875 * text parameter to NULL. This will also prevent any following filters from
8878 * @param obj The entry object
8879 * @param func The function to use as text filter
8880 * @param data User data to pass to @p func
8882 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8884 * Prepend a filter function for text insdrted in the entry
8886 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8887 * for more information
8889 * @param obj The entry object
8890 * @param func The function to use as text filter
8891 * @param data User data to pass to @p func
8893 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8895 * Remove a filter from the list
8897 * Removes the given callback from the filter list. See
8898 * elm_entry_text_filter_append() for more information.
8900 * @param obj The entry object
8901 * @param func The filter function to remove
8902 * @param data The user data passed when adding the function
8904 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8906 * This converts a markup (HTML-like) string into UTF-8.
8908 * The returned string is a malloc'ed buffer and it should be freed when
8909 * not needed anymore.
8911 * @param s The string (in markup) to be converted
8912 * @return The converted string (in UTF-8). It should be freed.
8914 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8916 * This converts a UTF-8 string into markup (HTML-like).
8918 * The returned string is a malloc'ed buffer and it should be freed when
8919 * not needed anymore.
8921 * @param s The string (in UTF-8) to be converted
8922 * @return The converted string (in markup). It should be freed.
8924 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8926 * This sets the file (and implicitly loads it) for the text to display and
8927 * then edit. All changes are written back to the file after a short delay if
8928 * the entry object is set to autosave (which is the default).
8930 * If the entry had any other file set previously, any changes made to it
8931 * will be saved if the autosave feature is enabled, otherwise, the file
8932 * will be silently discarded and any non-saved changes will be lost.
8934 * @param obj The entry object
8935 * @param file The path to the file to load and save
8936 * @param format The file format
8938 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8940 * Gets the file being edited by the entry.
8942 * This function can be used to retrieve any file set on the entry for
8943 * edition, along with the format used to load and save it.
8945 * @param obj The entry object
8946 * @param file The path to the file to load and save
8947 * @param format The file format
8949 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8951 * This function writes any changes made to the file set with
8952 * elm_entry_file_set()
8954 * @param obj The entry object
8956 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8958 * This sets the entry object to 'autosave' the loaded text file or not.
8960 * @param obj The entry object
8961 * @param autosave Autosave the loaded file or not
8963 * @see elm_entry_file_set()
8965 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8967 * This gets the entry object's 'autosave' status.
8969 * @param obj The entry object
8970 * @return Autosave the loaded file or not
8972 * @see elm_entry_file_set()
8974 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8976 * Control pasting of text and images for the widget.
8978 * Normally the entry allows both text and images to be pasted. By setting
8979 * textonly to be true, this prevents images from being pasted.
8981 * Note this only changes the behaviour of text.
8983 * @param obj The entry object
8984 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
8987 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
8989 * Getting elm_entry text paste/drop mode.
8991 * In textonly mode, only text may be pasted or dropped into the widget.
8993 * @param obj The entry object
8994 * @return If the widget only accepts text from pastes.
8996 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8998 * Enable or disable scrolling in entry
9000 * Normally the entry is not scrollable unless you enable it with this call.
9002 * @param obj The entry object
9003 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9005 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9007 * Get the scrollable state of the entry
9009 * Normally the entry is not scrollable. This gets the scrollable state
9010 * of the entry. See elm_entry_scrollable_set() for more information.
9012 * @param obj The entry object
9013 * @return The scrollable state
9015 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9017 * This sets a widget to be displayed to the left of a scrolled entry.
9019 * @param obj The scrolled entry object
9020 * @param icon The widget to display on the left side of the scrolled
9023 * @note A previously set widget will be destroyed.
9024 * @note If the object being set does not have minimum size hints set,
9025 * it won't get properly displayed.
9027 * @see elm_entry_end_set()
9029 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9031 * Gets the leftmost widget of the scrolled entry. This object is
9032 * owned by the scrolled entry and should not be modified.
9034 * @param obj The scrolled entry object
9035 * @return the left widget inside the scroller
9037 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9039 * Unset the leftmost widget of the scrolled entry, unparenting and
9042 * @param obj The scrolled entry object
9043 * @return the previously set icon sub-object of this entry, on
9046 * @see elm_entry_icon_set()
9048 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9050 * Sets the visibility of the left-side widget of the scrolled entry,
9051 * set by @elm_entry_icon_set().
9053 * @param obj The scrolled entry object
9054 * @param setting EINA_TRUE if the object should be displayed,
9055 * EINA_FALSE if not.
9057 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9059 * This sets a widget to be displayed to the end of a scrolled entry.
9061 * @param obj The scrolled entry object
9062 * @param end The widget to display on the right side of the scrolled
9065 * @note A previously set widget will be destroyed.
9066 * @note If the object being set does not have minimum size hints set,
9067 * it won't get properly displayed.
9069 * @see elm_entry_icon_set
9071 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9073 * Gets the endmost widget of the scrolled entry. This object is owned
9074 * by the scrolled entry and should not be modified.
9076 * @param obj The scrolled entry object
9077 * @return the right widget inside the scroller
9079 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9081 * Unset the endmost widget of the scrolled entry, unparenting and
9084 * @param obj The scrolled entry object
9085 * @return the previously set icon sub-object of this entry, on
9088 * @see elm_entry_icon_set()
9090 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9092 * Sets the visibility of the end widget of the scrolled entry, set by
9093 * @elm_entry_end_set().
9095 * @param obj The scrolled entry object
9096 * @param setting EINA_TRUE if the object should be displayed,
9097 * EINA_FALSE if not.
9099 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9101 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9104 * Setting an entry to single-line mode with elm_entry_single_line_set()
9105 * will automatically disable the display of scrollbars when the entry
9106 * moves inside its scroller.
9108 * @param obj The scrolled entry object
9109 * @param h The horizontal scrollbar policy to apply
9110 * @param v The vertical scrollbar policy to apply
9112 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9114 * This enables/disables bouncing within the entry.
9116 * This function sets whether the entry will bounce when scrolling reaches
9117 * the end of the contained entry.
9119 * @param obj The scrolled entry object
9120 * @param h The horizontal bounce state
9121 * @param v The vertical bounce state
9123 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9125 * Get the bounce mode
9127 * @param obj The Entry object
9128 * @param h_bounce Allow bounce horizontally
9129 * @param v_bounce Allow bounce vertically
9131 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9133 /* pre-made filters for entries */
9135 * @typedef Elm_Entry_Filter_Limit_Size
9137 * Data for the elm_entry_filter_limit_size() entry filter.
9139 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9141 * @struct _Elm_Entry_Filter_Limit_Size
9143 * Data for the elm_entry_filter_limit_size() entry filter.
9145 struct _Elm_Entry_Filter_Limit_Size
9147 int max_char_count; /**< The maximum number of characters allowed. */
9148 int max_byte_count; /**< The maximum number of bytes allowed*/
9151 * Filter inserted text based on user defined character and byte limits
9153 * Add this filter to an entry to limit the characters that it will accept
9154 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9155 * The funtion works on the UTF-8 representation of the string, converting
9156 * it from the set markup, thus not accounting for any format in it.
9158 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9159 * it as data when setting the filter. In it, it's possible to set limits
9160 * by character count or bytes (any of them is disabled if 0), and both can
9161 * be set at the same time. In that case, it first checks for characters,
9164 * The function will cut the inserted text in order to allow only the first
9165 * number of characters that are still allowed. The cut is made in
9166 * characters, even when limiting by bytes, in order to always contain
9167 * valid ones and avoid half unicode characters making it in.
9169 * This filter, like any others, does not apply when setting the entry text
9170 * directly with elm_object_text_set() (or the deprecated
9171 * elm_entry_entry_set()).
9173 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9175 * @typedef Elm_Entry_Filter_Accept_Set
9177 * Data for the elm_entry_filter_accept_set() entry filter.
9179 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9181 * @struct _Elm_Entry_Filter_Accept_Set
9183 * Data for the elm_entry_filter_accept_set() entry filter.
9185 struct _Elm_Entry_Filter_Accept_Set
9187 const char *accepted; /**< Set of characters accepted in the entry. */
9188 const char *rejected; /**< Set of characters rejected from the entry. */
9191 * Filter inserted text based on accepted or rejected sets of characters
9193 * Add this filter to an entry to restrict the set of accepted characters
9194 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9195 * This structure contains both accepted and rejected sets, but they are
9196 * mutually exclusive.
9198 * The @c accepted set takes preference, so if it is set, the filter will
9199 * only work based on the accepted characters, ignoring anything in the
9200 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9202 * In both cases, the function filters by matching utf8 characters to the
9203 * raw markup text, so it can be used to remove formatting tags.
9205 * This filter, like any others, does not apply when setting the entry text
9206 * directly with elm_object_text_set() (or the deprecated
9207 * elm_entry_entry_set()).
9209 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9214 /* composite widgets - these basically put together basic widgets above
9215 * in convenient packages that do more than basic stuff */
9219 * @defgroup Anchorview Anchorview
9221 * @image html img/widget/anchorview/preview-00.png
9222 * @image latex img/widget/anchorview/preview-00.eps
9224 * Anchorview is for displaying text that contains markup with anchors
9225 * like <c>\<a href=1234\>something\</\></c> in it.
9227 * Besides being styled differently, the anchorview widget provides the
9228 * necessary functionality so that clicking on these anchors brings up a
9229 * popup with user defined content such as "call", "add to contacts" or
9230 * "open web page". This popup is provided using the @ref Hover widget.
9232 * This widget is very similar to @ref Anchorblock, so refer to that
9233 * widget for an example. The only difference Anchorview has is that the
9234 * widget is already provided with scrolling functionality, so if the
9235 * text set to it is too large to fit in the given space, it will scroll,
9236 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9237 * text can be displayed.
9239 * This widget emits the following signals:
9240 * @li "anchor,clicked": will be called when an anchor is clicked. The
9241 * @p event_info parameter on the callback will be a pointer of type
9242 * ::Elm_Entry_Anchorview_Info.
9244 * See @ref Anchorblock for an example on how to use both of them.
9253 * @typedef Elm_Entry_Anchorview_Info
9255 * The info sent in the callback for "anchor,clicked" signals emitted by
9256 * the Anchorview widget.
9258 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9260 * @struct _Elm_Entry_Anchorview_Info
9262 * The info sent in the callback for "anchor,clicked" signals emitted by
9263 * the Anchorview widget.
9265 struct _Elm_Entry_Anchorview_Info
9267 const char *name; /**< Name of the anchor, as indicated in its href
9269 int button; /**< The mouse button used to click on it */
9270 Evas_Object *hover; /**< The hover object to use for the popup */
9272 Evas_Coord x, y, w, h;
9273 } anchor, /**< Geometry selection of text used as anchor */
9274 hover_parent; /**< Geometry of the object used as parent by the
9276 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9277 for content on the left side of
9278 the hover. Before calling the
9279 callback, the widget will make the
9280 necessary calculations to check
9281 which sides are fit to be set with
9282 content, based on the position the
9283 hover is activated and its distance
9284 to the edges of its parent object
9286 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9287 the right side of the hover.
9288 See @ref hover_left */
9289 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9290 of the hover. See @ref hover_left */
9291 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9292 below the hover. See @ref
9296 * Add a new Anchorview object
9298 * @param parent The parent object
9299 * @return The new object or NULL if it cannot be created
9301 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9303 * Set the text to show in the anchorview
9305 * Sets the text of the anchorview to @p text. This text can include markup
9306 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9307 * text that will be specially styled and react to click events, ended with
9308 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9309 * "anchor,clicked" signal that you can attach a callback to with
9310 * evas_object_smart_callback_add(). The name of the anchor given in the
9311 * event info struct will be the one set in the href attribute, in this
9314 * Other markup can be used to style the text in different ways, but it's
9315 * up to the style defined in the theme which tags do what.
9316 * @deprecated use elm_object_text_set() instead.
9318 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9320 * Get the markup text set for the anchorview
9322 * Retrieves the text set on the anchorview, with markup tags included.
9324 * @param obj The anchorview object
9325 * @return The markup text set or @c NULL if nothing was set or an error
9327 * @deprecated use elm_object_text_set() instead.
9329 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9331 * Set the parent of the hover popup
9333 * Sets the parent object to use by the hover created by the anchorview
9334 * when an anchor is clicked. See @ref Hover for more details on this.
9335 * If no parent is set, the same anchorview object will be used.
9337 * @param obj The anchorview object
9338 * @param parent The object to use as parent for the hover
9340 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9342 * Get the parent of the hover popup
9344 * Get the object used as parent for the hover created by the anchorview
9345 * widget. See @ref Hover for more details on this.
9347 * @param obj The anchorview object
9348 * @return The object used as parent for the hover, NULL if none is set.
9350 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9352 * Set the style that the hover should use
9354 * When creating the popup hover, anchorview will request that it's
9355 * themed according to @p style.
9357 * @param obj The anchorview object
9358 * @param style The style to use for the underlying hover
9360 * @see elm_object_style_set()
9362 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9364 * Get the style that the hover should use
9366 * Get the style the hover created by anchorview will use.
9368 * @param obj The anchorview object
9369 * @return The style to use by the hover. NULL means the default is used.
9371 * @see elm_object_style_set()
9373 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9375 * Ends the hover popup in the anchorview
9377 * When an anchor is clicked, the anchorview widget will create a hover
9378 * object to use as a popup with user provided content. This function
9379 * terminates this popup, returning the anchorview to its normal state.
9381 * @param obj The anchorview object
9383 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9385 * Set bouncing behaviour when the scrolled content reaches an edge
9387 * Tell the internal scroller object whether it should bounce or not
9388 * when it reaches the respective edges for each axis.
9390 * @param obj The anchorview object
9391 * @param h_bounce Whether to bounce or not in the horizontal axis
9392 * @param v_bounce Whether to bounce or not in the vertical axis
9394 * @see elm_scroller_bounce_set()
9396 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9398 * Get the set bouncing behaviour of the internal scroller
9400 * Get whether the internal scroller should bounce when the edge of each
9401 * axis is reached scrolling.
9403 * @param obj The anchorview object
9404 * @param h_bounce Pointer where to store the bounce state of the horizontal
9406 * @param v_bounce Pointer where to store the bounce state of the vertical
9409 * @see elm_scroller_bounce_get()
9411 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9413 * Appends a custom item provider to the given anchorview
9415 * Appends the given function to the list of items providers. This list is
9416 * called, one function at a time, with the given @p data pointer, the
9417 * anchorview object and, in the @p item parameter, the item name as
9418 * referenced in its href string. Following functions in the list will be
9419 * called in order until one of them returns something different to NULL,
9420 * which should be an Evas_Object which will be used in place of the item
9423 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9424 * href=item/name\>\</item\>
9426 * @param obj The anchorview object
9427 * @param func The function to add to the list of providers
9428 * @param data User data that will be passed to the callback function
9430 * @see elm_entry_item_provider_append()
9432 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);
9434 * Prepend a custom item provider to the given anchorview
9436 * Like elm_anchorview_item_provider_append(), but it adds the function
9437 * @p func to the beginning of the list, instead of the end.
9439 * @param obj The anchorview object
9440 * @param func The function to add to the list of providers
9441 * @param data User data that will be passed to the callback function
9443 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);
9445 * Remove a custom item provider from the list of the given anchorview
9447 * Removes the function and data pairing that matches @p func and @p data.
9448 * That is, unless the same function and same user data are given, the
9449 * function will not be removed from the list. This allows us to add the
9450 * same callback several times, with different @p data pointers and be
9451 * able to remove them later without conflicts.
9453 * @param obj The anchorview object
9454 * @param func The function to remove from the list
9455 * @param data The data matching the function to remove from the list
9457 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);
9464 * @defgroup Anchorblock Anchorblock
9466 * @image html img/widget/anchorblock/preview-00.png
9467 * @image latex img/widget/anchorblock/preview-00.eps
9469 * Anchorblock is for displaying text that contains markup with anchors
9470 * like <c>\<a href=1234\>something\</\></c> in it.
9472 * Besides being styled differently, the anchorblock widget provides the
9473 * necessary functionality so that clicking on these anchors brings up a
9474 * popup with user defined content such as "call", "add to contacts" or
9475 * "open web page". This popup is provided using the @ref Hover widget.
9477 * This widget emits the following signals:
9478 * @li "anchor,clicked": will be called when an anchor is clicked. The
9479 * @p event_info parameter on the callback will be a pointer of type
9480 * ::Elm_Entry_Anchorblock_Info.
9486 * Since examples are usually better than plain words, we might as well
9487 * try @ref tutorial_anchorblock_example "one".
9490 * @addtogroup Anchorblock
9494 * @typedef Elm_Entry_Anchorblock_Info
9496 * The info sent in the callback for "anchor,clicked" signals emitted by
9497 * the Anchorblock widget.
9499 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9501 * @struct _Elm_Entry_Anchorblock_Info
9503 * The info sent in the callback for "anchor,clicked" signals emitted by
9504 * the Anchorblock widget.
9506 struct _Elm_Entry_Anchorblock_Info
9508 const char *name; /**< Name of the anchor, as indicated in its href
9510 int button; /**< The mouse button used to click on it */
9511 Evas_Object *hover; /**< The hover object to use for the popup */
9513 Evas_Coord x, y, w, h;
9514 } anchor, /**< Geometry selection of text used as anchor */
9515 hover_parent; /**< Geometry of the object used as parent by the
9517 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9518 for content on the left side of
9519 the hover. Before calling the
9520 callback, the widget will make the
9521 necessary calculations to check
9522 which sides are fit to be set with
9523 content, based on the position the
9524 hover is activated and its distance
9525 to the edges of its parent object
9527 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9528 the right side of the hover.
9529 See @ref hover_left */
9530 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9531 of the hover. See @ref hover_left */
9532 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9533 below the hover. See @ref
9537 * Add a new Anchorblock object
9539 * @param parent The parent object
9540 * @return The new object or NULL if it cannot be created
9542 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9544 * Set the text to show in the anchorblock
9546 * Sets the text of the anchorblock to @p text. This text can include markup
9547 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9548 * of text that will be specially styled and react to click events, ended
9549 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9550 * "anchor,clicked" signal that you can attach a callback to with
9551 * evas_object_smart_callback_add(). The name of the anchor given in the
9552 * event info struct will be the one set in the href attribute, in this
9555 * Other markup can be used to style the text in different ways, but it's
9556 * up to the style defined in the theme which tags do what.
9557 * @deprecated use elm_object_text_set() instead.
9559 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9561 * Get the markup text set for the anchorblock
9563 * Retrieves the text set on the anchorblock, with markup tags included.
9565 * @param obj The anchorblock object
9566 * @return The markup text set or @c NULL if nothing was set or an error
9568 * @deprecated use elm_object_text_set() instead.
9570 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9572 * Set the parent of the hover popup
9574 * Sets the parent object to use by the hover created by the anchorblock
9575 * when an anchor is clicked. See @ref Hover for more details on this.
9577 * @param obj The anchorblock object
9578 * @param parent The object to use as parent for the hover
9580 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9582 * Get the parent of the hover popup
9584 * Get the object used as parent for the hover created by the anchorblock
9585 * widget. See @ref Hover for more details on this.
9586 * If no parent is set, the same anchorblock object will be used.
9588 * @param obj The anchorblock object
9589 * @return The object used as parent for the hover, NULL if none is set.
9591 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9593 * Set the style that the hover should use
9595 * When creating the popup hover, anchorblock will request that it's
9596 * themed according to @p style.
9598 * @param obj The anchorblock object
9599 * @param style The style to use for the underlying hover
9601 * @see elm_object_style_set()
9603 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9605 * Get the style that the hover should use
9607 * Get the style the hover created by anchorblock will use.
9609 * @param obj The anchorblock object
9610 * @return The style to use by the hover. NULL means the default is used.
9612 * @see elm_object_style_set()
9614 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9616 * Ends the hover popup in the anchorblock
9618 * When an anchor is clicked, the anchorblock widget will create a hover
9619 * object to use as a popup with user provided content. This function
9620 * terminates this popup, returning the anchorblock to its normal state.
9622 * @param obj The anchorblock object
9624 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9626 * Appends a custom item provider to the given anchorblock
9628 * Appends the given function to the list of items providers. This list is
9629 * called, one function at a time, with the given @p data pointer, the
9630 * anchorblock object and, in the @p item parameter, the item name as
9631 * referenced in its href string. Following functions in the list will be
9632 * called in order until one of them returns something different to NULL,
9633 * which should be an Evas_Object which will be used in place of the item
9636 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9637 * href=item/name\>\</item\>
9639 * @param obj The anchorblock object
9640 * @param func The function to add to the list of providers
9641 * @param data User data that will be passed to the callback function
9643 * @see elm_entry_item_provider_append()
9645 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);
9647 * Prepend a custom item provider to the given anchorblock
9649 * Like elm_anchorblock_item_provider_append(), but it adds the function
9650 * @p func to the beginning of the list, instead of the end.
9652 * @param obj The anchorblock object
9653 * @param func The function to add to the list of providers
9654 * @param data User data that will be passed to the callback function
9656 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);
9658 * Remove a custom item provider from the list of the given anchorblock
9660 * Removes the function and data pairing that matches @p func and @p data.
9661 * That is, unless the same function and same user data are given, the
9662 * function will not be removed from the list. This allows us to add the
9663 * same callback several times, with different @p data pointers and be
9664 * able to remove them later without conflicts.
9666 * @param obj The anchorblock object
9667 * @param func The function to remove from the list
9668 * @param data The data matching the function to remove from the list
9670 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);
9676 * @defgroup Bubble Bubble
9678 * @image html img/widget/bubble/preview-00.png
9679 * @image html img/widget/bubble/preview-01.png
9680 * @image html img/widget/bubble/preview-02.png
9682 * @brief The Bubble is a widget to show text similarly to how speech is
9683 * represented in comics.
9685 * The bubble widget contains 5 important visual elements:
9686 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9687 * @li The @p icon is an image to which the frame's arrow points to.
9688 * @li The @p label is a text which appears to the right of the icon if the
9689 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9691 * @li The @p info is a text which appears to the right of the label. Info's
9692 * font is of a ligther color than label.
9693 * @li The @p content is an evas object that is shown inside the frame.
9695 * The position of the arrow, icon, label and info depends on which corner is
9696 * selected. The four available corners are:
9697 * @li "top_left" - Default
9700 * @li "bottom_right"
9702 * Signals that you can add callbacks for are:
9703 * @li "clicked" - This is called when a user has clicked the bubble.
9705 * For an example of using a buble see @ref bubble_01_example_page "this".
9710 * Add a new bubble to the parent
9712 * @param parent The parent object
9713 * @return The new object or NULL if it cannot be created
9715 * This function adds a text bubble to the given parent evas object.
9717 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9719 * Set the label of the bubble
9721 * @param obj The bubble object
9722 * @param label The string to set in the label
9724 * This function sets the title of the bubble. Where this appears depends on
9725 * the selected corner.
9726 * @deprecated use elm_object_text_set() instead.
9728 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9730 * Get the label of the bubble
9732 * @param obj The bubble object
9733 * @return The string of set in the label
9735 * This function gets the title of the bubble.
9736 * @deprecated use elm_object_text_set() instead.
9738 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9740 * Set the info of the bubble
9742 * @param obj The bubble object
9743 * @param info The given info about the bubble
9745 * This function sets the info of the bubble. Where this appears depends on
9746 * the selected corner.
9747 * @deprecated use elm_object_text_set() instead.
9749 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9751 * Get the info of the bubble
9753 * @param obj The bubble object
9755 * @return The "info" string of the bubble
9757 * This function gets the info text.
9758 * @deprecated use elm_object_text_set() instead.
9760 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9762 * Set the content to be shown in the bubble
9764 * Once the content object is set, a previously set one will be deleted.
9765 * If you want to keep the old content object, use the
9766 * elm_bubble_content_unset() function.
9768 * @param obj The bubble object
9769 * @param content The given content of the bubble
9771 * This function sets the content shown on the middle of the bubble.
9773 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9775 * Get the content shown in the bubble
9777 * Return the content object which is set for this widget.
9779 * @param obj The bubble object
9780 * @return The content that is being used
9782 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9784 * Unset the content shown in the bubble
9786 * Unparent and return the content object which was set for this widget.
9788 * @param obj The bubble object
9789 * @return The content that was being used
9791 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9793 * Set the icon of the bubble
9795 * Once the icon object is set, a previously set one will be deleted.
9796 * If you want to keep the old content object, use the
9797 * elm_icon_content_unset() function.
9799 * @param obj The bubble object
9800 * @param icon The given icon for the bubble
9802 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9804 * Get the icon of the bubble
9806 * @param obj The bubble object
9807 * @return The icon for the bubble
9809 * This function gets the icon shown on the top left of bubble.
9811 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9813 * Unset the icon of the bubble
9815 * Unparent and return the icon object which was set for this widget.
9817 * @param obj The bubble object
9818 * @return The icon that was being used
9820 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9822 * Set the corner of the bubble
9824 * @param obj The bubble object.
9825 * @param corner The given corner for the bubble.
9827 * This function sets the corner of the bubble. The corner will be used to
9828 * determine where the arrow in the frame points to and where label, icon and
9831 * Possible values for corner are:
9832 * @li "top_left" - Default
9835 * @li "bottom_right"
9837 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9839 * Get the corner of the bubble
9841 * @param obj The bubble object.
9842 * @return The given corner for the bubble.
9844 * This function gets the selected corner of the bubble.
9846 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9852 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9853 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9854 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9855 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9856 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9857 /* smart callbacks called:
9858 * "clicked" - the user clicked the icon
9859 * "drag,start" - Someone started dragging the image out of the object
9860 * "drag,end" - Dragged item was dropped (somewhere)
9865 * @defgroup Elm_Gesture_Layer Gesture Layer
9866 * Gesture Layer Usage:
9868 * Use Gesture Layer to detect gestures.
9869 * The advantage is that you don't have to implement
9870 * gesture detection, just set callbacks of gesture state.
9871 * By using gesture layer we make standard interface.
9873 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9874 * with a parent object parameter.
9875 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9876 * call. Usually with same object as target (2nd parameter).
9878 * Now you need to tell gesture layer what gestures you follow.
9879 * This is done with @ref elm_gesture_layer_cb_set call.
9880 * By setting the callback you actually saying to gesture layer:
9881 * I would like to know when the gesture @ref Elm_Gesture_Types
9882 * switches to state @ref Elm_Gesture_State.
9884 * Next, you need to implement the actual action that follows the input
9887 * Note that if you like to stop being reported about a gesture, just set
9888 * all callbacks referring this gesture to NULL.
9889 * (again with @ref elm_gesture_layer_cb_set)
9891 * The information reported by gesture layer to your callback is depending
9892 * on @ref Elm_Gesture_Types:
9893 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9894 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9895 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9897 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9898 * @ref ELM_GESTURE_MOMENTUM.
9900 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9901 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9902 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9903 * Note that we consider a flick as a line-gesture that should be completed
9904 * in flick-time-limit as defined in @ref Config.
9906 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9908 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9912 * @enum _Elm_Gesture_Types
9913 * Enum of supported gesture types.
9914 * @ingroup Elm_Gesture_Layer
9916 enum _Elm_Gesture_Types
9918 ELM_GESTURE_FIRST = 0,
9920 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9921 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9922 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9923 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9925 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9927 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9928 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9930 ELM_GESTURE_ZOOM, /**< Zoom */
9931 ELM_GESTURE_ROTATE, /**< Rotate */
9937 * @typedef Elm_Gesture_Types
9938 * gesture types enum
9939 * @ingroup Elm_Gesture_Layer
9941 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9944 * @enum _Elm_Gesture_State
9945 * Enum of gesture states.
9946 * @ingroup Elm_Gesture_Layer
9948 enum _Elm_Gesture_State
9950 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9951 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9952 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9953 ELM_GESTURE_STATE_END, /**< Gesture completed */
9954 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9958 * @typedef Elm_Gesture_State
9959 * gesture states enum
9960 * @ingroup Elm_Gesture_Layer
9962 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9965 * @struct _Elm_Gesture_Taps_Info
9966 * Struct holds taps info for user
9967 * @ingroup Elm_Gesture_Layer
9969 struct _Elm_Gesture_Taps_Info
9971 Evas_Coord x, y; /**< Holds center point between fingers */
9972 unsigned int n; /**< Number of fingers tapped */
9973 unsigned int timestamp; /**< event timestamp */
9977 * @typedef Elm_Gesture_Taps_Info
9978 * holds taps info for user
9979 * @ingroup Elm_Gesture_Layer
9981 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
9984 * @struct _Elm_Gesture_Momentum_Info
9985 * Struct holds momentum info for user
9986 * x1 and y1 are not necessarily in sync
9987 * x1 holds x value of x direction starting point
9988 * and same holds for y1.
9989 * This is noticeable when doing V-shape movement
9990 * @ingroup Elm_Gesture_Layer
9992 struct _Elm_Gesture_Momentum_Info
9993 { /* Report line ends, timestamps, and momentum computed */
9994 Evas_Coord x1; /**< Final-swipe direction starting point on X */
9995 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
9996 Evas_Coord x2; /**< Final-swipe direction ending point on X */
9997 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
9999 unsigned int tx; /**< Timestamp of start of final x-swipe */
10000 unsigned int ty; /**< Timestamp of start of final y-swipe */
10002 Evas_Coord mx; /**< Momentum on X */
10003 Evas_Coord my; /**< Momentum on Y */
10007 * @typedef Elm_Gesture_Momentum_Info
10008 * holds momentum info for user
10009 * @ingroup Elm_Gesture_Layer
10011 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10014 * @struct _Elm_Gesture_Line_Info
10015 * Struct holds line info for user
10016 * @ingroup Elm_Gesture_Layer
10018 struct _Elm_Gesture_Line_Info
10019 { /* Report line ends, timestamps, and momentum computed */
10020 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10021 unsigned int n; /**< Number of fingers (lines) */
10022 /* FIXME should be radians, bot degrees */
10023 double angle; /**< Angle (direction) of lines */
10027 * @typedef Elm_Gesture_Line_Info
10028 * Holds line info for user
10029 * @ingroup Elm_Gesture_Layer
10031 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10034 * @struct _Elm_Gesture_Zoom_Info
10035 * Struct holds zoom info for user
10036 * @ingroup Elm_Gesture_Layer
10038 struct _Elm_Gesture_Zoom_Info
10040 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10041 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10042 double zoom; /**< Zoom value: 1.0 means no zoom */
10043 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10047 * @typedef Elm_Gesture_Zoom_Info
10048 * Holds zoom info for user
10049 * @ingroup Elm_Gesture_Layer
10051 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10054 * @struct _Elm_Gesture_Rotate_Info
10055 * Struct holds rotation info for user
10056 * @ingroup Elm_Gesture_Layer
10058 struct _Elm_Gesture_Rotate_Info
10060 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10061 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10062 double base_angle; /**< Holds start-angle */
10063 double angle; /**< Rotation value: 0.0 means no rotation */
10064 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10068 * @typedef Elm_Gesture_Rotate_Info
10069 * Holds rotation info for user
10070 * @ingroup Elm_Gesture_Layer
10072 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10075 * @typedef Elm_Gesture_Event_Cb
10076 * User callback used to stream gesture info from gesture layer
10077 * @param data user data
10078 * @param event_info gesture report info
10079 * Returns a flag field to be applied on the causing event.
10080 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10081 * upon the event, in an irreversible way.
10083 * @ingroup Elm_Gesture_Layer
10085 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10088 * Use function to set callbacks to be notified about
10089 * change of state of gesture.
10090 * When a user registers a callback with this function
10091 * this means this gesture has to be tested.
10093 * When ALL callbacks for a gesture are set to NULL
10094 * it means user isn't interested in gesture-state
10095 * and it will not be tested.
10097 * @param obj Pointer to gesture-layer.
10098 * @param idx The gesture you would like to track its state.
10099 * @param cb callback function pointer.
10100 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10101 * @param data user info to be sent to callback (usually, Smart Data)
10103 * @ingroup Elm_Gesture_Layer
10105 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);
10108 * Call this function to get repeat-events settings.
10110 * @param obj Pointer to gesture-layer.
10112 * @return repeat events settings.
10113 * @see elm_gesture_layer_hold_events_set()
10114 * @ingroup Elm_Gesture_Layer
10116 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10119 * This function called in order to make gesture-layer repeat events.
10120 * Set this of you like to get the raw events only if gestures were not detected.
10121 * Clear this if you like gesture layer to fwd events as testing gestures.
10123 * @param obj Pointer to gesture-layer.
10124 * @param r Repeat: TRUE/FALSE
10126 * @ingroup Elm_Gesture_Layer
10128 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10131 * This function sets step-value for zoom action.
10132 * Set step to any positive value.
10133 * Cancel step setting by setting to 0.0
10135 * @param obj Pointer to gesture-layer.
10136 * @param s new zoom step value.
10138 * @ingroup Elm_Gesture_Layer
10140 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10143 * This function sets step-value for rotate action.
10144 * Set step to any positive value.
10145 * Cancel step setting by setting to 0.0
10147 * @param obj Pointer to gesture-layer.
10148 * @param s new roatate step value.
10150 * @ingroup Elm_Gesture_Layer
10152 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10155 * This function called to attach gesture-layer to an Evas_Object.
10156 * @param obj Pointer to gesture-layer.
10157 * @param t Pointer to underlying object (AKA Target)
10159 * @return TRUE, FALSE on success, failure.
10161 * @ingroup Elm_Gesture_Layer
10163 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10166 * Call this function to construct a new gesture-layer object.
10167 * This does not activate the gesture layer. You have to
10168 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10170 * @param parent the parent object.
10172 * @return Pointer to new gesture-layer object.
10174 * @ingroup Elm_Gesture_Layer
10176 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10179 * @defgroup Thumb Thumb
10181 * @image html img/widget/thumb/preview-00.png
10182 * @image latex img/widget/thumb/preview-00.eps
10184 * A thumb object is used for displaying the thumbnail of an image or video.
10185 * You must have compiled Elementary with Ethumb_Client support and the DBus
10186 * service must be present and auto-activated in order to have thumbnails to
10189 * Once the thumbnail object becomes visible, it will check if there is a
10190 * previously generated thumbnail image for the file set on it. If not, it
10191 * will start generating this thumbnail.
10193 * Different config settings will cause different thumbnails to be generated
10194 * even on the same file.
10196 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10197 * Ethumb documentation to change this path, and to see other configuration
10200 * Signals that you can add callbacks for are:
10202 * - "clicked" - This is called when a user has clicked the thumb without dragging
10204 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10205 * - "press" - This is called when a user has pressed down the thumb.
10206 * - "generate,start" - The thumbnail generation started.
10207 * - "generate,stop" - The generation process stopped.
10208 * - "generate,error" - The generation failed.
10209 * - "load,error" - The thumbnail image loading failed.
10211 * available styles:
10215 * An example of use of thumbnail:
10217 * - @ref thumb_example_01
10221 * @addtogroup Thumb
10226 * @enum _Elm_Thum_Animation_Setting
10227 * @typedef Elm_Thumb_Animation_Setting
10229 * Used to set if a video thumbnail is animating or not.
10233 typedef enum _Elm_Thumb_Animation_Setting
10235 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10236 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10237 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10238 ELM_THUMB_ANIMATION_LAST
10239 } Elm_Thumb_Animation_Setting;
10242 * Add a new thumb object to the parent.
10244 * @param parent The parent object.
10245 * @return The new object or NULL if it cannot be created.
10247 * @see elm_thumb_file_set()
10248 * @see elm_thumb_ethumb_client_get()
10252 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10254 * Reload thumbnail if it was generated before.
10256 * @param obj The thumb object to reload
10258 * This is useful if the ethumb client configuration changed, like its
10259 * size, aspect or any other property one set in the handle returned
10260 * by elm_thumb_ethumb_client_get().
10262 * If the options didn't change, the thumbnail won't be generated again, but
10263 * the old one will still be used.
10265 * @see elm_thumb_file_set()
10269 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10271 * Set the file that will be used as thumbnail.
10273 * @param obj The thumb object.
10274 * @param file The path to file that will be used as thumb.
10275 * @param key The key used in case of an EET file.
10277 * The file can be an image or a video (in that case, acceptable extensions are:
10278 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10279 * function elm_thumb_animate().
10281 * @see elm_thumb_file_get()
10282 * @see elm_thumb_reload()
10283 * @see elm_thumb_animate()
10287 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10289 * Get the image or video path and key used to generate the thumbnail.
10291 * @param obj The thumb object.
10292 * @param file Pointer to filename.
10293 * @param key Pointer to key.
10295 * @see elm_thumb_file_set()
10296 * @see elm_thumb_path_get()
10300 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10302 * Get the path and key to the image or video generated by ethumb.
10304 * One just need to make sure that the thumbnail was generated before getting
10305 * its path; otherwise, the path will be NULL. One way to do that is by asking
10306 * for the path when/after the "generate,stop" smart callback is called.
10308 * @param obj The thumb object.
10309 * @param file Pointer to thumb path.
10310 * @param key Pointer to thumb key.
10312 * @see elm_thumb_file_get()
10316 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10318 * Set the animation state for the thumb object. If its content is an animated
10319 * video, you may start/stop the animation or tell it to play continuously and
10322 * @param obj The thumb object.
10323 * @param setting The animation setting.
10325 * @see elm_thumb_file_set()
10329 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10331 * Get the animation state for the thumb object.
10333 * @param obj The thumb object.
10334 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10337 * @see elm_thumb_animate_set()
10341 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10343 * Get the ethumb_client handle so custom configuration can be made.
10345 * @return Ethumb_Client instance or NULL.
10347 * This must be called before the objects are created to be sure no object is
10348 * visible and no generation started.
10350 * Example of usage:
10353 * #include <Elementary.h>
10354 * #ifndef ELM_LIB_QUICKLAUNCH
10356 * elm_main(int argc, char **argv)
10358 * Ethumb_Client *client;
10360 * elm_need_ethumb();
10364 * client = elm_thumb_ethumb_client_get();
10367 * ERR("could not get ethumb_client");
10370 * ethumb_client_size_set(client, 100, 100);
10371 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10374 * // Create elm_thumb objects here
10384 * @note There's only one client handle for Ethumb, so once a configuration
10385 * change is done to it, any other request for thumbnails (for any thumbnail
10386 * object) will use that configuration. Thus, this configuration is global.
10390 EAPI void *elm_thumb_ethumb_client_get(void);
10392 * Get the ethumb_client connection state.
10394 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10397 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10399 * Make the thumbnail 'editable'.
10401 * @param obj Thumb object.
10402 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10404 * This means the thumbnail is a valid drag target for drag and drop, and can be
10405 * cut or pasted too.
10407 * @seee elm_thumb_editable_get()
10411 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10413 * Make the thumbnail 'editable'.
10415 * @param obj Thumb object.
10416 * @return Editability.
10418 * This means the thumbnail is a valid drag target for drag and drop, and can be
10419 * cut or pasted too.
10421 * @seee elm_thumb_editable_set()
10425 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10432 * @defgroup Hoversel
10434 * @image html img/widget/hoversel/preview-00.png
10435 * @image latex img/widget/hoversel/preview-00.eps
10437 * A hoversel is a button that pops up a list of items (automatically
10438 * choosing the direction to display) that have a label and, optionally, an
10439 * icon to select from. It is a convenience widget to avoid the need to do
10440 * all the piecing together yourself. It is intended for a small number of
10441 * items in the hoversel menu (no more than 8), though is capable of many
10444 * Signals that you can add callbacks for are:
10445 * "clicked" - the user clicked the hoversel button and popped up the sel
10446 * "selected" - an item in the hoversel list is selected. event_info is the item
10447 * "dismissed" - the hover is dismissed
10449 * See @ref tutorial_hoversel for an example.
10452 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10454 * @brief Add a new Hoversel object
10456 * @param parent The parent object
10457 * @return The new object or NULL if it cannot be created
10459 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10461 * @brief This sets the hoversel to expand horizontally.
10463 * @param obj The hoversel object
10464 * @param horizontal If true, the hover will expand horizontally to the
10467 * @note The initial button will display horizontally regardless of this
10470 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10472 * @brief This returns whether the hoversel is set to expand horizontally.
10474 * @param obj The hoversel object
10475 * @return If true, the hover will expand horizontally to the right.
10477 * @see elm_hoversel_horizontal_set()
10479 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10481 * @brief Set the Hover parent
10483 * @param obj The hoversel object
10484 * @param parent The parent to use
10486 * Sets the hover parent object, the area that will be darkened when the
10487 * hoversel is clicked. Should probably be the window that the hoversel is
10488 * in. See @ref Hover objects for more information.
10490 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10492 * @brief Get the Hover parent
10494 * @param obj The hoversel object
10495 * @return The used parent
10497 * Gets the hover parent object.
10499 * @see elm_hoversel_hover_parent_set()
10501 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10503 * @brief Set the hoversel button label
10505 * @param obj The hoversel object
10506 * @param label The label text.
10508 * This sets the label of the button that is always visible (before it is
10509 * clicked and expanded).
10511 * @deprecated elm_object_text_set()
10513 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10515 * @brief Get the hoversel button label
10517 * @param obj The hoversel object
10518 * @return The label text.
10520 * @deprecated elm_object_text_get()
10522 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10524 * @brief Set the icon of the hoversel button
10526 * @param obj The hoversel object
10527 * @param icon The icon object
10529 * Sets the icon of the button that is always visible (before it is clicked
10530 * and expanded). Once the icon object is set, a previously set one will be
10531 * deleted, if you want to keep that old content object, use the
10532 * elm_hoversel_icon_unset() function.
10534 * @see elm_button_icon_set()
10536 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10538 * @brief Get the icon of the hoversel button
10540 * @param obj The hoversel object
10541 * @return The icon object
10543 * Get the icon of the button that is always visible (before it is clicked
10544 * and expanded). Also see elm_button_icon_get().
10546 * @see elm_hoversel_icon_set()
10548 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10550 * @brief Get and unparent the icon of the hoversel button
10552 * @param obj The hoversel object
10553 * @return The icon object that was being used
10555 * Unparent and return the icon of the button that is always visible
10556 * (before it is clicked and expanded).
10558 * @see elm_hoversel_icon_set()
10559 * @see elm_button_icon_unset()
10561 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10563 * @brief This triggers the hoversel popup from code, the same as if the user
10564 * had clicked the button.
10566 * @param obj The hoversel object
10568 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10570 * @brief This dismisses the hoversel popup as if the user had clicked
10571 * outside the hover.
10573 * @param obj The hoversel object
10575 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10577 * @brief Returns whether the hoversel is expanded.
10579 * @param obj The hoversel object
10580 * @return This will return EINA_TRUE if the hoversel is expanded or
10581 * EINA_FALSE if it is not expanded.
10583 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10585 * @brief This will remove all the children items from the hoversel.
10587 * @param obj The hoversel object
10589 * @warning Should @b not be called while the hoversel is active; use
10590 * elm_hoversel_expanded_get() to check first.
10592 * @see elm_hoversel_item_del_cb_set()
10593 * @see elm_hoversel_item_del()
10595 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10597 * @brief Get the list of items within the given hoversel.
10599 * @param obj The hoversel object
10600 * @return Returns a list of Elm_Hoversel_Item*
10602 * @see elm_hoversel_item_add()
10604 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10606 * @brief Add an item to the hoversel button
10608 * @param obj The hoversel object
10609 * @param label The text label to use for the item (NULL if not desired)
10610 * @param icon_file An image file path on disk to use for the icon or standard
10611 * icon name (NULL if not desired)
10612 * @param icon_type The icon type if relevant
10613 * @param func Convenience function to call when this item is selected
10614 * @param data Data to pass to item-related functions
10615 * @return A handle to the item added.
10617 * This adds an item to the hoversel to show when it is clicked. Note: if you
10618 * need to use an icon from an edje file then use
10619 * elm_hoversel_item_icon_set() right after the this function, and set
10620 * icon_file to NULL here.
10622 * For more information on what @p icon_file and @p icon_type are see the
10623 * @ref Icon "icon documentation".
10625 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);
10627 * @brief Delete an item from the hoversel
10629 * @param item The item to delete
10631 * This deletes the item from the hoversel (should not be called while the
10632 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10634 * @see elm_hoversel_item_add()
10635 * @see elm_hoversel_item_del_cb_set()
10637 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10639 * @brief Set the function to be called when an item from the hoversel is
10642 * @param item The item to set the callback on
10643 * @param func The function called
10645 * That function will receive these parameters:
10646 * @li void *item_data
10647 * @li Evas_Object *the_item_object
10648 * @li Elm_Hoversel_Item *the_object_struct
10650 * @see elm_hoversel_item_add()
10652 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10654 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10655 * that will be passed to associated function callbacks.
10657 * @param item The item to get the data from
10658 * @return The data pointer set with elm_hoversel_item_add()
10660 * @see elm_hoversel_item_add()
10662 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10664 * @brief This returns the label text of the given hoversel item.
10666 * @param item The item to get the label
10667 * @return The label text of the hoversel item
10669 * @see elm_hoversel_item_add()
10671 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10673 * @brief This sets the icon for the given hoversel item.
10675 * @param item The item to set the icon
10676 * @param icon_file An image file path on disk to use for the icon or standard
10678 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10679 * to NULL if the icon is not an edje file
10680 * @param icon_type The icon type
10682 * The icon can be loaded from the standard set, from an image file, or from
10685 * @see elm_hoversel_item_add()
10687 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);
10689 * @brief Get the icon object of the hoversel item
10691 * @param item The item to get the icon from
10692 * @param icon_file The image file path on disk used for the icon or standard
10694 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10695 * if the icon is not an edje file
10696 * @param icon_type The icon type
10698 * @see elm_hoversel_item_icon_set()
10699 * @see elm_hoversel_item_add()
10701 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);
10707 * @defgroup Toolbar Toolbar
10708 * @ingroup Elementary
10710 * @image html img/widget/toolbar/preview-00.png
10711 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10713 * @image html img/toolbar.png
10714 * @image latex img/toolbar.eps width=\textwidth
10716 * A toolbar is a widget that displays a list of items inside
10717 * a box. It can be scrollable, show a menu with items that don't fit
10718 * to toolbar size or even crop them.
10720 * Only one item can be selected at a time.
10722 * Items can have multiple states, or show menus when selected by the user.
10724 * Smart callbacks one can listen to:
10725 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10727 * Available styles for it:
10729 * - @c "transparent" - no background or shadow, just show the content
10731 * List of examples:
10732 * @li @ref toolbar_example_01
10733 * @li @ref toolbar_example_02
10734 * @li @ref toolbar_example_03
10738 * @addtogroup Toolbar
10743 * @enum _Elm_Toolbar_Shrink_Mode
10744 * @typedef Elm_Toolbar_Shrink_Mode
10746 * Set toolbar's items display behavior, it can be scrollabel,
10747 * show a menu with exceeding items, or simply hide them.
10749 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10752 * Values <b> don't </b> work as bitmaks, only one can be choosen.
10754 * @see elm_toolbar_mode_shrink_set()
10755 * @see elm_toolbar_mode_shrink_get()
10759 typedef enum _Elm_Toolbar_Shrink_Mode
10761 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10762 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10763 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10764 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10765 } Elm_Toolbar_Shrink_Mode;
10767 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
10769 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
10772 * Add a new toolbar widget to the given parent Elementary
10773 * (container) object.
10775 * @param parent The parent object.
10776 * @return a new toolbar widget handle or @c NULL, on errors.
10778 * This function inserts a new toolbar widget on the canvas.
10782 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10785 * Set the icon size, in pixels, to be used by toolbar items.
10787 * @param obj The toolbar object
10788 * @param icon_size The icon size in pixels
10790 * @note Default value is @c 32. It reads value from elm config.
10792 * @see elm_toolbar_icon_size_get()
10796 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10799 * Get the icon size, in pixels, to be used by toolbar items.
10801 * @param obj The toolbar object.
10802 * @return The icon size in pixels.
10804 * @see elm_toolbar_icon_size_set() for details.
10808 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10811 * Sets icon lookup order, for toolbar items' icons.
10813 * @param obj The toolbar object.
10814 * @param order The icon lookup order.
10816 * Icons added before calling this function will not be affected.
10817 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10819 * @see elm_toolbar_icon_order_lookup_get()
10823 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10826 * Gets the icon lookup order.
10828 * @param obj The toolbar object.
10829 * @return The icon lookup order.
10831 * @see elm_toolbar_icon_order_lookup_set() for details.
10835 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10838 * Set whether the toolbar items' should be selected by the user or not.
10840 * @param obj The toolbar object.
10841 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10844 * This will turn off the ability to select items entirely and they will
10845 * neither appear selected nor emit selected signals. The clicked
10846 * callback function will still be called.
10848 * Selection is enabled by default.
10850 * @see elm_toolbar_no_select_mode_get().
10854 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10857 * Set whether the toolbar items' should be selected by the user or not.
10859 * @param obj The toolbar object.
10860 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10861 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10863 * @see elm_toolbar_no_select_mode_set() for details.
10867 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10870 * Append item to the toolbar.
10872 * @param obj The toolbar object.
10873 * @param icon A string with icon name or the absolute path of an image file.
10874 * @param label The label of the item.
10875 * @param func The function to call when the item is clicked.
10876 * @param data The data to associate with the item for related callbacks.
10877 * @return The created item or @c NULL upon failure.
10879 * A new item will be created and appended to the toolbar, i.e., will
10880 * be set as @b last item.
10882 * Items created with this method can be deleted with
10883 * elm_toolbar_item_del().
10885 * Associated @p data can be properly freed when item is deleted if a
10886 * callback function is set with elm_toolbar_item_del_cb_set().
10888 * If a function is passed as argument, it will be called everytime this item
10889 * is selected, i.e., the user clicks over an unselected item.
10890 * If such function isn't needed, just passing
10891 * @c NULL as @p func is enough. The same should be done for @p data.
10893 * Toolbar will load icon image from fdo or current theme.
10894 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10895 * If an absolute path is provided it will load it direct from a file.
10897 * @see elm_toolbar_item_icon_set()
10898 * @see elm_toolbar_item_del()
10899 * @see elm_toolbar_item_del_cb_set()
10903 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);
10906 * Prepend item to the toolbar.
10908 * @param obj The toolbar object.
10909 * @param icon A string with icon name or the absolute path of an image file.
10910 * @param label The label of the item.
10911 * @param func The function to call when the item is clicked.
10912 * @param data The data to associate with the item for related callbacks.
10913 * @return The created item or @c NULL upon failure.
10915 * A new item will be created and prepended to the toolbar, i.e., will
10916 * be set as @b first item.
10918 * Items created with this method can be deleted with
10919 * elm_toolbar_item_del().
10921 * Associated @p data can be properly freed when item is deleted if a
10922 * callback function is set with elm_toolbar_item_del_cb_set().
10924 * If a function is passed as argument, it will be called everytime this item
10925 * is selected, i.e., the user clicks over an unselected item.
10926 * If such function isn't needed, just passing
10927 * @c NULL as @p func is enough. The same should be done for @p data.
10929 * Toolbar will load icon image from fdo or current theme.
10930 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10931 * If an absolute path is provided it will load it direct from a file.
10933 * @see elm_toolbar_item_icon_set()
10934 * @see elm_toolbar_item_del()
10935 * @see elm_toolbar_item_del_cb_set()
10939 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);
10942 * Insert a new item into the toolbar object before item @p before.
10944 * @param obj The toolbar object.
10945 * @param before The toolbar item to insert before.
10946 * @param icon A string with icon name or the absolute path of an image file.
10947 * @param label The label of the item.
10948 * @param func The function to call when the item is clicked.
10949 * @param data The data to associate with the item for related callbacks.
10950 * @return The created item or @c NULL upon failure.
10952 * A new item will be created and added to the toolbar. Its position in
10953 * this toolbar will be just before item @p before.
10955 * Items created with this method can be deleted with
10956 * elm_toolbar_item_del().
10958 * Associated @p data can be properly freed when item is deleted if a
10959 * callback function is set with elm_toolbar_item_del_cb_set().
10961 * If a function is passed as argument, it will be called everytime this item
10962 * is selected, i.e., the user clicks over an unselected item.
10963 * If such function isn't needed, just passing
10964 * @c NULL as @p func is enough. The same should be done for @p data.
10966 * Toolbar will load icon image from fdo or current theme.
10967 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10968 * If an absolute path is provided it will load it direct from a file.
10970 * @see elm_toolbar_item_icon_set()
10971 * @see elm_toolbar_item_del()
10972 * @see elm_toolbar_item_del_cb_set()
10976 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);
10979 * Insert a new item into the toolbar object after item @p after.
10981 * @param obj The toolbar object.
10982 * @param before The toolbar item to insert before.
10983 * @param icon A string with icon name or the absolute path of an image file.
10984 * @param label The label of the item.
10985 * @param func The function to call when the item is clicked.
10986 * @param data The data to associate with the item for related callbacks.
10987 * @return The created item or @c NULL upon failure.
10989 * A new item will be created and added to the toolbar. Its position in
10990 * this toolbar will be just after item @p after.
10992 * Items created with this method can be deleted with
10993 * elm_toolbar_item_del().
10995 * Associated @p data can be properly freed when item is deleted if a
10996 * callback function is set with elm_toolbar_item_del_cb_set().
10998 * If a function is passed as argument, it will be called everytime this item
10999 * is selected, i.e., the user clicks over an unselected item.
11000 * If such function isn't needed, just passing
11001 * @c NULL as @p func is enough. The same should be done for @p data.
11003 * Toolbar will load icon image from fdo or current theme.
11004 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11005 * If an absolute path is provided it will load it direct from a file.
11007 * @see elm_toolbar_item_icon_set()
11008 * @see elm_toolbar_item_del()
11009 * @see elm_toolbar_item_del_cb_set()
11013 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);
11016 * Get the first item in the given toolbar widget's list of
11019 * @param obj The toolbar object
11020 * @return The first item or @c NULL, if it has no items (and on
11023 * @see elm_toolbar_item_append()
11024 * @see elm_toolbar_last_item_get()
11028 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11031 * Get the last item in the given toolbar widget's list of
11034 * @param obj The toolbar object
11035 * @return The last item or @c NULL, if it has no items (and on
11038 * @see elm_toolbar_item_prepend()
11039 * @see elm_toolbar_first_item_get()
11043 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11046 * Get the item after @p item in toolbar.
11048 * @param item The toolbar item.
11049 * @return The item after @p item, or @c NULL if none or on failure.
11051 * @note If it is the last item, @c NULL will be returned.
11053 * @see elm_toolbar_item_append()
11057 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11060 * Get the item before @p item in toolbar.
11062 * @param item The toolbar item.
11063 * @return The item before @p item, or @c NULL if none or on failure.
11065 * @note If it is the first item, @c NULL will be returned.
11067 * @see elm_toolbar_item_prepend()
11071 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11074 * Get the toolbar object from an item.
11076 * @param item The item.
11077 * @return The toolbar object.
11079 * This returns the toolbar object itself that an item belongs to.
11083 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11086 * Set the priority of a toolbar item.
11088 * @param item The toolbar item.
11089 * @param priority The item priority. The default is zero.
11091 * This is used only when the toolbar shrink mode is set to
11092 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11093 * When space is less than required, items with low priority
11094 * will be removed from the toolbar and added to a dynamically-created menu,
11095 * while items with higher priority will remain on the toolbar,
11096 * with the same order they were added.
11098 * @see elm_toolbar_item_priority_get()
11102 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11105 * Get the priority of a toolbar item.
11107 * @param item The toolbar item.
11108 * @return The @p item priority, or @c 0 on failure.
11110 * @see elm_toolbar_item_priority_set() for details.
11114 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11117 * Get the label of item.
11119 * @param item The item of toolbar.
11120 * @return The label of item.
11122 * The return value is a pointer to the label associated to @p item when
11123 * it was created, with function elm_toolbar_item_append() or similar,
11125 * with function elm_toolbar_item_label_set. If no label
11126 * was passed as argument, it will return @c NULL.
11128 * @see elm_toolbar_item_label_set() for more details.
11129 * @see elm_toolbar_item_append()
11133 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11136 * Set the label of item.
11138 * @param item The item of toolbar.
11139 * @param text The label of item.
11141 * The label to be displayed by the item.
11142 * Label will be placed at icons bottom (if set).
11144 * If a label was passed as argument on item creation, with function
11145 * elm_toolbar_item_append() or similar, it will be already
11146 * displayed by the item.
11148 * @see elm_toolbar_item_label_get()
11149 * @see elm_toolbar_item_append()
11153 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11156 * Return the data associated with a given toolbar widget item.
11158 * @param item The toolbar widget item handle.
11159 * @return The data associated with @p item.
11161 * @see elm_toolbar_item_data_set()
11165 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11168 * Set the data associated with a given toolbar widget item.
11170 * @param item The toolbar widget item handle.
11171 * @param data The new data pointer to set to @p item.
11173 * This sets new item data on @p item.
11175 * @warning The old data pointer won't be touched by this function, so
11176 * the user had better to free that old data himself/herself.
11180 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11183 * Returns a pointer to a toolbar item by its label.
11185 * @param obj The toolbar object.
11186 * @param label The label of the item to find.
11188 * @return The pointer to the toolbar item matching @p label or @c NULL
11193 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11196 * Get whether the @p item is selected or not.
11198 * @param item The toolbar item.
11199 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11200 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11202 * @see elm_toolbar_selected_item_set() for details.
11203 * @see elm_toolbar_item_selected_get()
11207 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11210 * Set the selected state of an item.
11212 * @param item The toolbar item
11213 * @param selected The selected state
11215 * This sets the selected state of the given item @p it.
11216 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11218 * If a new item is selected the previosly selected will be unselected.
11219 * Previoulsy selected item can be get with function
11220 * elm_toolbar_selected_item_get().
11222 * Selected items will be highlighted.
11224 * @see elm_toolbar_item_selected_get()
11225 * @see elm_toolbar_selected_item_get()
11229 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11232 * Get the selected item.
11234 * @param obj The toolbar object.
11235 * @return The selected toolbar item.
11237 * The selected item can be unselected with function
11238 * elm_toolbar_item_selected_set().
11240 * The selected item always will be highlighted on toolbar.
11242 * @see elm_toolbar_selected_items_get()
11246 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11249 * Set the icon associated with @p item.
11251 * @param obj The parent of this item.
11252 * @param item The toolbar item.
11253 * @param icon A string with icon name or the absolute path of an image file.
11255 * Toolbar will load icon image from fdo or current theme.
11256 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11257 * If an absolute path is provided it will load it direct from a file.
11259 * @see elm_toolbar_icon_order_lookup_set()
11260 * @see elm_toolbar_icon_order_lookup_get()
11264 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11267 * Get the string used to set the icon of @p item.
11269 * @param item The toolbar item.
11270 * @return The string associated with the icon object.
11272 * @see elm_toolbar_item_icon_set() for details.
11276 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11279 * Delete them item from the toolbar.
11281 * @param item The item of toolbar to be deleted.
11283 * @see elm_toolbar_item_append()
11284 * @see elm_toolbar_item_del_cb_set()
11288 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11291 * Set the function called when a toolbar item is freed.
11293 * @param item The item to set the callback on.
11294 * @param func The function called.
11296 * If there is a @p func, then it will be called prior item's memory release.
11297 * That will be called with the following arguments:
11299 * @li item's Evas object;
11302 * This way, a data associated to a toolbar item could be properly freed.
11306 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11309 * Get a value whether toolbar item is disabled or not.
11311 * @param item The item.
11312 * @return The disabled state.
11314 * @see elm_toolbar_item_disabled_set() for more details.
11318 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11321 * Sets the disabled/enabled state of a toolbar item.
11323 * @param item The item.
11324 * @param disabled The disabled state.
11326 * A disabled item cannot be selected or unselected. It will also
11327 * change its appearance (generally greyed out). This sets the
11328 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11333 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11336 * Set or unset item as a separator.
11338 * @param item The toolbar item.
11339 * @param setting @c EINA_TRUE to set item @p item as separator or
11340 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11342 * Items aren't set as separator by default.
11344 * If set as separator it will display separator theme, so won't display
11347 * @see elm_toolbar_item_separator_get()
11351 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11354 * Get a value whether item is a separator or not.
11356 * @param item The toolbar item.
11357 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11358 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11360 * @see elm_toolbar_item_separator_set() for details.
11364 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11367 * Set the shrink state of toolbar @p obj.
11369 * @param obj The toolbar object.
11370 * @param shrink_mode Toolbar's items display behavior.
11372 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11373 * but will enforce a minimun size so all the items will fit, won't scroll
11374 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11375 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11376 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11380 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11383 * Get the shrink mode of toolbar @p obj.
11385 * @param obj The toolbar object.
11386 * @return Toolbar's items display behavior.
11388 * @see elm_toolbar_mode_shrink_set() for details.
11392 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11395 * Enable/disable homogenous mode.
11397 * @param obj The toolbar object
11398 * @param homogeneous Assume the items within the toolbar are of the
11399 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11401 * This will enable the homogeneous mode where items are of the same size.
11402 * @see elm_toolbar_homogeneous_get()
11406 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11409 * Get whether the homogenous mode is enabled.
11411 * @param obj The toolbar object.
11412 * @return Assume the items within the toolbar are of the same height
11413 * and width (EINA_TRUE = on, EINA_FALSE = off).
11415 * @see elm_toolbar_homogeneous_set()
11419 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11422 * Enable/disable homogenous mode.
11424 * @param obj The toolbar object
11425 * @param homogeneous Assume the items within the toolbar are of the
11426 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11428 * This will enable the homogeneous mode where items are of the same size.
11429 * @see elm_toolbar_homogeneous_get()
11431 * @deprecated use elm_toolbar_homogeneous_set() instead.
11435 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11438 * Get whether the homogenous mode is enabled.
11440 * @param obj The toolbar object.
11441 * @return Assume the items within the toolbar are of the same height
11442 * and width (EINA_TRUE = on, EINA_FALSE = off).
11444 * @see elm_toolbar_homogeneous_set()
11445 * @deprecated use elm_toolbar_homogeneous_get() instead.
11449 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11452 * Set the parent object of the toolbar items' menus.
11454 * @param obj The toolbar object.
11455 * @param parent The parent of the menu objects.
11457 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11459 * For more details about setting the parent for toolbar menus, see
11460 * elm_menu_parent_set().
11462 * @see elm_menu_parent_set() for details.
11463 * @see elm_toolbar_item_menu_set() for details.
11467 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11470 * Get the parent object of the toolbar items' menus.
11472 * @param obj The toolbar object.
11473 * @return The parent of the menu objects.
11475 * @see elm_toolbar_menu_parent_set() for details.
11479 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11482 * Set the alignment of the items.
11484 * @param obj The toolbar object.
11485 * @param align The new alignment, a float between <tt> 0.0 </tt>
11486 * and <tt> 1.0 </tt>.
11488 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11489 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11492 * Centered items by default.
11494 * @see elm_toolbar_align_get()
11498 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11501 * Get the alignment of the items.
11503 * @param obj The toolbar object.
11504 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11507 * @see elm_toolbar_align_set() for details.
11511 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11514 * Set whether the toolbar item opens a menu.
11516 * @param item The toolbar item.
11517 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11519 * A toolbar item can be set to be a menu, using this function.
11521 * Once it is set to be a menu, it can be manipulated through the
11522 * menu-like function elm_toolbar_menu_parent_set() and the other
11523 * elm_menu functions, using the Evas_Object @c menu returned by
11524 * elm_toolbar_item_menu_get().
11526 * So, items to be displayed in this item's menu should be added with
11527 * elm_menu_item_add().
11529 * The following code exemplifies the most basic usage:
11531 * tb = elm_toolbar_add(win)
11532 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11533 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11534 * elm_toolbar_menu_parent_set(tb, win);
11535 * menu = elm_toolbar_item_menu_get(item);
11536 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11537 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11541 * @see elm_toolbar_item_menu_get()
11545 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11548 * Get toolbar item's menu.
11550 * @param item The toolbar item.
11551 * @return Item's menu object or @c NULL on failure.
11553 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11554 * this function will set it.
11556 * @see elm_toolbar_item_menu_set() for details.
11560 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11563 * Add a new state to @p item.
11565 * @param item The item.
11566 * @param icon A string with icon name or the absolute path of an image file.
11567 * @param label The label of the new state.
11568 * @param func The function to call when the item is clicked when this
11569 * state is selected.
11570 * @param data The data to associate with the state.
11571 * @return The toolbar item state, or @c NULL upon failure.
11573 * Toolbar will load icon image from fdo or current theme.
11574 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11575 * If an absolute path is provided it will load it direct from a file.
11577 * States created with this function can be removed with
11578 * elm_toolbar_item_state_del().
11580 * @see elm_toolbar_item_state_del()
11581 * @see elm_toolbar_item_state_sel()
11582 * @see elm_toolbar_item_state_get()
11586 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);
11589 * Delete a previoulsy added state to @p item.
11591 * @param item The toolbar item.
11592 * @param state The state to be deleted.
11593 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11595 * @see elm_toolbar_item_state_add()
11597 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11600 * Set @p state as the current state of @p it.
11602 * @param it The item.
11603 * @param state The state to use.
11604 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11606 * If @p state is @c NULL, it won't select any state and the default item's
11607 * icon and label will be used. It's the same behaviour than
11608 * elm_toolbar_item_state_unser().
11610 * @see elm_toolbar_item_state_unset()
11614 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11617 * Unset the state of @p it.
11619 * @param it The item.
11621 * The default icon and label from this item will be displayed.
11623 * @see elm_toolbar_item_state_set() for more details.
11627 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11630 * Get the current state of @p it.
11632 * @param item The item.
11633 * @return The selected state or @c NULL if none is selected or on failure.
11635 * @see elm_toolbar_item_state_set() for details.
11636 * @see elm_toolbar_item_state_unset()
11637 * @see elm_toolbar_item_state_add()
11641 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11644 * Get the state after selected state in toolbar's @p item.
11646 * @param it The toolbar item to change state.
11647 * @return The state after current state, or @c NULL on failure.
11649 * If last state is selected, this function will return first state.
11651 * @see elm_toolbar_item_state_set()
11652 * @see elm_toolbar_item_state_add()
11656 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11659 * Get the state before selected state in toolbar's @p item.
11661 * @param it The toolbar item to change state.
11662 * @return The state before current state, or @c NULL on failure.
11664 * If first state is selected, this function will return last state.
11666 * @see elm_toolbar_item_state_set()
11667 * @see elm_toolbar_item_state_add()
11671 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11674 * Set the text to be shown in a given toolbar item's tooltips.
11676 * @param item Target item.
11677 * @param text The text to set in the content.
11679 * Setup the text as tooltip to object. The item can have only one tooltip,
11680 * so any previous tooltip data - set with this function or
11681 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11683 * @see elm_object_tooltip_text_set() for more details.
11687 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11690 * Set the content to be shown in the tooltip item.
11692 * Setup the tooltip to item. The item can have only one tooltip,
11693 * so any previous tooltip data is removed. @p func(with @p data) will
11694 * be called every time that need show the tooltip and it should
11695 * return a valid Evas_Object. This object is then managed fully by
11696 * tooltip system and is deleted when the tooltip is gone.
11698 * @param item the toolbar item being attached a tooltip.
11699 * @param func the function used to create the tooltip contents.
11700 * @param data what to provide to @a func as callback data/context.
11701 * @param del_cb called when data is not needed anymore, either when
11702 * another callback replaces @a func, the tooltip is unset with
11703 * elm_toolbar_item_tooltip_unset() or the owner @a item
11704 * dies. This callback receives as the first parameter the
11705 * given @a data, and @c event_info is the item.
11707 * @see elm_object_tooltip_content_cb_set() for more details.
11711 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);
11714 * Unset tooltip from item.
11716 * @param item toolbar item to remove previously set tooltip.
11718 * Remove tooltip from item. The callback provided as del_cb to
11719 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11720 * it is not used anymore.
11722 * @see elm_object_tooltip_unset() for more details.
11723 * @see elm_toolbar_item_tooltip_content_cb_set()
11727 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11730 * Sets a different style for this item tooltip.
11732 * @note before you set a style you should define a tooltip with
11733 * elm_toolbar_item_tooltip_content_cb_set() or
11734 * elm_toolbar_item_tooltip_text_set()
11736 * @param item toolbar item with tooltip already set.
11737 * @param style the theme style to use (default, transparent, ...)
11739 * @see elm_object_tooltip_style_set() for more details.
11743 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11746 * Get the style for this item tooltip.
11748 * @param item toolbar item with tooltip already set.
11749 * @return style the theme style in use, defaults to "default". If the
11750 * object does not have a tooltip set, then NULL is returned.
11752 * @see elm_object_tooltip_style_get() for more details.
11753 * @see elm_toolbar_item_tooltip_style_set()
11757 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11760 * Set the type of mouse pointer/cursor decoration to be shown,
11761 * when the mouse pointer is over the given toolbar widget item
11763 * @param item toolbar item to customize cursor on
11764 * @param cursor the cursor type's name
11766 * This function works analogously as elm_object_cursor_set(), but
11767 * here the cursor's changing area is restricted to the item's
11768 * area, and not the whole widget's. Note that that item cursors
11769 * have precedence over widget cursors, so that a mouse over an
11770 * item with custom cursor set will always show @b that cursor.
11772 * If this function is called twice for an object, a previously set
11773 * cursor will be unset on the second call.
11775 * @see elm_object_cursor_set()
11776 * @see elm_toolbar_item_cursor_get()
11777 * @see elm_toolbar_item_cursor_unset()
11781 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11784 * Get the type of mouse pointer/cursor decoration set to be shown,
11785 * when the mouse pointer is over the given toolbar widget item
11787 * @param item toolbar item with custom cursor set
11788 * @return the cursor type's name or @c NULL, if no custom cursors
11789 * were set to @p item (and on errors)
11791 * @see elm_object_cursor_get()
11792 * @see elm_toolbar_item_cursor_set()
11793 * @see elm_toolbar_item_cursor_unset()
11797 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11800 * Unset any custom mouse pointer/cursor decoration set to be
11801 * shown, when the mouse pointer is over the given toolbar widget
11802 * item, thus making it show the @b default cursor again.
11804 * @param item a toolbar item
11806 * Use this call to undo any custom settings on this item's cursor
11807 * decoration, bringing it back to defaults (no custom style set).
11809 * @see elm_object_cursor_unset()
11810 * @see elm_toolbar_item_cursor_set()
11814 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11817 * Set a different @b style for a given custom cursor set for a
11820 * @param item toolbar item with custom cursor set
11821 * @param style the <b>theme style</b> to use (e.g. @c "default",
11822 * @c "transparent", etc)
11824 * This function only makes sense when one is using custom mouse
11825 * cursor decorations <b>defined in a theme file</b>, which can have,
11826 * given a cursor name/type, <b>alternate styles</b> on it. It
11827 * works analogously as elm_object_cursor_style_set(), but here
11828 * applyed only to toolbar item objects.
11830 * @warning Before you set a cursor style you should have definen a
11831 * custom cursor previously on the item, with
11832 * elm_toolbar_item_cursor_set()
11834 * @see elm_toolbar_item_cursor_engine_only_set()
11835 * @see elm_toolbar_item_cursor_style_get()
11839 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11842 * Get the current @b style set for a given toolbar item's custom
11845 * @param item toolbar item with custom cursor set.
11846 * @return style the cursor style in use. If the object does not
11847 * have a cursor set, then @c NULL is returned.
11849 * @see elm_toolbar_item_cursor_style_set() for more details
11853 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11856 * Set if the (custom)cursor for a given toolbar item should be
11857 * searched in its theme, also, or should only rely on the
11858 * rendering engine.
11860 * @param item item with custom (custom) cursor already set on
11861 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11862 * only on those provided by the rendering engine, @c EINA_FALSE to
11863 * have them searched on the widget's theme, as well.
11865 * @note This call is of use only if you've set a custom cursor
11866 * for toolbar items, with elm_toolbar_item_cursor_set().
11868 * @note By default, cursors will only be looked for between those
11869 * provided by the rendering engine.
11873 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11876 * Get if the (custom) cursor for a given toolbar item is being
11877 * searched in its theme, also, or is only relying on the rendering
11880 * @param item a toolbar item
11881 * @return @c EINA_TRUE, if cursors are being looked for only on
11882 * those provided by the rendering engine, @c EINA_FALSE if they
11883 * are being searched on the widget's theme, as well.
11885 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11889 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11896 EAPI double elm_tooltip_delay_get(void);
11897 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11898 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11899 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11900 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11901 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);
11902 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11903 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11904 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11905 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11906 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11907 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11908 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11909 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11910 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11911 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11912 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11913 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11916 EAPI int elm_cursor_engine_only_get(void);
11917 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11920 * @defgroup Menu Menu
11922 * @image html img/widget/menu/preview-00.png
11923 * @image latex img/widget/menu/preview-00.eps
11925 * A menu is a list of items displayed above its parent. When the menu is
11926 * showing its parent is darkened. Each item can have a sub-menu. The menu
11927 * object can be used to display a menu on a right click event, in a toolbar,
11930 * Signals that you can add callbacks for are:
11931 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11932 * event_info is NULL.
11934 * @see @ref tutorial_menu
11937 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11939 * @brief Add a new menu to the parent
11941 * @param parent The parent object.
11942 * @return The new object or NULL if it cannot be created.
11944 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11946 * @brief Set the parent for the given menu widget
11948 * @param obj The menu object.
11949 * @param parent The new parent.
11951 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11953 * @brief Get the parent for the given menu widget
11955 * @param obj The menu object.
11956 * @return The parent.
11958 * @see elm_menu_parent_set()
11960 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11962 * @brief Move the menu to a new position
11964 * @param obj The menu object.
11965 * @param x The new position.
11966 * @param y The new position.
11968 * Sets the top-left position of the menu to (@p x,@p y).
11970 * @note @p x and @p y coordinates are relative to parent.
11972 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
11974 * @brief Close a opened menu
11976 * @param obj the menu object
11979 * Hides the menu and all it's sub-menus.
11981 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
11983 * @brief Returns a list of @p item's items.
11985 * @param obj The menu object
11986 * @return An Eina_List* of @p item's items
11988 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11990 * @brief Get the Evas_Object of an Elm_Menu_Item
11992 * @param item The menu item object.
11993 * @return The edje object containing the swallowed content
11995 * @warning Don't manipulate this object!
11997 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
11999 * @brief Add an item at the end of the given menu widget
12001 * @param obj The menu object.
12002 * @param parent The parent menu item (optional)
12003 * @param icon A icon display on the item. The icon will be destryed by the menu.
12004 * @param label The label of the item.
12005 * @param func Function called when the user select the item.
12006 * @param data Data sent by the callback.
12007 * @return Returns the new item.
12009 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);
12011 * @brief Add an object swallowed in an item at the end of the given menu
12014 * @param obj The menu object.
12015 * @param parent The parent menu item (optional)
12016 * @param subobj The object to swallow
12017 * @param func Function called when the user select the item.
12018 * @param data Data sent by the callback.
12019 * @return Returns the new item.
12021 * Add an evas object as an item to the menu.
12023 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);
12025 * @brief Set the label of a menu item
12027 * @param item The menu item object.
12028 * @param label The label to set for @p item
12030 * @warning Don't use this funcion on items created with
12031 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12033 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12035 * @brief Get the label of a menu item
12037 * @param item The menu item object.
12038 * @return The label of @p item
12040 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12042 * @brief Set the icon of a menu item to the standard icon with name @p icon
12044 * @param item The menu item object.
12045 * @param icon The icon object to set for the content of @p item
12047 * Once this icon is set, any previously set icon will be deleted.
12049 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12051 * @brief Get the string representation from the icon of a menu item
12053 * @param item The menu item object.
12054 * @return The string representation of @p item's icon or NULL
12056 * @see elm_menu_item_object_icon_name_set()
12058 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12060 * @deprecated Use elm_menu_item_object_icon_name_set()
12062 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12064 * @deprecated Use elm_menu_item_object_icon_name_get()
12066 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12068 * @brief Set the content object of a menu item
12070 * @param item The menu item object
12071 * @param The content object or NULL
12072 * @return EINA_TRUE on success, else EINA_FALSE
12074 * Use this function to change the object swallowed by a menu item, deleting
12075 * any previously swallowed object.
12077 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12079 * @brief Get the content object of a menu item
12081 * @param item The menu item object
12082 * @return The content object or NULL
12083 * @note If @p item was added with elm_menu_item_add_object, this
12084 * function will return the object passed, else it will return the
12087 * @see elm_menu_item_object_content_set()
12089 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12091 * @deprecated Use elm_menu_item_object_content_get() instead.
12093 EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12095 * @brief Set the selected state of @p item.
12097 * @param item The menu item object.
12098 * @param selected The selected/unselected state of the item
12100 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12102 * @brief Get the selected state of @p item.
12104 * @param item The menu item object.
12105 * @return The selected/unselected state of the item
12107 * @see elm_menu_item_selected_set()
12109 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12111 * @brief Set the disabled state of @p item.
12113 * @param item The menu item object.
12114 * @param disabled The enabled/disabled state of the item
12116 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12118 * @brief Get the disabled state of @p item.
12120 * @param item The menu item object.
12121 * @return The enabled/disabled state of the item
12123 * @see elm_menu_item_disabled_set()
12125 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12127 * @brief Add a separator item to menu @p obj under @p parent.
12129 * @param obj The menu object
12130 * @param parent The item to add the separator under
12131 * @return The created item or NULL on failure
12133 * This is item is a @ref Separator.
12135 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12137 * @brief Returns whether @p item is a separator.
12139 * @param item The item to check
12140 * @return If true, @p item is a separator
12142 * @see elm_menu_item_separator_add()
12144 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12146 * @brief Deletes an item from the menu.
12148 * @param item The item to delete.
12150 * @see elm_menu_item_add()
12152 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12154 * @brief Set the function called when a menu item is deleted.
12156 * @param item The item to set the callback on
12157 * @param func The function called
12159 * @see elm_menu_item_add()
12160 * @see elm_menu_item_del()
12162 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12164 * @brief Returns the data associated with menu item @p item.
12166 * @param item The item
12167 * @return The data associated with @p item or NULL if none was set.
12169 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12171 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12173 * @brief Sets the data to be associated with menu item @p item.
12175 * @param item The item
12176 * @param data The data to be associated with @p item
12178 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12180 * @brief Returns a list of @p item's subitems.
12182 * @param item The item
12183 * @return An Eina_List* of @p item's subitems
12185 * @see elm_menu_add()
12187 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12189 * @brief Get the position of a menu item
12191 * @param item The menu item
12192 * @return The item's index
12194 * This function returns the index position of a menu item in a menu.
12195 * For a sub-menu, this number is relative to the first item in the sub-menu.
12197 * @note Index values begin with 0
12199 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12201 * @brief @brief Return a menu item's owner menu
12203 * @param item The menu item
12204 * @return The menu object owning @p item, or NULL on failure
12206 * Use this function to get the menu object owning an item.
12208 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12210 * @brief Get the selected item in the menu
12212 * @param obj The menu object
12213 * @return The selected item, or NULL if none
12215 * @see elm_menu_item_selected_get()
12216 * @see elm_menu_item_selected_set()
12218 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12220 * @brief Get the last item in the menu
12222 * @param obj The menu object
12223 * @return The last item, or NULL if none
12225 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12227 * @brief Get the first item in the menu
12229 * @param obj The menu object
12230 * @return The first item, or NULL if none
12232 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12234 * @brief Get the next item in the menu.
12236 * @param item The menu item object.
12237 * @return The item after it, or NULL if none
12239 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12241 * @brief Get the previous item in the menu.
12243 * @param item The menu item object.
12244 * @return The item before it, or NULL if none
12246 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12252 * @defgroup List List
12253 * @ingroup Elementary
12255 * @image html img/widget/list/preview-00.png
12256 * @image latex img/widget/list/preview-00.eps width=\textwidth
12258 * @image html img/list.png
12259 * @image latex img/list.eps width=\textwidth
12261 * A list widget is a container whose children are displayed vertically or
12262 * horizontally, in order, and can be selected.
12263 * The list can accept only one or multiple items selection. Also has many
12264 * modes of items displaying.
12266 * A list is a very simple type of list widget. For more robust
12267 * lists, @ref Genlist should probably be used.
12269 * Smart callbacks one can listen to:
12270 * - @c "activated" - The user has double-clicked or pressed
12271 * (enter|return|spacebar) on an item. The @c event_info parameter
12272 * is the item that was activated.
12273 * - @c "clicked,double" - The user has double-clicked an item.
12274 * The @c event_info parameter is the item that was double-clicked.
12275 * - "selected" - when the user selected an item
12276 * - "unselected" - when the user unselected an item
12277 * - "longpressed" - an item in the list is long-pressed
12278 * - "scroll,edge,top" - the list is scrolled until the top edge
12279 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12280 * - "scroll,edge,left" - the list is scrolled until the left edge
12281 * - "scroll,edge,right" - the list is scrolled until the right edge
12283 * Available styles for it:
12286 * List of examples:
12287 * @li @ref list_example_01
12288 * @li @ref list_example_02
12289 * @li @ref list_example_03
12298 * @enum _Elm_List_Mode
12299 * @typedef Elm_List_Mode
12301 * Set list's resize behavior, transverse axis scroll and
12302 * items cropping. See each mode's description for more details.
12304 * @note Default value is #ELM_LIST_SCROLL.
12306 * Values <b> don't </b> work as bitmaks, only one can be choosen.
12308 * @see elm_list_mode_set()
12309 * @see elm_list_mode_get()
12313 typedef enum _Elm_List_Mode
12315 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. */
12316 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). */
12317 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. */
12318 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. */
12319 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12322 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(). */
12325 * Add a new list widget to the given parent Elementary
12326 * (container) object.
12328 * @param parent The parent object.
12329 * @return a new list widget handle or @c NULL, on errors.
12331 * This function inserts a new list widget on the canvas.
12335 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12340 * @param obj The list object
12342 * @note Call before running show() on the list object.
12343 * @warning If not called, it won't display the list properly.
12346 * li = elm_list_add(win);
12347 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12348 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12350 * evas_object_show(li);
12355 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12358 * Enable or disable multiple items selection on the list object.
12360 * @param obj The list object
12361 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12364 * Disabled by default. If disabled, the user can select a single item of
12365 * the list each time. Selected items are highlighted on list.
12366 * If enabled, many items can be selected.
12368 * If a selected item is selected again, it will be unselected.
12370 * @see elm_list_multi_select_get()
12374 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12377 * Get a value whether multiple items selection is enabled or not.
12379 * @see elm_list_multi_select_set() for details.
12381 * @param obj The list object.
12382 * @return @c EINA_TRUE means multiple items selection is enabled.
12383 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12384 * @c EINA_FALSE is returned.
12388 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12391 * Set which mode to use for the list object.
12393 * @param obj The list object
12394 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12395 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12397 * Set list's resize behavior, transverse axis scroll and
12398 * items cropping. See each mode's description for more details.
12400 * @note Default value is #ELM_LIST_SCROLL.
12402 * Only one can be set, if a previous one was set, it will be changed
12403 * by the new mode set. Bitmask won't work as well.
12405 * @see elm_list_mode_get()
12409 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12412 * Get the mode the list is at.
12414 * @param obj The list object
12415 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12416 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12418 * @note see elm_list_mode_set() for more information.
12422 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12425 * Enable or disable horizontal mode on the list object.
12427 * @param obj The list object.
12428 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12429 * disable it, i.e., to enable vertical mode.
12431 * @note Vertical mode is set by default.
12433 * On horizontal mode items are displayed on list from left to right,
12434 * instead of from top to bottom. Also, the list will scroll horizontally.
12435 * Each item will presents left icon on top and right icon, or end, at
12438 * @see elm_list_horizontal_get()
12442 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12445 * Get a value whether horizontal mode is enabled or not.
12447 * @param obj The list object.
12448 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12449 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12450 * @c EINA_FALSE is returned.
12452 * @see elm_list_horizontal_set() for details.
12456 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12459 * Enable or disable always select mode on the list object.
12461 * @param obj The list object
12462 * @param always_select @c EINA_TRUE to enable always select mode or
12463 * @c EINA_FALSE to disable it.
12465 * @note Always select mode is disabled by default.
12467 * Default behavior of list items is to only call its callback function
12468 * the first time it's pressed, i.e., when it is selected. If a selected
12469 * item is pressed again, and multi-select is disabled, it won't call
12470 * this function (if multi-select is enabled it will unselect the item).
12472 * If always select is enabled, it will call the callback function
12473 * everytime a item is pressed, so it will call when the item is selected,
12474 * and again when a selected item is pressed.
12476 * @see elm_list_always_select_mode_get()
12477 * @see elm_list_multi_select_set()
12481 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12484 * Get a value whether always select mode is enabled or not, meaning that
12485 * an item will always call its callback function, even if already selected.
12487 * @param obj The list object
12488 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12489 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12490 * @c EINA_FALSE is returned.
12492 * @see elm_list_always_select_mode_set() for details.
12496 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12499 * Set bouncing behaviour when the scrolled content reaches an edge.
12501 * Tell the internal scroller object whether it should bounce or not
12502 * when it reaches the respective edges for each axis.
12504 * @param obj The list object
12505 * @param h_bounce Whether to bounce or not in the horizontal axis.
12506 * @param v_bounce Whether to bounce or not in the vertical axis.
12508 * @see elm_scroller_bounce_set()
12512 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12515 * Get the bouncing behaviour of the internal scroller.
12517 * Get whether the internal scroller should bounce when the edge of each
12518 * axis is reached scrolling.
12520 * @param obj The list object.
12521 * @param h_bounce Pointer where to store the bounce state of the horizontal
12523 * @param v_bounce Pointer where to store the bounce state of the vertical
12526 * @see elm_scroller_bounce_get()
12527 * @see elm_list_bounce_set()
12531 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12534 * Set the scrollbar policy.
12536 * @param obj The list object
12537 * @param policy_h Horizontal scrollbar policy.
12538 * @param policy_v Vertical scrollbar policy.
12540 * This sets the scrollbar visibility policy for the given scroller.
12541 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12542 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12543 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12544 * This applies respectively for the horizontal and vertical scrollbars.
12546 * The both are disabled by default, i.e., are set to
12547 * #ELM_SCROLLER_POLICY_OFF.
12551 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12554 * Get the scrollbar policy.
12556 * @see elm_list_scroller_policy_get() for details.
12558 * @param obj The list object.
12559 * @param policy_h Pointer where to store horizontal scrollbar policy.
12560 * @param policy_v Pointer where to store vertical scrollbar policy.
12564 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);
12567 * Append a new item to the list object.
12569 * @param obj The list object.
12570 * @param label The label of the list item.
12571 * @param icon The icon object to use for the left side of the item. An
12572 * icon can be any Evas object, but usually it is an icon created
12573 * with elm_icon_add().
12574 * @param end The icon object to use for the right side of the item. An
12575 * icon can be any Evas object.
12576 * @param func The function to call when the item is clicked.
12577 * @param data The data to associate with the item for related callbacks.
12579 * @return The created item or @c NULL upon failure.
12581 * A new item will be created and appended to the list, i.e., will
12582 * be set as @b last item.
12584 * Items created with this method can be deleted with
12585 * elm_list_item_del().
12587 * Associated @p data can be properly freed when item is deleted if a
12588 * callback function is set with elm_list_item_del_cb_set().
12590 * If a function is passed as argument, it will be called everytime this item
12591 * is selected, i.e., the user clicks over an unselected item.
12592 * If always select is enabled it will call this function every time
12593 * user clicks over an item (already selected or not).
12594 * If such function isn't needed, just passing
12595 * @c NULL as @p func is enough. The same should be done for @p data.
12597 * Simple example (with no function callback or data associated):
12599 * li = elm_list_add(win);
12600 * ic = elm_icon_add(win);
12601 * elm_icon_file_set(ic, "path/to/image", NULL);
12602 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12603 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12605 * evas_object_show(li);
12608 * @see elm_list_always_select_mode_set()
12609 * @see elm_list_item_del()
12610 * @see elm_list_item_del_cb_set()
12611 * @see elm_list_clear()
12612 * @see elm_icon_add()
12616 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);
12619 * Prepend a new item to the list object.
12621 * @param obj The list object.
12622 * @param label The label of the list item.
12623 * @param icon The icon object to use for the left side of the item. An
12624 * icon can be any Evas object, but usually it is an icon created
12625 * with elm_icon_add().
12626 * @param end The icon object to use for the right side of the item. An
12627 * icon can be any Evas object.
12628 * @param func The function to call when the item is clicked.
12629 * @param data The data to associate with the item for related callbacks.
12631 * @return The created item or @c NULL upon failure.
12633 * A new item will be created and prepended to the list, i.e., will
12634 * be set as @b first item.
12636 * Items created with this method can be deleted with
12637 * elm_list_item_del().
12639 * Associated @p data can be properly freed when item is deleted if a
12640 * callback function is set with elm_list_item_del_cb_set().
12642 * If a function is passed as argument, it will be called everytime this item
12643 * is selected, i.e., the user clicks over an unselected item.
12644 * If always select is enabled it will call this function every time
12645 * user clicks over an item (already selected or not).
12646 * If such function isn't needed, just passing
12647 * @c NULL as @p func is enough. The same should be done for @p data.
12649 * @see elm_list_item_append() for a simple code example.
12650 * @see elm_list_always_select_mode_set()
12651 * @see elm_list_item_del()
12652 * @see elm_list_item_del_cb_set()
12653 * @see elm_list_clear()
12654 * @see elm_icon_add()
12658 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);
12661 * Insert a new item into the list object before item @p before.
12663 * @param obj The list object.
12664 * @param before The list item to insert before.
12665 * @param label The label of the list item.
12666 * @param icon The icon object to use for the left side of the item. An
12667 * icon can be any Evas object, but usually it is an icon created
12668 * with elm_icon_add().
12669 * @param end The icon object to use for the right side of the item. An
12670 * icon can be any Evas object.
12671 * @param func The function to call when the item is clicked.
12672 * @param data The data to associate with the item for related callbacks.
12674 * @return The created item or @c NULL upon failure.
12676 * A new item will be created and added to the list. Its position in
12677 * this list will be just before item @p before.
12679 * Items created with this method can be deleted with
12680 * elm_list_item_del().
12682 * Associated @p data can be properly freed when item is deleted if a
12683 * callback function is set with elm_list_item_del_cb_set().
12685 * If a function is passed as argument, it will be called everytime this item
12686 * is selected, i.e., the user clicks over an unselected item.
12687 * If always select is enabled it will call this function every time
12688 * user clicks over an item (already selected or not).
12689 * If such function isn't needed, just passing
12690 * @c NULL as @p func is enough. The same should be done for @p data.
12692 * @see elm_list_item_append() for a simple code example.
12693 * @see elm_list_always_select_mode_set()
12694 * @see elm_list_item_del()
12695 * @see elm_list_item_del_cb_set()
12696 * @see elm_list_clear()
12697 * @see elm_icon_add()
12701 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);
12704 * Insert a new item into the list object after item @p after.
12706 * @param obj The list object.
12707 * @param after The list item to insert after.
12708 * @param label The label of the list item.
12709 * @param icon The icon object to use for the left side of the item. An
12710 * icon can be any Evas object, but usually it is an icon created
12711 * with elm_icon_add().
12712 * @param end The icon object to use for the right side of the item. An
12713 * icon can be any Evas object.
12714 * @param func The function to call when the item is clicked.
12715 * @param data The data to associate with the item for related callbacks.
12717 * @return The created item or @c NULL upon failure.
12719 * A new item will be created and added to the list. Its position in
12720 * this list will be just after item @p after.
12722 * Items created with this method can be deleted with
12723 * elm_list_item_del().
12725 * Associated @p data can be properly freed when item is deleted if a
12726 * callback function is set with elm_list_item_del_cb_set().
12728 * If a function is passed as argument, it will be called everytime this item
12729 * is selected, i.e., the user clicks over an unselected item.
12730 * If always select is enabled it will call this function every time
12731 * user clicks over an item (already selected or not).
12732 * If such function isn't needed, just passing
12733 * @c NULL as @p func is enough. The same should be done for @p data.
12735 * @see elm_list_item_append() for a simple code example.
12736 * @see elm_list_always_select_mode_set()
12737 * @see elm_list_item_del()
12738 * @see elm_list_item_del_cb_set()
12739 * @see elm_list_clear()
12740 * @see elm_icon_add()
12744 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);
12747 * Insert a new item into the sorted list object.
12749 * @param obj The list object.
12750 * @param label The label of the list item.
12751 * @param icon The icon object to use for the left side of the item. An
12752 * icon can be any Evas object, but usually it is an icon created
12753 * with elm_icon_add().
12754 * @param end The icon object to use for the right side of the item. An
12755 * icon can be any Evas object.
12756 * @param func The function to call when the item is clicked.
12757 * @param data The data to associate with the item for related callbacks.
12758 * @param cmp_func The comparing function to be used to sort list
12759 * items <b>by #Elm_List_Item item handles</b>. This function will
12760 * receive two items and compare them, returning a non-negative integer
12761 * if the second item should be place after the first, or negative value
12762 * if should be placed before.
12764 * @return The created item or @c NULL upon failure.
12766 * @note This function inserts values into a list object assuming it was
12767 * sorted and the result will be sorted.
12769 * A new item will be created and added to the list. Its position in
12770 * this list will be found comparing the new item with previously inserted
12771 * items using function @p cmp_func.
12773 * Items created with this method can be deleted with
12774 * elm_list_item_del().
12776 * Associated @p data can be properly freed when item is deleted if a
12777 * callback function is set with elm_list_item_del_cb_set().
12779 * If a function is passed as argument, it will be called everytime this item
12780 * is selected, i.e., the user clicks over an unselected item.
12781 * If always select is enabled it will call this function every time
12782 * user clicks over an item (already selected or not).
12783 * If such function isn't needed, just passing
12784 * @c NULL as @p func is enough. The same should be done for @p data.
12786 * @see elm_list_item_append() for a simple code example.
12787 * @see elm_list_always_select_mode_set()
12788 * @see elm_list_item_del()
12789 * @see elm_list_item_del_cb_set()
12790 * @see elm_list_clear()
12791 * @see elm_icon_add()
12795 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);
12798 * Remove all list's items.
12800 * @param obj The list object
12802 * @see elm_list_item_del()
12803 * @see elm_list_item_append()
12807 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12810 * Get a list of all the list items.
12812 * @param obj The list object
12813 * @return An @c Eina_List of list items, #Elm_List_Item,
12814 * or @c NULL on failure.
12816 * @see elm_list_item_append()
12817 * @see elm_list_item_del()
12818 * @see elm_list_clear()
12822 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12825 * Get the selected item.
12827 * @param obj The list object.
12828 * @return The selected list item.
12830 * The selected item can be unselected with function
12831 * elm_list_item_selected_set().
12833 * The selected item always will be highlighted on list.
12835 * @see elm_list_selected_items_get()
12839 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12842 * Return a list of the currently selected list items.
12844 * @param obj The list object.
12845 * @return An @c Eina_List of list items, #Elm_List_Item,
12846 * or @c NULL on failure.
12848 * Multiple items can be selected if multi select is enabled. It can be
12849 * done with elm_list_multi_select_set().
12851 * @see elm_list_selected_item_get()
12852 * @see elm_list_multi_select_set()
12856 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12859 * Set the selected state of an item.
12861 * @param item The list item
12862 * @param selected The selected state
12864 * This sets the selected state of the given item @p it.
12865 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12867 * If a new item is selected the previosly selected will be unselected,
12868 * unless multiple selection is enabled with elm_list_multi_select_set().
12869 * Previoulsy selected item can be get with function
12870 * elm_list_selected_item_get().
12872 * Selected items will be highlighted.
12874 * @see elm_list_item_selected_get()
12875 * @see elm_list_selected_item_get()
12876 * @see elm_list_multi_select_set()
12880 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12883 * Get whether the @p item is selected or not.
12885 * @param item The list item.
12886 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12887 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12889 * @see elm_list_selected_item_set() for details.
12890 * @see elm_list_item_selected_get()
12894 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12897 * Set or unset item as a separator.
12899 * @param it The list item.
12900 * @param setting @c EINA_TRUE to set item @p it as separator or
12901 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12903 * Items aren't set as separator by default.
12905 * If set as separator it will display separator theme, so won't display
12908 * @see elm_list_item_separator_get()
12912 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12915 * Get a value whether item is a separator or not.
12917 * @see elm_list_item_separator_set() for details.
12919 * @param it The list item.
12920 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12921 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12925 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12928 * Show @p item in the list view.
12930 * @param item The list item to be shown.
12932 * It won't animate list until item is visible. If such behavior is wanted,
12933 * use elm_list_bring_in() intead.
12937 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12940 * Bring in the given item to list view.
12942 * @param item The item.
12944 * This causes list to jump to the given item @p item and show it
12945 * (by scrolling), if it is not fully visible.
12947 * This may use animation to do so and take a period of time.
12949 * If animation isn't wanted, elm_list_item_show() can be used.
12953 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12956 * Delete them item from the list.
12958 * @param item The item of list to be deleted.
12960 * If deleting all list items is required, elm_list_clear()
12961 * should be used instead of getting items list and deleting each one.
12963 * @see elm_list_clear()
12964 * @see elm_list_item_append()
12965 * @see elm_list_item_del_cb_set()
12969 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12972 * Set the function called when a list item is freed.
12974 * @param item The item to set the callback on
12975 * @param func The function called
12977 * If there is a @p func, then it will be called prior item's memory release.
12978 * That will be called with the following arguments:
12980 * @li item's Evas object;
12983 * This way, a data associated to a list item could be properly freed.
12987 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12990 * Get the data associated to the item.
12992 * @param item The list item
12993 * @return The data associated to @p item
12995 * The return value is a pointer to data associated to @p item when it was
12996 * created, with function elm_list_item_append() or similar. If no data
12997 * was passed as argument, it will return @c NULL.
12999 * @see elm_list_item_append()
13003 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13006 * Get the left side icon associated to the item.
13008 * @param item The list item
13009 * @return The left side icon associated to @p item
13011 * The return value is a pointer to the icon associated to @p item when
13013 * created, with function elm_list_item_append() or similar, or later
13014 * with function elm_list_item_icon_set(). If no icon
13015 * was passed as argument, it will return @c NULL.
13017 * @see elm_list_item_append()
13018 * @see elm_list_item_icon_set()
13022 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13025 * Set the left side icon associated to the item.
13027 * @param item The list item
13028 * @param icon The left side icon object to associate with @p item
13030 * The icon object to use at left side of the item. An
13031 * icon can be any Evas object, but usually it is an icon created
13032 * with elm_icon_add().
13034 * Once the icon object is set, a previously set one will be deleted.
13035 * @warning Setting the same icon for two items will cause the icon to
13036 * dissapear from the first item.
13038 * If an icon was passed as argument on item creation, with function
13039 * elm_list_item_append() or similar, it will be already
13040 * associated to the item.
13042 * @see elm_list_item_append()
13043 * @see elm_list_item_icon_get()
13047 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13050 * Get the right side icon associated to the item.
13052 * @param item The list item
13053 * @return The right side icon associated to @p item
13055 * The return value is a pointer to the icon associated to @p item when
13057 * created, with function elm_list_item_append() or similar, or later
13058 * with function elm_list_item_icon_set(). If no icon
13059 * was passed as argument, it will return @c NULL.
13061 * @see elm_list_item_append()
13062 * @see elm_list_item_icon_set()
13066 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13069 * Set the right side icon associated to the item.
13071 * @param item The list item
13072 * @param end The right side icon object to associate with @p item
13074 * The icon object to use at right side of the item. An
13075 * icon can be any Evas object, but usually it is an icon created
13076 * with elm_icon_add().
13078 * Once the icon object is set, a previously set one will be deleted.
13079 * @warning Setting the same icon for two items will cause the icon to
13080 * dissapear from the first item.
13082 * If an icon was passed as argument on item creation, with function
13083 * elm_list_item_append() or similar, it will be already
13084 * associated to the item.
13086 * @see elm_list_item_append()
13087 * @see elm_list_item_end_get()
13091 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13094 * Gets the base object of the item.
13096 * @param item The list item
13097 * @return The base object associated with @p item
13099 * Base object is the @c Evas_Object that represents that item.
13103 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13106 * Get the label of item.
13108 * @param item The item of list.
13109 * @return The label of item.
13111 * The return value is a pointer to the label associated to @p item when
13112 * it was created, with function elm_list_item_append(), or later
13113 * with function elm_list_item_label_set. If no label
13114 * was passed as argument, it will return @c NULL.
13116 * @see elm_list_item_label_set() for more details.
13117 * @see elm_list_item_append()
13121 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13124 * Set the label of item.
13126 * @param item The item of list.
13127 * @param text The label of item.
13129 * The label to be displayed by the item.
13130 * Label will be placed between left and right side icons (if set).
13132 * If a label was passed as argument on item creation, with function
13133 * elm_list_item_append() or similar, it will be already
13134 * displayed by the item.
13136 * @see elm_list_item_label_get()
13137 * @see elm_list_item_append()
13141 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13145 * Get the item before @p it in list.
13147 * @param it The list item.
13148 * @return The item before @p it, or @c NULL if none or on failure.
13150 * @note If it is the first item, @c NULL will be returned.
13152 * @see elm_list_item_append()
13153 * @see elm_list_items_get()
13157 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13160 * Get the item after @p it in list.
13162 * @param it The list item.
13163 * @return The item after @p it, or @c NULL if none or on failure.
13165 * @note If it is the last item, @c NULL will be returned.
13167 * @see elm_list_item_append()
13168 * @see elm_list_items_get()
13172 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13175 * Sets the disabled/enabled state of a list item.
13177 * @param it The item.
13178 * @param disabled The disabled state.
13180 * A disabled item cannot be selected or unselected. It will also
13181 * change its appearance (generally greyed out). This sets the
13182 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13187 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13190 * Get a value whether list item is disabled or not.
13192 * @param it The item.
13193 * @return The disabled state.
13195 * @see elm_list_item_disabled_set() for more details.
13199 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13202 * Set the text to be shown in a given list item's tooltips.
13204 * @param item Target item.
13205 * @param text The text to set in the content.
13207 * Setup the text as tooltip to object. The item can have only one tooltip,
13208 * so any previous tooltip data - set with this function or
13209 * elm_list_item_tooltip_content_cb_set() - is removed.
13211 * @see elm_object_tooltip_text_set() for more details.
13215 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13219 * @brief Disable size restrictions on an object's tooltip
13220 * @param item The tooltip's anchor object
13221 * @param disable If EINA_TRUE, size restrictions are disabled
13222 * @return EINA_FALSE on failure, EINA_TRUE on success
13224 * This function allows a tooltip to expand beyond its parant window's canvas.
13225 * It will instead be limited only by the size of the display.
13227 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13229 * @brief Retrieve size restriction state of an object's tooltip
13230 * @param obj The tooltip's anchor object
13231 * @return If EINA_TRUE, size restrictions are disabled
13233 * This function returns whether a tooltip is allowed to expand beyond
13234 * its parant window's canvas.
13235 * It will instead be limited only by the size of the display.
13237 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13240 * Set the content to be shown in the tooltip item.
13242 * Setup the tooltip to item. The item can have only one tooltip,
13243 * so any previous tooltip data is removed. @p func(with @p data) will
13244 * be called every time that need show the tooltip and it should
13245 * return a valid Evas_Object. This object is then managed fully by
13246 * tooltip system and is deleted when the tooltip is gone.
13248 * @param item the list item being attached a tooltip.
13249 * @param func the function used to create the tooltip contents.
13250 * @param data what to provide to @a func as callback data/context.
13251 * @param del_cb called when data is not needed anymore, either when
13252 * another callback replaces @a func, the tooltip is unset with
13253 * elm_list_item_tooltip_unset() or the owner @a item
13254 * dies. This callback receives as the first parameter the
13255 * given @a data, and @c event_info is the item.
13257 * @see elm_object_tooltip_content_cb_set() for more details.
13261 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);
13264 * Unset tooltip from item.
13266 * @param item list item to remove previously set tooltip.
13268 * Remove tooltip from item. The callback provided as del_cb to
13269 * elm_list_item_tooltip_content_cb_set() will be called to notify
13270 * it is not used anymore.
13272 * @see elm_object_tooltip_unset() for more details.
13273 * @see elm_list_item_tooltip_content_cb_set()
13277 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13280 * Sets a different style for this item tooltip.
13282 * @note before you set a style you should define a tooltip with
13283 * elm_list_item_tooltip_content_cb_set() or
13284 * elm_list_item_tooltip_text_set()
13286 * @param item list item with tooltip already set.
13287 * @param style the theme style to use (default, transparent, ...)
13289 * @see elm_object_tooltip_style_set() for more details.
13293 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13296 * Get the style for this item tooltip.
13298 * @param item list item with tooltip already set.
13299 * @return style the theme style in use, defaults to "default". If the
13300 * object does not have a tooltip set, then NULL is returned.
13302 * @see elm_object_tooltip_style_get() for more details.
13303 * @see elm_list_item_tooltip_style_set()
13307 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13310 * Set the type of mouse pointer/cursor decoration to be shown,
13311 * when the mouse pointer is over the given list widget item
13313 * @param item list item to customize cursor on
13314 * @param cursor the cursor type's name
13316 * This function works analogously as elm_object_cursor_set(), but
13317 * here the cursor's changing area is restricted to the item's
13318 * area, and not the whole widget's. Note that that item cursors
13319 * have precedence over widget cursors, so that a mouse over an
13320 * item with custom cursor set will always show @b that cursor.
13322 * If this function is called twice for an object, a previously set
13323 * cursor will be unset on the second call.
13325 * @see elm_object_cursor_set()
13326 * @see elm_list_item_cursor_get()
13327 * @see elm_list_item_cursor_unset()
13331 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13334 * Get the type of mouse pointer/cursor decoration set to be shown,
13335 * when the mouse pointer is over the given list widget item
13337 * @param item list item with custom cursor set
13338 * @return the cursor type's name or @c NULL, if no custom cursors
13339 * were set to @p item (and on errors)
13341 * @see elm_object_cursor_get()
13342 * @see elm_list_item_cursor_set()
13343 * @see elm_list_item_cursor_unset()
13347 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13350 * Unset any custom mouse pointer/cursor decoration set to be
13351 * shown, when the mouse pointer is over the given list widget
13352 * item, thus making it show the @b default cursor again.
13354 * @param item a list item
13356 * Use this call to undo any custom settings on this item's cursor
13357 * decoration, bringing it back to defaults (no custom style set).
13359 * @see elm_object_cursor_unset()
13360 * @see elm_list_item_cursor_set()
13364 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13367 * Set a different @b style for a given custom cursor set for a
13370 * @param item list item with custom cursor set
13371 * @param style the <b>theme style</b> to use (e.g. @c "default",
13372 * @c "transparent", etc)
13374 * This function only makes sense when one is using custom mouse
13375 * cursor decorations <b>defined in a theme file</b>, which can have,
13376 * given a cursor name/type, <b>alternate styles</b> on it. It
13377 * works analogously as elm_object_cursor_style_set(), but here
13378 * applyed only to list item objects.
13380 * @warning Before you set a cursor style you should have definen a
13381 * custom cursor previously on the item, with
13382 * elm_list_item_cursor_set()
13384 * @see elm_list_item_cursor_engine_only_set()
13385 * @see elm_list_item_cursor_style_get()
13389 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13392 * Get the current @b style set for a given list item's custom
13395 * @param item list item with custom cursor set.
13396 * @return style the cursor style in use. If the object does not
13397 * have a cursor set, then @c NULL is returned.
13399 * @see elm_list_item_cursor_style_set() for more details
13403 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13406 * Set if the (custom)cursor for a given list item should be
13407 * searched in its theme, also, or should only rely on the
13408 * rendering engine.
13410 * @param item item with custom (custom) cursor already set on
13411 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13412 * only on those provided by the rendering engine, @c EINA_FALSE to
13413 * have them searched on the widget's theme, as well.
13415 * @note This call is of use only if you've set a custom cursor
13416 * for list items, with elm_list_item_cursor_set().
13418 * @note By default, cursors will only be looked for between those
13419 * provided by the rendering engine.
13423 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13426 * Get if the (custom) cursor for a given list item is being
13427 * searched in its theme, also, or is only relying on the rendering
13430 * @param item a list item
13431 * @return @c EINA_TRUE, if cursors are being looked for only on
13432 * those provided by the rendering engine, @c EINA_FALSE if they
13433 * are being searched on the widget's theme, as well.
13435 * @see elm_list_item_cursor_engine_only_set(), for more details
13439 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13446 * @defgroup Slider Slider
13447 * @ingroup Elementary
13449 * @image html img/widget/slider/preview-00.png
13450 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13452 * The slider adds a dragable “slider” widget for selecting the value of
13453 * something within a range.
13455 * A slider can be horizontal or vertical. It can contain an Icon and has a
13456 * primary label as well as a units label (that is formatted with floating
13457 * point values and thus accepts a printf-style format string, like
13458 * “%1.2f units”. There is also an indicator string that may be somewhere
13459 * else (like on the slider itself) that also accepts a format string like
13460 * units. Label, Icon Unit and Indicator strings/objects are optional.
13462 * A slider may be inverted which means values invert, with high vales being
13463 * on the left or top and low values on the right or bottom (as opposed to
13464 * normally being low on the left or top and high on the bottom and right).
13466 * The slider should have its minimum and maximum values set by the
13467 * application with elm_slider_min_max_set() and value should also be set by
13468 * the application before use with elm_slider_value_set(). The span of the
13469 * slider is its length (horizontally or vertically). This will be scaled by
13470 * the object or applications scaling factor. At any point code can query the
13471 * slider for its value with elm_slider_value_get().
13473 * Smart callbacks one can listen to:
13474 * - "changed" - Whenever the slider value is changed by the user.
13475 * - "slider,drag,start" - dragging the slider indicator around has started.
13476 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13477 * - "delay,changed" - A short time after the value is changed by the user.
13478 * This will be called only when the user stops dragging for
13479 * a very short period or when they release their
13480 * finger/mouse, so it avoids possibly expensive reactions to
13481 * the value change.
13483 * Available styles for it:
13486 * Here is an example on its usage:
13487 * @li @ref slider_example
13491 * @addtogroup Slider
13496 * Add a new slider widget to the given parent Elementary
13497 * (container) object.
13499 * @param parent The parent object.
13500 * @return a new slider widget handle or @c NULL, on errors.
13502 * This function inserts a new slider widget on the canvas.
13506 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13509 * Set the label of a given slider widget
13511 * @param obj The progress bar object
13512 * @param label The text label string, in UTF-8
13515 * @deprecated use elm_object_text_set() instead.
13517 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13520 * Get the label of a given slider widget
13522 * @param obj The progressbar object
13523 * @return The text label string, in UTF-8
13526 * @deprecated use elm_object_text_get() instead.
13528 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13531 * Set the icon object of the slider object.
13533 * @param obj The slider object.
13534 * @param icon The icon object.
13536 * On horizontal mode, icon is placed at left, and on vertical mode,
13539 * @note Once the icon object is set, a previously set one will be deleted.
13540 * If you want to keep that old content object, use the
13541 * elm_slider_icon_unset() function.
13543 * @warning If the object being set does not have minimum size hints set,
13544 * it won't get properly displayed.
13548 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13551 * Unset an icon set on a given slider widget.
13553 * @param obj The slider object.
13554 * @return The icon object that was being used, if any was set, or
13555 * @c NULL, otherwise (and on errors).
13557 * On horizontal mode, icon is placed at left, and on vertical mode,
13560 * This call will unparent and return the icon object which was set
13561 * for this widget, previously, on success.
13563 * @see elm_slider_icon_set() for more details
13564 * @see elm_slider_icon_get()
13568 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13571 * Retrieve the icon object set for a given slider widget.
13573 * @param obj The slider object.
13574 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13575 * otherwise (and on errors).
13577 * On horizontal mode, icon is placed at left, and on vertical mode,
13580 * @see elm_slider_icon_set() for more details
13581 * @see elm_slider_icon_unset()
13585 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13588 * Set the end object of the slider object.
13590 * @param obj The slider object.
13591 * @param end The end object.
13593 * On horizontal mode, end is placed at left, and on vertical mode,
13594 * placed at bottom.
13596 * @note Once the icon object is set, a previously set one will be deleted.
13597 * If you want to keep that old content object, use the
13598 * elm_slider_end_unset() function.
13600 * @warning If the object being set does not have minimum size hints set,
13601 * it won't get properly displayed.
13605 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13608 * Unset an end object set on a given slider widget.
13610 * @param obj The slider object.
13611 * @return The end object that was being used, if any was set, or
13612 * @c NULL, otherwise (and on errors).
13614 * On horizontal mode, end is placed at left, and on vertical mode,
13615 * placed at bottom.
13617 * This call will unparent and return the icon object which was set
13618 * for this widget, previously, on success.
13620 * @see elm_slider_end_set() for more details.
13621 * @see elm_slider_end_get()
13625 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13628 * Retrieve the end object set for a given slider widget.
13630 * @param obj The slider object.
13631 * @return The end object's handle, if @p obj had one set, or @c NULL,
13632 * otherwise (and on errors).
13634 * On horizontal mode, icon is placed at right, and on vertical mode,
13635 * placed at bottom.
13637 * @see elm_slider_end_set() for more details.
13638 * @see elm_slider_end_unset()
13642 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13645 * Set the (exact) length of the bar region of a given slider widget.
13647 * @param obj The slider object.
13648 * @param size The length of the slider's bar region.
13650 * This sets the minimum width (when in horizontal mode) or height
13651 * (when in vertical mode) of the actual bar area of the slider
13652 * @p obj. This in turn affects the object's minimum size. Use
13653 * this when you're not setting other size hints expanding on the
13654 * given direction (like weight and alignment hints) and you would
13655 * like it to have a specific size.
13657 * @note Icon, end, label, indicator and unit text around @p obj
13658 * will require their
13659 * own space, which will make @p obj to require more the @p size,
13662 * @see elm_slider_span_size_get()
13666 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13669 * Get the length set for the bar region of a given slider widget
13671 * @param obj The slider object.
13672 * @return The length of the slider's bar region.
13674 * If that size was not set previously, with
13675 * elm_slider_span_size_set(), this call will return @c 0.
13679 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13682 * Set the format string for the unit label.
13684 * @param obj The slider object.
13685 * @param format The format string for the unit display.
13687 * Unit label is displayed all the time, if set, after slider's bar.
13688 * In horizontal mode, at right and in vertical mode, at bottom.
13690 * If @c NULL, unit label won't be visible. If not it sets the format
13691 * string for the label text. To the label text is provided a floating point
13692 * value, so the label text can display up to 1 floating point value.
13693 * Note that this is optional.
13695 * Use a format string such as "%1.2f meters" for example, and it will
13696 * display values like: "3.14 meters" for a value equal to 3.14159.
13698 * Default is unit label disabled.
13700 * @see elm_slider_indicator_format_get()
13704 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13707 * Get the unit label format of the slider.
13709 * @param obj The slider object.
13710 * @return The unit label format string in UTF-8.
13712 * Unit label is displayed all the time, if set, after slider's bar.
13713 * In horizontal mode, at right and in vertical mode, at bottom.
13715 * @see elm_slider_unit_format_set() for more
13716 * information on how this works.
13720 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13723 * Set the format string for the indicator label.
13725 * @param obj The slider object.
13726 * @param indicator The format string for the indicator display.
13728 * The slider may display its value somewhere else then unit label,
13729 * for example, above the slider knob that is dragged around. This function
13730 * sets the format string used for this.
13732 * If @c NULL, indicator label won't be visible. If not it sets the format
13733 * string for the label text. To the label text is provided a floating point
13734 * value, so the label text can display up to 1 floating point value.
13735 * Note that this is optional.
13737 * Use a format string such as "%1.2f meters" for example, and it will
13738 * display values like: "3.14 meters" for a value equal to 3.14159.
13740 * Default is indicator label disabled.
13742 * @see elm_slider_indicator_format_get()
13746 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13749 * Get the indicator label format of the slider.
13751 * @param obj The slider object.
13752 * @return The indicator label format string in UTF-8.
13754 * The slider may display its value somewhere else then unit label,
13755 * for example, above the slider knob that is dragged around. This function
13756 * gets the format string used for this.
13758 * @see elm_slider_indicator_format_set() for more
13759 * information on how this works.
13763 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13766 * Set the format function pointer for the indicator label
13768 * @param obj The slider object.
13769 * @param func The indicator format function.
13770 * @param free_func The freeing function for the format string.
13772 * Set the callback function to format the indicator string.
13774 * @see elm_slider_indicator_format_set() for more info on how this works.
13778 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);
13781 * Set the format function pointer for the units label
13783 * @param obj The slider object.
13784 * @param func The units format function.
13785 * @param free_func The freeing function for the format string.
13787 * Set the callback function to format the indicator string.
13789 * @see elm_slider_units_format_set() for more info on how this works.
13793 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);
13796 * Set the orientation of a given slider widget.
13798 * @param obj The slider object.
13799 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13800 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13802 * Use this function to change how your slider is to be
13803 * disposed: vertically or horizontally.
13805 * By default it's displayed horizontally.
13807 * @see elm_slider_horizontal_get()
13811 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13814 * Retrieve the orientation of a given slider widget
13816 * @param obj The slider object.
13817 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13818 * @c EINA_FALSE if it's @b vertical (and on errors).
13820 * @see elm_slider_horizontal_set() for more details.
13824 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13827 * Set the minimum and maximum values for the slider.
13829 * @param obj The slider object.
13830 * @param min The minimum value.
13831 * @param max The maximum value.
13833 * Define the allowed range of values to be selected by the user.
13835 * If actual value is less than @p min, it will be updated to @p min. If it
13836 * is bigger then @p max, will be updated to @p max. Actual value can be
13837 * get with elm_slider_value_get().
13839 * By default, min is equal to 0.0, and max is equal to 1.0.
13841 * @warning Maximum must be greater than minimum, otherwise behavior
13844 * @see elm_slider_min_max_get()
13848 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13851 * Get the minimum and maximum values of the slider.
13853 * @param obj The slider object.
13854 * @param min Pointer where to store the minimum value.
13855 * @param max Pointer where to store the maximum value.
13857 * @note If only one value is needed, the other pointer can be passed
13860 * @see elm_slider_min_max_set() for details.
13864 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13867 * Set the value the slider displays.
13869 * @param obj The slider object.
13870 * @param val The value to be displayed.
13872 * Value will be presented on the unit label following format specified with
13873 * elm_slider_unit_format_set() and on indicator with
13874 * elm_slider_indicator_format_set().
13876 * @warning The value must to be between min and max values. This values
13877 * are set by elm_slider_min_max_set().
13879 * @see elm_slider_value_get()
13880 * @see elm_slider_unit_format_set()
13881 * @see elm_slider_indicator_format_set()
13882 * @see elm_slider_min_max_set()
13886 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13889 * Get the value displayed by the spinner.
13891 * @param obj The spinner object.
13892 * @return The value displayed.
13894 * @see elm_spinner_value_set() for details.
13898 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13901 * Invert a given slider widget's displaying values order
13903 * @param obj The slider object.
13904 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13905 * @c EINA_FALSE to bring it back to default, non-inverted values.
13907 * A slider may be @b inverted, in which state it gets its
13908 * values inverted, with high vales being on the left or top and
13909 * low values on the right or bottom, as opposed to normally have
13910 * the low values on the former and high values on the latter,
13911 * respectively, for horizontal and vertical modes.
13913 * @see elm_slider_inverted_get()
13917 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13920 * Get whether a given slider widget's displaying values are
13923 * @param obj The slider object.
13924 * @return @c EINA_TRUE, if @p obj has inverted values,
13925 * @c EINA_FALSE otherwise (and on errors).
13927 * @see elm_slider_inverted_set() for more details.
13931 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13934 * Set whether to enlarge slider indicator (augmented knob) or not.
13936 * @param obj The slider object.
13937 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13938 * let the knob always at default size.
13940 * By default, indicator will be bigger while dragged by the user.
13942 * @warning It won't display values set with
13943 * elm_slider_indicator_format_set() if you disable indicator.
13947 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13950 * Get whether a given slider widget's enlarging indicator or not.
13952 * @param obj The slider object.
13953 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13954 * @c EINA_FALSE otherwise (and on errors).
13956 * @see elm_slider_indicator_show_set() for details.
13960 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13967 * @addtogroup Actionslider Actionslider
13969 * @image html img/widget/actionslider/preview-00.png
13970 * @image latex img/widget/actionslider/preview-00.eps
13972 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13973 * properties. The indicator is the element the user drags to choose a label.
13974 * When the position is set with magnet, when released the indicator will be
13975 * moved to it if it's nearest the magnetized position.
13977 * @note By default all positions are set as enabled.
13979 * Signals that you can add callbacks for are:
13981 * "selected" - when user selects an enabled position (the label is passed
13984 * "pos_changed" - when the indicator reaches any of the positions("left",
13985 * "right" or "center").
13987 * See an example of actionslider usage @ref actionslider_example_page "here"
13990 typedef enum _Elm_Actionslider_Pos
13992 ELM_ACTIONSLIDER_NONE = 0,
13993 ELM_ACTIONSLIDER_LEFT = 1 << 0,
13994 ELM_ACTIONSLIDER_CENTER = 1 << 1,
13995 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
13996 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
13997 } Elm_Actionslider_Pos;
14000 * Add a new actionslider to the parent.
14002 * @param parent The parent object
14003 * @return The new actionslider object or NULL if it cannot be created
14005 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14007 * Set actionslider labels.
14009 * @param obj The actionslider object
14010 * @param left_label The label to be set on the left.
14011 * @param center_label The label to be set on the center.
14012 * @param right_label The label to be set on the right.
14013 * @deprecated use elm_object_text_set() instead.
14015 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);
14017 * Get actionslider labels.
14019 * @param obj The actionslider object
14020 * @param left_label A char** to place the left_label of @p obj into.
14021 * @param center_label A char** to place the center_label of @p obj into.
14022 * @param right_label A char** to place the right_label of @p obj into.
14023 * @deprecated use elm_object_text_set() instead.
14025 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);
14027 * Get actionslider selected label.
14029 * @param obj The actionslider object
14030 * @return The selected label
14032 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14034 * Set actionslider indicator position.
14036 * @param obj The actionslider object.
14037 * @param pos The position of the indicator.
14039 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14041 * Get actionslider indicator position.
14043 * @param obj The actionslider object.
14044 * @return The position of the indicator.
14046 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14048 * Set actionslider magnet position. To make multiple positions magnets @c or
14049 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14051 * @param obj The actionslider object.
14052 * @param pos Bit mask indicating the magnet positions.
14054 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14056 * Get actionslider magnet position.
14058 * @param obj The actionslider object.
14059 * @return The positions with magnet property.
14061 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14063 * Set actionslider enabled position. To set multiple positions as enabled @c or
14064 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14066 * @note All the positions are enabled by default.
14068 * @param obj The actionslider object.
14069 * @param pos Bit mask indicating the enabled positions.
14071 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14073 * Get actionslider enabled position.
14075 * @param obj The actionslider object.
14076 * @return The enabled positions.
14078 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14080 * Set the label used on the indicator.
14082 * @param obj The actionslider object
14083 * @param label The label to be set on the indicator.
14084 * @deprecated use elm_object_text_set() instead.
14086 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14088 * Get the label used on the indicator object.
14090 * @param obj The actionslider object
14091 * @return The indicator label
14092 * @deprecated use elm_object_text_get() instead.
14094 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14100 * @defgroup Genlist Genlist
14102 * @image html img/widget/genlist/preview-00.png
14103 * @image latex img/widget/genlist/preview-00.eps
14104 * @image html img/genlist.png
14105 * @image latex img/genlist.eps
14107 * This widget aims to have more expansive list than the simple list in
14108 * Elementary that could have more flexible items and allow many more entries
14109 * while still being fast and low on memory usage. At the same time it was
14110 * also made to be able to do tree structures. But the price to pay is more
14111 * complexity when it comes to usage. If all you want is a simple list with
14112 * icons and a single label, use the normal @ref List object.
14114 * Genlist has a fairly large API, mostly because it's relatively complex,
14115 * trying to be both expansive, powerful and efficient. First we will begin
14116 * an overview on the theory behind genlist.
14118 * @section Genlist_Item_Class Genlist item classes - creating items
14120 * In order to have the ability to add and delete items on the fly, genlist
14121 * implements a class (callback) system where the application provides a
14122 * structure with information about that type of item (genlist may contain
14123 * multiple different items with different classes, states and styles).
14124 * Genlist will call the functions in this struct (methods) when an item is
14125 * "realized" (i.e., created dynamically, while the user is scrolling the
14126 * grid). All objects will simply be deleted when no longer needed with
14127 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14128 * following members:
14129 * - @c item_style - This is a constant string and simply defines the name
14130 * of the item style. It @b must be specified and the default should be @c
14133 * - @c func - A struct with pointers to functions that will be called when
14134 * an item is going to be actually created. All of them receive a @c data
14135 * parameter that will point to the same data passed to
14136 * elm_genlist_item_append() and related item creation functions, and a @c
14137 * obj parameter that points to the genlist object itself.
14139 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14140 * state_get and @c del. The 3 first functions also receive a @c part
14141 * parameter described below. A brief description of these functions follows:
14143 * - @c label_get - The @c part parameter is the name string of one of the
14144 * existing text parts in the Edje group implementing the item's theme.
14145 * This function @b must return a strdup'()ed string, as the caller will
14146 * free() it when done. See #GenlistItemLabelGetFunc.
14147 * - @c icon_get - The @c part parameter is the name string of one of the
14148 * existing (icon) swallow parts in the Edje group implementing the item's
14149 * theme. It must return @c NULL, when no icon is desired, or a valid
14150 * object handle, otherwise. The object will be deleted by the genlist on
14151 * its deletion or when the item is "unrealized". See
14152 * #GenlistItemIconGetFunc.
14153 * - @c func.state_get - The @c part parameter is the name string of one of
14154 * the state parts in the Edje group implementing the item's theme. Return
14155 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14156 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14157 * and @c "elm" as "emission" and "source" arguments, respectively, when
14158 * the state is true (the default is false), where @c XXX is the name of
14159 * the (state) part. See #GenlistItemStateGetFunc.
14160 * - @c func.del - This is intended for use when genlist items are deleted,
14161 * so any data attached to the item (e.g. its data parameter on creation)
14162 * can be deleted. See #GenlistItemDelFunc.
14164 * available item styles:
14166 * - default_style - The text part is a textblock
14168 * @image html img/widget/genlist/preview-04.png
14169 * @image latex img/widget/genlist/preview-04.eps
14173 * @image html img/widget/genlist/preview-01.png
14174 * @image latex img/widget/genlist/preview-01.eps
14176 * - icon_top_text_bottom
14178 * @image html img/widget/genlist/preview-02.png
14179 * @image latex img/widget/genlist/preview-02.eps
14183 * @image html img/widget/genlist/preview-03.png
14184 * @image latex img/widget/genlist/preview-03.eps
14186 * @section Genlist_Items Structure of items
14188 * An item in a genlist can have 0 or more text labels (they can be regular
14189 * text or textblock Evas objects - that's up to the style to determine), 0
14190 * or more icons (which are simply objects swallowed into the genlist item's
14191 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14192 * behavior left to the user to define. The Edje part names for each of
14193 * these properties will be looked up, in the theme file for the genlist,
14194 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14195 * "states", respectively. For each of those properties, if more than one
14196 * part is provided, they must have names listed separated by spaces in the
14197 * data fields. For the default genlist item theme, we have @b one label
14198 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14199 * "elm.swallow.end") and @b no state parts.
14201 * A genlist item may be at one of several styles. Elementary provides one
14202 * by default - "default", but this can be extended by system or application
14203 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14206 * @section Genlist_Manipulation Editing and Navigating
14208 * Items can be added by several calls. All of them return a @ref
14209 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14210 * They all take a data parameter that is meant to be used for a handle to
14211 * the applications internal data (eg the struct with the original item
14212 * data). The parent parameter is the parent genlist item this belongs to if
14213 * it is a tree or an indexed group, and NULL if there is no parent. The
14214 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14215 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14216 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14217 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14218 * is set then this item is group index item that is displayed at the top
14219 * until the next group comes. The func parameter is a convenience callback
14220 * that is called when the item is selected and the data parameter will be
14221 * the func_data parameter, obj be the genlist object and event_info will be
14222 * the genlist item.
14224 * elm_genlist_item_append() adds an item to the end of the list, or if
14225 * there is a parent, to the end of all the child items of the parent.
14226 * elm_genlist_item_prepend() is the same but adds to the beginning of
14227 * the list or children list. elm_genlist_item_insert_before() inserts at
14228 * item before another item and elm_genlist_item_insert_after() inserts after
14229 * the indicated item.
14231 * The application can clear the list with elm_genlist_clear() which deletes
14232 * all the items in the list and elm_genlist_item_del() will delete a specific
14233 * item. elm_genlist_item_subitems_clear() will clear all items that are
14234 * children of the indicated parent item.
14236 * To help inspect list items you can jump to the item at the top of the list
14237 * with elm_genlist_first_item_get() which will return the item pointer, and
14238 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14239 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14240 * and previous items respectively relative to the indicated item. Using
14241 * these calls you can walk the entire item list/tree. Note that as a tree
14242 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14243 * let you know which item is the parent (and thus know how to skip them if
14246 * @section Genlist_Muti_Selection Multi-selection
14248 * If the application wants multiple items to be able to be selected,
14249 * elm_genlist_multi_select_set() can enable this. If the list is
14250 * single-selection only (the default), then elm_genlist_selected_item_get()
14251 * will return the selected item, if any, or NULL I none is selected. If the
14252 * list is multi-select then elm_genlist_selected_items_get() will return a
14253 * list (that is only valid as long as no items are modified (added, deleted,
14254 * selected or unselected)).
14256 * @section Genlist_Usage_Hints Usage hints
14258 * There are also convenience functions. elm_genlist_item_genlist_get() will
14259 * return the genlist object the item belongs to. elm_genlist_item_show()
14260 * will make the scroller scroll to show that specific item so its visible.
14261 * elm_genlist_item_data_get() returns the data pointer set by the item
14262 * creation functions.
14264 * If an item changes (state of boolean changes, label or icons change),
14265 * then use elm_genlist_item_update() to have genlist update the item with
14266 * the new state. Genlist will re-realize the item thus call the functions
14267 * in the _Elm_Genlist_Item_Class for that item.
14269 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14270 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14271 * to expand/contract an item and get its expanded state, use
14272 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14273 * again to make an item disabled (unable to be selected and appear
14274 * differently) use elm_genlist_item_disabled_set() to set this and
14275 * elm_genlist_item_disabled_get() to get the disabled state.
14277 * In general to indicate how the genlist should expand items horizontally to
14278 * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
14279 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14280 * mode means that if items are too wide to fit, the scroller will scroll
14281 * horizontally. Otherwise items are expanded to fill the width of the
14282 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14283 * to the viewport width and limited to that size. This can be combined with
14284 * a different style that uses edjes' ellipsis feature (cutting text off like
14287 * Items will only call their selection func and callback when first becoming
14288 * selected. Any further clicks will do nothing, unless you enable always
14289 * select with elm_genlist_always_select_mode_set(). This means even if
14290 * selected, every click will make the selected callbacks be called.
14291 * elm_genlist_no_select_mode_set() will turn off the ability to select
14292 * items entirely and they will neither appear selected nor call selected
14293 * callback functions.
14295 * Remember that you can create new styles and add your own theme augmentation
14296 * per application with elm_theme_extension_add(). If you absolutely must
14297 * have a specific style that overrides any theme the user or system sets up
14298 * you can use elm_theme_overlay_add() to add such a file.
14300 * @section Genlist_Implementation Implementation
14302 * Evas tracks every object you create. Every time it processes an event
14303 * (mouse move, down, up etc.) it needs to walk through objects and find out
14304 * what event that affects. Even worse every time it renders display updates,
14305 * in order to just calculate what to re-draw, it needs to walk through many
14306 * many many objects. Thus, the more objects you keep active, the more
14307 * overhead Evas has in just doing its work. It is advisable to keep your
14308 * active objects to the minimum working set you need. Also remember that
14309 * object creation and deletion carries an overhead, so there is a
14310 * middle-ground, which is not easily determined. But don't keep massive lists
14311 * of objects you can't see or use. Genlist does this with list objects. It
14312 * creates and destroys them dynamically as you scroll around. It groups them
14313 * into blocks so it can determine the visibility etc. of a whole block at
14314 * once as opposed to having to walk the whole list. This 2-level list allows
14315 * for very large numbers of items to be in the list (tests have used up to
14316 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14317 * may be different sizes, every item added needs to be calculated as to its
14318 * size and thus this presents a lot of overhead on populating the list, this
14319 * genlist employs a queue. Any item added is queued and spooled off over
14320 * time, actually appearing some time later, so if your list has many members
14321 * you may find it takes a while for them to all appear, with your process
14322 * consuming a lot of CPU while it is busy spooling.
14324 * Genlist also implements a tree structure, but it does so with callbacks to
14325 * the application, with the application filling in tree structures when
14326 * requested (allowing for efficient building of a very deep tree that could
14327 * even be used for file-management). See the above smart signal callbacks for
14330 * @section Genlist_Smart_Events Genlist smart events
14332 * Signals that you can add callbacks for are:
14333 * - @c "activated" - The user has double-clicked or pressed
14334 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14335 * item that was activated.
14336 * - @c "clicked,double" - The user has double-clicked an item. The @c
14337 * event_info parameter is the item that was double-clicked.
14338 * - @c "selected" - This is called when a user has made an item selected.
14339 * The event_info parameter is the genlist item that was selected.
14340 * - @c "unselected" - This is called when a user has made an item
14341 * unselected. The event_info parameter is the genlist item that was
14343 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14344 * called and the item is now meant to be expanded. The event_info
14345 * parameter is the genlist item that was indicated to expand. It is the
14346 * job of this callback to then fill in the child items.
14347 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14348 * called and the item is now meant to be contracted. The event_info
14349 * parameter is the genlist item that was indicated to contract. It is the
14350 * job of this callback to then delete the child items.
14351 * - @c "expand,request" - This is called when a user has indicated they want
14352 * to expand a tree branch item. The callback should decide if the item can
14353 * expand (has any children) and then call elm_genlist_item_expanded_set()
14354 * appropriately to set the state. The event_info parameter is the genlist
14355 * item that was indicated to expand.
14356 * - @c "contract,request" - This is called when a user has indicated they
14357 * want to contract a tree branch item. The callback should decide if the
14358 * item can contract (has any children) and then call
14359 * elm_genlist_item_expanded_set() appropriately to set the state. The
14360 * event_info parameter is the genlist item that was indicated to contract.
14361 * - @c "realized" - This is called when the item in the list is created as a
14362 * real evas object. event_info parameter is the genlist item that was
14363 * created. The object may be deleted at any time, so it is up to the
14364 * caller to not use the object pointer from elm_genlist_item_object_get()
14365 * in a way where it may point to freed objects.
14366 * - @c "unrealized" - This is called just before an item is unrealized.
14367 * After this call icon objects provided will be deleted and the item
14368 * object itself delete or be put into a floating cache.
14369 * - @c "drag,start,up" - This is called when the item in the list has been
14370 * dragged (not scrolled) up.
14371 * - @c "drag,start,down" - This is called when the item in the list has been
14372 * dragged (not scrolled) down.
14373 * - @c "drag,start,left" - This is called when the item in the list has been
14374 * dragged (not scrolled) left.
14375 * - @c "drag,start,right" - This is called when the item in the list has
14376 * been dragged (not scrolled) right.
14377 * - @c "drag,stop" - This is called when the item in the list has stopped
14379 * - @c "drag" - This is called when the item in the list is being dragged.
14380 * - @c "longpressed" - This is called when the item is pressed for a certain
14381 * amount of time. By default it's 1 second.
14382 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14384 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14385 * until the bottom edge.
14386 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14387 * until the left edge.
14388 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14389 * until the right edge.
14390 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14392 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14394 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14396 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14398 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14399 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14400 * multi-touch pinched in.
14401 * - @c "swipe" - This is called when the genlist is swiped.
14403 * @section Genlist_Examples Examples
14405 * Here is a list of examples that use the genlist, trying to show some of
14406 * its capabilities:
14407 * - @ref genlist_example_01
14408 * - @ref genlist_example_02
14409 * - @ref genlist_example_03
14410 * - @ref genlist_example_04
14411 * - @ref genlist_example_05
14415 * @addtogroup Genlist
14420 * @enum _Elm_Genlist_Item_Flags
14421 * @typedef Elm_Genlist_Item_Flags
14423 * Defines if the item is of any special type (has subitems or it's the
14424 * index of a group), or is just a simple item.
14428 typedef enum _Elm_Genlist_Item_Flags
14430 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14431 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14432 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14433 } Elm_Genlist_Item_Flags;
14434 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14435 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14436 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14437 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14438 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14439 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14440 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14441 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14444 * @struct _Elm_Genlist_Item_Class
14446 * Genlist item class definition structs.
14448 * This struct contains the style and fetching functions that will define the
14449 * contents of each item.
14451 * @see @ref Genlist_Item_Class
14453 struct _Elm_Genlist_Item_Class
14455 const char *item_style; /**< style of this class. */
14458 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14459 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14460 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14461 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14462 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14464 const char *mode_item_style;
14468 * Add a new genlist widget to the given parent Elementary
14469 * (container) object
14471 * @param parent The parent object
14472 * @return a new genlist widget handle or @c NULL, on errors
14474 * This function inserts a new genlist widget on the canvas.
14476 * @see elm_genlist_item_append()
14477 * @see elm_genlist_item_del()
14478 * @see elm_genlist_clear()
14482 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14484 * Remove all items from a given genlist widget.
14486 * @param obj The genlist object
14488 * This removes (and deletes) all items in @p obj, leaving it empty.
14490 * @see elm_genlist_item_del(), to remove just one item.
14494 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14496 * Enable or disable multi-selection in the genlist
14498 * @param obj The genlist object
14499 * @param multi Multi-select enable/disable. Default is disabled.
14501 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14502 * the list. This allows more than 1 item to be selected. To retrieve the list
14503 * of selected items, use elm_genlist_selected_items_get().
14505 * @see elm_genlist_selected_items_get()
14506 * @see elm_genlist_multi_select_get()
14510 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14512 * Gets if multi-selection in genlist is enabled or disabled.
14514 * @param obj The genlist object
14515 * @return Multi-select enabled/disabled
14516 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14518 * @see elm_genlist_multi_select_set()
14522 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14524 * This sets the horizontal stretching mode.
14526 * @param obj The genlist object
14527 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14529 * This sets the mode used for sizing items horizontally. Valid modes
14530 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14531 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14532 * the scroller will scroll horizontally. Otherwise items are expanded
14533 * to fill the width of the viewport of the scroller. If it is
14534 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14535 * limited to that size.
14537 * @see elm_genlist_horizontal_mode_get()
14541 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14543 * Gets the horizontal stretching mode.
14545 * @param obj The genlist object
14546 * @return The mode to use
14547 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14549 * @see elm_genlist_horizontal_mode_set()
14553 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14555 * Set the always select mode.
14557 * @param obj The genlist object
14558 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14559 * EINA_FALSE = off). Default is @c EINA_FALSE.
14561 * Items will only call their selection func and callback when first
14562 * becoming selected. Any further clicks will do nothing, unless you
14563 * enable always select with elm_genlist_always_select_mode_set().
14564 * This means that, even if selected, every click will make the selected
14565 * callbacks be called.
14567 * @see elm_genlist_always_select_mode_get()
14571 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14573 * Get the always select mode.
14575 * @param obj The genlist object
14576 * @return The always select mode
14577 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14579 * @see elm_genlist_always_select_mode_set()
14583 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14585 * Enable/disable the no select mode.
14587 * @param obj The genlist object
14588 * @param no_select The no select mode
14589 * (EINA_TRUE = on, EINA_FALSE = off)
14591 * This will turn off the ability to select items entirely and they
14592 * will neither appear selected nor call selected callback functions.
14594 * @see elm_genlist_no_select_mode_get()
14598 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14600 * Gets whether the no select mode is enabled.
14602 * @param obj The genlist object
14603 * @return The no select mode
14604 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14606 * @see elm_genlist_no_select_mode_set()
14610 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14612 * Enable/disable compress mode.
14614 * @param obj The genlist object
14615 * @param compress The compress mode
14616 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14618 * This will enable the compress mode where items are "compressed"
14619 * horizontally to fit the genlist scrollable viewport width. This is
14620 * special for genlist. Do not rely on
14621 * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
14622 * work as genlist needs to handle it specially.
14624 * @see elm_genlist_compress_mode_get()
14628 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14630 * Get whether the compress mode is enabled.
14632 * @param obj The genlist object
14633 * @return The compress mode
14634 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14636 * @see elm_genlist_compress_mode_set()
14640 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14642 * Enable/disable height-for-width mode.
14644 * @param obj The genlist object
14645 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14646 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14648 * With height-for-width mode the item width will be fixed (restricted
14649 * to a minimum of) to the list width when calculating its size in
14650 * order to allow the height to be calculated based on it. This allows,
14651 * for instance, text block to wrap lines if the Edje part is
14652 * configured with "text.min: 0 1".
14654 * @note This mode will make list resize slower as it will have to
14655 * recalculate every item height again whenever the list width
14658 * @note When height-for-width mode is enabled, it also enables
14659 * compress mode (see elm_genlist_compress_mode_set()) and
14660 * disables homogeneous (see elm_genlist_homogeneous_set()).
14664 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14666 * Get whether the height-for-width mode is enabled.
14668 * @param obj The genlist object
14669 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14674 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14676 * Enable/disable horizontal and vertical bouncing effect.
14678 * @param obj The genlist object
14679 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14680 * EINA_FALSE = off). Default is @c EINA_FALSE.
14681 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14682 * EINA_FALSE = off). Default is @c EINA_TRUE.
14684 * This will enable or disable the scroller bouncing effect for the
14685 * genlist. See elm_scroller_bounce_set() for details.
14687 * @see elm_scroller_bounce_set()
14688 * @see elm_genlist_bounce_get()
14692 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14694 * Get whether the horizontal and vertical bouncing effect is enabled.
14696 * @param obj The genlist object
14697 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14699 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14702 * @see elm_genlist_bounce_set()
14706 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14708 * Enable/disable homogenous mode.
14710 * @param obj The genlist object
14711 * @param homogeneous Assume the items within the genlist are of the
14712 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14715 * This will enable the homogeneous mode where items are of the same
14716 * height and width so that genlist may do the lazy-loading at its
14717 * maximum (which increases the performance for scrolling the list). This
14718 * implies 'compressed' mode.
14720 * @see elm_genlist_compress_mode_set()
14721 * @see elm_genlist_homogeneous_get()
14725 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14727 * Get whether the homogenous mode is enabled.
14729 * @param obj The genlist object
14730 * @return Assume the items within the genlist are of the same height
14731 * and width (EINA_TRUE = on, EINA_FALSE = off)
14733 * @see elm_genlist_homogeneous_set()
14737 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14739 * Set the maximum number of items within an item block
14741 * @param obj The genlist object
14742 * @param n Maximum number of items within an item block. Default is 32.
14744 * This will configure the block count to tune to the target with
14745 * particular performance matrix.
14747 * A block of objects will be used to reduce the number of operations due to
14748 * many objects in the screen. It can determine the visibility, or if the
14749 * object has changed, it theme needs to be updated, etc. doing this kind of
14750 * calculation to the entire block, instead of per object.
14752 * The default value for the block count is enough for most lists, so unless
14753 * you know you will have a lot of objects visible in the screen at the same
14754 * time, don't try to change this.
14756 * @see elm_genlist_block_count_get()
14757 * @see @ref Genlist_Implementation
14761 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14763 * Get the maximum number of items within an item block
14765 * @param obj The genlist object
14766 * @return Maximum number of items within an item block
14768 * @see elm_genlist_block_count_set()
14772 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14774 * Set the timeout in seconds for the longpress event.
14776 * @param obj The genlist object
14777 * @param timeout timeout in seconds. Default is 1.
14779 * This option will change how long it takes to send an event "longpressed"
14780 * after the mouse down signal is sent to the list. If this event occurs, no
14781 * "clicked" event will be sent.
14783 * @see elm_genlist_longpress_timeout_set()
14787 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14789 * Get the timeout in seconds for the longpress event.
14791 * @param obj The genlist object
14792 * @return timeout in seconds
14794 * @see elm_genlist_longpress_timeout_get()
14798 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14800 * Append a new item in a given genlist widget.
14802 * @param obj The genlist object
14803 * @param itc The item class for the item
14804 * @param data The item data
14805 * @param parent The parent item, or NULL if none
14806 * @param flags Item flags
14807 * @param func Convenience function called when the item is selected
14808 * @param func_data Data passed to @p func above.
14809 * @return A handle to the item added or @c NULL if not possible
14811 * This adds the given item to the end of the list or the end of
14812 * the children list if the @p parent is given.
14814 * @see elm_genlist_item_prepend()
14815 * @see elm_genlist_item_insert_before()
14816 * @see elm_genlist_item_insert_after()
14817 * @see elm_genlist_item_del()
14821 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);
14823 * Prepend a new item in a given genlist widget.
14825 * @param obj The genlist object
14826 * @param itc The item class for the item
14827 * @param data The item data
14828 * @param parent The parent item, or NULL if none
14829 * @param flags Item flags
14830 * @param func Convenience function called when the item is selected
14831 * @param func_data Data passed to @p func above.
14832 * @return A handle to the item added or NULL if not possible
14834 * This adds an item to the beginning of the list or beginning of the
14835 * children of the parent if given.
14837 * @see elm_genlist_item_append()
14838 * @see elm_genlist_item_insert_before()
14839 * @see elm_genlist_item_insert_after()
14840 * @see elm_genlist_item_del()
14844 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);
14846 * Insert an item before another in a genlist widget
14848 * @param obj The genlist object
14849 * @param itc The item class for the item
14850 * @param data The item data
14851 * @param before The item to place this new one before.
14852 * @param flags Item flags
14853 * @param func Convenience function called when the item is selected
14854 * @param func_data Data passed to @p func above.
14855 * @return A handle to the item added or @c NULL if not possible
14857 * This inserts an item before another in the list. It will be in the
14858 * same tree level or group as the item it is inserted before.
14860 * @see elm_genlist_item_append()
14861 * @see elm_genlist_item_prepend()
14862 * @see elm_genlist_item_insert_after()
14863 * @see elm_genlist_item_del()
14867 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);
14869 * Insert an item after another in a genlist widget
14871 * @param obj The genlist object
14872 * @param itc The item class for the item
14873 * @param data The item data
14874 * @param after The item to place this new one after.
14875 * @param flags Item flags
14876 * @param func Convenience function called when the item is selected
14877 * @param func_data Data passed to @p func above.
14878 * @return A handle to the item added or @c NULL if not possible
14880 * This inserts an item after another in the list. It will be in the
14881 * same tree level or group as the item it is inserted after.
14883 * @see elm_genlist_item_append()
14884 * @see elm_genlist_item_prepend()
14885 * @see elm_genlist_item_insert_before()
14886 * @see elm_genlist_item_del()
14890 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);
14892 * Insert a new item into the sorted genlist object
14894 * @param obj The genlist object
14895 * @param itc The item class for the item
14896 * @param data The item data
14897 * @param parent The parent item, or NULL if none
14898 * @param flags Item flags
14899 * @param comp The function called for the sort
14900 * @param func Convenience function called when item selected
14901 * @param func_data Data passed to @p func above.
14902 * @return A handle to the item added or NULL if not possible
14906 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);
14907 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);
14908 /* operations to retrieve existing items */
14910 * Get the selectd item in the genlist.
14912 * @param obj The genlist object
14913 * @return The selected item, or NULL if none is selected.
14915 * This gets the selected item in the list (if multi-selection is enabled, only
14916 * the item that was first selected in the list is returned - which is not very
14917 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14920 * If no item is selected, NULL is returned.
14922 * @see elm_genlist_selected_items_get()
14926 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14928 * Get a list of selected items in the genlist.
14930 * @param obj The genlist object
14931 * @return The list of selected items, or NULL if none are selected.
14933 * It returns a list of the selected items. This list pointer is only valid so
14934 * long as the selection doesn't change (no items are selected or unselected, or
14935 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14936 * pointers. The order of the items in this list is the order which they were
14937 * selected, i.e. the first item in this list is the first item that was
14938 * selected, and so on.
14940 * @note If not in multi-select mode, consider using function
14941 * elm_genlist_selected_item_get() instead.
14943 * @see elm_genlist_multi_select_set()
14944 * @see elm_genlist_selected_item_get()
14948 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14950 * Get a list of realized items in genlist
14952 * @param obj The genlist object
14953 * @return The list of realized items, nor NULL if none are realized.
14955 * This returns a list of the realized items in the genlist. The list
14956 * contains Elm_Genlist_Item pointers. The list must be freed by the
14957 * caller when done with eina_list_free(). The item pointers in the
14958 * list are only valid so long as those items are not deleted or the
14959 * genlist is not deleted.
14961 * @see elm_genlist_realized_items_update()
14965 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14967 * Get the item that is at the x, y canvas coords.
14969 * @param obj The gelinst object.
14970 * @param x The input x coordinate
14971 * @param y The input y coordinate
14972 * @param posret The position relative to the item returned here
14973 * @return The item at the coordinates or NULL if none
14975 * This returns the item at the given coordinates (which are canvas
14976 * relative, not object-relative). If an item is at that coordinate,
14977 * that item handle is returned, and if @p posret is not NULL, the
14978 * integer pointed to is set to a value of -1, 0 or 1, depending if
14979 * the coordinate is on the upper portion of that item (-1), on the
14980 * middle section (0) or on the lower part (1). If NULL is returned as
14981 * an item (no item found there), then posret may indicate -1 or 1
14982 * based if the coordinate is above or below all items respectively in
14987 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);
14989 * Get the first item in the genlist
14991 * This returns the first item in the list.
14993 * @param obj The genlist object
14994 * @return The first item, or NULL if none
14998 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15000 * Get the last item in the genlist
15002 * This returns the last item in the list.
15004 * @return The last item, or NULL if none
15008 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15010 * Set the scrollbar policy
15012 * @param obj The genlist object
15013 * @param policy_h Horizontal scrollbar policy.
15014 * @param policy_v Vertical scrollbar policy.
15016 * This sets the scrollbar visibility policy for the given genlist
15017 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15018 * made visible if it is needed, and otherwise kept hidden.
15019 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15020 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15021 * respectively for the horizontal and vertical scrollbars. Default is
15022 * #ELM_SMART_SCROLLER_POLICY_AUTO
15024 * @see elm_genlist_scroller_policy_get()
15028 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15030 * Get the scrollbar policy
15032 * @param obj The genlist object
15033 * @param policy_h Pointer to store the horizontal scrollbar policy.
15034 * @param policy_v Pointer to store the vertical scrollbar policy.
15036 * @see elm_genlist_scroller_policy_set()
15040 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);
15042 * Get the @b next item in a genlist widget's internal list of items,
15043 * given a handle to one of those items.
15045 * @param item The genlist item to fetch next from
15046 * @return The item after @p item, or @c NULL if there's none (and
15049 * This returns the item placed after the @p item, on the container
15052 * @see elm_genlist_item_prev_get()
15056 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15058 * Get the @b previous item in a genlist widget's internal list of items,
15059 * given a handle to one of those items.
15061 * @param item The genlist item to fetch previous from
15062 * @return The item before @p item, or @c NULL if there's none (and
15065 * This returns the item placed before the @p item, on the container
15068 * @see elm_genlist_item_next_get()
15072 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15074 * Get the genlist object's handle which contains a given genlist
15077 * @param item The item to fetch the container from
15078 * @return The genlist (parent) object
15080 * This returns the genlist object itself that an item belongs to.
15084 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15086 * Get the parent item of the given item
15088 * @param it The item
15089 * @return The parent of the item or @c NULL if it has no parent.
15091 * This returns the item that was specified as parent of the item @p it on
15092 * elm_genlist_item_append() and insertion related functions.
15096 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15098 * Remove all sub-items (children) of the given item
15100 * @param it The item
15102 * This removes all items that are children (and their descendants) of the
15103 * given item @p it.
15105 * @see elm_genlist_clear()
15106 * @see elm_genlist_item_del()
15110 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15112 * Set whether a given genlist item is selected or not
15114 * @param it The item
15115 * @param selected Use @c EINA_TRUE, to make it selected, @c
15116 * EINA_FALSE to make it unselected
15118 * This sets the selected state of an item. If multi selection is
15119 * not enabled on the containing genlist and @p selected is @c
15120 * EINA_TRUE, any other previously selected items will get
15121 * unselected in favor of this new one.
15123 * @see elm_genlist_item_selected_get()
15127 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15129 * Get whether a given genlist item is selected or not
15131 * @param it The item
15132 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15134 * @see elm_genlist_item_selected_set() for more details
15138 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15140 * Sets the expanded state of an item.
15142 * @param it The item
15143 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15145 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15148 * The theme will respond to this change visually, and a signal "expanded" or
15149 * "contracted" will be sent from the genlist with a pointer to the item that
15150 * has been expanded/contracted.
15152 * Calling this function won't show or hide any child of this item (if it is
15153 * a parent). You must manually delete and create them on the callbacks fo
15154 * the "expanded" or "contracted" signals.
15156 * @see elm_genlist_item_expanded_get()
15160 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15162 * Get the expanded state of an item
15164 * @param it The item
15165 * @return The expanded state
15167 * This gets the expanded state of an item.
15169 * @see elm_genlist_item_expanded_set()
15173 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15175 * Get the depth of expanded item
15177 * @param it The genlist item object
15178 * @return The depth of expanded item
15182 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15184 * Set whether a given genlist item is disabled or not.
15186 * @param it The item
15187 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15188 * to enable it back.
15190 * A disabled item cannot be selected or unselected. It will also
15191 * change its appearance, to signal the user it's disabled.
15193 * @see elm_genlist_item_disabled_get()
15197 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15199 * Get whether a given genlist item is disabled or not.
15201 * @param it The item
15202 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15205 * @see elm_genlist_item_disabled_set() for more details
15209 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15211 * Sets the display only state of an item.
15213 * @param it The item
15214 * @param display_only @c EINA_TRUE if the item is display only, @c
15215 * EINA_FALSE otherwise.
15217 * A display only item cannot be selected or unselected. It is for
15218 * display only and not selecting or otherwise clicking, dragging
15219 * etc. by the user, thus finger size rules will not be applied to
15222 * It's good to set group index items to display only state.
15224 * @see elm_genlist_item_display_only_get()
15228 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15230 * Get the display only state of an item
15232 * @param it The item
15233 * @return @c EINA_TRUE if the item is display only, @c
15234 * EINA_FALSE otherwise.
15236 * @see elm_genlist_item_display_only_set()
15240 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15242 * Show the portion of a genlist's internal list containing a given
15243 * item, immediately.
15245 * @param it The item to display
15247 * This causes genlist to jump to the given item @p it and show it (by
15248 * immediately scrolling to that position), if it is not fully visible.
15250 * @see elm_genlist_item_bring_in()
15251 * @see elm_genlist_item_top_show()
15252 * @see elm_genlist_item_middle_show()
15256 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15258 * Animatedly bring in, to the visible are of a genlist, a given
15261 * @param it The item to display
15263 * This causes genlist to jump to the given item @p it and show it (by
15264 * animatedly scrolling), if it is not fully visible. This may use animation
15265 * to do so and take a period of time
15267 * @see elm_genlist_item_show()
15268 * @see elm_genlist_item_top_bring_in()
15269 * @see elm_genlist_item_middle_bring_in()
15273 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15275 * Show the portion of a genlist's internal list containing a given
15276 * item, immediately.
15278 * @param it The item to display
15280 * This causes genlist to jump to the given item @p it and show it (by
15281 * immediately scrolling to that position), if it is not fully visible.
15283 * The item will be positioned at the top of the genlist viewport.
15285 * @see elm_genlist_item_show()
15286 * @see elm_genlist_item_top_bring_in()
15290 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15292 * Animatedly bring in, to the visible are of a genlist, a given
15295 * @param it The item
15297 * This causes genlist to jump to the given item @p it and show it (by
15298 * animatedly scrolling), if it is not fully visible. This may use animation
15299 * to do so and take a period of time
15301 * The item will be positioned at the top of the genlist viewport.
15303 * @see elm_genlist_item_bring_in()
15304 * @see elm_genlist_item_top_show()
15308 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15310 * Show the portion of a genlist's internal list containing a given
15311 * item, immediately.
15313 * @param it The item to display
15315 * This causes genlist to jump to the given item @p it and show it (by
15316 * immediately scrolling to that position), if it is not fully visible.
15318 * The item will be positioned at the middle of the genlist viewport.
15320 * @see elm_genlist_item_show()
15321 * @see elm_genlist_item_middle_bring_in()
15325 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15327 * Animatedly bring in, to the visible are of a genlist, a given
15330 * @param it The item
15332 * This causes genlist to jump to the given item @p it and show it (by
15333 * animatedly scrolling), if it is not fully visible. This may use animation
15334 * to do so and take a period of time
15336 * The item will be positioned at the middle of the genlist viewport.
15338 * @see elm_genlist_item_bring_in()
15339 * @see elm_genlist_item_middle_show()
15343 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15345 * Remove a genlist item from the its parent, deleting it.
15347 * @param item The item to be removed.
15348 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15350 * @see elm_genlist_clear(), to remove all items in a genlist at
15355 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15357 * Return the data associated to a given genlist item
15359 * @param item The genlist item.
15360 * @return the data associated to this item.
15362 * This returns the @c data value passed on the
15363 * elm_genlist_item_append() and related item addition calls.
15365 * @see elm_genlist_item_append()
15366 * @see elm_genlist_item_data_set()
15370 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15372 * Set the data associated to a given genlist item
15374 * @param item The genlist item
15375 * @param data The new data pointer to set on it
15377 * This @b overrides the @c data value passed on the
15378 * elm_genlist_item_append() and related item addition calls. This
15379 * function @b won't call elm_genlist_item_update() automatically,
15380 * so you'd issue it afterwards if you want to hove the item
15381 * updated to reflect the that new data.
15383 * @see elm_genlist_item_data_get()
15387 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15389 * Tells genlist to "orphan" icons fetchs by the item class
15391 * @param it The item
15393 * This instructs genlist to release references to icons in the item,
15394 * meaning that they will no longer be managed by genlist and are
15395 * floating "orphans" that can be re-used elsewhere if the user wants
15400 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15402 * Get the real Evas object created to implement the view of a
15403 * given genlist item
15405 * @param item The genlist item.
15406 * @return the Evas object implementing this item's view.
15408 * This returns the actual Evas object used to implement the
15409 * specified genlist item's view. This may be @c NULL, as it may
15410 * not have been created or may have been deleted, at any time, by
15411 * the genlist. <b>Do not modify this object</b> (move, resize,
15412 * show, hide, etc.), as the genlist is controlling it. This
15413 * function is for querying, emitting custom signals or hooking
15414 * lower level callbacks for events on that object. Do not delete
15415 * this object under any circumstances.
15417 * @see elm_genlist_item_data_get()
15421 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15423 * Update the contents of an item
15425 * @param it The item
15427 * This updates an item by calling all the item class functions again
15428 * to get the icons, labels and states. Use this when the original
15429 * item data has changed and the changes are desired to be reflected.
15431 * Use elm_genlist_realized_items_update() to update all already realized
15434 * @see elm_genlist_realized_items_update()
15438 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15440 * Update the item class of an item
15442 * @param it The item
15443 * @parem itc The item class for the item
15445 * This sets another class fo the item, changing the way that it is
15446 * displayed. After changing the item class, elm_genlist_item_update() is
15447 * called on the item @p it.
15451 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15452 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15454 * Set the text to be shown in a given genlist item's tooltips.
15456 * @param item The genlist item
15457 * @param text The text to set in the content
15459 * This call will setup the text to be used as tooltip to that item
15460 * (analogous to elm_object_tooltip_text_set(), but being item
15461 * tooltips with higher precedence than object tooltips). It can
15462 * have only one tooltip at a time, so any previous tooltip data
15463 * will get removed.
15465 * In order to set an icon or something else as a tooltip, look at
15466 * elm_genlist_item_tooltip_content_cb_set().
15470 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15472 * Set the content to be shown in a given genlist item's tooltips
15474 * @param item The genlist item.
15475 * @param func The function returning the tooltip contents.
15476 * @param data What to provide to @a func as callback data/context.
15477 * @param del_cb Called when data is not needed anymore, either when
15478 * another callback replaces @func, the tooltip is unset with
15479 * elm_genlist_item_tooltip_unset() or the owner @p item
15480 * dies. This callback receives as its first parameter the
15481 * given @p data, being @c event_info the item handle.
15483 * This call will setup the tooltip's contents to @p item
15484 * (analogous to elm_object_tooltip_content_cb_set(), but being
15485 * item tooltips with higher precedence than object tooltips). It
15486 * can have only one tooltip at a time, so any previous tooltip
15487 * content will get removed. @p func (with @p data) will be called
15488 * every time Elementary needs to show the tooltip and it should
15489 * return a valid Evas object, which will be fully managed by the
15490 * tooltip system, getting deleted when the tooltip is gone.
15492 * In order to set just a text as a tooltip, look at
15493 * elm_genlist_item_tooltip_text_set().
15497 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);
15499 * Unset a tooltip from a given genlist item
15501 * @param item genlist item to remove a previously set tooltip from.
15503 * This call removes any tooltip set on @p item. The callback
15504 * provided as @c del_cb to
15505 * elm_genlist_item_tooltip_content_cb_set() will be called to
15506 * notify it is not used anymore (and have resources cleaned, if
15509 * @see elm_genlist_item_tooltip_content_cb_set()
15513 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15515 * Set a different @b style for a given genlist item's tooltip.
15517 * @param item genlist item with tooltip set
15518 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15519 * "default", @c "transparent", etc)
15521 * Tooltips can have <b>alternate styles</b> to be displayed on,
15522 * which are defined by the theme set on Elementary. This function
15523 * works analogously as elm_object_tooltip_style_set(), but here
15524 * applied only to genlist item objects. The default style for
15525 * tooltips is @c "default".
15527 * @note before you set a style you should define a tooltip with
15528 * elm_genlist_item_tooltip_content_cb_set() or
15529 * elm_genlist_item_tooltip_text_set()
15531 * @see elm_genlist_item_tooltip_style_get()
15535 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15537 * Get the style set a given genlist item's tooltip.
15539 * @param item genlist item with tooltip already set on.
15540 * @return style the theme style in use, which defaults to
15541 * "default". If the object does not have a tooltip set,
15542 * then @c NULL is returned.
15544 * @see elm_genlist_item_tooltip_style_set() for more details
15548 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15550 * @brief Disable size restrictions on an object's tooltip
15551 * @param item The tooltip's anchor object
15552 * @param disable If EINA_TRUE, size restrictions are disabled
15553 * @return EINA_FALSE on failure, EINA_TRUE on success
15555 * This function allows a tooltip to expand beyond its parant window's canvas.
15556 * It will instead be limited only by the size of the display.
15558 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15560 * @brief Retrieve size restriction state of an object's tooltip
15561 * @param item The tooltip's anchor object
15562 * @return If EINA_TRUE, size restrictions are disabled
15564 * This function returns whether a tooltip is allowed to expand beyond
15565 * its parant window's canvas.
15566 * It will instead be limited only by the size of the display.
15568 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15570 * Set the type of mouse pointer/cursor decoration to be shown,
15571 * when the mouse pointer is over the given genlist widget item
15573 * @param item genlist item to customize cursor on
15574 * @param cursor the cursor type's name
15576 * This function works analogously as elm_object_cursor_set(), but
15577 * here the cursor's changing area is restricted to the item's
15578 * area, and not the whole widget's. Note that that item cursors
15579 * have precedence over widget cursors, so that a mouse over @p
15580 * item will always show cursor @p type.
15582 * If this function is called twice for an object, a previously set
15583 * cursor will be unset on the second call.
15585 * @see elm_object_cursor_set()
15586 * @see elm_genlist_item_cursor_get()
15587 * @see elm_genlist_item_cursor_unset()
15591 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15593 * Get the type of mouse pointer/cursor decoration set to be shown,
15594 * when the mouse pointer is over the given genlist widget item
15596 * @param item genlist item with custom cursor set
15597 * @return the cursor type's name or @c NULL, if no custom cursors
15598 * were set to @p item (and on errors)
15600 * @see elm_object_cursor_get()
15601 * @see elm_genlist_item_cursor_set() for more details
15602 * @see elm_genlist_item_cursor_unset()
15606 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15608 * Unset any custom mouse pointer/cursor decoration set to be
15609 * shown, when the mouse pointer is over the given genlist widget
15610 * item, thus making it show the @b default cursor again.
15612 * @param item a genlist item
15614 * Use this call to undo any custom settings on this item's cursor
15615 * decoration, bringing it back to defaults (no custom style set).
15617 * @see elm_object_cursor_unset()
15618 * @see elm_genlist_item_cursor_set() for more details
15622 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15624 * Set a different @b style for a given custom cursor set for a
15627 * @param item genlist item with custom cursor set
15628 * @param style the <b>theme style</b> to use (e.g. @c "default",
15629 * @c "transparent", etc)
15631 * This function only makes sense when one is using custom mouse
15632 * cursor decorations <b>defined in a theme file</b> , which can
15633 * have, given a cursor name/type, <b>alternate styles</b> on
15634 * it. It works analogously as elm_object_cursor_style_set(), but
15635 * here applied only to genlist item objects.
15637 * @warning Before you set a cursor style you should have defined a
15638 * custom cursor previously on the item, with
15639 * elm_genlist_item_cursor_set()
15641 * @see elm_genlist_item_cursor_engine_only_set()
15642 * @see elm_genlist_item_cursor_style_get()
15646 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15648 * Get the current @b style set for a given genlist item's custom
15651 * @param item genlist item with custom cursor set.
15652 * @return style the cursor style in use. If the object does not
15653 * have a cursor set, then @c NULL is returned.
15655 * @see elm_genlist_item_cursor_style_set() for more details
15659 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15661 * Set if the (custom) cursor for a given genlist item should be
15662 * searched in its theme, also, or should only rely on the
15663 * rendering engine.
15665 * @param item item with custom (custom) cursor already set on
15666 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15667 * only on those provided by the rendering engine, @c EINA_FALSE to
15668 * have them searched on the widget's theme, as well.
15670 * @note This call is of use only if you've set a custom cursor
15671 * for genlist items, with elm_genlist_item_cursor_set().
15673 * @note By default, cursors will only be looked for between those
15674 * provided by the rendering engine.
15678 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15680 * Get if the (custom) cursor for a given genlist item is being
15681 * searched in its theme, also, or is only relying on the rendering
15684 * @param item a genlist item
15685 * @return @c EINA_TRUE, if cursors are being looked for only on
15686 * those provided by the rendering engine, @c EINA_FALSE if they
15687 * are being searched on the widget's theme, as well.
15689 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15693 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15695 * Update the contents of all realized items.
15697 * @param obj The genlist object.
15699 * This updates all realized items by calling all the item class functions again
15700 * to get the icons, labels and states. Use this when the original
15701 * item data has changed and the changes are desired to be reflected.
15703 * To update just one item, use elm_genlist_item_update().
15705 * @see elm_genlist_realized_items_get()
15706 * @see elm_genlist_item_update()
15710 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15711 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15712 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15713 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15714 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15715 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15722 * @defgroup Check Check
15724 * @image html img/widget/button/preview-00.png
15725 * @image html img/widget/button/preview-01.png
15726 * @image html img/widget/button/preview-02.png
15728 * @brief The check widget allows for toggling a value between true and
15731 * Check objects are a lot like radio objects in layout and functionality
15732 * except they do not work as a group, but independently and only toggle the
15733 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15734 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15735 * returns the current state. For convenience, like the radio objects, you
15736 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15737 * for it to modify.
15739 * Signals that you can add callbacks for are:
15740 * "changed" - This is called whenever the user changes the state of one of
15741 * the check object(event_info is NULL).
15743 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15747 * @brief Add a new Check object
15749 * @param parent The parent object
15750 * @return The new object or NULL if it cannot be created
15752 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15754 * @brief Set the text label of the check object
15756 * @param obj The check object
15757 * @param label The text label string in UTF-8
15759 * @deprecated use elm_object_text_set() instead.
15761 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15763 * @brief Get the text label of the check object
15765 * @param obj The check object
15766 * @return The text label string in UTF-8
15768 * @deprecated use elm_object_text_get() instead.
15770 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15772 * @brief Set the icon object of the check object
15774 * @param obj The check object
15775 * @param icon The icon object
15777 * Once the icon object is set, a previously set one will be deleted.
15778 * If you want to keep that old content object, use the
15779 * elm_check_icon_unset() function.
15781 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15783 * @brief Get the icon object of the check object
15785 * @param obj The check object
15786 * @return The icon object
15788 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15790 * @brief Unset the icon used for the check object
15792 * @param obj The check object
15793 * @return The icon object that was being used
15795 * Unparent and return the icon object which was set for this widget.
15797 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15799 * @brief Set the on/off state of the check object
15801 * @param obj The check object
15802 * @param state The state to use (1 == on, 0 == off)
15804 * This sets the state of the check. If set
15805 * with elm_check_state_pointer_set() the state of that variable is also
15806 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15808 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15810 * @brief Get the state of the check object
15812 * @param obj The check object
15813 * @return The boolean state
15815 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15817 * @brief Set a convenience pointer to a boolean to change
15819 * @param obj The check object
15820 * @param statep Pointer to the boolean to modify
15822 * This sets a pointer to a boolean, that, in addition to the check objects
15823 * state will also be modified directly. To stop setting the object pointed
15824 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15825 * then when this is called, the check objects state will also be modified to
15826 * reflect the value of the boolean @p statep points to, just like calling
15827 * elm_check_state_set().
15829 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15835 * @defgroup Radio Radio
15837 * @image html img/widget/radio/preview-00.png
15838 * @image latex img/widget/radio/preview-00.eps
15840 * @brief Radio is a widget that allows for 1 or more options to be displayed
15841 * and have the user choose only 1 of them.
15843 * A radio object contains an indicator, an optional Label and an optional
15844 * icon object. While it's possible to have a group of only one radio they,
15845 * are normally used in groups of 2 or more. To add a radio to a group use
15846 * elm_radio_group_add(). The radio object(s) will select from one of a set
15847 * of integer values, so any value they are configuring needs to be mapped to
15848 * a set of integers. To configure what value that radio object represents,
15849 * use elm_radio_state_value_set() to set the integer it represents. To set
15850 * the value the whole group(which one is currently selected) is to indicate
15851 * use elm_radio_value_set() on any group member, and to get the groups value
15852 * use elm_radio_value_get(). For convenience the radio objects are also able
15853 * to directly set an integer(int) to the value that is selected. To specify
15854 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15855 * The radio objects will modify this directly. That implies the pointer must
15856 * point to valid memory for as long as the radio objects exist.
15858 * Signals that you can add callbacks for are:
15859 * @li changed - This is called whenever the user changes the state of one of
15860 * the radio objects within the group of radio objects that work together.
15862 * @ref tutorial_radio show most of this API in action.
15866 * @brief Add a new radio to the parent
15868 * @param parent The parent object
15869 * @return The new object or NULL if it cannot be created
15871 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15873 * @brief Set the text label of the radio object
15875 * @param obj The radio object
15876 * @param label The text label string in UTF-8
15878 * @deprecated use elm_object_text_set() instead.
15880 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15882 * @brief Get the text label of the radio object
15884 * @param obj The radio object
15885 * @return The text label string in UTF-8
15887 * @deprecated use elm_object_text_set() instead.
15889 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15891 * @brief Set the icon object of the radio object
15893 * @param obj The radio object
15894 * @param icon The icon object
15896 * Once the icon object is set, a previously set one will be deleted. If you
15897 * want to keep that old content object, use the elm_radio_icon_unset()
15900 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15902 * @brief Get the icon object of the radio object
15904 * @param obj The radio object
15905 * @return The icon object
15907 * @see elm_radio_icon_set()
15909 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15911 * @brief Unset the icon used for the radio object
15913 * @param obj The radio object
15914 * @return The icon object that was being used
15916 * Unparent and return the icon object which was set for this widget.
15918 * @see elm_radio_icon_set()
15920 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15922 * @brief Add this radio to a group of other radio objects
15924 * @param obj The radio object
15925 * @param group Any object whose group the @p obj is to join.
15927 * Radio objects work in groups. Each member should have a different integer
15928 * value assigned. In order to have them work as a group, they need to know
15929 * about each other. This adds the given radio object to the group of which
15930 * the group object indicated is a member.
15932 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
15934 * @brief Set the integer value that this radio object represents
15936 * @param obj The radio object
15937 * @param value The value to use if this radio object is selected
15939 * This sets the value of the radio.
15941 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15943 * @brief Get the integer value that this radio object represents
15945 * @param obj The radio object
15946 * @return The value used if this radio object is selected
15948 * This gets the value of the radio.
15950 * @see elm_radio_value_set()
15952 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15954 * @brief Set the value of the radio.
15956 * @param obj The radio object
15957 * @param value The value to use for the group
15959 * This sets the value of the radio group and will also set the value if
15960 * pointed to, to the value supplied, but will not call any callbacks.
15962 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15964 * @brief Get the state of the radio object
15966 * @param obj The radio object
15967 * @return The integer state
15969 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15971 * @brief Set a convenience pointer to a integer to change
15973 * @param obj The radio object
15974 * @param valuep Pointer to the integer to modify
15976 * This sets a pointer to a integer, that, in addition to the radio objects
15977 * state will also be modified directly. To stop setting the object pointed
15978 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
15979 * when this is called, the radio objects state will also be modified to
15980 * reflect the value of the integer valuep points to, just like calling
15981 * elm_radio_value_set().
15983 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
15989 * @defgroup Pager Pager
15991 * @image html img/widget/pager/preview-00.png
15992 * @image latex img/widget/pager/preview-00.eps
15994 * @brief Widget that allows flipping between 1 or more “pages” of objects.
15996 * The flipping between “pages” of objects is animated. All content in pager
15997 * is kept in a stack, the last content to be added will be on the top of the
15998 * stack(be visible).
16000 * Objects can be pushed or popped from the stack or deleted as normal.
16001 * Pushes and pops will animate (and a pop will delete the object once the
16002 * animation is finished). Any object already in the pager can be promoted to
16003 * the top(from its current stacking position) through the use of
16004 * elm_pager_content_promote(). Objects are pushed to the top with
16005 * elm_pager_content_push() and when the top item is no longer wanted, simply
16006 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16007 * object is no longer needed and is not the top item, just delete it as
16008 * normal. You can query which objects are the top and bottom with
16009 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16011 * Signals that you can add callbacks for are:
16012 * "hide,finished" - when the previous page is hided
16014 * This widget has the following styles available:
16017 * @li fade_translucide
16018 * @li fade_invisible
16019 * @note This styles affect only the flipping animations, the appearance when
16020 * not animating is unaffected by styles.
16022 * @ref tutorial_pager gives a good overview of the usage of the API.
16026 * Add a new pager to the parent
16028 * @param parent The parent object
16029 * @return The new object or NULL if it cannot be created
16033 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16035 * @brief Push an object to the top of the pager stack (and show it).
16037 * @param obj The pager object
16038 * @param content The object to push
16040 * The object pushed becomes a child of the pager, it will be controlled and
16041 * deleted when the pager is deleted.
16043 * @note If the content is already in the stack use
16044 * elm_pager_content_promote().
16045 * @warning Using this function on @p content already in the stack results in
16046 * undefined behavior.
16048 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16050 * @brief Pop the object that is on top of the stack
16052 * @param obj The pager object
16054 * This pops the object that is on the top(visible) of the pager, makes it
16055 * disappear, then deletes the object. The object that was underneath it on
16056 * the stack will become visible.
16058 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16060 * @brief Moves an object already in the pager stack to the top of the stack.
16062 * @param obj The pager object
16063 * @param content The object to promote
16065 * This will take the @p content and move it to the top of the stack as
16066 * if it had been pushed there.
16068 * @note If the content isn't already in the stack use
16069 * elm_pager_content_push().
16070 * @warning Using this function on @p content not already in the stack
16071 * results in undefined behavior.
16073 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16075 * @brief Return the object at the bottom of the pager stack
16077 * @param obj The pager object
16078 * @return The bottom object or NULL if none
16080 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16082 * @brief Return the object at the top of the pager stack
16084 * @param obj The pager object
16085 * @return The top object or NULL if none
16087 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16093 * @defgroup Slideshow Slideshow
16095 * @image html img/widget/slideshow/preview-00.png
16096 * @image latex img/widget/slideshow/preview-00.eps
16098 * This widget, as the name indicates, is a pre-made image
16099 * slideshow panel, with API functions acting on (child) image
16100 * items presentation. Between those actions, are:
16101 * - advance to next/previous image
16102 * - select the style of image transition animation
16103 * - set the exhibition time for each image
16104 * - start/stop the slideshow
16106 * The transition animations are defined in the widget's theme,
16107 * consequently new animations can be added without having to
16108 * update the widget's code.
16110 * @section Slideshow_Items Slideshow items
16112 * For slideshow items, just like for @ref Genlist "genlist" ones,
16113 * the user defines a @b classes, specifying functions that will be
16114 * called on the item's creation and deletion times.
16116 * The #Elm_Slideshow_Item_Class structure contains the following
16119 * - @c func.get - When an item is displayed, this function is
16120 * called, and it's where one should create the item object, de
16121 * facto. For example, the object can be a pure Evas image object
16122 * or an Elementary @ref Photocam "photocam" widget. See
16123 * #SlideshowItemGetFunc.
16124 * - @c func.del - When an item is no more displayed, this function
16125 * is called, where the user must delete any data associated to
16126 * the item. See #SlideshowItemDelFunc.
16128 * @section Slideshow_Caching Slideshow caching
16130 * The slideshow provides facilities to have items adjacent to the
16131 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16132 * you, so that the system does not have to decode image data
16133 * anymore at the time it has to actually switch images on its
16134 * viewport. The user is able to set the numbers of items to be
16135 * cached @b before and @b after the current item, in the widget's
16138 * Smart events one can add callbacks for are:
16140 * - @c "changed" - when the slideshow switches its view to a new
16143 * List of examples for the slideshow widget:
16144 * @li @ref slideshow_example
16148 * @addtogroup Slideshow
16152 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16153 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16154 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16155 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16156 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16159 * @struct _Elm_Slideshow_Item_Class
16161 * Slideshow item class definition. See @ref Slideshow_Items for
16164 struct _Elm_Slideshow_Item_Class
16166 struct _Elm_Slideshow_Item_Class_Func
16168 SlideshowItemGetFunc get;
16169 SlideshowItemDelFunc del;
16171 }; /**< #Elm_Slideshow_Item_Class member definitions */
16174 * Add a new slideshow widget to the given parent Elementary
16175 * (container) object
16177 * @param parent The parent object
16178 * @return A new slideshow widget handle or @c NULL, on errors
16180 * This function inserts a new slideshow widget on the canvas.
16182 * @ingroup Slideshow
16184 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16187 * Add (append) a new item in a given slideshow widget.
16189 * @param obj The slideshow object
16190 * @aram itc The item class for the item
16191 * @param data The item's data
16192 * @return A handle to the item added or @c NULL, on errors
16194 * Add a new item to @p obj's internal list of items, appending it.
16195 * The item's class must contain the function really fetching the
16196 * image object to show for this item, which could be an Evas image
16197 * object or an Elementary photo, for example. The @p data
16198 * parameter is going to be passed to both class functions of the
16201 * @see #Elm_Slideshow_Item_Class
16202 * @see elm_slideshow_item_sorted_insert()
16204 * @ingroup Slideshow
16206 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16209 * Insert a new item into the given slideshow widget, using the @p func
16210 * function to sort items (by item handles).
16212 * @param obj The slideshow object
16213 * @aram itc The item class for the item
16214 * @param data The item's data
16215 * @param func The comparing function to be used to sort slideshow
16216 * items <b>by #Elm_Slideshow_Item item handles</b>
16217 * @return Returns The slideshow item handle, on success, or
16218 * @c NULL, on errors
16220 * Add a new item to @p obj's internal list of items, in a position
16221 * determined by the @p func comparing function. The item's class
16222 * must contain the function really fetching the image object to
16223 * show for this item, which could be an Evas image object or an
16224 * Elementary photo, for example. The @p data parameter is going to
16225 * be passed to both class functions of the item.
16227 * @see #Elm_Slideshow_Item_Class
16228 * @see elm_slideshow_item_add()
16230 * @ingroup Slideshow
16232 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);
16235 * Display a given slideshow widget's item, programmatically.
16237 * @param obj The slideshow object
16238 * @param item The item to display on @p obj's viewport
16240 * The change between the current item and @p item will use the
16241 * transition @p obj is set to use (@see
16242 * elm_slideshow_transition_set()).
16244 * @ingroup Slideshow
16246 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16249 * Slide to the @b next item, in a given slideshow widget
16251 * @param obj The slideshow object
16253 * The sliding animation @p obj is set to use will be the
16254 * transition effect used, after this call is issued.
16256 * @note If the end of the slideshow's internal list of items is
16257 * reached, it'll wrap around to the list's beginning, again.
16259 * @ingroup Slideshow
16261 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16264 * Slide to the @b previous item, in a given slideshow widget
16266 * @param obj The slideshow object
16268 * The sliding animation @p obj is set to use will be the
16269 * transition effect used, after this call is issued.
16271 * @note If the beginning of the slideshow's internal list of items
16272 * is reached, it'll wrap around to the list's end, again.
16274 * @ingroup Slideshow
16276 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16279 * Returns the list of sliding transition/effect names available, for a
16280 * given slideshow widget.
16282 * @param obj The slideshow object
16283 * @return The list of transitions (list of @b stringshared strings
16286 * The transitions, which come from @p obj's theme, must be an EDC
16287 * data item named @c "transitions" on the theme file, with (prefix)
16288 * names of EDC programs actually implementing them.
16290 * The available transitions for slideshows on the default theme are:
16291 * - @c "fade" - the current item fades out, while the new one
16292 * fades in to the slideshow's viewport.
16293 * - @c "black_fade" - the current item fades to black, and just
16294 * then, the new item will fade in.
16295 * - @c "horizontal" - the current item slides horizontally, until
16296 * it gets out of the slideshow's viewport, while the new item
16297 * comes from the left to take its place.
16298 * - @c "vertical" - the current item slides vertically, until it
16299 * gets out of the slideshow's viewport, while the new item comes
16300 * from the bottom to take its place.
16301 * - @c "square" - the new item starts to appear from the middle of
16302 * the current one, but with a tiny size, growing until its
16303 * target (full) size and covering the old one.
16305 * @warning The stringshared strings get no new references
16306 * exclusive to the user grabbing the list, here, so if you'd like
16307 * to use them out of this call's context, you'd better @c
16308 * eina_stringshare_ref() them.
16310 * @see elm_slideshow_transition_set()
16312 * @ingroup Slideshow
16314 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16317 * Set the current slide transition/effect in use for a given
16320 * @param obj The slideshow object
16321 * @param transition The new transition's name string
16323 * If @p transition is implemented in @p obj's theme (i.e., is
16324 * contained in the list returned by
16325 * elm_slideshow_transitions_get()), this new sliding effect will
16326 * be used on the widget.
16328 * @see elm_slideshow_transitions_get() for more details
16330 * @ingroup Slideshow
16332 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16335 * Get the current slide transition/effect in use for a given
16338 * @param obj The slideshow object
16339 * @return The current transition's name
16341 * @see elm_slideshow_transition_set() for more details
16343 * @ingroup Slideshow
16345 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16348 * Set the interval between each image transition on a given
16349 * slideshow widget, <b>and start the slideshow, itself</b>
16351 * @param obj The slideshow object
16352 * @param timeout The new displaying timeout for images
16354 * After this call, the slideshow widget will start cycling its
16355 * view, sequentially and automatically, with the images of the
16356 * items it has. The time between each new image displayed is going
16357 * to be @p timeout, in @b seconds. If a different timeout was set
16358 * previously and an slideshow was in progress, it will continue
16359 * with the new time between transitions, after this call.
16361 * @note A value less than or equal to 0 on @p timeout will disable
16362 * the widget's internal timer, thus halting any slideshow which
16363 * could be happening on @p obj.
16365 * @see elm_slideshow_timeout_get()
16367 * @ingroup Slideshow
16369 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16372 * Get the interval set for image transitions on a given slideshow
16375 * @param obj The slideshow object
16376 * @return Returns the timeout set on it
16378 * @see elm_slideshow_timeout_set() for more details
16380 * @ingroup Slideshow
16382 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16385 * Set if, after a slideshow is started, for a given slideshow
16386 * widget, its items should be displayed cyclically or not.
16388 * @param obj The slideshow object
16389 * @param loop Use @c EINA_TRUE to make it cycle through items or
16390 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16393 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16394 * ignore what is set by this functions, i.e., they'll @b always
16395 * cycle through items. This affects only the "automatic"
16396 * slideshow, as set by elm_slideshow_timeout_set().
16398 * @see elm_slideshow_loop_get()
16400 * @ingroup Slideshow
16402 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16405 * Get if, after a slideshow is started, for a given slideshow
16406 * widget, its items are to be displayed cyclically or not.
16408 * @param obj The slideshow object
16409 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16410 * through or @c EINA_FALSE, otherwise
16412 * @see elm_slideshow_loop_set() for more details
16414 * @ingroup Slideshow
16416 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16419 * Remove all items from a given slideshow widget
16421 * @param obj The slideshow object
16423 * This removes (and deletes) all items in @p obj, leaving it
16426 * @see elm_slideshow_item_del(), to remove just one item.
16428 * @ingroup Slideshow
16430 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16433 * Get the internal list of items in a given slideshow widget.
16435 * @param obj The slideshow object
16436 * @return The list of items (#Elm_Slideshow_Item as data) or
16437 * @c NULL on errors.
16439 * This list is @b not to be modified in any way and must not be
16440 * freed. Use the list members with functions like
16441 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16443 * @warning This list is only valid until @p obj object's internal
16444 * items list is changed. It should be fetched again with another
16445 * call to this function when changes happen.
16447 * @ingroup Slideshow
16449 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16452 * Delete a given item from a slideshow widget.
16454 * @param item The slideshow item
16456 * @ingroup Slideshow
16458 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16461 * Return the data associated with a given slideshow item
16463 * @param item The slideshow item
16464 * @return Returns the data associated to this item
16466 * @ingroup Slideshow
16468 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16471 * Returns the currently displayed item, in a given slideshow widget
16473 * @param obj The slideshow object
16474 * @return A handle to the item being displayed in @p obj or
16475 * @c NULL, if none is (and on errors)
16477 * @ingroup Slideshow
16479 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16482 * Get the real Evas object created to implement the view of a
16483 * given slideshow item
16485 * @param item The slideshow item.
16486 * @return the Evas object implementing this item's view.
16488 * This returns the actual Evas object used to implement the
16489 * specified slideshow item's view. This may be @c NULL, as it may
16490 * not have been created or may have been deleted, at any time, by
16491 * the slideshow. <b>Do not modify this object</b> (move, resize,
16492 * show, hide, etc.), as the slideshow is controlling it. This
16493 * function is for querying, emitting custom signals or hooking
16494 * lower level callbacks for events on that object. Do not delete
16495 * this object under any circumstances.
16497 * @see elm_slideshow_item_data_get()
16499 * @ingroup Slideshow
16501 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16504 * Get the the item, in a given slideshow widget, placed at
16505 * position @p nth, in its internal items list
16507 * @param obj The slideshow object
16508 * @param nth The number of the item to grab a handle to (0 being
16510 * @return The item stored in @p obj at position @p nth or @c NULL,
16511 * if there's no item with that index (and on errors)
16513 * @ingroup Slideshow
16515 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16518 * Set the current slide layout in use for a given slideshow widget
16520 * @param obj The slideshow object
16521 * @param layout The new layout's name string
16523 * If @p layout is implemented in @p obj's theme (i.e., is contained
16524 * in the list returned by elm_slideshow_layouts_get()), this new
16525 * images layout will be used on the widget.
16527 * @see elm_slideshow_layouts_get() for more details
16529 * @ingroup Slideshow
16531 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16534 * Get the current slide layout in use for a given slideshow widget
16536 * @param obj The slideshow object
16537 * @return The current layout's name
16539 * @see elm_slideshow_layout_set() for more details
16541 * @ingroup Slideshow
16543 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16546 * Returns the list of @b layout names available, for a given
16547 * slideshow widget.
16549 * @param obj The slideshow object
16550 * @return The list of layouts (list of @b stringshared strings
16553 * Slideshow layouts will change how the widget is to dispose each
16554 * image item in its viewport, with regard to cropping, scaling,
16557 * The layouts, which come from @p obj's theme, must be an EDC
16558 * data item name @c "layouts" on the theme file, with (prefix)
16559 * names of EDC programs actually implementing them.
16561 * The available layouts for slideshows on the default theme are:
16562 * - @c "fullscreen" - item images with original aspect, scaled to
16563 * touch top and down slideshow borders or, if the image's heigh
16564 * is not enough, left and right slideshow borders.
16565 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16566 * one, but always leaving 10% of the slideshow's dimensions of
16567 * distance between the item image's borders and the slideshow
16568 * borders, for each axis.
16570 * @warning The stringshared strings get no new references
16571 * exclusive to the user grabbing the list, here, so if you'd like
16572 * to use them out of this call's context, you'd better @c
16573 * eina_stringshare_ref() them.
16575 * @see elm_slideshow_layout_set()
16577 * @ingroup Slideshow
16579 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16582 * Set the number of items to cache, on a given slideshow widget,
16583 * <b>before the current item</b>
16585 * @param obj The slideshow object
16586 * @param count Number of items to cache before the current one
16588 * The default value for this property is @c 2. See
16589 * @ref Slideshow_Caching "slideshow caching" for more details.
16591 * @see elm_slideshow_cache_before_get()
16593 * @ingroup Slideshow
16595 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16598 * Retrieve the number of items to cache, on a given slideshow widget,
16599 * <b>before the current item</b>
16601 * @param obj The slideshow object
16602 * @return The number of items set to be cached before the current one
16604 * @see elm_slideshow_cache_before_set() for more details
16606 * @ingroup Slideshow
16608 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16611 * Set the number of items to cache, on a given slideshow widget,
16612 * <b>after the current item</b>
16614 * @param obj The slideshow object
16615 * @param count Number of items to cache after the current one
16617 * The default value for this property is @c 2. See
16618 * @ref Slideshow_Caching "slideshow caching" for more details.
16620 * @see elm_slideshow_cache_after_get()
16622 * @ingroup Slideshow
16624 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16627 * Retrieve the number of items to cache, on a given slideshow widget,
16628 * <b>after the current item</b>
16630 * @param obj The slideshow object
16631 * @return The number of items set to be cached after the current one
16633 * @see elm_slideshow_cache_after_set() for more details
16635 * @ingroup Slideshow
16637 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16640 * Get the number of items stored in a given slideshow widget
16642 * @param obj The slideshow object
16643 * @return The number of items on @p obj, at the moment of this call
16645 * @ingroup Slideshow
16647 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16654 * @defgroup Fileselector File Selector
16656 * @image html img/widget/fileselector/preview-00.png
16657 * @image latex img/widget/fileselector/preview-00.eps
16659 * A file selector is a widget that allows a user to navigate
16660 * through a file system, reporting file selections back via its
16663 * It contains shortcut buttons for home directory (@c ~) and to
16664 * jump one directory upwards (..), as well as cancel/ok buttons to
16665 * confirm/cancel a given selection. After either one of those two
16666 * former actions, the file selector will issue its @c "done" smart
16669 * There's a text entry on it, too, showing the name of the current
16670 * selection. There's the possibility of making it editable, so it
16671 * is useful on file saving dialogs on applications, where one
16672 * gives a file name to save contents to, in a given directory in
16673 * the system. This custom file name will be reported on the @c
16674 * "done" smart callback (explained in sequence).
16676 * Finally, it has a view to display file system items into in two
16681 * If Elementary is built with support of the Ethumb thumbnailing
16682 * library, the second form of view will display preview thumbnails
16683 * of files which it supports.
16685 * Smart callbacks one can register to:
16687 * - @c "selected" - the user has clicked on a file (when not in
16688 * folders-only mode) or directory (when in folders-only mode)
16689 * - @c "directory,open" - the list has been populated with new
16690 * content (@c event_info is a pointer to the directory's
16691 * path, a @b stringshared string)
16692 * - @c "done" - the user has clicked on the "ok" or "cancel"
16693 * buttons (@c event_info is a pointer to the selection's
16694 * path, a @b stringshared string)
16696 * Here is an example on its usage:
16697 * @li @ref fileselector_example
16701 * @addtogroup Fileselector
16706 * Defines how a file selector widget is to layout its contents
16707 * (file system entries).
16709 typedef enum _Elm_Fileselector_Mode
16711 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16712 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16713 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16714 } Elm_Fileselector_Mode;
16717 * Add a new file selector widget to the given parent Elementary
16718 * (container) object
16720 * @param parent The parent object
16721 * @return a new file selector widget handle or @c NULL, on errors
16723 * This function inserts a new file selector widget on the canvas.
16725 * @ingroup Fileselector
16727 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16730 * Enable/disable the file name entry box where the user can type
16731 * in a name for a file, in a given file selector widget
16733 * @param obj The file selector object
16734 * @param is_save @c EINA_TRUE to make the file selector a "saving
16735 * dialog", @c EINA_FALSE otherwise
16737 * Having the entry editable is useful on file saving dialogs on
16738 * applications, where one gives a file name to save contents to,
16739 * in a given directory in the system. This custom file name will
16740 * be reported on the @c "done" smart callback.
16742 * @see elm_fileselector_is_save_get()
16744 * @ingroup Fileselector
16746 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16749 * Get whether the given file selector is in "saving dialog" mode
16751 * @param obj The file selector object
16752 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16753 * mode, @c EINA_FALSE otherwise (and on errors)
16755 * @see elm_fileselector_is_save_set() for more details
16757 * @ingroup Fileselector
16759 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16762 * Enable/disable folder-only view for a given file selector widget
16764 * @param obj The file selector object
16765 * @param only @c EINA_TRUE to make @p obj only display
16766 * directories, @c EINA_FALSE to make files to be displayed in it
16769 * If enabled, the widget's view will only display folder items,
16772 * @see elm_fileselector_folder_only_get()
16774 * @ingroup Fileselector
16776 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16779 * Get whether folder-only view is set for a given file selector
16782 * @param obj The file selector object
16783 * @return only @c EINA_TRUE if @p obj is only displaying
16784 * directories, @c EINA_FALSE if files are being displayed in it
16785 * too (and on errors)
16787 * @see elm_fileselector_folder_only_get()
16789 * @ingroup Fileselector
16791 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16794 * Enable/disable the "ok" and "cancel" buttons on a given file
16797 * @param obj The file selector object
16798 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16800 * @note A file selector without those buttons will never emit the
16801 * @c "done" smart event, and is only usable if one is just hooking
16802 * to the other two events.
16804 * @see elm_fileselector_buttons_ok_cancel_get()
16806 * @ingroup Fileselector
16808 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16811 * Get whether the "ok" and "cancel" buttons on a given file
16812 * selector widget are being shown.
16814 * @param obj The file selector object
16815 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16816 * otherwise (and on errors)
16818 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16820 * @ingroup Fileselector
16822 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16825 * Enable/disable a tree view in the given file selector widget,
16826 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16828 * @param obj The file selector object
16829 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16832 * In a tree view, arrows are created on the sides of directories,
16833 * allowing them to expand in place.
16835 * @note If it's in other mode, the changes made by this function
16836 * will only be visible when one switches back to "list" mode.
16838 * @see elm_fileselector_expandable_get()
16840 * @ingroup Fileselector
16842 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16845 * Get whether tree view is enabled for the given file selector
16848 * @param obj The file selector object
16849 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16850 * otherwise (and or errors)
16852 * @see elm_fileselector_expandable_set() for more details
16854 * @ingroup Fileselector
16856 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16859 * Set, programmatically, the @b directory that a given file
16860 * selector widget will display contents from
16862 * @param obj The file selector object
16863 * @param path The path to display in @p obj
16865 * This will change the @b directory that @p obj is displaying. It
16866 * will also clear the text entry area on the @p obj object, which
16867 * displays select files' names.
16869 * @see elm_fileselector_path_get()
16871 * @ingroup Fileselector
16873 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16876 * Get the parent directory's path that a given file selector
16877 * widget is displaying
16879 * @param obj The file selector object
16880 * @return The (full) path of the directory the file selector is
16881 * displaying, a @b stringshared string
16883 * @see elm_fileselector_path_set()
16885 * @ingroup Fileselector
16887 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16890 * Set, programmatically, the currently selected file/directory in
16891 * the given file selector widget
16893 * @param obj The file selector object
16894 * @param path The (full) path to a file or directory
16895 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16896 * latter case occurs if the directory or file pointed to do not
16899 * @see elm_fileselector_selected_get()
16901 * @ingroup Fileselector
16903 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16906 * Get the currently selected item's (full) path, in the given file
16909 * @param obj The file selector object
16910 * @return The absolute path of the selected item, a @b
16911 * stringshared string
16913 * @note Custom editions on @p obj object's text entry, if made,
16914 * will appear on the return string of this function, naturally.
16916 * @see elm_fileselector_selected_set() for more details
16918 * @ingroup Fileselector
16920 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16923 * Set the mode in which a given file selector widget will display
16924 * (layout) file system entries in its view
16926 * @param obj The file selector object
16927 * @param mode The mode of the fileselector, being it one of
16928 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
16929 * first one, naturally, will display the files in a list. The
16930 * latter will make the widget to display its entries in a grid
16933 * @note By using elm_fileselector_expandable_set(), the user may
16934 * trigger a tree view for that list.
16936 * @note If Elementary is built with support of the Ethumb
16937 * thumbnailing library, the second form of view will display
16938 * preview thumbnails of files which it supports. You must have
16939 * elm_need_ethumb() called in your Elementary for thumbnailing to
16942 * @see elm_fileselector_expandable_set().
16943 * @see elm_fileselector_mode_get().
16945 * @ingroup Fileselector
16947 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
16950 * Get the mode in which a given file selector widget is displaying
16951 * (layouting) file system entries in its view
16953 * @param obj The fileselector object
16954 * @return The mode in which the fileselector is at
16956 * @see elm_fileselector_mode_set() for more details
16958 * @ingroup Fileselector
16960 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16967 * @defgroup Progressbar Progress bar
16969 * The progress bar is a widget for visually representing the
16970 * progress status of a given job/task.
16972 * A progress bar may be horizontal or vertical. It may display an
16973 * icon besides it, as well as primary and @b units labels. The
16974 * former is meant to label the widget as a whole, while the
16975 * latter, which is formatted with floating point values (and thus
16976 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
16977 * units"</c>), is meant to label the widget's <b>progress
16978 * value</b>. Label, icon and unit strings/objects are @b optional
16979 * for progress bars.
16981 * A progress bar may be @b inverted, in which state it gets its
16982 * values inverted, with high values being on the left or top and
16983 * low values on the right or bottom, as opposed to normally have
16984 * the low values on the former and high values on the latter,
16985 * respectively, for horizontal and vertical modes.
16987 * The @b span of the progress, as set by
16988 * elm_progressbar_span_size_set(), is its length (horizontally or
16989 * vertically), unless one puts size hints on the widget to expand
16990 * on desired directions, by any container. That length will be
16991 * scaled by the object or applications scaling factor. At any
16992 * point code can query the progress bar for its value with
16993 * elm_progressbar_value_get().
16995 * Available widget styles for progress bars:
16997 * - @c "wheel" (simple style, no text, no progression, only
16998 * "pulse" effect is available)
17000 * Here is an example on its usage:
17001 * @li @ref progressbar_example
17005 * Add a new progress bar widget to the given parent Elementary
17006 * (container) object
17008 * @param parent The parent object
17009 * @return a new progress bar widget handle or @c NULL, on errors
17011 * This function inserts a new progress bar widget on the canvas.
17013 * @ingroup Progressbar
17015 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17018 * Set whether a given progress bar widget is at "pulsing mode" or
17021 * @param obj The progress bar object
17022 * @param pulse @c EINA_TRUE to put @obj in pulsing mode,
17023 * @c EINA_FALSE to put it back to its default one
17025 * By default, progress bars will display values from the low to
17026 * high value boundaries. There are, though, contexts in which the
17027 * state of progression of a given task is @b unknown. For those,
17028 * one can set a progress bar widget to a "pulsing state", to give
17029 * the user an idea that some computation is being held, but
17030 * without exact progress values. In the default theme it will
17031 * animate its bar with the contents filling in constantly and back
17032 * to non-filled, in a loop. To start and stop this pulsing
17033 * animation, one has to explicitly call elm_progressbar_pulse().
17035 * @see elm_progressbar_pulse_get()
17036 * @see elm_progressbar_pulse()
17038 * @ingroup Progressbar
17040 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17043 * Get whether a given progress bar widget is at "pulsing mode" or
17046 * @param obj The progress bar object
17047 * @return @c EINA_TRUE, if @obj is in pulsing mode, @c EINA_FALSE
17048 * if it's in the default one (and on errors)
17050 * @ingroup Progressbar
17052 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17055 * Start/stop a given progress bar "pulsing" animation, if its
17058 * @param obj The progress bar object
17059 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17060 * @c EINA_FALSE to @b stop it
17062 * @note This call won't do anything if @p obj is not under "pulsing mode".
17064 * @see elm_progressbar_pulse_set() for more details.
17066 * @ingroup Progressbar
17068 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17071 * Set the progress value (in percentage) on a given progress bar
17074 * @param obj The progress bar object
17075 * @param val The progress value (@b must be between @c 0.0 and @c
17078 * Use this call to set progress bar levels.
17080 * @note If you passes a value out of the specified range for @p
17081 * val, it will be interpreted as the @b closest of the @b boundary
17082 * values in the range.
17084 * @ingroup Progressbar
17086 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17089 * Get the progress value (in percentage) on a given progress bar
17092 * @param obj The progress bar object
17093 * @return The value of the progressbar
17095 * @see elm_progressbar_value_set() for more details
17097 * @ingroup Progressbar
17099 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17102 * Set the label of a given progress bar widget
17104 * @param obj The progress bar object
17105 * @param label The text label string, in UTF-8
17107 * @ingroup Progressbar
17108 * @deprecated use elm_object_text_set() instead.
17110 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17113 * Get the label of a given progress bar widget
17115 * @param obj The progressbar object
17116 * @return The text label string, in UTF-8
17118 * @ingroup Progressbar
17119 * @deprecated use elm_object_text_set() instead.
17121 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17124 * Set the icon object of a given progress bar widget
17126 * @param obj The progress bar object
17127 * @param icon The icon object
17129 * Use this call to decorate @p obj with an icon next to it.
17131 * @note Once the icon object is set, a previously set one will be
17132 * deleted. If you want to keep that old content object, use the
17133 * elm_progressbar_icon_unset() function.
17135 * @see elm_progressbar_icon_get()
17137 * @ingroup Progressbar
17139 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17142 * Retrieve the icon object set for a given progress bar widget
17144 * @param obj The progress bar object
17145 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17146 * otherwise (and on errors)
17148 * @see elm_progressbar_icon_set() for more details
17150 * @ingroup Progressbar
17152 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17155 * Unset an icon set on a given progress bar widget
17157 * @param obj The progress bar object
17158 * @return The icon object that was being used, if any was set, or
17159 * @c NULL, otherwise (and on errors)
17161 * This call will unparent and return the icon object which was set
17162 * for this widget, previously, on success.
17164 * @see elm_progressbar_icon_set() for more details
17166 * @ingroup Progressbar
17168 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17171 * Set the (exact) length of the bar region of a given progress bar
17174 * @param obj The progress bar object
17175 * @param size The length of the progress bar's bar region
17177 * This sets the minimum width (when in horizontal mode) or height
17178 * (when in vertical mode) of the actual bar area of the progress
17179 * bar @p obj. This in turn affects the object's minimum size. Use
17180 * this when you're not setting other size hints expanding on the
17181 * given direction (like weight and alignment hints) and you would
17182 * like it to have a specific size.
17184 * @note Icon, label and unit text around @p obj will require their
17185 * own space, which will make @p obj to require more the @p size,
17188 * @see elm_progressbar_span_size_get()
17190 * @ingroup Progressbar
17192 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17195 * Get the length set for the bar region of a given progress bar
17198 * @param obj The progress bar object
17199 * @return The length of the progress bar's bar region
17201 * If that size was not set previously, with
17202 * elm_progressbar_span_size_set(), this call will return @c 0.
17204 * @ingroup Progressbar
17206 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17209 * Set the format string for a given progress bar widget's units
17212 * @param obj The progress bar object
17213 * @param format The format string for @p obj's units label
17215 * If @c NULL is passed on @p format, it will make @p obj's units
17216 * area to be hidden completely. If not, it'll set the <b>format
17217 * string</b> for the units label's @b text. The units label is
17218 * provided a floating point value, so the units text is up display
17219 * at most one floating point falue. Note that the units label is
17220 * optional. Use a format string such as "%1.2f meters" for
17223 * @note The default format string for a progress bar is an integer
17224 * percentage, as in @c "%.0f %%".
17226 * @see elm_progressbar_unit_format_get()
17228 * @ingroup Progressbar
17230 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17233 * Retrieve the format string set for a given progress bar widget's
17236 * @param obj The progress bar object
17237 * @return The format set string for @p obj's units label or
17238 * @c NULL, if none was set (and on errors)
17240 * @see elm_progressbar_unit_format_set() for more details
17242 * @ingroup Progressbar
17244 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17247 * Set the orientation of a given progress bar widget
17249 * @param obj The progress bar object
17250 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17251 * @b horizontal, @c EINA_FALSE to make it @b vertical
17253 * Use this function to change how your progress bar is to be
17254 * disposed: vertically or horizontally.
17256 * @see elm_progressbar_horizontal_get()
17258 * @ingroup Progressbar
17260 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17263 * Retrieve the orientation of a given progress bar widget
17265 * @param obj The progress bar object
17266 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17267 * @c EINA_FALSE if it's @b vertical (and on errors)
17269 * @see elm_progressbar_horizontal_set() for more details
17271 * @ingroup Progressbar
17273 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17276 * Invert a given progress bar widget's displaying values order
17278 * @param obj The progress bar object
17279 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17280 * @c EINA_FALSE to bring it back to default, non-inverted values.
17282 * A progress bar may be @b inverted, in which state it gets its
17283 * values inverted, with high values being on the left or top and
17284 * low values on the right or bottom, as opposed to normally have
17285 * the low values on the former and high values on the latter,
17286 * respectively, for horizontal and vertical modes.
17288 * @see elm_progressbar_inverted_get()
17290 * @ingroup Progressbar
17292 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17295 * Get whether a given progress bar widget's displaying values are
17298 * @param obj The progress bar object
17299 * @return @c EINA_TRUE, if @p obj has inverted values,
17300 * @c EINA_FALSE otherwise (and on errors)
17302 * @see elm_progressbar_inverted_set() for more details
17304 * @ingroup Progressbar
17306 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17309 * @defgroup Separator Separator
17311 * @brief Separator is a very thin object used to separate other objects.
17313 * A separator can be vertical or horizontal.
17315 * @ref tutorial_separator is a good example of how to use a separator.
17319 * @brief Add a separator object to @p parent
17321 * @param parent The parent object
17323 * @return The separator object, or NULL upon failure
17325 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17327 * @brief Set the horizontal mode of a separator object
17329 * @param obj The separator object
17330 * @param horizontal If true, the separator is horizontal
17332 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17334 * @brief Get the horizontal mode of a separator object
17336 * @param obj The separator object
17337 * @return If true, the separator is horizontal
17339 * @see elm_separator_horizontal_set()
17341 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17347 * @defgroup Spinner Spinner
17348 * @ingroup Elementary
17350 * @image html img/widget/spinner/preview-00.png
17351 * @image latex img/widget/spinner/preview-00.eps
17353 * A spinner is a widget which allows the user to increase or decrease
17354 * numeric values using arrow buttons, or edit values directly, clicking
17355 * over it and typing the new value.
17357 * By default the spinner will not wrap and has a label
17358 * of "%.0f" (just showing the integer value of the double).
17360 * A spinner has a label that is formatted with floating
17361 * point values and thus accepts a printf-style format string, like
17364 * It also allows specific values to be replaced by pre-defined labels.
17366 * Smart callbacks one can register to:
17368 * - "changed" - Whenever the spinner value is changed.
17369 * - "delay,changed" - A short time after the value is changed by the user.
17370 * This will be called only when the user stops dragging for a very short
17371 * period or when they release their finger/mouse, so it avoids possibly
17372 * expensive reactions to the value change.
17374 * Available styles for it:
17376 * - @c "vertical": up/down buttons at the right side and text left aligned.
17378 * Here is an example on its usage:
17379 * @ref spinner_example
17383 * @addtogroup Spinner
17388 * Add a new spinner widget to the given parent Elementary
17389 * (container) object.
17391 * @param parent The parent object.
17392 * @return a new spinner widget handle or @c NULL, on errors.
17394 * This function inserts a new spinner widget on the canvas.
17399 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17402 * Set the format string of the displayed label.
17404 * @param obj The spinner object.
17405 * @param fmt The format string for the label display.
17407 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17408 * string for the label text. The label text is provided a floating point
17409 * value, so the label text can display up to 1 floating point value.
17410 * Note that this is optional.
17412 * Use a format string such as "%1.2f meters" for example, and it will
17413 * display values like: "3.14 meters" for a value equal to 3.14159.
17415 * Default is "%0.f".
17417 * @see elm_spinner_label_format_get()
17421 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17424 * Get the label format of the spinner.
17426 * @param obj The spinner object.
17427 * @return The text label format string in UTF-8.
17429 * @see elm_spinner_label_format_set() for details.
17433 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17436 * Set the minimum and maximum values for the spinner.
17438 * @param obj The spinner object.
17439 * @param min The minimum value.
17440 * @param max The maximum value.
17442 * Define the allowed range of values to be selected by the user.
17444 * If actual value is less than @p min, it will be updated to @p min. If it
17445 * is bigger then @p max, will be updated to @p max. Actual value can be
17446 * get with elm_spinner_value_get().
17448 * By default, min is equal to 0, and max is equal to 100.
17450 * @warning Maximum must be greater than minimum.
17452 * @see elm_spinner_min_max_get()
17456 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17459 * Get the minimum and maximum values of the spinner.
17461 * @param obj The spinner object.
17462 * @param min Pointer where to store the minimum value.
17463 * @param max Pointer where to store the maximum value.
17465 * @note If only one value is needed, the other pointer can be passed
17468 * @see elm_spinner_min_max_set() for details.
17472 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17475 * Set the step used to increment or decrement the spinner value.
17477 * @param obj The spinner object.
17478 * @param step The step value.
17480 * This value will be incremented or decremented to the displayed value.
17481 * It will be incremented while the user keep right or top arrow pressed,
17482 * and will be decremented while the user keep left or bottom arrow pressed.
17484 * The interval to increment / decrement can be set with
17485 * elm_spinner_interval_set().
17487 * By default step value is equal to 1.
17489 * @see elm_spinner_step_get()
17493 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17496 * Get the step used to increment or decrement the spinner value.
17498 * @param obj The spinner object.
17499 * @return The step value.
17501 * @see elm_spinner_step_get() for more details.
17505 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17508 * Set the value the spinner displays.
17510 * @param obj The spinner object.
17511 * @param val The value to be displayed.
17513 * Value will be presented on the label following format specified with
17514 * elm_spinner_format_set().
17516 * @warning The value must to be between min and max values. This values
17517 * are set by elm_spinner_min_max_set().
17519 * @see elm_spinner_value_get().
17520 * @see elm_spinner_format_set().
17521 * @see elm_spinner_min_max_set().
17525 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17528 * Get the value displayed by the spinner.
17530 * @param obj The spinner object.
17531 * @return The value displayed.
17533 * @see elm_spinner_value_set() for details.
17537 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17540 * Set whether the spinner should wrap when it reaches its
17541 * minimum or maximum value.
17543 * @param obj The spinner object.
17544 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17547 * Disabled by default. If disabled, when the user tries to increment the
17549 * but displayed value plus step value is bigger than maximum value,
17551 * won't allow it. The same happens when the user tries to decrement it,
17552 * but the value less step is less than minimum value.
17554 * When wrap is enabled, in such situations it will allow these changes,
17555 * but will get the value that would be less than minimum and subtracts
17556 * from maximum. Or add the value that would be more than maximum to
17560 * @li min value = 10
17561 * @li max value = 50
17562 * @li step value = 20
17563 * @li displayed value = 20
17565 * When the user decrement value (using left or bottom arrow), it will
17566 * displays @c 40, because max - (min - (displayed - step)) is
17567 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17569 * @see elm_spinner_wrap_get().
17573 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17576 * Get whether the spinner should wrap when it reaches its
17577 * minimum or maximum value.
17579 * @param obj The spinner object
17580 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17581 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17583 * @see elm_spinner_wrap_set() for details.
17587 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17590 * Set whether the spinner can be directly edited by the user or not.
17592 * @param obj The spinner object.
17593 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17594 * don't allow users to edit it directly.
17596 * Spinner objects can have edition @b disabled, in which state they will
17597 * be changed only by arrows.
17598 * Useful for contexts
17599 * where you don't want your users to interact with it writting the value.
17601 * when using special values, the user can see real value instead
17602 * of special label on edition.
17604 * It's enabled by default.
17606 * @see elm_spinner_editable_get()
17610 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17613 * Get whether the spinner can be directly edited by the user or not.
17615 * @param obj The spinner object.
17616 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17617 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17619 * @see elm_spinner_editable_set() for details.
17623 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17626 * Set a special string to display in the place of the numerical value.
17628 * @param obj The spinner object.
17629 * @param value The value to be replaced.
17630 * @param label The label to be used.
17632 * It's useful for cases when a user should select an item that is
17633 * better indicated by a label than a value. For example, weekdays or months.
17637 * sp = elm_spinner_add(win);
17638 * elm_spinner_min_max_set(sp, 1, 3);
17639 * elm_spinner_special_value_add(sp, 1, "January");
17640 * elm_spinner_special_value_add(sp, 2, "February");
17641 * elm_spinner_special_value_add(sp, 3, "March");
17642 * evas_object_show(sp);
17647 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17650 * Set the interval on time updates for an user mouse button hold
17651 * on spinner widgets' arrows.
17653 * @param obj The spinner object.
17654 * @param interval The (first) interval value in seconds.
17656 * This interval value is @b decreased while the user holds the
17657 * mouse pointer either incrementing or decrementing spinner's value.
17659 * This helps the user to get to a given value distant from the
17660 * current one easier/faster, as it will start to change quicker and
17661 * quicker on mouse button holds.
17663 * The calculation for the next change interval value, starting from
17664 * the one set with this call, is the previous interval divided by
17665 * @c 1.05, so it decreases a little bit.
17667 * The default starting interval value for automatic changes is
17670 * @see elm_spinner_interval_get()
17674 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17677 * Get the interval on time updates for an user mouse button hold
17678 * on spinner widgets' arrows.
17680 * @param obj The spinner object.
17681 * @return The (first) interval value, in seconds, set on it.
17683 * @see elm_spinner_interval_set() for more details.
17687 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17694 * @defgroup Index Index
17696 * @image html img/widget/index/preview-00.png
17698 * An index widget gives you an index for fast access to whichever
17699 * group of other UI items one might have. It's a list of text
17700 * items (usually letters, for alphabetically ordered access).
17702 * Index widgets are by default hidden and just appear when the
17703 * user clicks over it's reserved area in the canvas. In its
17704 * default theme, it's an area one @ref Fingers "finger" wide on
17705 * the right side of the index widget's container.
17707 * When items on the index are selected, smart callbacks get
17708 * called, so that its user can make other container objects to
17709 * show a given area or child object depending on the index item
17710 * selected. You'd probably be using an index together with @ref
17711 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17714 * Smart events one can add callbacks for are:
17715 * - @c "changed" - When the selected index item changes. @c
17716 * event_info is the selected item's data pointer.
17717 * - @c "delay,changed" - When the selected index item changes, but
17718 * after a small idling period. @c event_info is the selected
17719 * item's data pointer.
17720 * - @c "selected" - When the user releases a mouse button and
17721 * selects an item. @c event_info is the selected item's data
17723 * - @c "level,up" - when the user moves a finger from the first
17724 * level to the second level
17725 * - @c "level,down" - when the user moves a finger from the second
17726 * level to the first level
17728 * The @c "delay,changed" event is so that it'll wait a small time
17729 * before actually reporting those events and, moreover, just the
17730 * last event happening on those time frames will actually be
17733 * Here are some examples on its usage:
17734 * @li @ref index_example_01
17735 * @li @ref index_example_02
17739 * @addtogroup Index
17743 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17746 * Add a new index widget to the given parent Elementary
17747 * (container) object
17749 * @param parent The parent object
17750 * @return a new index widget handle or @c NULL, on errors
17752 * This function inserts a new index widget on the canvas.
17756 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17759 * Set whether a given index widget is or not visible,
17762 * @param obj The index object
17763 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17765 * Not to be confused with visible as in @c evas_object_show() --
17766 * visible with regard to the widget's auto hiding feature.
17768 * @see elm_index_active_get()
17772 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17775 * Get whether a given index widget is currently visible or not.
17777 * @param obj The index object
17778 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17780 * @see elm_index_active_set() for more details
17784 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17787 * Set the items level for a given index widget.
17789 * @param obj The index object.
17790 * @param level @c 0 or @c 1, the currently implemented levels.
17792 * @see elm_index_item_level_get()
17796 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17799 * Get the items level set for a given index widget.
17801 * @param obj The index object.
17802 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17804 * @see elm_index_item_level_set() for more information
17808 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17811 * Returns the last selected item's data, for a given index widget.
17813 * @param obj The index object.
17814 * @return The item @b data associated to the last selected item on
17815 * @p obj (or @c NULL, on errors).
17817 * @warning The returned value is @b not an #Elm_Index_Item item
17818 * handle, but the data associated to it (see the @c item parameter
17819 * in elm_index_item_append(), as an example).
17823 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17826 * Append a new item on a given index widget.
17828 * @param obj The index object.
17829 * @param letter Letter under which the item should be indexed
17830 * @param item The item data to set for the index's item
17832 * Despite the most common usage of the @p letter argument is for
17833 * single char strings, one could use arbitrary strings as index
17836 * @c item will be the pointer returned back on @c "changed", @c
17837 * "delay,changed" and @c "selected" smart events.
17841 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17844 * Prepend a new item on a given index widget.
17846 * @param obj The index object.
17847 * @param letter Letter under which the item should be indexed
17848 * @param item The item data to set for the index's item
17850 * Despite the most common usage of the @p letter argument is for
17851 * single char strings, one could use arbitrary strings as index
17854 * @c item will be the pointer returned back on @c "changed", @c
17855 * "delay,changed" and @c "selected" smart events.
17859 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17862 * Append a new item, on a given index widget, <b>after the item
17863 * having @p relative as data</b>.
17865 * @param obj The index object.
17866 * @param letter Letter under which the item should be indexed
17867 * @param item The item data to set for the index's item
17868 * @param relative The item data of the index item to be the
17869 * predecessor of this new one
17871 * Despite the most common usage of the @p letter argument is for
17872 * single char strings, one could use arbitrary strings as index
17875 * @c item will be the pointer returned back on @c "changed", @c
17876 * "delay,changed" and @c "selected" smart events.
17878 * @note If @p relative is @c NULL or if it's not found to be data
17879 * set on any previous item on @p obj, this function will behave as
17880 * elm_index_item_append().
17884 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17887 * Prepend a new item, on a given index widget, <b>after the item
17888 * having @p relative as data</b>.
17890 * @param obj The index object.
17891 * @param letter Letter under which the item should be indexed
17892 * @param item The item data to set for the index's item
17893 * @param relative The item data of the index item to be the
17894 * successor of this new one
17896 * Despite the most common usage of the @p letter argument is for
17897 * single char strings, one could use arbitrary strings as index
17900 * @c item will be the pointer returned back on @c "changed", @c
17901 * "delay,changed" and @c "selected" smart events.
17903 * @note If @p relative is @c NULL or if it's not found to be data
17904 * set on any previous item on @p obj, this function will behave as
17905 * elm_index_item_prepend().
17909 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17912 * Insert a new item into the given index widget, using @p cmp_func
17913 * function to sort items (by item handles).
17915 * @param obj The index object.
17916 * @param letter Letter under which the item should be indexed
17917 * @param item The item data to set for the index's item
17918 * @param cmp_func The comparing function to be used to sort index
17919 * items <b>by #Elm_Index_Item item handles</b>
17920 * @param cmp_data_func A @b fallback function to be called for the
17921 * sorting of index items <b>by item data</b>). It will be used
17922 * when @p cmp_func returns @c 0 (equality), which means an index
17923 * item with provided item data already exists. To decide which
17924 * data item should be pointed to by the index item in question, @p
17925 * cmp_data_func will be used. If @p cmp_data_func returns a
17926 * non-negative value, the previous index item data will be
17927 * replaced by the given @p item pointer. If the previous data need
17928 * to be freed, it should be done by the @p cmp_data_func function,
17929 * because all references to it will be lost. If this function is
17930 * not provided (@c NULL is given), index items will be @b
17931 * duplicated, if @p cmp_func returns @c 0.
17933 * Despite the most common usage of the @p letter argument is for
17934 * single char strings, one could use arbitrary strings as index
17937 * @c item will be the pointer returned back on @c "changed", @c
17938 * "delay,changed" and @c "selected" smart events.
17942 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);
17945 * Remove an item from a given index widget, <b>to be referenced by
17946 * it's data value</b>.
17948 * @param obj The index object
17949 * @param item The item's data pointer for the item to be removed
17952 * If a deletion callback is set, via elm_index_item_del_cb_set(),
17953 * that callback function will be called by this one.
17955 * @warning The item to be removed from @p obj will be found via
17956 * its item data pointer, and not by an #Elm_Index_Item handle.
17960 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17963 * Find a given index widget's item, <b>using item data</b>.
17965 * @param obj The index object
17966 * @param item The item data pointed to by the desired index item
17967 * @return The index item handle, if found, or @c NULL otherwise
17971 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17974 * Removes @b all items from a given index widget.
17976 * @param obj The index object.
17978 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
17979 * that callback function will be called for each item in @p obj.
17983 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17986 * Go to a given items level on a index widget
17988 * @param obj The index object
17989 * @param level The index level (one of @c 0 or @c 1)
17993 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17996 * Return the data associated with a given index widget item
17998 * @param it The index widget item handle
17999 * @return The data associated with @p it
18001 * @see elm_index_item_data_set()
18005 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18008 * Set the data associated with a given index widget item
18010 * @param it The index widget item handle
18011 * @param data The new data pointer to set to @p it
18013 * This sets new item data on @p it.
18015 * @warning The old data pointer won't be touched by this function, so
18016 * the user had better to free that old data himself/herself.
18020 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18023 * Set the function to be called when a given index widget item is freed.
18025 * @param it The item to set the callback on
18026 * @param func The function to call on the item's deletion
18028 * When called, @p func will have both @c data and @c event_info
18029 * arguments with the @p it item's data value and, naturally, the
18030 * @c obj argument with a handle to the parent index widget.
18034 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18037 * Get the letter (string) set on a given index widget item.
18039 * @param it The index item handle
18040 * @return The letter string set on @p it
18044 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18051 * @defgroup Photocam Photocam
18053 * @image html img/widget/photocam/preview-00.png
18054 * @image latex img/widget/photocam/preview-00.eps
18056 * This is a widget specifically for displaying high-resolution digital
18057 * camera photos giving speedy feedback (fast load), low memory footprint
18058 * and zooming and panning as well as fitting logic. It is entirely focused
18059 * on jpeg images, and takes advantage of properties of the jpeg format (via
18060 * evas loader features in the jpeg loader).
18062 * Signals that you can add callbacks for are:
18063 * @li "clicked" - This is called when a user has clicked the photo without
18065 * @li "press" - This is called when a user has pressed down on the photo.
18066 * @li "longpressed" - This is called when a user has pressed down on the
18067 * photo for a long time without dragging around.
18068 * @li "clicked,double" - This is called when a user has double-clicked the
18070 * @li "load" - Photo load begins.
18071 * @li "loaded" - This is called when the image file load is complete for the
18072 * first view (low resolution blurry version).
18073 * @li "load,detail" - Photo detailed data load begins.
18074 * @li "loaded,detail" - This is called when the image file load is complete
18075 * for the detailed image data (full resolution needed).
18076 * @li "zoom,start" - Zoom animation started.
18077 * @li "zoom,stop" - Zoom animation stopped.
18078 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18079 * @li "scroll" - the content has been scrolled (moved)
18080 * @li "scroll,anim,start" - scrolling animation has started
18081 * @li "scroll,anim,stop" - scrolling animation has stopped
18082 * @li "scroll,drag,start" - dragging the contents around has started
18083 * @li "scroll,drag,stop" - dragging the contents around has stopped
18085 * @ref tutorial_photocam shows the API in action.
18089 * @brief Types of zoom available.
18091 typedef enum _Elm_Photocam_Zoom_Mode
18093 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18094 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18095 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18096 ELM_PHOTOCAM_ZOOM_MODE_LAST
18097 } Elm_Photocam_Zoom_Mode;
18099 * @brief Add a new Photocam object
18101 * @param parent The parent object
18102 * @return The new object or NULL if it cannot be created
18104 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18106 * @brief Set the photo file to be shown
18108 * @param obj The photocam object
18109 * @param file The photo file
18110 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18112 * This sets (and shows) the specified file (with a relative or absolute
18113 * path) and will return a load error (same error that
18114 * evas_object_image_load_error_get() will return). The image will change and
18115 * adjust its size at this point and begin a background load process for this
18116 * photo that at some time in the future will be displayed at the full
18119 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18121 * @brief Returns the path of the current image file
18123 * @param obj The photocam object
18124 * @return Returns the path
18126 * @see elm_photocam_file_set()
18128 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18130 * @brief Set the zoom level of the photo
18132 * @param obj The photocam object
18133 * @param zoom The zoom level to set
18135 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18136 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18137 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18138 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18141 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18143 * @brief Get the zoom level of the photo
18145 * @param obj The photocam object
18146 * @return The current zoom level
18148 * This returns the current zoom level of the photocam object. Note that if
18149 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18150 * (which is the default), the zoom level may be changed at any time by the
18151 * photocam object itself to account for photo size and photocam viewpoer
18154 * @see elm_photocam_zoom_set()
18155 * @see elm_photocam_zoom_mode_set()
18157 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18159 * @brief Set the zoom mode
18161 * @param obj The photocam object
18162 * @param mode The desired mode
18164 * This sets the zoom mode to manual or one of several automatic levels.
18165 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18166 * elm_photocam_zoom_set() and will stay at that level until changed by code
18167 * or until zoom mode is changed. This is the default mode. The Automatic
18168 * modes will allow the photocam object to automatically adjust zoom mode
18169 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18170 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18171 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18172 * pixels within the frame are left unfilled.
18174 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18176 * @brief Get the zoom mode
18178 * @param obj The photocam object
18179 * @return The current zoom mode
18181 * This gets the current zoom mode of the photocam object.
18183 * @see elm_photocam_zoom_mode_set()
18185 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18187 * @brief Get the current image pixel width and height
18189 * @param obj The photocam object
18190 * @param w A pointer to the width return
18191 * @param h A pointer to the height return
18193 * This gets the current photo pixel width and height (for the original).
18194 * The size will be returned in the integers @p w and @p h that are pointed
18197 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18199 * @brief Get the area of the image that is currently shown
18202 * @param x A pointer to the X-coordinate of region
18203 * @param y A pointer to the Y-coordinate of region
18204 * @param w A pointer to the width
18205 * @param h A pointer to the height
18207 * @see elm_photocam_image_region_show()
18208 * @see elm_photocam_image_region_bring_in()
18210 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18212 * @brief Set the viewed portion of the image
18214 * @param obj The photocam object
18215 * @param x X-coordinate of region in image original pixels
18216 * @param y Y-coordinate of region in image original pixels
18217 * @param w Width of region in image original pixels
18218 * @param h Height of region in image original pixels
18220 * This shows the region of the image without using animation.
18222 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18224 * @brief Bring in the viewed portion of the image
18226 * @param obj The photocam object
18227 * @param x X-coordinate of region in image original pixels
18228 * @param y Y-coordinate of region in image original pixels
18229 * @param w Width of region in image original pixels
18230 * @param h Height of region in image original pixels
18232 * This shows the region of the image using animation.
18234 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18236 * @brief Set the paused state for photocam
18238 * @param obj The photocam object
18239 * @param paused The pause state to set
18241 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18242 * photocam. The default is off. This will stop zooming using animation on
18243 * zoom levels changes and change instantly. This will stop any existing
18244 * animations that are running.
18246 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18248 * @brief Get the paused state for photocam
18250 * @param obj The photocam object
18251 * @return The current paused state
18253 * This gets the current paused state for the photocam object.
18255 * @see elm_photocam_paused_set()
18257 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18259 * @brief Get the internal low-res image used for photocam
18261 * @param obj The photocam object
18262 * @return The internal image object handle, or NULL if none exists
18264 * This gets the internal image object inside photocam. Do not modify it. It
18265 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18266 * deleted at any time as well.
18268 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18270 * @brief Set the photocam scrolling bouncing.
18272 * @param obj The photocam object
18273 * @param h_bounce bouncing for horizontal
18274 * @param v_bounce bouncing for vertical
18276 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18278 * @brief Get the photocam scrolling bouncing.
18280 * @param obj The photocam object
18281 * @param h_bounce bouncing for horizontal
18282 * @param v_bounce bouncing for vertical
18284 * @see elm_photocam_bounce_set()
18286 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18292 typedef enum _Elm_Map_Zoom_Mode
18294 ELM_MAP_ZOOM_MODE_MANUAL,
18295 ELM_MAP_ZOOM_MODE_AUTO_FIT,
18296 ELM_MAP_ZOOM_MODE_AUTO_FILL,
18297 ELM_MAP_ZOOM_MODE_LAST
18298 } Elm_Map_Zoom_Mode;
18300 typedef enum _Elm_Map_Route_Sources
18302 ELM_MAP_ROUTE_SOURCE_YOURS,
18303 ELM_MAP_ROUTE_SOURCE_MONAV,
18304 ELM_MAP_ROUTE_SOURCE_ORS,
18305 ELM_MAP_ROUTE_SOURCE_LAST
18306 } Elm_Map_Route_Sources;
18308 typedef enum _Elm_Map_Name_Sources
18310 ELM_MAP_NAME_SOURCE_NOMINATIM,
18311 ELM_MAP_NAME_SOURCE_LAST
18312 } Elm_Map_Name_Sources;
18314 typedef enum _Elm_Map_Route_Type
18316 ELM_MAP_ROUTE_TYPE_MOTOCAR,
18317 ELM_MAP_ROUTE_TYPE_BICYCLE,
18318 ELM_MAP_ROUTE_TYPE_FOOT,
18319 ELM_MAP_ROUTE_TYPE_LAST
18320 } Elm_Map_Route_Type;
18322 typedef enum _Elm_Map_Route_Method
18324 ELM_MAP_ROUTE_METHOD_FASTEST,
18325 ELM_MAP_ROUTE_METHOD_SHORTEST,
18326 ELM_MAP_ROUTE_METHOD_LAST
18327 } Elm_Map_Route_Method;
18329 typedef enum _Elm_Map_Name_Method
18331 ELM_MAP_NAME_METHOD_SEARCH,
18332 ELM_MAP_NAME_METHOD_REVERSE,
18333 ELM_MAP_NAME_METHOD_LAST
18334 } Elm_Map_Name_Method;
18336 typedef struct _Elm_Map_Marker Elm_Map_Marker;
18337 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
18338 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
18339 typedef struct _Elm_Map_Route Elm_Map_Route;
18340 typedef struct _Elm_Map_Name Elm_Map_Name;
18341 typedef struct _Elm_Map_Track Elm_Map_Track;
18343 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
18344 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
18345 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
18346 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
18348 typedef char *(*ElmMapModuleSourceFunc) (void);
18349 typedef int (*ElmMapModuleZoomMinFunc) (void);
18350 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18351 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18352 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18353 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18354 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18355 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18356 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18358 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18359 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18360 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18361 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18362 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18363 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18364 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18365 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18366 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18367 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18368 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18369 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18370 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18371 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);
18372 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);
18373 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18374 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18375 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);
18376 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);
18377 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18378 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18379 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
18380 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18381 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18382 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
18383 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18384 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18385 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
18386 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
18387 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
18388 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
18389 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
18390 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
18391 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
18392 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
18393 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
18394 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
18395 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
18396 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
18397 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
18398 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18399 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
18400 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18401 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
18402 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18403 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18404 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18405 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18406 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18407 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
18408 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18409 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);
18410 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
18411 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
18412 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
18413 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
18414 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
18415 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
18416 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
18417 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
18418 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
18419 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
18420 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);
18421 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18422 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18424 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
18426 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
18428 /* smart callbacks called:
18429 * "clicked" - when image clicked
18430 * "press" - when mouse/finger held down initially on image
18431 * "longpressed" - when mouse/finger held for long time on image
18432 * "clicked,double" - when mouse/finger double-clicked
18433 * "load,details" - when detailed image load begins
18434 * "loaded,details" - when detailed image load done
18435 * "zoom,start" - when zooming started
18436 * "zoom,stop" - when zooming stopped
18437 * "zoom,change" - when auto zoom mode changed zoom level
18438 * "scroll - the content has been scrolled (moved)
18439 * "scroll,anim,start" - scrolling animation has started
18440 * "scroll,anim,stop" - scrolling animation has stopped
18441 * "scroll,drag,start" - dragging the contents around has started
18442 * "scroll,drag,stop" - dragging the contents around has stopped
18446 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
18448 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
18450 EAPI double elm_route_lon_min_get(Evas_Object *obj);
18451 EAPI double elm_route_lat_min_get(Evas_Object *obj);
18452 EAPI double elm_route_lon_max_get(Evas_Object *obj);
18453 EAPI double elm_route_lat_max_get(Evas_Object *obj);
18457 * @defgroup Panel Panel
18459 * @image html img/widget/panel/preview-00.png
18460 * @image latex img/widget/panel/preview-00.eps
18462 * @brief A panel is a type of animated container that contains subobjects.
18463 * It can be expanded or contracted by clicking the button on it's edge.
18465 * Orientations are as follows:
18466 * @li ELM_PANEL_ORIENT_TOP
18467 * @li ELM_PANEL_ORIENT_LEFT
18468 * @li ELM_PANEL_ORIENT_RIGHT
18470 * @ref tutorial_panel shows one way to use this widget.
18473 typedef enum _Elm_Panel_Orient
18475 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
18476 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
18477 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
18478 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
18479 } Elm_Panel_Orient;
18481 * @brief Adds a panel object
18483 * @param parent The parent object
18485 * @return The panel object, or NULL on failure
18487 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18489 * @brief Sets the orientation of the panel
18491 * @param parent The parent object
18492 * @param orient The panel orientation. Can be one of the following:
18493 * @li ELM_PANEL_ORIENT_TOP
18494 * @li ELM_PANEL_ORIENT_LEFT
18495 * @li ELM_PANEL_ORIENT_RIGHT
18497 * Sets from where the panel will (dis)appear.
18499 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
18501 * @brief Get the orientation of the panel.
18503 * @param obj The panel object
18504 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
18506 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18508 * @brief Set the content of the panel.
18510 * @param obj The panel object
18511 * @param content The panel content
18513 * Once the content object is set, a previously set one will be deleted.
18514 * If you want to keep that old content object, use the
18515 * elm_panel_content_unset() function.
18517 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18519 * @brief Get the content of the panel.
18521 * @param obj The panel object
18522 * @return The content that is being used
18524 * Return the content object which is set for this widget.
18526 * @see elm_panel_content_set()
18528 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18530 * @brief Unset the content of the panel.
18532 * @param obj The panel object
18533 * @return The content that was being used
18535 * Unparent and return the content object which was set for this widget.
18537 * @see elm_panel_content_set()
18539 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18541 * @brief Set the state of the panel.
18543 * @param obj The panel object
18544 * @param hidden If true, the panel will run the animation to contract
18546 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
18548 * @brief Get the state of the panel.
18550 * @param obj The panel object
18551 * @param hidden If true, the panel is in the "hide" state
18553 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18555 * @brief Toggle the hidden state of the panel from code
18557 * @param obj The panel object
18559 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
18565 * @defgroup Panes Panes
18566 * @ingroup Elementary
18568 * @image html img/widget/panes/preview-00.png
18569 * @image latex img/widget/panes/preview-00.eps width=\textwidth
18571 * @image html img/panes.png
18572 * @image latex img/panes.eps width=\textwidth
18574 * The panes adds a dragable bar between two contents. When dragged
18575 * this bar will resize contents size.
18577 * Panes can be displayed vertically or horizontally, and contents
18578 * size proportion can be customized (homogeneous by default).
18580 * Smart callbacks one can listen to:
18581 * - "press" - The panes has been pressed (button wasn't released yet).
18582 * - "unpressed" - The panes was released after being pressed.
18583 * - "clicked" - The panes has been clicked>
18584 * - "clicked,double" - The panes has been double clicked
18586 * Available styles for it:
18589 * Here is an example on its usage:
18590 * @li @ref panes_example
18594 * @addtogroup Panes
18599 * Add a new panes widget to the given parent Elementary
18600 * (container) object.
18602 * @param parent The parent object.
18603 * @return a new panes widget handle or @c NULL, on errors.
18605 * This function inserts a new panes widget on the canvas.
18609 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18612 * Set the left content of the panes widget.
18614 * @param obj The panes object.
18615 * @param content The new left content object.
18617 * Once the content object is set, a previously set one will be deleted.
18618 * If you want to keep that old content object, use the
18619 * elm_panes_content_left_unset() function.
18621 * If panes is displayed vertically, left content will be displayed at
18624 * @see elm_panes_content_left_get()
18625 * @see elm_panes_content_right_set() to set content on the other side.
18629 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18632 * Set the right content of the panes widget.
18634 * @param obj The panes object.
18635 * @param content The new right content object.
18637 * Once the content object is set, a previously set one will be deleted.
18638 * If you want to keep that old content object, use the
18639 * elm_panes_content_right_unset() function.
18641 * If panes is displayed vertically, left content will be displayed at
18644 * @see elm_panes_content_right_get()
18645 * @see elm_panes_content_left_set() to set content on the other side.
18649 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18652 * Get the left content of the panes.
18654 * @param obj The panes object.
18655 * @return The left content object that is being used.
18657 * Return the left content object which is set for this widget.
18659 * @see elm_panes_content_left_set() for details.
18663 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18666 * Get the right content of the panes.
18668 * @param obj The panes object
18669 * @return The right content object that is being used
18671 * Return the right content object which is set for this widget.
18673 * @see elm_panes_content_right_set() for details.
18677 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18680 * Unset the left content used for the panes.
18682 * @param obj The panes object.
18683 * @return The left content object that was being used.
18685 * Unparent and return the left content object which was set for this widget.
18687 * @see elm_panes_content_left_set() for details.
18688 * @see elm_panes_content_left_get().
18692 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18695 * Unset the right content used for the panes..
18697 * @param obj The panes object.
18698 * @return The right content object that was being used.
18700 * Unparent and return the right content object which was set for this
18703 * @see elm_panes_content_right_set() for details.
18704 * @see elm_panes_content_right_get().
18708 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18711 * Get the size proportion of panes widget's left side.
18713 * @param obj The panes object.
18714 * @return float value between 0.0 and 1.0 representing size proportion
18717 * @see elm_panes_content_left_size_set() for more details.
18721 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18724 * Set the size proportion of panes widget's left side.
18726 * @param obj The panes object.
18727 * @param size Value between 0.0 and 1.0 representing size proportion
18730 * By default it's homogeneous, i.e., both sides have the same size.
18732 * If something different is required, it can be set with this function.
18733 * For example, if the left content should be displayed over
18734 * 75% of the panes size, @p size should be passed as @c 0.75.
18735 * This way, right content will be resized to 25% of panes size.
18737 * If displayed vertically, left content is displayed at top, and
18738 * right content at bottom.
18740 * @note This proportion will change when user drags the panes bar.
18742 * @see elm_panes_content_left_size_get()
18746 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
18749 * Set the orientation of a given panes widget.
18751 * @param obj The panes object.
18752 * @param horizontal Use @c EINA_TRUE to make @p obj to be
18753 * @b horizontal, @c EINA_FALSE to make it @b vertical.
18755 * Use this function to change how your panes is to be
18756 * disposed: vertically or horizontally.
18758 * By default it's displayed horizontally.
18760 * @see elm_panes_horizontal_get()
18764 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18767 * Retrieve the orientation of a given panes widget.
18769 * @param obj The panes object.
18770 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18771 * @c EINA_FALSE if it's @b vertical (and on errors).
18773 * @see elm_panes_horizontal_set() for more details.
18777 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18784 * @defgroup Flip Flip
18786 * @image html img/widget/flip/preview-00.png
18787 * @image latex img/widget/flip/preview-00.eps
18789 * This widget holds 2 content objects(Evas_Object): one on the front and one
18790 * on the back. It allows you to flip from front to back and vice-versa using
18791 * various animations.
18793 * If either the front or back contents are not set the flip will treat that
18794 * as transparent. So if you wore to set the front content but not the back,
18795 * and then call elm_flip_go() you would see whatever is below the flip.
18797 * For a list of supported animations see elm_flip_go().
18799 * Signals that you can add callbacks for are:
18800 * "animate,begin" - when a flip animation was started
18801 * "animate,done" - when a flip animation is finished
18803 * @ref tutorial_flip show how to use most of the API.
18807 typedef enum _Elm_Flip_Mode
18809 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
18810 ELM_FLIP_ROTATE_X_CENTER_AXIS,
18811 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
18812 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
18813 ELM_FLIP_CUBE_LEFT,
18814 ELM_FLIP_CUBE_RIGHT,
18816 ELM_FLIP_CUBE_DOWN,
18817 ELM_FLIP_PAGE_LEFT,
18818 ELM_FLIP_PAGE_RIGHT,
18822 typedef enum _Elm_Flip_Interaction
18824 ELM_FLIP_INTERACTION_NONE,
18825 ELM_FLIP_INTERACTION_ROTATE,
18826 ELM_FLIP_INTERACTION_CUBE,
18827 ELM_FLIP_INTERACTION_PAGE
18828 } Elm_Flip_Interaction;
18829 typedef enum _Elm_Flip_Direction
18831 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
18832 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
18833 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
18834 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
18835 } Elm_Flip_Direction;
18837 * @brief Add a new flip to the parent
18839 * @param parent The parent object
18840 * @return The new object or NULL if it cannot be created
18842 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18844 * @brief Set the front content of the flip widget.
18846 * @param obj The flip object
18847 * @param content The new front content object
18849 * Once the content object is set, a previously set one will be deleted.
18850 * If you want to keep that old content object, use the
18851 * elm_flip_content_front_unset() function.
18853 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18855 * @brief Set the back content of the flip widget.
18857 * @param obj The flip object
18858 * @param content The new back content object
18860 * Once the content object is set, a previously set one will be deleted.
18861 * If you want to keep that old content object, use the
18862 * elm_flip_content_back_unset() function.
18864 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18866 * @brief Get the front content used for the flip
18868 * @param obj The flip object
18869 * @return The front content object that is being used
18871 * Return the front content object which is set for this widget.
18873 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18875 * @brief Get the back content used for the flip
18877 * @param obj The flip object
18878 * @return The back content object that is being used
18880 * Return the back content object which is set for this widget.
18882 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18884 * @brief Unset the front content used for the flip
18886 * @param obj The flip object
18887 * @return The front content object that was being used
18889 * Unparent and return the front content object which was set for this widget.
18891 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18893 * @brief Unset the back content used for the flip
18895 * @param obj The flip object
18896 * @return The back content object that was being used
18898 * Unparent and return the back content object which was set for this widget.
18900 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18902 * @brief Get flip front visibility state
18904 * @param obj The flip objct
18905 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
18908 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18910 * @brief Set flip perspective
18912 * @param obj The flip object
18913 * @param foc The coordinate to set the focus on
18914 * @param x The X coordinate
18915 * @param y The Y coordinate
18917 * @warning This function currently does nothing.
18919 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
18921 * @brief Runs the flip animation
18923 * @param obj The flip object
18924 * @param mode The mode type
18926 * Flips the front and back contents using the @p mode animation. This
18927 * efectively hides the currently visible content and shows the hidden one.
18929 * There a number of possible animations to use for the flipping:
18930 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
18931 * around a horizontal axis in the middle of its height, the other content
18932 * is shown as the other side of the flip.
18933 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
18934 * around a vertical axis in the middle of its width, the other content is
18935 * shown as the other side of the flip.
18936 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
18937 * around a diagonal axis in the middle of its width, the other content is
18938 * shown as the other side of the flip.
18939 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
18940 * around a diagonal axis in the middle of its height, the other content is
18941 * shown as the other side of the flip.
18942 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
18943 * as if the flip was a cube, the other content is show as the right face of
18945 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
18946 * right as if the flip was a cube, the other content is show as the left
18947 * face of the cube.
18948 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
18949 * flip was a cube, the other content is show as the bottom face of the cube.
18950 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
18951 * the flip was a cube, the other content is show as the upper face of the
18953 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
18954 * if the flip was a book, the other content is shown as the page below that.
18955 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
18956 * as if the flip was a book, the other content is shown as the page below
18958 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
18959 * flip was a book, the other content is shown as the page below that.
18960 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
18961 * flip was a book, the other content is shown as the page below that.
18963 * @image html elm_flip.png
18964 * @image latex elm_flip.eps width=\textwidth
18966 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
18968 * @brief Set the interactive flip mode
18970 * @param obj The flip object
18971 * @param mode The interactive flip mode to use
18973 * This sets if the flip should be interactive (allow user to click and
18974 * drag a side of the flip to reveal the back page and cause it to flip).
18975 * By default a flip is not interactive. You may also need to set which
18976 * sides of the flip are "active" for flipping and how much space they use
18977 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
18978 * and elm_flip_interacton_direction_hitsize_set()
18980 * The four avilable mode of interaction are:
18981 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
18982 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
18983 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
18984 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
18986 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
18987 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
18988 * happen, those can only be acheived with elm_flip_go();
18990 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
18992 * @brief Get the interactive flip mode
18994 * @param obj The flip object
18995 * @return The interactive flip mode
18997 * Returns the interactive flip mode set by elm_flip_interaction_set()
18999 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
19001 * @brief Set which directions of the flip respond to interactive flip
19003 * @param obj The flip object
19004 * @param dir The direction to change
19005 * @param enabled If that direction is enabled or not
19007 * By default all directions are disabled, so you may want to enable the
19008 * desired directions for flipping if you need interactive flipping. You must
19009 * call this function once for each direction that should be enabled.
19011 * @see elm_flip_interaction_set()
19013 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
19015 * @brief Get the enabled state of that flip direction
19017 * @param obj The flip object
19018 * @param dir The direction to check
19019 * @return If that direction is enabled or not
19021 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
19023 * @see elm_flip_interaction_set()
19025 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
19027 * @brief Set the amount of the flip that is sensitive to interactive flip
19029 * @param obj The flip object
19030 * @param dir The direction to modify
19031 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
19033 * Set the amount of the flip that is sensitive to interactive flip, with 0
19034 * representing no area in the flip and 1 representing the entire flip. There
19035 * is however a consideration to be made in that the area will never be
19036 * smaller than the finger size set(as set in your Elementary configuration).
19038 * @see elm_flip_interaction_set()
19040 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
19042 * @brief Get the amount of the flip that is sensitive to interactive flip
19044 * @param obj The flip object
19045 * @param dir The direction to check
19046 * @return The size set for that direction
19048 * Returns the amount os sensitive area set by
19049 * elm_flip_interacton_direction_hitsize_set().
19051 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
19056 /* scrolledentry */
19057 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19058 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
19059 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19060 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
19061 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19062 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
19063 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19064 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
19065 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19066 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19067 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
19068 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
19069 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19070 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19071 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
19072 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
19073 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19074 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
19075 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
19076 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
19077 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
19078 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
19079 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
19080 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
19081 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
19082 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
19083 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19084 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19085 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19086 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
19087 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19088 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
19089 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
19090 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
19091 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19092 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);
19093 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19094 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19095 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);
19096 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19097 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);
19098 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
19099 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19100 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19101 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
19102 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
19103 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19104 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19105 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
19106 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);
19107 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);
19108 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);
19109 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);
19110 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);
19111 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);
19112 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
19113 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
19114 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
19115 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
19116 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19117 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
19118 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19121 * @defgroup Conformant Conformant
19122 * @ingroup Elementary
19124 * @image html img/widget/conformant/preview-00.png
19125 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
19127 * @image html img/conformant.png
19128 * @image latex img/conformant.eps width=\textwidth
19130 * The aim is to provide a widget that can be used in elementary apps to
19131 * account for space taken up by the indicator, virtual keypad & softkey
19132 * windows when running the illume2 module of E17.
19134 * So conformant content will be sized and positioned considering the
19135 * space required for such stuff, and when they popup, as a keyboard
19136 * shows when an entry is selected, conformant content won't change.
19138 * Available styles for it:
19141 * See how to use this widget in this example:
19142 * @ref conformant_example
19146 * @addtogroup Conformant
19151 * Add a new conformant widget to the given parent Elementary
19152 * (container) object.
19154 * @param parent The parent object.
19155 * @return A new conformant widget handle or @c NULL, on errors.
19157 * This function inserts a new conformant widget on the canvas.
19159 * @ingroup Conformant
19161 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19164 * Set the content of the conformant widget.
19166 * @param obj The conformant object.
19167 * @param content The content to be displayed by the conformant.
19169 * Content will be sized and positioned considering the space required
19170 * to display a virtual keyboard. So it won't fill all the conformant
19171 * size. This way is possible to be sure that content won't resize
19172 * or be re-positioned after the keyboard is displayed.
19174 * Once the content object is set, a previously set one will be deleted.
19175 * If you want to keep that old content object, use the
19176 * elm_conformat_content_unset() function.
19178 * @see elm_conformant_content_unset()
19179 * @see elm_conformant_content_get()
19181 * @ingroup Conformant
19183 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19186 * Get the content of the conformant widget.
19188 * @param obj The conformant object.
19189 * @return The content that is being used.
19191 * Return the content object which is set for this widget.
19192 * It won't be unparent from conformant. For that, use
19193 * elm_conformant_content_unset().
19195 * @see elm_conformant_content_set() for more details.
19196 * @see elm_conformant_content_unset()
19198 * @ingroup Conformant
19200 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19203 * Unset the content of the conformant widget.
19205 * @param obj The conformant object.
19206 * @return The content that was being used.
19208 * Unparent and return the content object which was set for this widget.
19210 * @see elm_conformant_content_set() for more details.
19212 * @ingroup Conformant
19214 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19217 * Returns the Evas_Object that represents the content area.
19219 * @param obj The conformant object.
19220 * @return The content area of the widget.
19222 * @ingroup Conformant
19224 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19231 * @defgroup Mapbuf Mapbuf
19232 * @ingroup Elementary
19234 * @image html img/widget/mapbuf/preview-00.png
19235 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
19237 * This holds one content object and uses an Evas Map of transformation
19238 * points to be later used with this content. So the content will be
19239 * moved, resized, etc as a single image. So it will improve performance
19240 * when you have a complex interafce, with a lot of elements, and will
19241 * need to resize or move it frequently (the content object and its
19244 * See how to use this widget in this example:
19245 * @ref mapbuf_example
19249 * @addtogroup Mapbuf
19254 * Add a new mapbuf widget to the given parent Elementary
19255 * (container) object.
19257 * @param parent The parent object.
19258 * @return A new mapbuf widget handle or @c NULL, on errors.
19260 * This function inserts a new mapbuf widget on the canvas.
19264 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19267 * Set the content of the mapbuf.
19269 * @param obj The mapbuf object.
19270 * @param content The content that will be filled in this mapbuf object.
19272 * Once the content object is set, a previously set one will be deleted.
19273 * If you want to keep that old content object, use the
19274 * elm_mapbuf_content_unset() function.
19276 * To enable map, elm_mapbuf_enabled_set() should be used.
19280 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19283 * Get the content of the mapbuf.
19285 * @param obj The mapbuf object.
19286 * @return The content that is being used.
19288 * Return the content object which is set for this widget.
19290 * @see elm_mapbuf_content_set() for details.
19294 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19297 * Unset the content of the mapbuf.
19299 * @param obj The mapbuf object.
19300 * @return The content that was being used.
19302 * Unparent and return the content object which was set for this widget.
19304 * @see elm_mapbuf_content_set() for details.
19308 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19311 * Enable or disable the map.
19313 * @param obj The mapbuf object.
19314 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
19316 * This enables the map that is set or disables it. On enable, the object
19317 * geometry will be saved, and the new geometry will change (position and
19318 * size) to reflect the map geometry set.
19320 * Also, when enabled, alpha and smooth states will be used, so if the
19321 * content isn't solid, alpha should be enabled, for example, otherwise
19322 * a black retangle will fill the content.
19324 * When disabled, the stored map will be freed and geometry prior to
19325 * enabling the map will be restored.
19327 * It's disabled by default.
19329 * @see elm_mapbuf_alpha_set()
19330 * @see elm_mapbuf_smooth_set()
19334 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
19337 * Get a value whether map is enabled or not.
19339 * @param obj The mapbuf object.
19340 * @return The value that the enabled state is set to.
19341 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
19342 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19344 * @see elm_mapbuf_enabled_set() for details.
19348 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19351 * Enable or disable smooth map rendering.
19353 * @param obj The mapbuf object.
19354 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
19357 * This sets smoothing for map rendering. If the object is a type that has
19358 * its own smoothing settings, then both the smooth settings for this object
19359 * and the map must be turned off.
19361 * By default smooth maps are enabled.
19365 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
19368 * Get a value whether smooth map rendering is enabled or not.
19370 * @param obj The mapbuf object.
19371 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
19372 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19374 * @see elm_mapbuf_smooth_set() for details.
19378 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19381 * Set or unset alpha flag for map rendering.
19383 * @param obj The mapbuf object.
19384 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
19387 * This sets alpha flag for map rendering. If the object is a type that has
19388 * its own alpha settings, then this will take precedence. Only image objects
19389 * have this currently. It stops alpha blending of the map area, and is
19390 * useful if you know the object and/or all sub-objects is 100% solid.
19392 * Alpha is enabled by default.
19396 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
19399 * Get a value whether alpha blending is enabled or not.
19401 * @param obj The mapbuf object.
19402 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
19403 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19405 * @see elm_mapbuf_alpha_set() for details.
19409 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19416 * @defgroup Flipselector Flip Selector
19418 * @image html img/widget/flipselector/preview-00.png
19419 * @image latex img/widget/flipselector/preview-00.eps
19421 * A flip selector is a widget to show a set of @b text items, one
19422 * at a time, with the same sheet switching style as the @ref Clock
19423 * "clock" widget, when one changes the current displaying sheet
19424 * (thus, the "flip" in the name).
19426 * User clicks to flip sheets which are @b held for some time will
19427 * make the flip selector to flip continuosly and automatically for
19428 * the user. The interval between flips will keep growing in time,
19429 * so that it helps the user to reach an item which is distant from
19430 * the current selection.
19432 * Smart callbacks one can register to:
19433 * - @c "selected" - when the widget's selected text item is changed
19434 * - @c "overflowed" - when the widget's current selection is changed
19435 * from the first item in its list to the last
19436 * - @c "underflowed" - when the widget's current selection is changed
19437 * from the last item in its list to the first
19439 * Available styles for it:
19442 * Here is an example on its usage:
19443 * @li @ref flipselector_example
19447 * @addtogroup Flipselector
19451 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
19454 * Add a new flip selector widget to the given parent Elementary
19455 * (container) widget
19457 * @param parent The parent object
19458 * @return a new flip selector widget handle or @c NULL, on errors
19460 * This function inserts a new flip selector widget on the canvas.
19462 * @ingroup Flipselector
19464 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19467 * Programmatically select the next item of a flip selector widget
19469 * @param obj The flipselector object
19471 * @note The selection will be animated. Also, if it reaches the
19472 * end of its list of member items, it will continue with the first
19475 * @ingroup Flipselector
19477 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19480 * Programmatically select the previous item of a flip selector
19483 * @param obj The flipselector object
19485 * @note The selection will be animated. Also, if it reaches the
19486 * beginning of its list of member items, it will continue with the
19487 * last one backwards.
19489 * @ingroup Flipselector
19491 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
19494 * Append a (text) item to a flip selector widget
19496 * @param obj The flipselector object
19497 * @param label The (text) label of the new item
19498 * @param func Convenience callback function to take place when
19500 * @param data Data passed to @p func, above
19501 * @return A handle to the item added or @c NULL, on errors
19503 * The widget's list of labels to show will be appended with the
19504 * given value. If the user wishes so, a callback function pointer
19505 * can be passed, which will get called when this same item is
19508 * @note The current selection @b won't be modified by appending an
19509 * element to the list.
19511 * @note The maximum length of the text label is going to be
19512 * determined <b>by the widget's theme</b>. Strings larger than
19513 * that value are going to be @b truncated.
19515 * @ingroup Flipselector
19517 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
19520 * Prepend a (text) item to a flip selector widget
19522 * @param obj The flipselector object
19523 * @param label The (text) label of the new item
19524 * @param func Convenience callback function to take place when
19526 * @param data Data passed to @p func, above
19527 * @return A handle to the item added or @c NULL, on errors
19529 * The widget's list of labels to show will be prepended with the
19530 * given value. If the user wishes so, a callback function pointer
19531 * can be passed, which will get called when this same item is
19534 * @note The current selection @b won't be modified by prepending
19535 * an element to the list.
19537 * @note The maximum length of the text label is going to be
19538 * determined <b>by the widget's theme</b>. Strings larger than
19539 * that value are going to be @b truncated.
19541 * @ingroup Flipselector
19543 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
19546 * Get the internal list of items in a given flip selector widget.
19548 * @param obj The flipselector object
19549 * @return The list of items (#Elm_Flipselector_Item as data) or
19550 * @c NULL on errors.
19552 * This list is @b not to be modified in any way and must not be
19553 * freed. Use the list members with functions like
19554 * elm_flipselector_item_label_set(),
19555 * elm_flipselector_item_label_get(),
19556 * elm_flipselector_item_del(),
19557 * elm_flipselector_item_selected_get(),
19558 * elm_flipselector_item_selected_set().
19560 * @warning This list is only valid until @p obj object's internal
19561 * items list is changed. It should be fetched again with another
19562 * call to this function when changes happen.
19564 * @ingroup Flipselector
19566 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19569 * Get the first item in the given flip selector widget's list of
19572 * @param obj The flipselector object
19573 * @return The first item or @c NULL, if it has no items (and on
19576 * @see elm_flipselector_item_append()
19577 * @see elm_flipselector_last_item_get()
19579 * @ingroup Flipselector
19581 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19584 * Get the last item in the given flip selector widget's list of
19587 * @param obj The flipselector object
19588 * @return The last item or @c NULL, if it has no items (and on
19591 * @see elm_flipselector_item_prepend()
19592 * @see elm_flipselector_first_item_get()
19594 * @ingroup Flipselector
19596 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19599 * Get the currently selected item in a flip selector widget.
19601 * @param obj The flipselector object
19602 * @return The selected item or @c NULL, if the widget has no items
19605 * @ingroup Flipselector
19607 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19610 * Set whether a given flip selector widget's item should be the
19611 * currently selected one.
19613 * @param item The flip selector item
19614 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
19616 * This sets whether @p item is or not the selected (thus, under
19617 * display) one. If @p item is different than one under display,
19618 * the latter will be unselected. If the @p item is set to be
19619 * unselected, on the other hand, the @b first item in the widget's
19620 * internal members list will be the new selected one.
19622 * @see elm_flipselector_item_selected_get()
19624 * @ingroup Flipselector
19626 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19629 * Get whether a given flip selector widget's item is the currently
19632 * @param item The flip selector item
19633 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19636 * @see elm_flipselector_item_selected_set()
19638 * @ingroup Flipselector
19640 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
19643 * Delete a given item from a flip selector widget.
19645 * @param item The item to delete
19647 * @ingroup Flipselector
19649 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
19652 * Get the label of a given flip selector widget's item.
19654 * @param item The item to get label from
19655 * @return The text label of @p item or @c NULL, on errors
19657 * @see elm_flipselector_item_label_set()
19659 * @ingroup Flipselector
19661 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
19664 * Set the label of a given flip selector widget's item.
19666 * @param item The item to set label on
19667 * @param label The text label string, in UTF-8 encoding
19669 * @see elm_flipselector_item_label_get()
19671 * @ingroup Flipselector
19673 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
19676 * Gets the item before @p item in a flip selector widget's
19677 * internal list of items.
19679 * @param item The item to fetch previous from
19680 * @return The item before the @p item, in its parent's list. If
19681 * there is no previous item for @p item or there's an
19682 * error, @c NULL is returned.
19684 * @see elm_flipselector_item_next_get()
19686 * @ingroup Flipselector
19688 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
19691 * Gets the item after @p item in a flip selector widget's
19692 * internal list of items.
19694 * @param item The item to fetch next from
19695 * @return The item after the @p item, in its parent's list. If
19696 * there is no next item for @p item or there's an
19697 * error, @c NULL is returned.
19699 * @see elm_flipselector_item_next_get()
19701 * @ingroup Flipselector
19703 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
19706 * Set the interval on time updates for an user mouse button hold
19707 * on a flip selector widget.
19709 * @param obj The flip selector object
19710 * @param interval The (first) interval value in seconds
19712 * This interval value is @b decreased while the user holds the
19713 * mouse pointer either flipping up or flipping doww a given flip
19716 * This helps the user to get to a given item distant from the
19717 * current one easier/faster, as it will start to flip quicker and
19718 * quicker on mouse button holds.
19720 * The calculation for the next flip interval value, starting from
19721 * the one set with this call, is the previous interval divided by
19722 * 1.05, so it decreases a little bit.
19724 * The default starting interval value for automatic flips is
19727 * @see elm_flipselector_interval_get()
19729 * @ingroup Flipselector
19731 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19734 * Get the interval on time updates for an user mouse button hold
19735 * on a flip selector widget.
19737 * @param obj The flip selector object
19738 * @return The (first) interval value, in seconds, set on it
19740 * @see elm_flipselector_interval_set() for more details
19742 * @ingroup Flipselector
19744 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19751 * @addtogroup Animator Animator
19752 * @ingroup Elementary
19754 * @brief Functions to ease creation of animations.
19756 * elm_animator is designed to provide an easy way to create animations.
19757 * Creating an animation with elm_animator is as simple as setting a
19758 * duration, an operating callback and telling it to run the animation.
19759 * However that is not the full extent of elm_animator's ability, animations
19760 * can be paused and resumed, reversed and the animation need not be linear.
19762 * To run an animation you must specify at least a duration and operation
19763 * callback, not setting any other properties will create a linear animation
19764 * that runs once and is not reversed.
19766 * @ref elm_animator_example_page_01 "This" example should make all of that
19769 * @warning elm_animator is @b not a widget.
19773 * @brief Type of curve desired for animation.
19775 * The speed in which an animation happens doesn't have to be linear, some
19776 * animations will look better if they're accelerating or decelerating, so
19777 * elm_animator provides four options in this regard:
19779 * @image html elm_animator_curve_style.png
19780 * @image latex elm_animator_curve_style.eps width=\textwidth
19781 * As can be seen in the image the speed of the animation will be:
19782 * @li ELM_ANIMATOR_CURVE_LINEAR constant
19783 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
19784 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
19785 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
19789 ELM_ANIMATOR_CURVE_LINEAR,
19790 ELM_ANIMATOR_CURVE_IN_OUT,
19791 ELM_ANIMATOR_CURVE_IN,
19792 ELM_ANIMATOR_CURVE_OUT
19793 } Elm_Animator_Curve_Style;
19794 typedef struct _Elm_Animator Elm_Animator;
19796 * Called back per loop of an elementary animators cycle
19797 * @param data user-data given to elm_animator_operation_callback_set()
19798 * @param animator the animator being run
19799 * @param double the position in the animation
19801 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
19803 * Called back when an elementary animator finishes
19804 * @param data user-data given to elm_animator_completion_callback_set()
19806 typedef void (*Elm_Animator_Completion_Cb) (void *data);
19809 * @brief Create a new animator.
19811 * @param[in] parent Parent object
19813 * The @a parent argument can be set to NULL for no parent. If a parent is set
19814 * there is no need to call elm_animator_del(), when the parent is deleted it
19815 * will delete the animator.
19816 * @deprecated Use @ref Transit instead.
19818 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
19820 * Deletes the animator freeing any resources it used. If the animator was
19821 * created with a NULL parent this must be called, otherwise it will be
19822 * automatically called when the parent is deleted.
19824 * @param[in] animator Animator object
19825 * @deprecated Use @ref Transit instead.
19827 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
19829 * Set the duration of the animation.
19831 * @param[in] animator Animator object
19832 * @param[in] duration Duration in second
19833 * @deprecated Use @ref Transit instead.
19835 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
19837 * @brief Set the callback function for animator operation.
19839 * @param[in] animator Animator object
19840 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
19841 * @param[in] data Callback function user argument
19843 * The @p func callback will be called with a frame value in range [0, 1] which
19844 * indicates how far along the animation should be. It is the job of @p func to
19845 * actually change the state of any object(or objects) that are being animated.
19846 * @deprecated Use @ref Transit instead.
19848 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
19850 * Set the callback function for the when the animation ends.
19852 * @param[in] animator Animator object
19853 * @param[in] func Callback function pointe
19854 * @param[in] data Callback function user argument
19856 * @warning @a func will not be executed if elm_animator_stop() is called.
19857 * @deprecated Use @ref Transit instead.
19859 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
19861 * @brief Stop animator.
19863 * @param[in] animator Animator object
19865 * If called before elm_animator_animate() it does nothing. If there is an
19866 * animation in progress the animation will be stopped(the operation callback
19867 * will not be executed again) and it can't be restarted using
19868 * elm_animator_resume().
19869 * @deprecated Use @ref Transit instead.
19871 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
19873 * Set the animator repeat count.
19875 * @param[in] animator Animator object
19876 * @param[in] repeat_cnt Repeat count
19877 * @deprecated Use @ref Transit instead.
19879 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
19881 * @brief Start animation.
19883 * @param[in] animator Animator object
19885 * This function starts the animation if the nescessary properties(duration
19886 * and operation callback) have been set. Once started the animation will
19887 * run until complete or elm_animator_stop() is called.
19888 * @deprecated Use @ref Transit instead.
19890 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
19892 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
19894 * @param[in] animator Animator object
19895 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
19896 * @deprecated Use @ref Transit instead.
19898 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
19900 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
19902 * @param[in] animator Animator object
19903 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
19904 * @deprecated Use @ref Transit instead.
19906 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
19908 * @brief Sets wether the animation should be automatically reversed.
19910 * @param[in] animator Animator object
19911 * @param[in] reverse Reverse or not
19913 * This controls wether the animation will be run on reverse imediately after
19914 * running forward. When this is set together with repetition the animation
19915 * will run in reverse once for each time it ran forward.@n
19916 * Runnin an animation in reverse is accomplished by calling the operation
19917 * callback with a frame value starting at 1 and diminshing until 0.
19918 * @deprecated Use @ref Transit instead.
19920 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
19922 * Gets wether the animation will automatically reversed
19924 * @param[in] animator Animator object
19925 * @deprecated Use @ref Transit instead.
19927 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
19929 * Gets the status for the animator operation. The status of the animator @b
19930 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
19931 * only informs if the animation was started and has not ended(either normally
19932 * or through elm_animator_stop()).
19934 * @param[in] animator Animator object
19935 * @deprecated Use @ref Transit instead.
19937 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
19939 * Gets how many times the animation will be repeated
19941 * @param[in] animator Animator object
19942 * @deprecated Use @ref Transit instead.
19944 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
19946 * Pause the animator.
19948 * @param[in] animator Animator object
19950 * This causes the animation to be temporarily stopped(the operation callback
19951 * will not be called). If the animation is not yet running this is a no-op.
19952 * Once an animation has been paused with this function it can be resumed
19953 * using elm_animator_resume().
19954 * @deprecated Use @ref Transit instead.
19956 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
19958 * @brief Resumes the animator.
19960 * @param[in] animator Animator object
19962 * Resumes an animation that was paused using elm_animator_pause(), after
19963 * calling this function calls to the operation callback will happen
19964 * normally. If an animation is stopped by means of elm_animator_stop it
19965 * @b can't be restarted with this function.@n
19967 * @warning When an animation is resumed it doesn't start from where it was paused, it
19968 * will go to where it would have been if it had not been paused. If an
19969 * animation with a duration of 3 seconds is paused after 1 second for 1 second
19970 * it will resume as if it had ben animating for 2 seconds, the operating
19971 * callback will be called with a frame value of aproximately 2/3.
19972 * @deprecated Use @ref Transit instead.
19974 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
19980 * @defgroup Calendar Calendar
19981 * @ingroup Elementary
19983 * @image html img/widget/calendar/preview-00.png
19984 * @image latex img/widget/calendar/preview-00.eps
19986 * A calendar is a widget that displays a regular calendar, one
19987 * month at a time, to the user, and can allows the user to select a date.
19989 * It has support to adding check marks (holidays and checks are supported
19990 * by default theme).
19992 * Weekday names and the function used to format month and year to
19993 * be displayed can be set, giving more flexibility to this widget.
19995 * Smart callbacks one can register to:
19996 * - "changed" - emitted when the user selects a day or changes the
19997 * displayed month, what actually changes the selected day as well.
19999 * Available styles for it:
20002 * List of examples:
20003 * @li @ref calendar_example_01
20004 * @li @ref calendar_example_02
20005 * @li @ref calendar_example_03
20006 * @li @ref calendar_example_04
20007 * @li @ref calendar_example_05
20008 * @li @ref calendar_example_06
20012 * @addtogroup Calendar
20017 * @enum _Elm_Calendar_Mark_Repeat
20018 * @typedef Elm_Calendar_Mark_Repeat
20020 * Event periodicity, used to define if a mark should be repeated
20021 * @b beyond event's day. It's set when a mark is added.
20023 * So, for a mark added to 13th May with periodicity set to WEEKLY,
20024 * there will be marks every week after this date. Marks will be displayed
20025 * at 13th, 20th, 27th, 3rd June ...
20027 * Values don't work as bitmaks, only one can be choosen.
20029 * @see elm_calendar_mark_add()
20031 * @ingroup Calendar
20033 typedef enum _Elm_Calendar_Mark_Repeat
20035 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
20036 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
20037 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
20038 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*/
20039 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. */
20040 } Elm_Calendar_Mark_Repeat;
20042 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(). */
20045 * Add a new calendar widget to the given parent Elementary
20046 * (container) object.
20048 * @param parent The parent object.
20049 * @return a new calendar widget handle or @c NULL, on errors.
20051 * This function inserts a new calendar widget on the canvas.
20053 * @ref calendar_example_01
20055 * @ingroup Calendar
20057 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20060 * Get weekdays names displayed by the calendar.
20062 * @param obj The calendar object.
20063 * @return Array of seven strings to be used as weekday names.
20065 * By default, weekdays abbreviations get from system are displayed:
20066 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
20067 * The first string is related to Sunday, the second to Monday...
20069 * @see elm_calendar_weekdays_name_set()
20071 * @ref calendar_example_05
20073 * @ingroup Calendar
20075 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20078 * Set weekdays names to be displayed by the calendar.
20080 * @param obj The calendar object.
20081 * @param weedays Array of seven strings to be used as weekday names.
20082 * @warning It must have 7 elements, or it will access invalid memory.
20083 * @warning The strings must be NULL terminated ('@\0').
20085 * By default, weekdays abbreviations get from system are displayed:
20086 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
20088 * The first string should be related to Sunday, the second to Monday...
20090 * The usage should be like this:
20092 * const char *weekdays[] =
20094 * "Sunday", "Monday", "Tuesday", "Wednesday",
20095 * "Thursday", "Friday", "Saturday"
20097 * elm_calendar_weekdays_names_set(calendar, weekdays);
20100 * @see elm_calendar_weekdays_name_get()
20102 * @ref calendar_example_02
20104 * @ingroup Calendar
20106 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
20109 * Set the minimum and maximum values for the year
20111 * @param obj The calendar object
20112 * @param min The minimum year, greater than 1901;
20113 * @param max The maximum year;
20115 * Maximum must be greater than minimum, except if you don't wan't to set
20117 * Default values are 1902 and -1.
20119 * If the maximum year is a negative value, it will be limited depending
20120 * on the platform architecture (year 2037 for 32 bits);
20122 * @see elm_calendar_min_max_year_get()
20124 * @ref calendar_example_03
20126 * @ingroup Calendar
20128 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
20131 * Get the minimum and maximum values for the year
20133 * @param obj The calendar object.
20134 * @param min The minimum year.
20135 * @param max The maximum year.
20137 * Default values are 1902 and -1.
20139 * @see elm_calendar_min_max_year_get() for more details.
20141 * @ref calendar_example_05
20143 * @ingroup Calendar
20145 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
20148 * Enable or disable day selection
20150 * @param obj The calendar object.
20151 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
20154 * Enabled by default. If disabled, the user still can select months,
20155 * but not days. Selected days are highlighted on calendar.
20156 * It should be used if you won't need such selection for the widget usage.
20158 * When a day is selected, or month is changed, smart callbacks for
20159 * signal "changed" will be called.
20161 * @see elm_calendar_day_selection_enable_get()
20163 * @ref calendar_example_04
20165 * @ingroup Calendar
20167 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20170 * Get a value whether day selection is enabled or not.
20172 * @see elm_calendar_day_selection_enable_set() for details.
20174 * @param obj The calendar object.
20175 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
20176 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
20178 * @ref calendar_example_05
20180 * @ingroup Calendar
20182 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20186 * Set selected date to be highlighted on calendar.
20188 * @param obj The calendar object.
20189 * @param selected_time A @b tm struct to represent the selected date.
20191 * Set the selected date, changing the displayed month if needed.
20192 * Selected date changes when the user goes to next/previous month or
20193 * select a day pressing over it on calendar.
20195 * @see elm_calendar_selected_time_get()
20197 * @ref calendar_example_04
20199 * @ingroup Calendar
20201 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
20204 * Get selected date.
20206 * @param obj The calendar object
20207 * @param selected_time A @b tm struct to point to selected date
20208 * @return EINA_FALSE means an error ocurred and returned time shouldn't
20211 * Get date selected by the user or set by function
20212 * elm_calendar_selected_time_set().
20213 * Selected date changes when the user goes to next/previous month or
20214 * select a day pressing over it on calendar.
20216 * @see elm_calendar_selected_time_get()
20218 * @ref calendar_example_05
20220 * @ingroup Calendar
20222 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
20225 * Set a function to format the string that will be used to display
20228 * @param obj The calendar object
20229 * @param format_function Function to set the month-year string given
20230 * the selected date
20232 * By default it uses strftime with "%B %Y" format string.
20233 * It should allocate the memory that will be used by the string,
20234 * that will be freed by the widget after usage.
20235 * A pointer to the string and a pointer to the time struct will be provided.
20240 * _format_month_year(struct tm *selected_time)
20243 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
20244 * return strdup(buf);
20247 * elm_calendar_format_function_set(calendar, _format_month_year);
20250 * @ref calendar_example_02
20252 * @ingroup Calendar
20254 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
20257 * Add a new mark to the calendar
20259 * @param obj The calendar object
20260 * @param mark_type A string used to define the type of mark. It will be
20261 * emitted to the theme, that should display a related modification on these
20262 * days representation.
20263 * @param mark_time A time struct to represent the date of inclusion of the
20264 * mark. For marks that repeats it will just be displayed after the inclusion
20265 * date in the calendar.
20266 * @param repeat Repeat the event following this periodicity. Can be a unique
20267 * mark (that don't repeat), daily, weekly, monthly or annually.
20268 * @return The created mark or @NULL upon failure.
20270 * Add a mark that will be drawn in the calendar respecting the insertion
20271 * time and periodicity. It will emit the type as signal to the widget theme.
20272 * Default theme supports "holiday" and "checked", but it can be extended.
20274 * It won't immediately update the calendar, drawing the marks.
20275 * For this, call elm_calendar_marks_draw(). However, when user selects
20276 * next or previous month calendar forces marks drawn.
20278 * Marks created with this method can be deleted with
20279 * elm_calendar_mark_del().
20283 * struct tm selected_time;
20284 * time_t current_time;
20286 * current_time = time(NULL) + 5 * 84600;
20287 * localtime_r(¤t_time, &selected_time);
20288 * elm_calendar_mark_add(cal, "holiday", selected_time,
20289 * ELM_CALENDAR_ANNUALLY);
20291 * current_time = time(NULL) + 1 * 84600;
20292 * localtime_r(¤t_time, &selected_time);
20293 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
20295 * elm_calendar_marks_draw(cal);
20298 * @see elm_calendar_marks_draw()
20299 * @see elm_calendar_mark_del()
20301 * @ref calendar_example_06
20303 * @ingroup Calendar
20305 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);
20308 * Delete mark from the calendar.
20310 * @param mark The mark to be deleted.
20312 * If deleting all calendar marks is required, elm_calendar_marks_clear()
20313 * should be used instead of getting marks list and deleting each one.
20315 * @see elm_calendar_mark_add()
20317 * @ref calendar_example_06
20319 * @ingroup Calendar
20321 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
20324 * Remove all calendar's marks
20326 * @param obj The calendar object.
20328 * @see elm_calendar_mark_add()
20329 * @see elm_calendar_mark_del()
20331 * @ingroup Calendar
20333 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20337 * Get a list of all the calendar marks.
20339 * @param obj The calendar object.
20340 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
20342 * @see elm_calendar_mark_add()
20343 * @see elm_calendar_mark_del()
20344 * @see elm_calendar_marks_clear()
20346 * @ingroup Calendar
20348 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20351 * Draw calendar marks.
20353 * @param obj The calendar object.
20355 * Should be used after adding, removing or clearing marks.
20356 * It will go through the entire marks list updating the calendar.
20357 * If lots of marks will be added, add all the marks and then call
20360 * When the month is changed, i.e. user selects next or previous month,
20361 * marks will be drawed.
20363 * @see elm_calendar_mark_add()
20364 * @see elm_calendar_mark_del()
20365 * @see elm_calendar_marks_clear()
20367 * @ref calendar_example_06
20369 * @ingroup Calendar
20371 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
20374 * Set a day text color to the same that represents Saturdays.
20376 * @param obj The calendar object.
20377 * @param pos The text position. Position is the cell counter, from left
20378 * to right, up to down. It starts on 0 and ends on 41.
20380 * @deprecated use elm_calendar_mark_add() instead like:
20383 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
20384 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
20387 * @see elm_calendar_mark_add()
20389 * @ingroup Calendar
20391 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20394 * Set a day text color to the same that represents Sundays.
20396 * @param obj The calendar object.
20397 * @param pos The text position. Position is the cell counter, from left
20398 * to right, up to down. It starts on 0 and ends on 41.
20400 * @deprecated use elm_calendar_mark_add() instead like:
20403 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
20404 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
20407 * @see elm_calendar_mark_add()
20409 * @ingroup Calendar
20411 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20414 * Set a day text color to the same that represents Weekdays.
20416 * @param obj The calendar object
20417 * @param pos The text position. Position is the cell counter, from left
20418 * to right, up to down. It starts on 0 and ends on 41.
20420 * @deprecated use elm_calendar_mark_add() instead like:
20423 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
20425 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
20426 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
20427 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
20428 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
20429 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
20430 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
20431 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
20432 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
20433 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
20436 * @see elm_calendar_mark_add()
20438 * @ingroup Calendar
20440 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20443 * Set the interval on time updates for an user mouse button hold
20444 * on calendar widgets' month selection.
20446 * @param obj The calendar object
20447 * @param interval The (first) interval value in seconds
20449 * This interval value is @b decreased while the user holds the
20450 * mouse pointer either selecting next or previous month.
20452 * This helps the user to get to a given month distant from the
20453 * current one easier/faster, as it will start to change quicker and
20454 * quicker on mouse button holds.
20456 * The calculation for the next change interval value, starting from
20457 * the one set with this call, is the previous interval divided by
20458 * 1.05, so it decreases a little bit.
20460 * The default starting interval value for automatic changes is
20463 * @see elm_calendar_interval_get()
20465 * @ingroup Calendar
20467 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20470 * Get the interval on time updates for an user mouse button hold
20471 * on calendar widgets' month selection.
20473 * @param obj The calendar object
20474 * @return The (first) interval value, in seconds, set on it
20476 * @see elm_calendar_interval_set() for more details
20478 * @ingroup Calendar
20480 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20487 * @defgroup Diskselector Diskselector
20488 * @ingroup Elementary
20490 * @image html img/widget/diskselector/preview-00.png
20491 * @image latex img/widget/diskselector/preview-00.eps
20493 * A diskselector is a kind of list widget. It scrolls horizontally,
20494 * and can contain label and icon objects. Three items are displayed
20495 * with the selected one in the middle.
20497 * It can act like a circular list with round mode and labels can be
20498 * reduced for a defined length for side items.
20500 * Smart callbacks one can listen to:
20501 * - "selected" - when item is selected, i.e. scroller stops.
20503 * Available styles for it:
20506 * List of examples:
20507 * @li @ref diskselector_example_01
20508 * @li @ref diskselector_example_02
20512 * @addtogroup Diskselector
20516 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(). */
20519 * Add a new diskselector widget to the given parent Elementary
20520 * (container) object.
20522 * @param parent The parent object.
20523 * @return a new diskselector widget handle or @c NULL, on errors.
20525 * This function inserts a new diskselector widget on the canvas.
20527 * @ingroup Diskselector
20529 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20532 * Enable or disable round mode.
20534 * @param obj The diskselector object.
20535 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
20538 * Disabled by default. If round mode is enabled the items list will
20539 * work like a circle list, so when the user reaches the last item,
20540 * the first one will popup.
20542 * @see elm_diskselector_round_get()
20544 * @ingroup Diskselector
20546 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
20549 * Get a value whether round mode is enabled or not.
20551 * @see elm_diskselector_round_set() for details.
20553 * @param obj The diskselector object.
20554 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
20555 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20557 * @ingroup Diskselector
20559 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20562 * Get the side labels max length.
20564 * @deprecated use elm_diskselector_side_label_length_get() instead:
20566 * @param obj The diskselector object.
20567 * @return The max length defined for side labels, or 0 if not a valid
20570 * @ingroup Diskselector
20572 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20575 * Set the side labels max length.
20577 * @deprecated use elm_diskselector_side_label_length_set() instead:
20579 * @param obj The diskselector object.
20580 * @param len The max length defined for side labels.
20582 * @ingroup Diskselector
20584 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
20587 * Get the side labels max length.
20589 * @see elm_diskselector_side_label_length_set() for details.
20591 * @param obj The diskselector object.
20592 * @return The max length defined for side labels, or 0 if not a valid
20595 * @ingroup Diskselector
20597 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20600 * Set the side labels max length.
20602 * @param obj The diskselector object.
20603 * @param len The max length defined for side labels.
20605 * Length is the number of characters of items' label that will be
20606 * visible when it's set on side positions. It will just crop
20607 * the string after defined size. E.g.:
20609 * An item with label "January" would be displayed on side position as
20610 * "Jan" if max length is set to 3, or "Janu", if this property
20613 * When it's selected, the entire label will be displayed, except for
20614 * width restrictions. In this case label will be cropped and "..."
20615 * will be concatenated.
20617 * Default side label max length is 3.
20619 * This property will be applyed over all items, included before or
20620 * later this function call.
20622 * @ingroup Diskselector
20624 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
20627 * Set the number of items to be displayed.
20629 * @param obj The diskselector object.
20630 * @param num The number of items the diskselector will display.
20632 * Default value is 3, and also it's the minimun. If @p num is less
20633 * than 3, it will be set to 3.
20635 * Also, it can be set on theme, using data item @c display_item_num
20636 * on group "elm/diskselector/item/X", where X is style set.
20639 * group { name: "elm/diskselector/item/X";
20641 * item: "display_item_num" "5";
20644 * @ingroup Diskselector
20646 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
20649 * Set bouncing behaviour when the scrolled content reaches an edge.
20651 * Tell the internal scroller object whether it should bounce or not
20652 * when it reaches the respective edges for each axis.
20654 * @param obj The diskselector object.
20655 * @param h_bounce Whether to bounce or not in the horizontal axis.
20656 * @param v_bounce Whether to bounce or not in the vertical axis.
20658 * @see elm_scroller_bounce_set()
20660 * @ingroup Diskselector
20662 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20665 * Get the bouncing behaviour of the internal scroller.
20667 * Get whether the internal scroller should bounce when the edge of each
20668 * axis is reached scrolling.
20670 * @param obj The diskselector object.
20671 * @param h_bounce Pointer where to store the bounce state of the horizontal
20673 * @param v_bounce Pointer where to store the bounce state of the vertical
20676 * @see elm_scroller_bounce_get()
20677 * @see elm_diskselector_bounce_set()
20679 * @ingroup Diskselector
20681 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20684 * Get the scrollbar policy.
20686 * @see elm_diskselector_scroller_policy_get() for details.
20688 * @param obj The diskselector object.
20689 * @param policy_h Pointer where to store horizontal scrollbar policy.
20690 * @param policy_v Pointer where to store vertical scrollbar policy.
20692 * @ingroup Diskselector
20694 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);
20697 * Set the scrollbar policy.
20699 * @param obj The diskselector object.
20700 * @param policy_h Horizontal scrollbar policy.
20701 * @param policy_v Vertical scrollbar policy.
20703 * This sets the scrollbar visibility policy for the given scroller.
20704 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
20705 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
20706 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
20707 * This applies respectively for the horizontal and vertical scrollbars.
20709 * The both are disabled by default, i.e., are set to
20710 * #ELM_SCROLLER_POLICY_OFF.
20712 * @ingroup Diskselector
20714 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20717 * Remove all diskselector's items.
20719 * @param obj The diskselector object.
20721 * @see elm_diskselector_item_del()
20722 * @see elm_diskselector_item_append()
20724 * @ingroup Diskselector
20726 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20729 * Get a list of all the diskselector items.
20731 * @param obj The diskselector object.
20732 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
20733 * or @c NULL on failure.
20735 * @see elm_diskselector_item_append()
20736 * @see elm_diskselector_item_del()
20737 * @see elm_diskselector_clear()
20739 * @ingroup Diskselector
20741 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20744 * Appends a new item to the diskselector object.
20746 * @param obj The diskselector object.
20747 * @param label The label of the diskselector item.
20748 * @param icon The icon object to use at left side of the item. An
20749 * icon can be any Evas object, but usually it is an icon created
20750 * with elm_icon_add().
20751 * @param func The function to call when the item is selected.
20752 * @param data The data to associate with the item for related callbacks.
20754 * @return The created item or @c NULL upon failure.
20756 * A new item will be created and appended to the diskselector, i.e., will
20757 * be set as last item. Also, if there is no selected item, it will
20758 * be selected. This will always happens for the first appended item.
20760 * If no icon is set, label will be centered on item position, otherwise
20761 * the icon will be placed at left of the label, that will be shifted
20764 * Items created with this method can be deleted with
20765 * elm_diskselector_item_del().
20767 * Associated @p data can be properly freed when item is deleted if a
20768 * callback function is set with elm_diskselector_item_del_cb_set().
20770 * If a function is passed as argument, it will be called everytime this item
20771 * is selected, i.e., the user stops the diskselector with this
20772 * item on center position. If such function isn't needed, just passing
20773 * @c NULL as @p func is enough. The same should be done for @p data.
20775 * Simple example (with no function callback or data associated):
20777 * disk = elm_diskselector_add(win);
20778 * ic = elm_icon_add(win);
20779 * elm_icon_file_set(ic, "path/to/image", NULL);
20780 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
20781 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
20784 * @see elm_diskselector_item_del()
20785 * @see elm_diskselector_item_del_cb_set()
20786 * @see elm_diskselector_clear()
20787 * @see elm_icon_add()
20789 * @ingroup Diskselector
20791 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);
20795 * Delete them item from the diskselector.
20797 * @param it The item of diskselector to be deleted.
20799 * If deleting all diskselector items is required, elm_diskselector_clear()
20800 * should be used instead of getting items list and deleting each one.
20802 * @see elm_diskselector_clear()
20803 * @see elm_diskselector_item_append()
20804 * @see elm_diskselector_item_del_cb_set()
20806 * @ingroup Diskselector
20808 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
20811 * Set the function called when a diskselector item is freed.
20813 * @param it The item to set the callback on
20814 * @param func The function called
20816 * If there is a @p func, then it will be called prior item's memory release.
20817 * That will be called with the following arguments:
20819 * @li item's Evas object;
20822 * This way, a data associated to a diskselector item could be properly
20825 * @ingroup Diskselector
20827 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20830 * Get the data associated to the item.
20832 * @param it The diskselector item
20833 * @return The data associated to @p it
20835 * The return value is a pointer to data associated to @item when it was
20836 * created, with function elm_diskselector_item_append(). If no data
20837 * was passed as argument, it will return @c NULL.
20839 * @see elm_diskselector_item_append()
20841 * @ingroup Diskselector
20843 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
20846 * Set the icon associated to the item.
20848 * @param it The diskselector item
20849 * @param icon The icon object to associate with @p it
20851 * The icon object to use at left side of the item. An
20852 * icon can be any Evas object, but usually it is an icon created
20853 * with elm_icon_add().
20855 * Once the icon object is set, a previously set one will be deleted.
20856 * @warning Setting the same icon for two items will cause the icon to
20857 * dissapear from the first item.
20859 * If an icon was passed as argument on item creation, with function
20860 * elm_diskselector_item_append(), it will be already
20861 * associated to the item.
20863 * @see elm_diskselector_item_append()
20864 * @see elm_diskselector_item_icon_get()
20866 * @ingroup Diskselector
20868 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
20871 * Get the icon associated to the item.
20873 * @param it The diskselector item
20874 * @return The icon associated to @p it
20876 * The return value is a pointer to the icon associated to @item when it was
20877 * created, with function elm_diskselector_item_append(), or later
20878 * with function elm_diskselector_item_icon_set. If no icon
20879 * was passed as argument, it will return @c NULL.
20881 * @see elm_diskselector_item_append()
20882 * @see elm_diskselector_item_icon_set()
20884 * @ingroup Diskselector
20886 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
20889 * Set the label of item.
20891 * @param it The item of diskselector.
20892 * @param label The label of item.
20894 * The label to be displayed by the item.
20896 * If no icon is set, label will be centered on item position, otherwise
20897 * the icon will be placed at left of the label, that will be shifted
20900 * An item with label "January" would be displayed on side position as
20901 * "Jan" if max length is set to 3 with function
20902 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
20905 * When this @item is selected, the entire label will be displayed,
20906 * except for width restrictions.
20907 * In this case label will be cropped and "..." will be concatenated,
20908 * but only for display purposes. It will keep the entire string, so
20909 * if diskselector is resized the remaining characters will be displayed.
20911 * If a label was passed as argument on item creation, with function
20912 * elm_diskselector_item_append(), it will be already
20913 * displayed by the item.
20915 * @see elm_diskselector_side_label_lenght_set()
20916 * @see elm_diskselector_item_label_get()
20917 * @see elm_diskselector_item_append()
20919 * @ingroup Diskselector
20921 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
20924 * Get the label of item.
20926 * @param it The item of diskselector.
20927 * @return The label of item.
20929 * The return value is a pointer to the label associated to @item when it was
20930 * created, with function elm_diskselector_item_append(), or later
20931 * with function elm_diskselector_item_label_set. If no label
20932 * was passed as argument, it will return @c NULL.
20934 * @see elm_diskselector_item_label_set() for more details.
20935 * @see elm_diskselector_item_append()
20937 * @ingroup Diskselector
20939 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
20942 * Get the selected item.
20944 * @param obj The diskselector object.
20945 * @return The selected diskselector item.
20947 * The selected item can be unselected with function
20948 * elm_diskselector_item_selected_set(), and the first item of
20949 * diskselector will be selected.
20951 * The selected item always will be centered on diskselector, with
20952 * full label displayed, i.e., max lenght set to side labels won't
20953 * apply on the selected item. More details on
20954 * elm_diskselector_side_label_length_set().
20956 * @ingroup Diskselector
20958 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20961 * Set the selected state of an item.
20963 * @param it The diskselector item
20964 * @param selected The selected state
20966 * This sets the selected state of the given item @p it.
20967 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
20969 * If a new item is selected the previosly selected will be unselected.
20970 * Previoulsy selected item can be get with function
20971 * elm_diskselector_selected_item_get().
20973 * If the item @p it is unselected, the first item of diskselector will
20976 * Selected items will be visible on center position of diskselector.
20977 * So if it was on another position before selected, or was invisible,
20978 * diskselector will animate items until the selected item reaches center
20981 * @see elm_diskselector_item_selected_get()
20982 * @see elm_diskselector_selected_item_get()
20984 * @ingroup Diskselector
20986 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20989 * Get whether the @p item is selected or not.
20991 * @param it The diskselector item.
20992 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
20993 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20995 * @see elm_diskselector_selected_item_set() for details.
20996 * @see elm_diskselector_item_selected_get()
20998 * @ingroup Diskselector
21000 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21003 * Get the first item of the diskselector.
21005 * @param obj The diskselector object.
21006 * @return The first item, or @c NULL if none.
21008 * The list of items follows append order. So it will return the first
21009 * item appended to the widget that wasn't deleted.
21011 * @see elm_diskselector_item_append()
21012 * @see elm_diskselector_items_get()
21014 * @ingroup Diskselector
21016 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21019 * Get the last item of the diskselector.
21021 * @param obj The diskselector object.
21022 * @return The last item, or @c NULL if none.
21024 * The list of items follows append order. So it will return last first
21025 * item appended to the widget that wasn't deleted.
21027 * @see elm_diskselector_item_append()
21028 * @see elm_diskselector_items_get()
21030 * @ingroup Diskselector
21032 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21035 * Get the item before @p item in diskselector.
21037 * @param it The diskselector item.
21038 * @return The item before @p item, or @c NULL if none or on failure.
21040 * The list of items follows append order. So it will return item appended
21041 * just before @item and that wasn't deleted.
21043 * If it is the first item, @c NULL will be returned.
21044 * First item can be get by elm_diskselector_first_item_get().
21046 * @see elm_diskselector_item_append()
21047 * @see elm_diskselector_items_get()
21049 * @ingroup Diskselector
21051 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21054 * Get the item after @p item in diskselector.
21056 * @param it The diskselector item.
21057 * @return The item after @p item, or @c NULL if none or on failure.
21059 * The list of items follows append order. So it will return item appended
21060 * just after @item and that wasn't deleted.
21062 * If it is the last item, @c NULL will be returned.
21063 * Last item can be get by elm_diskselector_last_item_get().
21065 * @see elm_diskselector_item_append()
21066 * @see elm_diskselector_items_get()
21068 * @ingroup Diskselector
21070 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21073 * Set the text to be shown in the diskselector item.
21075 * @param item Target item
21076 * @param text The text to set in the content
21078 * Setup the text as tooltip to object. The item can have only one tooltip,
21079 * so any previous tooltip data is removed.
21081 * @see elm_object_tooltip_text_set() for more details.
21083 * @ingroup Diskselector
21085 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
21088 * Set the content to be shown in the tooltip item.
21090 * Setup the tooltip to item. The item can have only one tooltip,
21091 * so any previous tooltip data is removed. @p func(with @p data) will
21092 * be called every time that need show the tooltip and it should
21093 * return a valid Evas_Object. This object is then managed fully by
21094 * tooltip system and is deleted when the tooltip is gone.
21096 * @param item the diskselector item being attached a tooltip.
21097 * @param func the function used to create the tooltip contents.
21098 * @param data what to provide to @a func as callback data/context.
21099 * @param del_cb called when data is not needed anymore, either when
21100 * another callback replaces @func, the tooltip is unset with
21101 * elm_diskselector_item_tooltip_unset() or the owner @a item
21102 * dies. This callback receives as the first parameter the
21103 * given @a data, and @c event_info is the item.
21105 * @see elm_object_tooltip_content_cb_set() for more details.
21107 * @ingroup Diskselector
21109 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);
21112 * Unset tooltip from item.
21114 * @param item diskselector item to remove previously set tooltip.
21116 * Remove tooltip from item. The callback provided as del_cb to
21117 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
21118 * it is not used anymore.
21120 * @see elm_object_tooltip_unset() for more details.
21121 * @see elm_diskselector_item_tooltip_content_cb_set()
21123 * @ingroup Diskselector
21125 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21129 * Sets a different style for this item tooltip.
21131 * @note before you set a style you should define a tooltip with
21132 * elm_diskselector_item_tooltip_content_cb_set() or
21133 * elm_diskselector_item_tooltip_text_set()
21135 * @param item diskselector item with tooltip already set.
21136 * @param style the theme style to use (default, transparent, ...)
21138 * @see elm_object_tooltip_style_set() for more details.
21140 * @ingroup Diskselector
21142 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
21145 * Get the style for this item tooltip.
21147 * @param item diskselector item with tooltip already set.
21148 * @return style the theme style in use, defaults to "default". If the
21149 * object does not have a tooltip set, then NULL is returned.
21151 * @see elm_object_tooltip_style_get() for more details.
21152 * @see elm_diskselector_item_tooltip_style_set()
21154 * @ingroup Diskselector
21156 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21159 * Set the cursor to be shown when mouse is over the diskselector item
21161 * @param item Target item
21162 * @param cursor the cursor name to be used.
21164 * @see elm_object_cursor_set() for more details.
21166 * @ingroup Diskselector
21168 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
21171 * Get the cursor to be shown when mouse is over the diskselector item
21173 * @param item diskselector item with cursor already set.
21174 * @return the cursor name.
21176 * @see elm_object_cursor_get() for more details.
21177 * @see elm_diskselector_cursor_set()
21179 * @ingroup Diskselector
21181 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21185 * Unset the cursor to be shown when mouse is over the diskselector item
21187 * @param item Target item
21189 * @see elm_object_cursor_unset() for more details.
21190 * @see elm_diskselector_cursor_set()
21192 * @ingroup Diskselector
21194 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21197 * Sets a different style for this item cursor.
21199 * @note before you set a style you should define a cursor with
21200 * elm_diskselector_item_cursor_set()
21202 * @param item diskselector item with cursor already set.
21203 * @param style the theme style to use (default, transparent, ...)
21205 * @see elm_object_cursor_style_set() for more details.
21207 * @ingroup Diskselector
21209 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
21213 * Get the style for this item cursor.
21215 * @param item diskselector item with cursor already set.
21216 * @return style the theme style in use, defaults to "default". If the
21217 * object does not have a cursor set, then @c NULL is returned.
21219 * @see elm_object_cursor_style_get() for more details.
21220 * @see elm_diskselector_item_cursor_style_set()
21222 * @ingroup Diskselector
21224 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21228 * Set if the cursor set should be searched on the theme or should use
21229 * the provided by the engine, only.
21231 * @note before you set if should look on theme you should define a cursor
21232 * with elm_diskselector_item_cursor_set().
21233 * By default it will only look for cursors provided by the engine.
21235 * @param item widget item with cursor already set.
21236 * @param engine_only boolean to define if cursors set with
21237 * elm_diskselector_item_cursor_set() should be searched only
21238 * between cursors provided by the engine or searched on widget's
21241 * @see elm_object_cursor_engine_only_set() for more details.
21243 * @ingroup Diskselector
21245 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
21248 * Get the cursor engine only usage for this item cursor.
21250 * @param item widget item with cursor already set.
21251 * @return engine_only boolean to define it cursors should be looked only
21252 * between the provided by the engine or searched on widget's theme as well.
21253 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
21255 * @see elm_object_cursor_engine_only_get() for more details.
21256 * @see elm_diskselector_item_cursor_engine_only_set()
21258 * @ingroup Diskselector
21260 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21267 * @defgroup Colorselector Colorselector
21271 * @image html img/widget/colorselector/preview-00.png
21273 * @brief Widget for user to select a color.
21275 * Signals that you can add callbacks for are:
21276 * "changed" - When the color value changes(event_info is NULL).
21278 * See @ref tutorial_colorselector.
21281 * @brief Add a new colorselector to the parent
21283 * @param parent The parent object
21284 * @return The new object or NULL if it cannot be created
21286 * @ingroup Colorselector
21288 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21290 * Set a color for the colorselector
21292 * @param obj Colorselector object
21293 * @param r r-value of color
21294 * @param g g-value of color
21295 * @param b b-value of color
21296 * @param a a-value of color
21298 * @ingroup Colorselector
21300 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21302 * Get a color from the colorselector
21304 * @param obj Colorselector object
21305 * @param r integer pointer for r-value of color
21306 * @param g integer pointer for g-value of color
21307 * @param b integer pointer for b-value of color
21308 * @param a integer pointer for a-value of color
21310 * @ingroup Colorselector
21312 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21318 * @defgroup Ctxpopup
21320 * @image html img/widget/ctxpopup/preview-00.png
21321 * @image latex img/widget/ctxpopup/preview-00.eps
21323 * @brief Context popup widet.
21325 * A ctxpopup is a widget that, when shown, pops up a list of items.
21326 * It automatically chooses an area inside its parent object's view
21327 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
21328 * optimally fit into it. In the default theme, it will also point an
21329 * arrow to it's top left position at the time one shows it. Ctxpopup
21330 * items have a label and/or an icon. It is intended for a small
21331 * number of items (hence the use of list, not genlist).
21333 * @note Ctxpopup is a especialization of @ref Hover.
21335 * Signals that you can add callbacks for are:
21336 * "dismissed" - the ctxpopup was dismissed
21338 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
21341 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
21343 typedef enum _Elm_Ctxpopup_Direction
21345 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
21347 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
21348 the clicked area */
21349 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
21350 the clicked area */
21351 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
21353 } Elm_Ctxpopup_Direction;
21356 * @brief Add a new Ctxpopup object to the parent.
21358 * @param parent Parent object
21359 * @return New object or @c NULL, if it cannot be created
21361 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21363 * @brief Set the Ctxpopup's parent
21365 * @param obj The ctxpopup object
21366 * @param area The parent to use
21368 * Set the parent object.
21370 * @note elm_ctxpopup_add() will automatically call this function
21371 * with its @c parent argument.
21373 * @see elm_ctxpopup_add()
21374 * @see elm_hover_parent_set()
21376 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
21378 * @brief Get the Ctxpopup's parent
21380 * @param obj The ctxpopup object
21382 * @see elm_ctxpopup_hover_parent_set() for more information
21384 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21386 * @brief Clear all items in the given ctxpopup object.
21388 * @param obj Ctxpopup object
21390 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21392 * @brief Change the ctxpopup's orientation to horizontal or vertical.
21394 * @param obj Ctxpopup object
21395 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
21397 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21399 * @brief Get the value of current ctxpopup object's orientation.
21401 * @param obj Ctxpopup object
21402 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
21404 * @see elm_ctxpopup_horizontal_set()
21406 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21408 * @brief Add a new item to a ctxpopup object.
21410 * @param obj Ctxpopup object
21411 * @param icon Icon to be set on new item
21412 * @param label The Label of the new item
21413 * @param func Convenience function called when item selected
21414 * @param data Data passed to @p func
21415 * @return A handle to the item added or @c NULL, on errors
21417 * @warning Ctxpopup can't hold both an item list and a content at the same
21418 * time. When an item is added, any previous content will be removed.
21420 * @see elm_ctxpopup_content_set()
21422 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);
21424 * @brief Delete the given item in a ctxpopup object.
21426 * @param item Ctxpopup item to be deleted
21428 * @see elm_ctxpopup_item_append()
21430 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
21432 * @brief Set the ctxpopup item's state as disabled or enabled.
21434 * @param item Ctxpopup item to be enabled/disabled
21435 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
21437 * When disabled the item is greyed out to indicate it's state.
21439 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21441 * @brief Get the ctxpopup item's disabled/enabled state.
21443 * @param item Ctxpopup item to be enabled/disabled
21444 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
21446 * @see elm_ctxpopup_item_disabled_set()
21448 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
21450 * @brief Get the icon object for the given ctxpopup item.
21452 * @param item Ctxpopup item
21453 * @return icon object or @c NULL, if the item does not have icon or an error
21456 * @see elm_ctxpopup_item_append()
21457 * @see elm_ctxpopup_item_icon_set()
21459 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
21461 * @brief Sets the side icon associated with the ctxpopup item
21463 * @param item Ctxpopup item
21464 * @param icon Icon object to be set
21466 * Once the icon object is set, a previously set one will be deleted.
21467 * @warning Setting the same icon for two items will cause the icon to
21468 * dissapear from the first item.
21470 * @see elm_ctxpopup_item_append()
21472 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
21474 * @brief Get the label for the given ctxpopup item.
21476 * @param item Ctxpopup item
21477 * @return label string or @c NULL, if the item does not have label or an
21480 * @see elm_ctxpopup_item_append()
21481 * @see elm_ctxpopup_item_label_set()
21483 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
21485 * @brief (Re)set the label on the given ctxpopup item.
21487 * @param item Ctxpopup item
21488 * @param label String to set as label
21490 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
21492 * @brief Set an elm widget as the content of the ctxpopup.
21494 * @param obj Ctxpopup object
21495 * @param content Content to be swallowed
21497 * If the content object is already set, a previous one will bedeleted. If
21498 * you want to keep that old content object, use the
21499 * elm_ctxpopup_content_unset() function.
21501 * @deprecated use elm_object_content_set()
21503 * @warning Ctxpopup can't hold both a item list and a content at the same
21504 * time. When a content is set, any previous items will be removed.
21506 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
21508 * @brief Unset the ctxpopup content
21510 * @param obj Ctxpopup object
21511 * @return The content that was being used
21513 * Unparent and return the content object which was set for this widget.
21515 * @deprecated use elm_object_content_unset()
21517 * @see elm_ctxpopup_content_set()
21519 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21521 * @brief Set the direction priority of a ctxpopup.
21523 * @param obj Ctxpopup object
21524 * @param first 1st priority of direction
21525 * @param second 2nd priority of direction
21526 * @param third 3th priority of direction
21527 * @param fourth 4th priority of direction
21529 * This functions gives a chance to user to set the priority of ctxpopup
21530 * showing direction. This doesn't guarantee the ctxpopup will appear in the
21531 * requested direction.
21533 * @see Elm_Ctxpopup_Direction
21535 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);
21537 * @brief Get the direction priority of a ctxpopup.
21539 * @param obj Ctxpopup object
21540 * @param first 1st priority of direction to be returned
21541 * @param second 2nd priority of direction to be returned
21542 * @param third 3th priority of direction to be returned
21543 * @param fourth 4th priority of direction to be returned
21545 * @see elm_ctxpopup_direction_priority_set() for more information.
21547 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);
21555 * @defgroup Transit Transit
21556 * @ingroup Elementary
21558 * Transit is designed to apply various animated transition effects to @c
21559 * Evas_Object, such like translation, rotation, etc. For using these
21560 * effects, create an @ref Elm_Transit and add the desired transition effects.
21562 * Once the effects are added into transit, they will be automatically
21563 * managed (their callback will be called until the duration is ended, and
21564 * they will be deleted on completion).
21568 * Elm_Transit *trans = elm_transit_add();
21569 * elm_transit_object_add(trans, obj);
21570 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
21571 * elm_transit_duration_set(transit, 1);
21572 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
21573 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
21574 * elm_transit_repeat_times_set(transit, 3);
21577 * Some transition effects are used to change the properties of objects. They
21579 * @li @ref elm_transit_effect_translation_add
21580 * @li @ref elm_transit_effect_color_add
21581 * @li @ref elm_transit_effect_rotation_add
21582 * @li @ref elm_transit_effect_wipe_add
21583 * @li @ref elm_transit_effect_zoom_add
21584 * @li @ref elm_transit_effect_resizing_add
21586 * Other transition effects are used to make one object disappear and another
21587 * object appear on its old place. These effects are:
21589 * @li @ref elm_transit_effect_flip_add
21590 * @li @ref elm_transit_effect_resizable_flip_add
21591 * @li @ref elm_transit_effect_fade_add
21592 * @li @ref elm_transit_effect_blend_add
21594 * It's also possible to make a transition chain with @ref
21595 * elm_transit_chain_transit_add.
21597 * @warning We strongly recommend to use elm_transit just when edje can not do
21598 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
21599 * animations can be manipulated inside the theme.
21601 * List of examples:
21602 * @li @ref transit_example_01_explained
21603 * @li @ref transit_example_02_explained
21604 * @li @ref transit_example_03_c
21605 * @li @ref transit_example_04_c
21611 * @enum Elm_Transit_Tween_Mode
21613 * The type of acceleration used in the transition.
21617 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
21618 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
21619 over time, then decrease again
21621 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
21623 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
21625 } Elm_Transit_Tween_Mode;
21628 * @enum Elm_Transit_Effect_Flip_Axis
21630 * The axis where flip effect should be applied.
21634 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
21635 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
21636 } Elm_Transit_Effect_Flip_Axis;
21638 * @enum Elm_Transit_Effect_Wipe_Dir
21640 * The direction where the wipe effect should occur.
21644 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
21645 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
21646 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
21647 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
21648 } Elm_Transit_Effect_Wipe_Dir;
21649 /** @enum Elm_Transit_Effect_Wipe_Type
21651 * Whether the wipe effect should show or hide the object.
21655 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
21657 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
21659 } Elm_Transit_Effect_Wipe_Type;
21662 * @typedef Elm_Transit
21664 * The Transit created with elm_transit_add(). This type has the information
21665 * about the objects which the transition will be applied, and the
21666 * transition effects that will be used. It also contains info about
21667 * duration, number of repetitions, auto-reverse, etc.
21669 typedef struct _Elm_Transit Elm_Transit;
21670 typedef void Elm_Transit_Effect;
21672 * @typedef Elm_Transit_Effect_Transition_Cb
21674 * Transition callback called for this effect on each transition iteration.
21676 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
21678 * Elm_Transit_Effect_End_Cb
21680 * Transition callback called for this effect when the transition is over.
21682 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
21685 * Elm_Transit_Del_Cb
21687 * A callback called when the transit is deleted.
21689 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
21694 * @note Is not necessary to delete the transit object, it will be deleted at
21695 * the end of its operation.
21696 * @note The transit will start playing when the program enter in the main loop, is not
21697 * necessary to give a start to the transit.
21699 * @return The transit object.
21703 EAPI Elm_Transit *elm_transit_add(void);
21706 * Stops the animation and delete the @p transit object.
21708 * Call this function if you wants to stop the animation before the duration
21709 * time. Make sure the @p transit object is still alive with
21710 * elm_transit_del_cb_set() function.
21711 * All added effects will be deleted, calling its repective data_free_cb
21712 * functions. The function setted by elm_transit_del_cb_set() will be called.
21714 * @see elm_transit_del_cb_set()
21716 * @param transit The transit object to be deleted.
21719 * @warning Just call this function if you are sure the transit is alive.
21721 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
21724 * Add a new effect to the transit.
21726 * @note The cb function and the data are the key to the effect. If you try to
21727 * add an already added effect, nothing is done.
21728 * @note After the first addition of an effect in @p transit, if its
21729 * effect list become empty again, the @p transit will be killed by
21730 * elm_transit_del(transit) function.
21734 * Elm_Transit *transit = elm_transit_add();
21735 * elm_transit_effect_add(transit,
21736 * elm_transit_effect_blend_op,
21737 * elm_transit_effect_blend_context_new(),
21738 * elm_transit_effect_blend_context_free);
21741 * @param transit The transit object.
21742 * @param transition_cb The operation function. It is called when the
21743 * animation begins, it is the function that actually performs the animation.
21744 * It is called with the @p data, @p transit and the time progression of the
21745 * animation (a double value between 0.0 and 1.0).
21746 * @param effect The context data of the effect.
21747 * @param end_cb The function to free the context data, it will be called
21748 * at the end of the effect, it must finalize the animation and free the
21752 * @warning The transit free the context data at the and of the transition with
21753 * the data_free_cb function, do not use the context data in another transit.
21755 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);
21758 * Delete an added effect.
21760 * This function will remove the effect from the @p transit, calling the
21761 * data_free_cb to free the @p data.
21763 * @see elm_transit_effect_add()
21765 * @note If the effect is not found, nothing is done.
21766 * @note If the effect list become empty, this function will call
21767 * elm_transit_del(transit), that is, it will kill the @p transit.
21769 * @param transit The transit object.
21770 * @param transition_cb The operation function.
21771 * @param effect The context data of the effect.
21775 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);
21778 * Add new object to apply the effects.
21780 * @note After the first addition of an object in @p transit, if its
21781 * object list become empty again, the @p transit will be killed by
21782 * elm_transit_del(transit) function.
21783 * @note If the @p obj belongs to another transit, the @p obj will be
21784 * removed from it and it will only belong to the @p transit. If the old
21785 * transit stays without objects, it will die.
21786 * @note When you add an object into the @p transit, its state from
21787 * evas_object_pass_events_get(obj) is saved, and it is applied when the
21788 * transit ends, if you change this state whith evas_object_pass_events_set()
21789 * after add the object, this state will change again when @p transit stops to
21792 * @param transit The transit object.
21793 * @param obj Object to be animated.
21796 * @warning It is not allowed to add a new object after transit begins to go.
21798 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
21801 * Removes an added object from the transit.
21803 * @note If the @p obj is not in the @p transit, nothing is done.
21804 * @note If the list become empty, this function will call
21805 * elm_transit_del(transit), that is, it will kill the @p transit.
21807 * @param transit The transit object.
21808 * @param obj Object to be removed from @p transit.
21811 * @warning It is not allowed to remove objects after transit begins to go.
21813 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
21816 * Get the objects of the transit.
21818 * @param transit The transit object.
21819 * @return a Eina_List with the objects from the transit.
21823 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
21826 * Enable/disable keeping up the objects states.
21827 * If it is not kept, the objects states will be reset when transition ends.
21829 * @note @p transit can not be NULL.
21830 * @note One state includes geometry, color, map data.
21832 * @param transit The transit object.
21833 * @param state_keep Keeping or Non Keeping.
21837 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
21840 * Get a value whether the objects states will be reset or not.
21842 * @note @p transit can not be NULL
21844 * @see elm_transit_objects_final_state_keep_set()
21846 * @param transit The transit object.
21847 * @return EINA_TRUE means the states of the objects will be reset.
21848 * If @p transit is NULL, EINA_FALSE is returned
21852 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
21855 * Set the event enabled when transit is operating.
21857 * If @p enabled is EINA_TRUE, the objects of the transit will receives
21858 * events from mouse and keyboard during the animation.
21859 * @note When you add an object with elm_transit_object_add(), its state from
21860 * evas_object_pass_events_get(obj) is saved, and it is applied when the
21861 * transit ends, if you change this state with evas_object_pass_events_set()
21862 * after adding the object, this state will change again when @p transit stops
21865 * @param transit The transit object.
21866 * @param enabled Events are received when enabled is @c EINA_TRUE, and
21867 * ignored otherwise.
21871 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21874 * Get the value of event enabled status.
21876 * @see elm_transit_event_enabled_set()
21878 * @param transit The Transit object
21879 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
21880 * EINA_FALSE is returned
21884 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
21887 * Set the user-callback function when the transit is deleted.
21889 * @note Using this function twice will overwrite the first function setted.
21890 * @note the @p transit object will be deleted after call @p cb function.
21892 * @param transit The transit object.
21893 * @param cb Callback function pointer. This function will be called before
21894 * the deletion of the transit.
21895 * @param data Callback funtion user data. It is the @p op parameter.
21899 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
21902 * Set reverse effect automatically.
21904 * If auto reverse is setted, after running the effects with the progress
21905 * parameter from 0 to 1, it will call the effecs again with the progress
21906 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
21907 * where the duration was setted with the function elm_transit_add and
21908 * the repeat with the function elm_transit_repeat_times_set().
21910 * @param transit The transit object.
21911 * @param reverse EINA_TRUE means the auto_reverse is on.
21915 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21918 * Get if the auto reverse is on.
21920 * @see elm_transit_auto_reverse_set()
21922 * @param transit The transit object.
21923 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
21924 * EINA_FALSE is returned
21928 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
21931 * Set the transit repeat count. Effect will be repeated by repeat count.
21933 * This function sets the number of repetition the transit will run after
21934 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
21935 * If the @p repeat is a negative number, it will repeat infinite times.
21937 * @note If this function is called during the transit execution, the transit
21938 * will run @p repeat times, ignoring the times it already performed.
21940 * @param transit The transit object
21941 * @param repeat Repeat count
21945 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
21948 * Get the transit repeat count.
21950 * @see elm_transit_repeat_times_set()
21952 * @param transit The Transit object.
21953 * @return The repeat count. If @p transit is NULL
21958 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
21961 * Set the transit animation acceleration type.
21963 * This function sets the tween mode of the transit that can be:
21964 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
21965 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
21966 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
21967 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
21969 * @param transit The transit object.
21970 * @param tween_mode The tween type.
21974 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
21977 * Get the transit animation acceleration type.
21979 * @note @p transit can not be NULL
21981 * @param transit The transit object.
21982 * @return The tween type. If @p transit is NULL
21983 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
21987 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
21990 * Set the transit animation time
21992 * @note @p transit can not be NULL
21994 * @param transit The transit object.
21995 * @param duration The animation time.
21999 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
22002 * Get the transit animation time
22004 * @note @p transit can not be NULL
22006 * @param transit The transit object.
22008 * @return The transit animation time.
22012 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
22015 * Starts the transition.
22016 * Once this API is called, the transit begins to measure the time.
22018 * @note @p transit can not be NULL
22020 * @param transit The transit object.
22024 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
22027 * Pause/Resume the transition.
22029 * If you call elm_transit_go again, the transit will be started from the
22030 * beginning, and will be unpaused.
22032 * @note @p transit can not be NULL
22034 * @param transit The transit object.
22035 * @param paused Whether the transition should be paused or not.
22039 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
22042 * Get the value of paused status.
22044 * @see elm_transit_paused_set()
22046 * @note @p transit can not be NULL
22048 * @param transit The transit object.
22049 * @return EINA_TRUE means transition is paused. If @p transit is NULL
22050 * EINA_FALSE is returned
22054 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
22057 * Get the time progression of the animation (a double value between 0.0 and 1.0).
22059 * The value returned is a fraction (current time / total time). It
22060 * represents the progression position relative to the total.
22062 * @note @p transit can not be NULL
22064 * @param transit The transit object.
22066 * @return The time progression value. If @p transit is NULL
22071 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
22074 * Makes the chain relationship between two transits.
22076 * @note @p transit can not be NULL. Transit would have multiple chain transits.
22077 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
22079 * @param transit The transit object.
22080 * @param chain_transit The chain transit object. This transit will be operated
22081 * after transit is done.
22083 * This function adds @p chain_transit transition to a chain after the @p
22084 * transit, and will be started as soon as @p transit ends. See @ref
22085 * transit_example_02_explained for a full example.
22089 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
22092 * Cut off the chain relationship between two transits.
22094 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
22095 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
22097 * @param transit The transit object.
22098 * @param chain_transit The chain transit object.
22100 * This function remove the @p chain_transit transition from the @p transit.
22104 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
22107 * Get the current chain transit list.
22109 * @note @p transit can not be NULL.
22111 * @param transit The transit object.
22112 * @return chain transit list.
22116 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
22119 * Add the Resizing Effect to Elm_Transit.
22121 * @note This API is one of the facades. It creates resizing effect context
22122 * and add it's required APIs to elm_transit_effect_add.
22124 * @see elm_transit_effect_add()
22126 * @param transit Transit object.
22127 * @param from_w Object width size when effect begins.
22128 * @param from_h Object height size when effect begins.
22129 * @param to_w Object width size when effect ends.
22130 * @param to_h Object height size when effect ends.
22131 * @return Resizing effect context data.
22135 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);
22138 * Add the Translation Effect to Elm_Transit.
22140 * @note This API is one of the facades. It creates translation effect context
22141 * and add it's required APIs to elm_transit_effect_add.
22143 * @see elm_transit_effect_add()
22145 * @param transit Transit object.
22146 * @param from_dx X Position variation when effect begins.
22147 * @param from_dy Y Position variation when effect begins.
22148 * @param to_dx X Position variation when effect ends.
22149 * @param to_dy Y Position variation when effect ends.
22150 * @return Translation effect context data.
22153 * @warning It is highly recommended just create a transit with this effect when
22154 * the window that the objects of the transit belongs has already been created.
22155 * This is because this effect needs the geometry information about the objects,
22156 * and if the window was not created yet, it can get a wrong information.
22158 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);
22161 * Add the Zoom Effect to Elm_Transit.
22163 * @note This API is one of the facades. It creates zoom effect context
22164 * and add it's required APIs to elm_transit_effect_add.
22166 * @see elm_transit_effect_add()
22168 * @param transit Transit object.
22169 * @param from_rate Scale rate when effect begins (1 is current rate).
22170 * @param to_rate Scale rate when effect ends.
22171 * @return Zoom effect context data.
22174 * @warning It is highly recommended just create a transit with this effect when
22175 * the window that the objects of the transit belongs has already been created.
22176 * This is because this effect needs the geometry information about the objects,
22177 * and if the window was not created yet, it can get a wrong information.
22179 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
22182 * Add the Flip Effect to Elm_Transit.
22184 * @note This API is one of the facades. It creates flip effect context
22185 * and add it's required APIs to elm_transit_effect_add.
22186 * @note This effect is applied to each pair of objects in the order they are listed
22187 * in the transit list of objects. The first object in the pair will be the
22188 * "front" object and the second will be the "back" object.
22190 * @see elm_transit_effect_add()
22192 * @param transit Transit object.
22193 * @param axis Flipping Axis(X or Y).
22194 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
22195 * @return Flip effect context data.
22198 * @warning It is highly recommended just create a transit with this effect when
22199 * the window that the objects of the transit belongs has already been created.
22200 * This is because this effect needs the geometry information about the objects,
22201 * and if the window was not created yet, it can get a wrong information.
22203 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
22206 * Add the Resizable Flip Effect to Elm_Transit.
22208 * @note This API is one of the facades. It creates resizable flip effect context
22209 * and add it's required APIs to elm_transit_effect_add.
22210 * @note This effect is applied to each pair of objects in the order they are listed
22211 * in the transit list of objects. The first object in the pair will be the
22212 * "front" object and the second will be the "back" object.
22214 * @see elm_transit_effect_add()
22216 * @param transit Transit object.
22217 * @param axis Flipping Axis(X or Y).
22218 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
22219 * @return Resizable flip effect context data.
22222 * @warning It is highly recommended just create a transit with this effect when
22223 * the window that the objects of the transit belongs has already been created.
22224 * This is because this effect needs the geometry information about the objects,
22225 * and if the window was not created yet, it can get a wrong information.
22227 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
22230 * Add the Wipe Effect to Elm_Transit.
22232 * @note This API is one of the facades. It creates wipe effect context
22233 * and add it's required APIs to elm_transit_effect_add.
22235 * @see elm_transit_effect_add()
22237 * @param transit Transit object.
22238 * @param type Wipe type. Hide or show.
22239 * @param dir Wipe Direction.
22240 * @return Wipe effect context data.
22243 * @warning It is highly recommended just create a transit with this effect when
22244 * the window that the objects of the transit belongs has already been created.
22245 * This is because this effect needs the geometry information about the objects,
22246 * and if the window was not created yet, it can get a wrong information.
22248 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
22251 * Add the Color Effect to Elm_Transit.
22253 * @note This API is one of the facades. It creates color effect context
22254 * and add it's required APIs to elm_transit_effect_add.
22256 * @see elm_transit_effect_add()
22258 * @param transit Transit object.
22259 * @param from_r RGB R when effect begins.
22260 * @param from_g RGB G when effect begins.
22261 * @param from_b RGB B when effect begins.
22262 * @param from_a RGB A when effect begins.
22263 * @param to_r RGB R when effect ends.
22264 * @param to_g RGB G when effect ends.
22265 * @param to_b RGB B when effect ends.
22266 * @param to_a RGB A when effect ends.
22267 * @return Color effect context data.
22271 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);
22274 * Add the Fade Effect to Elm_Transit.
22276 * @note This API is one of the facades. It creates fade effect context
22277 * and add it's required APIs to elm_transit_effect_add.
22278 * @note This effect is applied to each pair of objects in the order they are listed
22279 * in the transit list of objects. The first object in the pair will be the
22280 * "before" object and the second will be the "after" object.
22282 * @see elm_transit_effect_add()
22284 * @param transit Transit object.
22285 * @return Fade effect context data.
22288 * @warning It is highly recommended just create a transit with this effect when
22289 * the window that the objects of the transit belongs has already been created.
22290 * This is because this effect needs the color information about the objects,
22291 * and if the window was not created yet, it can get a wrong information.
22293 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
22296 * Add the Blend Effect to Elm_Transit.
22298 * @note This API is one of the facades. It creates blend effect context
22299 * and add it's required APIs to elm_transit_effect_add.
22300 * @note This effect is applied to each pair of objects in the order they are listed
22301 * in the transit list of objects. The first object in the pair will be the
22302 * "before" object and the second will be the "after" object.
22304 * @see elm_transit_effect_add()
22306 * @param transit Transit object.
22307 * @return Blend effect context data.
22310 * @warning It is highly recommended just create a transit with this effect when
22311 * the window that the objects of the transit belongs has already been created.
22312 * This is because this effect needs the color information about the objects,
22313 * and if the window was not created yet, it can get a wrong information.
22315 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
22318 * Add the Rotation Effect to Elm_Transit.
22320 * @note This API is one of the facades. It creates rotation effect context
22321 * and add it's required APIs to elm_transit_effect_add.
22323 * @see elm_transit_effect_add()
22325 * @param transit Transit object.
22326 * @param from_degree Degree when effect begins.
22327 * @param to_degree Degree when effect is ends.
22328 * @return Rotation effect context data.
22331 * @warning It is highly recommended just create a transit with this effect when
22332 * the window that the objects of the transit belongs has already been created.
22333 * This is because this effect needs the geometry information about the objects,
22334 * and if the window was not created yet, it can get a wrong information.
22336 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
22339 * Add the ImageAnimation Effect to Elm_Transit.
22341 * @note This API is one of the facades. It creates image animation effect context
22342 * and add it's required APIs to elm_transit_effect_add.
22343 * The @p images parameter is a list images paths. This list and
22344 * its contents will be deleted at the end of the effect by
22345 * elm_transit_effect_image_animation_context_free() function.
22349 * char buf[PATH_MAX];
22350 * Eina_List *images = NULL;
22351 * Elm_Transit *transi = elm_transit_add();
22353 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
22354 * images = eina_list_append(images, eina_stringshare_add(buf));
22356 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
22357 * images = eina_list_append(images, eina_stringshare_add(buf));
22358 * elm_transit_effect_image_animation_add(transi, images);
22362 * @see elm_transit_effect_add()
22364 * @param transit Transit object.
22365 * @param images Eina_List of images file paths. This list and
22366 * its contents will be deleted at the end of the effect by
22367 * elm_transit_effect_image_animation_context_free() function.
22368 * @return Image Animation effect context data.
22372 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
22377 typedef struct _Elm_Store Elm_Store;
22378 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
22379 typedef struct _Elm_Store_Item Elm_Store_Item;
22380 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
22381 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
22382 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
22383 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
22384 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
22385 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
22386 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
22387 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
22389 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
22390 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
22391 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
22392 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
22396 ELM_STORE_ITEM_MAPPING_NONE = 0,
22397 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
22398 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
22399 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
22400 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
22401 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
22402 // can add more here as needed by common apps
22403 ELM_STORE_ITEM_MAPPING_LAST
22404 } Elm_Store_Item_Mapping_Type;
22406 struct _Elm_Store_Item_Mapping_Icon
22408 // FIXME: allow edje file icons
22410 Elm_Icon_Lookup_Order lookup_order;
22411 Eina_Bool standard_name : 1;
22412 Eina_Bool no_scale : 1;
22413 Eina_Bool smooth : 1;
22414 Eina_Bool scale_up : 1;
22415 Eina_Bool scale_down : 1;
22418 struct _Elm_Store_Item_Mapping_Empty
22423 struct _Elm_Store_Item_Mapping_Photo
22428 struct _Elm_Store_Item_Mapping_Custom
22430 Elm_Store_Item_Mapping_Cb func;
22433 struct _Elm_Store_Item_Mapping
22435 Elm_Store_Item_Mapping_Type type;
22440 Elm_Store_Item_Mapping_Empty empty;
22441 Elm_Store_Item_Mapping_Icon icon;
22442 Elm_Store_Item_Mapping_Photo photo;
22443 Elm_Store_Item_Mapping_Custom custom;
22444 // add more types here
22448 struct _Elm_Store_Item_Info
22450 Elm_Genlist_Item_Class *item_class;
22451 const Elm_Store_Item_Mapping *mapping;
22456 struct _Elm_Store_Item_Info_Filesystem
22458 Elm_Store_Item_Info base;
22462 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
22463 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
22465 EAPI void elm_store_free(Elm_Store *st);
22467 EAPI Elm_Store *elm_store_filesystem_new(void);
22468 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
22469 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
22470 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
22472 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
22474 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
22475 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
22476 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
22477 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
22478 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
22479 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
22481 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
22482 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
22483 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
22484 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
22485 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
22486 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
22487 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
22490 * @defgroup SegmentControl SegmentControl
22491 * @ingroup Elementary
22493 * @image html img/widget/segment_control/preview-00.png
22494 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
22496 * @image html img/segment_control.png
22497 * @image latex img/segment_control.eps width=\textwidth
22499 * Segment control widget is a horizontal control made of multiple segment
22500 * items, each segment item functioning similar to discrete two state button.
22501 * A segment control groups the items together and provides compact
22502 * single button with multiple equal size segments.
22504 * Segment item size is determined by base widget
22505 * size and the number of items added.
22506 * Only one segment item can be at selected state. A segment item can display
22507 * combination of Text and any Evas_Object like Images or other widget.
22509 * Smart callbacks one can listen to:
22510 * - "changed" - When the user clicks on a segment item which is not
22511 * previously selected and get selected. The event_info parameter is the
22512 * segment item index.
22514 * Available styles for it:
22517 * Here is an example on its usage:
22518 * @li @ref segment_control_example
22522 * @addtogroup SegmentControl
22526 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
22529 * Add a new segment control widget to the given parent Elementary
22530 * (container) object.
22532 * @param parent The parent object.
22533 * @return a new segment control widget handle or @c NULL, on errors.
22535 * This function inserts a new segment control widget on the canvas.
22537 * @ingroup SegmentControl
22539 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22542 * Append a new item to the segment control object.
22544 * @param obj The segment control object.
22545 * @param icon The icon object to use for the left side of the item. An
22546 * icon can be any Evas object, but usually it is an icon created
22547 * with elm_icon_add().
22548 * @param label The label of the item.
22549 * Note that, NULL is different from empty string "".
22550 * @return The created item or @c NULL upon failure.
22552 * A new item will be created and appended to the segment control, i.e., will
22553 * be set as @b last item.
22555 * If it should be inserted at another position,
22556 * elm_segment_control_item_insert_at() should be used instead.
22558 * Items created with this function can be deleted with function
22559 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
22561 * @note @p label set to @c NULL is different from empty string "".
22563 * only has icon, it will be displayed bigger and centered. If it has
22564 * icon and label, even that an empty string, icon will be smaller and
22565 * positioned at left.
22569 * sc = elm_segment_control_add(win);
22570 * ic = elm_icon_add(win);
22571 * elm_icon_file_set(ic, "path/to/image", NULL);
22572 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22573 * elm_segment_control_item_add(sc, ic, "label");
22574 * evas_object_show(sc);
22577 * @see elm_segment_control_item_insert_at()
22578 * @see elm_segment_control_item_del()
22580 * @ingroup SegmentControl
22582 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
22585 * Insert a new item to the segment control object at specified position.
22587 * @param obj The segment control object.
22588 * @param icon The icon object to use for the left side of the item. An
22589 * icon can be any Evas object, but usually it is an icon created
22590 * with elm_icon_add().
22591 * @param label The label of the item.
22592 * @param index Item position. Value should be between 0 and items count.
22593 * @return The created item or @c NULL upon failure.
22595 * Index values must be between @c 0, when item will be prepended to
22596 * segment control, and items count, that can be get with
22597 * elm_segment_control_item_count_get(), case when item will be appended
22598 * to segment control, just like elm_segment_control_item_add().
22600 * Items created with this function can be deleted with function
22601 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
22603 * @note @p label set to @c NULL is different from empty string "".
22605 * only has icon, it will be displayed bigger and centered. If it has
22606 * icon and label, even that an empty string, icon will be smaller and
22607 * positioned at left.
22609 * @see elm_segment_control_item_add()
22610 * @see elm_segment_control_count_get()
22611 * @see elm_segment_control_item_del()
22613 * @ingroup SegmentControl
22615 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);
22618 * Remove a segment control item from its parent, deleting it.
22620 * @param it The item to be removed.
22622 * Items can be added with elm_segment_control_item_add() or
22623 * elm_segment_control_item_insert_at().
22625 * @ingroup SegmentControl
22627 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
22630 * Remove a segment control item at given index from its parent,
22633 * @param obj The segment control object.
22634 * @param index The position of the segment control item to be deleted.
22636 * Items can be added with elm_segment_control_item_add() or
22637 * elm_segment_control_item_insert_at().
22639 * @ingroup SegmentControl
22641 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
22644 * Get the Segment items count from segment control.
22646 * @param obj The segment control object.
22647 * @return Segment items count.
22649 * It will just return the number of items added to segment control @p obj.
22651 * @ingroup SegmentControl
22653 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22656 * Get the item placed at specified index.
22658 * @param obj The segment control object.
22659 * @param index The index of the segment item.
22660 * @return The segment control item or @c NULL on failure.
22662 * Index is the position of an item in segment control widget. Its
22663 * range is from @c 0 to <tt> count - 1 </tt>.
22664 * Count is the number of items, that can be get with
22665 * elm_segment_control_item_count_get().
22667 * @ingroup SegmentControl
22669 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
22672 * Get the label of item.
22674 * @param obj The segment control object.
22675 * @param index The index of the segment item.
22676 * @return The label of the item at @p index.
22678 * The return value is a pointer to the label associated to the item when
22679 * it was created, with function elm_segment_control_item_add(), or later
22680 * with function elm_segment_control_item_label_set. If no label
22681 * was passed as argument, it will return @c NULL.
22683 * @see elm_segment_control_item_label_set() for more details.
22684 * @see elm_segment_control_item_add()
22686 * @ingroup SegmentControl
22688 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
22691 * Set the label of item.
22693 * @param it The item of segment control.
22694 * @param text The label of item.
22696 * The label to be displayed by the item.
22697 * Label will be at right of the icon (if set).
22699 * If a label was passed as argument on item creation, with function
22700 * elm_control_segment_item_add(), it will be already
22701 * displayed by the item.
22703 * @see elm_segment_control_item_label_get()
22704 * @see elm_segment_control_item_add()
22706 * @ingroup SegmentControl
22708 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
22711 * Get the icon associated to the item.
22713 * @param obj The segment control object.
22714 * @param index The index of the segment item.
22715 * @return The left side icon associated to the item at @p index.
22717 * The return value is a pointer to the icon associated to the item when
22718 * it was created, with function elm_segment_control_item_add(), or later
22719 * with function elm_segment_control_item_icon_set(). If no icon
22720 * was passed as argument, it will return @c NULL.
22722 * @see elm_segment_control_item_add()
22723 * @see elm_segment_control_item_icon_set()
22725 * @ingroup SegmentControl
22727 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
22730 * Set the icon associated to the item.
22732 * @param it The segment control item.
22733 * @param icon The icon object to associate with @p it.
22735 * The icon object to use at left side of the item. An
22736 * icon can be any Evas object, but usually it is an icon created
22737 * with elm_icon_add().
22739 * Once the icon object is set, a previously set one will be deleted.
22740 * @warning Setting the same icon for two items will cause the icon to
22741 * dissapear from the first item.
22743 * If an icon was passed as argument on item creation, with function
22744 * elm_segment_control_item_add(), it will be already
22745 * associated to the item.
22747 * @see elm_segment_control_item_add()
22748 * @see elm_segment_control_item_icon_get()
22750 * @ingroup SegmentControl
22752 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
22755 * Get the index of an item.
22757 * @param it The segment control item.
22758 * @return The position of item in segment control widget.
22760 * Index is the position of an item in segment control widget. Its
22761 * range is from @c 0 to <tt> count - 1 </tt>.
22762 * Count is the number of items, that can be get with
22763 * elm_segment_control_item_count_get().
22765 * @ingroup SegmentControl
22767 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
22770 * Get the base object of the item.
22772 * @param it The segment control item.
22773 * @return The base object associated with @p it.
22775 * Base object is the @c Evas_Object that represents that item.
22777 * @ingroup SegmentControl
22779 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
22782 * Get the selected item.
22784 * @param obj The segment control object.
22785 * @return The selected item or @c NULL if none of segment items is
22788 * The selected item can be unselected with function
22789 * elm_segment_control_item_selected_set().
22791 * The selected item always will be highlighted on segment control.
22793 * @ingroup SegmentControl
22795 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22798 * Set the selected state of an item.
22800 * @param it The segment control item
22801 * @param select The selected state
22803 * This sets the selected state of the given item @p it.
22804 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22806 * If a new item is selected the previosly selected will be unselected.
22807 * Previoulsy selected item can be get with function
22808 * elm_segment_control_item_selected_get().
22810 * The selected item always will be highlighted on segment control.
22812 * @see elm_segment_control_item_selected_get()
22814 * @ingroup SegmentControl
22816 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
22823 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
22824 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
22825 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
22826 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
22827 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
22828 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
22829 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
22830 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
22832 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
22833 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
22835 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
22836 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
22837 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
22838 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
22839 EAPI void elm_video_play(Evas_Object *video);
22840 EAPI void elm_video_pause(Evas_Object *video);
22841 EAPI void elm_video_stop(Evas_Object *video);
22842 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
22843 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
22844 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
22845 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
22846 EAPI double elm_video_audio_level_get(Evas_Object *video);
22847 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
22848 EAPI double elm_video_play_position_get(Evas_Object *video);
22849 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
22850 EAPI double elm_video_play_length_get(Evas_Object *video);
22851 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
22852 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
22853 EAPI const char *elm_video_title_get(Evas_Object *video);
22855 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
22856 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
22859 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
22863 ELM_NAVIFRAME_PREV_BUTTON,
22864 ELM_NAVIFRAME_NEXT_BUTTON
22865 } Elm_Naviframe_Button_Type;
22867 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22868 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);
22869 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
22870 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
22871 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22872 EAPI void elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
22873 EAPI Evas_Object *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
22874 EAPI void elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
22875 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
22876 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
22877 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
22878 EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22879 EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22880 EAPI void elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
22881 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
22882 EAPI void elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
22883 EAPI Evas_Object *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
22884 EAPI void elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
22885 EAPI const char *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
22886 EAPI void elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
22887 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);