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@
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @section organization Organization
27 One can divide Elemementary into three main groups:
28 @li @ref infralist - These are modules that deal with Elementary as a whole.
29 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
30 @li @ref containerslist - These are the containers in which the widgets will be
33 @section license License
35 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
36 all files in the source tree.
38 @section ack Acknowledgements
39 There is a lot that goes into making a widget set, and they don't happen out of
40 nothing. It's like trying to make everyone everywhere happy, regardless of age,
41 gender, race or nationality - and that is really tough. So thanks to people and
42 organisations behind this, as listed in the @ref authors page.
47 @author Carsten Haitzler <raster@@rasterman.com>
48 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
49 @author Cedric Bail <cedric.bail@@free.fr>
50 @author Vincent Torri <vtorri@@univ-evry.fr>
51 @author Daniel Kolesa <quaker66@@gmail.com>
52 @author Jaime Thomas <avi.thomas@@gmail.com>
53 @author Swisscom - http://www.swisscom.ch/
54 @author Christopher Michael <devilhorns@@comcast.net>
55 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
56 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
57 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
58 @author Brian Wang <brian.wang.0721@@gmail.com>
59 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
60 @author Samsung Electronics <tbd>
61 @author Samsung SAIT <tbd>
62 @author Brett Nash <nash@@nash.id.au>
63 @author Bruno Dilly <bdilly@@profusion.mobi>
64 @author Rafael Fonseca <rfonseca@@profusion.mobi>
65 @author Chuneon Park <hermet@@hermet.pe.kr>
66 @author Woohyun Jung <wh0705.jung@@samsung.com>
67 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
68 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
69 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
70 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
71 @author Gustavo Lima Chaves <glima@@profusion.mobi>
72 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
73 @author Tiago Falcão <tiago@@profusion.mobi>
74 @author Otavio Pontes <otavio@@profusion.mobi>
75 @author Viktor Kojouharov <vkojouharov@@gmail.com>
76 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
77 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
78 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
79 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
80 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
81 @author Jihoon Kim <jihoon48.kim@@samsung.com>
82 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
83 @author Tom Hacohen <tom@@stosb.com>
84 @author Aharon Hillel <a.hillel@@partner.samsung.com>
85 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
86 @author Shinwoo Kim <kimcinoo@@gmail.com>
87 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
88 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
90 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
91 contact with the developers and maintainers.
99 * @brief Elementary's API
104 @ELM_UNIX_DEF@ ELM_UNIX
105 @ELM_WIN32_DEF@ ELM_WIN32
106 @ELM_WINCE_DEF@ ELM_WINCE
107 @ELM_EDBUS_DEF@ ELM_EDBUS
108 @ELM_EFREET_DEF@ ELM_EFREET
109 @ELM_ETHUMB_DEF@ ELM_ETHUMB
110 @ELM_EMAP_DEF@ ELM_EMAP
111 @ELM_DEBUG_DEF@ ELM_DEBUG
112 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
113 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
115 /* Standard headers for standard system calls etc. */
120 #include <sys/types.h>
121 #include <sys/stat.h>
122 #include <sys/time.h>
123 #include <sys/param.h>
136 # ifdef ELM_LIBINTL_H
137 # include <libintl.h>
148 #if defined (ELM_WIN32) || defined (ELM_WINCE)
151 # define alloca _alloca
162 #include <Ecore_Evas.h>
163 #include <Ecore_File.h>
164 #include <Ecore_IMF.h>
165 #include <Ecore_Con.h>
174 # include <Efreet_Mime.h>
175 # include <Efreet_Trash.h>
179 # include <Ethumb_Client.h>
191 # ifdef ELEMENTARY_BUILD
193 # define EAPI __declspec(dllexport)
196 # endif /* ! DLL_EXPORT */
198 # define EAPI __declspec(dllimport)
199 # endif /* ! EFL_EVAS_BUILD */
203 # define EAPI __attribute__ ((visibility("default")))
210 #endif /* ! _WIN32 */
213 /* allow usage from c++ */
218 #define ELM_VERSION_MAJOR @VMAJ@
219 #define ELM_VERSION_MINOR @VMIN@
221 typedef struct _Elm_Version
229 EAPI extern Elm_Version *elm_version;
232 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
233 #define ELM_PI 3.14159265358979323846
236 * @defgroup General General
238 * @brief General Elementary API. Functions that don't relate to
239 * Elementary objects specifically.
241 * Here are documented functions which init/shutdown the library,
242 * that apply to generic Elementary objects, that deal with
243 * configuration, et cetera.
245 * @ref general_functions_example_page "This" example contemplates
246 * some of these functions.
250 * @addtogroup General
255 * Defines couple of standard Evas_Object layers to be used
256 * with evas_object_layer_set().
258 * @note whenever extending with new values, try to keep some padding
259 * to siblings so there is room for further extensions.
261 typedef enum _Elm_Object_Layer
263 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
264 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
265 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
266 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
267 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
268 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
271 /**************************************************************************/
272 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
275 * Emitted when any Elementary's policy value is changed.
277 EAPI extern int ELM_EVENT_POLICY_CHANGED;
280 * @typedef Elm_Event_Policy_Changed
282 * Data on the event when an Elementary policy has changed
284 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
287 * @struct _Elm_Event_Policy_Changed
289 * Data on the event when an Elementary policy has changed
291 struct _Elm_Event_Policy_Changed
293 unsigned int policy; /**< the policy identifier */
294 int new_value; /**< value the policy had before the change */
295 int old_value; /**< new value the policy got */
299 * Policy identifiers.
301 typedef enum _Elm_Policy
303 ELM_POLICY_QUIT, /**< under which circunstances the application
304 * should quit automatically. @see
308 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
311 typedef enum _Elm_Policy_Quit
313 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
315 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
317 * window is closed */
318 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
320 typedef enum _Elm_Focus_Direction
324 } Elm_Focus_Direction;
326 typedef enum _Elm_Text_Format
328 ELM_TEXT_FORMAT_PLAIN_UTF8,
329 ELM_TEXT_FORMAT_MARKUP_UTF8
333 * Line wrapping types.
335 typedef enum _Elm_Wrap_Type
337 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
338 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
339 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
340 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
345 * @typedef Elm_Object_Item
346 * An Elementary Object item handle.
349 typedef struct _Elm_Object_Item Elm_Object_Item;
353 * Called back when a widget's tooltip is activated and needs content.
354 * @param data user-data given to elm_object_tooltip_content_cb_set()
355 * @param obj owner widget.
356 * @param tooltip The tooltip object (affix content to this!)
358 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
361 * Called back when a widget's item tooltip is activated and needs content.
362 * @param data user-data given to elm_object_tooltip_content_cb_set()
363 * @param obj owner widget.
364 * @param tooltip The tooltip object (affix content to this!)
365 * @param item context dependent item. As an example, if tooltip was
366 * set on Elm_List_Item, then it is of this type.
368 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
370 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
372 #ifndef ELM_LIB_QUICKLAUNCH
373 #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 */
375 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
378 /**************************************************************************/
382 * Initialize Elementary
384 * @param[in] argc System's argument count value
385 * @param[in] argv System's pointer to array of argument strings
386 * @return The init counter value.
388 * This function initializes Elementary and increments a counter of
389 * the number of calls to it. It returs the new counter's value.
391 * @warning This call is exported only for use by the @c ELM_MAIN()
392 * macro. There is no need to use this if you use this macro (which
393 * is highly advisable). An elm_main() should contain the entry
394 * point code for your application, having the same prototype as
395 * elm_init(), and @b not being static (putting the @c EAPI symbol
396 * in front of its type declaration is advisable). The @c
397 * ELM_MAIN() call should be placed just after it.
400 * @dontinclude bg_example_01.c
404 * See the full @ref bg_example_01_c "example".
406 * @see elm_shutdown().
409 EAPI int elm_init(int argc, char **argv);
412 * Shut down Elementary
414 * @return The init counter value.
416 * This should be called at the end of your application, just
417 * before it ceases to do any more processing. This will clean up
418 * any permanent resources your application may have allocated via
419 * Elementary that would otherwise persist.
421 * @see elm_init() for an example
425 EAPI int elm_shutdown(void);
428 * Run Elementary's main loop
430 * This call should be issued just after all initialization is
431 * completed. This function will not return until elm_exit() is
432 * called. It will keep looping, running the main
433 * (event/processing) loop for Elementary.
435 * @see elm_init() for an example
439 EAPI void elm_run(void);
442 * Exit Elementary's main loop
444 * If this call is issued, it will flag the main loop to cease
445 * processing and return back to its parent function (usually your
446 * elm_main() function).
448 * @see elm_init() for an example. There, just after a request to
449 * close the window comes, the main loop will be left.
451 * @note By using the #ELM_POLICY_QUIT on your Elementary
452 * applications, you'll this function called automatically for you.
456 EAPI void elm_exit(void);
459 * Provide information in order to make Elementary determine the @b
460 * run time location of the software in question, so other data files
461 * such as images, sound files, executable utilities, libraries,
462 * modules and locale files can be found.
464 * @param mainfunc This is your application's main function name,
465 * whose binary's location is to be found. Providing @c NULL
466 * will make Elementary not to use it
467 * @param dom This will be used as the application's "domain", in the
468 * form of a prefix to any environment variables that may
469 * override prefix detection and the directory name, inside the
470 * standard share or data directories, where the software's
471 * data files will be looked for.
472 * @param checkfile This is an (optional) magic file's path to check
473 * for existence (and it must be located in the data directory,
474 * under the share directory provided above). Its presence will
475 * help determine the prefix found was correct. Pass @c NULL if
476 * the check is not to be done.
478 * This function allows one to re-locate the application somewhere
479 * else after compilation, if the developer wishes for easier
480 * distribution of pre-compiled binaries.
482 * The prefix system is designed to locate where the given software is
483 * installed (under a common path prefix) at run time and then report
484 * specific locations of this prefix and common directories inside
485 * this prefix like the binary, library, data and locale directories,
486 * through the @c elm_app_*_get() family of functions.
488 * Call elm_app_info_set() early on before you change working
489 * directory or anything about @c argv[0], so it gets accurate
492 * It will then try and trace back which file @p mainfunc comes from,
493 * if provided, to determine the application's prefix directory.
495 * The @p dom parameter provides a string prefix to prepend before
496 * environment variables, allowing a fallback to @b specific
497 * environment variables to locate the software. You would most
498 * probably provide a lowercase string there, because it will also
499 * serve as directory domain, explained next. For environment
500 * variables purposes, this string is made uppercase. For example if
501 * @c "myapp" is provided as the prefix, then the program would expect
502 * @c "MYAPP_PREFIX" as a master environment variable to specify the
503 * exact install prefix for the software, or more specific environment
504 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
505 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
506 * the user or scripts before launching. If not provided (@c NULL),
507 * environment variables will not be used to override compiled-in
508 * defaults or auto detections.
510 * The @p dom string also provides a subdirectory inside the system
511 * shared data directory for data files. For example, if the system
512 * directory is @c /usr/local/share, then this directory name is
513 * appended, creating @c /usr/local/share/myapp, if it @p was @c
514 * "myapp". It is expected the application installs data files in
517 * The @p checkfile is a file name or path of something inside the
518 * share or data directory to be used to test that the prefix
519 * detection worked. For example, your app will install a wallpaper
520 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
521 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
524 * @see elm_app_compile_bin_dir_set()
525 * @see elm_app_compile_lib_dir_set()
526 * @see elm_app_compile_data_dir_set()
527 * @see elm_app_compile_locale_set()
528 * @see elm_app_prefix_dir_get()
529 * @see elm_app_bin_dir_get()
530 * @see elm_app_lib_dir_get()
531 * @see elm_app_data_dir_get()
532 * @see elm_app_locale_dir_get()
534 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
537 * Provide information on the @b fallback application's binaries
538 * directory, on scenarios where they get overriden by
539 * elm_app_info_set().
541 * @param dir The path to the default binaries directory (compile time
544 * @note Elementary will as well use this path to determine actual
545 * names of binaries' directory paths, maybe changing it to be @c
546 * something/local/bin instead of @c something/bin, only, for
549 * @warning You should call this function @b before
550 * elm_app_info_set().
552 EAPI void elm_app_compile_bin_dir_set(const char *dir);
555 * Provide information on the @b fallback application's libraries
556 * directory, on scenarios where they get overriden by
557 * elm_app_info_set().
559 * @param dir The path to the default libraries directory (compile
562 * @note Elementary will as well use this path to determine actual
563 * names of libraries' directory paths, maybe changing it to be @c
564 * something/lib32 or @c something/lib64 instead of @c something/lib,
567 * @warning You should call this function @b before
568 * elm_app_info_set().
570 EAPI void elm_app_compile_lib_dir_set(const char *dir);
573 * Provide information on the @b fallback application's data
574 * directory, on scenarios where they get overriden by
575 * elm_app_info_set().
577 * @param dir The path to the default data directory (compile time
580 * @note Elementary will as well use this path to determine actual
581 * names of data directory paths, maybe changing it to be @c
582 * something/local/share instead of @c something/share, only, for
585 * @warning You should call this function @b before
586 * elm_app_info_set().
588 EAPI void elm_app_compile_data_dir_set(const char *dir);
591 * Provide information on the @b fallback application's locale
592 * directory, on scenarios where they get overriden by
593 * elm_app_info_set().
595 * @param dir The path to the default locale directory (compile time
598 * @warning You should call this function @b before
599 * elm_app_info_set().
601 EAPI void elm_app_compile_locale_set(const char *dir);
604 * Retrieve the application's run time prefix directory, as set by
605 * elm_app_info_set() and the way (environment) the application was
608 * @return The directory prefix the application is actually using
610 EAPI const char *elm_app_prefix_dir_get(void);
613 * Retrieve the application's run time binaries prefix directory, as
614 * set by elm_app_info_set() and the way (environment) the application
617 * @return The binaries directory prefix the application is actually
620 EAPI const char *elm_app_bin_dir_get(void);
623 * Retrieve the application's run time libraries prefix directory, as
624 * set by elm_app_info_set() and the way (environment) the application
627 * @return The libraries directory prefix the application is actually
630 EAPI const char *elm_app_lib_dir_get(void);
633 * Retrieve the application's run time data prefix directory, as
634 * set by elm_app_info_set() and the way (environment) the application
637 * @return The data directory prefix the application is actually
640 EAPI const char *elm_app_data_dir_get(void);
643 * Retrieve the application's run time locale prefix directory, as
644 * set by elm_app_info_set() and the way (environment) the application
647 * @return The locale directory prefix the application is actually
650 EAPI const char *elm_app_locale_dir_get(void);
652 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
653 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
654 EAPI int elm_quicklaunch_init(int argc, char **argv);
655 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
656 EAPI int elm_quicklaunch_sub_shutdown(void);
657 EAPI int elm_quicklaunch_shutdown(void);
658 EAPI void elm_quicklaunch_seed(void);
659 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
660 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
661 EAPI void elm_quicklaunch_cleanup(void);
662 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
663 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
665 EAPI Eina_Bool elm_need_efreet(void);
666 EAPI Eina_Bool elm_need_e_dbus(void);
667 EAPI Eina_Bool elm_need_ethumb(void);
670 * Set a new policy's value (for a given policy group/identifier).
672 * @param policy policy identifier, as in @ref Elm_Policy.
673 * @param value policy value, which depends on the identifier
675 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
677 * Elementary policies define applications' behavior,
678 * somehow. These behaviors are divided in policy groups (see
679 * #Elm_Policy enumeration). This call will emit the Ecore event
680 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
681 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
684 * @note Currently, we have only one policy identifier/group
685 * (#ELM_POLICY_QUIT), which has two possible values.
689 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
692 * Gets the policy value set for given policy identifier.
694 * @param policy policy identifier, as in #Elm_Policy.
695 * @return The currently set policy value, for that
696 * identifier. Will be @c 0 if @p policy passed is invalid.
700 EAPI int elm_policy_get(unsigned int policy);
703 * Set a label of an object
705 * @param obj The Elementary object
706 * @param part The text part name to set (NULL for the default label)
707 * @param label The new text of the label
709 * @note Elementary objects may have many labels (e.g. Action Slider)
713 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
715 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
718 * Get a label of an object
720 * @param obj The Elementary object
721 * @param part The text part name to get (NULL for the default label)
722 * @return text of the label or NULL for any error
724 * @note Elementary objects may have many labels (e.g. Action Slider)
728 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
730 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
733 * Set a content of an object
735 * @param obj The Elementary object
736 * @param part The content part name to set (NULL for the default content)
737 * @param content The new content of the object
739 * @note Elementary objects may have many contents
743 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
745 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
748 * Get a content of an object
750 * @param obj The Elementary object
751 * @param item The content part name to get (NULL for the default content)
752 * @return content of the object or NULL for any error
754 * @note Elementary objects may have many contents
758 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
760 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
763 * Unset a content of an object
765 * @param obj The Elementary object
766 * @param item The content part name to unset (NULL for the default content)
768 * @note Elementary objects may have many contents
772 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
774 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
777 * Set a content of an object item
779 * @param it The Elementary object item
780 * @param part The content part name to unset (NULL for the default content)
781 * @param content The new content of the object item
783 * @note Elementary object items may have many contents
787 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
789 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
792 * Get a content of an object item
794 * @param it The Elementary object item
795 * @param part The content part name to unset (NULL for the default content)
796 * @return content of the object item or NULL for any error
798 * @note Elementary object items may have many contents
802 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
804 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
807 * Unset a content of an object item
809 * @param it The Elementary object item
810 * @param part The content part name to unset (NULL for the default content)
812 * @note Elementary object items may have many contents
816 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
818 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
821 * Set a label of an objec itemt
823 * @param it The Elementary object item
824 * @param part The text part name to set (NULL for the default label)
825 * @param label The new text of the label
827 * @note Elementary object items may have many labels
831 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
833 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
836 * Get a label of an object
838 * @param it The Elementary object item
839 * @param part The text part name to get (NULL for the default label)
840 * @return text of the label or NULL for any error
842 * @note Elementary object items may have many labels
846 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
848 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
854 EAPI void elm_all_flush(void);
855 EAPI int elm_cache_flush_interval_get(void);
856 EAPI void elm_cache_flush_interval_set(int size);
857 EAPI void elm_cache_flush_interval_all_set(int size);
858 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
859 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
860 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
861 EAPI int elm_font_cache_get(void);
862 EAPI void elm_font_cache_set(int size);
863 EAPI void elm_font_cache_all_set(int size);
864 EAPI int elm_image_cache_get(void);
865 EAPI void elm_image_cache_set(int size);
866 EAPI void elm_image_cache_all_set(int size);
867 EAPI int elm_edje_file_cache_get(void);
868 EAPI void elm_edje_file_cache_set(int size);
869 EAPI void elm_edje_file_cache_all_set(int size);
870 EAPI int elm_edje_collection_cache_get(void);
871 EAPI void elm_edje_collection_cache_set(int size);
872 EAPI void elm_edje_collection_cache_all_set(int size);
875 * @defgroup Scaling Selective Widget Scaling
877 * Different widgets can be scaled independently. These functions
878 * allow you to manipulate this scaling on a per-widget basis. The
879 * object and all its children get their scaling factors multiplied
880 * by the scale factor set. This is multiplicative, in that if a
881 * child also has a scale size set it is in turn multiplied by its
882 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
883 * double size, @c 0.5 is half, etc.
885 * @ref general_functions_example_page "This" example contemplates
886 * some of these functions.
890 * Set the scaling factor for a given Elementary object
892 * @param obj The Elementary to operate on
893 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
898 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
901 * Get the scaling factor for a given Elementary object
903 * @param obj The object
904 * @return The scaling factor set by elm_object_scale_set()
908 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
909 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
910 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
911 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
912 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
914 * Set the style to use by a widget
916 * Sets the style name that will define the appearance of a widget. Styles
917 * vary from widget to widget and may also be defined by other themes
918 * by means of extensions and overlays.
920 * @param obj The Elementary widget to style
921 * @param style The style name to use
923 * @see elm_theme_extension_add()
924 * @see elm_theme_overlay_add()
928 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
930 * Get the style used by the widget
932 * This gets the style being used for that widget. Note that the string
933 * pointer is only valid as longas the object is valid and the style doesn't
936 * @param obj The Elementary widget to query for its style
937 * @return The style name used
939 * @see elm_object_style_set()
943 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
946 * @defgroup Styles Styles
948 * Widgets can have different styles of look. These generic API's
949 * set styles of widgets, if they support them (and if the theme(s)
952 * @ref general_functions_example_page "This" example contemplates
953 * some of these functions.
957 * Set the disabled state of an Elementary object.
959 * @param obj The Elementary object to operate on
960 * @param disabled The state to put in in: @c EINA_TRUE for
961 * disabled, @c EINA_FALSE for enabled
963 * Elementary objects can be @b disabled, in which state they won't
964 * receive input and, in general, will be themed differently from
965 * their normal state, usually greyed out. Useful for contexts
966 * where you don't want your users to interact with some of the
967 * parts of you interface.
969 * This sets the state for the widget, either disabling it or
974 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
977 * Get the disabled state of an Elementary object.
979 * @param obj The Elementary object to operate on
980 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
981 * if it's enabled (or on errors)
983 * This gets the state of the widget, which might be enabled or disabled.
987 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
990 * @defgroup WidgetNavigation Widget Tree Navigation.
992 * How to check if an Evas Object is an Elementary widget? How to
993 * get the first elementary widget that is parent of the given
994 * object? These are all covered in widget tree navigation.
996 * @ref general_functions_example_page "This" example contemplates
997 * some of these functions.
1000 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1003 * Get the first parent of the given object that is an Elementary
1006 * @param obj the Elementary object to query parent from.
1007 * @return the parent object that is an Elementary widget, or @c
1008 * NULL, if it was not found.
1010 * Use this to query for an object's parent widget.
1012 * @note Most of Elementary users wouldn't be mixing non-Elementary
1013 * smart objects in the objects tree of an application, as this is
1014 * an advanced usage of Elementary with Evas. So, except for the
1015 * application's window, which is the root of that tree, all other
1016 * objects would have valid Elementary widget parents.
1018 * @ingroup WidgetNavigation
1020 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1021 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1022 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1024 EAPI double elm_scale_get(void);
1025 EAPI void elm_scale_set(double scale);
1026 EAPI void elm_scale_all_set(double scale);
1028 EAPI Eina_Bool elm_mirrored_get(void);
1029 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1031 EAPI Eina_Bool elm_config_save(void);
1032 EAPI void elm_config_reload(void);
1034 EAPI const char *elm_profile_current_get(void);
1035 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1036 EAPI void elm_profile_dir_free(const char *p_dir);
1037 EAPI Eina_List *elm_profile_list_get(void);
1038 EAPI void elm_profile_list_free(Eina_List *l);
1039 EAPI void elm_profile_set(const char *profile);
1040 EAPI void elm_profile_all_set(const char *profile);
1042 EAPI const char *elm_engine_current_get(void);
1043 EAPI void elm_engine_set(const char *engine);
1045 typedef struct _Elm_Text_Class
1051 typedef struct _Elm_Font_Overlay
1053 const char *text_class;
1055 Evas_Font_Size size;
1058 typedef struct _Elm_Font_Properties
1062 } Elm_Font_Properties;
1064 EAPI const Eina_List *elm_text_classes_list_get(void);
1065 EAPI void elm_text_classes_list_free(const Eina_List *list);
1067 EAPI const Eina_List *elm_font_overlay_list_get(void);
1068 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1069 EAPI void elm_font_overlay_unset(const char *text_class);
1070 EAPI void elm_font_overlay_apply(void);
1071 EAPI void elm_font_overlay_all_apply(void);
1073 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1074 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1075 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1076 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1077 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1078 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1081 * @defgroup Fingers Fingers
1083 * Elementary is designed to be finger-friendly for touchscreens,
1084 * and so in addition to scaling for display resolution, it can
1085 * also scale based on finger "resolution" (or size). You can then
1086 * customize the granularity of the areas meant to receive clicks
1089 * Different profiles may have pre-set values for finger sizes.
1091 * @ref general_functions_example_page "This" example contemplates
1092 * some of these functions.
1096 * Get the configured "finger size"
1098 * @return The finger size
1100 * This gets the globally configured finger size, <b>in pixels</b>
1104 EAPI Evas_Coord elm_finger_size_get(void);
1105 EAPI void elm_finger_size_set(Evas_Coord size);
1106 EAPI void elm_finger_size_all_set(Evas_Coord size);
1109 * @defgroup Focus Focus
1111 * An Elementary application has, at all times, one (and only one)
1112 * @b focused object. This is what determines where the input
1113 * events go to within the application's window. Also, focused
1114 * objects can be decorated differently, in order to signal to the
1115 * user where the input is, at a given moment.
1117 * Elementary applications also have the concept of <b>focus
1118 * chain</b>: one can cycle through all the windows' focusable
1119 * objects by input (tab key) or programmatically. The default
1120 * focus chain for an application is the one define by the order in
1121 * which the widgets where added in code. One will cycle through
1122 * top level widgets, and, for each one containg sub-objects, cycle
1123 * through them all, before returning to the level
1124 * above. Elementary also allows one to set @b custom focus chains
1125 * for their applications.
1127 * Besides the focused decoration a widget may exhibit, when it
1128 * gets focus, Elementary has a @b global focus highlight object
1129 * that can be enabled for a window. If one chooses to do so, this
1130 * extra highlight effect will surround the current focused object,
1133 * @note Some Elementary widgets are @b unfocusable, after
1134 * creation, by their very nature: they are not meant to be
1135 * interacted with input events, but are there just for visual
1138 * @ref general_functions_example_page "This" example contemplates
1139 * some of these functions.
1142 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1143 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1144 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1145 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1148 * Get the whether an Elementary object has the focus or not.
1150 * @param obj The Elementary object to get the information from
1151 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1152 * not (and on errors).
1154 * @see elm_object_focus()
1158 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1161 * Set/unset focus to a given Elementary object.
1163 * @param obj The Elementary object to operate on.
1164 * @param enable @c EINA_TRUE Set focus to a given object,
1165 * @c EINA_FALSE Unset focus to a given object.
1167 * @note When you set focus to this object, if it can handle focus, will
1168 * take the focus away from the one who had it previously and will, for
1169 * now on, be the one receiving input events. Unsetting focus will remove
1170 * the focus from @p obj, passing it back to the previous element in the
1173 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1177 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1180 * Make a given Elementary object the focused one.
1182 * @param obj The Elementary object to make focused.
1184 * @note This object, if it can handle focus, will take the focus
1185 * away from the one who had it previously and will, for now on, be
1186 * the one receiving input events.
1188 * @see elm_object_focus_get()
1189 * @deprecated use elm_object_focus_set() instead.
1193 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1196 * Remove the focus from an Elementary object
1198 * @param obj The Elementary to take focus from
1200 * This removes the focus from @p obj, passing it back to the
1201 * previous element in the focus chain list.
1203 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1204 * @deprecated use elm_object_focus_set() instead.
1208 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1211 * Set the ability for an Element object to be focused
1213 * @param obj The Elementary object to operate on
1214 * @param enable @c EINA_TRUE if the object can be focused, @c
1215 * EINA_FALSE if not (and on errors)
1217 * This sets whether the object @p obj is able to take focus or
1218 * not. Unfocusable objects do nothing when programmatically
1219 * focused, being the nearest focusable parent object the one
1220 * really getting focus. Also, when they receive mouse input, they
1221 * will get the event, but not take away the focus from where it
1226 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1229 * Get whether an Elementary object is focusable or not
1231 * @param obj The Elementary object to operate on
1232 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1233 * EINA_FALSE if not (and on errors)
1235 * @note Objects which are meant to be interacted with by input
1236 * events are created able to be focused, by default. All the
1241 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1243 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1244 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1245 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1246 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1247 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1248 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1249 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1252 * Make the elementary object and its children to be unfocusable (or focusable).
1254 * @param obj The Elementary object to operate on
1255 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1256 * @c EINA_FALSE for focusable.
1258 * This sets whether the object @p obj and its children objects
1259 * are able to take focus or not. If the tree is set as unfocusable,
1260 * newest focused object which is not in this tree will get focus.
1261 * This API can be helpful for an object to be deleted.
1262 * When an object will be deleted soon, it and its children may not
1263 * want to get focus (by focus reverting or by other focus controls).
1264 * Then, just use this API before deleting.
1266 * @see elm_object_tree_unfocusable_get()
1270 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1273 * Get whether an Elementary object and its children are unfocusable or not.
1275 * @param obj The Elementary object to get the information from
1276 * @return @c EINA_TRUE, if the tree is unfocussable,
1277 * @c EINA_FALSE if not (and on errors).
1279 * @see elm_object_tree_unfocusable_set()
1283 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1285 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1286 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1287 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1288 EAPI double elm_scroll_bounce_friction_get(void);
1289 EAPI void elm_scroll_bounce_friction_set(double friction);
1290 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1291 EAPI double elm_scroll_page_scroll_friction_get(void);
1292 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1293 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1294 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1295 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1296 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1297 EAPI double elm_scroll_zoom_friction_get(void);
1298 EAPI void elm_scroll_zoom_friction_set(double friction);
1299 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1300 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1301 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1302 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1303 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1304 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1305 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1306 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1307 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1308 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1309 EAPI double elm_scroll_thumbscroll_friction_get(void);
1310 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1311 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1312 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1313 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1314 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1316 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1317 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1318 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1319 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1320 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1321 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1322 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1323 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1325 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1326 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);
1327 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);
1329 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1330 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1333 * Adjust size of an element for finger usage.
1335 * @param times_w How many fingers should fit horizontally
1336 * @param w Pointer to the width size to adjust
1337 * @param times_h How many fingers should fit vertically
1338 * @param h Pointer to the height size to adjust
1340 * This takes width and height sizes (in pixels) as input and a
1341 * size multiple (which is how many fingers you want to place
1342 * within the area, being "finger" the size set by
1343 * elm_finger_size_set()), and adjusts the size to be large enough
1344 * to accommodate the resulting size -- if it doesn't already
1345 * accommodate it. On return the @p w and @p h sizes pointed to by
1346 * these parameters will be modified, on those conditions.
1348 * @note This is kind of a low level Elementary call, most useful
1349 * on size evaluation times for widgets. An external user wouldn't
1350 * be calling, most of the time.
1354 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1356 EAPI double elm_longpress_timeout_get(void);
1357 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1360 * don't use it unless you are sure
1362 EAPI void elm_object_tree_dump(const Evas_Object *top);
1363 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1368 * @defgroup Theme Theme
1370 * Elementary uses Edje to theme its widgets, naturally. But for the most
1371 * part this is hidden behind a simpler interface that lets the user set
1372 * extensions and choose the style of widgets in a much easier way.
1374 * Instead of thinking in terms of paths to Edje files and their groups
1375 * each time you want to change the appearance of a widget, Elementary
1376 * works so you can add any theme file with extensions or replace the
1377 * main theme at one point in the application, and then just set the style
1378 * of widgets with elm_object_style_set() and related functions. Elementary
1379 * will then look in its list of themes for a matching group and apply it,
1380 * and when the theme changes midway through the application, all widgets
1381 * will be updated accordingly.
1383 * There are three concepts you need to know to understand how Elementary
1384 * theming works: default theme, extensions and overlays.
1386 * Default theme, obviously enough, is the one that provides the default
1387 * look of all widgets. End users can change the theme used by Elementary
1388 * by setting the @c ELM_THEME environment variable before running an
1389 * application, or globally for all programs using the @c elementary_config
1390 * utility. Applications can change the default theme using elm_theme_set(),
1391 * but this can go against the user wishes, so it's not an adviced practice.
1393 * Ideally, applications should find everything they need in the already
1394 * provided theme, but there may be occasions when that's not enough and
1395 * custom styles are required to correctly express the idea. For this
1396 * cases, Elementary has extensions.
1398 * Extensions allow the application developer to write styles of its own
1399 * to apply to some widgets. This requires knowledge of how each widget
1400 * is themed, as extensions will always replace the entire group used by
1401 * the widget, so important signals and parts need to be there for the
1402 * object to behave properly (see documentation of Edje for details).
1403 * Once the theme for the extension is done, the application needs to add
1404 * it to the list of themes Elementary will look into, using
1405 * elm_theme_extension_add(), and set the style of the desired widgets as
1406 * he would normally with elm_object_style_set().
1408 * Overlays, on the other hand, can replace the look of all widgets by
1409 * overriding the default style. Like extensions, it's up to the application
1410 * developer to write the theme for the widgets it wants, the difference
1411 * being that when looking for the theme, Elementary will check first the
1412 * list of overlays, then the set theme and lastly the list of extensions,
1413 * so with overlays it's possible to replace the default view and every
1414 * widget will be affected. This is very much alike to setting the whole
1415 * theme for the application and will probably clash with the end user
1416 * options, not to mention the risk of ending up with not matching styles
1417 * across the program. Unless there's a very special reason to use them,
1418 * overlays should be avoided for the resons exposed before.
1420 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1421 * keeps one default internally and every function that receives one of
1422 * these can be called with NULL to refer to this default (except for
1423 * elm_theme_free()). It's possible to create a new instance of a
1424 * ::Elm_Theme to set other theme for a specific widget (and all of its
1425 * children), but this is as discouraged, if not even more so, than using
1426 * overlays. Don't use this unless you really know what you are doing.
1428 * But to be less negative about things, you can look at the following
1430 * @li @ref theme_example_01 "Using extensions"
1431 * @li @ref theme_example_02 "Using overlays"
1436 * @typedef Elm_Theme
1438 * Opaque handler for the list of themes Elementary looks for when
1439 * rendering widgets.
1441 * Stay out of this unless you really know what you are doing. For most
1442 * cases, sticking to the default is all a developer needs.
1444 typedef struct _Elm_Theme Elm_Theme;
1447 * Create a new specific theme
1449 * This creates an empty specific theme that only uses the default theme. A
1450 * specific theme has its own private set of extensions and overlays too
1451 * (which are empty by default). Specific themes do not fall back to themes
1452 * of parent objects. They are not intended for this use. Use styles, overlays
1453 * and extensions when needed, but avoid specific themes unless there is no
1454 * other way (example: you want to have a preview of a new theme you are
1455 * selecting in a "theme selector" window. The preview is inside a scroller
1456 * and should display what the theme you selected will look like, but not
1457 * actually apply it yet. The child of the scroller will have a specific
1458 * theme set to show this preview before the user decides to apply it to all
1461 EAPI Elm_Theme *elm_theme_new(void);
1463 * Free a specific theme
1465 * @param th The theme to free
1467 * This frees a theme created with elm_theme_new().
1469 EAPI void elm_theme_free(Elm_Theme *th);
1471 * Copy the theme fom the source to the destination theme
1473 * @param th The source theme to copy from
1474 * @param thdst The destination theme to copy data to
1476 * This makes a one-time static copy of all the theme config, extensions
1477 * and overlays from @p th to @p thdst. If @p th references a theme, then
1478 * @p thdst is also set to reference it, with all the theme settings,
1479 * overlays and extensions that @p th had.
1481 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1483 * Tell the source theme to reference the ref theme
1485 * @param th The theme that will do the referencing
1486 * @param thref The theme that is the reference source
1488 * This clears @p th to be empty and then sets it to refer to @p thref
1489 * so @p th acts as an override to @p thref, but where its overrides
1490 * don't apply, it will fall through to @p thref for configuration.
1492 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1494 * Return the theme referred to
1496 * @param th The theme to get the reference from
1497 * @return The referenced theme handle
1499 * This gets the theme set as the reference theme by elm_theme_ref_set().
1500 * If no theme is set as a reference, NULL is returned.
1502 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1504 * Return the default theme
1506 * @return The default theme handle
1508 * This returns the internal default theme setup handle that all widgets
1509 * use implicitly unless a specific theme is set. This is also often use
1510 * as a shorthand of NULL.
1512 EAPI Elm_Theme *elm_theme_default_get(void);
1514 * Prepends a theme overlay to the list of overlays
1516 * @param th The theme to add to, or if NULL, the default theme
1517 * @param item The Edje file path to be used
1519 * Use this if your application needs to provide some custom overlay theme
1520 * (An Edje file that replaces some default styles of widgets) where adding
1521 * new styles, or changing system theme configuration is not possible. Do
1522 * NOT use this instead of a proper system theme configuration. Use proper
1523 * configuration files, profiles, environment variables etc. to set a theme
1524 * so that the theme can be altered by simple confiugration by a user. Using
1525 * this call to achieve that effect is abusing the API and will create lots
1528 * @see elm_theme_extension_add()
1530 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1532 * Delete a theme overlay from the list of overlays
1534 * @param th The theme to delete from, or if NULL, the default theme
1535 * @param item The name of the theme overlay
1537 * @see elm_theme_overlay_add()
1539 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1541 * Appends a theme extension to the list of extensions.
1543 * @param th The theme to add to, or if NULL, the default theme
1544 * @param item The Edje file path to be used
1546 * This is intended when an application needs more styles of widgets or new
1547 * widget themes that the default does not provide (or may not provide). The
1548 * application has "extended" usage by coming up with new custom style names
1549 * for widgets for specific uses, but as these are not "standard", they are
1550 * not guaranteed to be provided by a default theme. This means the
1551 * application is required to provide these extra elements itself in specific
1552 * Edje files. This call adds one of those Edje files to the theme search
1553 * path to be search after the default theme. The use of this call is
1554 * encouraged when default styles do not meet the needs of the application.
1555 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1557 * @see elm_object_style_set()
1559 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1561 * Deletes a theme extension from the list of extensions.
1563 * @param th The theme to delete from, or if NULL, the default theme
1564 * @param item The name of the theme extension
1566 * @see elm_theme_extension_add()
1568 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1570 * Set the theme search order for the given theme
1572 * @param th The theme to set the search order, or if NULL, the default theme
1573 * @param theme Theme search string
1575 * This sets the search string for the theme in path-notation from first
1576 * theme to search, to last, delimited by the : character. Example:
1578 * "shiny:/path/to/file.edj:default"
1580 * See the ELM_THEME environment variable for more information.
1582 * @see elm_theme_get()
1583 * @see elm_theme_list_get()
1585 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1587 * Return the theme search order
1589 * @param th The theme to get the search order, or if NULL, the default theme
1590 * @return The internal search order path
1592 * This function returns a colon separated string of theme elements as
1593 * returned by elm_theme_list_get().
1595 * @see elm_theme_set()
1596 * @see elm_theme_list_get()
1598 EAPI const char *elm_theme_get(Elm_Theme *th);
1600 * Return a list of theme elements to be used in a theme.
1602 * @param th Theme to get the list of theme elements from.
1603 * @return The internal list of theme elements
1605 * This returns the internal list of theme elements (will only be valid as
1606 * long as the theme is not modified by elm_theme_set() or theme is not
1607 * freed by elm_theme_free(). This is a list of strings which must not be
1608 * altered as they are also internal. If @p th is NULL, then the default
1609 * theme element list is returned.
1611 * A theme element can consist of a full or relative path to a .edj file,
1612 * or a name, without extension, for a theme to be searched in the known
1613 * theme paths for Elemementary.
1615 * @see elm_theme_set()
1616 * @see elm_theme_get()
1618 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1620 * Return the full patrh for a theme element
1622 * @param f The theme element name
1623 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1624 * @return The full path to the file found.
1626 * This returns a string you should free with free() on success, NULL on
1627 * failure. This will search for the given theme element, and if it is a
1628 * full or relative path element or a simple searchable name. The returned
1629 * path is the full path to the file, if searched, and the file exists, or it
1630 * is simply the full path given in the element or a resolved path if
1631 * relative to home. The @p in_search_path boolean pointed to is set to
1632 * EINA_TRUE if the file was a searchable file andis in the search path,
1633 * and EINA_FALSE otherwise.
1635 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1637 * Flush the current theme.
1639 * @param th Theme to flush
1641 * This flushes caches that let elementary know where to find theme elements
1642 * in the given theme. If @p th is NULL, then the default theme is flushed.
1643 * Call this function if source theme data has changed in such a way as to
1644 * make any caches Elementary kept invalid.
1646 EAPI void elm_theme_flush(Elm_Theme *th);
1648 * This flushes all themes (default and specific ones).
1650 * This will flush all themes in the current application context, by calling
1651 * elm_theme_flush() on each of them.
1653 EAPI void elm_theme_full_flush(void);
1655 * Set the theme for all elementary using applications on the current display
1657 * @param theme The name of the theme to use. Format same as the ELM_THEME
1658 * environment variable.
1660 EAPI void elm_theme_all_set(const char *theme);
1662 * Return a list of theme elements in the theme search path
1664 * @return A list of strings that are the theme element names.
1666 * This lists all available theme files in the standard Elementary search path
1667 * for theme elements, and returns them in alphabetical order as theme
1668 * element names in a list of strings. Free this with
1669 * elm_theme_name_available_list_free() when you are done with the list.
1671 EAPI Eina_List *elm_theme_name_available_list_new(void);
1673 * Free the list returned by elm_theme_name_available_list_new()
1675 * This frees the list of themes returned by
1676 * elm_theme_name_available_list_new(). Once freed the list should no longer
1677 * be used. a new list mys be created.
1679 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1681 * Set a specific theme to be used for this object and its children
1683 * @param obj The object to set the theme on
1684 * @param th The theme to set
1686 * This sets a specific theme that will be used for the given object and any
1687 * child objects it has. If @p th is NULL then the theme to be used is
1688 * cleared and the object will inherit its theme from its parent (which
1689 * ultimately will use the default theme if no specific themes are set).
1691 * Use special themes with great care as this will annoy users and make
1692 * configuration difficult. Avoid any custom themes at all if it can be
1695 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1697 * Get the specific theme to be used
1699 * @param obj The object to get the specific theme from
1700 * @return The specifc theme set.
1702 * This will return a specific theme set, or NULL if no specific theme is
1703 * set on that object. It will not return inherited themes from parents, only
1704 * the specific theme set for that specific object. See elm_object_theme_set()
1705 * for more information.
1707 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1713 /** @defgroup Win Win
1715 * @image html img/widget/win/preview-00.png
1716 * @image latex img/widget/win/preview-00.eps
1718 * The window class of Elementary. Contains functions to manipulate
1719 * windows. The Evas engine used to render the window contents is specified
1720 * in the system or user elementary config files (whichever is found last),
1721 * and can be overridden with the ELM_ENGINE environment variable for
1722 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1723 * compilation setup and modules actually installed at runtime) are (listed
1724 * in order of best supported and most likely to be complete and work to
1727 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1728 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1730 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1732 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1734 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1736 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1737 * rendering using SDL as the buffer)
1738 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1739 * GDI with software)
1740 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1741 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1742 * grayscale using dedicated 8bit software engine in X11)
1743 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1744 * X11 using 16bit software engine)
1745 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1746 * (Windows CE rendering via GDI with 16bit software renderer)
1747 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1748 * buffer with 16bit software renderer)
1750 * All engines use a simple string to select the engine to render, EXCEPT
1751 * the "shot" engine. This actually encodes the output of the virtual
1752 * screenshot and how long to delay in the engine string. The engine string
1753 * is encoded in the following way:
1755 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1757 * Where options are separated by a ":" char if more than one option is
1758 * given, with delay, if provided being the first option and file the last
1759 * (order is important). The delay specifies how long to wait after the
1760 * window is shown before doing the virtual "in memory" rendering and then
1761 * save the output to the file specified by the file option (and then exit).
1762 * If no delay is given, the default is 0.5 seconds. If no file is given the
1763 * default output file is "out.png". Repeat option is for continous
1764 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1765 * fixed to "out001.png" Some examples of using the shot engine:
1767 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1768 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1769 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1770 * ELM_ENGINE="shot:delay=2.0" elementary_test
1771 * ELM_ENGINE="shot:" elementary_test
1773 * Signals that you can add callbacks for are:
1775 * @li "delete,request": the user requested to close the window. See
1776 * elm_win_autodel_set().
1777 * @li "focus,in": window got focus
1778 * @li "focus,out": window lost focus
1779 * @li "moved": window that holds the canvas was moved
1782 * @li @ref win_example_01
1787 * Defines the types of window that can be created
1789 * These are hints set on the window so that a running Window Manager knows
1790 * how the window should be handled and/or what kind of decorations it
1793 * Currently, only the X11 backed engines use them.
1795 typedef enum _Elm_Win_Type
1797 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1798 window. Almost every window will be created with this
1800 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1801 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1802 window holding desktop icons. */
1803 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1804 be kept on top of any other window by the Window
1806 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1808 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1809 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1811 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1812 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1813 entry in a menubar is clicked. Typically used
1814 with elm_win_override_set(). This hint exists
1815 for completion only, as the EFL way of
1816 implementing a menu would not normally use a
1817 separate window for its contents. */
1818 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1819 triggered by right-clicking an object. */
1820 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1821 explanatory text that typically appear after the
1822 mouse cursor hovers over an object for a while.
1823 Typically used with elm_win_override_set() and also
1824 not very commonly used in the EFL. */
1825 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1826 battery life or a new E-Mail received. */
1827 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1828 usually used in the EFL. */
1829 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1830 object being dragged across different windows, or even
1831 applications. Typically used with
1832 elm_win_override_set(). */
1833 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1834 buffer. No actual window is created for this
1835 type, instead the window and all of its
1836 contents will be rendered to an image buffer.
1837 This allows to have children window inside a
1838 parent one just like any other object would
1839 be, and do other things like applying @c
1840 Evas_Map effects to it. This is the only type
1841 of window that requires the @c parent
1842 parameter of elm_win_add() to be a valid @c
1847 * The differents layouts that can be requested for the virtual keyboard.
1849 * When the application window is being managed by Illume, it may request
1850 * any of the following layouts for the virtual keyboard.
1852 typedef enum _Elm_Win_Keyboard_Mode
1854 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1855 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1856 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1857 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1858 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1859 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1860 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1861 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1862 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1863 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1864 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1865 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1866 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1867 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1868 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1869 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1870 } Elm_Win_Keyboard_Mode;
1873 * Available commands that can be sent to the Illume manager.
1875 * When running under an Illume session, a window may send commands to the
1876 * Illume manager to perform different actions.
1878 typedef enum _Elm_Illume_Command
1880 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1882 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1884 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1886 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1887 } Elm_Illume_Command;
1890 * Adds a window object. If this is the first window created, pass NULL as
1893 * @param parent Parent object to add the window to, or NULL
1894 * @param name The name of the window
1895 * @param type The window type, one of #Elm_Win_Type.
1897 * The @p parent paramter can be @c NULL for every window @p type except
1898 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1899 * which the image object will be created.
1901 * @return The created object, or NULL on failure
1903 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1905 * Add @p subobj as a resize object of window @p obj.
1908 * Setting an object as a resize object of the window means that the
1909 * @p subobj child's size and position will be controlled by the window
1910 * directly. That is, the object will be resized to match the window size
1911 * and should never be moved or resized manually by the developer.
1913 * In addition, resize objects of the window control what the minimum size
1914 * of it will be, as well as whether it can or not be resized by the user.
1916 * For the end user to be able to resize a window by dragging the handles
1917 * or borders provided by the Window Manager, or using any other similar
1918 * mechanism, all of the resize objects in the window should have their
1919 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1921 * @param obj The window object
1922 * @param subobj The resize object to add
1924 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1926 * Delete @p subobj as a resize object of window @p obj.
1928 * This function removes the object @p subobj from the resize objects of
1929 * the window @p obj. It will not delete the object itself, which will be
1930 * left unmanaged and should be deleted by the developer, manually handled
1931 * or set as child of some other container.
1933 * @param obj The window object
1934 * @param subobj The resize object to add
1936 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1938 * Set the title of the window
1940 * @param obj The window object
1941 * @param title The title to set
1943 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1945 * Get the title of the window
1947 * The returned string is an internal one and should not be freed or
1948 * modified. It will also be rendered invalid if a new title is set or if
1949 * the window is destroyed.
1951 * @param obj The window object
1954 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1956 * Set the window's autodel state.
1958 * When closing the window in any way outside of the program control, like
1959 * pressing the X button in the titlebar or using a command from the
1960 * Window Manager, a "delete,request" signal is emitted to indicate that
1961 * this event occurred and the developer can take any action, which may
1962 * include, or not, destroying the window object.
1964 * When the @p autodel parameter is set, the window will be automatically
1965 * destroyed when this event occurs, after the signal is emitted.
1966 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1967 * and is up to the program to do so when it's required.
1969 * @param obj The window object
1970 * @param autodel If true, the window will automatically delete itself when
1973 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1975 * Get the window's autodel state.
1977 * @param obj The window object
1978 * @return If the window will automatically delete itself when closed
1980 * @see elm_win_autodel_set()
1982 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1984 * Activate a window object.
1986 * This function sends a request to the Window Manager to activate the
1987 * window pointed by @p obj. If honored by the WM, the window will receive
1988 * the keyboard focus.
1990 * @note This is just a request that a Window Manager may ignore, so calling
1991 * this function does not ensure in any way that the window will be the
1992 * active one after it.
1994 * @param obj The window object
1996 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1998 * Lower a window object.
2000 * Places the window pointed by @p obj at the bottom of the stack, so that
2001 * no other window is covered by it.
2003 * If elm_win_override_set() is not set, the Window Manager may ignore this
2006 * @param obj The window object
2008 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2010 * Raise a window object.
2012 * Places the window pointed by @p obj at the top of the stack, so that it's
2013 * not covered by any other window.
2015 * If elm_win_override_set() is not set, the Window Manager may ignore this
2018 * @param obj The window object
2020 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2022 * Set the borderless state of a window.
2024 * This function requests the Window Manager to not draw any decoration
2025 * around the window.
2027 * @param obj The window object
2028 * @param borderless If true, the window is borderless
2030 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2032 * Get the borderless state of a window.
2034 * @param obj The window object
2035 * @return If true, the window is borderless
2037 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2039 * Set the shaped state of a window.
2041 * Shaped windows, when supported, will render the parts of the window that
2042 * has no content, transparent.
2044 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2045 * background object or cover the entire window in any other way, or the
2046 * parts of the canvas that have no data will show framebuffer artifacts.
2048 * @param obj The window object
2049 * @param shaped If true, the window is shaped
2051 * @see elm_win_alpha_set()
2053 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2055 * Get the shaped state of a window.
2057 * @param obj The window object
2058 * @return If true, the window is shaped
2060 * @see elm_win_shaped_set()
2062 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2064 * Set the alpha channel state of a window.
2066 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2067 * possibly making parts of the window completely or partially transparent.
2068 * This is also subject to the underlying system supporting it, like for
2069 * example, running under a compositing manager. If no compositing is
2070 * available, enabling this option will instead fallback to using shaped
2071 * windows, with elm_win_shaped_set().
2073 * @param obj The window object
2074 * @param alpha If true, the window has an alpha channel
2076 * @see elm_win_alpha_set()
2078 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2080 * Get the transparency state of a window.
2082 * @param obj The window object
2083 * @return If true, the window is transparent
2085 * @see elm_win_transparent_set()
2087 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2089 * Set the transparency state of a window.
2091 * Use elm_win_alpha_set() instead.
2093 * @param obj The window object
2094 * @param transparent If true, the window is transparent
2096 * @see elm_win_alpha_set()
2098 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2100 * Get the alpha channel state of a window.
2102 * @param obj The window object
2103 * @return If true, the window has an alpha channel
2105 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2107 * Set the override state of a window.
2109 * A window with @p override set to EINA_TRUE will not be managed by the
2110 * Window Manager. This means that no decorations of any kind will be shown
2111 * for it, moving and resizing must be handled by the application, as well
2112 * as the window visibility.
2114 * This should not be used for normal windows, and even for not so normal
2115 * ones, it should only be used when there's a good reason and with a lot
2116 * of care. Mishandling override windows may result situations that
2117 * disrupt the normal workflow of the end user.
2119 * @param obj The window object
2120 * @param override If true, the window is overridden
2122 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2124 * Get the override state of a window.
2126 * @param obj The window object
2127 * @return If true, the window is overridden
2129 * @see elm_win_override_set()
2131 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2133 * Set the fullscreen state of a window.
2135 * @param obj The window object
2136 * @param fullscreen If true, the window is fullscreen
2138 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2140 * Get the fullscreen state of a window.
2142 * @param obj The window object
2143 * @return If true, the window is fullscreen
2145 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2147 * Set the maximized state of a window.
2149 * @param obj The window object
2150 * @param maximized If true, the window is maximized
2152 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2154 * Get the maximized state of a window.
2156 * @param obj The window object
2157 * @return If true, the window is maximized
2159 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2161 * Set the iconified state of a window.
2163 * @param obj The window object
2164 * @param iconified If true, the window is iconified
2166 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2168 * Get the iconified state of a window.
2170 * @param obj The window object
2171 * @return If true, the window is iconified
2173 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2175 * Set the layer of the window.
2177 * What this means exactly will depend on the underlying engine used.
2179 * In the case of X11 backed engines, the value in @p layer has the
2180 * following meanings:
2181 * @li < 3: The window will be placed below all others.
2182 * @li > 5: The window will be placed above all others.
2183 * @li other: The window will be placed in the default layer.
2185 * @param obj The window object
2186 * @param layer The layer of the window
2188 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2190 * Get the layer of the window.
2192 * @param obj The window object
2193 * @return The layer of the window
2195 * @see elm_win_layer_set()
2197 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2199 * Set the rotation of the window.
2201 * Most engines only work with multiples of 90.
2203 * This function is used to set the orientation of the window @p obj to
2204 * match that of the screen. The window itself will be resized to adjust
2205 * to the new geometry of its contents. If you want to keep the window size,
2206 * see elm_win_rotation_with_resize_set().
2208 * @param obj The window object
2209 * @param rotation The rotation of the window, in degrees (0-360),
2210 * counter-clockwise.
2212 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2214 * Rotates the window and resizes it.
2216 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2217 * that they fit inside the current window geometry.
2219 * @param obj The window object
2220 * @param layer The rotation of the window in degrees (0-360),
2221 * counter-clockwise.
2223 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2225 * Get the rotation of the window.
2227 * @param obj The window object
2228 * @return The rotation of the window in degrees (0-360)
2230 * @see elm_win_rotation_set()
2231 * @see elm_win_rotation_with_resize_set()
2233 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2235 * Set the sticky state of the window.
2237 * Hints the Window Manager that the window in @p obj should be left fixed
2238 * at its position even when the virtual desktop it's on moves or changes.
2240 * @param obj The window object
2241 * @param sticky If true, the window's sticky state is enabled
2243 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2245 * Get the sticky state of the window.
2247 * @param obj The window object
2248 * @return If true, the window's sticky state is enabled
2250 * @see elm_win_sticky_set()
2252 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2254 * Set if this window is an illume conformant window
2256 * @param obj The window object
2257 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2259 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2261 * Get if this window is an illume conformant window
2263 * @param obj The window object
2264 * @return A boolean if this window is illume conformant or not
2266 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2268 * Set a window to be an illume quickpanel window
2270 * By default window objects are not quickpanel windows.
2272 * @param obj The window object
2273 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2275 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2277 * Get if this window is a quickpanel or not
2279 * @param obj The window object
2280 * @return A boolean if this window is a quickpanel or not
2282 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2284 * Set the major priority of a quickpanel window
2286 * @param obj The window object
2287 * @param priority The major priority for this quickpanel
2289 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2291 * Get the major priority of a quickpanel window
2293 * @param obj The window object
2294 * @return The major priority of this quickpanel
2296 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2298 * Set the minor priority of a quickpanel window
2300 * @param obj The window object
2301 * @param priority The minor priority for this quickpanel
2303 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2305 * Get the minor priority of a quickpanel window
2307 * @param obj The window object
2308 * @return The minor priority of this quickpanel
2310 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2312 * Set which zone this quickpanel should appear in
2314 * @param obj The window object
2315 * @param zone The requested zone for this quickpanel
2317 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2319 * Get which zone this quickpanel should appear in
2321 * @param obj The window object
2322 * @return The requested zone for this quickpanel
2324 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2326 * Set the window to be skipped by keyboard focus
2328 * This sets the window to be skipped by normal keyboard input. This means
2329 * a window manager will be asked to not focus this window as well as omit
2330 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2332 * Call this and enable it on a window BEFORE you show it for the first time,
2333 * otherwise it may have no effect.
2335 * Use this for windows that have only output information or might only be
2336 * interacted with by the mouse or fingers, and never for typing input.
2337 * Be careful that this may have side-effects like making the window
2338 * non-accessible in some cases unless the window is specially handled. Use
2341 * @param obj The window object
2342 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2344 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2346 * Send a command to the windowing environment
2348 * This is intended to work in touchscreen or small screen device
2349 * environments where there is a more simplistic window management policy in
2350 * place. This uses the window object indicated to select which part of the
2351 * environment to control (the part that this window lives in), and provides
2352 * a command and an optional parameter structure (use NULL for this if not
2355 * @param obj The window object that lives in the environment to control
2356 * @param command The command to send
2357 * @param params Optional parameters for the command
2359 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2361 * Get the inlined image object handle
2363 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2364 * then the window is in fact an evas image object inlined in the parent
2365 * canvas. You can get this object (be careful to not manipulate it as it
2366 * is under control of elementary), and use it to do things like get pixel
2367 * data, save the image to a file, etc.
2369 * @param obj The window object to get the inlined image from
2370 * @return The inlined image object, or NULL if none exists
2372 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2374 * Set the enabled status for the focus highlight in a window
2376 * This function will enable or disable the focus highlight only for the
2377 * given window, regardless of the global setting for it
2379 * @param obj The window where to enable the highlight
2380 * @param enabled The enabled value for the highlight
2382 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2384 * Get the enabled value of the focus highlight for this window
2386 * @param obj The window in which to check if the focus highlight is enabled
2388 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2390 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2392 * Set the style for the focus highlight on this window
2394 * Sets the style to use for theming the highlight of focused objects on
2395 * the given window. If @p style is NULL, the default will be used.
2397 * @param obj The window where to set the style
2398 * @param style The style to set
2400 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2402 * Get the style set for the focus highlight object
2404 * Gets the style set for this windows highilght object, or NULL if none
2407 * @param obj The window to retrieve the highlights style from
2409 * @return The style set or NULL if none was. Default is used in that case.
2411 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2413 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2414 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2415 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2416 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2417 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2418 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2419 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2421 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2422 * (blank mouse, private mouse obj, defaultmouse)
2426 * Sets the keyboard mode of the window.
2428 * @param obj The window object
2429 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2431 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2433 * Gets the keyboard mode of the window.
2435 * @param obj The window object
2436 * @return The mode, one of #Elm_Win_Keyboard_Mode
2438 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2440 * Sets whether the window is a keyboard.
2442 * @param obj The window object
2443 * @param is_keyboard If true, the window is a virtual keyboard
2445 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2447 * Gets whether the window is a keyboard.
2449 * @param obj The window object
2450 * @return If the window is a virtual keyboard
2452 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2455 * Get the screen position of a window.
2457 * @param obj The window object
2458 * @param x The int to store the x coordinate to
2459 * @param y The int to store the y coordinate to
2461 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2467 * @defgroup Inwin Inwin
2469 * @image html img/widget/inwin/preview-00.png
2470 * @image latex img/widget/inwin/preview-00.eps
2471 * @image html img/widget/inwin/preview-01.png
2472 * @image latex img/widget/inwin/preview-01.eps
2473 * @image html img/widget/inwin/preview-02.png
2474 * @image latex img/widget/inwin/preview-02.eps
2476 * An inwin is a window inside a window that is useful for a quick popup.
2477 * It does not hover.
2479 * It works by creating an object that will occupy the entire window, so it
2480 * must be created using an @ref Win "elm_win" as parent only. The inwin
2481 * object can be hidden or restacked below every other object if it's
2482 * needed to show what's behind it without destroying it. If this is done,
2483 * the elm_win_inwin_activate() function can be used to bring it back to
2484 * full visibility again.
2486 * There are three styles available in the default theme. These are:
2487 * @li default: The inwin is sized to take over most of the window it's
2489 * @li minimal: The size of the inwin will be the minimum necessary to show
2491 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2492 * possible, but it's sized vertically the most it needs to fit its\
2495 * Some examples of Inwin can be found in the following:
2496 * @li @ref inwin_example_01
2501 * Adds an inwin to the current window
2503 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2504 * Never call this function with anything other than the top-most window
2505 * as its parameter, unless you are fond of undefined behavior.
2507 * After creating the object, the widget will set itself as resize object
2508 * for the window with elm_win_resize_object_add(), so when shown it will
2509 * appear to cover almost the entire window (how much of it depends on its
2510 * content and the style used). It must not be added into other container
2511 * objects and it needs not be moved or resized manually.
2513 * @param parent The parent object
2514 * @return The new object or NULL if it cannot be created
2516 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2518 * Activates an inwin object, ensuring its visibility
2520 * This function will make sure that the inwin @p obj is completely visible
2521 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2522 * to the front. It also sets the keyboard focus to it, which will be passed
2525 * The object's theme will also receive the signal "elm,action,show" with
2528 * @param obj The inwin to activate
2530 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2532 * Set the content of an inwin object.
2534 * Once the content object is set, a previously set one will be deleted.
2535 * If you want to keep that old content object, use the
2536 * elm_win_inwin_content_unset() function.
2538 * @param obj The inwin object
2539 * @param content The object to set as content
2541 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2543 * Get the content of an inwin object.
2545 * Return the content object which is set for this widget.
2547 * The returned object is valid as long as the inwin is still alive and no
2548 * other content is set on it. Deleting the object will notify the inwin
2549 * about it and this one will be left empty.
2551 * If you need to remove an inwin's content to be reused somewhere else,
2552 * see elm_win_inwin_content_unset().
2554 * @param obj The inwin object
2555 * @return The content that is being used
2557 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2559 * Unset the content of an inwin object.
2561 * Unparent and return the content object which was set for this widget.
2563 * @param obj The inwin object
2564 * @return The content that was being used
2566 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2570 /* X specific calls - won't work on non-x engines (return 0) */
2571 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2572 /* smart callbacks called:
2573 * "delete,request" - the user requested to delete the window
2574 * "focus,in" - window got focus
2575 * "focus,out" - window lost focus
2576 * "moved" - window that holds the canvas was moved
2582 * @image html img/widget/bg/preview-00.png
2583 * @image latex img/widget/bg/preview-00.eps
2585 * @brief Background object, used for setting a solid color, image or Edje
2586 * group as background to a window or any container object.
2588 * The bg object is used for setting a solid background to a window or
2589 * packing into any container object. It works just like an image, but has
2590 * some properties useful to a background, like setting it to tiled,
2591 * centered, scaled or stretched.
2593 * Here is some sample code using it:
2594 * @li @ref bg_01_example_page
2595 * @li @ref bg_02_example_page
2596 * @li @ref bg_03_example_page
2600 typedef enum _Elm_Bg_Option
2602 ELM_BG_OPTION_CENTER, /**< center the background */
2603 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2604 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2605 ELM_BG_OPTION_TILE /**< tile background at its original size */
2609 * Add a new background to the parent
2611 * @param parent The parent object
2612 * @return The new object or NULL if it cannot be created
2616 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2619 * Set the file (image or edje) used for the background
2621 * @param obj The bg object
2622 * @param file The file path
2623 * @param group Optional key (group in Edje) within the file
2625 * This sets the image file used in the background object. The image (or edje)
2626 * will be stretched (retaining aspect if its an image file) to completely fill
2627 * the bg object. This may mean some parts are not visible.
2629 * @note Once the image of @p obj is set, a previously set one will be deleted,
2630 * even if @p file is NULL.
2634 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2637 * Get the file (image or edje) used for the background
2639 * @param obj The bg object
2640 * @param file The file path
2641 * @param group Optional key (group in Edje) within the file
2645 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2648 * Set the option used for the background image
2650 * @param obj The bg object
2651 * @param option The desired background option (TILE, SCALE)
2653 * This sets the option used for manipulating the display of the background
2654 * image. The image can be tiled or scaled.
2658 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2661 * Get the option used for the background image
2663 * @param obj The bg object
2664 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2668 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2670 * Set the option used for the background color
2672 * @param obj The bg object
2677 * This sets the color used for the background rectangle. Its range goes
2682 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2684 * Get the option used for the background color
2686 * @param obj The bg object
2693 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2696 * Set the overlay object used for the background object.
2698 * @param obj The bg object
2699 * @param overlay The overlay object
2701 * This provides a way for elm_bg to have an 'overlay' that will be on top
2702 * of the bg. Once the over object is set, a previously set one will be
2703 * deleted, even if you set the new one to NULL. If you want to keep that
2704 * old content object, use the elm_bg_overlay_unset() function.
2709 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2712 * Get the overlay object used for the background object.
2714 * @param obj The bg object
2715 * @return The content that is being used
2717 * Return the content object which is set for this widget
2721 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2724 * Get the overlay object used for the background object.
2726 * @param obj The bg object
2727 * @return The content that was being used
2729 * Unparent and return the overlay object which was set for this widget
2733 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2736 * Set the size of the pixmap representation of the image.
2738 * This option just makes sense if an image is going to be set in the bg.
2740 * @param obj The bg object
2741 * @param w The new width of the image pixmap representation.
2742 * @param h The new height of the image pixmap representation.
2744 * This function sets a new size for pixmap representation of the given bg
2745 * image. It allows the image to be loaded already in the specified size,
2746 * reducing the memory usage and load time when loading a big image with load
2747 * size set to a smaller size.
2749 * NOTE: this is just a hint, the real size of the pixmap may differ
2750 * depending on the type of image being loaded, being bigger than requested.
2754 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2755 /* smart callbacks called:
2759 * @defgroup Icon Icon
2761 * @image html img/widget/icon/preview-00.png
2762 * @image latex img/widget/icon/preview-00.eps
2764 * An object that provides standard icon images (delete, edit, arrows, etc.)
2765 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2767 * The icon image requested can be in the elementary theme, or in the
2768 * freedesktop.org paths. It's possible to set the order of preference from
2769 * where the image will be used.
2771 * This API is very similar to @ref Image, but with ready to use images.
2773 * Default images provided by the theme are described below.
2775 * The first list contains icons that were first intended to be used in
2776 * toolbars, but can be used in many other places too:
2792 * Now some icons that were designed to be used in menus (but again, you can
2793 * use them anywhere else):
2798 * @li menu/arrow_down
2799 * @li menu/arrow_left
2800 * @li menu/arrow_right
2809 * And here we have some media player specific icons:
2810 * @li media_player/forward
2811 * @li media_player/info
2812 * @li media_player/next
2813 * @li media_player/pause
2814 * @li media_player/play
2815 * @li media_player/prev
2816 * @li media_player/rewind
2817 * @li media_player/stop
2819 * Signals that you can add callbacks for are:
2821 * "clicked" - This is called when a user has clicked the icon
2823 * An example of usage for this API follows:
2824 * @li @ref tutorial_icon
2832 typedef enum _Elm_Icon_Type
2839 * @enum _Elm_Icon_Lookup_Order
2840 * @typedef Elm_Icon_Lookup_Order
2842 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2843 * theme, FDO paths, or both?
2847 typedef enum _Elm_Icon_Lookup_Order
2849 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2850 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2851 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2852 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2853 } Elm_Icon_Lookup_Order;
2856 * Add a new icon object to the parent.
2858 * @param parent The parent object
2859 * @return The new object or NULL if it cannot be created
2861 * @see elm_icon_file_set()
2865 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2867 * Set the file that will be used as icon.
2869 * @param obj The icon object
2870 * @param file The path to file that will be used as icon image
2871 * @param group The group that the icon belongs to in edje file
2873 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2875 * @note The icon image set by this function can be changed by
2876 * elm_icon_standard_set().
2878 * @see elm_icon_file_get()
2882 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2884 * Set a location in memory to be used as an icon
2886 * @param obj The icon object
2887 * @param img The binary data that will be used as an image
2888 * @param size The size of binary data @p img
2889 * @param format Optional format of @p img to pass to the image loader
2890 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2892 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2894 * @note The icon image set by this function can be changed by
2895 * elm_icon_standard_set().
2899 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);
2901 * Get the file that will be used as icon.
2903 * @param obj The icon object
2904 * @param file The path to file that will be used as icon icon image
2905 * @param group The group that the icon belongs to in edje file
2907 * @see elm_icon_file_set()
2911 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2912 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2914 * Set the icon by icon standards names.
2916 * @param obj The icon object
2917 * @param name The icon name
2919 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2921 * For example, freedesktop.org defines standard icon names such as "home",
2922 * "network", etc. There can be different icon sets to match those icon
2923 * keys. The @p name given as parameter is one of these "keys", and will be
2924 * used to look in the freedesktop.org paths and elementary theme. One can
2925 * change the lookup order with elm_icon_order_lookup_set().
2927 * If name is not found in any of the expected locations and it is the
2928 * absolute path of an image file, this image will be used.
2930 * @note The icon image set by this function can be changed by
2931 * elm_icon_file_set().
2933 * @see elm_icon_standard_get()
2934 * @see elm_icon_file_set()
2938 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2940 * Get the icon name set by icon standard names.
2942 * @param obj The icon object
2943 * @return The icon name
2945 * If the icon image was set using elm_icon_file_set() instead of
2946 * elm_icon_standard_set(), then this function will return @c NULL.
2948 * @see elm_icon_standard_set()
2952 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2954 * Set the smooth effect for an icon object.
2956 * @param obj The icon object
2957 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2958 * otherwise. Default is @c EINA_TRUE.
2960 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2961 * scaling provides a better resulting image, but is slower.
2963 * The smooth scaling should be disabled when making animations that change
2964 * the icon size, since they will be faster. Animations that don't require
2965 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2966 * is already scaled, since the scaled icon image will be cached).
2968 * @see elm_icon_smooth_get()
2972 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2974 * Get the smooth effect for an icon object.
2976 * @param obj The icon object
2977 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2979 * @see elm_icon_smooth_set()
2983 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2985 * Disable scaling of this object.
2987 * @param obj The icon object.
2988 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2989 * otherwise. Default is @c EINA_FALSE.
2991 * This function disables scaling of the icon object through the function
2992 * elm_object_scale_set(). However, this does not affect the object
2993 * size/resize in any way. For that effect, take a look at
2994 * elm_icon_scale_set().
2996 * @see elm_icon_no_scale_get()
2997 * @see elm_icon_scale_set()
2998 * @see elm_object_scale_set()
3002 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3004 * Get whether scaling is disabled on the object.
3006 * @param obj The icon object
3007 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3009 * @see elm_icon_no_scale_set()
3013 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3015 * Set if the object is (up/down) resizeable.
3017 * @param obj The icon object
3018 * @param scale_up A bool to set if the object is resizeable up. Default is
3020 * @param scale_down A bool to set if the object is resizeable down. Default
3023 * This function limits the icon object resize ability. If @p scale_up is set to
3024 * @c EINA_FALSE, the object can't have its height or width resized to a value
3025 * higher than the original icon size. Same is valid for @p scale_down.
3027 * @see elm_icon_scale_get()
3031 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3033 * Get if the object is (up/down) resizeable.
3035 * @param obj The icon object
3036 * @param scale_up A bool to set if the object is resizeable up
3037 * @param scale_down A bool to set if the object is resizeable down
3039 * @see elm_icon_scale_set()
3043 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3045 * Get the object's image size
3047 * @param obj The icon object
3048 * @param w A pointer to store the width in
3049 * @param h A pointer to store the height in
3053 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3055 * Set if the icon fill the entire object area.
3057 * @param obj The icon object
3058 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3059 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3061 * When the icon object is resized to a different aspect ratio from the
3062 * original icon image, the icon image will still keep its aspect. This flag
3063 * tells how the image should fill the object's area. They are: keep the
3064 * entire icon inside the limits of height and width of the object (@p
3065 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3066 * of the object, and the icon will fill the entire object (@p fill_outside
3069 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3070 * retain property to false. Thus, the icon image will always keep its
3071 * original aspect ratio.
3073 * @see elm_icon_fill_outside_get()
3074 * @see elm_image_fill_outside_set()
3078 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3080 * Get if the object is filled outside.
3082 * @param obj The icon object
3083 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3085 * @see elm_icon_fill_outside_set()
3089 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3091 * Set the prescale size for the icon.
3093 * @param obj The icon object
3094 * @param size The prescale size. This value is used for both width and
3097 * This function sets a new size for pixmap representation of the given
3098 * icon. It allows the icon to be loaded already in the specified size,
3099 * reducing the memory usage and load time when loading a big icon with load
3100 * size set to a smaller size.
3102 * It's equivalent to the elm_bg_load_size_set() function for bg.
3104 * @note this is just a hint, the real size of the pixmap may differ
3105 * depending on the type of icon being loaded, being bigger than requested.
3107 * @see elm_icon_prescale_get()
3108 * @see elm_bg_load_size_set()
3112 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3114 * Get the prescale size for the icon.
3116 * @param obj The icon object
3117 * @return The prescale size
3119 * @see elm_icon_prescale_set()
3123 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3125 * Sets the icon lookup order used by elm_icon_standard_set().
3127 * @param obj The icon object
3128 * @param order The icon lookup order (can be one of
3129 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3130 * or ELM_ICON_LOOKUP_THEME)
3132 * @see elm_icon_order_lookup_get()
3133 * @see Elm_Icon_Lookup_Order
3137 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3139 * Gets the icon lookup order.
3141 * @param obj The icon object
3142 * @return The icon lookup order
3144 * @see elm_icon_order_lookup_set()
3145 * @see Elm_Icon_Lookup_Order
3149 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3156 * @defgroup Image Image
3158 * @image html img/widget/image/preview-00.png
3159 * @image latex img/widget/image/preview-00.eps
3161 * An object that allows one to load an image file to it. It can be used
3162 * anywhere like any other elementary widget.
3164 * This widget provides most of the functionality provided from @ref Bg or @ref
3165 * Icon, but with a slightly different API (use the one that fits better your
3168 * The features not provided by those two other image widgets are:
3169 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3170 * @li change the object orientation with elm_image_orient_set();
3171 * @li and turning the image editable with elm_image_editable_set().
3173 * Signals that you can add callbacks for are:
3175 * @li @c "clicked" - This is called when a user has clicked the image
3177 * An example of usage for this API follows:
3178 * @li @ref tutorial_image
3187 * @enum _Elm_Image_Orient
3188 * @typedef Elm_Image_Orient
3190 * Possible orientation options for elm_image_orient_set().
3192 * @image html elm_image_orient_set.png
3193 * @image latex elm_image_orient_set.eps width=\textwidth
3197 typedef enum _Elm_Image_Orient
3199 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3200 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3201 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3202 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3203 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3204 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3205 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3206 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3210 * Add a new image to the parent.
3212 * @param parent The parent object
3213 * @return The new object or NULL if it cannot be created
3215 * @see elm_image_file_set()
3219 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3221 * Set the file that will be used as image.
3223 * @param obj The image object
3224 * @param file The path to file that will be used as image
3225 * @param group The group that the image belongs in edje file (if it's an
3228 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3230 * @see elm_image_file_get()
3234 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3236 * Get the file that will be used as image.
3238 * @param obj The image object
3239 * @param file The path to file
3240 * @param group The group that the image belongs in edje file
3242 * @see elm_image_file_set()
3246 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3248 * Set the smooth effect for an image.
3250 * @param obj The image object
3251 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3252 * otherwise. Default is @c EINA_TRUE.
3254 * Set the scaling algorithm to be used when scaling the image. Smooth
3255 * scaling provides a better resulting image, but is slower.
3257 * The smooth scaling should be disabled when making animations that change
3258 * the image size, since it will be faster. Animations that don't require
3259 * resizing of the image can keep the smooth scaling enabled (even if the
3260 * image is already scaled, since the scaled image will be cached).
3262 * @see elm_image_smooth_get()
3266 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3268 * Get the smooth effect for an image.
3270 * @param obj The image object
3271 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3273 * @see elm_image_smooth_get()
3277 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3279 * Gets the current size of the image.
3281 * @param obj The image object.
3282 * @param w Pointer to store width, or NULL.
3283 * @param h Pointer to store height, or NULL.
3285 * This is the real size of the image, not the size of the object.
3287 * On error, neither w or h will be written.
3291 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3293 * Disable scaling of this object.
3295 * @param obj The image object.
3296 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3297 * otherwise. Default is @c EINA_FALSE.
3299 * This function disables scaling of the elm_image widget through the
3300 * function elm_object_scale_set(). However, this does not affect the widget
3301 * size/resize in any way. For that effect, take a look at
3302 * elm_image_scale_set().
3304 * @see elm_image_no_scale_get()
3305 * @see elm_image_scale_set()
3306 * @see elm_object_scale_set()
3310 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3312 * Get whether scaling is disabled on the object.
3314 * @param obj The image object
3315 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3317 * @see elm_image_no_scale_set()
3321 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3323 * Set if the object is (up/down) resizeable.
3325 * @param obj The image object
3326 * @param scale_up A bool to set if the object is resizeable up. Default is
3328 * @param scale_down A bool to set if the object is resizeable down. Default
3331 * This function limits the image resize ability. If @p scale_up is set to
3332 * @c EINA_FALSE, the object can't have its height or width resized to a value
3333 * higher than the original image size. Same is valid for @p scale_down.
3335 * @see elm_image_scale_get()
3339 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3341 * Get if the object is (up/down) resizeable.
3343 * @param obj The image object
3344 * @param scale_up A bool to set if the object is resizeable up
3345 * @param scale_down A bool to set if the object is resizeable down
3347 * @see elm_image_scale_set()
3351 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3353 * Set if the image fill the entire object area when keeping the aspect ratio.
3355 * @param obj The image object
3356 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3357 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3359 * When the image should keep its aspect ratio even if resized to another
3360 * aspect ratio, there are two possibilities to resize it: keep the entire
3361 * image inside the limits of height and width of the object (@p fill_outside
3362 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3363 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3365 * @note This option will have no effect if
3366 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3368 * @see elm_image_fill_outside_get()
3369 * @see elm_image_aspect_ratio_retained_set()
3373 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3375 * Get if the object is filled outside
3377 * @param obj The image object
3378 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3380 * @see elm_image_fill_outside_set()
3384 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3386 * Set the prescale size for the image
3388 * @param obj The image object
3389 * @param size The prescale size. This value is used for both width and
3392 * This function sets a new size for pixmap representation of the given
3393 * image. It allows the image to be loaded already in the specified size,
3394 * reducing the memory usage and load time when loading a big image with load
3395 * size set to a smaller size.
3397 * It's equivalent to the elm_bg_load_size_set() function for bg.
3399 * @note this is just a hint, the real size of the pixmap may differ
3400 * depending on the type of image being loaded, being bigger than requested.
3402 * @see elm_image_prescale_get()
3403 * @see elm_bg_load_size_set()
3407 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3409 * Get the prescale size for the image
3411 * @param obj The image object
3412 * @return The prescale size
3414 * @see elm_image_prescale_set()
3418 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3420 * Set the image orientation.
3422 * @param obj The image object
3423 * @param orient The image orientation
3424 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3425 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3426 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3427 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3428 * Default is #ELM_IMAGE_ORIENT_NONE.
3430 * This function allows to rotate or flip the given image.
3432 * @see elm_image_orient_get()
3433 * @see @ref Elm_Image_Orient
3437 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3439 * Get the image orientation.
3441 * @param obj The image object
3442 * @return The image orientation
3443 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3444 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3445 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3446 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3448 * @see elm_image_orient_set()
3449 * @see @ref Elm_Image_Orient
3453 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3455 * Make the image 'editable'.
3457 * @param obj Image object.
3458 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3460 * This means the image is a valid drag target for drag and drop, and can be
3461 * cut or pasted too.
3465 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3467 * Make the image 'editable'.
3469 * @param obj Image object.
3470 * @return Editability.
3472 * This means the image is a valid drag target for drag and drop, and can be
3473 * cut or pasted too.
3477 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3479 * Get the basic Evas_Image object from this object (widget).
3481 * @param obj The image object to get the inlined image from
3482 * @return The inlined image object, or NULL if none exists
3484 * This function allows one to get the underlying @c Evas_Object of type
3485 * Image from this elementary widget. It can be useful to do things like get
3486 * the pixel data, save the image to a file, etc.
3488 * @note Be careful to not manipulate it, as it is under control of
3493 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3495 * Set whether the original aspect ratio of the image should be kept on resize.
3497 * @param obj The image object.
3498 * @param retained @c EINA_TRUE if the image should retain the aspect,
3499 * @c EINA_FALSE otherwise.
3501 * The original aspect ratio (width / height) of the image is usually
3502 * distorted to match the object's size. Enabling this option will retain
3503 * this original aspect, and the way that the image is fit into the object's
3504 * area depends on the option set by elm_image_fill_outside_set().
3506 * @see elm_image_aspect_ratio_retained_get()
3507 * @see elm_image_fill_outside_set()
3511 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3513 * Get if the object retains the original aspect ratio.
3515 * @param obj The image object.
3516 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3521 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3523 /* smart callbacks called:
3524 * "clicked" - the user clicked the image
3532 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3534 typedef enum _Elm_GLView_Mode
3536 ELM_GLVIEW_ALPHA = 1,
3537 ELM_GLVIEW_DEPTH = 2,
3538 ELM_GLVIEW_STENCIL = 4
3542 * Defines a policy for the glview resizing.
3544 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3546 typedef enum _Elm_GLView_Resize_Policy
3548 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3549 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3550 } Elm_GLView_Resize_Policy;
3552 typedef enum _Elm_GLView_Render_Policy
3554 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3555 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3556 } Elm_GLView_Render_Policy;
3559 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3560 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3561 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3562 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3563 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3564 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3565 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3566 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3567 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3568 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3569 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3570 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3576 * @image html img/widget/box/preview-00.png
3577 * @image latex img/widget/box/preview-00.eps width=\textwidth
3579 * @image html img/box.png
3580 * @image latex img/box.eps width=\textwidth
3582 * A box arranges objects in a linear fashion, governed by a layout function
3583 * that defines the details of this arrangement.
3585 * By default, the box will use an internal function to set the layout to
3586 * a single row, either vertical or horizontal. This layout is affected
3587 * by a number of parameters, such as the homogeneous flag set by
3588 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3589 * elm_box_align_set() and the hints set to each object in the box.
3591 * For this default layout, it's possible to change the orientation with
3592 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3593 * placing its elements ordered from top to bottom. When horizontal is set,
3594 * the order will go from left to right. If the box is set to be
3595 * homogeneous, every object in it will be assigned the same space, that
3596 * of the largest object. Padding can be used to set some spacing between
3597 * the cell given to each object. The alignment of the box, set with
3598 * elm_box_align_set(), determines how the bounding box of all the elements
3599 * will be placed within the space given to the box widget itself.
3601 * The size hints of each object also affect how they are placed and sized
3602 * within the box. evas_object_size_hint_min_set() will give the minimum
3603 * size the object can have, and the box will use it as the basis for all
3604 * latter calculations. Elementary widgets set their own minimum size as
3605 * needed, so there's rarely any need to use it manually.
3607 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3608 * used to tell whether the object will be allocated the minimum size it
3609 * needs or if the space given to it should be expanded. It's important
3610 * to realize that expanding the size given to the object is not the same
3611 * thing as resizing the object. It could very well end being a small
3612 * widget floating in a much larger empty space. If not set, the weight
3613 * for objects will normally be 0.0 for both axis, meaning the widget will
3614 * not be expanded. To take as much space possible, set the weight to
3615 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3617 * Besides how much space each object is allocated, it's possible to control
3618 * how the widget will be placed within that space using
3619 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3620 * for both axis, meaning the object will be centered, but any value from
3621 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3622 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3623 * is -1.0, means the object will be resized to fill the entire space it
3626 * In addition, customized functions to define the layout can be set, which
3627 * allow the application developer to organize the objects within the box
3628 * in any number of ways.
3630 * The special elm_box_layout_transition() function can be used
3631 * to switch from one layout to another, animating the motion of the
3632 * children of the box.
3634 * @note Objects should not be added to box objects using _add() calls.
3636 * Some examples on how to use boxes follow:
3637 * @li @ref box_example_01
3638 * @li @ref box_example_02
3643 * @typedef Elm_Box_Transition
3645 * Opaque handler containing the parameters to perform an animated
3646 * transition of the layout the box uses.
3648 * @see elm_box_transition_new()
3649 * @see elm_box_layout_set()
3650 * @see elm_box_layout_transition()
3652 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3655 * Add a new box to the parent
3657 * By default, the box will be in vertical mode and non-homogeneous.
3659 * @param parent The parent object
3660 * @return The new object or NULL if it cannot be created
3662 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3664 * Set the horizontal orientation
3666 * By default, box object arranges their contents vertically from top to
3668 * By calling this function with @p horizontal as EINA_TRUE, the box will
3669 * become horizontal, arranging contents from left to right.
3671 * @note This flag is ignored if a custom layout function is set.
3673 * @param obj The box object
3674 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3675 * EINA_FALSE = vertical)
3677 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3679 * Get the horizontal orientation
3681 * @param obj The box object
3682 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3684 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3686 * Set the box to arrange its children homogeneously
3688 * If enabled, homogeneous layout makes all items the same size, according
3689 * to the size of the largest of its children.
3691 * @note This flag is ignored if a custom layout function is set.
3693 * @param obj The box object
3694 * @param homogeneous The homogeneous flag
3696 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3698 * Get whether the box is using homogeneous mode or not
3700 * @param obj The box object
3701 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3703 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3704 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3705 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3707 * Add an object to the beginning of the pack list
3709 * Pack @p subobj into the box @p obj, placing it first in the list of
3710 * children objects. The actual position the object will get on screen
3711 * depends on the layout used. If no custom layout is set, it will be at
3712 * the top or left, depending if the box is vertical or horizontal,
3715 * @param obj The box object
3716 * @param subobj The object to add to the box
3718 * @see elm_box_pack_end()
3719 * @see elm_box_pack_before()
3720 * @see elm_box_pack_after()
3721 * @see elm_box_unpack()
3722 * @see elm_box_unpack_all()
3723 * @see elm_box_clear()
3725 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3727 * Add an object at the end of the pack list
3729 * Pack @p subobj into the box @p obj, placing it last in the list of
3730 * children objects. The actual position the object will get on screen
3731 * depends on the layout used. If no custom layout is set, it will be at
3732 * the bottom or right, depending if the box is vertical or horizontal,
3735 * @param obj The box object
3736 * @param subobj The object to add to the box
3738 * @see elm_box_pack_start()
3739 * @see elm_box_pack_before()
3740 * @see elm_box_pack_after()
3741 * @see elm_box_unpack()
3742 * @see elm_box_unpack_all()
3743 * @see elm_box_clear()
3745 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3747 * Adds an object to the box before the indicated object
3749 * This will add the @p subobj to the box indicated before the object
3750 * indicated with @p before. If @p before is not already in the box, results
3751 * are undefined. Before means either to the left of the indicated object or
3752 * above it depending on orientation.
3754 * @param obj The box object
3755 * @param subobj The object to add to the box
3756 * @param before The object before which to add it
3758 * @see elm_box_pack_start()
3759 * @see elm_box_pack_end()
3760 * @see elm_box_pack_after()
3761 * @see elm_box_unpack()
3762 * @see elm_box_unpack_all()
3763 * @see elm_box_clear()
3765 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3767 * Adds an object to the box after the indicated object
3769 * This will add the @p subobj to the box indicated after the object
3770 * indicated with @p after. If @p after is not already in the box, results
3771 * are undefined. After means either to the right of the indicated object or
3772 * below it depending on orientation.
3774 * @param obj The box object
3775 * @param subobj The object to add to the box
3776 * @param after The object after which to add it
3778 * @see elm_box_pack_start()
3779 * @see elm_box_pack_end()
3780 * @see elm_box_pack_before()
3781 * @see elm_box_unpack()
3782 * @see elm_box_unpack_all()
3783 * @see elm_box_clear()
3785 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3787 * Clear the box of all children
3789 * Remove all the elements contained by the box, deleting the respective
3792 * @param obj The box object
3794 * @see elm_box_unpack()
3795 * @see elm_box_unpack_all()
3797 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3801 * Remove the object given by @p subobj from the box @p obj without
3804 * @param obj The box object
3806 * @see elm_box_unpack_all()
3807 * @see elm_box_clear()
3809 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3811 * Remove all items from the box, without deleting them
3813 * Clear the box from all children, but don't delete the respective objects.
3814 * If no other references of the box children exist, the objects will never
3815 * be deleted, and thus the application will leak the memory. Make sure
3816 * when using this function that you hold a reference to all the objects
3817 * in the box @p obj.
3819 * @param obj The box object
3821 * @see elm_box_clear()
3822 * @see elm_box_unpack()
3824 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3826 * Retrieve a list of the objects packed into the box
3828 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3829 * The order of the list corresponds to the packing order the box uses.
3831 * You must free this list with eina_list_free() once you are done with it.
3833 * @param obj The box object
3835 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3837 * Set the space (padding) between the box's elements.
3839 * Extra space in pixels that will be added between a box child and its
3840 * neighbors after its containing cell has been calculated. This padding
3841 * is set for all elements in the box, besides any possible padding that
3842 * individual elements may have through their size hints.
3844 * @param obj The box object
3845 * @param horizontal The horizontal space between elements
3846 * @param vertical The vertical space between elements
3848 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3850 * Get the space (padding) between the box's elements.
3852 * @param obj The box object
3853 * @param horizontal The horizontal space between elements
3854 * @param vertical The vertical space between elements
3856 * @see elm_box_padding_set()
3858 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3860 * Set the alignment of the whole bouding box of contents.
3862 * Sets how the bounding box containing all the elements of the box, after
3863 * their sizes and position has been calculated, will be aligned within
3864 * the space given for the whole box widget.
3866 * @param obj The box object
3867 * @param horizontal The horizontal alignment of elements
3868 * @param vertical The vertical alignment of elements
3870 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3872 * Get the alignment of the whole bouding box of contents.
3874 * @param obj The box object
3875 * @param horizontal The horizontal alignment of elements
3876 * @param vertical The vertical alignment of elements
3878 * @see elm_box_align_set()
3880 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3883 * Set the layout defining function to be used by the box
3885 * Whenever anything changes that requires the box in @p obj to recalculate
3886 * the size and position of its elements, the function @p cb will be called
3887 * to determine what the layout of the children will be.
3889 * Once a custom function is set, everything about the children layout
3890 * is defined by it. The flags set by elm_box_horizontal_set() and
3891 * elm_box_homogeneous_set() no longer have any meaning, and the values
3892 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3893 * layout function to decide if they are used and how. These last two
3894 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3895 * passed to @p cb. The @c Evas_Object the function receives is not the
3896 * Elementary widget, but the internal Evas Box it uses, so none of the
3897 * functions described here can be used on it.
3899 * Any of the layout functions in @c Evas can be used here, as well as the
3900 * special elm_box_layout_transition().
3902 * The final @p data argument received by @p cb is the same @p data passed
3903 * here, and the @p free_data function will be called to free it
3904 * whenever the box is destroyed or another layout function is set.
3906 * Setting @p cb to NULL will revert back to the default layout function.
3908 * @param obj The box object
3909 * @param cb The callback function used for layout
3910 * @param data Data that will be passed to layout function
3911 * @param free_data Function called to free @p data
3913 * @see elm_box_layout_transition()
3915 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);
3917 * Special layout function that animates the transition from one layout to another
3919 * Normally, when switching the layout function for a box, this will be
3920 * reflected immediately on screen on the next render, but it's also
3921 * possible to do this through an animated transition.
3923 * This is done by creating an ::Elm_Box_Transition and setting the box
3924 * layout to this function.
3928 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3929 * evas_object_box_layout_vertical, // start
3930 * NULL, // data for initial layout
3931 * NULL, // free function for initial data
3932 * evas_object_box_layout_horizontal, // end
3933 * NULL, // data for final layout
3934 * NULL, // free function for final data
3935 * anim_end, // will be called when animation ends
3936 * NULL); // data for anim_end function\
3937 * elm_box_layout_set(box, elm_box_layout_transition, t,
3938 * elm_box_transition_free);
3941 * @note This function can only be used with elm_box_layout_set(). Calling
3942 * it directly will not have the expected results.
3944 * @see elm_box_transition_new
3945 * @see elm_box_transition_free
3946 * @see elm_box_layout_set
3948 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3950 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3952 * If you want to animate the change from one layout to another, you need
3953 * to set the layout function of the box to elm_box_layout_transition(),
3954 * passing as user data to it an instance of ::Elm_Box_Transition with the
3955 * necessary information to perform this animation. The free function to
3956 * set for the layout is elm_box_transition_free().
3958 * The parameters to create an ::Elm_Box_Transition sum up to how long
3959 * will it be, in seconds, a layout function to describe the initial point,
3960 * another for the final position of the children and one function to be
3961 * called when the whole animation ends. This last function is useful to
3962 * set the definitive layout for the box, usually the same as the end
3963 * layout for the animation, but could be used to start another transition.
3965 * @param start_layout The layout function that will be used to start the animation
3966 * @param start_layout_data The data to be passed the @p start_layout function
3967 * @param start_layout_free_data Function to free @p start_layout_data
3968 * @param end_layout The layout function that will be used to end the animation
3969 * @param end_layout_free_data The data to be passed the @p end_layout function
3970 * @param end_layout_free_data Function to free @p end_layout_data
3971 * @param transition_end_cb Callback function called when animation ends
3972 * @param transition_end_data Data to be passed to @p transition_end_cb
3973 * @return An instance of ::Elm_Box_Transition
3975 * @see elm_box_transition_new
3976 * @see elm_box_layout_transition
3978 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);
3980 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3982 * This function is mostly useful as the @c free_data parameter in
3983 * elm_box_layout_set() when elm_box_layout_transition().
3985 * @param data The Elm_Box_Transition instance to be freed.
3987 * @see elm_box_transition_new
3988 * @see elm_box_layout_transition
3990 EAPI void elm_box_transition_free(void *data);
3997 * @defgroup Button Button
3999 * @image html img/widget/button/preview-00.png
4000 * @image latex img/widget/button/preview-00.eps
4001 * @image html img/widget/button/preview-01.png
4002 * @image latex img/widget/button/preview-01.eps
4003 * @image html img/widget/button/preview-02.png
4004 * @image latex img/widget/button/preview-02.eps
4006 * This is a push-button. Press it and run some function. It can contain
4007 * a simple label and icon object and it also has an autorepeat feature.
4009 * This widgets emits the following signals:
4010 * @li "clicked": the user clicked the button (press/release).
4011 * @li "repeated": the user pressed the button without releasing it.
4012 * @li "pressed": button was pressed.
4013 * @li "unpressed": button was released after being pressed.
4014 * In all three cases, the @c event parameter of the callback will be
4017 * Also, defined in the default theme, the button has the following styles
4019 * @li default: a normal button.
4020 * @li anchor: Like default, but the button fades away when the mouse is not
4021 * over it, leaving only the text or icon.
4022 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4023 * continuous look across its options.
4024 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4026 * Follow through a complete example @ref button_example_01 "here".
4030 * Add a new button to the parent's canvas
4032 * @param parent The parent object
4033 * @return The new object or NULL if it cannot be created
4035 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4037 * Set the label used in the button
4039 * The passed @p label can be NULL to clean any existing text in it and
4040 * leave the button as an icon only object.
4042 * @param obj The button object
4043 * @param label The text will be written on the button
4044 * @deprecated use elm_object_text_set() instead.
4046 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4048 * Get the label set for the button
4050 * The string returned is an internal pointer and should not be freed or
4051 * altered. It will also become invalid when the button is destroyed.
4052 * The string returned, if not NULL, is a stringshare, so if you need to
4053 * keep it around even after the button is destroyed, you can use
4054 * eina_stringshare_ref().
4056 * @param obj The button object
4057 * @return The text set to the label, or NULL if nothing is set
4058 * @deprecated use elm_object_text_set() instead.
4060 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4062 * Set the icon used for the button
4064 * Setting a new icon will delete any other that was previously set, making
4065 * any reference to them invalid. If you need to maintain the previous
4066 * object alive, unset it first with elm_button_icon_unset().
4068 * @param obj The button object
4069 * @param icon The icon object for the button
4071 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4073 * Get the icon used for the button
4075 * Return the icon object which is set for this widget. If the button is
4076 * destroyed or another icon is set, the returned object will be deleted
4077 * and any reference to it will be invalid.
4079 * @param obj The button object
4080 * @return The icon object that is being used
4082 * @see elm_button_icon_unset()
4084 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4086 * Remove the icon set without deleting it and return the object
4088 * This function drops the reference the button holds of the icon object
4089 * and returns this last object. It is used in case you want to remove any
4090 * icon, or set another one, without deleting the actual object. The button
4091 * will be left without an icon set.
4093 * @param obj The button object
4094 * @return The icon object that was being used
4096 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4098 * Turn on/off the autorepeat event generated when the button is kept pressed
4100 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4101 * signal when they are clicked.
4103 * When on, keeping a button pressed will continuously emit a @c repeated
4104 * signal until the button is released. The time it takes until it starts
4105 * emitting the signal is given by
4106 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4107 * new emission by elm_button_autorepeat_gap_timeout_set().
4109 * @param obj The button object
4110 * @param on A bool to turn on/off the event
4112 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4114 * Get whether the autorepeat feature is enabled
4116 * @param obj The button object
4117 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4119 * @see elm_button_autorepeat_set()
4121 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4123 * Set the initial timeout before the autorepeat event is generated
4125 * Sets the timeout, in seconds, since the button is pressed until the
4126 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4127 * won't be any delay and the even will be fired the moment the button is
4130 * @param obj The button object
4131 * @param t Timeout in seconds
4133 * @see elm_button_autorepeat_set()
4134 * @see elm_button_autorepeat_gap_timeout_set()
4136 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4138 * Get the initial timeout before the autorepeat event is generated
4140 * @param obj The button object
4141 * @return Timeout in seconds
4143 * @see elm_button_autorepeat_initial_timeout_set()
4145 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4147 * Set the interval between each generated autorepeat event
4149 * After the first @c repeated event is fired, all subsequent ones will
4150 * follow after a delay of @p t seconds for each.
4152 * @param obj The button object
4153 * @param t Interval in seconds
4155 * @see elm_button_autorepeat_initial_timeout_set()
4157 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4159 * Get the interval between each generated autorepeat event
4161 * @param obj The button object
4162 * @return Interval in seconds
4164 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4170 * @defgroup File_Selector_Button File Selector Button
4172 * @image html img/widget/fileselector_button/preview-00.png
4173 * @image latex img/widget/fileselector_button/preview-00.eps
4174 * @image html img/widget/fileselector_button/preview-01.png
4175 * @image latex img/widget/fileselector_button/preview-01.eps
4176 * @image html img/widget/fileselector_button/preview-02.png
4177 * @image latex img/widget/fileselector_button/preview-02.eps
4179 * This is a button that, when clicked, creates an Elementary
4180 * window (or inner window) <b> with a @ref Fileselector "file
4181 * selector widget" within</b>. When a file is chosen, the (inner)
4182 * window is closed and the button emits a signal having the
4183 * selected file as it's @c event_info.
4185 * This widget encapsulates operations on its internal file
4186 * selector on its own API. There is less control over its file
4187 * selector than that one would have instatiating one directly.
4189 * The following styles are available for this button:
4192 * @li @c "hoversel_vertical"
4193 * @li @c "hoversel_vertical_entry"
4195 * Smart callbacks one can register to:
4196 * - @c "file,chosen" - the user has selected a path, whose string
4197 * pointer comes as the @c event_info data (a stringshared
4200 * Here is an example on its usage:
4201 * @li @ref fileselector_button_example
4203 * @see @ref File_Selector_Entry for a similar widget.
4208 * Add a new file selector button widget to the given parent
4209 * Elementary (container) object
4211 * @param parent The parent object
4212 * @return a new file selector button widget handle or @c NULL, on
4215 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4218 * Set the label for a given file selector button widget
4220 * @param obj The file selector button widget
4221 * @param label The text label to be displayed on @p obj
4223 * @deprecated use elm_object_text_set() instead.
4225 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4228 * Get the label set for a given file selector button widget
4230 * @param obj The file selector button widget
4231 * @return The button label
4233 * @deprecated use elm_object_text_set() instead.
4235 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4238 * Set the icon on a given file selector button widget
4240 * @param obj The file selector button widget
4241 * @param icon The icon object for the button
4243 * Once the icon object is set, a previously set one will be
4244 * deleted. If you want to keep the latter, use the
4245 * elm_fileselector_button_icon_unset() function.
4247 * @see elm_fileselector_button_icon_get()
4249 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4252 * Get the icon set for a given file selector button widget
4254 * @param obj The file selector button widget
4255 * @return The icon object currently set on @p obj or @c NULL, if
4258 * @see elm_fileselector_button_icon_set()
4260 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4263 * Unset the icon used in a given file selector button widget
4265 * @param obj The file selector button widget
4266 * @return The icon object that was being used on @p obj or @c
4269 * Unparent and return the icon object which was set for this
4272 * @see elm_fileselector_button_icon_set()
4274 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4277 * Set the title for a given file selector button widget's window
4279 * @param obj The file selector button widget
4280 * @param title The title string
4282 * This will change the window's title, when the file selector pops
4283 * out after a click on the button. Those windows have the default
4284 * (unlocalized) value of @c "Select a file" as titles.
4286 * @note It will only take any effect if the file selector
4287 * button widget is @b not under "inwin mode".
4289 * @see elm_fileselector_button_window_title_get()
4291 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4294 * Get the title set for a given file selector button widget's
4297 * @param obj The file selector button widget
4298 * @return Title of the file selector button's window
4300 * @see elm_fileselector_button_window_title_get() for more details
4302 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4305 * Set the size of a given file selector button widget's window,
4306 * holding the file selector itself.
4308 * @param obj The file selector button widget
4309 * @param width The window's width
4310 * @param height The window's height
4312 * @note it will only take any effect if the file selector button
4313 * widget is @b not under "inwin mode". The default size for the
4314 * window (when applicable) is 400x400 pixels.
4316 * @see elm_fileselector_button_window_size_get()
4318 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4321 * Get the size of a given file selector button widget's window,
4322 * holding the file selector itself.
4324 * @param obj The file selector button widget
4325 * @param width Pointer into which to store the width value
4326 * @param height Pointer into which to store the height value
4328 * @note Use @c NULL pointers on the size values you're not
4329 * interested in: they'll be ignored by the function.
4331 * @see elm_fileselector_button_window_size_set(), for more details
4333 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4336 * Set the initial file system path for a given file selector
4339 * @param obj The file selector button widget
4340 * @param path The path string
4342 * It must be a <b>directory</b> path, which will have the contents
4343 * displayed initially in the file selector's view, when invoked
4344 * from @p obj. The default initial path is the @c "HOME"
4345 * environment variable's value.
4347 * @see elm_fileselector_button_path_get()
4349 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4352 * Get the initial file system path set for a given file selector
4355 * @param obj The file selector button widget
4356 * @return path The path string
4358 * @see elm_fileselector_button_path_set() for more details
4360 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4363 * Enable/disable a tree view in the given file selector button
4364 * widget's internal file selector
4366 * @param obj The file selector button widget
4367 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4370 * This has the same effect as elm_fileselector_expandable_set(),
4371 * but now applied to a file selector button's internal file
4374 * @note There's no way to put a file selector button's internal
4375 * file selector in "grid mode", as one may do with "pure" file
4378 * @see elm_fileselector_expandable_get()
4380 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4383 * Get whether tree view is enabled for the given file selector
4384 * button widget's internal file selector
4386 * @param obj The file selector button widget
4387 * @return @c EINA_TRUE if @p obj widget's internal file selector
4388 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4390 * @see elm_fileselector_expandable_set() for more details
4392 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4395 * Set whether a given file selector button widget's internal file
4396 * selector is to display folders only or the directory contents,
4399 * @param obj The file selector button widget
4400 * @param only @c EINA_TRUE to make @p obj widget's internal file
4401 * selector only display directories, @c EINA_FALSE to make files
4402 * to be displayed in it too
4404 * This has the same effect as elm_fileselector_folder_only_set(),
4405 * but now applied to a file selector button's internal file
4408 * @see elm_fileselector_folder_only_get()
4410 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4413 * Get whether a given file selector button widget's internal file
4414 * selector is displaying folders only or the directory contents,
4417 * @param obj The file selector button widget
4418 * @return @c EINA_TRUE if @p obj widget's internal file
4419 * selector is only displaying directories, @c EINA_FALSE if files
4420 * are being displayed in it too (and on errors)
4422 * @see elm_fileselector_button_folder_only_set() for more details
4424 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4427 * Enable/disable the file name entry box where the user can type
4428 * in a name for a file, in a given file selector button widget's
4429 * internal file selector.
4431 * @param obj The file selector button widget
4432 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4433 * file selector a "saving dialog", @c EINA_FALSE otherwise
4435 * This has the same effect as elm_fileselector_is_save_set(),
4436 * but now applied to a file selector button's internal file
4439 * @see elm_fileselector_is_save_get()
4441 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4444 * Get whether the given file selector button widget's internal
4445 * file selector is in "saving dialog" mode
4447 * @param obj The file selector button widget
4448 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4449 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4452 * @see elm_fileselector_button_is_save_set() for more details
4454 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4457 * Set whether a given file selector button widget's internal file
4458 * selector will raise an Elementary "inner window", instead of a
4459 * dedicated Elementary window. By default, it won't.
4461 * @param obj The file selector button widget
4462 * @param value @c EINA_TRUE to make it use an inner window, @c
4463 * EINA_TRUE to make it use a dedicated window
4465 * @see elm_win_inwin_add() for more information on inner windows
4466 * @see elm_fileselector_button_inwin_mode_get()
4468 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4471 * Get whether a given file selector button widget's internal file
4472 * selector will raise an Elementary "inner window", instead of a
4473 * dedicated Elementary window.
4475 * @param obj The file selector button widget
4476 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4477 * if it will use a dedicated window
4479 * @see elm_fileselector_button_inwin_mode_set() for more details
4481 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4488 * @defgroup File_Selector_Entry File Selector Entry
4490 * @image html img/widget/fileselector_entry/preview-00.png
4491 * @image latex img/widget/fileselector_entry/preview-00.eps
4493 * This is an entry made to be filled with or display a <b>file
4494 * system path string</b>. Besides the entry itself, the widget has
4495 * a @ref File_Selector_Button "file selector button" on its side,
4496 * which will raise an internal @ref Fileselector "file selector widget",
4497 * when clicked, for path selection aided by file system
4500 * This file selector may appear in an Elementary window or in an
4501 * inner window. When a file is chosen from it, the (inner) window
4502 * is closed and the selected file's path string is exposed both as
4503 * an smart event and as the new text on the entry.
4505 * This widget encapsulates operations on its internal file
4506 * selector on its own API. There is less control over its file
4507 * selector than that one would have instatiating one directly.
4509 * Smart callbacks one can register to:
4510 * - @c "changed" - The text within the entry was changed
4511 * - @c "activated" - The entry has had editing finished and
4512 * changes are to be "committed"
4513 * - @c "press" - The entry has been clicked
4514 * - @c "longpressed" - The entry has been clicked (and held) for a
4516 * - @c "clicked" - The entry has been clicked
4517 * - @c "clicked,double" - The entry has been double clicked
4518 * - @c "focused" - The entry has received focus
4519 * - @c "unfocused" - The entry has lost focus
4520 * - @c "selection,paste" - A paste action has occurred on the
4522 * - @c "selection,copy" - A copy action has occurred on the entry
4523 * - @c "selection,cut" - A cut action has occurred on the entry
4524 * - @c "unpressed" - The file selector entry's button was released
4525 * after being pressed.
4526 * - @c "file,chosen" - The user has selected a path via the file
4527 * selector entry's internal file selector, whose string pointer
4528 * comes as the @c event_info data (a stringshared string)
4530 * Here is an example on its usage:
4531 * @li @ref fileselector_entry_example
4533 * @see @ref File_Selector_Button for a similar widget.
4538 * Add a new file selector entry widget to the given parent
4539 * Elementary (container) object
4541 * @param parent The parent object
4542 * @return a new file selector entry widget handle or @c NULL, on
4545 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4548 * Set the label for a given file selector entry widget's button
4550 * @param obj The file selector entry widget
4551 * @param label The text label to be displayed on @p obj widget's
4554 * @deprecated use elm_object_text_set() instead.
4556 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4559 * Get the label set for a given file selector entry widget's button
4561 * @param obj The file selector entry widget
4562 * @return The widget button's label
4564 * @deprecated use elm_object_text_set() instead.
4566 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4569 * Set the icon on a given file selector entry widget's button
4571 * @param obj The file selector entry widget
4572 * @param icon The icon object for the entry's button
4574 * Once the icon object is set, a previously set one will be
4575 * deleted. If you want to keep the latter, use the
4576 * elm_fileselector_entry_button_icon_unset() function.
4578 * @see elm_fileselector_entry_button_icon_get()
4580 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4583 * Get the icon set for a given file selector entry widget's button
4585 * @param obj The file selector entry widget
4586 * @return The icon object currently set on @p obj widget's button
4587 * or @c NULL, if none is
4589 * @see elm_fileselector_entry_button_icon_set()
4591 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4594 * Unset the icon used in a given file selector entry widget's
4597 * @param obj The file selector entry widget
4598 * @return The icon object that was being used on @p obj widget's
4599 * button or @c NULL, on errors
4601 * Unparent and return the icon object which was set for this
4604 * @see elm_fileselector_entry_button_icon_set()
4606 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4609 * Set the title for a given file selector entry widget's window
4611 * @param obj The file selector entry widget
4612 * @param title The title string
4614 * This will change the window's title, when the file selector pops
4615 * out after a click on the entry's button. Those windows have the
4616 * default (unlocalized) value of @c "Select a file" as titles.
4618 * @note It will only take any effect if the file selector
4619 * entry widget is @b not under "inwin mode".
4621 * @see elm_fileselector_entry_window_title_get()
4623 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4626 * Get the title set for a given file selector entry widget's
4629 * @param obj The file selector entry widget
4630 * @return Title of the file selector entry's window
4632 * @see elm_fileselector_entry_window_title_get() for more details
4634 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4637 * Set the size of a given file selector entry widget's window,
4638 * holding the file selector itself.
4640 * @param obj The file selector entry widget
4641 * @param width The window's width
4642 * @param height The window's height
4644 * @note it will only take any effect if the file selector entry
4645 * widget is @b not under "inwin mode". The default size for the
4646 * window (when applicable) is 400x400 pixels.
4648 * @see elm_fileselector_entry_window_size_get()
4650 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4653 * Get the size of a given file selector entry widget's window,
4654 * holding the file selector itself.
4656 * @param obj The file selector entry widget
4657 * @param width Pointer into which to store the width value
4658 * @param height Pointer into which to store the height value
4660 * @note Use @c NULL pointers on the size values you're not
4661 * interested in: they'll be ignored by the function.
4663 * @see elm_fileselector_entry_window_size_set(), for more details
4665 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4668 * Set the initial file system path and the entry's path string for
4669 * a given file selector entry widget
4671 * @param obj The file selector entry widget
4672 * @param path The path string
4674 * It must be a <b>directory</b> path, which will have the contents
4675 * displayed initially in the file selector's view, when invoked
4676 * from @p obj. The default initial path is the @c "HOME"
4677 * environment variable's value.
4679 * @see elm_fileselector_entry_path_get()
4681 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4684 * Get the entry's path string for a given file selector entry
4687 * @param obj The file selector entry widget
4688 * @return path The path string
4690 * @see elm_fileselector_entry_path_set() for more details
4692 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4695 * Enable/disable a tree view in the given file selector entry
4696 * widget's internal file selector
4698 * @param obj The file selector entry widget
4699 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4702 * This has the same effect as elm_fileselector_expandable_set(),
4703 * but now applied to a file selector entry's internal file
4706 * @note There's no way to put a file selector entry's internal
4707 * file selector in "grid mode", as one may do with "pure" file
4710 * @see elm_fileselector_expandable_get()
4712 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4715 * Get whether tree view is enabled for the given file selector
4716 * entry widget's internal file selector
4718 * @param obj The file selector entry widget
4719 * @return @c EINA_TRUE if @p obj widget's internal file selector
4720 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4722 * @see elm_fileselector_expandable_set() for more details
4724 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4727 * Set whether a given file selector entry widget's internal file
4728 * selector is to display folders only or the directory contents,
4731 * @param obj The file selector entry widget
4732 * @param only @c EINA_TRUE to make @p obj widget's internal file
4733 * selector only display directories, @c EINA_FALSE to make files
4734 * to be displayed in it too
4736 * This has the same effect as elm_fileselector_folder_only_set(),
4737 * but now applied to a file selector entry's internal file
4740 * @see elm_fileselector_folder_only_get()
4742 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4745 * Get whether a given file selector entry widget's internal file
4746 * selector is displaying folders only or the directory contents,
4749 * @param obj The file selector entry widget
4750 * @return @c EINA_TRUE if @p obj widget's internal file
4751 * selector is only displaying directories, @c EINA_FALSE if files
4752 * are being displayed in it too (and on errors)
4754 * @see elm_fileselector_entry_folder_only_set() for more details
4756 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4759 * Enable/disable the file name entry box where the user can type
4760 * in a name for a file, in a given file selector entry widget's
4761 * internal file selector.
4763 * @param obj The file selector entry widget
4764 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4765 * file selector a "saving dialog", @c EINA_FALSE otherwise
4767 * This has the same effect as elm_fileselector_is_save_set(),
4768 * but now applied to a file selector entry's internal file
4771 * @see elm_fileselector_is_save_get()
4773 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4776 * Get whether the given file selector entry widget's internal
4777 * file selector is in "saving dialog" mode
4779 * @param obj The file selector entry widget
4780 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4781 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4784 * @see elm_fileselector_entry_is_save_set() for more details
4786 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4789 * Set whether a given file selector entry widget's internal file
4790 * selector will raise an Elementary "inner window", instead of a
4791 * dedicated Elementary window. By default, it won't.
4793 * @param obj The file selector entry widget
4794 * @param value @c EINA_TRUE to make it use an inner window, @c
4795 * EINA_TRUE to make it use a dedicated window
4797 * @see elm_win_inwin_add() for more information on inner windows
4798 * @see elm_fileselector_entry_inwin_mode_get()
4800 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4803 * Get whether a given file selector entry widget's internal file
4804 * selector will raise an Elementary "inner window", instead of a
4805 * dedicated Elementary window.
4807 * @param obj The file selector entry widget
4808 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4809 * if it will use a dedicated window
4811 * @see elm_fileselector_entry_inwin_mode_set() for more details
4813 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4816 * Set the initial file system path for a given file selector entry
4819 * @param obj The file selector entry widget
4820 * @param path The path string
4822 * It must be a <b>directory</b> path, which will have the contents
4823 * displayed initially in the file selector's view, when invoked
4824 * from @p obj. The default initial path is the @c "HOME"
4825 * environment variable's value.
4827 * @see elm_fileselector_entry_path_get()
4829 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4832 * Get the parent directory's path to the latest file selection on
4833 * a given filer selector entry widget
4835 * @param obj The file selector object
4836 * @return The (full) path of the directory of the last selection
4837 * on @p obj widget, a @b stringshared string
4839 * @see elm_fileselector_entry_path_set()
4841 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4848 * @defgroup Scroller Scroller
4850 * A scroller holds a single object and "scrolls it around". This means that
4851 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4852 * region around, allowing to move through a much larger object that is
4853 * contained in the scroller. The scroiller will always have a small minimum
4854 * size by default as it won't be limited by the contents of the scroller.
4856 * Signals that you can add callbacks for are:
4857 * @li "edge,left" - the left edge of the content has been reached
4858 * @li "edge,right" - the right edge of the content has been reached
4859 * @li "edge,top" - the top edge of the content has been reached
4860 * @li "edge,bottom" - the bottom edge of the content has been reached
4861 * @li "scroll" - the content has been scrolled (moved)
4862 * @li "scroll,anim,start" - scrolling animation has started
4863 * @li "scroll,anim,stop" - scrolling animation has stopped
4864 * @li "scroll,drag,start" - dragging the contents around has started
4865 * @li "scroll,drag,stop" - dragging the contents around has stopped
4866 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4869 * @note When Elemementary is in embedded mode the scrollbars will not be
4870 * dragable, they appear merely as indicators of how much has been scrolled.
4871 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4872 * fingerscroll) won't work.
4874 * In @ref tutorial_scroller you'll find an example of how to use most of
4879 * @brief Type that controls when scrollbars should appear.
4881 * @see elm_scroller_policy_set()
4883 typedef enum _Elm_Scroller_Policy
4885 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4886 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4887 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4888 ELM_SCROLLER_POLICY_LAST
4889 } Elm_Scroller_Policy;
4891 * @brief Add a new scroller to the parent
4893 * @param parent The parent object
4894 * @return The new object or NULL if it cannot be created
4896 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4898 * @brief Set the content of the scroller widget (the object to be scrolled around).
4900 * @param obj The scroller object
4901 * @param content The new content object
4903 * Once the content object is set, a previously set one will be deleted.
4904 * If you want to keep that old content object, use the
4905 * elm_scroller_content_unset() function.
4907 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4909 * @brief Get the content of the scroller widget
4911 * @param obj The slider object
4912 * @return The content that is being used
4914 * Return the content object which is set for this widget
4916 * @see elm_scroller_content_set()
4918 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4920 * @brief Unset the content of the scroller widget
4922 * @param obj The slider object
4923 * @return The content that was being used
4925 * Unparent and return the content object which was set for this widget
4927 * @see elm_scroller_content_set()
4929 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4931 * @brief Set custom theme elements for the scroller
4933 * @param obj The scroller object
4934 * @param widget The widget name to use (default is "scroller")
4935 * @param base The base name to use (default is "base")
4937 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4939 * @brief Make the scroller minimum size limited to the minimum size of the content
4941 * @param obj The scroller object
4942 * @param w Enable limiting minimum size horizontally
4943 * @param h Enable limiting minimum size vertically
4945 * By default the scroller will be as small as its design allows,
4946 * irrespective of its content. This will make the scroller minimum size the
4947 * right size horizontally and/or vertically to perfectly fit its content in
4950 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4952 * @brief Show a specific virtual region within the scroller content object
4954 * @param obj The scroller object
4955 * @param x X coordinate of the region
4956 * @param y Y coordinate of the region
4957 * @param w Width of the region
4958 * @param h Height of the region
4960 * This will ensure all (or part if it does not fit) of the designated
4961 * region in the virtual content object (0, 0 starting at the top-left of the
4962 * virtual content object) is shown within the scroller.
4964 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);
4966 * @brief Set the scrollbar visibility policy
4968 * @param obj The scroller object
4969 * @param policy_h Horizontal scrollbar policy
4970 * @param policy_v Vertical scrollbar policy
4972 * This sets the scrollbar visibility policy for the given scroller.
4973 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4974 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4975 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4976 * respectively for the horizontal and vertical scrollbars.
4978 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4980 * @brief Gets scrollbar visibility policy
4982 * @param obj The scroller object
4983 * @param policy_h Horizontal scrollbar policy
4984 * @param policy_v Vertical scrollbar policy
4986 * @see elm_scroller_policy_set()
4988 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4990 * @brief Get the currently visible content region
4992 * @param obj The scroller object
4993 * @param x X coordinate of the region
4994 * @param y Y coordinate of the region
4995 * @param w Width of the region
4996 * @param h Height of the region
4998 * This gets the current region in the content object that is visible through
4999 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5000 * w, @p h values pointed to.
5002 * @note All coordinates are relative to the content.
5004 * @see elm_scroller_region_show()
5006 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);
5008 * @brief Get the size of the content object
5010 * @param obj The scroller object
5011 * @param w Width return
5012 * @param h Height return
5014 * This gets the size of the content object of the scroller.
5016 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5018 * @brief Set bouncing behavior
5020 * @param obj The scroller object
5021 * @param h_bounce Will the scroller bounce horizontally or not
5022 * @param v_bounce Will the scroller bounce vertically or not
5024 * When scrolling, the scroller may "bounce" when reaching an edge of the
5025 * content object. This is a visual way to indicate the end has been reached.
5026 * This is enabled by default for both axis. This will set if it is enabled
5027 * for that axis with the boolean parameters for each axis.
5029 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5031 * @brief Get the bounce mode
5033 * @param obj The Scroller object
5034 * @param h_bounce Allow bounce horizontally
5035 * @param v_bounce Allow bounce vertically
5037 * @see elm_scroller_bounce_set()
5039 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5041 * @brief Set scroll page size relative to viewport size.
5043 * @param obj The scroller object
5044 * @param h_pagerel The horizontal page relative size
5045 * @param v_pagerel The vertical page relative size
5047 * The scroller is capable of limiting scrolling by the user to "pages". That
5048 * is to jump by and only show a "whole page" at a time as if the continuous
5049 * area of the scroller content is split into page sized pieces. This sets
5050 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5051 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5052 * axis. This is mutually exclusive with page size
5053 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5054 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5055 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5058 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5060 * @brief Set scroll page size.
5062 * @param obj The scroller object
5063 * @param h_pagesize The horizontal page size
5064 * @param v_pagesize The vertical page size
5066 * This sets the page size to an absolute fixed value, with 0 turning it off
5069 * @see elm_scroller_page_relative_set()
5071 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5073 * @brief Show a specific virtual region within the scroller content object.
5075 * @param obj The scroller object
5076 * @param x X coordinate of the region
5077 * @param y Y coordinate of the region
5078 * @param w Width of the region
5079 * @param h Height of the region
5081 * This will ensure all (or part if it does not fit) of the designated
5082 * region in the virtual content object (0, 0 starting at the top-left of the
5083 * virtual content object) is shown within the scroller. Unlike
5084 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5085 * to this location (if configuration in general calls for transitions). It
5086 * may not jump immediately to the new location and make take a while and
5087 * show other content along the way.
5089 * @see elm_scroller_region_show()
5091 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);
5093 * @brief Set event propagation on a scroller
5095 * @param obj The scroller object
5096 * @param propagation If propagation is enabled or not
5098 * This enables or disabled event propagation from the scroller content to
5099 * the scroller and its parent. By default event propagation is disabled.
5101 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5103 * @brief Get event propagation for a scroller
5105 * @param obj The scroller object
5106 * @return The propagation state
5108 * This gets the event propagation for a scroller.
5110 * @see elm_scroller_propagate_events_set()
5112 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5118 * @defgroup Label Label
5120 * @image html img/widget/label/preview-00.png
5121 * @image latex img/widget/label/preview-00.eps
5123 * @brief Widget to display text, with simple html-like markup.
5125 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5126 * text doesn't fit the geometry of the label it will be ellipsized or be
5127 * cut. Elementary provides several themes for this widget:
5128 * @li default - No animation
5129 * @li marker - Centers the text in the label and make it bold by default
5130 * @li slide_long - The entire text appears from the right of the screen and
5131 * slides until it disappears in the left of the screen(reappering on the
5133 * @li slide_short - The text appears in the left of the label and slides to
5134 * the right to show the overflow. When all of the text has been shown the
5135 * position is reset.
5136 * @li slide_bounce - The text appears in the left of the label and slides to
5137 * the right to show the overflow. When all of the text has been shown the
5138 * animation reverses, moving the text to the left.
5140 * Custom themes can of course invent new markup tags and style them any way
5143 * See @ref tutorial_label for a demonstration of how to use a label widget.
5147 * @brief Add a new label to the parent
5149 * @param parent The parent object
5150 * @return The new object or NULL if it cannot be created
5152 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5154 * @brief Set the label on the label object
5156 * @param obj The label object
5157 * @param label The label will be used on the label object
5158 * @deprecated See elm_object_text_set()
5160 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 */
5162 * @brief Get the label used on the label object
5164 * @param obj The label object
5165 * @return The string inside the label
5166 * @deprecated See elm_object_text_get()
5168 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5170 * @brief Set the wrapping behavior of the label
5172 * @param obj The label object
5173 * @param wrap To wrap text or not
5175 * By default no wrapping is done. Possible values for @p wrap are:
5176 * @li ELM_WRAP_NONE - No wrapping
5177 * @li ELM_WRAP_CHAR - wrap between characters
5178 * @li ELM_WRAP_WORD - wrap between words
5179 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5181 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5183 * @brief Get the wrapping behavior of the label
5185 * @param obj The label object
5188 * @see elm_label_line_wrap_set()
5190 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5192 * @brief Set wrap width of the label
5194 * @param obj The label object
5195 * @param w The wrap width in pixels at a minimum where words need to wrap
5197 * This function sets the maximum width size hint of the label.
5199 * @warning This is only relevant if the label is inside a container.
5201 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5203 * @brief Get wrap width of the label
5205 * @param obj The label object
5206 * @return The wrap width in pixels at a minimum where words need to wrap
5208 * @see elm_label_wrap_width_set()
5210 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5212 * @brief Set wrap height of the label
5214 * @param obj The label object
5215 * @param h The wrap height in pixels at a minimum where words need to wrap
5217 * This function sets the maximum height size hint of the label.
5219 * @warning This is only relevant if the label is inside a container.
5221 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5223 * @brief get wrap width of the label
5225 * @param obj The label object
5226 * @return The wrap height in pixels at a minimum where words need to wrap
5228 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5230 * @brief Set the font size on the label object.
5232 * @param obj The label object
5233 * @param size font size
5235 * @warning NEVER use this. It is for hyper-special cases only. use styles
5236 * instead. e.g. "big", "medium", "small" - or better name them by use:
5237 * "title", "footnote", "quote" etc.
5239 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5241 * @brief Set the text color on the label object
5243 * @param obj The label object
5244 * @param r Red property background color of The label object
5245 * @param g Green property background color of The label object
5246 * @param b Blue property background color of The label object
5247 * @param a Alpha property background color of The label object
5249 * @warning NEVER use this. It is for hyper-special cases only. use styles
5250 * instead. e.g. "big", "medium", "small" - or better name them by use:
5251 * "title", "footnote", "quote" etc.
5253 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);
5255 * @brief Set the text align on the label object
5257 * @param obj The label object
5258 * @param align align mode ("left", "center", "right")
5260 * @warning NEVER use this. It is for hyper-special cases only. use styles
5261 * instead. e.g. "big", "medium", "small" - or better name them by use:
5262 * "title", "footnote", "quote" etc.
5264 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5266 * @brief Set background color of the label
5268 * @param obj The label object
5269 * @param r Red property background color of The label object
5270 * @param g Green property background color of The label object
5271 * @param b Blue property background color of The label object
5272 * @param a Alpha property background alpha of The label object
5274 * @warning NEVER use this. It is for hyper-special cases only. use styles
5275 * instead. e.g. "big", "medium", "small" - or better name them by use:
5276 * "title", "footnote", "quote" etc.
5278 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);
5280 * @brief Set the ellipsis behavior of the label
5282 * @param obj The label object
5283 * @param ellipsis To ellipsis text or not
5285 * If set to true and the text doesn't fit in the label an ellipsis("...")
5286 * will be shown at the end of the widget.
5288 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5289 * choosen wrap method was ELM_WRAP_WORD.
5291 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5293 * @brief Set the text slide of the label
5295 * @param obj The label object
5296 * @param slide To start slide or stop
5298 * If set to true the text of the label will slide throught the length of
5301 * @warning This only work with the themes "slide_short", "slide_long" and
5304 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5306 * @brief Get the text slide mode of the label
5308 * @param obj The label object
5309 * @return slide slide mode value
5311 * @see elm_label_slide_set()
5313 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5315 * @brief Set the slide duration(speed) of the label
5317 * @param obj The label object
5318 * @return The duration in seconds in moving text from slide begin position
5319 * to slide end position
5321 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5323 * @brief Get the slide duration(speed) of the label
5325 * @param obj The label object
5326 * @return The duration time in moving text from slide begin position to slide end position
5328 * @see elm_label_slide_duration_set()
5330 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5336 * @defgroup Toggle Toggle
5338 * @image html img/widget/toggle/preview-00.png
5339 * @image latex img/widget/toggle/preview-00.eps
5341 * @brief A toggle is a slider which can be used to toggle between
5342 * two values. It has two states: on and off.
5344 * Signals that you can add callbacks for are:
5345 * @li "changed" - Whenever the toggle value has been changed. Is not called
5346 * until the toggle is released by the cursor (assuming it
5347 * has been triggered by the cursor in the first place).
5349 * @ref tutorial_toggle show how to use a toggle.
5353 * @brief Add a toggle to @p parent.
5355 * @param parent The parent object
5357 * @return The toggle object
5359 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5361 * @brief Sets the label to be displayed with the toggle.
5363 * @param obj The toggle object
5364 * @param label The label to be displayed
5366 * @deprecated use elm_object_text_set() instead.
5368 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5370 * @brief Gets the label of the toggle
5372 * @param obj toggle object
5373 * @return The label of the toggle
5375 * @deprecated use elm_object_text_get() instead.
5377 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5379 * @brief Set the icon used for the toggle
5381 * @param obj The toggle object
5382 * @param icon The icon object for the button
5384 * Once the icon object is set, a previously set one will be deleted
5385 * If you want to keep that old content object, use the
5386 * elm_toggle_icon_unset() function.
5388 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5390 * @brief Get the icon used for the toggle
5392 * @param obj The toggle object
5393 * @return The icon object that is being used
5395 * Return the icon object which is set for this widget.
5397 * @see elm_toggle_icon_set()
5399 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5401 * @brief Unset the icon used for the toggle
5403 * @param obj The toggle object
5404 * @return The icon object that was being used
5406 * Unparent and return the icon object which was set for this widget.
5408 * @see elm_toggle_icon_set()
5410 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5412 * @brief Sets the labels to be associated with the on and off states of the toggle.
5414 * @param obj The toggle object
5415 * @param onlabel The label displayed when the toggle is in the "on" state
5416 * @param offlabel The label displayed when the toggle is in the "off" state
5418 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5420 * @brief Gets the labels associated with the on and off states of the toggle.
5422 * @param obj The toggle object
5423 * @param onlabel A char** to place the onlabel of @p obj into
5424 * @param offlabel A char** to place the offlabel of @p obj into
5426 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5428 * @brief Sets the state of the toggle to @p state.
5430 * @param obj The toggle object
5431 * @param state The state of @p obj
5433 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5435 * @brief Gets the state of the toggle to @p state.
5437 * @param obj The toggle object
5438 * @return The state of @p obj
5440 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5442 * @brief Sets the state pointer of the toggle to @p statep.
5444 * @param obj The toggle object
5445 * @param statep The state pointer of @p obj
5447 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5453 * @defgroup Frame Frame
5455 * @image html img/widget/frame/preview-00.png
5456 * @image latex img/widget/frame/preview-00.eps
5458 * @brief Frame is a widget that holds some content and has a title.
5460 * The default look is a frame with a title, but Frame supports multple
5468 * @li outdent_bottom
5470 * Of all this styles only default shows the title. Frame emits no signals.
5472 * For a detailed example see the @ref tutorial_frame.
5477 * @brief Add a new frame to the parent
5479 * @param parent The parent object
5480 * @return The new object or NULL if it cannot be created
5482 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5484 * @brief Set the frame label
5486 * @param obj The frame object
5487 * @param label The label of this frame object
5489 * @deprecated use elm_object_text_set() instead.
5491 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5493 * @brief Get the frame label
5495 * @param obj The frame object
5497 * @return The label of this frame objet or NULL if unable to get frame
5499 * @deprecated use elm_object_text_get() instead.
5501 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503 * @brief Set the content of the frame widget
5505 * Once the content object is set, a previously set one will be deleted.
5506 * If you want to keep that old content object, use the
5507 * elm_frame_content_unset() function.
5509 * @param obj The frame object
5510 * @param content The content will be filled in this frame object
5512 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5514 * @brief Get the content of the frame widget
5516 * Return the content object which is set for this widget
5518 * @param obj The frame object
5519 * @return The content that is being used
5521 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5523 * @brief Unset the content of the frame widget
5525 * Unparent and return the content object which was set for this widget
5527 * @param obj The frame object
5528 * @return The content that was being used
5530 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5536 * @defgroup Table Table
5538 * A container widget to arrange other widgets in a table where items can
5539 * also span multiple columns or rows - even overlap (and then be raised or
5540 * lowered accordingly to adjust stacking if they do overlap).
5542 * The followin are examples of how to use a table:
5543 * @li @ref tutorial_table_01
5544 * @li @ref tutorial_table_02
5549 * @brief Add a new table to the parent
5551 * @param parent The parent object
5552 * @return The new object or NULL if it cannot be created
5554 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5556 * @brief Set the homogeneous layout in the table
5558 * @param obj The layout object
5559 * @param homogeneous A boolean to set if the layout is homogeneous in the
5560 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5562 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5564 * @brief Get the current table homogeneous mode.
5566 * @param obj The table object
5567 * @return A boolean to indicating if the layout is homogeneous in the table
5568 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5570 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5572 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5574 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5576 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5578 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5580 * @brief Set padding between cells.
5582 * @param obj The layout object.
5583 * @param horizontal set the horizontal padding.
5584 * @param vertical set the vertical padding.
5586 * Default value is 0.
5588 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5590 * @brief Get padding between cells.
5592 * @param obj The layout object.
5593 * @param horizontal set the horizontal padding.
5594 * @param vertical set the vertical padding.
5596 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5598 * @brief Add a subobject on the table with the coordinates passed
5600 * @param obj The table object
5601 * @param subobj The subobject to be added to the table
5602 * @param x Row number
5603 * @param y Column number
5607 * @note All positioning inside the table is relative to rows and columns, so
5608 * a value of 0 for x and y, means the top left cell of the table, and a
5609 * value of 1 for w and h means @p subobj only takes that 1 cell.
5611 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5613 * @brief Remove child from table.
5615 * @param obj The table object
5616 * @param subobj The subobject
5618 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5620 * @brief Faster way to remove all child objects from a table object.
5622 * @param obj The table object
5623 * @param clear If true, will delete children, else just remove from table.
5625 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5627 * @brief Set the packing location of an existing child of the table
5629 * @param subobj The subobject to be modified in the table
5630 * @param x Row number
5631 * @param y Column number
5635 * Modifies the position of an object already in the table.
5637 * @note All positioning inside the table is relative to rows and columns, so
5638 * a value of 0 for x and y, means the top left cell of the table, and a
5639 * value of 1 for w and h means @p subobj only takes that 1 cell.
5641 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5643 * @brief Get the packing location of an existing child of the table
5645 * @param subobj The subobject to be modified in the table
5646 * @param x Row number
5647 * @param y Column number
5651 * @see elm_table_pack_set()
5653 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5659 * @defgroup Gengrid Gengrid (Generic grid)
5661 * This widget aims to position objects in a grid layout while
5662 * actually creating and rendering only the visible ones, using the
5663 * same idea as the @ref Genlist "genlist": the user defines a @b
5664 * class for each item, specifying functions that will be called at
5665 * object creation, deletion, etc. When those items are selected by
5666 * the user, a callback function is issued. Users may interact with
5667 * a gengrid via the mouse (by clicking on items to select them and
5668 * clicking on the grid's viewport and swiping to pan the whole
5669 * view) or via the keyboard, navigating through item with the
5672 * @section Gengrid_Layouts Gengrid layouts
5674 * Gengrids may layout its items in one of two possible layouts:
5678 * When in "horizontal mode", items will be placed in @b columns,
5679 * from top to bottom and, when the space for a column is filled,
5680 * another one is started on the right, thus expanding the grid
5681 * horizontally, making for horizontal scrolling. When in "vertical
5682 * mode" , though, items will be placed in @b rows, from left to
5683 * right and, when the space for a row is filled, another one is
5684 * started below, thus expanding the grid vertically (and making
5685 * for vertical scrolling).
5687 * @section Gengrid_Items Gengrid items
5689 * An item in a gengrid can have 0 or more text labels (they can be
5690 * regular text or textblock Evas objects - that's up to the style
5691 * to determine), 0 or more icons (which are simply objects
5692 * swallowed into the gengrid item's theming Edje object) and 0 or
5693 * more <b>boolean states</b>, which have the behavior left to the
5694 * user to define. The Edje part names for each of these properties
5695 * will be looked up, in the theme file for the gengrid, under the
5696 * Edje (string) data items named @c "labels", @c "icons" and @c
5697 * "states", respectively. For each of those properties, if more
5698 * than one part is provided, they must have names listed separated
5699 * by spaces in the data fields. For the default gengrid item
5700 * theme, we have @b one label part (@c "elm.text"), @b two icon
5701 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5704 * A gengrid item may be at one of several styles. Elementary
5705 * provides one by default - "default", but this can be extended by
5706 * system or application custom themes/overlays/extensions (see
5707 * @ref Theme "themes" for more details).
5709 * @section Gengrid_Item_Class Gengrid item classes
5711 * In order to have the ability to add and delete items on the fly,
5712 * gengrid implements a class (callback) system where the
5713 * application provides a structure with information about that
5714 * type of item (gengrid may contain multiple different items with
5715 * different classes, states and styles). Gengrid will call the
5716 * functions in this struct (methods) when an item is "realized"
5717 * (i.e., created dynamically, while the user is scrolling the
5718 * grid). All objects will simply be deleted when no longer needed
5719 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5720 * contains the following members:
5721 * - @c item_style - This is a constant string and simply defines
5722 * the name of the item style. It @b must be specified and the
5723 * default should be @c "default".
5724 * - @c func.label_get - This function is called when an item
5725 * object is actually created. The @c data parameter will point to
5726 * the same data passed to elm_gengrid_item_append() and related
5727 * item creation functions. The @c obj parameter is the gengrid
5728 * object itself, while the @c part one is the name string of one
5729 * of the existing text parts in the Edje group implementing the
5730 * item's theme. This function @b must return a strdup'()ed string,
5731 * as the caller will free() it when done. See
5732 * #GridItemLabelGetFunc.
5733 * - @c func.icon_get - This function is called when an item object
5734 * is actually created. The @c data parameter will point to the
5735 * same data passed to elm_gengrid_item_append() and related item
5736 * creation functions. The @c obj parameter is the gengrid object
5737 * itself, while the @c part one is the name string of one of the
5738 * existing (icon) swallow parts in the Edje group implementing the
5739 * item's theme. It must return @c NULL, when no icon is desired,
5740 * or a valid object handle, otherwise. The object will be deleted
5741 * by the gengrid on its deletion or when the item is "unrealized".
5742 * See #GridItemIconGetFunc.
5743 * - @c func.state_get - This function is called when an item
5744 * object is actually created. The @c data parameter will point to
5745 * the same data passed to elm_gengrid_item_append() and related
5746 * item creation functions. The @c obj parameter is the gengrid
5747 * object itself, while the @c part one is the name string of one
5748 * of the state parts in the Edje group implementing the item's
5749 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5750 * true/on. Gengrids will emit a signal to its theming Edje object
5751 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5752 * "source" arguments, respectively, when the state is true (the
5753 * default is false), where @c XXX is the name of the (state) part.
5754 * See #GridItemStateGetFunc.
5755 * - @c func.del - This is called when elm_gengrid_item_del() is
5756 * called on an item or elm_gengrid_clear() is called on the
5757 * gengrid. This is intended for use when gengrid items are
5758 * deleted, so any data attached to the item (e.g. its data
5759 * parameter on creation) can be deleted. See #GridItemDelFunc.
5761 * @section Gengrid_Usage_Hints Usage hints
5763 * If the user wants to have multiple items selected at the same
5764 * time, elm_gengrid_multi_select_set() will permit it. If the
5765 * gengrid is single-selection only (the default), then
5766 * elm_gengrid_select_item_get() will return the selected item or
5767 * @c NULL, if none is selected. If the gengrid is under
5768 * multi-selection, then elm_gengrid_selected_items_get() will
5769 * return a list (that is only valid as long as no items are
5770 * modified (added, deleted, selected or unselected) of child items
5773 * If an item changes (internal (boolean) state, label or icon
5774 * changes), then use elm_gengrid_item_update() to have gengrid
5775 * update the item with the new state. A gengrid will re-"realize"
5776 * the item, thus calling the functions in the
5777 * #Elm_Gengrid_Item_Class set for that item.
5779 * To programmatically (un)select an item, use
5780 * elm_gengrid_item_selected_set(). To get its selected state use
5781 * elm_gengrid_item_selected_get(). To make an item disabled
5782 * (unable to be selected and appear differently) use
5783 * elm_gengrid_item_disabled_set() to set this and
5784 * elm_gengrid_item_disabled_get() to get the disabled state.
5786 * Grid cells will only have their selection smart callbacks called
5787 * when firstly getting selected. Any further clicks will do
5788 * nothing, unless you enable the "always select mode", with
5789 * elm_gengrid_always_select_mode_set(), thus making every click to
5790 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5791 * turn off the ability to select items entirely in the widget and
5792 * they will neither appear selected nor call the selection smart
5795 * Remember that you can create new styles and add your own theme
5796 * augmentation per application with elm_theme_extension_add(). If
5797 * you absolutely must have a specific style that overrides any
5798 * theme the user or system sets up you can use
5799 * elm_theme_overlay_add() to add such a file.
5801 * @section Gengrid_Smart_Events Gengrid smart events
5803 * Smart events that you can add callbacks for are:
5804 * - @c "activated" - The user has double-clicked or pressed
5805 * (enter|return|spacebar) on an item. The @c event_info parameter
5806 * is the gengrid item that was activated.
5807 * - @c "clicked,double" - The user has double-clicked an item.
5808 * The @c event_info parameter is the gengrid item that was double-clicked.
5809 * - @c "selected" - The user has made an item selected. The
5810 * @c event_info parameter is the gengrid item that was selected.
5811 * - @c "unselected" - The user has made an item unselected. The
5812 * @c event_info parameter is the gengrid item that was unselected.
5813 * - @c "realized" - This is called when the item in the gengrid
5814 * has its implementing Evas object instantiated, de facto. @c
5815 * event_info is the gengrid item that was created. The object
5816 * may be deleted at any time, so it is highly advised to the
5817 * caller @b not to use the object pointer returned from
5818 * elm_gengrid_item_object_get(), because it may point to freed
5820 * - @c "unrealized" - This is called when the implementing Evas
5821 * object for this item is deleted. @c event_info is the gengrid
5822 * item that was deleted.
5823 * - @c "changed" - Called when an item is added, removed, resized
5824 * or moved and when the gengrid is resized or gets "horizontal"
5826 * - @c "drag,start,up" - Called when the item in the gengrid has
5827 * been dragged (not scrolled) up.
5828 * - @c "drag,start,down" - Called when the item in the gengrid has
5829 * been dragged (not scrolled) down.
5830 * - @c "drag,start,left" - Called when the item in the gengrid has
5831 * been dragged (not scrolled) left.
5832 * - @c "drag,start,right" - Called when the item in the gengrid has
5833 * been dragged (not scrolled) right.
5834 * - @c "drag,stop" - Called when the item in the gengrid has
5835 * stopped being dragged.
5836 * - @c "drag" - Called when the item in the gengrid is being
5838 * - @c "scroll" - called when the content has been scrolled
5840 * - @c "scroll,drag,start" - called when dragging the content has
5842 * - @c "scroll,drag,stop" - called when dragging the content has
5845 * List of gendrid examples:
5846 * @li @ref gengrid_example
5850 * @addtogroup Gengrid
5854 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5855 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5856 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5857 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5858 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5859 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5860 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5863 * @struct _Elm_Gengrid_Item_Class
5865 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5868 struct _Elm_Gengrid_Item_Class
5870 const char *item_style;
5871 struct _Elm_Gengrid_Item_Class_Func
5873 GridItemLabelGetFunc label_get;
5874 GridItemIconGetFunc icon_get;
5875 GridItemStateGetFunc state_get;
5876 GridItemDelFunc del;
5878 }; /**< #Elm_Gengrid_Item_Class member definitions */
5881 * Add a new gengrid widget to the given parent Elementary
5882 * (container) object
5884 * @param parent The parent object
5885 * @return a new gengrid widget handle or @c NULL, on errors
5887 * This function inserts a new gengrid widget on the canvas.
5889 * @see elm_gengrid_item_size_set()
5890 * @see elm_gengrid_horizontal_set()
5891 * @see elm_gengrid_item_append()
5892 * @see elm_gengrid_item_del()
5893 * @see elm_gengrid_clear()
5897 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5900 * Set the size for the items of a given gengrid widget
5902 * @param obj The gengrid object.
5903 * @param w The items' width.
5904 * @param h The items' height;
5906 * A gengrid, after creation, has still no information on the size
5907 * to give to each of its cells. So, you most probably will end up
5908 * with squares one @ref Fingers "finger" wide, the default
5909 * size. Use this function to force a custom size for you items,
5910 * making them as big as you wish.
5912 * @see elm_gengrid_item_size_get()
5916 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5919 * Get the size set for the items of a given gengrid widget
5921 * @param obj The gengrid object.
5922 * @param w Pointer to a variable where to store the items' width.
5923 * @param h Pointer to a variable where to store the items' height.
5925 * @note Use @c NULL pointers on the size values you're not
5926 * interested in: they'll be ignored by the function.
5928 * @see elm_gengrid_item_size_get() for more details
5932 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5935 * Set the items grid's alignment within a given gengrid widget
5937 * @param obj The gengrid object.
5938 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5939 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5941 * This sets the alignment of the whole grid of items of a gengrid
5942 * within its given viewport. By default, those values are both
5943 * 0.5, meaning that the gengrid will have its items grid placed
5944 * exactly in the middle of its viewport.
5946 * @note If given alignment values are out of the cited ranges,
5947 * they'll be changed to the nearest boundary values on the valid
5950 * @see elm_gengrid_align_get()
5954 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5957 * Get the items grid's alignment values within a given gengrid
5960 * @param obj The gengrid object.
5961 * @param align_x Pointer to a variable where to store the
5962 * horizontal alignment.
5963 * @param align_y Pointer to a variable where to store the vertical
5966 * @note Use @c NULL pointers on the alignment values you're not
5967 * interested in: they'll be ignored by the function.
5969 * @see elm_gengrid_align_set() for more details
5973 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5976 * Set whether a given gengrid widget is or not able have items
5979 * @param obj The gengrid object
5980 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5981 * @c EINA_FALSE to turn it off
5983 * If a gengrid is set to allow reordering, a click held for more
5984 * than 0.5 over a given item will highlight it specially,
5985 * signalling the gengrid has entered the reordering state. From
5986 * that time on, the user will be able to, while still holding the
5987 * mouse button down, move the item freely in the gengrid's
5988 * viewport, replacing to said item to the locations it goes to.
5989 * The replacements will be animated and, whenever the user
5990 * releases the mouse button, the item being replaced gets a new
5991 * definitive place in the grid.
5993 * @see elm_gengrid_reorder_mode_get()
5997 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6000 * Get whether a given gengrid widget is or not able have items
6003 * @param obj The gengrid object
6004 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6007 * @see elm_gengrid_reorder_mode_set() for more details
6011 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6014 * Append a new item in a given gengrid widget.
6016 * @param obj The gengrid object.
6017 * @param gic The item class for the item.
6018 * @param data The item data.
6019 * @param func Convenience function called when the item is
6021 * @param func_data Data to be passed to @p func.
6022 * @return A handle to the item added or @c NULL, on errors.
6024 * This adds an item to the beginning of the gengrid.
6026 * @see elm_gengrid_item_prepend()
6027 * @see elm_gengrid_item_insert_before()
6028 * @see elm_gengrid_item_insert_after()
6029 * @see elm_gengrid_item_del()
6033 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);
6036 * Prepend a new item in a given gengrid widget.
6038 * @param obj The gengrid object.
6039 * @param gic The item class for the item.
6040 * @param data The item data.
6041 * @param func Convenience function called when the item is
6043 * @param func_data Data to be passed to @p func.
6044 * @return A handle to the item added or @c NULL, on errors.
6046 * This adds an item to the end of the gengrid.
6048 * @see elm_gengrid_item_append()
6049 * @see elm_gengrid_item_insert_before()
6050 * @see elm_gengrid_item_insert_after()
6051 * @see elm_gengrid_item_del()
6055 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);
6058 * Insert an item before another in a gengrid widget
6060 * @param obj The gengrid object.
6061 * @param gic The item class for the item.
6062 * @param data The item data.
6063 * @param relative The item to place this new one before.
6064 * @param func Convenience function called when the item is
6066 * @param func_data Data to be passed to @p func.
6067 * @return A handle to the item added or @c NULL, on errors.
6069 * This inserts an item before another in the gengrid.
6071 * @see elm_gengrid_item_append()
6072 * @see elm_gengrid_item_prepend()
6073 * @see elm_gengrid_item_insert_after()
6074 * @see elm_gengrid_item_del()
6078 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);
6081 * Insert an item after another in a gengrid widget
6083 * @param obj The gengrid object.
6084 * @param gic The item class for the item.
6085 * @param data The item data.
6086 * @param relative The item to place this new one after.
6087 * @param func Convenience function called when the item is
6089 * @param func_data Data to be passed to @p func.
6090 * @return A handle to the item added or @c NULL, on errors.
6092 * This inserts an item after another in the gengrid.
6094 * @see elm_gengrid_item_append()
6095 * @see elm_gengrid_item_prepend()
6096 * @see elm_gengrid_item_insert_after()
6097 * @see elm_gengrid_item_del()
6101 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);
6103 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);
6105 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);
6108 * Set whether items on a given gengrid widget are to get their
6109 * selection callbacks issued for @b every subsequent selection
6110 * click on them or just for the first click.
6112 * @param obj The gengrid object
6113 * @param always_select @c EINA_TRUE to make items "always
6114 * selected", @c EINA_FALSE, otherwise
6116 * By default, grid items will only call their selection callback
6117 * function when firstly getting selected, any subsequent further
6118 * clicks will do nothing. With this call, you make those
6119 * subsequent clicks also to issue the selection callbacks.
6121 * @note <b>Double clicks</b> will @b always be reported on items.
6123 * @see elm_gengrid_always_select_mode_get()
6127 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6130 * Get whether items on a given gengrid widget have their selection
6131 * callbacks issued for @b every subsequent selection click on them
6132 * or just for the first click.
6134 * @param obj The gengrid object.
6135 * @return @c EINA_TRUE if the gengrid items are "always selected",
6136 * @c EINA_FALSE, otherwise
6138 * @see elm_gengrid_always_select_mode_set() for more details
6142 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6145 * Set whether items on a given gengrid widget can be selected or not.
6147 * @param obj The gengrid object
6148 * @param no_select @c EINA_TRUE to make items selectable,
6149 * @c EINA_FALSE otherwise
6151 * This will make items in @p obj selectable or not. In the latter
6152 * case, any user interacion on the gendrid items will neither make
6153 * them appear selected nor them call their selection callback
6156 * @see elm_gengrid_no_select_mode_get()
6160 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6163 * Get whether items on a given gengrid widget can be selected or
6166 * @param obj The gengrid object
6167 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6170 * @see elm_gengrid_no_select_mode_set() for more details
6174 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6177 * Enable or disable multi-selection in a given gengrid widget
6179 * @param obj The gengrid object.
6180 * @param multi @c EINA_TRUE, to enable multi-selection,
6181 * @c EINA_FALSE to disable it.
6183 * Multi-selection is the ability for one to have @b more than one
6184 * item selected, on a given gengrid, simultaneously. When it is
6185 * enabled, a sequence of clicks on different items will make them
6186 * all selected, progressively. A click on an already selected item
6187 * will unselect it. If interecting via the keyboard,
6188 * multi-selection is enabled while holding the "Shift" key.
6190 * @note By default, multi-selection is @b disabled on gengrids
6192 * @see elm_gengrid_multi_select_get()
6196 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6199 * Get whether multi-selection is enabled or disabled for a given
6202 * @param obj The gengrid object.
6203 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6204 * EINA_FALSE otherwise
6206 * @see elm_gengrid_multi_select_set() for more details
6210 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213 * Enable or disable bouncing effect for a given gengrid widget
6215 * @param obj The gengrid object
6216 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6217 * @c EINA_FALSE to disable it
6218 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6219 * @c EINA_FALSE to disable it
6221 * The bouncing effect occurs whenever one reaches the gengrid's
6222 * edge's while panning it -- it will scroll past its limits a
6223 * little bit and return to the edge again, in a animated for,
6226 * @note By default, gengrids have bouncing enabled on both axis
6228 * @see elm_gengrid_bounce_get()
6232 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6235 * Get whether bouncing effects are enabled or disabled, for a
6236 * given gengrid widget, on each axis
6238 * @param obj The gengrid object
6239 * @param h_bounce Pointer to a variable where to store the
6240 * horizontal bouncing flag.
6241 * @param v_bounce Pointer to a variable where to store the
6242 * vertical bouncing flag.
6244 * @see elm_gengrid_bounce_set() for more details
6248 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6251 * Set a given gengrid widget's scrolling page size, relative to
6252 * its viewport size.
6254 * @param obj The gengrid object
6255 * @param h_pagerel The horizontal page (relative) size
6256 * @param v_pagerel The vertical page (relative) size
6258 * The gengrid's scroller is capable of binding scrolling by the
6259 * user to "pages". It means that, while scrolling and, specially
6260 * after releasing the mouse button, the grid will @b snap to the
6261 * nearest displaying page's area. When page sizes are set, the
6262 * grid's continuous content area is split into (equal) page sized
6265 * This function sets the size of a page <b>relatively to the
6266 * viewport dimensions</b> of the gengrid, for each axis. A value
6267 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6268 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6269 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6270 * 1.0. Values beyond those will make it behave behave
6271 * inconsistently. If you only want one axis to snap to pages, use
6272 * the value @c 0.0 for the other one.
6274 * There is a function setting page size values in @b absolute
6275 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6276 * is mutually exclusive to this one.
6278 * @see elm_gengrid_page_relative_get()
6282 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6285 * Get a given gengrid widget's scrolling page size, relative to
6286 * its viewport size.
6288 * @param obj The gengrid object
6289 * @param h_pagerel Pointer to a variable where to store the
6290 * horizontal page (relative) size
6291 * @param v_pagerel Pointer to a variable where to store the
6292 * vertical page (relative) size
6294 * @see elm_gengrid_page_relative_set() for more details
6298 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6301 * Set a given gengrid widget's scrolling page size
6303 * @param obj The gengrid object
6304 * @param h_pagerel The horizontal page size, in pixels
6305 * @param v_pagerel The vertical page size, in pixels
6307 * The gengrid's scroller is capable of binding scrolling by the
6308 * user to "pages". It means that, while scrolling and, specially
6309 * after releasing the mouse button, the grid will @b snap to the
6310 * nearest displaying page's area. When page sizes are set, the
6311 * grid's continuous content area is split into (equal) page sized
6314 * This function sets the size of a page of the gengrid, in pixels,
6315 * for each axis. Sane usable values are, between @c 0 and the
6316 * dimensions of @p obj, for each axis. Values beyond those will
6317 * make it behave behave inconsistently. If you only want one axis
6318 * to snap to pages, use the value @c 0 for the other one.
6320 * There is a function setting page size values in @b relative
6321 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6322 * use is mutually exclusive to this one.
6326 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6329 * Set for what direction a given gengrid widget will expand while
6330 * placing its items.
6332 * @param obj The gengrid object.
6333 * @param setting @c EINA_TRUE to make the gengrid expand
6334 * horizontally, @c EINA_FALSE to expand vertically.
6336 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6337 * in @b columns, from top to bottom and, when the space for a
6338 * column is filled, another one is started on the right, thus
6339 * expanding the grid horizontally. When in "vertical mode"
6340 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6341 * to right and, when the space for a row is filled, another one is
6342 * started below, thus expanding the grid vertically.
6344 * @see elm_gengrid_horizontal_get()
6348 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6351 * Get for what direction a given gengrid widget will expand while
6352 * placing its items.
6354 * @param obj The gengrid object.
6355 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6356 * @c EINA_FALSE if it's set to expand vertically.
6358 * @see elm_gengrid_horizontal_set() for more detais
6362 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6365 * Get the first item in a given gengrid widget
6367 * @param obj The gengrid object
6368 * @return The first item's handle or @c NULL, if there are no
6369 * items in @p obj (and on errors)
6371 * This returns the first item in the @p obj's internal list of
6374 * @see elm_gengrid_last_item_get()
6378 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6381 * Get the last item in a given gengrid widget
6383 * @param obj The gengrid object
6384 * @return The last item's handle or @c NULL, if there are no
6385 * items in @p obj (and on errors)
6387 * This returns the last item in the @p obj's internal list of
6390 * @see elm_gengrid_first_item_get()
6394 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6397 * Get the @b next item in a gengrid widget's internal list of items,
6398 * given a handle to one of those items.
6400 * @param item The gengrid item to fetch next from
6401 * @return The item after @p item, or @c NULL if there's none (and
6404 * This returns the item placed after the @p item, on the container
6407 * @see elm_gengrid_item_prev_get()
6411 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6414 * Get the @b previous item in a gengrid widget's internal list of items,
6415 * given a handle to one of those items.
6417 * @param item The gengrid item to fetch previous from
6418 * @return The item before @p item, or @c NULL if there's none (and
6421 * This returns the item placed before the @p item, on the container
6424 * @see elm_gengrid_item_next_get()
6428 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6431 * Get the gengrid object's handle which contains a given gengrid
6434 * @param item The item to fetch the container from
6435 * @return The gengrid (parent) object
6437 * This returns the gengrid object itself that an item belongs to.
6441 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6444 * Remove a gengrid item from the its parent, deleting it.
6446 * @param item The item to be removed.
6447 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6449 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6454 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6457 * Update the contents of a given gengrid item
6459 * @param item The gengrid item
6461 * This updates an item by calling all the item class functions
6462 * again to get the icons, labels and states. Use this when the
6463 * original item data has changed and you want thta changes to be
6468 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6469 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6470 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6473 * Return the data associated to a given gengrid item
6475 * @param item The gengrid item.
6476 * @return the data associated to this item.
6478 * This returns the @c data value passed on the
6479 * elm_gengrid_item_append() and related item addition calls.
6481 * @see elm_gengrid_item_append()
6482 * @see elm_gengrid_item_data_set()
6486 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6489 * Set the data associated to a given gengrid item
6491 * @param item The gengrid item
6492 * @param data The new data pointer to set on it
6494 * This @b overrides the @c data value passed on the
6495 * elm_gengrid_item_append() and related item addition calls. This
6496 * function @b won't call elm_gengrid_item_update() automatically,
6497 * so you'd issue it afterwards if you want to hove the item
6498 * updated to reflect the that new data.
6500 * @see elm_gengrid_item_data_get()
6504 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6507 * Get a given gengrid item's position, relative to the whole
6508 * gengrid's grid area.
6510 * @param item The Gengrid item.
6511 * @param x Pointer to variable where to store the item's <b>row
6513 * @param y Pointer to variable where to store the item's <b>column
6516 * This returns the "logical" position of the item whithin the
6517 * gengrid. For example, @c (0, 1) would stand for first row,
6522 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6525 * Set whether a given gengrid item is selected or not
6527 * @param item The gengrid item
6528 * @param selected Use @c EINA_TRUE, to make it selected, @c
6529 * EINA_FALSE to make it unselected
6531 * This sets the selected state of an item. If multi selection is
6532 * not enabled on the containing gengrid and @p selected is @c
6533 * EINA_TRUE, any other previously selected items will get
6534 * unselected in favor of this new one.
6536 * @see elm_gengrid_item_selected_get()
6540 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6543 * Get whether a given gengrid item is selected or not
6545 * @param item The gengrid item
6546 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6548 * @see elm_gengrid_item_selected_set() for more details
6552 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6555 * Get the real Evas object created to implement the view of a
6556 * given gengrid item
6558 * @param item The gengrid item.
6559 * @return the Evas object implementing this item's view.
6561 * This returns the actual Evas object used to implement the
6562 * specified gengrid item's view. This may be @c NULL, as it may
6563 * not have been created or may have been deleted, at any time, by
6564 * the gengrid. <b>Do not modify this object</b> (move, resize,
6565 * show, hide, etc.), as the gengrid is controlling it. This
6566 * function is for querying, emitting custom signals or hooking
6567 * lower level callbacks for events on that object. Do not delete
6568 * this object under any circumstances.
6570 * @see elm_gengrid_item_data_get()
6574 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6577 * Show the portion of a gengrid's internal grid containing a given
6578 * item, @b immediately.
6580 * @param item The item to display
6582 * This causes gengrid to @b redraw its viewport's contents to the
6583 * region contining the given @p item item, if it is not fully
6586 * @see elm_gengrid_item_bring_in()
6590 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6593 * Animatedly bring in, to the visible are of a gengrid, a given
6596 * @param item The gengrid item to display
6598 * This causes gengrig to jump to the given @p item item and show
6599 * it (by scrolling), if it is not fully visible. This will use
6600 * animation to do so and take a period of time to complete.
6602 * @see elm_gengrid_item_show()
6606 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6609 * Set whether a given gengrid item is disabled or not.
6611 * @param item The gengrid item
6612 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6613 * to enable it back.
6615 * A disabled item cannot be selected or unselected. It will also
6616 * change its appearance, to signal the user it's disabled.
6618 * @see elm_gengrid_item_disabled_get()
6622 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6625 * Get whether a given gengrid item is disabled or not.
6627 * @param item The gengrid item
6628 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6631 * @see elm_gengrid_item_disabled_set() for more details
6635 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6638 * Set the text to be shown in a given gengrid item's tooltips.
6640 * @param item The gengrid item
6641 * @param text The text to set in the content
6643 * This call will setup the text to be used as tooltip to that item
6644 * (analogous to elm_object_tooltip_text_set(), but being item
6645 * tooltips with higher precedence than object tooltips). It can
6646 * have only one tooltip at a time, so any previous tooltip data
6651 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6654 * Set the content to be shown in a given gengrid item's tooltips
6656 * @param item The gengrid item.
6657 * @param func The function returning the tooltip contents.
6658 * @param data What to provide to @a func as callback data/context.
6659 * @param del_cb Called when data is not needed anymore, either when
6660 * another callback replaces @p func, the tooltip is unset with
6661 * elm_gengrid_item_tooltip_unset() or the owner @p item
6662 * dies. This callback receives as its first parameter the
6663 * given @p data, being @c event_info the item handle.
6665 * This call will setup the tooltip's contents to @p item
6666 * (analogous to elm_object_tooltip_content_cb_set(), but being
6667 * item tooltips with higher precedence than object tooltips). It
6668 * can have only one tooltip at a time, so any previous tooltip
6669 * content will get removed. @p func (with @p data) will be called
6670 * every time Elementary needs to show the tooltip and it should
6671 * return a valid Evas object, which will be fully managed by the
6672 * tooltip system, getting deleted when the tooltip is gone.
6676 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);
6679 * Unset a tooltip from a given gengrid item
6681 * @param item gengrid item to remove a previously set tooltip from.
6683 * This call removes any tooltip set on @p item. The callback
6684 * provided as @c del_cb to
6685 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6686 * notify it is not used anymore (and have resources cleaned, if
6689 * @see elm_gengrid_item_tooltip_content_cb_set()
6693 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6696 * Set a different @b style for a given gengrid item's tooltip.
6698 * @param item gengrid item with tooltip set
6699 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6700 * "default", @c "transparent", etc)
6702 * Tooltips can have <b>alternate styles</b> to be displayed on,
6703 * which are defined by the theme set on Elementary. This function
6704 * works analogously as elm_object_tooltip_style_set(), but here
6705 * applied only to gengrid item objects. The default style for
6706 * tooltips is @c "default".
6708 * @note before you set a style you should define a tooltip with
6709 * elm_gengrid_item_tooltip_content_cb_set() or
6710 * elm_gengrid_item_tooltip_text_set()
6712 * @see elm_gengrid_item_tooltip_style_get()
6716 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6719 * Get the style set a given gengrid item's tooltip.
6721 * @param item gengrid item with tooltip already set on.
6722 * @return style the theme style in use, which defaults to
6723 * "default". If the object does not have a tooltip set,
6724 * then @c NULL is returned.
6726 * @see elm_gengrid_item_tooltip_style_set() for more details
6730 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6732 * @brief Disable size restrictions on an object's tooltip
6733 * @param item The tooltip's anchor object
6734 * @param disable If EINA_TRUE, size restrictions are disabled
6735 * @return EINA_FALSE on failure, EINA_TRUE on success
6737 * This function allows a tooltip to expand beyond its parant window's canvas.
6738 * It will instead be limited only by the size of the display.
6740 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6742 * @brief Retrieve size restriction state of an object's tooltip
6743 * @param item The tooltip's anchor object
6744 * @return If EINA_TRUE, size restrictions are disabled
6746 * This function returns whether a tooltip is allowed to expand beyond
6747 * its parant window's canvas.
6748 * It will instead be limited only by the size of the display.
6750 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6752 * Set the type of mouse pointer/cursor decoration to be shown,
6753 * when the mouse pointer is over the given gengrid widget item
6755 * @param item gengrid item to customize cursor on
6756 * @param cursor the cursor type's name
6758 * This function works analogously as elm_object_cursor_set(), but
6759 * here the cursor's changing area is restricted to the item's
6760 * area, and not the whole widget's. Note that that item cursors
6761 * have precedence over widget cursors, so that a mouse over @p
6762 * item will always show cursor @p type.
6764 * If this function is called twice for an object, a previously set
6765 * cursor will be unset on the second call.
6767 * @see elm_object_cursor_set()
6768 * @see elm_gengrid_item_cursor_get()
6769 * @see elm_gengrid_item_cursor_unset()
6773 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6776 * Get the type of mouse pointer/cursor decoration set to be shown,
6777 * when the mouse pointer is over the given gengrid widget item
6779 * @param item gengrid item with custom cursor set
6780 * @return the cursor type's name or @c NULL, if no custom cursors
6781 * were set to @p item (and on errors)
6783 * @see elm_object_cursor_get()
6784 * @see elm_gengrid_item_cursor_set() for more details
6785 * @see elm_gengrid_item_cursor_unset()
6789 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6792 * Unset any custom mouse pointer/cursor decoration set to be
6793 * shown, when the mouse pointer is over the given gengrid widget
6794 * item, thus making it show the @b default cursor again.
6796 * @param item a gengrid item
6798 * Use this call to undo any custom settings on this item's cursor
6799 * decoration, bringing it back to defaults (no custom style set).
6801 * @see elm_object_cursor_unset()
6802 * @see elm_gengrid_item_cursor_set() for more details
6806 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6809 * Set a different @b style for a given custom cursor set for a
6812 * @param item gengrid item with custom cursor set
6813 * @param style the <b>theme style</b> to use (e.g. @c "default",
6814 * @c "transparent", etc)
6816 * This function only makes sense when one is using custom mouse
6817 * cursor decorations <b>defined in a theme file</b> , which can
6818 * have, given a cursor name/type, <b>alternate styles</b> on
6819 * it. It works analogously as elm_object_cursor_style_set(), but
6820 * here applied only to gengrid item objects.
6822 * @warning Before you set a cursor style you should have defined a
6823 * custom cursor previously on the item, with
6824 * elm_gengrid_item_cursor_set()
6826 * @see elm_gengrid_item_cursor_engine_only_set()
6827 * @see elm_gengrid_item_cursor_style_get()
6831 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6834 * Get the current @b style set for a given gengrid item's custom
6837 * @param item gengrid item with custom cursor set.
6838 * @return style the cursor style in use. If the object does not
6839 * have a cursor set, then @c NULL is returned.
6841 * @see elm_gengrid_item_cursor_style_set() for more details
6845 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6848 * Set if the (custom) cursor for a given gengrid item should be
6849 * searched in its theme, also, or should only rely on the
6852 * @param item item with custom (custom) cursor already set on
6853 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6854 * only on those provided by the rendering engine, @c EINA_FALSE to
6855 * have them searched on the widget's theme, as well.
6857 * @note This call is of use only if you've set a custom cursor
6858 * for gengrid items, with elm_gengrid_item_cursor_set().
6860 * @note By default, cursors will only be looked for between those
6861 * provided by the rendering engine.
6865 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6868 * Get if the (custom) cursor for a given gengrid item is being
6869 * searched in its theme, also, or is only relying on the rendering
6872 * @param item a gengrid item
6873 * @return @c EINA_TRUE, if cursors are being looked for only on
6874 * those provided by the rendering engine, @c EINA_FALSE if they
6875 * are being searched on the widget's theme, as well.
6877 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6881 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6884 * Remove all items from a given gengrid widget
6886 * @param obj The gengrid object.
6888 * This removes (and deletes) all items in @p obj, leaving it
6891 * @see elm_gengrid_item_del(), to remove just one item.
6895 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6898 * Get the selected item in a given gengrid widget
6900 * @param obj The gengrid object.
6901 * @return The selected item's handleor @c NULL, if none is
6902 * selected at the moment (and on errors)
6904 * This returns the selected item in @p obj. If multi selection is
6905 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6906 * the first item in the list is selected, which might not be very
6907 * useful. For that case, see elm_gengrid_selected_items_get().
6911 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6914 * Get <b>a list</b> of selected items in a given gengrid
6916 * @param obj The gengrid object.
6917 * @return The list of selected items or @c NULL, if none is
6918 * selected at the moment (and on errors)
6920 * This returns a list of the selected items, in the order that
6921 * they appear in the grid. This list is only valid as long as no
6922 * more items are selected or unselected (or unselected implictly
6923 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6926 * @see elm_gengrid_selected_item_get()
6930 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6937 * @defgroup Clock Clock
6939 * @image html img/widget/clock/preview-00.png
6940 * @image latex img/widget/clock/preview-00.eps
6942 * This is a @b digital clock widget. In its default theme, it has a
6943 * vintage "flipping numbers clock" appearance, which will animate
6944 * sheets of individual algarisms individually as time goes by.
6946 * A newly created clock will fetch system's time (already
6947 * considering local time adjustments) to start with, and will tick
6948 * accondingly. It may or may not show seconds.
6950 * Clocks have an @b edition mode. When in it, the sheets will
6951 * display extra arrow indications on the top and bottom and the
6952 * user may click on them to raise or lower the time values. After
6953 * it's told to exit edition mode, it will keep ticking with that
6954 * new time set (it keeps the difference from local time).
6956 * Also, when under edition mode, user clicks on the cited arrows
6957 * which are @b held for some time will make the clock to flip the
6958 * sheet, thus editing the time, continuosly and automatically for
6959 * the user. The interval between sheet flips will keep growing in
6960 * time, so that it helps the user to reach a time which is distant
6963 * The time display is, by default, in military mode (24h), but an
6964 * am/pm indicator may be optionally shown, too, when it will
6967 * Smart callbacks one can register to:
6968 * - "changed" - the clock's user changed the time
6970 * Here is an example on its usage:
6971 * @li @ref clock_example
6980 * Identifiers for which clock digits should be editable, when a
6981 * clock widget is in edition mode. Values may be ORed together to
6982 * make a mask, naturally.
6984 * @see elm_clock_edit_set()
6985 * @see elm_clock_digit_edit_set()
6987 typedef enum _Elm_Clock_Digedit
6989 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6990 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6991 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6992 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6993 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6994 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6995 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
6996 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
6997 } Elm_Clock_Digedit;
7000 * Add a new clock widget to the given parent Elementary
7001 * (container) object
7003 * @param parent The parent object
7004 * @return a new clock widget handle or @c NULL, on errors
7006 * This function inserts a new clock widget on the canvas.
7010 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7013 * Set a clock widget's time, programmatically
7015 * @param obj The clock widget object
7016 * @param hrs The hours to set
7017 * @param min The minutes to set
7018 * @param sec The secondes to set
7020 * This function updates the time that is showed by the clock
7023 * Values @b must be set within the following ranges:
7024 * - 0 - 23, for hours
7025 * - 0 - 59, for minutes
7026 * - 0 - 59, for seconds,
7028 * even if the clock is not in "military" mode.
7030 * @warning The behavior for values set out of those ranges is @b
7035 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7038 * Get a clock widget's time values
7040 * @param obj The clock object
7041 * @param[out] hrs Pointer to the variable to get the hours value
7042 * @param[out] min Pointer to the variable to get the minutes value
7043 * @param[out] sec Pointer to the variable to get the seconds value
7045 * This function gets the time set for @p obj, returning
7046 * it on the variables passed as the arguments to function
7048 * @note Use @c NULL pointers on the time values you're not
7049 * interested in: they'll be ignored by the function.
7053 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7056 * Set whether a given clock widget is under <b>edition mode</b> or
7057 * under (default) displaying-only mode.
7059 * @param obj The clock object
7060 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7061 * put it back to "displaying only" mode
7063 * This function makes a clock's time to be editable or not <b>by
7064 * user interaction</b>. When in edition mode, clocks @b stop
7065 * ticking, until one brings them back to canonical mode. The
7066 * elm_clock_digit_edit_set() function will influence which digits
7067 * of the clock will be editable. By default, all of them will be
7068 * (#ELM_CLOCK_NONE).
7070 * @note am/pm sheets, if being shown, will @b always be editable
7071 * under edition mode.
7073 * @see elm_clock_edit_get()
7077 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7080 * Retrieve whether a given clock widget is under <b>edition
7081 * mode</b> or under (default) displaying-only mode.
7083 * @param obj The clock object
7084 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7087 * This function retrieves whether the clock's time can be edited
7088 * or not by user interaction.
7090 * @see elm_clock_edit_set() for more details
7094 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7097 * Set what digits of the given clock widget should be editable
7098 * when in edition mode.
7100 * @param obj The clock object
7101 * @param digedit Bit mask indicating the digits to be editable
7102 * (values in #Elm_Clock_Digedit).
7104 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7105 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7108 * @see elm_clock_digit_edit_get()
7112 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7115 * Retrieve what digits of the given clock widget should be
7116 * editable when in edition mode.
7118 * @param obj The clock object
7119 * @return Bit mask indicating the digits to be editable
7120 * (values in #Elm_Clock_Digedit).
7122 * @see elm_clock_digit_edit_set() for more details
7126 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7129 * Set if the given clock widget must show hours in military or
7132 * @param obj The clock object
7133 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7136 * This function sets if the clock must show hours in military or
7137 * am/pm mode. In some countries like Brazil the military mode
7138 * (00-24h-format) is used, in opposition to the USA, where the
7139 * am/pm mode is more commonly used.
7141 * @see elm_clock_show_am_pm_get()
7145 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7148 * Get if the given clock widget shows hours in military or am/pm
7151 * @param obj The clock object
7152 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7155 * This function gets if the clock shows hours in military or am/pm
7158 * @see elm_clock_show_am_pm_set() for more details
7162 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7165 * Set if the given clock widget must show time with seconds or not
7167 * @param obj The clock object
7168 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7170 * This function sets if the given clock must show or not elapsed
7171 * seconds. By default, they are @b not shown.
7173 * @see elm_clock_show_seconds_get()
7177 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7180 * Get whether the given clock widget is showing time with seconds
7183 * @param obj The clock object
7184 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7186 * This function gets whether @p obj is showing or not the elapsed
7189 * @see elm_clock_show_seconds_set()
7193 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7196 * Set the interval on time updates for an user mouse button hold
7197 * on clock widgets' time edition.
7199 * @param obj The clock object
7200 * @param interval The (first) interval value in seconds
7202 * This interval value is @b decreased while the user holds the
7203 * mouse pointer either incrementing or decrementing a given the
7204 * clock digit's value.
7206 * This helps the user to get to a given time distant from the
7207 * current one easier/faster, as it will start to flip quicker and
7208 * quicker on mouse button holds.
7210 * The calculation for the next flip interval value, starting from
7211 * the one set with this call, is the previous interval divided by
7212 * 1.05, so it decreases a little bit.
7214 * The default starting interval value for automatic flips is
7217 * @see elm_clock_interval_get()
7221 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7224 * Get the interval on time updates for an user mouse button hold
7225 * on clock widgets' time edition.
7227 * @param obj The clock object
7228 * @return The (first) interval value, in seconds, set on it
7230 * @see elm_clock_interval_set() for more details
7234 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7241 * @defgroup Layout Layout
7243 * @image html img/widget/layout/preview-00.png
7244 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7246 * @image html img/layout-predefined.png
7247 * @image latex img/layout-predefined.eps width=\textwidth
7249 * This is a container widget that takes a standard Edje design file and
7250 * wraps it very thinly in a widget.
7252 * An Edje design (theme) file has a very wide range of possibilities to
7253 * describe the behavior of elements added to the Layout. Check out the Edje
7254 * documentation and the EDC reference to get more information about what can
7255 * be done with Edje.
7257 * Just like @ref List, @ref Box, and other container widgets, any
7258 * object added to the Layout will become its child, meaning that it will be
7259 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7261 * The Layout widget can contain as many Contents, Boxes or Tables as
7262 * described in its theme file. For instance, objects can be added to
7263 * different Tables by specifying the respective Table part names. The same
7264 * is valid for Content and Box.
7266 * The objects added as child of the Layout will behave as described in the
7267 * part description where they were added. There are 3 possible types of
7268 * parts where a child can be added:
7270 * @section secContent Content (SWALLOW part)
7272 * Only one object can be added to the @c SWALLOW part (but you still can
7273 * have many @c SWALLOW parts and one object on each of them). Use the @c
7274 * elm_layout_content_* set of functions to set, retrieve and unset objects
7275 * as content of the @c SWALLOW. After being set to this part, the object
7276 * size, position, visibility, clipping and other description properties
7277 * will be totally controled by the description of the given part (inside
7278 * the Edje theme file).
7280 * One can use @c evas_object_size_hint_* functions on the child to have some
7281 * kind of control over its behavior, but the resulting behavior will still
7282 * depend heavily on the @c SWALLOW part description.
7284 * The Edje theme also can change the part description, based on signals or
7285 * scripts running inside the theme. This change can also be animated. All of
7286 * this will affect the child object set as content accordingly. The object
7287 * size will be changed if the part size is changed, it will animate move if
7288 * the part is moving, and so on.
7290 * The following picture demonstrates a Layout widget with a child object
7291 * added to its @c SWALLOW:
7293 * @image html layout_swallow.png
7294 * @image latex layout_swallow.eps width=\textwidth
7296 * @section secBox Box (BOX part)
7298 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7299 * allows one to add objects to the box and have them distributed along its
7300 * area, accordingly to the specified @a layout property (now by @a layout we
7301 * mean the chosen layouting design of the Box, not the Layout widget
7304 * A similar effect for having a box with its position, size and other things
7305 * controled by the Layout theme would be to create an Elementary @ref Box
7306 * widget and add it as a Content in the @c SWALLOW part.
7308 * The main difference of using the Layout Box is that its behavior, the box
7309 * properties like layouting format, padding, align, etc. will be all
7310 * controled by the theme. This means, for example, that a signal could be
7311 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7312 * handled the signal by changing the box padding, or align, or both. Using
7313 * the Elementary @ref Box widget is not necessarily harder or easier, it
7314 * just depends on the circunstances and requirements.
7316 * The Layout Box can be used through the @c elm_layout_box_* set of
7319 * The following picture demonstrates a Layout widget with many child objects
7320 * added to its @c BOX part:
7322 * @image html layout_box.png
7323 * @image latex layout_box.eps width=\textwidth
7325 * @section secTable Table (TABLE part)
7327 * Just like the @ref secBox, the Layout Table is very similar to the
7328 * Elementary @ref Table widget. It allows one to add objects to the Table
7329 * specifying the row and column where the object should be added, and any
7330 * column or row span if necessary.
7332 * Again, we could have this design by adding a @ref Table widget to the @c
7333 * SWALLOW part using elm_layout_content_set(). The same difference happens
7334 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7335 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7337 * The Layout Table can be used through the @c elm_layout_table_* set of
7340 * The following picture demonstrates a Layout widget with many child objects
7341 * added to its @c TABLE part:
7343 * @image html layout_table.png
7344 * @image latex layout_table.eps width=\textwidth
7346 * @section secPredef Predefined Layouts
7348 * Another interesting thing about the Layout widget is that it offers some
7349 * predefined themes that come with the default Elementary theme. These
7350 * themes can be set by the call elm_layout_theme_set(), and provide some
7351 * basic functionality depending on the theme used.
7353 * Most of them already send some signals, some already provide a toolbar or
7354 * back and next buttons.
7356 * These are available predefined theme layouts. All of them have class = @c
7357 * layout, group = @c application, and style = one of the following options:
7359 * @li @c toolbar-content - application with toolbar and main content area
7360 * @li @c toolbar-content-back - application with toolbar and main content
7361 * area with a back button and title area
7362 * @li @c toolbar-content-back-next - application with toolbar and main
7363 * content area with a back and next buttons and title area
7364 * @li @c content-back - application with a main content area with a back
7365 * button and title area
7366 * @li @c content-back-next - application with a main content area with a
7367 * back and next buttons and title area
7368 * @li @c toolbar-vbox - application with toolbar and main content area as a
7370 * @li @c toolbar-table - application with toolbar and main content area as a
7373 * @section secExamples Examples
7375 * Some examples of the Layout widget can be found here:
7376 * @li @ref layout_example_01
7377 * @li @ref layout_example_02
7378 * @li @ref layout_example_03
7379 * @li @ref layout_example_edc
7384 * Add a new layout to the parent
7386 * @param parent The parent object
7387 * @return The new object or NULL if it cannot be created
7389 * @see elm_layout_file_set()
7390 * @see elm_layout_theme_set()
7394 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7396 * Set the file that will be used as layout
7398 * @param obj The layout object
7399 * @param file The path to file (edj) that will be used as layout
7400 * @param group The group that the layout belongs in edje file
7402 * @return (1 = success, 0 = error)
7406 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7408 * Set the edje group from the elementary theme that will be used as layout
7410 * @param obj The layout object
7411 * @param clas the clas of the group
7412 * @param group the group
7413 * @param style the style to used
7415 * @return (1 = success, 0 = error)
7419 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7421 * Set the layout content.
7423 * @param obj The layout object
7424 * @param swallow The swallow part name in the edje file
7425 * @param content The child that will be added in this layout object
7427 * Once the content object is set, a previously set one will be deleted.
7428 * If you want to keep that old content object, use the
7429 * elm_layout_content_unset() function.
7431 * @note In an Edje theme, the part used as a content container is called @c
7432 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7433 * expected to be a part name just like the second parameter of
7434 * elm_layout_box_append().
7436 * @see elm_layout_box_append()
7437 * @see elm_layout_content_get()
7438 * @see elm_layout_content_unset()
7443 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7445 * Get the child object in the given content part.
7447 * @param obj The layout object
7448 * @param swallow The SWALLOW part to get its content
7450 * @return The swallowed object or NULL if none or an error occurred
7452 * @see elm_layout_content_set()
7456 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7458 * Unset the layout content.
7460 * @param obj The layout object
7461 * @param swallow The swallow part name in the edje file
7462 * @return The content that was being used
7464 * Unparent and return the content object which was set for this part.
7466 * @see elm_layout_content_set()
7470 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7472 * Set the text of the given part
7474 * @param obj The layout object
7475 * @param part The TEXT part where to set the text
7476 * @param text The text to set
7479 * @deprecated use elm_object_text_* instead.
7481 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7483 * Get the text set in the given part
7485 * @param obj The layout object
7486 * @param part The TEXT part to retrieve the text off
7488 * @return The text set in @p part
7491 * @deprecated use elm_object_text_* instead.
7493 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7495 * Append child to layout box part.
7497 * @param obj the layout object
7498 * @param part the box part to which the object will be appended.
7499 * @param child the child object to append to box.
7501 * Once the object is appended, 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_prepend()
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_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7515 * Prepend child to layout box part.
7517 * @param obj the layout object
7518 * @param part the box part to prepend.
7519 * @param child the child object to prepend to box.
7521 * Once the object is prepended, it will become child of the layout. Its
7522 * lifetime will be bound to the layout, whenever the layout dies the child
7523 * will be deleted automatically. One should use elm_layout_box_remove() to
7524 * make this layout forget about the object.
7526 * @see elm_layout_box_append()
7527 * @see elm_layout_box_insert_before()
7528 * @see elm_layout_box_insert_at()
7529 * @see elm_layout_box_remove()
7533 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7535 * Insert child to layout box part before a reference object.
7537 * @param obj the layout object
7538 * @param part the box part to insert.
7539 * @param child the child object to insert into box.
7540 * @param reference another reference object to insert before in box.
7542 * Once the object is inserted, it will become child of the layout. Its
7543 * lifetime will be bound to the layout, whenever the layout dies the child
7544 * will be deleted automatically. One should use elm_layout_box_remove() to
7545 * make this layout forget about the object.
7547 * @see elm_layout_box_append()
7548 * @see elm_layout_box_prepend()
7549 * @see elm_layout_box_insert_before()
7550 * @see elm_layout_box_remove()
7554 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7556 * Insert child to layout box part at a given position.
7558 * @param obj the layout object
7559 * @param part the box part to insert.
7560 * @param child the child object to insert into box.
7561 * @param pos the numeric position >=0 to insert the child.
7563 * Once the object is inserted, it will become child of the layout. Its
7564 * lifetime will be bound to the layout, whenever the layout dies the child
7565 * will be deleted automatically. One should use elm_layout_box_remove() to
7566 * make this layout forget about the object.
7568 * @see elm_layout_box_append()
7569 * @see elm_layout_box_prepend()
7570 * @see elm_layout_box_insert_before()
7571 * @see elm_layout_box_remove()
7575 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7577 * Remove a child of the given part box.
7579 * @param obj The layout object
7580 * @param part The box part name to remove child.
7581 * @param child The object to remove from box.
7582 * @return The object that was being used, or NULL if not found.
7584 * The object will be removed from the box part and its lifetime will
7585 * not be handled by the layout anymore. This is equivalent to
7586 * elm_layout_content_unset() for box.
7588 * @see elm_layout_box_append()
7589 * @see elm_layout_box_remove_all()
7593 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7595 * Remove all child of the given part box.
7597 * @param obj The layout object
7598 * @param part The box part name to remove child.
7599 * @param clear If EINA_TRUE, then all objects will be deleted as
7600 * well, otherwise they will just be removed and will be
7601 * dangling on the canvas.
7603 * The objects will be removed from the box part and their lifetime will
7604 * not be handled by the layout anymore. This is equivalent to
7605 * elm_layout_box_remove() for all box children.
7607 * @see elm_layout_box_append()
7608 * @see elm_layout_box_remove()
7612 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7614 * Insert child to layout table part.
7616 * @param obj the layout object
7617 * @param part the box part to pack child.
7618 * @param child_obj the child object to pack into table.
7619 * @param col the column to which the child should be added. (>= 0)
7620 * @param row the row to which the child should be added. (>= 0)
7621 * @param colspan how many columns should be used to store this object. (>=
7623 * @param rowspan how many rows should be used to store this object. (>= 1)
7625 * Once the object is inserted, it will become child of the table. Its
7626 * lifetime will be bound to the layout, and whenever the layout dies the
7627 * child will be deleted automatically. One should use
7628 * elm_layout_table_remove() to make this layout forget about the object.
7630 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7631 * more space than a single cell. For instance, the following code:
7633 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7636 * Would result in an object being added like the following picture:
7638 * @image html layout_colspan.png
7639 * @image latex layout_colspan.eps width=\textwidth
7641 * @see elm_layout_table_unpack()
7642 * @see elm_layout_table_clear()
7646 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);
7648 * Unpack (remove) a child of the given part table.
7650 * @param obj The layout object
7651 * @param part The table part name to remove child.
7652 * @param child_obj The object to remove from table.
7653 * @return The object that was being used, or NULL if not found.
7655 * The object will be unpacked from the table part and its lifetime
7656 * will not be handled by the layout anymore. This is equivalent to
7657 * elm_layout_content_unset() for table.
7659 * @see elm_layout_table_pack()
7660 * @see elm_layout_table_clear()
7664 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7666 * Remove all child of the given part table.
7668 * @param obj The layout object
7669 * @param part The table part name to remove child.
7670 * @param clear If EINA_TRUE, then all objects will be deleted as
7671 * well, otherwise they will just be removed and will be
7672 * dangling on the canvas.
7674 * The objects will be removed from the table part and their lifetime will
7675 * not be handled by the layout anymore. This is equivalent to
7676 * elm_layout_table_unpack() for all table children.
7678 * @see elm_layout_table_pack()
7679 * @see elm_layout_table_unpack()
7683 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7685 * Get the edje layout
7687 * @param obj The layout object
7689 * @return A Evas_Object with the edje layout settings loaded
7690 * with function elm_layout_file_set
7692 * This returns the edje object. It is not expected to be used to then
7693 * swallow objects via edje_object_part_swallow() for example. Use
7694 * elm_layout_content_set() instead so child object handling and sizing is
7697 * @note This function should only be used if you really need to call some
7698 * low level Edje function on this edje object. All the common stuff (setting
7699 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7700 * with proper elementary functions.
7702 * @see elm_object_signal_callback_add()
7703 * @see elm_object_signal_emit()
7704 * @see elm_object_text_part_set()
7705 * @see elm_layout_content_set()
7706 * @see elm_layout_box_append()
7707 * @see elm_layout_table_pack()
7708 * @see elm_layout_data_get()
7712 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7714 * Get the edje data from the given layout
7716 * @param obj The layout object
7717 * @param key The data key
7719 * @return The edje data string
7721 * This function fetches data specified inside the edje theme of this layout.
7722 * This function return NULL if data is not found.
7724 * In EDC this comes from a data block within the group block that @p
7725 * obj was loaded from. E.g.
7732 * item: "key1" "value1";
7733 * item: "key2" "value2";
7741 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7745 * @param obj The layout object
7747 * Manually forces a sizing re-evaluation. This is useful when the minimum
7748 * size required by the edje theme of this layout has changed. The change on
7749 * the minimum size required by the edje theme is not immediately reported to
7750 * the elementary layout, so one needs to call this function in order to tell
7751 * the widget (layout) that it needs to reevaluate its own size.
7753 * The minimum size of the theme is calculated based on minimum size of
7754 * parts, the size of elements inside containers like box and table, etc. All
7755 * of this can change due to state changes, and that's when this function
7758 * Also note that a standard signal of "size,eval" "elm" emitted from the
7759 * edje object will cause this to happen too.
7763 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7764 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7765 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7766 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7767 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7768 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7769 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);
7770 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7772 * @def elm_layout_icon_set
7773 * Convienience macro to set the icon object in a layout that follows the
7774 * Elementary naming convention for its parts.
7778 #define elm_layout_icon_set(_ly, _obj) \
7781 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7782 if ((_obj)) sig = "elm,state,icon,visible"; \
7783 else sig = "elm,state,icon,hidden"; \
7784 elm_object_signal_emit((_ly), sig, "elm"); \
7788 * @def elm_layout_icon_get
7789 * Convienience macro to get the icon object from a layout that follows the
7790 * Elementary naming convention for its parts.
7794 #define elm_layout_icon_get(_ly) \
7795 elm_layout_content_get((_ly), "elm.swallow.icon")
7798 * @def elm_layout_end_set
7799 * Convienience macro to set the end object in a layout that follows the
7800 * Elementary naming convention for its parts.
7804 #define elm_layout_end_set(_ly, _obj) \
7807 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7808 if ((_obj)) sig = "elm,state,end,visible"; \
7809 else sig = "elm,state,end,hidden"; \
7810 elm_object_signal_emit((_ly), sig, "elm"); \
7814 * @def elm_layout_end_get
7815 * Convienience macro to get the end object in a layout that follows the
7816 * Elementary naming convention for its parts.
7820 #define elm_layout_end_get(_ly) \
7821 elm_layout_content_get((_ly), "elm.swallow.end")
7824 * @def elm_layout_label_set
7825 * Convienience macro to set the label in a layout that follows the
7826 * Elementary naming convention for its parts.
7829 * @deprecated use elm_object_text_* instead.
7831 #define elm_layout_label_set(_ly, _txt) \
7832 elm_layout_text_set((_ly), "elm.text", (_txt))
7835 * @def elm_layout_label_get
7836 * Convienience macro to get the label in a layout that follows the
7837 * Elementary naming convention for its parts.
7840 * @deprecated use elm_object_text_* instead.
7842 #define elm_layout_label_get(_ly) \
7843 elm_layout_text_get((_ly), "elm.text")
7845 /* smart callbacks called:
7846 * "theme,changed" - when elm theme is changed.
7850 * @defgroup Notify Notify
7852 * @image html img/widget/notify/preview-00.png
7853 * @image latex img/widget/notify/preview-00.eps
7855 * Display a container in a particular region of the parent(top, bottom,
7856 * etc. A timeout can be set to automatically hide the notify. This is so
7857 * that, after an evas_object_show() on a notify object, if a timeout was set
7858 * on it, it will @b automatically get hidden after that time.
7860 * Signals that you can add callbacks for are:
7861 * @li "timeout" - when timeout happens on notify and it's hidden
7862 * @li "block,clicked" - when a click outside of the notify happens
7864 * @ref tutorial_notify show usage of the API.
7869 * @brief Possible orient values for notify.
7871 * This values should be used in conjunction to elm_notify_orient_set() to
7872 * set the position in which the notify should appear(relative to its parent)
7873 * and in conjunction with elm_notify_orient_get() to know where the notify
7876 typedef enum _Elm_Notify_Orient
7878 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7879 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7880 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7881 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7882 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7883 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7884 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7885 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7886 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7887 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7888 } Elm_Notify_Orient;
7890 * @brief Add a new notify to the parent
7892 * @param parent The parent object
7893 * @return The new object or NULL if it cannot be created
7895 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7897 * @brief Set the content of the notify widget
7899 * @param obj The notify object
7900 * @param content The content will be filled in this notify object
7902 * Once the content object is set, a previously set one will be deleted. If
7903 * you want to keep that old content object, use the
7904 * elm_notify_content_unset() function.
7906 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7908 * @brief Unset the content of the notify widget
7910 * @param obj The notify object
7911 * @return The content that was being used
7913 * Unparent and return the content object which was set for this widget
7915 * @see elm_notify_content_set()
7917 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7919 * @brief Return the content of the notify widget
7921 * @param obj The notify object
7922 * @return The content that is being used
7924 * @see elm_notify_content_set()
7926 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7928 * @brief Set the notify parent
7930 * @param obj The notify object
7931 * @param content The new parent
7933 * Once the parent object is set, a previously set one will be disconnected
7936 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7938 * @brief Get the notify parent
7940 * @param obj The notify object
7941 * @return The parent
7943 * @see elm_notify_parent_set()
7945 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7947 * @brief Set the orientation
7949 * @param obj The notify object
7950 * @param orient The new orientation
7952 * Sets the position in which the notify will appear in its parent.
7954 * @see @ref Elm_Notify_Orient for possible values.
7956 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7958 * @brief Return the orientation
7959 * @param obj The notify object
7960 * @return The orientation of the notification
7962 * @see elm_notify_orient_set()
7963 * @see Elm_Notify_Orient
7965 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7967 * @brief Set the time interval after which the notify window is going to be
7970 * @param obj The notify object
7971 * @param time The timeout in seconds
7973 * This function sets a timeout and starts the timer controlling when the
7974 * notify is hidden. Since calling evas_object_show() on a notify restarts
7975 * the timer controlling when the notify is hidden, setting this before the
7976 * notify is shown will in effect mean starting the timer when the notify is
7979 * @note Set a value <= 0.0 to disable a running timer.
7981 * @note If the value > 0.0 and the notify is previously visible, the
7982 * timer will be started with this value, canceling any running timer.
7984 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7986 * @brief Return the timeout value (in seconds)
7987 * @param obj the notify object
7989 * @see elm_notify_timeout_set()
7991 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7993 * @brief Sets whether events should be passed to by a click outside
7996 * @param obj The notify object
7997 * @param repeats EINA_TRUE Events are repeats, else no
7999 * When true if the user clicks outside the window the events will be caught
8000 * by the others widgets, else the events are blocked.
8002 * @note The default value is EINA_TRUE.
8004 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8006 * @brief Return true if events are repeat below the notify object
8007 * @param obj the notify object
8009 * @see elm_notify_repeat_events_set()
8011 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8017 * @defgroup Hover Hover
8019 * @image html img/widget/hover/preview-00.png
8020 * @image latex img/widget/hover/preview-00.eps
8022 * A Hover object will hover over its @p parent object at the @p target
8023 * location. Anything in the background will be given a darker coloring to
8024 * indicate that the hover object is on top (at the default theme). When the
8025 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8026 * clicked that @b doesn't cause the hover to be dismissed.
8028 * @note The hover object will take up the entire space of @p target
8031 * Elementary has the following styles for the hover widget:
8035 * @li hoversel_vertical
8037 * The following are the available position for content:
8049 * Signals that you can add callbacks for are:
8050 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8051 * @li "smart,changed" - a content object placed under the "smart"
8052 * policy was replaced to a new slot direction.
8054 * See @ref tutorial_hover for more information.
8058 typedef enum _Elm_Hover_Axis
8060 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8061 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8062 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8063 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8066 * @brief Adds a hover object to @p parent
8068 * @param parent The parent object
8069 * @return The hover object or NULL if one could not be created
8071 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8073 * @brief Sets the target object for the hover.
8075 * @param obj The hover object
8076 * @param target The object to center the hover onto. The hover
8078 * This function will cause the hover to be centered on the target object.
8080 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8082 * @brief Gets the target object for the hover.
8084 * @param obj The hover object
8085 * @param parent The object to locate the hover over.
8087 * @see elm_hover_target_set()
8089 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8091 * @brief Sets the parent object for the hover.
8093 * @param obj The hover object
8094 * @param parent The object to locate the hover over.
8096 * This function will cause the hover to take up the entire space that the
8097 * parent object fills.
8099 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8101 * @brief Gets the parent object for the hover.
8103 * @param obj The hover object
8104 * @return The parent object to locate the hover over.
8106 * @see elm_hover_parent_set()
8108 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8110 * @brief Sets the content of the hover object and the direction in which it
8113 * @param obj The hover object
8114 * @param swallow The direction that the object will be displayed
8115 * at. Accepted values are "left", "top-left", "top", "top-right",
8116 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8118 * @param content The content to place at @p swallow
8120 * Once the content object is set for a given direction, a previously
8121 * set one (on the same direction) will be deleted. If you want to
8122 * keep that old content object, use the elm_hover_content_unset()
8125 * All directions may have contents at the same time, except for
8126 * "smart". This is a special placement hint and its use case
8127 * independs of the calculations coming from
8128 * elm_hover_best_content_location_get(). Its use is for cases when
8129 * one desires only one hover content, but with a dinamic special
8130 * placement within the hover area. The content's geometry, whenever
8131 * it changes, will be used to decide on a best location not
8132 * extrapolating the hover's parent object view to show it in (still
8133 * being the hover's target determinant of its medium part -- move and
8134 * resize it to simulate finger sizes, for example). If one of the
8135 * directions other than "smart" are used, a previously content set
8136 * using it will be deleted, and vice-versa.
8138 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8140 * @brief Get the content of the hover object, in a given direction.
8142 * Return the content object which was set for this widget in the
8143 * @p swallow direction.
8145 * @param obj The hover object
8146 * @param swallow The direction that the object was display at.
8147 * @return The content that was being used
8149 * @see elm_hover_content_set()
8151 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8153 * @brief Unset the content of the hover object, in a given direction.
8155 * Unparent and return the content object set at @p swallow direction.
8157 * @param obj The hover object
8158 * @param swallow The direction that the object was display at.
8159 * @return The content that was being used.
8161 * @see elm_hover_content_set()
8163 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8165 * @brief Returns the best swallow location for content in the hover.
8167 * @param obj The hover object
8168 * @param pref_axis The preferred orientation axis for the hover object to use
8169 * @return The edje location to place content into the hover or @c
8172 * Best is defined here as the location at which there is the most available
8175 * @p pref_axis may be one of
8176 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8177 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8178 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8179 * - @c ELM_HOVER_AXIS_BOTH -- both
8181 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8182 * nescessarily be along the horizontal axis("left" or "right"). If
8183 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8184 * be along the vertical axis("top" or "bottom"). Chossing
8185 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8186 * returned position may be in either axis.
8188 * @see elm_hover_content_set()
8190 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8197 * @defgroup Entry Entry
8199 * @image html img/widget/entry/preview-00.png
8200 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8201 * @image html img/widget/entry/preview-01.png
8202 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8203 * @image html img/widget/entry/preview-02.png
8204 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8205 * @image html img/widget/entry/preview-03.png
8206 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8208 * An entry is a convenience widget which shows a box that the user can
8209 * enter text into. Entries by default don't scroll, so they grow to
8210 * accomodate the entire text, resizing the parent window as needed. This
8211 * can be changed with the elm_entry_scrollable_set() function.
8213 * They can also be single line or multi line (the default) and when set
8214 * to multi line mode they support text wrapping in any of the modes
8215 * indicated by #Elm_Wrap_Type.
8217 * Other features include password mode, filtering of inserted text with
8218 * elm_entry_text_filter_append() and related functions, inline "items" and
8219 * formatted markup text.
8221 * @section entry-markup Formatted text
8223 * The markup tags supported by the Entry are defined by the theme, but
8224 * even when writing new themes or extensions it's a good idea to stick to
8225 * a sane default, to maintain coherency and avoid application breakages.
8226 * Currently defined by the default theme are the following tags:
8227 * @li \<br\>: Inserts a line break.
8228 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8230 * @li \<tab\>: Inserts a tab.
8231 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8233 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8234 * @li \<link\>...\</link\>: Underlines the enclosed text.
8235 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8237 * @section entry-special Special markups
8239 * Besides those used to format text, entries support two special markup
8240 * tags used to insert clickable portions of text or items inlined within
8243 * @subsection entry-anchors Anchors
8245 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8246 * \</a\> tags and an event will be generated when this text is clicked,
8250 * This text is outside <a href=anc-01>but this one is an anchor</a>
8253 * The @c href attribute in the opening tag gives the name that will be
8254 * used to identify the anchor and it can be any valid utf8 string.
8256 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8257 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8258 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8259 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8262 * @subsection entry-items Items
8264 * Inlined in the text, any other @c Evas_Object can be inserted by using
8265 * \<item\> tags this way:
8268 * <item size=16x16 vsize=full href=emoticon/haha></item>
8271 * Just like with anchors, the @c href identifies each item, but these need,
8272 * in addition, to indicate their size, which is done using any one of
8273 * @c size, @c absize or @c relsize attributes. These attributes take their
8274 * value in the WxH format, where W is the width and H the height of the
8277 * @li absize: Absolute pixel size for the item. Whatever value is set will
8278 * be the item's size regardless of any scale value the object may have
8279 * been set to. The final line height will be adjusted to fit larger items.
8280 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8282 * @li relsize: Size is adjusted for the item to fit within the current
8285 * Besides their size, items are specificed a @c vsize value that affects
8286 * how their final size and position are calculated. The possible values
8288 * @li ascent: Item will be placed within the line's baseline and its
8289 * ascent. That is, the height between the line where all characters are
8290 * positioned and the highest point in the line. For @c size and @c absize
8291 * items, the descent value will be added to the total line height to make
8292 * them fit. @c relsize items will be adjusted to fit within this space.
8293 * @li full: Items will be placed between the descent and ascent, or the
8294 * lowest point in the line and its highest.
8296 * The next image shows different configurations of items and how they
8297 * are the previously mentioned options affect their sizes. In all cases,
8298 * the green line indicates the ascent, blue for the baseline and red for
8301 * @image html entry_item.png
8302 * @image latex entry_item.eps width=\textwidth
8304 * And another one to show how size differs from absize. In the first one,
8305 * the scale value is set to 1.0, while the second one is using one of 2.0.
8307 * @image html entry_item_scale.png
8308 * @image latex entry_item_scale.eps width=\textwidth
8310 * After the size for an item is calculated, the entry will request an
8311 * object to place in its space. For this, the functions set with
8312 * elm_entry_item_provider_append() and related functions will be called
8313 * in order until one of them returns a @c non-NULL value. If no providers
8314 * are available, or all of them return @c NULL, then the entry falls back
8315 * to one of the internal defaults, provided the name matches with one of
8318 * All of the following are currently supported:
8321 * - emoticon/angry-shout
8322 * - emoticon/crazy-laugh
8323 * - emoticon/evil-laugh
8325 * - emoticon/goggle-smile
8327 * - emoticon/grumpy-smile
8329 * - emoticon/guilty-smile
8331 * - emoticon/half-smile
8332 * - emoticon/happy-panting
8334 * - emoticon/indifferent
8336 * - emoticon/knowing-grin
8338 * - emoticon/little-bit-sorry
8339 * - emoticon/love-lots
8341 * - emoticon/minimal-smile
8342 * - emoticon/not-happy
8343 * - emoticon/not-impressed
8345 * - emoticon/opensmile
8348 * - emoticon/squint-laugh
8349 * - emoticon/surprised
8350 * - emoticon/suspicious
8351 * - emoticon/tongue-dangling
8352 * - emoticon/tongue-poke
8354 * - emoticon/unhappy
8355 * - emoticon/very-sorry
8358 * - emoticon/worried
8361 * Alternatively, an item may reference an image by its path, using
8362 * the URI form @c file:///path/to/an/image.png and the entry will then
8363 * use that image for the item.
8365 * @section entry-files Loading and saving files
8367 * Entries have convinience functions to load text from a file and save
8368 * changes back to it after a short delay. The automatic saving is enabled
8369 * by default, but can be disabled with elm_entry_autosave_set() and files
8370 * can be loaded directly as plain text or have any markup in them
8371 * recognized. See elm_entry_file_set() for more details.
8373 * @section entry-signals Emitted signals
8375 * This widget emits the following signals:
8377 * @li "changed": The text within the entry was changed.
8378 * @li "changed,user": The text within the entry was changed because of user interaction.
8379 * @li "activated": The enter key was pressed on a single line entry.
8380 * @li "press": A mouse button has been pressed on the entry.
8381 * @li "longpressed": A mouse button has been pressed and held for a couple
8383 * @li "clicked": The entry has been clicked (mouse press and release).
8384 * @li "clicked,double": The entry has been double clicked.
8385 * @li "clicked,triple": The entry has been triple clicked.
8386 * @li "focused": The entry has received focus.
8387 * @li "unfocused": The entry has lost focus.
8388 * @li "selection,paste": A paste of the clipboard contents was requested.
8389 * @li "selection,copy": A copy of the selected text into the clipboard was
8391 * @li "selection,cut": A cut of the selected text into the clipboard was
8393 * @li "selection,start": A selection has begun and no previous selection
8395 * @li "selection,changed": The current selection has changed.
8396 * @li "selection,cleared": The current selection has been cleared.
8397 * @li "cursor,changed": The cursor has changed position.
8398 * @li "anchor,clicked": An anchor has been clicked. The event_info
8399 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8400 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8401 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8402 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8403 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8404 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8405 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8406 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8407 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8408 * @li "preedit,changed": The preedit string has changed.
8410 * @section entry-examples
8412 * An overview of the Entry API can be seen in @ref entry_example_01
8417 * @typedef Elm_Entry_Anchor_Info
8419 * The info sent in the callback for the "anchor,clicked" signals emitted
8422 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8424 * @struct _Elm_Entry_Anchor_Info
8426 * The info sent in the callback for the "anchor,clicked" signals emitted
8429 struct _Elm_Entry_Anchor_Info
8431 const char *name; /**< The name of the anchor, as stated in its href */
8432 int button; /**< The mouse button used to click on it */
8433 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8434 y, /**< Anchor geometry, relative to canvas */
8435 w, /**< Anchor geometry, relative to canvas */
8436 h; /**< Anchor geometry, relative to canvas */
8439 * @typedef Elm_Entry_Filter_Cb
8440 * This callback type is used by entry filters to modify text.
8441 * @param data The data specified as the last param when adding the filter
8442 * @param entry The entry object
8443 * @param text A pointer to the location of the text being filtered. This data can be modified,
8444 * but any additional allocations must be managed by the user.
8445 * @see elm_entry_text_filter_append
8446 * @see elm_entry_text_filter_prepend
8448 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8451 * This adds an entry to @p parent object.
8453 * By default, entries are:
8457 * @li autosave is enabled
8459 * @param parent The parent object
8460 * @return The new object or NULL if it cannot be created
8462 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8464 * Sets the entry to single line mode.
8466 * In single line mode, entries don't ever wrap when the text reaches the
8467 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8468 * key will generate an @c "activate" event instead of adding a new line.
8470 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8471 * and pressing enter will break the text into a different line
8472 * without generating any events.
8474 * @param obj The entry object
8475 * @param single_line If true, the text in the entry
8476 * will be on a single line.
8478 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8480 * Gets whether the entry is set to be single line.
8482 * @param obj The entry object
8483 * @return single_line If true, the text in the entry is set to display
8486 * @see elm_entry_single_line_set()
8488 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8490 * Sets the entry to password mode.
8492 * In password mode, entries are implicitly single line and the display of
8493 * any text in them is replaced with asterisks (*).
8495 * @param obj The entry object
8496 * @param password If true, password mode is enabled.
8498 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8500 * Gets whether the entry is set to password mode.
8502 * @param obj The entry object
8503 * @return If true, the entry is set to display all characters
8506 * @see elm_entry_password_set()
8508 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8510 * This sets the text displayed within the entry to @p entry.
8512 * @param obj The entry object
8513 * @param entry The text to be displayed
8515 * @deprecated Use elm_object_text_set() instead.
8517 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8519 * This returns the text currently shown in object @p entry.
8520 * See also elm_entry_entry_set().
8522 * @param obj The entry object
8523 * @return The currently displayed text or NULL on failure
8525 * @deprecated Use elm_object_text_get() instead.
8527 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8529 * Appends @p entry to the text of the entry.
8531 * Adds the text in @p entry to the end of any text already present in the
8534 * The appended text is subject to any filters set for the widget.
8536 * @param obj The entry object
8537 * @param entry The text to be displayed
8539 * @see elm_entry_text_filter_append()
8541 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8543 * Gets whether the entry is empty.
8545 * Empty means no text at all. If there are any markup tags, like an item
8546 * tag for which no provider finds anything, and no text is displayed, this
8547 * function still returns EINA_FALSE.
8549 * @param obj The entry object
8550 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8552 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8554 * Gets any selected text within the entry.
8556 * If there's any selected text in the entry, this function returns it as
8557 * a string in markup format. NULL is returned if no selection exists or
8558 * if an error occurred.
8560 * The returned value points to an internal string and should not be freed
8561 * or modified in any way. If the @p entry object is deleted or its
8562 * contents are changed, the returned pointer should be considered invalid.
8564 * @param obj The entry object
8565 * @return The selected text within the entry or NULL on failure
8567 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8569 * Inserts the given text into the entry at the current cursor position.
8571 * This inserts text at the cursor position as if it was typed
8572 * by the user (note that this also allows markup which a user
8573 * can't just "type" as it would be converted to escaped text, so this
8574 * call can be used to insert things like emoticon items or bold push/pop
8575 * tags, other font and color change tags etc.)
8577 * If any selection exists, it will be replaced by the inserted text.
8579 * The inserted text is subject to any filters set for the widget.
8581 * @param obj The entry object
8582 * @param entry The text to insert
8584 * @see elm_entry_text_filter_append()
8586 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8588 * Set the line wrap type to use on multi-line entries.
8590 * Sets the wrap type used by the entry to any of the specified in
8591 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8592 * line (without inserting a line break or paragraph separator) when it
8593 * reaches the far edge of the widget.
8595 * Note that this only makes sense for multi-line entries. A widget set
8596 * to be single line will never wrap.
8598 * @param obj The entry object
8599 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8601 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8603 * Gets the wrap mode the entry was set to use.
8605 * @param obj The entry object
8608 * @see also elm_entry_line_wrap_set()
8610 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8612 * Sets if the entry is to be editable or not.
8614 * By default, entries are editable and when focused, any text input by the
8615 * user will be inserted at the current cursor position. But calling this
8616 * function with @p editable as EINA_FALSE will prevent the user from
8617 * inputting text into the entry.
8619 * The only way to change the text of a non-editable entry is to use
8620 * elm_object_text_set(), elm_entry_entry_insert() and other related
8623 * @param obj The entry object
8624 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8625 * if not, the entry is read-only and no user input is allowed.
8627 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8629 * Gets whether the entry is editable or not.
8631 * @param obj The entry object
8632 * @return If true, the entry is editable by the user.
8633 * If false, it is not editable by the user
8635 * @see elm_entry_editable_set()
8637 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8639 * This drops any existing text selection within the entry.
8641 * @param obj The entry object
8643 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8645 * This selects all text within the entry.
8647 * @param obj The entry object
8649 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8651 * This moves the cursor one place to the right within the entry.
8653 * @param obj The entry object
8654 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8656 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8658 * This moves the cursor one place to the left within the entry.
8660 * @param obj The entry object
8661 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8663 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8665 * This moves the cursor one line up within the entry.
8667 * @param obj The entry object
8668 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8670 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8672 * This moves the cursor one line down within the entry.
8674 * @param obj The entry object
8675 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8677 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8679 * This moves the cursor to the beginning of the entry.
8681 * @param obj The entry object
8683 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8685 * This moves the cursor to the end of the entry.
8687 * @param obj The entry object
8689 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8691 * This moves the cursor to the beginning of the current line.
8693 * @param obj The entry object
8695 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8697 * This moves the cursor to the end of the current line.
8699 * @param obj The entry object
8701 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8703 * This begins a selection within the entry as though
8704 * the user were holding down the mouse button to make a selection.
8706 * @param obj The entry object
8708 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8710 * This ends a selection within the entry as though
8711 * the user had just released the mouse button while making a selection.
8713 * @param obj The entry object
8715 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8717 * Gets whether a format node exists at the current cursor position.
8719 * A format node is anything that defines how the text is rendered. It can
8720 * be a visible format node, such as a line break or a paragraph separator,
8721 * or an invisible one, such as bold begin or end tag.
8722 * This function returns whether any format node exists at the current
8725 * @param obj The entry object
8726 * @return EINA_TRUE if the current cursor position contains a format node,
8727 * EINA_FALSE otherwise.
8729 * @see elm_entry_cursor_is_visible_format_get()
8731 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8733 * Gets if the current cursor position holds a visible format node.
8735 * @param obj The entry object
8736 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8737 * if it's an invisible one or no format exists.
8739 * @see elm_entry_cursor_is_format_get()
8741 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8743 * Gets the character pointed by the cursor at its current position.
8745 * This function returns a string with the utf8 character stored at the
8746 * current cursor position.
8747 * Only the text is returned, any format that may exist will not be part
8748 * of the return value.
8750 * @param obj The entry object
8751 * @return The text pointed by the cursors.
8753 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8755 * This function returns the geometry of the cursor.
8757 * It's useful if you want to draw something on the cursor (or where it is),
8758 * or for example in the case of scrolled entry where you want to show the
8761 * @param obj The entry object
8762 * @param x returned geometry
8763 * @param y returned geometry
8764 * @param w returned geometry
8765 * @param h returned geometry
8766 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8768 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);
8770 * Sets the cursor position in the entry to the given value
8772 * The value in @p pos is the index of the character position within the
8773 * contents of the string as returned by elm_entry_cursor_pos_get().
8775 * @param obj The entry object
8776 * @param pos The position of the cursor
8778 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8780 * Retrieves the current position of the cursor in the entry
8782 * @param obj The entry object
8783 * @return The cursor position
8785 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8787 * This executes a "cut" action on the selected text in the entry.
8789 * @param obj The entry object
8791 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8793 * This executes a "copy" action on the selected text in the entry.
8795 * @param obj The entry object
8797 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8799 * This executes a "paste" action in the entry.
8801 * @param obj The entry object
8803 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8805 * This clears and frees the items in a entry's contextual (longpress)
8808 * @param obj The entry object
8810 * @see elm_entry_context_menu_item_add()
8812 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8814 * This adds an item to the entry's contextual menu.
8816 * A longpress on an entry will make the contextual menu show up, if this
8817 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8818 * By default, this menu provides a few options like enabling selection mode,
8819 * which is useful on embedded devices that need to be explicit about it,
8820 * and when a selection exists it also shows the copy and cut actions.
8822 * With this function, developers can add other options to this menu to
8823 * perform any action they deem necessary.
8825 * @param obj The entry object
8826 * @param label The item's text label
8827 * @param icon_file The item's icon file
8828 * @param icon_type The item's icon type
8829 * @param func The callback to execute when the item is clicked
8830 * @param data The data to associate with the item for related functions
8832 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);
8834 * This disables the entry's contextual (longpress) menu.
8836 * @param obj The entry object
8837 * @param disabled If true, the menu is disabled
8839 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8841 * This returns whether the entry's contextual (longpress) menu is
8844 * @param obj The entry object
8845 * @return If true, the menu is disabled
8847 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8849 * This appends a custom item provider to the list for that entry
8851 * This appends the given callback. The list is walked from beginning to end
8852 * with each function called given the item href string in the text. If the
8853 * function returns an object handle other than NULL (it should create an
8854 * object to do this), then this object is used to replace that item. If
8855 * not the next provider is called until one provides an item object, or the
8856 * default provider in entry does.
8858 * @param obj The entry object
8859 * @param func The function called to provide the item object
8860 * @param data The data passed to @p func
8862 * @see @ref entry-items
8864 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);
8866 * This prepends a custom item provider to the list for that entry
8868 * This prepends the given callback. See elm_entry_item_provider_append() for
8871 * @param obj The entry object
8872 * @param func The function called to provide the item object
8873 * @param data The data passed to @p func
8875 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);
8877 * This removes a custom item provider to the list for that entry
8879 * This removes the given callback. See elm_entry_item_provider_append() for
8882 * @param obj The entry object
8883 * @param func The function called to provide the item object
8884 * @param data The data passed to @p func
8886 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);
8888 * Append a filter function for text inserted in the entry
8890 * Append the given callback to the list. This functions will be called
8891 * whenever any text is inserted into the entry, with the text to be inserted
8892 * as a parameter. The callback function is free to alter the text in any way
8893 * it wants, but it must remember to free the given pointer and update it.
8894 * If the new text is to be discarded, the function can free it and set its
8895 * text parameter to NULL. This will also prevent any following filters from
8898 * @param obj The entry object
8899 * @param func The function to use as text filter
8900 * @param data User data to pass to @p func
8902 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8904 * Prepend a filter function for text insdrted in the entry
8906 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8907 * for more information
8909 * @param obj The entry object
8910 * @param func The function to use as text filter
8911 * @param data User data to pass to @p func
8913 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8915 * Remove a filter from the list
8917 * Removes the given callback from the filter list. See
8918 * elm_entry_text_filter_append() for more information.
8920 * @param obj The entry object
8921 * @param func The filter function to remove
8922 * @param data The user data passed when adding the function
8924 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8926 * This converts a markup (HTML-like) string into UTF-8.
8928 * The returned string is a malloc'ed buffer and it should be freed when
8929 * not needed anymore.
8931 * @param s The string (in markup) to be converted
8932 * @return The converted string (in UTF-8). It should be freed.
8934 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8936 * This converts a UTF-8 string into markup (HTML-like).
8938 * The returned string is a malloc'ed buffer and it should be freed when
8939 * not needed anymore.
8941 * @param s The string (in UTF-8) to be converted
8942 * @return The converted string (in markup). It should be freed.
8944 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8946 * This sets the file (and implicitly loads it) for the text to display and
8947 * then edit. All changes are written back to the file after a short delay if
8948 * the entry object is set to autosave (which is the default).
8950 * If the entry had any other file set previously, any changes made to it
8951 * will be saved if the autosave feature is enabled, otherwise, the file
8952 * will be silently discarded and any non-saved changes will be lost.
8954 * @param obj The entry object
8955 * @param file The path to the file to load and save
8956 * @param format The file format
8958 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8960 * Gets the file being edited by the entry.
8962 * This function can be used to retrieve any file set on the entry for
8963 * edition, along with the format used to load and save it.
8965 * @param obj The entry object
8966 * @param file The path to the file to load and save
8967 * @param format The file format
8969 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8971 * This function writes any changes made to the file set with
8972 * elm_entry_file_set()
8974 * @param obj The entry object
8976 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8978 * This sets the entry object to 'autosave' the loaded text file or not.
8980 * @param obj The entry object
8981 * @param autosave Autosave the loaded file or not
8983 * @see elm_entry_file_set()
8985 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8987 * This gets the entry object's 'autosave' status.
8989 * @param obj The entry object
8990 * @return Autosave the loaded file or not
8992 * @see elm_entry_file_set()
8994 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8996 * Control pasting of text and images for the widget.
8998 * Normally the entry allows both text and images to be pasted. By setting
8999 * textonly to be true, this prevents images from being pasted.
9001 * Note this only changes the behaviour of text.
9003 * @param obj The entry object
9004 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9007 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9009 * Getting elm_entry text paste/drop mode.
9011 * In textonly mode, only text may be pasted or dropped into the widget.
9013 * @param obj The entry object
9014 * @return If the widget only accepts text from pastes.
9016 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9018 * Enable or disable scrolling in entry
9020 * Normally the entry is not scrollable unless you enable it with this call.
9022 * @param obj The entry object
9023 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9025 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9027 * Get the scrollable state of the entry
9029 * Normally the entry is not scrollable. This gets the scrollable state
9030 * of the entry. See elm_entry_scrollable_set() for more information.
9032 * @param obj The entry object
9033 * @return The scrollable state
9035 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9037 * This sets a widget to be displayed to the left of a scrolled entry.
9039 * @param obj The scrolled entry object
9040 * @param icon The widget to display on the left side of the scrolled
9043 * @note A previously set widget will be destroyed.
9044 * @note If the object being set does not have minimum size hints set,
9045 * it won't get properly displayed.
9047 * @see elm_entry_end_set()
9049 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9051 * Gets the leftmost widget of the scrolled entry. This object is
9052 * owned by the scrolled entry and should not be modified.
9054 * @param obj The scrolled entry object
9055 * @return the left widget inside the scroller
9057 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9059 * Unset the leftmost widget of the scrolled entry, unparenting and
9062 * @param obj The scrolled entry object
9063 * @return the previously set icon sub-object of this entry, on
9066 * @see elm_entry_icon_set()
9068 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9070 * Sets the visibility of the left-side widget of the scrolled entry,
9071 * set by elm_entry_icon_set().
9073 * @param obj The scrolled entry object
9074 * @param setting EINA_TRUE if the object should be displayed,
9075 * EINA_FALSE if not.
9077 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9079 * This sets a widget to be displayed to the end of a scrolled entry.
9081 * @param obj The scrolled entry object
9082 * @param end The widget to display on the right side of the scrolled
9085 * @note A previously set widget will be destroyed.
9086 * @note If the object being set does not have minimum size hints set,
9087 * it won't get properly displayed.
9089 * @see elm_entry_icon_set
9091 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9093 * Gets the endmost widget of the scrolled entry. This object is owned
9094 * by the scrolled entry and should not be modified.
9096 * @param obj The scrolled entry object
9097 * @return the right widget inside the scroller
9099 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9101 * Unset the endmost widget of the scrolled entry, unparenting and
9104 * @param obj The scrolled entry object
9105 * @return the previously set icon sub-object of this entry, on
9108 * @see elm_entry_icon_set()
9110 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9112 * Sets the visibility of the end widget of the scrolled entry, set by
9113 * elm_entry_end_set().
9115 * @param obj The scrolled entry object
9116 * @param setting EINA_TRUE if the object should be displayed,
9117 * EINA_FALSE if not.
9119 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9121 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9124 * Setting an entry to single-line mode with elm_entry_single_line_set()
9125 * will automatically disable the display of scrollbars when the entry
9126 * moves inside its scroller.
9128 * @param obj The scrolled entry object
9129 * @param h The horizontal scrollbar policy to apply
9130 * @param v The vertical scrollbar policy to apply
9132 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9134 * This enables/disables bouncing within the entry.
9136 * This function sets whether the entry will bounce when scrolling reaches
9137 * the end of the contained entry.
9139 * @param obj The scrolled entry object
9140 * @param h The horizontal bounce state
9141 * @param v The vertical bounce state
9143 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9145 * Get the bounce mode
9147 * @param obj The Entry object
9148 * @param h_bounce Allow bounce horizontally
9149 * @param v_bounce Allow bounce vertically
9151 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9153 /* pre-made filters for entries */
9155 * @typedef Elm_Entry_Filter_Limit_Size
9157 * Data for the elm_entry_filter_limit_size() entry filter.
9159 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9161 * @struct _Elm_Entry_Filter_Limit_Size
9163 * Data for the elm_entry_filter_limit_size() entry filter.
9165 struct _Elm_Entry_Filter_Limit_Size
9167 int max_char_count; /**< The maximum number of characters allowed. */
9168 int max_byte_count; /**< The maximum number of bytes allowed*/
9171 * Filter inserted text based on user defined character and byte limits
9173 * Add this filter to an entry to limit the characters that it will accept
9174 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9175 * The funtion works on the UTF-8 representation of the string, converting
9176 * it from the set markup, thus not accounting for any format in it.
9178 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9179 * it as data when setting the filter. In it, it's possible to set limits
9180 * by character count or bytes (any of them is disabled if 0), and both can
9181 * be set at the same time. In that case, it first checks for characters,
9184 * The function will cut the inserted text in order to allow only the first
9185 * number of characters that are still allowed. The cut is made in
9186 * characters, even when limiting by bytes, in order to always contain
9187 * valid ones and avoid half unicode characters making it in.
9189 * This filter, like any others, does not apply when setting the entry text
9190 * directly with elm_object_text_set() (or the deprecated
9191 * elm_entry_entry_set()).
9193 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9195 * @typedef Elm_Entry_Filter_Accept_Set
9197 * Data for the elm_entry_filter_accept_set() entry filter.
9199 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9201 * @struct _Elm_Entry_Filter_Accept_Set
9203 * Data for the elm_entry_filter_accept_set() entry filter.
9205 struct _Elm_Entry_Filter_Accept_Set
9207 const char *accepted; /**< Set of characters accepted in the entry. */
9208 const char *rejected; /**< Set of characters rejected from the entry. */
9211 * Filter inserted text based on accepted or rejected sets of characters
9213 * Add this filter to an entry to restrict the set of accepted characters
9214 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9215 * This structure contains both accepted and rejected sets, but they are
9216 * mutually exclusive.
9218 * The @c accepted set takes preference, so if it is set, the filter will
9219 * only work based on the accepted characters, ignoring anything in the
9220 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9222 * In both cases, the function filters by matching utf8 characters to the
9223 * raw markup text, so it can be used to remove formatting tags.
9225 * This filter, like any others, does not apply when setting the entry text
9226 * directly with elm_object_text_set() (or the deprecated
9227 * elm_entry_entry_set()).
9229 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9234 /* composite widgets - these basically put together basic widgets above
9235 * in convenient packages that do more than basic stuff */
9239 * @defgroup Anchorview Anchorview
9241 * @image html img/widget/anchorview/preview-00.png
9242 * @image latex img/widget/anchorview/preview-00.eps
9244 * Anchorview is for displaying text that contains markup with anchors
9245 * like <c>\<a href=1234\>something\</\></c> in it.
9247 * Besides being styled differently, the anchorview widget provides the
9248 * necessary functionality so that clicking on these anchors brings up a
9249 * popup with user defined content such as "call", "add to contacts" or
9250 * "open web page". This popup is provided using the @ref Hover widget.
9252 * This widget is very similar to @ref Anchorblock, so refer to that
9253 * widget for an example. The only difference Anchorview has is that the
9254 * widget is already provided with scrolling functionality, so if the
9255 * text set to it is too large to fit in the given space, it will scroll,
9256 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9257 * text can be displayed.
9259 * This widget emits the following signals:
9260 * @li "anchor,clicked": will be called when an anchor is clicked. The
9261 * @p event_info parameter on the callback will be a pointer of type
9262 * ::Elm_Entry_Anchorview_Info.
9264 * See @ref Anchorblock for an example on how to use both of them.
9273 * @typedef Elm_Entry_Anchorview_Info
9275 * The info sent in the callback for "anchor,clicked" signals emitted by
9276 * the Anchorview widget.
9278 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9280 * @struct _Elm_Entry_Anchorview_Info
9282 * The info sent in the callback for "anchor,clicked" signals emitted by
9283 * the Anchorview widget.
9285 struct _Elm_Entry_Anchorview_Info
9287 const char *name; /**< Name of the anchor, as indicated in its href
9289 int button; /**< The mouse button used to click on it */
9290 Evas_Object *hover; /**< The hover object to use for the popup */
9292 Evas_Coord x, y, w, h;
9293 } anchor, /**< Geometry selection of text used as anchor */
9294 hover_parent; /**< Geometry of the object used as parent by the
9296 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9297 for content on the left side of
9298 the hover. Before calling the
9299 callback, the widget will make the
9300 necessary calculations to check
9301 which sides are fit to be set with
9302 content, based on the position the
9303 hover is activated and its distance
9304 to the edges of its parent object
9306 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9307 the right side of the hover.
9308 See @ref hover_left */
9309 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9310 of the hover. See @ref hover_left */
9311 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9312 below the hover. See @ref
9316 * Add a new Anchorview object
9318 * @param parent The parent object
9319 * @return The new object or NULL if it cannot be created
9321 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9323 * Set the text to show in the anchorview
9325 * Sets the text of the anchorview to @p text. This text can include markup
9326 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9327 * text that will be specially styled and react to click events, ended with
9328 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9329 * "anchor,clicked" signal that you can attach a callback to with
9330 * evas_object_smart_callback_add(). The name of the anchor given in the
9331 * event info struct will be the one set in the href attribute, in this
9334 * Other markup can be used to style the text in different ways, but it's
9335 * up to the style defined in the theme which tags do what.
9336 * @deprecated use elm_object_text_set() instead.
9338 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9340 * Get the markup text set for the anchorview
9342 * Retrieves the text set on the anchorview, with markup tags included.
9344 * @param obj The anchorview object
9345 * @return The markup text set or @c NULL if nothing was set or an error
9347 * @deprecated use elm_object_text_set() instead.
9349 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9351 * Set the parent of the hover popup
9353 * Sets the parent object to use by the hover created by the anchorview
9354 * when an anchor is clicked. See @ref Hover for more details on this.
9355 * If no parent is set, the same anchorview object will be used.
9357 * @param obj The anchorview object
9358 * @param parent The object to use as parent for the hover
9360 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9362 * Get the parent of the hover popup
9364 * Get the object used as parent for the hover created by the anchorview
9365 * widget. See @ref Hover for more details on this.
9367 * @param obj The anchorview object
9368 * @return The object used as parent for the hover, NULL if none is set.
9370 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9372 * Set the style that the hover should use
9374 * When creating the popup hover, anchorview will request that it's
9375 * themed according to @p style.
9377 * @param obj The anchorview object
9378 * @param style The style to use for the underlying hover
9380 * @see elm_object_style_set()
9382 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9384 * Get the style that the hover should use
9386 * Get the style the hover created by anchorview will use.
9388 * @param obj The anchorview object
9389 * @return The style to use by the hover. NULL means the default is used.
9391 * @see elm_object_style_set()
9393 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9395 * Ends the hover popup in the anchorview
9397 * When an anchor is clicked, the anchorview widget will create a hover
9398 * object to use as a popup with user provided content. This function
9399 * terminates this popup, returning the anchorview to its normal state.
9401 * @param obj The anchorview object
9403 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9405 * Set bouncing behaviour when the scrolled content reaches an edge
9407 * Tell the internal scroller object whether it should bounce or not
9408 * when it reaches the respective edges for each axis.
9410 * @param obj The anchorview object
9411 * @param h_bounce Whether to bounce or not in the horizontal axis
9412 * @param v_bounce Whether to bounce or not in the vertical axis
9414 * @see elm_scroller_bounce_set()
9416 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9418 * Get the set bouncing behaviour of the internal scroller
9420 * Get whether the internal scroller should bounce when the edge of each
9421 * axis is reached scrolling.
9423 * @param obj The anchorview object
9424 * @param h_bounce Pointer where to store the bounce state of the horizontal
9426 * @param v_bounce Pointer where to store the bounce state of the vertical
9429 * @see elm_scroller_bounce_get()
9431 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9433 * Appends a custom item provider to the given anchorview
9435 * Appends the given function to the list of items providers. This list is
9436 * called, one function at a time, with the given @p data pointer, the
9437 * anchorview object and, in the @p item parameter, the item name as
9438 * referenced in its href string. Following functions in the list will be
9439 * called in order until one of them returns something different to NULL,
9440 * which should be an Evas_Object which will be used in place of the item
9443 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9444 * href=item/name\>\</item\>
9446 * @param obj The anchorview object
9447 * @param func The function to add to the list of providers
9448 * @param data User data that will be passed to the callback function
9450 * @see elm_entry_item_provider_append()
9452 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);
9454 * Prepend a custom item provider to the given anchorview
9456 * Like elm_anchorview_item_provider_append(), but it adds the function
9457 * @p func to the beginning of the list, instead of the end.
9459 * @param obj The anchorview object
9460 * @param func The function to add to the list of providers
9461 * @param data User data that will be passed to the callback function
9463 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);
9465 * Remove a custom item provider from the list of the given anchorview
9467 * Removes the function and data pairing that matches @p func and @p data.
9468 * That is, unless the same function and same user data are given, the
9469 * function will not be removed from the list. This allows us to add the
9470 * same callback several times, with different @p data pointers and be
9471 * able to remove them later without conflicts.
9473 * @param obj The anchorview object
9474 * @param func The function to remove from the list
9475 * @param data The data matching the function to remove from the list
9477 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);
9484 * @defgroup Anchorblock Anchorblock
9486 * @image html img/widget/anchorblock/preview-00.png
9487 * @image latex img/widget/anchorblock/preview-00.eps
9489 * Anchorblock is for displaying text that contains markup with anchors
9490 * like <c>\<a href=1234\>something\</\></c> in it.
9492 * Besides being styled differently, the anchorblock widget provides the
9493 * necessary functionality so that clicking on these anchors brings up a
9494 * popup with user defined content such as "call", "add to contacts" or
9495 * "open web page". This popup is provided using the @ref Hover widget.
9497 * This widget emits the following signals:
9498 * @li "anchor,clicked": will be called when an anchor is clicked. The
9499 * @p event_info parameter on the callback will be a pointer of type
9500 * ::Elm_Entry_Anchorblock_Info.
9506 * Since examples are usually better than plain words, we might as well
9507 * try @ref tutorial_anchorblock_example "one".
9510 * @addtogroup Anchorblock
9514 * @typedef Elm_Entry_Anchorblock_Info
9516 * The info sent in the callback for "anchor,clicked" signals emitted by
9517 * the Anchorblock widget.
9519 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9521 * @struct _Elm_Entry_Anchorblock_Info
9523 * The info sent in the callback for "anchor,clicked" signals emitted by
9524 * the Anchorblock widget.
9526 struct _Elm_Entry_Anchorblock_Info
9528 const char *name; /**< Name of the anchor, as indicated in its href
9530 int button; /**< The mouse button used to click on it */
9531 Evas_Object *hover; /**< The hover object to use for the popup */
9533 Evas_Coord x, y, w, h;
9534 } anchor, /**< Geometry selection of text used as anchor */
9535 hover_parent; /**< Geometry of the object used as parent by the
9537 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9538 for content on the left side of
9539 the hover. Before calling the
9540 callback, the widget will make the
9541 necessary calculations to check
9542 which sides are fit to be set with
9543 content, based on the position the
9544 hover is activated and its distance
9545 to the edges of its parent object
9547 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9548 the right side of the hover.
9549 See @ref hover_left */
9550 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9551 of the hover. See @ref hover_left */
9552 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9553 below the hover. See @ref
9557 * Add a new Anchorblock object
9559 * @param parent The parent object
9560 * @return The new object or NULL if it cannot be created
9562 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9564 * Set the text to show in the anchorblock
9566 * Sets the text of the anchorblock to @p text. This text can include markup
9567 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9568 * of text that will be specially styled and react to click events, ended
9569 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9570 * "anchor,clicked" signal that you can attach a callback to with
9571 * evas_object_smart_callback_add(). The name of the anchor given in the
9572 * event info struct will be the one set in the href attribute, in this
9575 * Other markup can be used to style the text in different ways, but it's
9576 * up to the style defined in the theme which tags do what.
9577 * @deprecated use elm_object_text_set() instead.
9579 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9581 * Get the markup text set for the anchorblock
9583 * Retrieves the text set on the anchorblock, with markup tags included.
9585 * @param obj The anchorblock object
9586 * @return The markup text set or @c NULL if nothing was set or an error
9588 * @deprecated use elm_object_text_set() instead.
9590 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9592 * Set the parent of the hover popup
9594 * Sets the parent object to use by the hover created by the anchorblock
9595 * when an anchor is clicked. See @ref Hover for more details on this.
9597 * @param obj The anchorblock object
9598 * @param parent The object to use as parent for the hover
9600 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9602 * Get the parent of the hover popup
9604 * Get the object used as parent for the hover created by the anchorblock
9605 * widget. See @ref Hover for more details on this.
9606 * If no parent is set, the same anchorblock object will be used.
9608 * @param obj The anchorblock object
9609 * @return The object used as parent for the hover, NULL if none is set.
9611 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9613 * Set the style that the hover should use
9615 * When creating the popup hover, anchorblock will request that it's
9616 * themed according to @p style.
9618 * @param obj The anchorblock object
9619 * @param style The style to use for the underlying hover
9621 * @see elm_object_style_set()
9623 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9625 * Get the style that the hover should use
9627 * Get the style the hover created by anchorblock will use.
9629 * @param obj The anchorblock object
9630 * @return The style to use by the hover. NULL means the default is used.
9632 * @see elm_object_style_set()
9634 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9636 * Ends the hover popup in the anchorblock
9638 * When an anchor is clicked, the anchorblock widget will create a hover
9639 * object to use as a popup with user provided content. This function
9640 * terminates this popup, returning the anchorblock to its normal state.
9642 * @param obj The anchorblock object
9644 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9646 * Appends a custom item provider to the given anchorblock
9648 * Appends the given function to the list of items providers. This list is
9649 * called, one function at a time, with the given @p data pointer, the
9650 * anchorblock object and, in the @p item parameter, the item name as
9651 * referenced in its href string. Following functions in the list will be
9652 * called in order until one of them returns something different to NULL,
9653 * which should be an Evas_Object which will be used in place of the item
9656 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9657 * href=item/name\>\</item\>
9659 * @param obj The anchorblock object
9660 * @param func The function to add to the list of providers
9661 * @param data User data that will be passed to the callback function
9663 * @see elm_entry_item_provider_append()
9665 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);
9667 * Prepend a custom item provider to the given anchorblock
9669 * Like elm_anchorblock_item_provider_append(), but it adds the function
9670 * @p func to the beginning of the list, instead of the end.
9672 * @param obj The anchorblock object
9673 * @param func The function to add to the list of providers
9674 * @param data User data that will be passed to the callback function
9676 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);
9678 * Remove a custom item provider from the list of the given anchorblock
9680 * Removes the function and data pairing that matches @p func and @p data.
9681 * That is, unless the same function and same user data are given, the
9682 * function will not be removed from the list. This allows us to add the
9683 * same callback several times, with different @p data pointers and be
9684 * able to remove them later without conflicts.
9686 * @param obj The anchorblock object
9687 * @param func The function to remove from the list
9688 * @param data The data matching the function to remove from the list
9690 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);
9696 * @defgroup Bubble Bubble
9698 * @image html img/widget/bubble/preview-00.png
9699 * @image latex img/widget/bubble/preview-00.eps
9700 * @image html img/widget/bubble/preview-01.png
9701 * @image latex img/widget/bubble/preview-01.eps
9702 * @image html img/widget/bubble/preview-02.png
9703 * @image latex img/widget/bubble/preview-02.eps
9705 * @brief The Bubble is a widget to show text similarly to how speech is
9706 * represented in comics.
9708 * The bubble widget contains 5 important visual elements:
9709 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9710 * @li The @p icon is an image to which the frame's arrow points to.
9711 * @li The @p label is a text which appears to the right of the icon if the
9712 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9714 * @li The @p info is a text which appears to the right of the label. Info's
9715 * font is of a ligther color than label.
9716 * @li The @p content is an evas object that is shown inside the frame.
9718 * The position of the arrow, icon, label and info depends on which corner is
9719 * selected. The four available corners are:
9720 * @li "top_left" - Default
9723 * @li "bottom_right"
9725 * Signals that you can add callbacks for are:
9726 * @li "clicked" - This is called when a user has clicked the bubble.
9728 * For an example of using a buble see @ref bubble_01_example_page "this".
9733 * Add a new bubble to the parent
9735 * @param parent The parent object
9736 * @return The new object or NULL if it cannot be created
9738 * This function adds a text bubble to the given parent evas object.
9740 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9742 * Set the label of the bubble
9744 * @param obj The bubble object
9745 * @param label The string to set in the label
9747 * This function sets the title of the bubble. Where this appears depends on
9748 * the selected corner.
9749 * @deprecated use elm_object_text_set() instead.
9751 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9753 * Get the label of the bubble
9755 * @param obj The bubble object
9756 * @return The string of set in the label
9758 * This function gets the title of the bubble.
9759 * @deprecated use elm_object_text_get() instead.
9761 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9763 * Set the info of the bubble
9765 * @param obj The bubble object
9766 * @param info The given info about the bubble
9768 * This function sets the info of the bubble. Where this appears depends on
9769 * the selected corner.
9770 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
9772 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9774 * Get the info of the bubble
9776 * @param obj The bubble object
9778 * @return The "info" string of the bubble
9780 * This function gets the info text.
9781 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
9783 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9785 * Set the content to be shown in the bubble
9787 * Once the content object is set, a previously set one will be deleted.
9788 * If you want to keep the old content object, use the
9789 * elm_bubble_content_unset() function.
9791 * @param obj The bubble object
9792 * @param content The given content of the bubble
9794 * This function sets the content shown on the middle of the bubble.
9796 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9798 * Get the content shown in the bubble
9800 * Return the content object which is set for this widget.
9802 * @param obj The bubble object
9803 * @return The content that is being used
9805 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9807 * Unset the content shown in the bubble
9809 * Unparent and return the content object which was set for this widget.
9811 * @param obj The bubble object
9812 * @return The content that was being used
9814 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9816 * Set the icon of the bubble
9818 * Once the icon object is set, a previously set one will be deleted.
9819 * If you want to keep the old content object, use the
9820 * elm_icon_content_unset() function.
9822 * @param obj The bubble object
9823 * @param icon The given icon for the bubble
9825 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9827 * Get the icon of the bubble
9829 * @param obj The bubble object
9830 * @return The icon for the bubble
9832 * This function gets the icon shown on the top left of bubble.
9834 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9836 * Unset the icon of the bubble
9838 * Unparent and return the icon object which was set for this widget.
9840 * @param obj The bubble object
9841 * @return The icon that was being used
9843 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9845 * Set the corner of the bubble
9847 * @param obj The bubble object.
9848 * @param corner The given corner for the bubble.
9850 * This function sets the corner of the bubble. The corner will be used to
9851 * determine where the arrow in the frame points to and where label, icon and
9854 * Possible values for corner are:
9855 * @li "top_left" - Default
9858 * @li "bottom_right"
9860 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9862 * Get the corner of the bubble
9864 * @param obj The bubble object.
9865 * @return The given corner for the bubble.
9867 * This function gets the selected corner of the bubble.
9869 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9875 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9876 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9877 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9878 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9879 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9880 /* smart callbacks called:
9881 * "clicked" - the user clicked the icon
9882 * "drag,start" - Someone started dragging the image out of the object
9883 * "drag,end" - Dragged item was dropped (somewhere)
9888 * @defgroup Elm_Gesture_Layer Gesture Layer
9889 * Gesture Layer Usage:
9891 * Use Gesture Layer to detect gestures.
9892 * The advantage is that you don't have to implement
9893 * gesture detection, just set callbacks of gesture state.
9894 * By using gesture layer we make standard interface.
9896 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9897 * with a parent object parameter.
9898 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9899 * call. Usually with same object as target (2nd parameter).
9901 * Now you need to tell gesture layer what gestures you follow.
9902 * This is done with @ref elm_gesture_layer_cb_set call.
9903 * By setting the callback you actually saying to gesture layer:
9904 * I would like to know when the gesture @ref Elm_Gesture_Types
9905 * switches to state @ref Elm_Gesture_State.
9907 * Next, you need to implement the actual action that follows the input
9910 * Note that if you like to stop being reported about a gesture, just set
9911 * all callbacks referring this gesture to NULL.
9912 * (again with @ref elm_gesture_layer_cb_set)
9914 * The information reported by gesture layer to your callback is depending
9915 * on @ref Elm_Gesture_Types:
9916 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9917 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9918 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9920 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9921 * @ref ELM_GESTURE_MOMENTUM.
9923 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9924 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9925 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9926 * Note that we consider a flick as a line-gesture that should be completed
9927 * in flick-time-limit as defined in @ref Config.
9929 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9931 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9935 * @enum _Elm_Gesture_Types
9936 * Enum of supported gesture types.
9937 * @ingroup Elm_Gesture_Layer
9939 enum _Elm_Gesture_Types
9941 ELM_GESTURE_FIRST = 0,
9943 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9944 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9945 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9946 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9948 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9950 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9951 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9953 ELM_GESTURE_ZOOM, /**< Zoom */
9954 ELM_GESTURE_ROTATE, /**< Rotate */
9960 * @typedef Elm_Gesture_Types
9961 * gesture types enum
9962 * @ingroup Elm_Gesture_Layer
9964 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9967 * @enum _Elm_Gesture_State
9968 * Enum of gesture states.
9969 * @ingroup Elm_Gesture_Layer
9971 enum _Elm_Gesture_State
9973 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9974 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9975 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9976 ELM_GESTURE_STATE_END, /**< Gesture completed */
9977 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9981 * @typedef Elm_Gesture_State
9982 * gesture states enum
9983 * @ingroup Elm_Gesture_Layer
9985 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9988 * @struct _Elm_Gesture_Taps_Info
9989 * Struct holds taps info for user
9990 * @ingroup Elm_Gesture_Layer
9992 struct _Elm_Gesture_Taps_Info
9994 Evas_Coord x, y; /**< Holds center point between fingers */
9995 unsigned int n; /**< Number of fingers tapped */
9996 unsigned int timestamp; /**< event timestamp */
10000 * @typedef Elm_Gesture_Taps_Info
10001 * holds taps info for user
10002 * @ingroup Elm_Gesture_Layer
10004 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10007 * @struct _Elm_Gesture_Momentum_Info
10008 * Struct holds momentum info for user
10009 * x1 and y1 are not necessarily in sync
10010 * x1 holds x value of x direction starting point
10011 * and same holds for y1.
10012 * This is noticeable when doing V-shape movement
10013 * @ingroup Elm_Gesture_Layer
10015 struct _Elm_Gesture_Momentum_Info
10016 { /* Report line ends, timestamps, and momentum computed */
10017 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10018 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10019 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10020 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10022 unsigned int tx; /**< Timestamp of start of final x-swipe */
10023 unsigned int ty; /**< Timestamp of start of final y-swipe */
10025 Evas_Coord mx; /**< Momentum on X */
10026 Evas_Coord my; /**< Momentum on Y */
10030 * @typedef Elm_Gesture_Momentum_Info
10031 * holds momentum info for user
10032 * @ingroup Elm_Gesture_Layer
10034 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10037 * @struct _Elm_Gesture_Line_Info
10038 * Struct holds line info for user
10039 * @ingroup Elm_Gesture_Layer
10041 struct _Elm_Gesture_Line_Info
10042 { /* Report line ends, timestamps, and momentum computed */
10043 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10044 unsigned int n; /**< Number of fingers (lines) */
10045 /* FIXME should be radians, bot degrees */
10046 double angle; /**< Angle (direction) of lines */
10050 * @typedef Elm_Gesture_Line_Info
10051 * Holds line info for user
10052 * @ingroup Elm_Gesture_Layer
10054 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10057 * @struct _Elm_Gesture_Zoom_Info
10058 * Struct holds zoom info for user
10059 * @ingroup Elm_Gesture_Layer
10061 struct _Elm_Gesture_Zoom_Info
10063 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10064 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10065 double zoom; /**< Zoom value: 1.0 means no zoom */
10066 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10070 * @typedef Elm_Gesture_Zoom_Info
10071 * Holds zoom info for user
10072 * @ingroup Elm_Gesture_Layer
10074 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10077 * @struct _Elm_Gesture_Rotate_Info
10078 * Struct holds rotation info for user
10079 * @ingroup Elm_Gesture_Layer
10081 struct _Elm_Gesture_Rotate_Info
10083 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10084 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10085 double base_angle; /**< Holds start-angle */
10086 double angle; /**< Rotation value: 0.0 means no rotation */
10087 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10091 * @typedef Elm_Gesture_Rotate_Info
10092 * Holds rotation info for user
10093 * @ingroup Elm_Gesture_Layer
10095 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10098 * @typedef Elm_Gesture_Event_Cb
10099 * User callback used to stream gesture info from gesture layer
10100 * @param data user data
10101 * @param event_info gesture report info
10102 * Returns a flag field to be applied on the causing event.
10103 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10104 * upon the event, in an irreversible way.
10106 * @ingroup Elm_Gesture_Layer
10108 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10111 * Use function to set callbacks to be notified about
10112 * change of state of gesture.
10113 * When a user registers a callback with this function
10114 * this means this gesture has to be tested.
10116 * When ALL callbacks for a gesture are set to NULL
10117 * it means user isn't interested in gesture-state
10118 * and it will not be tested.
10120 * @param obj Pointer to gesture-layer.
10121 * @param idx The gesture you would like to track its state.
10122 * @param cb callback function pointer.
10123 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10124 * @param data user info to be sent to callback (usually, Smart Data)
10126 * @ingroup Elm_Gesture_Layer
10128 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);
10131 * Call this function to get repeat-events settings.
10133 * @param obj Pointer to gesture-layer.
10135 * @return repeat events settings.
10136 * @see elm_gesture_layer_hold_events_set()
10137 * @ingroup Elm_Gesture_Layer
10139 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10142 * This function called in order to make gesture-layer repeat events.
10143 * Set this of you like to get the raw events only if gestures were not detected.
10144 * Clear this if you like gesture layer to fwd events as testing gestures.
10146 * @param obj Pointer to gesture-layer.
10147 * @param r Repeat: TRUE/FALSE
10149 * @ingroup Elm_Gesture_Layer
10151 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10154 * This function sets step-value for zoom action.
10155 * Set step to any positive value.
10156 * Cancel step setting by setting to 0.0
10158 * @param obj Pointer to gesture-layer.
10159 * @param s new zoom step value.
10161 * @ingroup Elm_Gesture_Layer
10163 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10166 * This function sets step-value for rotate action.
10167 * Set step to any positive value.
10168 * Cancel step setting by setting to 0.0
10170 * @param obj Pointer to gesture-layer.
10171 * @param s new roatate step value.
10173 * @ingroup Elm_Gesture_Layer
10175 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10178 * This function called to attach gesture-layer to an Evas_Object.
10179 * @param obj Pointer to gesture-layer.
10180 * @param t Pointer to underlying object (AKA Target)
10182 * @return TRUE, FALSE on success, failure.
10184 * @ingroup Elm_Gesture_Layer
10186 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10189 * Call this function to construct a new gesture-layer object.
10190 * This does not activate the gesture layer. You have to
10191 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10193 * @param parent the parent object.
10195 * @return Pointer to new gesture-layer object.
10197 * @ingroup Elm_Gesture_Layer
10199 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10202 * @defgroup Thumb Thumb
10204 * @image html img/widget/thumb/preview-00.png
10205 * @image latex img/widget/thumb/preview-00.eps
10207 * A thumb object is used for displaying the thumbnail of an image or video.
10208 * You must have compiled Elementary with Ethumb_Client support and the DBus
10209 * service must be present and auto-activated in order to have thumbnails to
10212 * Once the thumbnail object becomes visible, it will check if there is a
10213 * previously generated thumbnail image for the file set on it. If not, it
10214 * will start generating this thumbnail.
10216 * Different config settings will cause different thumbnails to be generated
10217 * even on the same file.
10219 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10220 * Ethumb documentation to change this path, and to see other configuration
10223 * Signals that you can add callbacks for are:
10225 * - "clicked" - This is called when a user has clicked the thumb without dragging
10227 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10228 * - "press" - This is called when a user has pressed down the thumb.
10229 * - "generate,start" - The thumbnail generation started.
10230 * - "generate,stop" - The generation process stopped.
10231 * - "generate,error" - The generation failed.
10232 * - "load,error" - The thumbnail image loading failed.
10234 * available styles:
10238 * An example of use of thumbnail:
10240 * - @ref thumb_example_01
10244 * @addtogroup Thumb
10249 * @enum _Elm_Thumb_Animation_Setting
10250 * @typedef Elm_Thumb_Animation_Setting
10252 * Used to set if a video thumbnail is animating or not.
10256 typedef enum _Elm_Thumb_Animation_Setting
10258 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10259 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10260 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10261 ELM_THUMB_ANIMATION_LAST
10262 } Elm_Thumb_Animation_Setting;
10265 * Add a new thumb object to the parent.
10267 * @param parent The parent object.
10268 * @return The new object or NULL if it cannot be created.
10270 * @see elm_thumb_file_set()
10271 * @see elm_thumb_ethumb_client_get()
10275 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10277 * Reload thumbnail if it was generated before.
10279 * @param obj The thumb object to reload
10281 * This is useful if the ethumb client configuration changed, like its
10282 * size, aspect or any other property one set in the handle returned
10283 * by elm_thumb_ethumb_client_get().
10285 * If the options didn't change, the thumbnail won't be generated again, but
10286 * the old one will still be used.
10288 * @see elm_thumb_file_set()
10292 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10294 * Set the file that will be used as thumbnail.
10296 * @param obj The thumb object.
10297 * @param file The path to file that will be used as thumb.
10298 * @param key The key used in case of an EET file.
10300 * The file can be an image or a video (in that case, acceptable extensions are:
10301 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10302 * function elm_thumb_animate().
10304 * @see elm_thumb_file_get()
10305 * @see elm_thumb_reload()
10306 * @see elm_thumb_animate()
10310 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10312 * Get the image or video path and key used to generate the thumbnail.
10314 * @param obj The thumb object.
10315 * @param file Pointer to filename.
10316 * @param key Pointer to key.
10318 * @see elm_thumb_file_set()
10319 * @see elm_thumb_path_get()
10323 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10325 * Get the path and key to the image or video generated by ethumb.
10327 * One just need to make sure that the thumbnail was generated before getting
10328 * its path; otherwise, the path will be NULL. One way to do that is by asking
10329 * for the path when/after the "generate,stop" smart callback is called.
10331 * @param obj The thumb object.
10332 * @param file Pointer to thumb path.
10333 * @param key Pointer to thumb key.
10335 * @see elm_thumb_file_get()
10339 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10341 * Set the animation state for the thumb object. If its content is an animated
10342 * video, you may start/stop the animation or tell it to play continuously and
10345 * @param obj The thumb object.
10346 * @param setting The animation setting.
10348 * @see elm_thumb_file_set()
10352 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10354 * Get the animation state for the thumb object.
10356 * @param obj The thumb object.
10357 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10360 * @see elm_thumb_animate_set()
10364 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10366 * Get the ethumb_client handle so custom configuration can be made.
10368 * @return Ethumb_Client instance or NULL.
10370 * This must be called before the objects are created to be sure no object is
10371 * visible and no generation started.
10373 * Example of usage:
10376 * #include <Elementary.h>
10377 * #ifndef ELM_LIB_QUICKLAUNCH
10379 * elm_main(int argc, char **argv)
10381 * Ethumb_Client *client;
10383 * elm_need_ethumb();
10387 * client = elm_thumb_ethumb_client_get();
10390 * ERR("could not get ethumb_client");
10393 * ethumb_client_size_set(client, 100, 100);
10394 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10397 * // Create elm_thumb objects here
10407 * @note There's only one client handle for Ethumb, so once a configuration
10408 * change is done to it, any other request for thumbnails (for any thumbnail
10409 * object) will use that configuration. Thus, this configuration is global.
10413 EAPI void *elm_thumb_ethumb_client_get(void);
10415 * Get the ethumb_client connection state.
10417 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10420 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10422 * Make the thumbnail 'editable'.
10424 * @param obj Thumb object.
10425 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10427 * This means the thumbnail is a valid drag target for drag and drop, and can be
10428 * cut or pasted too.
10430 * @see elm_thumb_editable_get()
10434 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10436 * Make the thumbnail 'editable'.
10438 * @param obj Thumb object.
10439 * @return Editability.
10441 * This means the thumbnail is a valid drag target for drag and drop, and can be
10442 * cut or pasted too.
10444 * @see elm_thumb_editable_set()
10448 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10455 * @defgroup Hoversel Hoversel
10457 * @image html img/widget/hoversel/preview-00.png
10458 * @image latex img/widget/hoversel/preview-00.eps
10460 * A hoversel is a button that pops up a list of items (automatically
10461 * choosing the direction to display) that have a label and, optionally, an
10462 * icon to select from. It is a convenience widget to avoid the need to do
10463 * all the piecing together yourself. It is intended for a small number of
10464 * items in the hoversel menu (no more than 8), though is capable of many
10467 * Signals that you can add callbacks for are:
10468 * "clicked" - the user clicked the hoversel button and popped up the sel
10469 * "selected" - an item in the hoversel list is selected. event_info is the item
10470 * "dismissed" - the hover is dismissed
10472 * See @ref tutorial_hoversel for an example.
10475 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10477 * @brief Add a new Hoversel object
10479 * @param parent The parent object
10480 * @return The new object or NULL if it cannot be created
10482 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10484 * @brief This sets the hoversel to expand horizontally.
10486 * @param obj The hoversel object
10487 * @param horizontal If true, the hover will expand horizontally to the
10490 * @note The initial button will display horizontally regardless of this
10493 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10495 * @brief This returns whether the hoversel is set to expand horizontally.
10497 * @param obj The hoversel object
10498 * @return If true, the hover will expand horizontally to the right.
10500 * @see elm_hoversel_horizontal_set()
10502 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10504 * @brief Set the Hover parent
10506 * @param obj The hoversel object
10507 * @param parent The parent to use
10509 * Sets the hover parent object, the area that will be darkened when the
10510 * hoversel is clicked. Should probably be the window that the hoversel is
10511 * in. See @ref Hover objects for more information.
10513 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10515 * @brief Get the Hover parent
10517 * @param obj The hoversel object
10518 * @return The used parent
10520 * Gets the hover parent object.
10522 * @see elm_hoversel_hover_parent_set()
10524 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10526 * @brief Set the hoversel button label
10528 * @param obj The hoversel object
10529 * @param label The label text.
10531 * This sets the label of the button that is always visible (before it is
10532 * clicked and expanded).
10534 * @deprecated elm_object_text_set()
10536 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10538 * @brief Get the hoversel button label
10540 * @param obj The hoversel object
10541 * @return The label text.
10543 * @deprecated elm_object_text_get()
10545 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10547 * @brief Set the icon of the hoversel button
10549 * @param obj The hoversel object
10550 * @param icon The icon object
10552 * Sets the icon of the button that is always visible (before it is clicked
10553 * and expanded). Once the icon object is set, a previously set one will be
10554 * deleted, if you want to keep that old content object, use the
10555 * elm_hoversel_icon_unset() function.
10557 * @see elm_button_icon_set()
10559 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10561 * @brief Get the icon of the hoversel button
10563 * @param obj The hoversel object
10564 * @return The icon object
10566 * Get the icon of the button that is always visible (before it is clicked
10567 * and expanded). Also see elm_button_icon_get().
10569 * @see elm_hoversel_icon_set()
10571 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10573 * @brief Get and unparent the icon of the hoversel button
10575 * @param obj The hoversel object
10576 * @return The icon object that was being used
10578 * Unparent and return the icon of the button that is always visible
10579 * (before it is clicked and expanded).
10581 * @see elm_hoversel_icon_set()
10582 * @see elm_button_icon_unset()
10584 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10586 * @brief This triggers the hoversel popup from code, the same as if the user
10587 * had clicked the button.
10589 * @param obj The hoversel object
10591 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10593 * @brief This dismisses the hoversel popup as if the user had clicked
10594 * outside the hover.
10596 * @param obj The hoversel object
10598 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10600 * @brief Returns whether the hoversel is expanded.
10602 * @param obj The hoversel object
10603 * @return This will return EINA_TRUE if the hoversel is expanded or
10604 * EINA_FALSE if it is not expanded.
10606 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10608 * @brief This will remove all the children items from the hoversel.
10610 * @param obj The hoversel object
10612 * @warning Should @b not be called while the hoversel is active; use
10613 * elm_hoversel_expanded_get() to check first.
10615 * @see elm_hoversel_item_del_cb_set()
10616 * @see elm_hoversel_item_del()
10618 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10620 * @brief Get the list of items within the given hoversel.
10622 * @param obj The hoversel object
10623 * @return Returns a list of Elm_Hoversel_Item*
10625 * @see elm_hoversel_item_add()
10627 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10629 * @brief Add an item to the hoversel button
10631 * @param obj The hoversel object
10632 * @param label The text label to use for the item (NULL if not desired)
10633 * @param icon_file An image file path on disk to use for the icon or standard
10634 * icon name (NULL if not desired)
10635 * @param icon_type The icon type if relevant
10636 * @param func Convenience function to call when this item is selected
10637 * @param data Data to pass to item-related functions
10638 * @return A handle to the item added.
10640 * This adds an item to the hoversel to show when it is clicked. Note: if you
10641 * need to use an icon from an edje file then use
10642 * elm_hoversel_item_icon_set() right after the this function, and set
10643 * icon_file to NULL here.
10645 * For more information on what @p icon_file and @p icon_type are see the
10646 * @ref Icon "icon documentation".
10648 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);
10650 * @brief Delete an item from the hoversel
10652 * @param item The item to delete
10654 * This deletes the item from the hoversel (should not be called while the
10655 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10657 * @see elm_hoversel_item_add()
10658 * @see elm_hoversel_item_del_cb_set()
10660 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10662 * @brief Set the function to be called when an item from the hoversel is
10665 * @param item The item to set the callback on
10666 * @param func The function called
10668 * That function will receive these parameters:
10669 * @li void *item_data
10670 * @li Evas_Object *the_item_object
10671 * @li Elm_Hoversel_Item *the_object_struct
10673 * @see elm_hoversel_item_add()
10675 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10677 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10678 * that will be passed to associated function callbacks.
10680 * @param item The item to get the data from
10681 * @return The data pointer set with elm_hoversel_item_add()
10683 * @see elm_hoversel_item_add()
10685 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10687 * @brief This returns the label text of the given hoversel item.
10689 * @param item The item to get the label
10690 * @return The label text of the hoversel item
10692 * @see elm_hoversel_item_add()
10694 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10696 * @brief This sets the icon for the given hoversel item.
10698 * @param item The item to set the icon
10699 * @param icon_file An image file path on disk to use for the icon or standard
10701 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10702 * to NULL if the icon is not an edje file
10703 * @param icon_type The icon type
10705 * The icon can be loaded from the standard set, from an image file, or from
10708 * @see elm_hoversel_item_add()
10710 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);
10712 * @brief Get the icon object of the hoversel item
10714 * @param item The item to get the icon from
10715 * @param icon_file The image file path on disk used for the icon or standard
10717 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10718 * if the icon is not an edje file
10719 * @param icon_type The icon type
10721 * @see elm_hoversel_item_icon_set()
10722 * @see elm_hoversel_item_add()
10724 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);
10730 * @defgroup Toolbar Toolbar
10731 * @ingroup Elementary
10733 * @image html img/widget/toolbar/preview-00.png
10734 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10736 * @image html img/toolbar.png
10737 * @image latex img/toolbar.eps width=\textwidth
10739 * A toolbar is a widget that displays a list of items inside
10740 * a box. It can be scrollable, show a menu with items that don't fit
10741 * to toolbar size or even crop them.
10743 * Only one item can be selected at a time.
10745 * Items can have multiple states, or show menus when selected by the user.
10747 * Smart callbacks one can listen to:
10748 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10750 * Available styles for it:
10752 * - @c "transparent" - no background or shadow, just show the content
10754 * List of examples:
10755 * @li @ref toolbar_example_01
10756 * @li @ref toolbar_example_02
10757 * @li @ref toolbar_example_03
10761 * @addtogroup Toolbar
10766 * @enum _Elm_Toolbar_Shrink_Mode
10767 * @typedef Elm_Toolbar_Shrink_Mode
10769 * Set toolbar's items display behavior, it can be scrollabel,
10770 * show a menu with exceeding items, or simply hide them.
10772 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10775 * Values <b> don't </b> work as bitmask, only one can be choosen.
10777 * @see elm_toolbar_mode_shrink_set()
10778 * @see elm_toolbar_mode_shrink_get()
10782 typedef enum _Elm_Toolbar_Shrink_Mode
10784 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10785 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10786 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10787 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10788 } Elm_Toolbar_Shrink_Mode;
10790 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(). */
10792 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(). */
10795 * Add a new toolbar widget to the given parent Elementary
10796 * (container) object.
10798 * @param parent The parent object.
10799 * @return a new toolbar widget handle or @c NULL, on errors.
10801 * This function inserts a new toolbar widget on the canvas.
10805 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10808 * Set the icon size, in pixels, to be used by toolbar items.
10810 * @param obj The toolbar object
10811 * @param icon_size The icon size in pixels
10813 * @note Default value is @c 32. It reads value from elm config.
10815 * @see elm_toolbar_icon_size_get()
10819 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10822 * Get the icon size, in pixels, to be used by toolbar items.
10824 * @param obj The toolbar object.
10825 * @return The icon size in pixels.
10827 * @see elm_toolbar_icon_size_set() for details.
10831 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10834 * Sets icon lookup order, for toolbar items' icons.
10836 * @param obj The toolbar object.
10837 * @param order The icon lookup order.
10839 * Icons added before calling this function will not be affected.
10840 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10842 * @see elm_toolbar_icon_order_lookup_get()
10846 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10849 * Gets the icon lookup order.
10851 * @param obj The toolbar object.
10852 * @return The icon lookup order.
10854 * @see elm_toolbar_icon_order_lookup_set() for details.
10858 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10861 * Set whether the toolbar items' should be selected by the user or not.
10863 * @param obj The toolbar object.
10864 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10867 * This will turn off the ability to select items entirely and they will
10868 * neither appear selected nor emit selected signals. The clicked
10869 * callback function will still be called.
10871 * Selection is enabled by default.
10873 * @see elm_toolbar_no_select_mode_get().
10877 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10880 * Set whether the toolbar items' should be selected by the user or not.
10882 * @param obj The toolbar object.
10883 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10884 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10886 * @see elm_toolbar_no_select_mode_set() for details.
10890 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10893 * Append item to the toolbar.
10895 * @param obj The toolbar object.
10896 * @param icon A string with icon name or the absolute path of an image file.
10897 * @param label The label of the item.
10898 * @param func The function to call when the item is clicked.
10899 * @param data The data to associate with the item for related callbacks.
10900 * @return The created item or @c NULL upon failure.
10902 * A new item will be created and appended to the toolbar, i.e., will
10903 * be set as @b last item.
10905 * Items created with this method can be deleted with
10906 * elm_toolbar_item_del().
10908 * Associated @p data can be properly freed when item is deleted if a
10909 * callback function is set with elm_toolbar_item_del_cb_set().
10911 * If a function is passed as argument, it will be called everytime this item
10912 * is selected, i.e., the user clicks over an unselected item.
10913 * If such function isn't needed, just passing
10914 * @c NULL as @p func is enough. The same should be done for @p data.
10916 * Toolbar will load icon image from fdo or current theme.
10917 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10918 * If an absolute path is provided it will load it direct from a file.
10920 * @see elm_toolbar_item_icon_set()
10921 * @see elm_toolbar_item_del()
10922 * @see elm_toolbar_item_del_cb_set()
10926 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);
10929 * Prepend item to the toolbar.
10931 * @param obj The toolbar object.
10932 * @param icon A string with icon name or the absolute path of an image file.
10933 * @param label The label of the item.
10934 * @param func The function to call when the item is clicked.
10935 * @param data The data to associate with the item for related callbacks.
10936 * @return The created item or @c NULL upon failure.
10938 * A new item will be created and prepended to the toolbar, i.e., will
10939 * be set as @b first item.
10941 * Items created with this method can be deleted with
10942 * elm_toolbar_item_del().
10944 * Associated @p data can be properly freed when item is deleted if a
10945 * callback function is set with elm_toolbar_item_del_cb_set().
10947 * If a function is passed as argument, it will be called everytime this item
10948 * is selected, i.e., the user clicks over an unselected item.
10949 * If such function isn't needed, just passing
10950 * @c NULL as @p func is enough. The same should be done for @p data.
10952 * Toolbar will load icon image from fdo or current theme.
10953 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10954 * If an absolute path is provided it will load it direct from a file.
10956 * @see elm_toolbar_item_icon_set()
10957 * @see elm_toolbar_item_del()
10958 * @see elm_toolbar_item_del_cb_set()
10962 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);
10965 * Insert a new item into the toolbar object before item @p before.
10967 * @param obj The toolbar object.
10968 * @param before The toolbar item to insert before.
10969 * @param icon A string with icon name or the absolute path of an image file.
10970 * @param label The label of the item.
10971 * @param func The function to call when the item is clicked.
10972 * @param data The data to associate with the item for related callbacks.
10973 * @return The created item or @c NULL upon failure.
10975 * A new item will be created and added to the toolbar. Its position in
10976 * this toolbar will be just before item @p before.
10978 * Items created with this method can be deleted with
10979 * elm_toolbar_item_del().
10981 * Associated @p data can be properly freed when item is deleted if a
10982 * callback function is set with elm_toolbar_item_del_cb_set().
10984 * If a function is passed as argument, it will be called everytime this item
10985 * is selected, i.e., the user clicks over an unselected item.
10986 * If such function isn't needed, just passing
10987 * @c NULL as @p func is enough. The same should be done for @p data.
10989 * Toolbar will load icon image from fdo or current theme.
10990 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10991 * If an absolute path is provided it will load it direct from a file.
10993 * @see elm_toolbar_item_icon_set()
10994 * @see elm_toolbar_item_del()
10995 * @see elm_toolbar_item_del_cb_set()
10999 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);
11002 * Insert a new item into the toolbar object after item @p after.
11004 * @param obj The toolbar object.
11005 * @param before The toolbar item to insert before.
11006 * @param icon A string with icon name or the absolute path of an image file.
11007 * @param label The label of the item.
11008 * @param func The function to call when the item is clicked.
11009 * @param data The data to associate with the item for related callbacks.
11010 * @return The created item or @c NULL upon failure.
11012 * A new item will be created and added to the toolbar. Its position in
11013 * this toolbar will be just after item @p after.
11015 * Items created with this method can be deleted with
11016 * elm_toolbar_item_del().
11018 * Associated @p data can be properly freed when item is deleted if a
11019 * callback function is set with elm_toolbar_item_del_cb_set().
11021 * If a function is passed as argument, it will be called everytime this item
11022 * is selected, i.e., the user clicks over an unselected item.
11023 * If such function isn't needed, just passing
11024 * @c NULL as @p func is enough. The same should be done for @p data.
11026 * Toolbar will load icon image from fdo or current theme.
11027 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11028 * If an absolute path is provided it will load it direct from a file.
11030 * @see elm_toolbar_item_icon_set()
11031 * @see elm_toolbar_item_del()
11032 * @see elm_toolbar_item_del_cb_set()
11036 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);
11039 * Get the first item in the given toolbar widget's list of
11042 * @param obj The toolbar object
11043 * @return The first item or @c NULL, if it has no items (and on
11046 * @see elm_toolbar_item_append()
11047 * @see elm_toolbar_last_item_get()
11051 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11054 * Get the last item in the given toolbar widget's list of
11057 * @param obj The toolbar object
11058 * @return The last item or @c NULL, if it has no items (and on
11061 * @see elm_toolbar_item_prepend()
11062 * @see elm_toolbar_first_item_get()
11066 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11069 * Get the item after @p item in toolbar.
11071 * @param item The toolbar item.
11072 * @return The item after @p item, or @c NULL if none or on failure.
11074 * @note If it is the last item, @c NULL will be returned.
11076 * @see elm_toolbar_item_append()
11080 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11083 * Get the item before @p item in toolbar.
11085 * @param item The toolbar item.
11086 * @return The item before @p item, or @c NULL if none or on failure.
11088 * @note If it is the first item, @c NULL will be returned.
11090 * @see elm_toolbar_item_prepend()
11094 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11097 * Get the toolbar object from an item.
11099 * @param item The item.
11100 * @return The toolbar object.
11102 * This returns the toolbar object itself that an item belongs to.
11106 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11109 * Set the priority of a toolbar item.
11111 * @param item The toolbar item.
11112 * @param priority The item priority. The default is zero.
11114 * This is used only when the toolbar shrink mode is set to
11115 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11116 * When space is less than required, items with low priority
11117 * will be removed from the toolbar and added to a dynamically-created menu,
11118 * while items with higher priority will remain on the toolbar,
11119 * with the same order they were added.
11121 * @see elm_toolbar_item_priority_get()
11125 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11128 * Get the priority of a toolbar item.
11130 * @param item The toolbar item.
11131 * @return The @p item priority, or @c 0 on failure.
11133 * @see elm_toolbar_item_priority_set() for details.
11137 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11140 * Get the label of item.
11142 * @param item The item of toolbar.
11143 * @return The label of item.
11145 * The return value is a pointer to the label associated to @p item when
11146 * it was created, with function elm_toolbar_item_append() or similar,
11148 * with function elm_toolbar_item_label_set. If no label
11149 * was passed as argument, it will return @c NULL.
11151 * @see elm_toolbar_item_label_set() for more details.
11152 * @see elm_toolbar_item_append()
11156 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11159 * Set the label of item.
11161 * @param item The item of toolbar.
11162 * @param text The label of item.
11164 * The label to be displayed by the item.
11165 * Label will be placed at icons bottom (if set).
11167 * If a label was passed as argument on item creation, with function
11168 * elm_toolbar_item_append() or similar, it will be already
11169 * displayed by the item.
11171 * @see elm_toolbar_item_label_get()
11172 * @see elm_toolbar_item_append()
11176 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11179 * Return the data associated with a given toolbar widget item.
11181 * @param item The toolbar widget item handle.
11182 * @return The data associated with @p item.
11184 * @see elm_toolbar_item_data_set()
11188 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11191 * Set the data associated with a given toolbar widget item.
11193 * @param item The toolbar widget item handle.
11194 * @param data The new data pointer to set to @p item.
11196 * This sets new item data on @p item.
11198 * @warning The old data pointer won't be touched by this function, so
11199 * the user had better to free that old data himself/herself.
11203 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11206 * Returns a pointer to a toolbar item by its label.
11208 * @param obj The toolbar object.
11209 * @param label The label of the item to find.
11211 * @return The pointer to the toolbar item matching @p label or @c NULL
11216 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11219 * Get whether the @p item is selected or not.
11221 * @param item The toolbar item.
11222 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11223 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11225 * @see elm_toolbar_selected_item_set() for details.
11226 * @see elm_toolbar_item_selected_get()
11230 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11233 * Set the selected state of an item.
11235 * @param item The toolbar item
11236 * @param selected The selected state
11238 * This sets the selected state of the given item @p it.
11239 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11241 * If a new item is selected the previosly selected will be unselected.
11242 * Previoulsy selected item can be get with function
11243 * elm_toolbar_selected_item_get().
11245 * Selected items will be highlighted.
11247 * @see elm_toolbar_item_selected_get()
11248 * @see elm_toolbar_selected_item_get()
11252 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11255 * Get the selected item.
11257 * @param obj The toolbar object.
11258 * @return The selected toolbar item.
11260 * The selected item can be unselected with function
11261 * elm_toolbar_item_selected_set().
11263 * The selected item always will be highlighted on toolbar.
11265 * @see elm_toolbar_selected_items_get()
11269 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11272 * Set the icon associated with @p item.
11274 * @param obj The parent of this item.
11275 * @param item The toolbar item.
11276 * @param icon A string with icon name or the absolute path of an image file.
11278 * Toolbar will load icon image from fdo or current theme.
11279 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11280 * If an absolute path is provided it will load it direct from a file.
11282 * @see elm_toolbar_icon_order_lookup_set()
11283 * @see elm_toolbar_icon_order_lookup_get()
11287 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11290 * Get the string used to set the icon of @p item.
11292 * @param item The toolbar item.
11293 * @return The string associated with the icon object.
11295 * @see elm_toolbar_item_icon_set() for details.
11299 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11302 * Delete them item from the toolbar.
11304 * @param item The item of toolbar to be deleted.
11306 * @see elm_toolbar_item_append()
11307 * @see elm_toolbar_item_del_cb_set()
11311 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11314 * Set the function called when a toolbar item is freed.
11316 * @param item The item to set the callback on.
11317 * @param func The function called.
11319 * If there is a @p func, then it will be called prior item's memory release.
11320 * That will be called with the following arguments:
11322 * @li item's Evas object;
11325 * This way, a data associated to a toolbar item could be properly freed.
11329 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11332 * Get a value whether toolbar item is disabled or not.
11334 * @param item The item.
11335 * @return The disabled state.
11337 * @see elm_toolbar_item_disabled_set() for more details.
11341 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11344 * Sets the disabled/enabled state of a toolbar item.
11346 * @param item The item.
11347 * @param disabled The disabled state.
11349 * A disabled item cannot be selected or unselected. It will also
11350 * change its appearance (generally greyed out). This sets the
11351 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11356 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11359 * Set or unset item as a separator.
11361 * @param item The toolbar item.
11362 * @param setting @c EINA_TRUE to set item @p item as separator or
11363 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11365 * Items aren't set as separator by default.
11367 * If set as separator it will display separator theme, so won't display
11370 * @see elm_toolbar_item_separator_get()
11374 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11377 * Get a value whether item is a separator or not.
11379 * @param item The toolbar item.
11380 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11381 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11383 * @see elm_toolbar_item_separator_set() for details.
11387 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11390 * Set the shrink state of toolbar @p obj.
11392 * @param obj The toolbar object.
11393 * @param shrink_mode Toolbar's items display behavior.
11395 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11396 * but will enforce a minimun size so all the items will fit, won't scroll
11397 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11398 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11399 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11403 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11406 * Get the shrink mode of toolbar @p obj.
11408 * @param obj The toolbar object.
11409 * @return Toolbar's items display behavior.
11411 * @see elm_toolbar_mode_shrink_set() for details.
11415 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11418 * Enable/disable homogenous mode.
11420 * @param obj The toolbar object
11421 * @param homogeneous Assume the items within the toolbar are of the
11422 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11424 * This will enable the homogeneous mode where items are of the same size.
11425 * @see elm_toolbar_homogeneous_get()
11429 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11432 * Get whether the homogenous mode is enabled.
11434 * @param obj The toolbar object.
11435 * @return Assume the items within the toolbar are of the same height
11436 * and width (EINA_TRUE = on, EINA_FALSE = off).
11438 * @see elm_toolbar_homogeneous_set()
11442 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11445 * Enable/disable homogenous mode.
11447 * @param obj The toolbar object
11448 * @param homogeneous Assume the items within the toolbar are of the
11449 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11451 * This will enable the homogeneous mode where items are of the same size.
11452 * @see elm_toolbar_homogeneous_get()
11454 * @deprecated use elm_toolbar_homogeneous_set() instead.
11458 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11461 * Get whether the homogenous mode is enabled.
11463 * @param obj The toolbar object.
11464 * @return Assume the items within the toolbar are of the same height
11465 * and width (EINA_TRUE = on, EINA_FALSE = off).
11467 * @see elm_toolbar_homogeneous_set()
11468 * @deprecated use elm_toolbar_homogeneous_get() instead.
11472 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11475 * Set the parent object of the toolbar items' menus.
11477 * @param obj The toolbar object.
11478 * @param parent The parent of the menu objects.
11480 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11482 * For more details about setting the parent for toolbar menus, see
11483 * elm_menu_parent_set().
11485 * @see elm_menu_parent_set() for details.
11486 * @see elm_toolbar_item_menu_set() for details.
11490 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11493 * Get the parent object of the toolbar items' menus.
11495 * @param obj The toolbar object.
11496 * @return The parent of the menu objects.
11498 * @see elm_toolbar_menu_parent_set() for details.
11502 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11505 * Set the alignment of the items.
11507 * @param obj The toolbar object.
11508 * @param align The new alignment, a float between <tt> 0.0 </tt>
11509 * and <tt> 1.0 </tt>.
11511 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11512 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11515 * Centered items by default.
11517 * @see elm_toolbar_align_get()
11521 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11524 * Get the alignment of the items.
11526 * @param obj The toolbar object.
11527 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11530 * @see elm_toolbar_align_set() for details.
11534 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11537 * Set whether the toolbar item opens a menu.
11539 * @param item The toolbar item.
11540 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11542 * A toolbar item can be set to be a menu, using this function.
11544 * Once it is set to be a menu, it can be manipulated through the
11545 * menu-like function elm_toolbar_menu_parent_set() and the other
11546 * elm_menu functions, using the Evas_Object @c menu returned by
11547 * elm_toolbar_item_menu_get().
11549 * So, items to be displayed in this item's menu should be added with
11550 * elm_menu_item_add().
11552 * The following code exemplifies the most basic usage:
11554 * tb = elm_toolbar_add(win)
11555 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11556 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11557 * elm_toolbar_menu_parent_set(tb, win);
11558 * menu = elm_toolbar_item_menu_get(item);
11559 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11560 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11564 * @see elm_toolbar_item_menu_get()
11568 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11571 * Get toolbar item's menu.
11573 * @param item The toolbar item.
11574 * @return Item's menu object or @c NULL on failure.
11576 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11577 * this function will set it.
11579 * @see elm_toolbar_item_menu_set() for details.
11583 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11586 * Add a new state to @p item.
11588 * @param item The item.
11589 * @param icon A string with icon name or the absolute path of an image file.
11590 * @param label The label of the new state.
11591 * @param func The function to call when the item is clicked when this
11592 * state is selected.
11593 * @param data The data to associate with the state.
11594 * @return The toolbar item state, or @c NULL upon failure.
11596 * Toolbar will load icon image from fdo or current theme.
11597 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11598 * If an absolute path is provided it will load it direct from a file.
11600 * States created with this function can be removed with
11601 * elm_toolbar_item_state_del().
11603 * @see elm_toolbar_item_state_del()
11604 * @see elm_toolbar_item_state_sel()
11605 * @see elm_toolbar_item_state_get()
11609 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);
11612 * Delete a previoulsy added state to @p item.
11614 * @param item The toolbar item.
11615 * @param state The state to be deleted.
11616 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11618 * @see elm_toolbar_item_state_add()
11620 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11623 * Set @p state as the current state of @p it.
11625 * @param it The item.
11626 * @param state The state to use.
11627 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11629 * If @p state is @c NULL, it won't select any state and the default item's
11630 * icon and label will be used. It's the same behaviour than
11631 * elm_toolbar_item_state_unser().
11633 * @see elm_toolbar_item_state_unset()
11637 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11640 * Unset the state of @p it.
11642 * @param it The item.
11644 * The default icon and label from this item will be displayed.
11646 * @see elm_toolbar_item_state_set() for more details.
11650 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11653 * Get the current state of @p it.
11655 * @param item The item.
11656 * @return The selected state or @c NULL if none is selected or on failure.
11658 * @see elm_toolbar_item_state_set() for details.
11659 * @see elm_toolbar_item_state_unset()
11660 * @see elm_toolbar_item_state_add()
11664 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11667 * Get the state after selected state in toolbar's @p item.
11669 * @param it The toolbar item to change state.
11670 * @return The state after current state, or @c NULL on failure.
11672 * If last state is selected, this function will return first state.
11674 * @see elm_toolbar_item_state_set()
11675 * @see elm_toolbar_item_state_add()
11679 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11682 * Get the state before selected state in toolbar's @p item.
11684 * @param it The toolbar item to change state.
11685 * @return The state before current state, or @c NULL on failure.
11687 * If first state is selected, this function will return last state.
11689 * @see elm_toolbar_item_state_set()
11690 * @see elm_toolbar_item_state_add()
11694 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11697 * Set the text to be shown in a given toolbar item's tooltips.
11699 * @param item Target item.
11700 * @param text The text to set in the content.
11702 * Setup the text as tooltip to object. The item can have only one tooltip,
11703 * so any previous tooltip data - set with this function or
11704 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11706 * @see elm_object_tooltip_text_set() for more details.
11710 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11713 * Set the content to be shown in the tooltip item.
11715 * Setup the tooltip to item. The item can have only one tooltip,
11716 * so any previous tooltip data is removed. @p func(with @p data) will
11717 * be called every time that need show the tooltip and it should
11718 * return a valid Evas_Object. This object is then managed fully by
11719 * tooltip system and is deleted when the tooltip is gone.
11721 * @param item the toolbar item being attached a tooltip.
11722 * @param func the function used to create the tooltip contents.
11723 * @param data what to provide to @a func as callback data/context.
11724 * @param del_cb called when data is not needed anymore, either when
11725 * another callback replaces @a func, the tooltip is unset with
11726 * elm_toolbar_item_tooltip_unset() or the owner @a item
11727 * dies. This callback receives as the first parameter the
11728 * given @a data, and @c event_info is the item.
11730 * @see elm_object_tooltip_content_cb_set() for more details.
11734 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);
11737 * Unset tooltip from item.
11739 * @param item toolbar item to remove previously set tooltip.
11741 * Remove tooltip from item. The callback provided as del_cb to
11742 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11743 * it is not used anymore.
11745 * @see elm_object_tooltip_unset() for more details.
11746 * @see elm_toolbar_item_tooltip_content_cb_set()
11750 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11753 * Sets a different style for this item tooltip.
11755 * @note before you set a style you should define a tooltip with
11756 * elm_toolbar_item_tooltip_content_cb_set() or
11757 * elm_toolbar_item_tooltip_text_set()
11759 * @param item toolbar item with tooltip already set.
11760 * @param style the theme style to use (default, transparent, ...)
11762 * @see elm_object_tooltip_style_set() for more details.
11766 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11769 * Get the style for this item tooltip.
11771 * @param item toolbar item with tooltip already set.
11772 * @return style the theme style in use, defaults to "default". If the
11773 * object does not have a tooltip set, then NULL is returned.
11775 * @see elm_object_tooltip_style_get() for more details.
11776 * @see elm_toolbar_item_tooltip_style_set()
11780 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11783 * Set the type of mouse pointer/cursor decoration to be shown,
11784 * when the mouse pointer is over the given toolbar widget item
11786 * @param item toolbar item to customize cursor on
11787 * @param cursor the cursor type's name
11789 * This function works analogously as elm_object_cursor_set(), but
11790 * here the cursor's changing area is restricted to the item's
11791 * area, and not the whole widget's. Note that that item cursors
11792 * have precedence over widget cursors, so that a mouse over an
11793 * item with custom cursor set will always show @b that cursor.
11795 * If this function is called twice for an object, a previously set
11796 * cursor will be unset on the second call.
11798 * @see elm_object_cursor_set()
11799 * @see elm_toolbar_item_cursor_get()
11800 * @see elm_toolbar_item_cursor_unset()
11804 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11807 * Get the type of mouse pointer/cursor decoration set to be shown,
11808 * when the mouse pointer is over the given toolbar widget item
11810 * @param item toolbar item with custom cursor set
11811 * @return the cursor type's name or @c NULL, if no custom cursors
11812 * were set to @p item (and on errors)
11814 * @see elm_object_cursor_get()
11815 * @see elm_toolbar_item_cursor_set()
11816 * @see elm_toolbar_item_cursor_unset()
11820 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11823 * Unset any custom mouse pointer/cursor decoration set to be
11824 * shown, when the mouse pointer is over the given toolbar widget
11825 * item, thus making it show the @b default cursor again.
11827 * @param item a toolbar item
11829 * Use this call to undo any custom settings on this item's cursor
11830 * decoration, bringing it back to defaults (no custom style set).
11832 * @see elm_object_cursor_unset()
11833 * @see elm_toolbar_item_cursor_set()
11837 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11840 * Set a different @b style for a given custom cursor set for a
11843 * @param item toolbar item with custom cursor set
11844 * @param style the <b>theme style</b> to use (e.g. @c "default",
11845 * @c "transparent", etc)
11847 * This function only makes sense when one is using custom mouse
11848 * cursor decorations <b>defined in a theme file</b>, which can have,
11849 * given a cursor name/type, <b>alternate styles</b> on it. It
11850 * works analogously as elm_object_cursor_style_set(), but here
11851 * applyed only to toolbar item objects.
11853 * @warning Before you set a cursor style you should have definen a
11854 * custom cursor previously on the item, with
11855 * elm_toolbar_item_cursor_set()
11857 * @see elm_toolbar_item_cursor_engine_only_set()
11858 * @see elm_toolbar_item_cursor_style_get()
11862 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11865 * Get the current @b style set for a given toolbar item's custom
11868 * @param item toolbar item with custom cursor set.
11869 * @return style the cursor style in use. If the object does not
11870 * have a cursor set, then @c NULL is returned.
11872 * @see elm_toolbar_item_cursor_style_set() for more details
11876 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11879 * Set if the (custom)cursor for a given toolbar item should be
11880 * searched in its theme, also, or should only rely on the
11881 * rendering engine.
11883 * @param item item with custom (custom) cursor already set on
11884 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11885 * only on those provided by the rendering engine, @c EINA_FALSE to
11886 * have them searched on the widget's theme, as well.
11888 * @note This call is of use only if you've set a custom cursor
11889 * for toolbar items, with elm_toolbar_item_cursor_set().
11891 * @note By default, cursors will only be looked for between those
11892 * provided by the rendering engine.
11896 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11899 * Get if the (custom) cursor for a given toolbar item is being
11900 * searched in its theme, also, or is only relying on the rendering
11903 * @param item a toolbar item
11904 * @return @c EINA_TRUE, if cursors are being looked for only on
11905 * those provided by the rendering engine, @c EINA_FALSE if they
11906 * are being searched on the widget's theme, as well.
11908 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11912 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11915 * Change a toolbar's orientation
11916 * @param obj The toolbar object
11917 * @param vertical If @c EINA_TRUE, the toolbar is vertical
11918 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
11921 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
11924 * Get a toolbar's orientation
11925 * @param obj The toolbar object
11926 * @return If @c EINA_TRUE, the toolbar is vertical
11927 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
11930 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11937 EAPI double elm_tooltip_delay_get(void);
11938 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11939 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11940 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11941 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11942 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);
11943 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11944 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11945 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11946 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11947 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11948 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11949 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11950 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11951 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11952 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11953 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11954 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11957 EAPI int elm_cursor_engine_only_get(void);
11958 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11961 * @defgroup Menu Menu
11963 * @image html img/widget/menu/preview-00.png
11964 * @image latex img/widget/menu/preview-00.eps
11966 * A menu is a list of items displayed above its parent. When the menu is
11967 * showing its parent is darkened. Each item can have a sub-menu. The menu
11968 * object can be used to display a menu on a right click event, in a toolbar,
11971 * Signals that you can add callbacks for are:
11972 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11973 * event_info is NULL.
11975 * @see @ref tutorial_menu
11978 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11980 * @brief Add a new menu to the parent
11982 * @param parent The parent object.
11983 * @return The new object or NULL if it cannot be created.
11985 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11987 * @brief Set the parent for the given menu widget
11989 * @param obj The menu object.
11990 * @param parent The new parent.
11992 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11994 * @brief Get the parent for the given menu widget
11996 * @param obj The menu object.
11997 * @return The parent.
11999 * @see elm_menu_parent_set()
12001 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12003 * @brief Move the menu to a new position
12005 * @param obj The menu object.
12006 * @param x The new position.
12007 * @param y The new position.
12009 * Sets the top-left position of the menu to (@p x,@p y).
12011 * @note @p x and @p y coordinates are relative to parent.
12013 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12015 * @brief Close a opened menu
12017 * @param obj the menu object
12020 * Hides the menu and all it's sub-menus.
12022 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12024 * @brief Returns a list of @p item's items.
12026 * @param obj The menu object
12027 * @return An Eina_List* of @p item's items
12029 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12031 * @brief Get the Evas_Object of an Elm_Menu_Item
12033 * @param item The menu item object.
12034 * @return The edje object containing the swallowed content
12036 * @warning Don't manipulate this object!
12038 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12040 * @brief Add an item at the end of the given menu widget
12042 * @param obj The menu object.
12043 * @param parent The parent menu item (optional)
12044 * @param icon A icon display on the item. The icon will be destryed by the menu.
12045 * @param label The label of the item.
12046 * @param func Function called when the user select the item.
12047 * @param data Data sent by the callback.
12048 * @return Returns the new item.
12050 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);
12052 * @brief Add an object swallowed in an item at the end of the given menu
12055 * @param obj The menu object.
12056 * @param parent The parent menu item (optional)
12057 * @param subobj The object to swallow
12058 * @param func Function called when the user select the item.
12059 * @param data Data sent by the callback.
12060 * @return Returns the new item.
12062 * Add an evas object as an item to the menu.
12064 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);
12066 * @brief Set the label of a menu item
12068 * @param item The menu item object.
12069 * @param label The label to set for @p item
12071 * @warning Don't use this funcion on items created with
12072 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12074 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12076 * @brief Get the label of a menu item
12078 * @param item The menu item object.
12079 * @return The label of @p item
12081 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12083 * @brief Set the icon of a menu item to the standard icon with name @p icon
12085 * @param item The menu item object.
12086 * @param icon The icon object to set for the content of @p item
12088 * Once this icon is set, any previously set icon will be deleted.
12090 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12092 * @brief Get the string representation from the icon of a menu item
12094 * @param item The menu item object.
12095 * @return The string representation of @p item's icon or NULL
12097 * @see elm_menu_item_object_icon_name_set()
12099 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12101 * @brief Set the content object of a menu item
12103 * @param item The menu item object
12104 * @param The content object or NULL
12105 * @return EINA_TRUE on success, else EINA_FALSE
12107 * Use this function to change the object swallowed by a menu item, deleting
12108 * any previously swallowed object.
12110 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12112 * @brief Get the content object of a menu item
12114 * @param item The menu item object
12115 * @return The content object or NULL
12116 * @note If @p item was added with elm_menu_item_add_object, this
12117 * function will return the object passed, else it will return the
12120 * @see elm_menu_item_object_content_set()
12122 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12124 * @brief Set the selected state of @p item.
12126 * @param item The menu item object.
12127 * @param selected The selected/unselected state of the item
12129 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12131 * @brief Get the selected state of @p item.
12133 * @param item The menu item object.
12134 * @return The selected/unselected state of the item
12136 * @see elm_menu_item_selected_set()
12138 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12140 * @brief Set the disabled state of @p item.
12142 * @param item The menu item object.
12143 * @param disabled The enabled/disabled state of the item
12145 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12147 * @brief Get the disabled state of @p item.
12149 * @param item The menu item object.
12150 * @return The enabled/disabled state of the item
12152 * @see elm_menu_item_disabled_set()
12154 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12156 * @brief Add a separator item to menu @p obj under @p parent.
12158 * @param obj The menu object
12159 * @param parent The item to add the separator under
12160 * @return The created item or NULL on failure
12162 * This is item is a @ref Separator.
12164 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12166 * @brief Returns whether @p item is a separator.
12168 * @param item The item to check
12169 * @return If true, @p item is a separator
12171 * @see elm_menu_item_separator_add()
12173 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12175 * @brief Deletes an item from the menu.
12177 * @param item The item to delete.
12179 * @see elm_menu_item_add()
12181 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12183 * @brief Set the function called when a menu item is deleted.
12185 * @param item The item to set the callback on
12186 * @param func The function called
12188 * @see elm_menu_item_add()
12189 * @see elm_menu_item_del()
12191 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12193 * @brief Returns the data associated with menu item @p item.
12195 * @param item The item
12196 * @return The data associated with @p item or NULL if none was set.
12198 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12200 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12202 * @brief Sets the data to be associated with menu item @p item.
12204 * @param item The item
12205 * @param data The data to be associated with @p item
12207 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12209 * @brief Returns a list of @p item's subitems.
12211 * @param item The item
12212 * @return An Eina_List* of @p item's subitems
12214 * @see elm_menu_add()
12216 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12218 * @brief Get the position of a menu item
12220 * @param item The menu item
12221 * @return The item's index
12223 * This function returns the index position of a menu item in a menu.
12224 * For a sub-menu, this number is relative to the first item in the sub-menu.
12226 * @note Index values begin with 0
12228 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12230 * @brief @brief Return a menu item's owner menu
12232 * @param item The menu item
12233 * @return The menu object owning @p item, or NULL on failure
12235 * Use this function to get the menu object owning an item.
12237 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12239 * @brief Get the selected item in the menu
12241 * @param obj The menu object
12242 * @return The selected item, or NULL if none
12244 * @see elm_menu_item_selected_get()
12245 * @see elm_menu_item_selected_set()
12247 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12249 * @brief Get the last item in the menu
12251 * @param obj The menu object
12252 * @return The last item, or NULL if none
12254 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12256 * @brief Get the first item in the menu
12258 * @param obj The menu object
12259 * @return The first item, or NULL if none
12261 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12263 * @brief Get the next item in the menu.
12265 * @param item The menu item object.
12266 * @return The item after it, or NULL if none
12268 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12270 * @brief Get the previous item in the menu.
12272 * @param item The menu item object.
12273 * @return The item before it, or NULL if none
12275 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12281 * @defgroup List List
12282 * @ingroup Elementary
12284 * @image html img/widget/list/preview-00.png
12285 * @image latex img/widget/list/preview-00.eps width=\textwidth
12287 * @image html img/list.png
12288 * @image latex img/list.eps width=\textwidth
12290 * A list widget is a container whose children are displayed vertically or
12291 * horizontally, in order, and can be selected.
12292 * The list can accept only one or multiple items selection. Also has many
12293 * modes of items displaying.
12295 * A list is a very simple type of list widget. For more robust
12296 * lists, @ref Genlist should probably be used.
12298 * Smart callbacks one can listen to:
12299 * - @c "activated" - The user has double-clicked or pressed
12300 * (enter|return|spacebar) on an item. The @c event_info parameter
12301 * is the item that was activated.
12302 * - @c "clicked,double" - The user has double-clicked an item.
12303 * The @c event_info parameter is the item that was double-clicked.
12304 * - "selected" - when the user selected an item
12305 * - "unselected" - when the user unselected an item
12306 * - "longpressed" - an item in the list is long-pressed
12307 * - "scroll,edge,top" - the list is scrolled until the top edge
12308 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12309 * - "scroll,edge,left" - the list is scrolled until the left edge
12310 * - "scroll,edge,right" - the list is scrolled until the right edge
12312 * Available styles for it:
12315 * List of examples:
12316 * @li @ref list_example_01
12317 * @li @ref list_example_02
12318 * @li @ref list_example_03
12327 * @enum _Elm_List_Mode
12328 * @typedef Elm_List_Mode
12330 * Set list's resize behavior, transverse axis scroll and
12331 * items cropping. See each mode's description for more details.
12333 * @note Default value is #ELM_LIST_SCROLL.
12335 * Values <b> don't </b> work as bitmask, only one can be choosen.
12337 * @see elm_list_mode_set()
12338 * @see elm_list_mode_get()
12342 typedef enum _Elm_List_Mode
12344 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. */
12345 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). */
12346 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. */
12347 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. */
12348 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12351 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(). */
12354 * Add a new list widget to the given parent Elementary
12355 * (container) object.
12357 * @param parent The parent object.
12358 * @return a new list widget handle or @c NULL, on errors.
12360 * This function inserts a new list widget on the canvas.
12364 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12369 * @param obj The list object
12371 * @note Call before running show() on the list object.
12372 * @warning If not called, it won't display the list properly.
12375 * li = elm_list_add(win);
12376 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12377 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12379 * evas_object_show(li);
12384 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12387 * Enable or disable multiple items selection on the list object.
12389 * @param obj The list object
12390 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12393 * Disabled by default. If disabled, the user can select a single item of
12394 * the list each time. Selected items are highlighted on list.
12395 * If enabled, many items can be selected.
12397 * If a selected item is selected again, it will be unselected.
12399 * @see elm_list_multi_select_get()
12403 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12406 * Get a value whether multiple items selection is enabled or not.
12408 * @see elm_list_multi_select_set() for details.
12410 * @param obj The list object.
12411 * @return @c EINA_TRUE means multiple items selection is enabled.
12412 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12413 * @c EINA_FALSE is returned.
12417 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12420 * Set which mode to use for the list object.
12422 * @param obj The list object
12423 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12424 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12426 * Set list's resize behavior, transverse axis scroll and
12427 * items cropping. See each mode's description for more details.
12429 * @note Default value is #ELM_LIST_SCROLL.
12431 * Only one can be set, if a previous one was set, it will be changed
12432 * by the new mode set. Bitmask won't work as well.
12434 * @see elm_list_mode_get()
12438 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12441 * Get the mode the list is at.
12443 * @param obj The list object
12444 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12445 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12447 * @note see elm_list_mode_set() for more information.
12451 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12454 * Enable or disable horizontal mode on the list object.
12456 * @param obj The list object.
12457 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12458 * disable it, i.e., to enable vertical mode.
12460 * @note Vertical mode is set by default.
12462 * On horizontal mode items are displayed on list from left to right,
12463 * instead of from top to bottom. Also, the list will scroll horizontally.
12464 * Each item will presents left icon on top and right icon, or end, at
12467 * @see elm_list_horizontal_get()
12471 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12474 * Get a value whether horizontal mode is enabled or not.
12476 * @param obj The list object.
12477 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12478 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12479 * @c EINA_FALSE is returned.
12481 * @see elm_list_horizontal_set() for details.
12485 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12488 * Enable or disable always select mode on the list object.
12490 * @param obj The list object
12491 * @param always_select @c EINA_TRUE to enable always select mode or
12492 * @c EINA_FALSE to disable it.
12494 * @note Always select mode is disabled by default.
12496 * Default behavior of list items is to only call its callback function
12497 * the first time it's pressed, i.e., when it is selected. If a selected
12498 * item is pressed again, and multi-select is disabled, it won't call
12499 * this function (if multi-select is enabled it will unselect the item).
12501 * If always select is enabled, it will call the callback function
12502 * everytime a item is pressed, so it will call when the item is selected,
12503 * and again when a selected item is pressed.
12505 * @see elm_list_always_select_mode_get()
12506 * @see elm_list_multi_select_set()
12510 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12513 * Get a value whether always select mode is enabled or not, meaning that
12514 * an item will always call its callback function, even if already selected.
12516 * @param obj The list object
12517 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12518 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12519 * @c EINA_FALSE is returned.
12521 * @see elm_list_always_select_mode_set() for details.
12525 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12528 * Set bouncing behaviour when the scrolled content reaches an edge.
12530 * Tell the internal scroller object whether it should bounce or not
12531 * when it reaches the respective edges for each axis.
12533 * @param obj The list object
12534 * @param h_bounce Whether to bounce or not in the horizontal axis.
12535 * @param v_bounce Whether to bounce or not in the vertical axis.
12537 * @see elm_scroller_bounce_set()
12541 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12544 * Get the bouncing behaviour of the internal scroller.
12546 * Get whether the internal scroller should bounce when the edge of each
12547 * axis is reached scrolling.
12549 * @param obj The list object.
12550 * @param h_bounce Pointer where to store the bounce state of the horizontal
12552 * @param v_bounce Pointer where to store the bounce state of the vertical
12555 * @see elm_scroller_bounce_get()
12556 * @see elm_list_bounce_set()
12560 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12563 * Set the scrollbar policy.
12565 * @param obj The list object
12566 * @param policy_h Horizontal scrollbar policy.
12567 * @param policy_v Vertical scrollbar policy.
12569 * This sets the scrollbar visibility policy for the given scroller.
12570 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12571 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12572 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12573 * This applies respectively for the horizontal and vertical scrollbars.
12575 * The both are disabled by default, i.e., are set to
12576 * #ELM_SCROLLER_POLICY_OFF.
12580 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12583 * Get the scrollbar policy.
12585 * @see elm_list_scroller_policy_get() for details.
12587 * @param obj The list object.
12588 * @param policy_h Pointer where to store horizontal scrollbar policy.
12589 * @param policy_v Pointer where to store vertical scrollbar policy.
12593 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);
12596 * Append a new item to the list object.
12598 * @param obj The list object.
12599 * @param label The label of the list item.
12600 * @param icon The icon object to use for the left side of the item. An
12601 * icon can be any Evas object, but usually it is an icon created
12602 * with elm_icon_add().
12603 * @param end The icon object to use for the right side of the item. An
12604 * icon can be any Evas object.
12605 * @param func The function to call when the item is clicked.
12606 * @param data The data to associate with the item for related callbacks.
12608 * @return The created item or @c NULL upon failure.
12610 * A new item will be created and appended to the list, i.e., will
12611 * be set as @b last item.
12613 * Items created with this method can be deleted with
12614 * elm_list_item_del().
12616 * Associated @p data can be properly freed when item is deleted if a
12617 * callback function is set with elm_list_item_del_cb_set().
12619 * If a function is passed as argument, it will be called everytime this item
12620 * is selected, i.e., the user clicks over an unselected item.
12621 * If always select is enabled it will call this function every time
12622 * user clicks over an item (already selected or not).
12623 * If such function isn't needed, just passing
12624 * @c NULL as @p func is enough. The same should be done for @p data.
12626 * Simple example (with no function callback or data associated):
12628 * li = elm_list_add(win);
12629 * ic = elm_icon_add(win);
12630 * elm_icon_file_set(ic, "path/to/image", NULL);
12631 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12632 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12634 * evas_object_show(li);
12637 * @see elm_list_always_select_mode_set()
12638 * @see elm_list_item_del()
12639 * @see elm_list_item_del_cb_set()
12640 * @see elm_list_clear()
12641 * @see elm_icon_add()
12645 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);
12648 * Prepend a new item to the list object.
12650 * @param obj The list object.
12651 * @param label The label of the list item.
12652 * @param icon The icon object to use for the left side of the item. An
12653 * icon can be any Evas object, but usually it is an icon created
12654 * with elm_icon_add().
12655 * @param end The icon object to use for the right side of the item. An
12656 * icon can be any Evas object.
12657 * @param func The function to call when the item is clicked.
12658 * @param data The data to associate with the item for related callbacks.
12660 * @return The created item or @c NULL upon failure.
12662 * A new item will be created and prepended to the list, i.e., will
12663 * be set as @b first item.
12665 * Items created with this method can be deleted with
12666 * elm_list_item_del().
12668 * Associated @p data can be properly freed when item is deleted if a
12669 * callback function is set with elm_list_item_del_cb_set().
12671 * If a function is passed as argument, it will be called everytime this item
12672 * is selected, i.e., the user clicks over an unselected item.
12673 * If always select is enabled it will call this function every time
12674 * user clicks over an item (already selected or not).
12675 * If such function isn't needed, just passing
12676 * @c NULL as @p func is enough. The same should be done for @p data.
12678 * @see elm_list_item_append() for a simple code example.
12679 * @see elm_list_always_select_mode_set()
12680 * @see elm_list_item_del()
12681 * @see elm_list_item_del_cb_set()
12682 * @see elm_list_clear()
12683 * @see elm_icon_add()
12687 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);
12690 * Insert a new item into the list object before item @p before.
12692 * @param obj The list object.
12693 * @param before The list item to insert before.
12694 * @param label The label of the list item.
12695 * @param icon The icon object to use for the left side of the item. An
12696 * icon can be any Evas object, but usually it is an icon created
12697 * with elm_icon_add().
12698 * @param end The icon object to use for the right side of the item. An
12699 * icon can be any Evas object.
12700 * @param func The function to call when the item is clicked.
12701 * @param data The data to associate with the item for related callbacks.
12703 * @return The created item or @c NULL upon failure.
12705 * A new item will be created and added to the list. Its position in
12706 * this list will be just before item @p before.
12708 * Items created with this method can be deleted with
12709 * elm_list_item_del().
12711 * Associated @p data can be properly freed when item is deleted if a
12712 * callback function is set with elm_list_item_del_cb_set().
12714 * If a function is passed as argument, it will be called everytime this item
12715 * is selected, i.e., the user clicks over an unselected item.
12716 * If always select is enabled it will call this function every time
12717 * user clicks over an item (already selected or not).
12718 * If such function isn't needed, just passing
12719 * @c NULL as @p func is enough. The same should be done for @p data.
12721 * @see elm_list_item_append() for a simple code example.
12722 * @see elm_list_always_select_mode_set()
12723 * @see elm_list_item_del()
12724 * @see elm_list_item_del_cb_set()
12725 * @see elm_list_clear()
12726 * @see elm_icon_add()
12730 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);
12733 * Insert a new item into the list object after item @p after.
12735 * @param obj The list object.
12736 * @param after The list item to insert after.
12737 * @param label The label of the list item.
12738 * @param icon The icon object to use for the left side of the item. An
12739 * icon can be any Evas object, but usually it is an icon created
12740 * with elm_icon_add().
12741 * @param end The icon object to use for the right side of the item. An
12742 * icon can be any Evas object.
12743 * @param func The function to call when the item is clicked.
12744 * @param data The data to associate with the item for related callbacks.
12746 * @return The created item or @c NULL upon failure.
12748 * A new item will be created and added to the list. Its position in
12749 * this list will be just after item @p after.
12751 * Items created with this method can be deleted with
12752 * elm_list_item_del().
12754 * Associated @p data can be properly freed when item is deleted if a
12755 * callback function is set with elm_list_item_del_cb_set().
12757 * If a function is passed as argument, it will be called everytime this item
12758 * is selected, i.e., the user clicks over an unselected item.
12759 * If always select is enabled it will call this function every time
12760 * user clicks over an item (already selected or not).
12761 * If such function isn't needed, just passing
12762 * @c NULL as @p func is enough. The same should be done for @p data.
12764 * @see elm_list_item_append() for a simple code example.
12765 * @see elm_list_always_select_mode_set()
12766 * @see elm_list_item_del()
12767 * @see elm_list_item_del_cb_set()
12768 * @see elm_list_clear()
12769 * @see elm_icon_add()
12773 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);
12776 * Insert a new item into the sorted list object.
12778 * @param obj The list object.
12779 * @param label The label of the list item.
12780 * @param icon The icon object to use for the left side of the item. An
12781 * icon can be any Evas object, but usually it is an icon created
12782 * with elm_icon_add().
12783 * @param end The icon object to use for the right side of the item. An
12784 * icon can be any Evas object.
12785 * @param func The function to call when the item is clicked.
12786 * @param data The data to associate with the item for related callbacks.
12787 * @param cmp_func The comparing function to be used to sort list
12788 * items <b>by #Elm_List_Item item handles</b>. This function will
12789 * receive two items and compare them, returning a non-negative integer
12790 * if the second item should be place after the first, or negative value
12791 * if should be placed before.
12793 * @return The created item or @c NULL upon failure.
12795 * @note This function inserts values into a list object assuming it was
12796 * sorted and the result will be sorted.
12798 * A new item will be created and added to the list. Its position in
12799 * this list will be found comparing the new item with previously inserted
12800 * items using function @p cmp_func.
12802 * Items created with this method can be deleted with
12803 * elm_list_item_del().
12805 * Associated @p data can be properly freed when item is deleted if a
12806 * callback function is set with elm_list_item_del_cb_set().
12808 * If a function is passed as argument, it will be called everytime this item
12809 * is selected, i.e., the user clicks over an unselected item.
12810 * If always select is enabled it will call this function every time
12811 * user clicks over an item (already selected or not).
12812 * If such function isn't needed, just passing
12813 * @c NULL as @p func is enough. The same should be done for @p data.
12815 * @see elm_list_item_append() for a simple code example.
12816 * @see elm_list_always_select_mode_set()
12817 * @see elm_list_item_del()
12818 * @see elm_list_item_del_cb_set()
12819 * @see elm_list_clear()
12820 * @see elm_icon_add()
12824 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);
12827 * Remove all list's items.
12829 * @param obj The list object
12831 * @see elm_list_item_del()
12832 * @see elm_list_item_append()
12836 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12839 * Get a list of all the list items.
12841 * @param obj The list object
12842 * @return An @c Eina_List of list items, #Elm_List_Item,
12843 * or @c NULL on failure.
12845 * @see elm_list_item_append()
12846 * @see elm_list_item_del()
12847 * @see elm_list_clear()
12851 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12854 * Get the selected item.
12856 * @param obj The list object.
12857 * @return The selected list item.
12859 * The selected item can be unselected with function
12860 * elm_list_item_selected_set().
12862 * The selected item always will be highlighted on list.
12864 * @see elm_list_selected_items_get()
12868 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12871 * Return a list of the currently selected list items.
12873 * @param obj The list object.
12874 * @return An @c Eina_List of list items, #Elm_List_Item,
12875 * or @c NULL on failure.
12877 * Multiple items can be selected if multi select is enabled. It can be
12878 * done with elm_list_multi_select_set().
12880 * @see elm_list_selected_item_get()
12881 * @see elm_list_multi_select_set()
12885 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12888 * Set the selected state of an item.
12890 * @param item The list item
12891 * @param selected The selected state
12893 * This sets the selected state of the given item @p it.
12894 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12896 * If a new item is selected the previosly selected will be unselected,
12897 * unless multiple selection is enabled with elm_list_multi_select_set().
12898 * Previoulsy selected item can be get with function
12899 * elm_list_selected_item_get().
12901 * Selected items will be highlighted.
12903 * @see elm_list_item_selected_get()
12904 * @see elm_list_selected_item_get()
12905 * @see elm_list_multi_select_set()
12909 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12912 * Get whether the @p item is selected or not.
12914 * @param item The list item.
12915 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12916 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12918 * @see elm_list_selected_item_set() for details.
12919 * @see elm_list_item_selected_get()
12923 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12926 * Set or unset item as a separator.
12928 * @param it The list item.
12929 * @param setting @c EINA_TRUE to set item @p it as separator or
12930 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12932 * Items aren't set as separator by default.
12934 * If set as separator it will display separator theme, so won't display
12937 * @see elm_list_item_separator_get()
12941 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12944 * Get a value whether item is a separator or not.
12946 * @see elm_list_item_separator_set() for details.
12948 * @param it The list item.
12949 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12950 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12954 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12957 * Show @p item in the list view.
12959 * @param item The list item to be shown.
12961 * It won't animate list until item is visible. If such behavior is wanted,
12962 * use elm_list_bring_in() intead.
12966 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12969 * Bring in the given item to list view.
12971 * @param item The item.
12973 * This causes list to jump to the given item @p item and show it
12974 * (by scrolling), if it is not fully visible.
12976 * This may use animation to do so and take a period of time.
12978 * If animation isn't wanted, elm_list_item_show() can be used.
12982 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12985 * Delete them item from the list.
12987 * @param item The item of list to be deleted.
12989 * If deleting all list items is required, elm_list_clear()
12990 * should be used instead of getting items list and deleting each one.
12992 * @see elm_list_clear()
12993 * @see elm_list_item_append()
12994 * @see elm_list_item_del_cb_set()
12998 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13001 * Set the function called when a list item is freed.
13003 * @param item The item to set the callback on
13004 * @param func The function called
13006 * If there is a @p func, then it will be called prior item's memory release.
13007 * That will be called with the following arguments:
13009 * @li item's Evas object;
13012 * This way, a data associated to a list item could be properly freed.
13016 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13019 * Get the data associated to the item.
13021 * @param item The list item
13022 * @return The data associated to @p item
13024 * The return value is a pointer to data associated to @p item when it was
13025 * created, with function elm_list_item_append() or similar. If no data
13026 * was passed as argument, it will return @c NULL.
13028 * @see elm_list_item_append()
13032 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13035 * Get the left side icon associated to the item.
13037 * @param item The list item
13038 * @return The left side icon associated to @p item
13040 * The return value is a pointer to the icon associated to @p item when
13042 * created, with function elm_list_item_append() or similar, or later
13043 * with function elm_list_item_icon_set(). If no icon
13044 * was passed as argument, it will return @c NULL.
13046 * @see elm_list_item_append()
13047 * @see elm_list_item_icon_set()
13051 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13054 * Set the left side icon associated to the item.
13056 * @param item The list item
13057 * @param icon The left side icon object to associate with @p item
13059 * The icon object to use at left side of the item. An
13060 * icon can be any Evas object, but usually it is an icon created
13061 * with elm_icon_add().
13063 * Once the icon object is set, a previously set one will be deleted.
13064 * @warning Setting the same icon for two items will cause the icon to
13065 * dissapear from the first item.
13067 * If an icon was passed as argument on item creation, with function
13068 * elm_list_item_append() or similar, it will be already
13069 * associated to the item.
13071 * @see elm_list_item_append()
13072 * @see elm_list_item_icon_get()
13076 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13079 * Get the right side icon associated to the item.
13081 * @param item The list item
13082 * @return The right side icon associated to @p item
13084 * The return value is a pointer to the icon associated to @p item when
13086 * created, with function elm_list_item_append() or similar, or later
13087 * with function elm_list_item_icon_set(). If no icon
13088 * was passed as argument, it will return @c NULL.
13090 * @see elm_list_item_append()
13091 * @see elm_list_item_icon_set()
13095 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13098 * Set the right side icon associated to the item.
13100 * @param item The list item
13101 * @param end The right side icon object to associate with @p item
13103 * The icon object to use at right side of the item. An
13104 * icon can be any Evas object, but usually it is an icon created
13105 * with elm_icon_add().
13107 * Once the icon object is set, a previously set one will be deleted.
13108 * @warning Setting the same icon for two items will cause the icon to
13109 * dissapear from the first item.
13111 * If an icon was passed as argument on item creation, with function
13112 * elm_list_item_append() or similar, it will be already
13113 * associated to the item.
13115 * @see elm_list_item_append()
13116 * @see elm_list_item_end_get()
13120 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13123 * Gets the base object of the item.
13125 * @param item The list item
13126 * @return The base object associated with @p item
13128 * Base object is the @c Evas_Object that represents that item.
13132 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13135 * Get the label of item.
13137 * @param item The item of list.
13138 * @return The label of item.
13140 * The return value is a pointer to the label associated to @p item when
13141 * it was created, with function elm_list_item_append(), or later
13142 * with function elm_list_item_label_set. If no label
13143 * was passed as argument, it will return @c NULL.
13145 * @see elm_list_item_label_set() for more details.
13146 * @see elm_list_item_append()
13150 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13153 * Set the label of item.
13155 * @param item The item of list.
13156 * @param text The label of item.
13158 * The label to be displayed by the item.
13159 * Label will be placed between left and right side icons (if set).
13161 * If a label was passed as argument on item creation, with function
13162 * elm_list_item_append() or similar, it will be already
13163 * displayed by the item.
13165 * @see elm_list_item_label_get()
13166 * @see elm_list_item_append()
13170 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13174 * Get the item before @p it in list.
13176 * @param it The list item.
13177 * @return The item before @p it, or @c NULL if none or on failure.
13179 * @note If it is the first item, @c NULL will be returned.
13181 * @see elm_list_item_append()
13182 * @see elm_list_items_get()
13186 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13189 * Get the item after @p it in list.
13191 * @param it The list item.
13192 * @return The item after @p it, or @c NULL if none or on failure.
13194 * @note If it is the last item, @c NULL will be returned.
13196 * @see elm_list_item_append()
13197 * @see elm_list_items_get()
13201 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13204 * Sets the disabled/enabled state of a list item.
13206 * @param it The item.
13207 * @param disabled The disabled state.
13209 * A disabled item cannot be selected or unselected. It will also
13210 * change its appearance (generally greyed out). This sets the
13211 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13216 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13219 * Get a value whether list item is disabled or not.
13221 * @param it The item.
13222 * @return The disabled state.
13224 * @see elm_list_item_disabled_set() for more details.
13228 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13231 * Set the text to be shown in a given list item's tooltips.
13233 * @param item Target item.
13234 * @param text The text to set in the content.
13236 * Setup the text as tooltip to object. The item can have only one tooltip,
13237 * so any previous tooltip data - set with this function or
13238 * elm_list_item_tooltip_content_cb_set() - is removed.
13240 * @see elm_object_tooltip_text_set() for more details.
13244 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13248 * @brief Disable size restrictions on an object's tooltip
13249 * @param item The tooltip's anchor object
13250 * @param disable If EINA_TRUE, size restrictions are disabled
13251 * @return EINA_FALSE on failure, EINA_TRUE on success
13253 * This function allows a tooltip to expand beyond its parant window's canvas.
13254 * It will instead be limited only by the size of the display.
13256 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13258 * @brief Retrieve size restriction state of an object's tooltip
13259 * @param obj The tooltip's anchor object
13260 * @return If EINA_TRUE, size restrictions are disabled
13262 * This function returns whether a tooltip is allowed to expand beyond
13263 * its parant window's canvas.
13264 * It will instead be limited only by the size of the display.
13266 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13269 * Set the content to be shown in the tooltip item.
13271 * Setup the tooltip to item. The item can have only one tooltip,
13272 * so any previous tooltip data is removed. @p func(with @p data) will
13273 * be called every time that need show the tooltip and it should
13274 * return a valid Evas_Object. This object is then managed fully by
13275 * tooltip system and is deleted when the tooltip is gone.
13277 * @param item the list item being attached a tooltip.
13278 * @param func the function used to create the tooltip contents.
13279 * @param data what to provide to @a func as callback data/context.
13280 * @param del_cb called when data is not needed anymore, either when
13281 * another callback replaces @a func, the tooltip is unset with
13282 * elm_list_item_tooltip_unset() or the owner @a item
13283 * dies. This callback receives as the first parameter the
13284 * given @a data, and @c event_info is the item.
13286 * @see elm_object_tooltip_content_cb_set() for more details.
13290 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);
13293 * Unset tooltip from item.
13295 * @param item list item to remove previously set tooltip.
13297 * Remove tooltip from item. The callback provided as del_cb to
13298 * elm_list_item_tooltip_content_cb_set() will be called to notify
13299 * it is not used anymore.
13301 * @see elm_object_tooltip_unset() for more details.
13302 * @see elm_list_item_tooltip_content_cb_set()
13306 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13309 * Sets a different style for this item tooltip.
13311 * @note before you set a style you should define a tooltip with
13312 * elm_list_item_tooltip_content_cb_set() or
13313 * elm_list_item_tooltip_text_set()
13315 * @param item list item with tooltip already set.
13316 * @param style the theme style to use (default, transparent, ...)
13318 * @see elm_object_tooltip_style_set() for more details.
13322 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13325 * Get the style for this item tooltip.
13327 * @param item list item with tooltip already set.
13328 * @return style the theme style in use, defaults to "default". If the
13329 * object does not have a tooltip set, then NULL is returned.
13331 * @see elm_object_tooltip_style_get() for more details.
13332 * @see elm_list_item_tooltip_style_set()
13336 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13339 * Set the type of mouse pointer/cursor decoration to be shown,
13340 * when the mouse pointer is over the given list widget item
13342 * @param item list item to customize cursor on
13343 * @param cursor the cursor type's name
13345 * This function works analogously as elm_object_cursor_set(), but
13346 * here the cursor's changing area is restricted to the item's
13347 * area, and not the whole widget's. Note that that item cursors
13348 * have precedence over widget cursors, so that a mouse over an
13349 * item with custom cursor set will always show @b that cursor.
13351 * If this function is called twice for an object, a previously set
13352 * cursor will be unset on the second call.
13354 * @see elm_object_cursor_set()
13355 * @see elm_list_item_cursor_get()
13356 * @see elm_list_item_cursor_unset()
13360 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13363 * Get the type of mouse pointer/cursor decoration set to be shown,
13364 * when the mouse pointer is over the given list widget item
13366 * @param item list item with custom cursor set
13367 * @return the cursor type's name or @c NULL, if no custom cursors
13368 * were set to @p item (and on errors)
13370 * @see elm_object_cursor_get()
13371 * @see elm_list_item_cursor_set()
13372 * @see elm_list_item_cursor_unset()
13376 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13379 * Unset any custom mouse pointer/cursor decoration set to be
13380 * shown, when the mouse pointer is over the given list widget
13381 * item, thus making it show the @b default cursor again.
13383 * @param item a list item
13385 * Use this call to undo any custom settings on this item's cursor
13386 * decoration, bringing it back to defaults (no custom style set).
13388 * @see elm_object_cursor_unset()
13389 * @see elm_list_item_cursor_set()
13393 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13396 * Set a different @b style for a given custom cursor set for a
13399 * @param item list item with custom cursor set
13400 * @param style the <b>theme style</b> to use (e.g. @c "default",
13401 * @c "transparent", etc)
13403 * This function only makes sense when one is using custom mouse
13404 * cursor decorations <b>defined in a theme file</b>, which can have,
13405 * given a cursor name/type, <b>alternate styles</b> on it. It
13406 * works analogously as elm_object_cursor_style_set(), but here
13407 * applyed only to list item objects.
13409 * @warning Before you set a cursor style you should have definen a
13410 * custom cursor previously on the item, with
13411 * elm_list_item_cursor_set()
13413 * @see elm_list_item_cursor_engine_only_set()
13414 * @see elm_list_item_cursor_style_get()
13418 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13421 * Get the current @b style set for a given list item's custom
13424 * @param item list item with custom cursor set.
13425 * @return style the cursor style in use. If the object does not
13426 * have a cursor set, then @c NULL is returned.
13428 * @see elm_list_item_cursor_style_set() for more details
13432 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13435 * Set if the (custom)cursor for a given list item should be
13436 * searched in its theme, also, or should only rely on the
13437 * rendering engine.
13439 * @param item item with custom (custom) cursor already set on
13440 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13441 * only on those provided by the rendering engine, @c EINA_FALSE to
13442 * have them searched on the widget's theme, as well.
13444 * @note This call is of use only if you've set a custom cursor
13445 * for list items, with elm_list_item_cursor_set().
13447 * @note By default, cursors will only be looked for between those
13448 * provided by the rendering engine.
13452 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13455 * Get if the (custom) cursor for a given list item is being
13456 * searched in its theme, also, or is only relying on the rendering
13459 * @param item a list item
13460 * @return @c EINA_TRUE, if cursors are being looked for only on
13461 * those provided by the rendering engine, @c EINA_FALSE if they
13462 * are being searched on the widget's theme, as well.
13464 * @see elm_list_item_cursor_engine_only_set(), for more details
13468 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13475 * @defgroup Slider Slider
13476 * @ingroup Elementary
13478 * @image html img/widget/slider/preview-00.png
13479 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13481 * The slider adds a dragable “slider” widget for selecting the value of
13482 * something within a range.
13484 * A slider can be horizontal or vertical. It can contain an Icon and has a
13485 * primary label as well as a units label (that is formatted with floating
13486 * point values and thus accepts a printf-style format string, like
13487 * “%1.2f units”. There is also an indicator string that may be somewhere
13488 * else (like on the slider itself) that also accepts a format string like
13489 * units. Label, Icon Unit and Indicator strings/objects are optional.
13491 * A slider may be inverted which means values invert, with high vales being
13492 * on the left or top and low values on the right or bottom (as opposed to
13493 * normally being low on the left or top and high on the bottom and right).
13495 * The slider should have its minimum and maximum values set by the
13496 * application with elm_slider_min_max_set() and value should also be set by
13497 * the application before use with elm_slider_value_set(). The span of the
13498 * slider is its length (horizontally or vertically). This will be scaled by
13499 * the object or applications scaling factor. At any point code can query the
13500 * slider for its value with elm_slider_value_get().
13502 * Smart callbacks one can listen to:
13503 * - "changed" - Whenever the slider value is changed by the user.
13504 * - "slider,drag,start" - dragging the slider indicator around has started.
13505 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13506 * - "delay,changed" - A short time after the value is changed by the user.
13507 * This will be called only when the user stops dragging for
13508 * a very short period or when they release their
13509 * finger/mouse, so it avoids possibly expensive reactions to
13510 * the value change.
13512 * Available styles for it:
13515 * Here is an example on its usage:
13516 * @li @ref slider_example
13520 * @addtogroup Slider
13525 * Add a new slider widget to the given parent Elementary
13526 * (container) object.
13528 * @param parent The parent object.
13529 * @return a new slider widget handle or @c NULL, on errors.
13531 * This function inserts a new slider widget on the canvas.
13535 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13538 * Set the label of a given slider widget
13540 * @param obj The progress bar object
13541 * @param label The text label string, in UTF-8
13544 * @deprecated use elm_object_text_set() instead.
13546 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13549 * Get the label of a given slider widget
13551 * @param obj The progressbar object
13552 * @return The text label string, in UTF-8
13555 * @deprecated use elm_object_text_get() instead.
13557 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13560 * Set the icon object of the slider object.
13562 * @param obj The slider object.
13563 * @param icon The icon object.
13565 * On horizontal mode, icon is placed at left, and on vertical mode,
13568 * @note Once the icon object is set, a previously set one will be deleted.
13569 * If you want to keep that old content object, use the
13570 * elm_slider_icon_unset() function.
13572 * @warning If the object being set does not have minimum size hints set,
13573 * it won't get properly displayed.
13577 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13580 * Unset an icon set on a given slider widget.
13582 * @param obj The slider object.
13583 * @return The icon object that was being used, if any was set, or
13584 * @c NULL, otherwise (and on errors).
13586 * On horizontal mode, icon is placed at left, and on vertical mode,
13589 * This call will unparent and return the icon object which was set
13590 * for this widget, previously, on success.
13592 * @see elm_slider_icon_set() for more details
13593 * @see elm_slider_icon_get()
13597 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13600 * Retrieve the icon object set for a given slider widget.
13602 * @param obj The slider object.
13603 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13604 * otherwise (and on errors).
13606 * On horizontal mode, icon is placed at left, and on vertical mode,
13609 * @see elm_slider_icon_set() for more details
13610 * @see elm_slider_icon_unset()
13614 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13617 * Set the end object of the slider object.
13619 * @param obj The slider object.
13620 * @param end The end object.
13622 * On horizontal mode, end is placed at left, and on vertical mode,
13623 * placed at bottom.
13625 * @note Once the icon object is set, a previously set one will be deleted.
13626 * If you want to keep that old content object, use the
13627 * elm_slider_end_unset() function.
13629 * @warning If the object being set does not have minimum size hints set,
13630 * it won't get properly displayed.
13634 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13637 * Unset an end object set on a given slider widget.
13639 * @param obj The slider object.
13640 * @return The end object that was being used, if any was set, or
13641 * @c NULL, otherwise (and on errors).
13643 * On horizontal mode, end is placed at left, and on vertical mode,
13644 * placed at bottom.
13646 * This call will unparent and return the icon object which was set
13647 * for this widget, previously, on success.
13649 * @see elm_slider_end_set() for more details.
13650 * @see elm_slider_end_get()
13654 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13657 * Retrieve the end object set for a given slider widget.
13659 * @param obj The slider object.
13660 * @return The end object's handle, if @p obj had one set, or @c NULL,
13661 * otherwise (and on errors).
13663 * On horizontal mode, icon is placed at right, and on vertical mode,
13664 * placed at bottom.
13666 * @see elm_slider_end_set() for more details.
13667 * @see elm_slider_end_unset()
13671 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13674 * Set the (exact) length of the bar region of a given slider widget.
13676 * @param obj The slider object.
13677 * @param size The length of the slider's bar region.
13679 * This sets the minimum width (when in horizontal mode) or height
13680 * (when in vertical mode) of the actual bar area of the slider
13681 * @p obj. This in turn affects the object's minimum size. Use
13682 * this when you're not setting other size hints expanding on the
13683 * given direction (like weight and alignment hints) and you would
13684 * like it to have a specific size.
13686 * @note Icon, end, label, indicator and unit text around @p obj
13687 * will require their
13688 * own space, which will make @p obj to require more the @p size,
13691 * @see elm_slider_span_size_get()
13695 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13698 * Get the length set for the bar region of a given slider widget
13700 * @param obj The slider object.
13701 * @return The length of the slider's bar region.
13703 * If that size was not set previously, with
13704 * elm_slider_span_size_set(), this call will return @c 0.
13708 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13711 * Set the format string for the unit label.
13713 * @param obj The slider object.
13714 * @param format The format string for the unit display.
13716 * Unit label is displayed all the time, if set, after slider's bar.
13717 * In horizontal mode, at right and in vertical mode, at bottom.
13719 * If @c NULL, unit label won't be visible. If not it sets the format
13720 * string for the label text. To the label text is provided a floating point
13721 * value, so the label text can display up to 1 floating point value.
13722 * Note that this is optional.
13724 * Use a format string such as "%1.2f meters" for example, and it will
13725 * display values like: "3.14 meters" for a value equal to 3.14159.
13727 * Default is unit label disabled.
13729 * @see elm_slider_indicator_format_get()
13733 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13736 * Get the unit label format of the slider.
13738 * @param obj The slider object.
13739 * @return The unit label format string in UTF-8.
13741 * Unit label is displayed all the time, if set, after slider's bar.
13742 * In horizontal mode, at right and in vertical mode, at bottom.
13744 * @see elm_slider_unit_format_set() for more
13745 * information on how this works.
13749 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13752 * Set the format string for the indicator label.
13754 * @param obj The slider object.
13755 * @param indicator The format string for the indicator display.
13757 * The slider may display its value somewhere else then unit label,
13758 * for example, above the slider knob that is dragged around. This function
13759 * sets the format string used for this.
13761 * If @c NULL, indicator label won't be visible. If not it sets the format
13762 * string for the label text. To the label text is provided a floating point
13763 * value, so the label text can display up to 1 floating point value.
13764 * Note that this is optional.
13766 * Use a format string such as "%1.2f meters" for example, and it will
13767 * display values like: "3.14 meters" for a value equal to 3.14159.
13769 * Default is indicator label disabled.
13771 * @see elm_slider_indicator_format_get()
13775 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13778 * Get the indicator label format of the slider.
13780 * @param obj The slider object.
13781 * @return The indicator label format string in UTF-8.
13783 * The slider may display its value somewhere else then unit label,
13784 * for example, above the slider knob that is dragged around. This function
13785 * gets the format string used for this.
13787 * @see elm_slider_indicator_format_set() for more
13788 * information on how this works.
13792 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13795 * Set the format function pointer for the indicator label
13797 * @param obj The slider object.
13798 * @param func The indicator format function.
13799 * @param free_func The freeing function for the format string.
13801 * Set the callback function to format the indicator string.
13803 * @see elm_slider_indicator_format_set() for more info on how this works.
13807 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);
13810 * Set the format function pointer for the units label
13812 * @param obj The slider object.
13813 * @param func The units format function.
13814 * @param free_func The freeing function for the format string.
13816 * Set the callback function to format the indicator string.
13818 * @see elm_slider_units_format_set() for more info on how this works.
13822 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);
13825 * Set the orientation of a given slider widget.
13827 * @param obj The slider object.
13828 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13829 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13831 * Use this function to change how your slider is to be
13832 * disposed: vertically or horizontally.
13834 * By default it's displayed horizontally.
13836 * @see elm_slider_horizontal_get()
13840 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13843 * Retrieve the orientation of a given slider widget
13845 * @param obj The slider object.
13846 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13847 * @c EINA_FALSE if it's @b vertical (and on errors).
13849 * @see elm_slider_horizontal_set() for more details.
13853 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13856 * Set the minimum and maximum values for the slider.
13858 * @param obj The slider object.
13859 * @param min The minimum value.
13860 * @param max The maximum value.
13862 * Define the allowed range of values to be selected by the user.
13864 * If actual value is less than @p min, it will be updated to @p min. If it
13865 * is bigger then @p max, will be updated to @p max. Actual value can be
13866 * get with elm_slider_value_get().
13868 * By default, min is equal to 0.0, and max is equal to 1.0.
13870 * @warning Maximum must be greater than minimum, otherwise behavior
13873 * @see elm_slider_min_max_get()
13877 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13880 * Get the minimum and maximum values of the slider.
13882 * @param obj The slider object.
13883 * @param min Pointer where to store the minimum value.
13884 * @param max Pointer where to store the maximum value.
13886 * @note If only one value is needed, the other pointer can be passed
13889 * @see elm_slider_min_max_set() for details.
13893 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13896 * Set the value the slider displays.
13898 * @param obj The slider object.
13899 * @param val The value to be displayed.
13901 * Value will be presented on the unit label following format specified with
13902 * elm_slider_unit_format_set() and on indicator with
13903 * elm_slider_indicator_format_set().
13905 * @warning The value must to be between min and max values. This values
13906 * are set by elm_slider_min_max_set().
13908 * @see elm_slider_value_get()
13909 * @see elm_slider_unit_format_set()
13910 * @see elm_slider_indicator_format_set()
13911 * @see elm_slider_min_max_set()
13915 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13918 * Get the value displayed by the spinner.
13920 * @param obj The spinner object.
13921 * @return The value displayed.
13923 * @see elm_spinner_value_set() for details.
13927 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13930 * Invert a given slider widget's displaying values order
13932 * @param obj The slider object.
13933 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13934 * @c EINA_FALSE to bring it back to default, non-inverted values.
13936 * A slider may be @b inverted, in which state it gets its
13937 * values inverted, with high vales being on the left or top and
13938 * low values on the right or bottom, as opposed to normally have
13939 * the low values on the former and high values on the latter,
13940 * respectively, for horizontal and vertical modes.
13942 * @see elm_slider_inverted_get()
13946 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13949 * Get whether a given slider widget's displaying values are
13952 * @param obj The slider object.
13953 * @return @c EINA_TRUE, if @p obj has inverted values,
13954 * @c EINA_FALSE otherwise (and on errors).
13956 * @see elm_slider_inverted_set() for more details.
13960 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13963 * Set whether to enlarge slider indicator (augmented knob) or not.
13965 * @param obj The slider object.
13966 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13967 * let the knob always at default size.
13969 * By default, indicator will be bigger while dragged by the user.
13971 * @warning It won't display values set with
13972 * elm_slider_indicator_format_set() if you disable indicator.
13976 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13979 * Get whether a given slider widget's enlarging indicator or not.
13981 * @param obj The slider object.
13982 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13983 * @c EINA_FALSE otherwise (and on errors).
13985 * @see elm_slider_indicator_show_set() for details.
13989 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13996 * @addtogroup Actionslider Actionslider
13998 * @image html img/widget/actionslider/preview-00.png
13999 * @image latex img/widget/actionslider/preview-00.eps
14001 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14002 * properties. The indicator is the element the user drags to choose a label.
14003 * When the position is set with magnet, when released the indicator will be
14004 * moved to it if it's nearest the magnetized position.
14006 * @note By default all positions are set as enabled.
14008 * Signals that you can add callbacks for are:
14010 * "selected" - when user selects an enabled position (the label is passed
14013 * "pos_changed" - when the indicator reaches any of the positions("left",
14014 * "right" or "center").
14016 * See an example of actionslider usage @ref actionslider_example_page "here"
14019 typedef enum _Elm_Actionslider_Pos
14021 ELM_ACTIONSLIDER_NONE = 0,
14022 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14023 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14024 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14025 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14026 } Elm_Actionslider_Pos;
14029 * Add a new actionslider to the parent.
14031 * @param parent The parent object
14032 * @return The new actionslider object or NULL if it cannot be created
14034 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14036 * Set actionslider labels.
14038 * @param obj The actionslider object
14039 * @param left_label The label to be set on the left.
14040 * @param center_label The label to be set on the center.
14041 * @param right_label The label to be set on the right.
14042 * @deprecated use elm_object_text_set() instead.
14044 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);
14046 * Get actionslider labels.
14048 * @param obj The actionslider object
14049 * @param left_label A char** to place the left_label of @p obj into.
14050 * @param center_label A char** to place the center_label of @p obj into.
14051 * @param right_label A char** to place the right_label of @p obj into.
14052 * @deprecated use elm_object_text_set() instead.
14054 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);
14056 * Get actionslider selected label.
14058 * @param obj The actionslider object
14059 * @return The selected label
14061 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14063 * Set actionslider indicator position.
14065 * @param obj The actionslider object.
14066 * @param pos The position of the indicator.
14068 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14070 * Get actionslider indicator position.
14072 * @param obj The actionslider object.
14073 * @return The position of the indicator.
14075 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14077 * Set actionslider magnet position. To make multiple positions magnets @c or
14078 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14080 * @param obj The actionslider object.
14081 * @param pos Bit mask indicating the magnet positions.
14083 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14085 * Get actionslider magnet position.
14087 * @param obj The actionslider object.
14088 * @return The positions with magnet property.
14090 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14092 * Set actionslider enabled position. To set multiple positions as enabled @c or
14093 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14095 * @note All the positions are enabled by default.
14097 * @param obj The actionslider object.
14098 * @param pos Bit mask indicating the enabled positions.
14100 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14102 * Get actionslider enabled position.
14104 * @param obj The actionslider object.
14105 * @return The enabled positions.
14107 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14109 * Set the label used on the indicator.
14111 * @param obj The actionslider object
14112 * @param label The label to be set on the indicator.
14113 * @deprecated use elm_object_text_set() instead.
14115 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14117 * Get the label used on the indicator object.
14119 * @param obj The actionslider object
14120 * @return The indicator label
14121 * @deprecated use elm_object_text_get() instead.
14123 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14129 * @defgroup Genlist Genlist
14131 * @image html img/widget/genlist/preview-00.png
14132 * @image latex img/widget/genlist/preview-00.eps
14133 * @image html img/genlist.png
14134 * @image latex img/genlist.eps
14136 * This widget aims to have more expansive list than the simple list in
14137 * Elementary that could have more flexible items and allow many more entries
14138 * while still being fast and low on memory usage. At the same time it was
14139 * also made to be able to do tree structures. But the price to pay is more
14140 * complexity when it comes to usage. If all you want is a simple list with
14141 * icons and a single label, use the normal @ref List object.
14143 * Genlist has a fairly large API, mostly because it's relatively complex,
14144 * trying to be both expansive, powerful and efficient. First we will begin
14145 * an overview on the theory behind genlist.
14147 * @section Genlist_Item_Class Genlist item classes - creating items
14149 * In order to have the ability to add and delete items on the fly, genlist
14150 * implements a class (callback) system where the application provides a
14151 * structure with information about that type of item (genlist may contain
14152 * multiple different items with different classes, states and styles).
14153 * Genlist will call the functions in this struct (methods) when an item is
14154 * "realized" (i.e., created dynamically, while the user is scrolling the
14155 * grid). All objects will simply be deleted when no longer needed with
14156 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14157 * following members:
14158 * - @c item_style - This is a constant string and simply defines the name
14159 * of the item style. It @b must be specified and the default should be @c
14161 * - @c mode_item_style - This is a constant string and simply defines the
14162 * name of the style that will be used for mode animations. It can be left
14163 * as @c NULL if you don't plan to use Genlist mode. See
14164 * elm_genlist_item_mode_set() for more info.
14166 * - @c func - A struct with pointers to functions that will be called when
14167 * an item is going to be actually created. All of them receive a @c data
14168 * parameter that will point to the same data passed to
14169 * elm_genlist_item_append() and related item creation functions, and a @c
14170 * obj parameter that points to the genlist object itself.
14172 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14173 * state_get and @c del. The 3 first functions also receive a @c part
14174 * parameter described below. A brief description of these functions follows:
14176 * - @c label_get - The @c part parameter is the name string of one of the
14177 * existing text parts in the Edje group implementing the item's theme.
14178 * This function @b must return a strdup'()ed string, as the caller will
14179 * free() it when done. See #GenlistItemLabelGetFunc.
14180 * - @c icon_get - The @c part parameter is the name string of one of the
14181 * existing (icon) swallow parts in the Edje group implementing the item's
14182 * theme. It must return @c NULL, when no icon is desired, or a valid
14183 * object handle, otherwise. The object will be deleted by the genlist on
14184 * its deletion or when the item is "unrealized". See
14185 * #GenlistItemIconGetFunc.
14186 * - @c func.state_get - The @c part parameter is the name string of one of
14187 * the state parts in the Edje group implementing the item's theme. Return
14188 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14189 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14190 * and @c "elm" as "emission" and "source" arguments, respectively, when
14191 * the state is true (the default is false), where @c XXX is the name of
14192 * the (state) part. See #GenlistItemStateGetFunc.
14193 * - @c func.del - This is intended for use when genlist items are deleted,
14194 * so any data attached to the item (e.g. its data parameter on creation)
14195 * can be deleted. See #GenlistItemDelFunc.
14197 * available item styles:
14199 * - default_style - The text part is a textblock
14201 * @image html img/widget/genlist/preview-04.png
14202 * @image latex img/widget/genlist/preview-04.eps
14206 * @image html img/widget/genlist/preview-01.png
14207 * @image latex img/widget/genlist/preview-01.eps
14209 * - icon_top_text_bottom
14211 * @image html img/widget/genlist/preview-02.png
14212 * @image latex img/widget/genlist/preview-02.eps
14216 * @image html img/widget/genlist/preview-03.png
14217 * @image latex img/widget/genlist/preview-03.eps
14219 * @section Genlist_Items Structure of items
14221 * An item in a genlist can have 0 or more text labels (they can be regular
14222 * text or textblock Evas objects - that's up to the style to determine), 0
14223 * or more icons (which are simply objects swallowed into the genlist item's
14224 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14225 * behavior left to the user to define. The Edje part names for each of
14226 * these properties will be looked up, in the theme file for the genlist,
14227 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14228 * "states", respectively. For each of those properties, if more than one
14229 * part is provided, they must have names listed separated by spaces in the
14230 * data fields. For the default genlist item theme, we have @b one label
14231 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14232 * "elm.swallow.end") and @b no state parts.
14234 * A genlist item may be at one of several styles. Elementary provides one
14235 * by default - "default", but this can be extended by system or application
14236 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14239 * @section Genlist_Manipulation Editing and Navigating
14241 * Items can be added by several calls. All of them return a @ref
14242 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14243 * They all take a data parameter that is meant to be used for a handle to
14244 * the applications internal data (eg the struct with the original item
14245 * data). The parent parameter is the parent genlist item this belongs to if
14246 * it is a tree or an indexed group, and NULL if there is no parent. The
14247 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14248 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14249 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14250 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14251 * is set then this item is group index item that is displayed at the top
14252 * until the next group comes. The func parameter is a convenience callback
14253 * that is called when the item is selected and the data parameter will be
14254 * the func_data parameter, obj be the genlist object and event_info will be
14255 * the genlist item.
14257 * elm_genlist_item_append() adds an item to the end of the list, or if
14258 * there is a parent, to the end of all the child items of the parent.
14259 * elm_genlist_item_prepend() is the same but adds to the beginning of
14260 * the list or children list. elm_genlist_item_insert_before() inserts at
14261 * item before another item and elm_genlist_item_insert_after() inserts after
14262 * the indicated item.
14264 * The application can clear the list with elm_genlist_clear() which deletes
14265 * all the items in the list and elm_genlist_item_del() will delete a specific
14266 * item. elm_genlist_item_subitems_clear() will clear all items that are
14267 * children of the indicated parent item.
14269 * To help inspect list items you can jump to the item at the top of the list
14270 * with elm_genlist_first_item_get() which will return the item pointer, and
14271 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14272 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14273 * and previous items respectively relative to the indicated item. Using
14274 * these calls you can walk the entire item list/tree. Note that as a tree
14275 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14276 * let you know which item is the parent (and thus know how to skip them if
14279 * @section Genlist_Muti_Selection Multi-selection
14281 * If the application wants multiple items to be able to be selected,
14282 * elm_genlist_multi_select_set() can enable this. If the list is
14283 * single-selection only (the default), then elm_genlist_selected_item_get()
14284 * will return the selected item, if any, or NULL I none is selected. If the
14285 * list is multi-select then elm_genlist_selected_items_get() will return a
14286 * list (that is only valid as long as no items are modified (added, deleted,
14287 * selected or unselected)).
14289 * @section Genlist_Usage_Hints Usage hints
14291 * There are also convenience functions. elm_genlist_item_genlist_get() will
14292 * return the genlist object the item belongs to. elm_genlist_item_show()
14293 * will make the scroller scroll to show that specific item so its visible.
14294 * elm_genlist_item_data_get() returns the data pointer set by the item
14295 * creation functions.
14297 * If an item changes (state of boolean changes, label or icons change),
14298 * then use elm_genlist_item_update() to have genlist update the item with
14299 * the new state. Genlist will re-realize the item thus call the functions
14300 * in the _Elm_Genlist_Item_Class for that item.
14302 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14303 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14304 * to expand/contract an item and get its expanded state, use
14305 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14306 * again to make an item disabled (unable to be selected and appear
14307 * differently) use elm_genlist_item_disabled_set() to set this and
14308 * elm_genlist_item_disabled_get() to get the disabled state.
14310 * In general to indicate how the genlist should expand items horizontally to
14311 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14312 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14313 * mode means that if items are too wide to fit, the scroller will scroll
14314 * horizontally. Otherwise items are expanded to fill the width of the
14315 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14316 * to the viewport width and limited to that size. This can be combined with
14317 * a different style that uses edjes' ellipsis feature (cutting text off like
14320 * Items will only call their selection func and callback when first becoming
14321 * selected. Any further clicks will do nothing, unless you enable always
14322 * select with elm_genlist_always_select_mode_set(). This means even if
14323 * selected, every click will make the selected callbacks be called.
14324 * elm_genlist_no_select_mode_set() will turn off the ability to select
14325 * items entirely and they will neither appear selected nor call selected
14326 * callback functions.
14328 * Remember that you can create new styles and add your own theme augmentation
14329 * per application with elm_theme_extension_add(). If you absolutely must
14330 * have a specific style that overrides any theme the user or system sets up
14331 * you can use elm_theme_overlay_add() to add such a file.
14333 * @section Genlist_Implementation Implementation
14335 * Evas tracks every object you create. Every time it processes an event
14336 * (mouse move, down, up etc.) it needs to walk through objects and find out
14337 * what event that affects. Even worse every time it renders display updates,
14338 * in order to just calculate what to re-draw, it needs to walk through many
14339 * many many objects. Thus, the more objects you keep active, the more
14340 * overhead Evas has in just doing its work. It is advisable to keep your
14341 * active objects to the minimum working set you need. Also remember that
14342 * object creation and deletion carries an overhead, so there is a
14343 * middle-ground, which is not easily determined. But don't keep massive lists
14344 * of objects you can't see or use. Genlist does this with list objects. It
14345 * creates and destroys them dynamically as you scroll around. It groups them
14346 * into blocks so it can determine the visibility etc. of a whole block at
14347 * once as opposed to having to walk the whole list. This 2-level list allows
14348 * for very large numbers of items to be in the list (tests have used up to
14349 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14350 * may be different sizes, every item added needs to be calculated as to its
14351 * size and thus this presents a lot of overhead on populating the list, this
14352 * genlist employs a queue. Any item added is queued and spooled off over
14353 * time, actually appearing some time later, so if your list has many members
14354 * you may find it takes a while for them to all appear, with your process
14355 * consuming a lot of CPU while it is busy spooling.
14357 * Genlist also implements a tree structure, but it does so with callbacks to
14358 * the application, with the application filling in tree structures when
14359 * requested (allowing for efficient building of a very deep tree that could
14360 * even be used for file-management). See the above smart signal callbacks for
14363 * @section Genlist_Smart_Events Genlist smart events
14365 * Signals that you can add callbacks for are:
14366 * - @c "activated" - The user has double-clicked or pressed
14367 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14368 * item that was activated.
14369 * - @c "clicked,double" - The user has double-clicked an item. The @c
14370 * event_info parameter is the item that was double-clicked.
14371 * - @c "selected" - This is called when a user has made an item selected.
14372 * The event_info parameter is the genlist item that was selected.
14373 * - @c "unselected" - This is called when a user has made an item
14374 * unselected. The event_info parameter is the genlist item that was
14376 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14377 * called and the item is now meant to be expanded. The event_info
14378 * parameter is the genlist item that was indicated to expand. It is the
14379 * job of this callback to then fill in the child items.
14380 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14381 * called and the item is now meant to be contracted. The event_info
14382 * parameter is the genlist item that was indicated to contract. It is the
14383 * job of this callback to then delete the child items.
14384 * - @c "expand,request" - This is called when a user has indicated they want
14385 * to expand a tree branch item. The callback should decide if the item can
14386 * expand (has any children) and then call elm_genlist_item_expanded_set()
14387 * appropriately to set the state. The event_info parameter is the genlist
14388 * item that was indicated to expand.
14389 * - @c "contract,request" - This is called when a user has indicated they
14390 * want to contract a tree branch item. The callback should decide if the
14391 * item can contract (has any children) and then call
14392 * elm_genlist_item_expanded_set() appropriately to set the state. The
14393 * event_info parameter is the genlist item that was indicated to contract.
14394 * - @c "realized" - This is called when the item in the list is created as a
14395 * real evas object. event_info parameter is the genlist item that was
14396 * created. The object may be deleted at any time, so it is up to the
14397 * caller to not use the object pointer from elm_genlist_item_object_get()
14398 * in a way where it may point to freed objects.
14399 * - @c "unrealized" - This is called just before an item is unrealized.
14400 * After this call icon objects provided will be deleted and the item
14401 * object itself delete or be put into a floating cache.
14402 * - @c "drag,start,up" - This is called when the item in the list has been
14403 * dragged (not scrolled) up.
14404 * - @c "drag,start,down" - This is called when the item in the list has been
14405 * dragged (not scrolled) down.
14406 * - @c "drag,start,left" - This is called when the item in the list has been
14407 * dragged (not scrolled) left.
14408 * - @c "drag,start,right" - This is called when the item in the list has
14409 * been dragged (not scrolled) right.
14410 * - @c "drag,stop" - This is called when the item in the list has stopped
14412 * - @c "drag" - This is called when the item in the list is being dragged.
14413 * - @c "longpressed" - This is called when the item is pressed for a certain
14414 * amount of time. By default it's 1 second.
14415 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14417 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14418 * until the bottom edge.
14419 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14420 * until the left edge.
14421 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14422 * until the right edge.
14423 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14425 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14427 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14429 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14431 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14432 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14433 * multi-touch pinched in.
14434 * - @c "swipe" - This is called when the genlist is swiped.
14436 * @section Genlist_Examples Examples
14438 * Here is a list of examples that use the genlist, trying to show some of
14439 * its capabilities:
14440 * - @ref genlist_example_01
14441 * - @ref genlist_example_02
14442 * - @ref genlist_example_03
14443 * - @ref genlist_example_04
14444 * - @ref genlist_example_05
14448 * @addtogroup Genlist
14453 * @enum _Elm_Genlist_Item_Flags
14454 * @typedef Elm_Genlist_Item_Flags
14456 * Defines if the item is of any special type (has subitems or it's the
14457 * index of a group), or is just a simple item.
14461 typedef enum _Elm_Genlist_Item_Flags
14463 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14464 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14465 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14466 } Elm_Genlist_Item_Flags;
14467 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14468 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14469 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14470 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14471 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14472 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14473 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14474 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14477 * @struct _Elm_Genlist_Item_Class
14479 * Genlist item class definition structs.
14481 * This struct contains the style and fetching functions that will define the
14482 * contents of each item.
14484 * @see @ref Genlist_Item_Class
14486 struct _Elm_Genlist_Item_Class
14488 const char *item_style; /**< style of this class. */
14491 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14492 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14493 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14494 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14495 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14497 const char *mode_item_style;
14501 * Add a new genlist widget to the given parent Elementary
14502 * (container) object
14504 * @param parent The parent object
14505 * @return a new genlist widget handle or @c NULL, on errors
14507 * This function inserts a new genlist widget on the canvas.
14509 * @see elm_genlist_item_append()
14510 * @see elm_genlist_item_del()
14511 * @see elm_genlist_clear()
14515 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14517 * Remove all items from a given genlist widget.
14519 * @param obj The genlist object
14521 * This removes (and deletes) all items in @p obj, leaving it empty.
14523 * @see elm_genlist_item_del(), to remove just one item.
14527 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14529 * Enable or disable multi-selection in the genlist
14531 * @param obj The genlist object
14532 * @param multi Multi-select enable/disable. Default is disabled.
14534 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14535 * the list. This allows more than 1 item to be selected. To retrieve the list
14536 * of selected items, use elm_genlist_selected_items_get().
14538 * @see elm_genlist_selected_items_get()
14539 * @see elm_genlist_multi_select_get()
14543 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14545 * Gets if multi-selection in genlist is enabled or disabled.
14547 * @param obj The genlist object
14548 * @return Multi-select enabled/disabled
14549 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14551 * @see elm_genlist_multi_select_set()
14555 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14557 * This sets the horizontal stretching mode.
14559 * @param obj The genlist object
14560 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14562 * This sets the mode used for sizing items horizontally. Valid modes
14563 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14564 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14565 * the scroller will scroll horizontally. Otherwise items are expanded
14566 * to fill the width of the viewport of the scroller. If it is
14567 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14568 * limited to that size.
14570 * @see elm_genlist_horizontal_get()
14574 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14575 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14577 * Gets the horizontal stretching mode.
14579 * @param obj The genlist object
14580 * @return The mode to use
14581 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14583 * @see elm_genlist_horizontal_set()
14587 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14588 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14590 * Set the always select mode.
14592 * @param obj The genlist object
14593 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14594 * EINA_FALSE = off). Default is @c EINA_FALSE.
14596 * Items will only call their selection func and callback when first
14597 * becoming selected. Any further clicks will do nothing, unless you
14598 * enable always select with elm_genlist_always_select_mode_set().
14599 * This means that, even if selected, every click will make the selected
14600 * callbacks be called.
14602 * @see elm_genlist_always_select_mode_get()
14606 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14608 * Get the always select mode.
14610 * @param obj The genlist object
14611 * @return The always select mode
14612 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14614 * @see elm_genlist_always_select_mode_set()
14618 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14620 * Enable/disable the no select mode.
14622 * @param obj The genlist object
14623 * @param no_select The no select mode
14624 * (EINA_TRUE = on, EINA_FALSE = off)
14626 * This will turn off the ability to select items entirely and they
14627 * will neither appear selected nor call selected callback functions.
14629 * @see elm_genlist_no_select_mode_get()
14633 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14635 * Gets whether the no select mode is enabled.
14637 * @param obj The genlist object
14638 * @return The no select mode
14639 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14641 * @see elm_genlist_no_select_mode_set()
14645 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14647 * Enable/disable compress mode.
14649 * @param obj The genlist object
14650 * @param compress The compress mode
14651 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14653 * This will enable the compress mode where items are "compressed"
14654 * horizontally to fit the genlist scrollable viewport width. This is
14655 * special for genlist. Do not rely on
14656 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14657 * work as genlist needs to handle it specially.
14659 * @see elm_genlist_compress_mode_get()
14663 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14665 * Get whether the compress mode is enabled.
14667 * @param obj The genlist object
14668 * @return The compress mode
14669 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14671 * @see elm_genlist_compress_mode_set()
14675 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14677 * Enable/disable height-for-width mode.
14679 * @param obj The genlist object
14680 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14681 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14683 * With height-for-width mode the item width will be fixed (restricted
14684 * to a minimum of) to the list width when calculating its size in
14685 * order to allow the height to be calculated based on it. This allows,
14686 * for instance, text block to wrap lines if the Edje part is
14687 * configured with "text.min: 0 1".
14689 * @note This mode will make list resize slower as it will have to
14690 * recalculate every item height again whenever the list width
14693 * @note When height-for-width mode is enabled, it also enables
14694 * compress mode (see elm_genlist_compress_mode_set()) and
14695 * disables homogeneous (see elm_genlist_homogeneous_set()).
14699 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14701 * Get whether the height-for-width mode is enabled.
14703 * @param obj The genlist object
14704 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14709 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14711 * Enable/disable horizontal and vertical bouncing effect.
14713 * @param obj The genlist object
14714 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14715 * EINA_FALSE = off). Default is @c EINA_FALSE.
14716 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14717 * EINA_FALSE = off). Default is @c EINA_TRUE.
14719 * This will enable or disable the scroller bouncing effect for the
14720 * genlist. See elm_scroller_bounce_set() for details.
14722 * @see elm_scroller_bounce_set()
14723 * @see elm_genlist_bounce_get()
14727 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14729 * Get whether the horizontal and vertical bouncing effect is enabled.
14731 * @param obj The genlist object
14732 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14734 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14737 * @see elm_genlist_bounce_set()
14741 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14743 * Enable/disable homogenous mode.
14745 * @param obj The genlist object
14746 * @param homogeneous Assume the items within the genlist are of the
14747 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14750 * This will enable the homogeneous mode where items are of the same
14751 * height and width so that genlist may do the lazy-loading at its
14752 * maximum (which increases the performance for scrolling the list). This
14753 * implies 'compressed' mode.
14755 * @see elm_genlist_compress_mode_set()
14756 * @see elm_genlist_homogeneous_get()
14760 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14762 * Get whether the homogenous mode is enabled.
14764 * @param obj The genlist object
14765 * @return Assume the items within the genlist are of the same height
14766 * and width (EINA_TRUE = on, EINA_FALSE = off)
14768 * @see elm_genlist_homogeneous_set()
14772 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14774 * Set the maximum number of items within an item block
14776 * @param obj The genlist object
14777 * @param n Maximum number of items within an item block. Default is 32.
14779 * This will configure the block count to tune to the target with
14780 * particular performance matrix.
14782 * A block of objects will be used to reduce the number of operations due to
14783 * many objects in the screen. It can determine the visibility, or if the
14784 * object has changed, it theme needs to be updated, etc. doing this kind of
14785 * calculation to the entire block, instead of per object.
14787 * The default value for the block count is enough for most lists, so unless
14788 * you know you will have a lot of objects visible in the screen at the same
14789 * time, don't try to change this.
14791 * @see elm_genlist_block_count_get()
14792 * @see @ref Genlist_Implementation
14796 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14798 * Get the maximum number of items within an item block
14800 * @param obj The genlist object
14801 * @return Maximum number of items within an item block
14803 * @see elm_genlist_block_count_set()
14807 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14809 * Set the timeout in seconds for the longpress event.
14811 * @param obj The genlist object
14812 * @param timeout timeout in seconds. Default is 1.
14814 * This option will change how long it takes to send an event "longpressed"
14815 * after the mouse down signal is sent to the list. If this event occurs, no
14816 * "clicked" event will be sent.
14818 * @see elm_genlist_longpress_timeout_set()
14822 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14824 * Get the timeout in seconds for the longpress event.
14826 * @param obj The genlist object
14827 * @return timeout in seconds
14829 * @see elm_genlist_longpress_timeout_get()
14833 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14835 * Append a new item in a given genlist widget.
14837 * @param obj The genlist object
14838 * @param itc The item class for the item
14839 * @param data The item data
14840 * @param parent The parent item, or NULL if none
14841 * @param flags Item flags
14842 * @param func Convenience function called when the item is selected
14843 * @param func_data Data passed to @p func above.
14844 * @return A handle to the item added or @c NULL if not possible
14846 * This adds the given item to the end of the list or the end of
14847 * the children list if the @p parent is given.
14849 * @see elm_genlist_item_prepend()
14850 * @see elm_genlist_item_insert_before()
14851 * @see elm_genlist_item_insert_after()
14852 * @see elm_genlist_item_del()
14856 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);
14858 * Prepend a new item in a given genlist widget.
14860 * @param obj The genlist object
14861 * @param itc The item class for the item
14862 * @param data The item data
14863 * @param parent The parent item, or NULL if none
14864 * @param flags Item flags
14865 * @param func Convenience function called when the item is selected
14866 * @param func_data Data passed to @p func above.
14867 * @return A handle to the item added or NULL if not possible
14869 * This adds an item to the beginning of the list or beginning of the
14870 * children of the parent if given.
14872 * @see elm_genlist_item_append()
14873 * @see elm_genlist_item_insert_before()
14874 * @see elm_genlist_item_insert_after()
14875 * @see elm_genlist_item_del()
14879 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);
14881 * Insert an item before another in a genlist widget
14883 * @param obj The genlist object
14884 * @param itc The item class for the item
14885 * @param data The item data
14886 * @param before The item to place this new one before.
14887 * @param flags Item flags
14888 * @param func Convenience function called when the item is selected
14889 * @param func_data Data passed to @p func above.
14890 * @return A handle to the item added or @c NULL if not possible
14892 * This inserts an item before another in the list. It will be in the
14893 * same tree level or group as the item it is inserted before.
14895 * @see elm_genlist_item_append()
14896 * @see elm_genlist_item_prepend()
14897 * @see elm_genlist_item_insert_after()
14898 * @see elm_genlist_item_del()
14902 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);
14904 * Insert an item after another in a genlist widget
14906 * @param obj The genlist object
14907 * @param itc The item class for the item
14908 * @param data The item data
14909 * @param after The item to place this new one after.
14910 * @param flags Item flags
14911 * @param func Convenience function called when the item is selected
14912 * @param func_data Data passed to @p func above.
14913 * @return A handle to the item added or @c NULL if not possible
14915 * This inserts an item after another in the list. It will be in the
14916 * same tree level or group as the item it is inserted after.
14918 * @see elm_genlist_item_append()
14919 * @see elm_genlist_item_prepend()
14920 * @see elm_genlist_item_insert_before()
14921 * @see elm_genlist_item_del()
14925 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);
14927 * Insert a new item into the sorted genlist object
14929 * @param obj The genlist object
14930 * @param itc The item class for the item
14931 * @param data The item data
14932 * @param parent The parent item, or NULL if none
14933 * @param flags Item flags
14934 * @param comp The function called for the sort
14935 * @param func Convenience function called when item selected
14936 * @param func_data Data passed to @p func above.
14937 * @return A handle to the item added or NULL if not possible
14941 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);
14942 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);
14943 /* operations to retrieve existing items */
14945 * Get the selectd item in the genlist.
14947 * @param obj The genlist object
14948 * @return The selected item, or NULL if none is selected.
14950 * This gets the selected item in the list (if multi-selection is enabled, only
14951 * the item that was first selected in the list is returned - which is not very
14952 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14955 * If no item is selected, NULL is returned.
14957 * @see elm_genlist_selected_items_get()
14961 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14963 * Get a list of selected items in the genlist.
14965 * @param obj The genlist object
14966 * @return The list of selected items, or NULL if none are selected.
14968 * It returns a list of the selected items. This list pointer is only valid so
14969 * long as the selection doesn't change (no items are selected or unselected, or
14970 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14971 * pointers. The order of the items in this list is the order which they were
14972 * selected, i.e. the first item in this list is the first item that was
14973 * selected, and so on.
14975 * @note If not in multi-select mode, consider using function
14976 * elm_genlist_selected_item_get() instead.
14978 * @see elm_genlist_multi_select_set()
14979 * @see elm_genlist_selected_item_get()
14983 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14985 * Get a list of realized items in genlist
14987 * @param obj The genlist object
14988 * @return The list of realized items, nor NULL if none are realized.
14990 * This returns a list of the realized items in the genlist. The list
14991 * contains Elm_Genlist_Item pointers. The list must be freed by the
14992 * caller when done with eina_list_free(). The item pointers in the
14993 * list are only valid so long as those items are not deleted or the
14994 * genlist is not deleted.
14996 * @see elm_genlist_realized_items_update()
15000 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15002 * Get the item that is at the x, y canvas coords.
15004 * @param obj The gelinst object.
15005 * @param x The input x coordinate
15006 * @param y The input y coordinate
15007 * @param posret The position relative to the item returned here
15008 * @return The item at the coordinates or NULL if none
15010 * This returns the item at the given coordinates (which are canvas
15011 * relative, not object-relative). If an item is at that coordinate,
15012 * that item handle is returned, and if @p posret is not NULL, the
15013 * integer pointed to is set to a value of -1, 0 or 1, depending if
15014 * the coordinate is on the upper portion of that item (-1), on the
15015 * middle section (0) or on the lower part (1). If NULL is returned as
15016 * an item (no item found there), then posret may indicate -1 or 1
15017 * based if the coordinate is above or below all items respectively in
15022 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);
15024 * Get the first item in the genlist
15026 * This returns the first item in the list.
15028 * @param obj The genlist object
15029 * @return The first item, or NULL if none
15033 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15035 * Get the last item in the genlist
15037 * This returns the last item in the list.
15039 * @return The last item, or NULL if none
15043 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15045 * Set the scrollbar policy
15047 * @param obj The genlist object
15048 * @param policy_h Horizontal scrollbar policy.
15049 * @param policy_v Vertical scrollbar policy.
15051 * This sets the scrollbar visibility policy for the given genlist
15052 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15053 * made visible if it is needed, and otherwise kept hidden.
15054 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15055 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15056 * respectively for the horizontal and vertical scrollbars. Default is
15057 * #ELM_SMART_SCROLLER_POLICY_AUTO
15059 * @see elm_genlist_scroller_policy_get()
15063 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15065 * Get the scrollbar policy
15067 * @param obj The genlist object
15068 * @param policy_h Pointer to store the horizontal scrollbar policy.
15069 * @param policy_v Pointer to store the vertical scrollbar policy.
15071 * @see elm_genlist_scroller_policy_set()
15075 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);
15077 * Get the @b next item in a genlist widget's internal list of items,
15078 * given a handle to one of those items.
15080 * @param item The genlist item to fetch next from
15081 * @return The item after @p item, or @c NULL if there's none (and
15084 * This returns the item placed after the @p item, on the container
15087 * @see elm_genlist_item_prev_get()
15091 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15093 * Get the @b previous item in a genlist widget's internal list of items,
15094 * given a handle to one of those items.
15096 * @param item The genlist item to fetch previous from
15097 * @return The item before @p item, or @c NULL if there's none (and
15100 * This returns the item placed before the @p item, on the container
15103 * @see elm_genlist_item_next_get()
15107 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15109 * Get the genlist object's handle which contains a given genlist
15112 * @param item The item to fetch the container from
15113 * @return The genlist (parent) object
15115 * This returns the genlist object itself that an item belongs to.
15119 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15121 * Get the parent item of the given item
15123 * @param it The item
15124 * @return The parent of the item or @c NULL if it has no parent.
15126 * This returns the item that was specified as parent of the item @p it on
15127 * elm_genlist_item_append() and insertion related functions.
15131 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15133 * Remove all sub-items (children) of the given item
15135 * @param it The item
15137 * This removes all items that are children (and their descendants) of the
15138 * given item @p it.
15140 * @see elm_genlist_clear()
15141 * @see elm_genlist_item_del()
15145 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15147 * Set whether a given genlist item is selected or not
15149 * @param it The item
15150 * @param selected Use @c EINA_TRUE, to make it selected, @c
15151 * EINA_FALSE to make it unselected
15153 * This sets the selected state of an item. If multi selection is
15154 * not enabled on the containing genlist and @p selected is @c
15155 * EINA_TRUE, any other previously selected items will get
15156 * unselected in favor of this new one.
15158 * @see elm_genlist_item_selected_get()
15162 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15164 * Get whether a given genlist item is selected or not
15166 * @param it The item
15167 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15169 * @see elm_genlist_item_selected_set() for more details
15173 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15175 * Sets the expanded state of an item.
15177 * @param it The item
15178 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15180 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15183 * The theme will respond to this change visually, and a signal "expanded" or
15184 * "contracted" will be sent from the genlist with a pointer to the item that
15185 * has been expanded/contracted.
15187 * Calling this function won't show or hide any child of this item (if it is
15188 * a parent). You must manually delete and create them on the callbacks fo
15189 * the "expanded" or "contracted" signals.
15191 * @see elm_genlist_item_expanded_get()
15195 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15197 * Get the expanded state of an item
15199 * @param it The item
15200 * @return The expanded state
15202 * This gets the expanded state of an item.
15204 * @see elm_genlist_item_expanded_set()
15208 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15210 * Get the depth of expanded item
15212 * @param it The genlist item object
15213 * @return The depth of expanded item
15217 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15219 * Set whether a given genlist item is disabled or not.
15221 * @param it The item
15222 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15223 * to enable it back.
15225 * A disabled item cannot be selected or unselected. It will also
15226 * change its appearance, to signal the user it's disabled.
15228 * @see elm_genlist_item_disabled_get()
15232 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15234 * Get whether a given genlist item is disabled or not.
15236 * @param it The item
15237 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15240 * @see elm_genlist_item_disabled_set() for more details
15244 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15246 * Sets the display only state of an item.
15248 * @param it The item
15249 * @param display_only @c EINA_TRUE if the item is display only, @c
15250 * EINA_FALSE otherwise.
15252 * A display only item cannot be selected or unselected. It is for
15253 * display only and not selecting or otherwise clicking, dragging
15254 * etc. by the user, thus finger size rules will not be applied to
15257 * It's good to set group index items to display only state.
15259 * @see elm_genlist_item_display_only_get()
15263 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15265 * Get the display only state of an item
15267 * @param it The item
15268 * @return @c EINA_TRUE if the item is display only, @c
15269 * EINA_FALSE otherwise.
15271 * @see elm_genlist_item_display_only_set()
15275 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15277 * Show the portion of a genlist's internal list containing a given
15278 * item, immediately.
15280 * @param it The item to display
15282 * This causes genlist to jump to the given item @p it and show it (by
15283 * immediately scrolling to that position), if it is not fully visible.
15285 * @see elm_genlist_item_bring_in()
15286 * @see elm_genlist_item_top_show()
15287 * @see elm_genlist_item_middle_show()
15291 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15293 * Animatedly bring in, to the visible are of a genlist, a given
15296 * @param it The item to display
15298 * This causes genlist to jump to the given item @p it and show it (by
15299 * animatedly scrolling), if it is not fully visible. This may use animation
15300 * to do so and take a period of time
15302 * @see elm_genlist_item_show()
15303 * @see elm_genlist_item_top_bring_in()
15304 * @see elm_genlist_item_middle_bring_in()
15308 EAPI void elm_genlist_item_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 top of the genlist viewport.
15320 * @see elm_genlist_item_show()
15321 * @see elm_genlist_item_top_bring_in()
15325 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) 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 top of the genlist viewport.
15338 * @see elm_genlist_item_bring_in()
15339 * @see elm_genlist_item_top_show()
15343 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15345 * Show the portion of a genlist's internal list containing a given
15346 * item, immediately.
15348 * @param it The item to display
15350 * This causes genlist to jump to the given item @p it and show it (by
15351 * immediately scrolling to that position), if it is not fully visible.
15353 * The item will be positioned at the middle of the genlist viewport.
15355 * @see elm_genlist_item_show()
15356 * @see elm_genlist_item_middle_bring_in()
15360 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15362 * Animatedly bring in, to the visible are of a genlist, a given
15365 * @param it The item
15367 * This causes genlist to jump to the given item @p it and show it (by
15368 * animatedly scrolling), if it is not fully visible. This may use animation
15369 * to do so and take a period of time
15371 * The item will be positioned at the middle of the genlist viewport.
15373 * @see elm_genlist_item_bring_in()
15374 * @see elm_genlist_item_middle_show()
15378 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15380 * Remove a genlist item from the its parent, deleting it.
15382 * @param item The item to be removed.
15383 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15385 * @see elm_genlist_clear(), to remove all items in a genlist at
15390 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15392 * Return the data associated to a given genlist item
15394 * @param item The genlist item.
15395 * @return the data associated to this item.
15397 * This returns the @c data value passed on the
15398 * elm_genlist_item_append() and related item addition calls.
15400 * @see elm_genlist_item_append()
15401 * @see elm_genlist_item_data_set()
15405 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15407 * Set the data associated to a given genlist item
15409 * @param item The genlist item
15410 * @param data The new data pointer to set on it
15412 * This @b overrides the @c data value passed on the
15413 * elm_genlist_item_append() and related item addition calls. This
15414 * function @b won't call elm_genlist_item_update() automatically,
15415 * so you'd issue it afterwards if you want to hove the item
15416 * updated to reflect the that new data.
15418 * @see elm_genlist_item_data_get()
15422 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15424 * Tells genlist to "orphan" icons fetchs by the item class
15426 * @param it The item
15428 * This instructs genlist to release references to icons in the item,
15429 * meaning that they will no longer be managed by genlist and are
15430 * floating "orphans" that can be re-used elsewhere if the user wants
15435 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15437 * Get the real Evas object created to implement the view of a
15438 * given genlist item
15440 * @param item The genlist item.
15441 * @return the Evas object implementing this item's view.
15443 * This returns the actual Evas object used to implement the
15444 * specified genlist item's view. This may be @c NULL, as it may
15445 * not have been created or may have been deleted, at any time, by
15446 * the genlist. <b>Do not modify this object</b> (move, resize,
15447 * show, hide, etc.), as the genlist is controlling it. This
15448 * function is for querying, emitting custom signals or hooking
15449 * lower level callbacks for events on that object. Do not delete
15450 * this object under any circumstances.
15452 * @see elm_genlist_item_data_get()
15456 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15458 * Update the contents of an item
15460 * @param it The item
15462 * This updates an item by calling all the item class functions again
15463 * to get the icons, labels and states. Use this when the original
15464 * item data has changed and the changes are desired to be reflected.
15466 * Use elm_genlist_realized_items_update() to update all already realized
15469 * @see elm_genlist_realized_items_update()
15473 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15475 * Update the item class of an item
15477 * @param it The item
15478 * @param itc The item class for the item
15480 * This sets another class fo the item, changing the way that it is
15481 * displayed. After changing the item class, elm_genlist_item_update() is
15482 * called on the item @p it.
15486 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15487 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15489 * Set the text to be shown in a given genlist item's tooltips.
15491 * @param item The genlist item
15492 * @param text The text to set in the content
15494 * This call will setup the text to be used as tooltip to that item
15495 * (analogous to elm_object_tooltip_text_set(), but being item
15496 * tooltips with higher precedence than object tooltips). It can
15497 * have only one tooltip at a time, so any previous tooltip data
15498 * will get removed.
15500 * In order to set an icon or something else as a tooltip, look at
15501 * elm_genlist_item_tooltip_content_cb_set().
15505 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15507 * Set the content to be shown in a given genlist item's tooltips
15509 * @param item The genlist item.
15510 * @param func The function returning the tooltip contents.
15511 * @param data What to provide to @a func as callback data/context.
15512 * @param del_cb Called when data is not needed anymore, either when
15513 * another callback replaces @p func, the tooltip is unset with
15514 * elm_genlist_item_tooltip_unset() or the owner @p item
15515 * dies. This callback receives as its first parameter the
15516 * given @p data, being @c event_info the item handle.
15518 * This call will setup the tooltip's contents to @p item
15519 * (analogous to elm_object_tooltip_content_cb_set(), but being
15520 * item tooltips with higher precedence than object tooltips). It
15521 * can have only one tooltip at a time, so any previous tooltip
15522 * content will get removed. @p func (with @p data) will be called
15523 * every time Elementary needs to show the tooltip and it should
15524 * return a valid Evas object, which will be fully managed by the
15525 * tooltip system, getting deleted when the tooltip is gone.
15527 * In order to set just a text as a tooltip, look at
15528 * elm_genlist_item_tooltip_text_set().
15532 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);
15534 * Unset a tooltip from a given genlist item
15536 * @param item genlist item to remove a previously set tooltip from.
15538 * This call removes any tooltip set on @p item. The callback
15539 * provided as @c del_cb to
15540 * elm_genlist_item_tooltip_content_cb_set() will be called to
15541 * notify it is not used anymore (and have resources cleaned, if
15544 * @see elm_genlist_item_tooltip_content_cb_set()
15548 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15550 * Set a different @b style for a given genlist item's tooltip.
15552 * @param item genlist item with tooltip set
15553 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15554 * "default", @c "transparent", etc)
15556 * Tooltips can have <b>alternate styles</b> to be displayed on,
15557 * which are defined by the theme set on Elementary. This function
15558 * works analogously as elm_object_tooltip_style_set(), but here
15559 * applied only to genlist item objects. The default style for
15560 * tooltips is @c "default".
15562 * @note before you set a style you should define a tooltip with
15563 * elm_genlist_item_tooltip_content_cb_set() or
15564 * elm_genlist_item_tooltip_text_set()
15566 * @see elm_genlist_item_tooltip_style_get()
15570 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15572 * Get the style set a given genlist item's tooltip.
15574 * @param item genlist item with tooltip already set on.
15575 * @return style the theme style in use, which defaults to
15576 * "default". If the object does not have a tooltip set,
15577 * then @c NULL is returned.
15579 * @see elm_genlist_item_tooltip_style_set() for more details
15583 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15585 * @brief Disable size restrictions on an object's tooltip
15586 * @param item The tooltip's anchor object
15587 * @param disable If EINA_TRUE, size restrictions are disabled
15588 * @return EINA_FALSE on failure, EINA_TRUE on success
15590 * This function allows a tooltip to expand beyond its parant window's canvas.
15591 * It will instead be limited only by the size of the display.
15593 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15595 * @brief Retrieve size restriction state of an object's tooltip
15596 * @param item The tooltip's anchor object
15597 * @return If EINA_TRUE, size restrictions are disabled
15599 * This function returns whether a tooltip is allowed to expand beyond
15600 * its parant window's canvas.
15601 * It will instead be limited only by the size of the display.
15603 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15605 * Set the type of mouse pointer/cursor decoration to be shown,
15606 * when the mouse pointer is over the given genlist widget item
15608 * @param item genlist item to customize cursor on
15609 * @param cursor the cursor type's name
15611 * This function works analogously as elm_object_cursor_set(), but
15612 * here the cursor's changing area is restricted to the item's
15613 * area, and not the whole widget's. Note that that item cursors
15614 * have precedence over widget cursors, so that a mouse over @p
15615 * item will always show cursor @p type.
15617 * If this function is called twice for an object, a previously set
15618 * cursor will be unset on the second call.
15620 * @see elm_object_cursor_set()
15621 * @see elm_genlist_item_cursor_get()
15622 * @see elm_genlist_item_cursor_unset()
15626 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15628 * Get the type of mouse pointer/cursor decoration set to be shown,
15629 * when the mouse pointer is over the given genlist widget item
15631 * @param item genlist item with custom cursor set
15632 * @return the cursor type's name or @c NULL, if no custom cursors
15633 * were set to @p item (and on errors)
15635 * @see elm_object_cursor_get()
15636 * @see elm_genlist_item_cursor_set() for more details
15637 * @see elm_genlist_item_cursor_unset()
15641 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15643 * Unset any custom mouse pointer/cursor decoration set to be
15644 * shown, when the mouse pointer is over the given genlist widget
15645 * item, thus making it show the @b default cursor again.
15647 * @param item a genlist item
15649 * Use this call to undo any custom settings on this item's cursor
15650 * decoration, bringing it back to defaults (no custom style set).
15652 * @see elm_object_cursor_unset()
15653 * @see elm_genlist_item_cursor_set() for more details
15657 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15659 * Set a different @b style for a given custom cursor set for a
15662 * @param item genlist item with custom cursor set
15663 * @param style the <b>theme style</b> to use (e.g. @c "default",
15664 * @c "transparent", etc)
15666 * This function only makes sense when one is using custom mouse
15667 * cursor decorations <b>defined in a theme file</b> , which can
15668 * have, given a cursor name/type, <b>alternate styles</b> on
15669 * it. It works analogously as elm_object_cursor_style_set(), but
15670 * here applied only to genlist item objects.
15672 * @warning Before you set a cursor style you should have defined a
15673 * custom cursor previously on the item, with
15674 * elm_genlist_item_cursor_set()
15676 * @see elm_genlist_item_cursor_engine_only_set()
15677 * @see elm_genlist_item_cursor_style_get()
15681 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15683 * Get the current @b style set for a given genlist item's custom
15686 * @param item genlist item with custom cursor set.
15687 * @return style the cursor style in use. If the object does not
15688 * have a cursor set, then @c NULL is returned.
15690 * @see elm_genlist_item_cursor_style_set() for more details
15694 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15696 * Set if the (custom) cursor for a given genlist item should be
15697 * searched in its theme, also, or should only rely on the
15698 * rendering engine.
15700 * @param item item with custom (custom) cursor already set on
15701 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15702 * only on those provided by the rendering engine, @c EINA_FALSE to
15703 * have them searched on the widget's theme, as well.
15705 * @note This call is of use only if you've set a custom cursor
15706 * for genlist items, with elm_genlist_item_cursor_set().
15708 * @note By default, cursors will only be looked for between those
15709 * provided by the rendering engine.
15713 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15715 * Get if the (custom) cursor for a given genlist item is being
15716 * searched in its theme, also, or is only relying on the rendering
15719 * @param item a genlist item
15720 * @return @c EINA_TRUE, if cursors are being looked for only on
15721 * those provided by the rendering engine, @c EINA_FALSE if they
15722 * are being searched on the widget's theme, as well.
15724 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15728 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15730 * Update the contents of all realized items.
15732 * @param obj The genlist object.
15734 * This updates all realized items by calling all the item class functions again
15735 * to get the icons, labels and states. Use this when the original
15736 * item data has changed and the changes are desired to be reflected.
15738 * To update just one item, use elm_genlist_item_update().
15740 * @see elm_genlist_realized_items_get()
15741 * @see elm_genlist_item_update()
15745 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15747 * Activate a genlist mode on an item
15749 * @param item The genlist item
15750 * @param mode Mode name
15751 * @param mode_set Boolean to define set or unset mode.
15753 * A genlist mode is a different way of selecting an item. Once a mode is
15754 * activated on an item, any other selected item is immediately unselected.
15755 * This feature provides an easy way of implementing a new kind of animation
15756 * for selecting an item, without having to entirely rewrite the item style
15757 * theme. However, the elm_genlist_selected_* API can't be used to get what
15758 * item is activate for a mode.
15760 * The current item style will still be used, but applying a genlist mode to
15761 * an item will select it using a different kind of animation.
15763 * The current active item for a mode can be found by
15764 * elm_genlist_mode_item_get().
15766 * The characteristics of genlist mode are:
15767 * - Only one mode can be active at any time, and for only one item.
15768 * - Genlist handles deactivating other items when one item is activated.
15769 * - A mode is defined in the genlist theme (edc), and more modes can easily
15771 * - A mode style and the genlist item style are different things. They
15772 * can be combined to provide a default style to the item, with some kind
15773 * of animation for that item when the mode is activated.
15775 * When a mode is activated on an item, a new view for that item is created.
15776 * The theme of this mode defines the animation that will be used to transit
15777 * the item from the old view to the new view. This second (new) view will be
15778 * active for that item while the mode is active on the item, and will be
15779 * destroyed after the mode is totally deactivated from that item.
15781 * @see elm_genlist_mode_get()
15782 * @see elm_genlist_mode_item_get()
15786 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15788 * Get the last (or current) genlist mode used.
15790 * @param obj The genlist object
15792 * This function just returns the name of the last used genlist mode. It will
15793 * be the current mode if it's still active.
15795 * @see elm_genlist_item_mode_set()
15796 * @see elm_genlist_mode_item_get()
15800 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15802 * Get active genlist mode item
15804 * @param obj The genlist object
15805 * @return The active item for that current mode. Or @c NULL if no item is
15806 * activated with any mode.
15808 * This function returns the item that was activated with a mode, by the
15809 * function elm_genlist_item_mode_set().
15811 * @see elm_genlist_item_mode_set()
15812 * @see elm_genlist_mode_get()
15816 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15817 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15818 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15825 * @defgroup Check Check
15827 * @image html img/widget/check/preview-00.png
15828 * @image latex img/widget/check/preview-00.eps
15829 * @image html img/widget/check/preview-01.png
15830 * @image latex img/widget/check/preview-01.eps
15831 * @image html img/widget/check/preview-02.png
15832 * @image latex img/widget/check/preview-02.eps
15834 * @brief The check widget allows for toggling a value between true and
15837 * Check objects are a lot like radio objects in layout and functionality
15838 * except they do not work as a group, but independently and only toggle the
15839 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15840 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15841 * returns the current state. For convenience, like the radio objects, you
15842 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15843 * for it to modify.
15845 * Signals that you can add callbacks for are:
15846 * "changed" - This is called whenever the user changes the state of one of
15847 * the check object(event_info is NULL).
15849 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15853 * @brief Add a new Check object
15855 * @param parent The parent object
15856 * @return The new object or NULL if it cannot be created
15858 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15860 * @brief Set the text label of the check object
15862 * @param obj The check object
15863 * @param label The text label string in UTF-8
15865 * @deprecated use elm_object_text_set() instead.
15867 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15869 * @brief Get the text label of the check object
15871 * @param obj The check object
15872 * @return The text label string in UTF-8
15874 * @deprecated use elm_object_text_get() instead.
15876 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15878 * @brief Set the icon object of the check object
15880 * @param obj The check object
15881 * @param icon The icon object
15883 * Once the icon object is set, a previously set one will be deleted.
15884 * If you want to keep that old content object, use the
15885 * elm_check_icon_unset() function.
15887 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15889 * @brief Get the icon object of the check object
15891 * @param obj The check object
15892 * @return The icon object
15894 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15896 * @brief Unset the icon used for the check object
15898 * @param obj The check object
15899 * @return The icon object that was being used
15901 * Unparent and return the icon object which was set for this widget.
15903 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15905 * @brief Set the on/off state of the check object
15907 * @param obj The check object
15908 * @param state The state to use (1 == on, 0 == off)
15910 * This sets the state of the check. If set
15911 * with elm_check_state_pointer_set() the state of that variable is also
15912 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15914 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15916 * @brief Get the state of the check object
15918 * @param obj The check object
15919 * @return The boolean state
15921 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15923 * @brief Set a convenience pointer to a boolean to change
15925 * @param obj The check object
15926 * @param statep Pointer to the boolean to modify
15928 * This sets a pointer to a boolean, that, in addition to the check objects
15929 * state will also be modified directly. To stop setting the object pointed
15930 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15931 * then when this is called, the check objects state will also be modified to
15932 * reflect the value of the boolean @p statep points to, just like calling
15933 * elm_check_state_set().
15935 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15941 * @defgroup Radio Radio
15943 * @image html img/widget/radio/preview-00.png
15944 * @image latex img/widget/radio/preview-00.eps
15946 * @brief Radio is a widget that allows for 1 or more options to be displayed
15947 * and have the user choose only 1 of them.
15949 * A radio object contains an indicator, an optional Label and an optional
15950 * icon object. While it's possible to have a group of only one radio they,
15951 * are normally used in groups of 2 or more. To add a radio to a group use
15952 * elm_radio_group_add(). The radio object(s) will select from one of a set
15953 * of integer values, so any value they are configuring needs to be mapped to
15954 * a set of integers. To configure what value that radio object represents,
15955 * use elm_radio_state_value_set() to set the integer it represents. To set
15956 * the value the whole group(which one is currently selected) is to indicate
15957 * use elm_radio_value_set() on any group member, and to get the groups value
15958 * use elm_radio_value_get(). For convenience the radio objects are also able
15959 * to directly set an integer(int) to the value that is selected. To specify
15960 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15961 * The radio objects will modify this directly. That implies the pointer must
15962 * point to valid memory for as long as the radio objects exist.
15964 * Signals that you can add callbacks for are:
15965 * @li changed - This is called whenever the user changes the state of one of
15966 * the radio objects within the group of radio objects that work together.
15968 * @ref tutorial_radio show most of this API in action.
15972 * @brief Add a new radio to the parent
15974 * @param parent The parent object
15975 * @return The new object or NULL if it cannot be created
15977 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15979 * @brief Set the text label of the radio object
15981 * @param obj The radio object
15982 * @param label The text label string in UTF-8
15984 * @deprecated use elm_object_text_set() instead.
15986 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15988 * @brief Get the text label of the radio object
15990 * @param obj The radio object
15991 * @return The text label string in UTF-8
15993 * @deprecated use elm_object_text_set() instead.
15995 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15997 * @brief Set the icon object of the radio object
15999 * @param obj The radio object
16000 * @param icon The icon object
16002 * Once the icon object is set, a previously set one will be deleted. If you
16003 * want to keep that old content object, use the elm_radio_icon_unset()
16006 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16008 * @brief Get the icon object of the radio object
16010 * @param obj The radio object
16011 * @return The icon object
16013 * @see elm_radio_icon_set()
16015 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16017 * @brief Unset the icon used for the radio object
16019 * @param obj The radio object
16020 * @return The icon object that was being used
16022 * Unparent and return the icon object which was set for this widget.
16024 * @see elm_radio_icon_set()
16026 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16028 * @brief Add this radio to a group of other radio objects
16030 * @param obj The radio object
16031 * @param group Any object whose group the @p obj is to join.
16033 * Radio objects work in groups. Each member should have a different integer
16034 * value assigned. In order to have them work as a group, they need to know
16035 * about each other. This adds the given radio object to the group of which
16036 * the group object indicated is a member.
16038 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16040 * @brief Set the integer value that this radio object represents
16042 * @param obj The radio object
16043 * @param value The value to use if this radio object is selected
16045 * This sets the value of the radio.
16047 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16049 * @brief Get the integer value that this radio object represents
16051 * @param obj The radio object
16052 * @return The value used if this radio object is selected
16054 * This gets the value of the radio.
16056 * @see elm_radio_value_set()
16058 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16060 * @brief Set the value of the radio.
16062 * @param obj The radio object
16063 * @param value The value to use for the group
16065 * This sets the value of the radio group and will also set the value if
16066 * pointed to, to the value supplied, but will not call any callbacks.
16068 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16070 * @brief Get the state of the radio object
16072 * @param obj The radio object
16073 * @return The integer state
16075 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16077 * @brief Set a convenience pointer to a integer to change
16079 * @param obj The radio object
16080 * @param valuep Pointer to the integer to modify
16082 * This sets a pointer to a integer, that, in addition to the radio objects
16083 * state will also be modified directly. To stop setting the object pointed
16084 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16085 * when this is called, the radio objects state will also be modified to
16086 * reflect the value of the integer valuep points to, just like calling
16087 * elm_radio_value_set().
16089 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16095 * @defgroup Pager Pager
16097 * @image html img/widget/pager/preview-00.png
16098 * @image latex img/widget/pager/preview-00.eps
16100 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16102 * The flipping between “pages” of objects is animated. All content in pager
16103 * is kept in a stack, the last content to be added will be on the top of the
16104 * stack(be visible).
16106 * Objects can be pushed or popped from the stack or deleted as normal.
16107 * Pushes and pops will animate (and a pop will delete the object once the
16108 * animation is finished). Any object already in the pager can be promoted to
16109 * the top(from its current stacking position) through the use of
16110 * elm_pager_content_promote(). Objects are pushed to the top with
16111 * elm_pager_content_push() and when the top item is no longer wanted, simply
16112 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16113 * object is no longer needed and is not the top item, just delete it as
16114 * normal. You can query which objects are the top and bottom with
16115 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16117 * Signals that you can add callbacks for are:
16118 * "hide,finished" - when the previous page is hided
16120 * This widget has the following styles available:
16123 * @li fade_translucide
16124 * @li fade_invisible
16125 * @note This styles affect only the flipping animations, the appearance when
16126 * not animating is unaffected by styles.
16128 * @ref tutorial_pager gives a good overview of the usage of the API.
16132 * Add a new pager to the parent
16134 * @param parent The parent object
16135 * @return The new object or NULL if it cannot be created
16139 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16141 * @brief Push an object to the top of the pager stack (and show it).
16143 * @param obj The pager object
16144 * @param content The object to push
16146 * The object pushed becomes a child of the pager, it will be controlled and
16147 * deleted when the pager is deleted.
16149 * @note If the content is already in the stack use
16150 * elm_pager_content_promote().
16151 * @warning Using this function on @p content already in the stack results in
16152 * undefined behavior.
16154 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16156 * @brief Pop the object that is on top of the stack
16158 * @param obj The pager object
16160 * This pops the object that is on the top(visible) of the pager, makes it
16161 * disappear, then deletes the object. The object that was underneath it on
16162 * the stack will become visible.
16164 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16166 * @brief Moves an object already in the pager stack to the top of the stack.
16168 * @param obj The pager object
16169 * @param content The object to promote
16171 * This will take the @p content and move it to the top of the stack as
16172 * if it had been pushed there.
16174 * @note If the content isn't already in the stack use
16175 * elm_pager_content_push().
16176 * @warning Using this function on @p content not already in the stack
16177 * results in undefined behavior.
16179 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16181 * @brief Return the object at the bottom of the pager stack
16183 * @param obj The pager object
16184 * @return The bottom object or NULL if none
16186 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16188 * @brief Return the object at the top of the pager stack
16190 * @param obj The pager object
16191 * @return The top object or NULL if none
16193 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16199 * @defgroup Slideshow Slideshow
16201 * @image html img/widget/slideshow/preview-00.png
16202 * @image latex img/widget/slideshow/preview-00.eps
16204 * This widget, as the name indicates, is a pre-made image
16205 * slideshow panel, with API functions acting on (child) image
16206 * items presentation. Between those actions, are:
16207 * - advance to next/previous image
16208 * - select the style of image transition animation
16209 * - set the exhibition time for each image
16210 * - start/stop the slideshow
16212 * The transition animations are defined in the widget's theme,
16213 * consequently new animations can be added without having to
16214 * update the widget's code.
16216 * @section Slideshow_Items Slideshow items
16218 * For slideshow items, just like for @ref Genlist "genlist" ones,
16219 * the user defines a @b classes, specifying functions that will be
16220 * called on the item's creation and deletion times.
16222 * The #Elm_Slideshow_Item_Class structure contains the following
16225 * - @c func.get - When an item is displayed, this function is
16226 * called, and it's where one should create the item object, de
16227 * facto. For example, the object can be a pure Evas image object
16228 * or an Elementary @ref Photocam "photocam" widget. See
16229 * #SlideshowItemGetFunc.
16230 * - @c func.del - When an item is no more displayed, this function
16231 * is called, where the user must delete any data associated to
16232 * the item. See #SlideshowItemDelFunc.
16234 * @section Slideshow_Caching Slideshow caching
16236 * The slideshow provides facilities to have items adjacent to the
16237 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16238 * you, so that the system does not have to decode image data
16239 * anymore at the time it has to actually switch images on its
16240 * viewport. The user is able to set the numbers of items to be
16241 * cached @b before and @b after the current item, in the widget's
16244 * Smart events one can add callbacks for are:
16246 * - @c "changed" - when the slideshow switches its view to a new
16249 * List of examples for the slideshow widget:
16250 * @li @ref slideshow_example
16254 * @addtogroup Slideshow
16258 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16259 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16260 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16261 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16262 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16265 * @struct _Elm_Slideshow_Item_Class
16267 * Slideshow item class definition. See @ref Slideshow_Items for
16270 struct _Elm_Slideshow_Item_Class
16272 struct _Elm_Slideshow_Item_Class_Func
16274 SlideshowItemGetFunc get;
16275 SlideshowItemDelFunc del;
16277 }; /**< #Elm_Slideshow_Item_Class member definitions */
16280 * Add a new slideshow widget to the given parent Elementary
16281 * (container) object
16283 * @param parent The parent object
16284 * @return A new slideshow widget handle or @c NULL, on errors
16286 * This function inserts a new slideshow widget on the canvas.
16288 * @ingroup Slideshow
16290 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16293 * Add (append) a new item in a given slideshow widget.
16295 * @param obj The slideshow object
16296 * @param itc The item class for the item
16297 * @param data The item's data
16298 * @return A handle to the item added or @c NULL, on errors
16300 * Add a new item to @p obj's internal list of items, appending it.
16301 * The item's class must contain the function really fetching the
16302 * image object to show for this item, which could be an Evas image
16303 * object or an Elementary photo, for example. The @p data
16304 * parameter is going to be passed to both class functions of the
16307 * @see #Elm_Slideshow_Item_Class
16308 * @see elm_slideshow_item_sorted_insert()
16310 * @ingroup Slideshow
16312 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16315 * Insert a new item into the given slideshow widget, using the @p func
16316 * function to sort items (by item handles).
16318 * @param obj The slideshow object
16319 * @param itc The item class for the item
16320 * @param data The item's data
16321 * @param func The comparing function to be used to sort slideshow
16322 * items <b>by #Elm_Slideshow_Item item handles</b>
16323 * @return Returns The slideshow item handle, on success, or
16324 * @c NULL, on errors
16326 * Add a new item to @p obj's internal list of items, in a position
16327 * determined by the @p func comparing function. The item's class
16328 * must contain the function really fetching the image object to
16329 * show for this item, which could be an Evas image object or an
16330 * Elementary photo, for example. The @p data parameter is going to
16331 * be passed to both class functions of the item.
16333 * @see #Elm_Slideshow_Item_Class
16334 * @see elm_slideshow_item_add()
16336 * @ingroup Slideshow
16338 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);
16341 * Display a given slideshow widget's item, programmatically.
16343 * @param obj The slideshow object
16344 * @param item The item to display on @p obj's viewport
16346 * The change between the current item and @p item will use the
16347 * transition @p obj is set to use (@see
16348 * elm_slideshow_transition_set()).
16350 * @ingroup Slideshow
16352 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16355 * Slide to the @b next item, in a given slideshow widget
16357 * @param obj The slideshow object
16359 * The sliding animation @p obj is set to use will be the
16360 * transition effect used, after this call is issued.
16362 * @note If the end of the slideshow's internal list of items is
16363 * reached, it'll wrap around to the list's beginning, again.
16365 * @ingroup Slideshow
16367 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16370 * Slide to the @b previous item, in a given slideshow widget
16372 * @param obj The slideshow object
16374 * The sliding animation @p obj is set to use will be the
16375 * transition effect used, after this call is issued.
16377 * @note If the beginning of the slideshow's internal list of items
16378 * is reached, it'll wrap around to the list's end, again.
16380 * @ingroup Slideshow
16382 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16385 * Returns the list of sliding transition/effect names available, for a
16386 * given slideshow widget.
16388 * @param obj The slideshow object
16389 * @return The list of transitions (list of @b stringshared strings
16392 * The transitions, which come from @p obj's theme, must be an EDC
16393 * data item named @c "transitions" on the theme file, with (prefix)
16394 * names of EDC programs actually implementing them.
16396 * The available transitions for slideshows on the default theme are:
16397 * - @c "fade" - the current item fades out, while the new one
16398 * fades in to the slideshow's viewport.
16399 * - @c "black_fade" - the current item fades to black, and just
16400 * then, the new item will fade in.
16401 * - @c "horizontal" - the current item slides horizontally, until
16402 * it gets out of the slideshow's viewport, while the new item
16403 * comes from the left to take its place.
16404 * - @c "vertical" - the current item slides vertically, until it
16405 * gets out of the slideshow's viewport, while the new item comes
16406 * from the bottom to take its place.
16407 * - @c "square" - the new item starts to appear from the middle of
16408 * the current one, but with a tiny size, growing until its
16409 * target (full) size and covering the old one.
16411 * @warning The stringshared strings get no new references
16412 * exclusive to the user grabbing the list, here, so if you'd like
16413 * to use them out of this call's context, you'd better @c
16414 * eina_stringshare_ref() them.
16416 * @see elm_slideshow_transition_set()
16418 * @ingroup Slideshow
16420 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16423 * Set the current slide transition/effect in use for a given
16426 * @param obj The slideshow object
16427 * @param transition The new transition's name string
16429 * If @p transition is implemented in @p obj's theme (i.e., is
16430 * contained in the list returned by
16431 * elm_slideshow_transitions_get()), this new sliding effect will
16432 * be used on the widget.
16434 * @see elm_slideshow_transitions_get() for more details
16436 * @ingroup Slideshow
16438 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16441 * Get the current slide transition/effect in use for a given
16444 * @param obj The slideshow object
16445 * @return The current transition's name
16447 * @see elm_slideshow_transition_set() for more details
16449 * @ingroup Slideshow
16451 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16454 * Set the interval between each image transition on a given
16455 * slideshow widget, <b>and start the slideshow, itself</b>
16457 * @param obj The slideshow object
16458 * @param timeout The new displaying timeout for images
16460 * After this call, the slideshow widget will start cycling its
16461 * view, sequentially and automatically, with the images of the
16462 * items it has. The time between each new image displayed is going
16463 * to be @p timeout, in @b seconds. If a different timeout was set
16464 * previously and an slideshow was in progress, it will continue
16465 * with the new time between transitions, after this call.
16467 * @note A value less than or equal to 0 on @p timeout will disable
16468 * the widget's internal timer, thus halting any slideshow which
16469 * could be happening on @p obj.
16471 * @see elm_slideshow_timeout_get()
16473 * @ingroup Slideshow
16475 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16478 * Get the interval set for image transitions on a given slideshow
16481 * @param obj The slideshow object
16482 * @return Returns the timeout set on it
16484 * @see elm_slideshow_timeout_set() for more details
16486 * @ingroup Slideshow
16488 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16491 * Set if, after a slideshow is started, for a given slideshow
16492 * widget, its items should be displayed cyclically or not.
16494 * @param obj The slideshow object
16495 * @param loop Use @c EINA_TRUE to make it cycle through items or
16496 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16499 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16500 * ignore what is set by this functions, i.e., they'll @b always
16501 * cycle through items. This affects only the "automatic"
16502 * slideshow, as set by elm_slideshow_timeout_set().
16504 * @see elm_slideshow_loop_get()
16506 * @ingroup Slideshow
16508 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16511 * Get if, after a slideshow is started, for a given slideshow
16512 * widget, its items are to be displayed cyclically or not.
16514 * @param obj The slideshow object
16515 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16516 * through or @c EINA_FALSE, otherwise
16518 * @see elm_slideshow_loop_set() for more details
16520 * @ingroup Slideshow
16522 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16525 * Remove all items from a given slideshow widget
16527 * @param obj The slideshow object
16529 * This removes (and deletes) all items in @p obj, leaving it
16532 * @see elm_slideshow_item_del(), to remove just one item.
16534 * @ingroup Slideshow
16536 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16539 * Get the internal list of items in a given slideshow widget.
16541 * @param obj The slideshow object
16542 * @return The list of items (#Elm_Slideshow_Item as data) or
16543 * @c NULL on errors.
16545 * This list is @b not to be modified in any way and must not be
16546 * freed. Use the list members with functions like
16547 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16549 * @warning This list is only valid until @p obj object's internal
16550 * items list is changed. It should be fetched again with another
16551 * call to this function when changes happen.
16553 * @ingroup Slideshow
16555 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16558 * Delete a given item from a slideshow widget.
16560 * @param item The slideshow item
16562 * @ingroup Slideshow
16564 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16567 * Return the data associated with a given slideshow item
16569 * @param item The slideshow item
16570 * @return Returns the data associated to this item
16572 * @ingroup Slideshow
16574 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16577 * Returns the currently displayed item, in a given slideshow widget
16579 * @param obj The slideshow object
16580 * @return A handle to the item being displayed in @p obj or
16581 * @c NULL, if none is (and on errors)
16583 * @ingroup Slideshow
16585 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16588 * Get the real Evas object created to implement the view of a
16589 * given slideshow item
16591 * @param item The slideshow item.
16592 * @return the Evas object implementing this item's view.
16594 * This returns the actual Evas object used to implement the
16595 * specified slideshow item's view. This may be @c NULL, as it may
16596 * not have been created or may have been deleted, at any time, by
16597 * the slideshow. <b>Do not modify this object</b> (move, resize,
16598 * show, hide, etc.), as the slideshow is controlling it. This
16599 * function is for querying, emitting custom signals or hooking
16600 * lower level callbacks for events on that object. Do not delete
16601 * this object under any circumstances.
16603 * @see elm_slideshow_item_data_get()
16605 * @ingroup Slideshow
16607 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16610 * Get the the item, in a given slideshow widget, placed at
16611 * position @p nth, in its internal items list
16613 * @param obj The slideshow object
16614 * @param nth The number of the item to grab a handle to (0 being
16616 * @return The item stored in @p obj at position @p nth or @c NULL,
16617 * if there's no item with that index (and on errors)
16619 * @ingroup Slideshow
16621 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16624 * Set the current slide layout in use for a given slideshow widget
16626 * @param obj The slideshow object
16627 * @param layout The new layout's name string
16629 * If @p layout is implemented in @p obj's theme (i.e., is contained
16630 * in the list returned by elm_slideshow_layouts_get()), this new
16631 * images layout will be used on the widget.
16633 * @see elm_slideshow_layouts_get() for more details
16635 * @ingroup Slideshow
16637 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16640 * Get the current slide layout in use for a given slideshow widget
16642 * @param obj The slideshow object
16643 * @return The current layout's name
16645 * @see elm_slideshow_layout_set() for more details
16647 * @ingroup Slideshow
16649 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16652 * Returns the list of @b layout names available, for a given
16653 * slideshow widget.
16655 * @param obj The slideshow object
16656 * @return The list of layouts (list of @b stringshared strings
16659 * Slideshow layouts will change how the widget is to dispose each
16660 * image item in its viewport, with regard to cropping, scaling,
16663 * The layouts, which come from @p obj's theme, must be an EDC
16664 * data item name @c "layouts" on the theme file, with (prefix)
16665 * names of EDC programs actually implementing them.
16667 * The available layouts for slideshows on the default theme are:
16668 * - @c "fullscreen" - item images with original aspect, scaled to
16669 * touch top and down slideshow borders or, if the image's heigh
16670 * is not enough, left and right slideshow borders.
16671 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16672 * one, but always leaving 10% of the slideshow's dimensions of
16673 * distance between the item image's borders and the slideshow
16674 * borders, for each axis.
16676 * @warning The stringshared strings get no new references
16677 * exclusive to the user grabbing the list, here, so if you'd like
16678 * to use them out of this call's context, you'd better @c
16679 * eina_stringshare_ref() them.
16681 * @see elm_slideshow_layout_set()
16683 * @ingroup Slideshow
16685 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16688 * Set the number of items to cache, on a given slideshow widget,
16689 * <b>before the current item</b>
16691 * @param obj The slideshow object
16692 * @param count Number of items to cache before the current one
16694 * The default value for this property is @c 2. See
16695 * @ref Slideshow_Caching "slideshow caching" for more details.
16697 * @see elm_slideshow_cache_before_get()
16699 * @ingroup Slideshow
16701 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16704 * Retrieve the number of items to cache, on a given slideshow widget,
16705 * <b>before the current item</b>
16707 * @param obj The slideshow object
16708 * @return The number of items set to be cached before the current one
16710 * @see elm_slideshow_cache_before_set() for more details
16712 * @ingroup Slideshow
16714 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16717 * Set the number of items to cache, on a given slideshow widget,
16718 * <b>after the current item</b>
16720 * @param obj The slideshow object
16721 * @param count Number of items to cache after the current one
16723 * The default value for this property is @c 2. See
16724 * @ref Slideshow_Caching "slideshow caching" for more details.
16726 * @see elm_slideshow_cache_after_get()
16728 * @ingroup Slideshow
16730 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16733 * Retrieve the number of items to cache, on a given slideshow widget,
16734 * <b>after the current item</b>
16736 * @param obj The slideshow object
16737 * @return The number of items set to be cached after the current one
16739 * @see elm_slideshow_cache_after_set() for more details
16741 * @ingroup Slideshow
16743 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16746 * Get the number of items stored in a given slideshow widget
16748 * @param obj The slideshow object
16749 * @return The number of items on @p obj, at the moment of this call
16751 * @ingroup Slideshow
16753 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16760 * @defgroup Fileselector File Selector
16762 * @image html img/widget/fileselector/preview-00.png
16763 * @image latex img/widget/fileselector/preview-00.eps
16765 * A file selector is a widget that allows a user to navigate
16766 * through a file system, reporting file selections back via its
16769 * It contains shortcut buttons for home directory (@c ~) and to
16770 * jump one directory upwards (..), as well as cancel/ok buttons to
16771 * confirm/cancel a given selection. After either one of those two
16772 * former actions, the file selector will issue its @c "done" smart
16775 * There's a text entry on it, too, showing the name of the current
16776 * selection. There's the possibility of making it editable, so it
16777 * is useful on file saving dialogs on applications, where one
16778 * gives a file name to save contents to, in a given directory in
16779 * the system. This custom file name will be reported on the @c
16780 * "done" smart callback (explained in sequence).
16782 * Finally, it has a view to display file system items into in two
16787 * If Elementary is built with support of the Ethumb thumbnailing
16788 * library, the second form of view will display preview thumbnails
16789 * of files which it supports.
16791 * Smart callbacks one can register to:
16793 * - @c "selected" - the user has clicked on a file (when not in
16794 * folders-only mode) or directory (when in folders-only mode)
16795 * - @c "directory,open" - the list has been populated with new
16796 * content (@c event_info is a pointer to the directory's
16797 * path, a @b stringshared string)
16798 * - @c "done" - the user has clicked on the "ok" or "cancel"
16799 * buttons (@c event_info is a pointer to the selection's
16800 * path, a @b stringshared string)
16802 * Here is an example on its usage:
16803 * @li @ref fileselector_example
16807 * @addtogroup Fileselector
16812 * Defines how a file selector widget is to layout its contents
16813 * (file system entries).
16815 typedef enum _Elm_Fileselector_Mode
16817 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16818 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16819 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16820 } Elm_Fileselector_Mode;
16823 * Add a new file selector widget to the given parent Elementary
16824 * (container) object
16826 * @param parent The parent object
16827 * @return a new file selector widget handle or @c NULL, on errors
16829 * This function inserts a new file selector widget on the canvas.
16831 * @ingroup Fileselector
16833 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16836 * Enable/disable the file name entry box where the user can type
16837 * in a name for a file, in a given file selector widget
16839 * @param obj The file selector object
16840 * @param is_save @c EINA_TRUE to make the file selector a "saving
16841 * dialog", @c EINA_FALSE otherwise
16843 * Having the entry editable is useful on file saving dialogs on
16844 * applications, where one gives a file name to save contents to,
16845 * in a given directory in the system. This custom file name will
16846 * be reported on the @c "done" smart callback.
16848 * @see elm_fileselector_is_save_get()
16850 * @ingroup Fileselector
16852 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16855 * Get whether the given file selector is in "saving dialog" mode
16857 * @param obj The file selector object
16858 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16859 * mode, @c EINA_FALSE otherwise (and on errors)
16861 * @see elm_fileselector_is_save_set() for more details
16863 * @ingroup Fileselector
16865 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16868 * Enable/disable folder-only view for a given file selector widget
16870 * @param obj The file selector object
16871 * @param only @c EINA_TRUE to make @p obj only display
16872 * directories, @c EINA_FALSE to make files to be displayed in it
16875 * If enabled, the widget's view will only display folder items,
16878 * @see elm_fileselector_folder_only_get()
16880 * @ingroup Fileselector
16882 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16885 * Get whether folder-only view is set for a given file selector
16888 * @param obj The file selector object
16889 * @return only @c EINA_TRUE if @p obj is only displaying
16890 * directories, @c EINA_FALSE if files are being displayed in it
16891 * too (and on errors)
16893 * @see elm_fileselector_folder_only_get()
16895 * @ingroup Fileselector
16897 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16900 * Enable/disable the "ok" and "cancel" buttons on a given file
16903 * @param obj The file selector object
16904 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16906 * @note A file selector without those buttons will never emit the
16907 * @c "done" smart event, and is only usable if one is just hooking
16908 * to the other two events.
16910 * @see elm_fileselector_buttons_ok_cancel_get()
16912 * @ingroup Fileselector
16914 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16917 * Get whether the "ok" and "cancel" buttons on a given file
16918 * selector widget are being shown.
16920 * @param obj The file selector object
16921 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16922 * otherwise (and on errors)
16924 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16926 * @ingroup Fileselector
16928 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16931 * Enable/disable a tree view in the given file selector widget,
16932 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16934 * @param obj The file selector object
16935 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16938 * In a tree view, arrows are created on the sides of directories,
16939 * allowing them to expand in place.
16941 * @note If it's in other mode, the changes made by this function
16942 * will only be visible when one switches back to "list" mode.
16944 * @see elm_fileselector_expandable_get()
16946 * @ingroup Fileselector
16948 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16951 * Get whether tree view is enabled for the given file selector
16954 * @param obj The file selector object
16955 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16956 * otherwise (and or errors)
16958 * @see elm_fileselector_expandable_set() for more details
16960 * @ingroup Fileselector
16962 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16965 * Set, programmatically, the @b directory that a given file
16966 * selector widget will display contents from
16968 * @param obj The file selector object
16969 * @param path The path to display in @p obj
16971 * This will change the @b directory that @p obj is displaying. It
16972 * will also clear the text entry area on the @p obj object, which
16973 * displays select files' names.
16975 * @see elm_fileselector_path_get()
16977 * @ingroup Fileselector
16979 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16982 * Get the parent directory's path that a given file selector
16983 * widget is displaying
16985 * @param obj The file selector object
16986 * @return The (full) path of the directory the file selector is
16987 * displaying, a @b stringshared string
16989 * @see elm_fileselector_path_set()
16991 * @ingroup Fileselector
16993 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16996 * Set, programmatically, the currently selected file/directory in
16997 * the given file selector widget
16999 * @param obj The file selector object
17000 * @param path The (full) path to a file or directory
17001 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17002 * latter case occurs if the directory or file pointed to do not
17005 * @see elm_fileselector_selected_get()
17007 * @ingroup Fileselector
17009 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17012 * Get the currently selected item's (full) path, in the given file
17015 * @param obj The file selector object
17016 * @return The absolute path of the selected item, a @b
17017 * stringshared string
17019 * @note Custom editions on @p obj object's text entry, if made,
17020 * will appear on the return string of this function, naturally.
17022 * @see elm_fileselector_selected_set() for more details
17024 * @ingroup Fileselector
17026 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17029 * Set the mode in which a given file selector widget will display
17030 * (layout) file system entries in its view
17032 * @param obj The file selector object
17033 * @param mode The mode of the fileselector, being it one of
17034 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17035 * first one, naturally, will display the files in a list. The
17036 * latter will make the widget to display its entries in a grid
17039 * @note By using elm_fileselector_expandable_set(), the user may
17040 * trigger a tree view for that list.
17042 * @note If Elementary is built with support of the Ethumb
17043 * thumbnailing library, the second form of view will display
17044 * preview thumbnails of files which it supports. You must have
17045 * elm_need_ethumb() called in your Elementary for thumbnailing to
17048 * @see elm_fileselector_expandable_set().
17049 * @see elm_fileselector_mode_get().
17051 * @ingroup Fileselector
17053 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17056 * Get the mode in which a given file selector widget is displaying
17057 * (layouting) file system entries in its view
17059 * @param obj The fileselector object
17060 * @return The mode in which the fileselector is at
17062 * @see elm_fileselector_mode_set() for more details
17064 * @ingroup Fileselector
17066 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17073 * @defgroup Progressbar Progress bar
17075 * The progress bar is a widget for visually representing the
17076 * progress status of a given job/task.
17078 * A progress bar may be horizontal or vertical. It may display an
17079 * icon besides it, as well as primary and @b units labels. The
17080 * former is meant to label the widget as a whole, while the
17081 * latter, which is formatted with floating point values (and thus
17082 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17083 * units"</c>), is meant to label the widget's <b>progress
17084 * value</b>. Label, icon and unit strings/objects are @b optional
17085 * for progress bars.
17087 * A progress bar may be @b inverted, in which state it gets its
17088 * values inverted, with high values being on the left or top and
17089 * low values on the right or bottom, as opposed to normally have
17090 * the low values on the former and high values on the latter,
17091 * respectively, for horizontal and vertical modes.
17093 * The @b span of the progress, as set by
17094 * elm_progressbar_span_size_set(), is its length (horizontally or
17095 * vertically), unless one puts size hints on the widget to expand
17096 * on desired directions, by any container. That length will be
17097 * scaled by the object or applications scaling factor. At any
17098 * point code can query the progress bar for its value with
17099 * elm_progressbar_value_get().
17101 * Available widget styles for progress bars:
17103 * - @c "wheel" (simple style, no text, no progression, only
17104 * "pulse" effect is available)
17106 * Here is an example on its usage:
17107 * @li @ref progressbar_example
17111 * Add a new progress bar widget to the given parent Elementary
17112 * (container) object
17114 * @param parent The parent object
17115 * @return a new progress bar widget handle or @c NULL, on errors
17117 * This function inserts a new progress bar widget on the canvas.
17119 * @ingroup Progressbar
17121 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17124 * Set whether a given progress bar widget is at "pulsing mode" or
17127 * @param obj The progress bar object
17128 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17129 * @c EINA_FALSE to put it back to its default one
17131 * By default, progress bars will display values from the low to
17132 * high value boundaries. There are, though, contexts in which the
17133 * state of progression of a given task is @b unknown. For those,
17134 * one can set a progress bar widget to a "pulsing state", to give
17135 * the user an idea that some computation is being held, but
17136 * without exact progress values. In the default theme it will
17137 * animate its bar with the contents filling in constantly and back
17138 * to non-filled, in a loop. To start and stop this pulsing
17139 * animation, one has to explicitly call elm_progressbar_pulse().
17141 * @see elm_progressbar_pulse_get()
17142 * @see elm_progressbar_pulse()
17144 * @ingroup Progressbar
17146 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17149 * Get whether a given progress bar widget is at "pulsing mode" or
17152 * @param obj The progress bar object
17153 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17154 * if it's in the default one (and on errors)
17156 * @ingroup Progressbar
17158 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17161 * Start/stop a given progress bar "pulsing" animation, if its
17164 * @param obj The progress bar object
17165 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17166 * @c EINA_FALSE to @b stop it
17168 * @note This call won't do anything if @p obj is not under "pulsing mode".
17170 * @see elm_progressbar_pulse_set() for more details.
17172 * @ingroup Progressbar
17174 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17177 * Set the progress value (in percentage) on a given progress bar
17180 * @param obj The progress bar object
17181 * @param val The progress value (@b must be between @c 0.0 and @c
17184 * Use this call to set progress bar levels.
17186 * @note If you passes a value out of the specified range for @p
17187 * val, it will be interpreted as the @b closest of the @b boundary
17188 * values in the range.
17190 * @ingroup Progressbar
17192 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17195 * Get the progress value (in percentage) on a given progress bar
17198 * @param obj The progress bar object
17199 * @return The value of the progressbar
17201 * @see elm_progressbar_value_set() for more details
17203 * @ingroup Progressbar
17205 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17208 * Set the label of a given progress bar widget
17210 * @param obj The progress bar object
17211 * @param label The text label string, in UTF-8
17213 * @ingroup Progressbar
17214 * @deprecated use elm_object_text_set() instead.
17216 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17219 * Get the label of a given progress bar widget
17221 * @param obj The progressbar object
17222 * @return The text label string, in UTF-8
17224 * @ingroup Progressbar
17225 * @deprecated use elm_object_text_set() instead.
17227 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17230 * Set the icon object of a given progress bar widget
17232 * @param obj The progress bar object
17233 * @param icon The icon object
17235 * Use this call to decorate @p obj with an icon next to it.
17237 * @note Once the icon object is set, a previously set one will be
17238 * deleted. If you want to keep that old content object, use the
17239 * elm_progressbar_icon_unset() function.
17241 * @see elm_progressbar_icon_get()
17243 * @ingroup Progressbar
17245 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17248 * Retrieve the icon object set for a given progress bar widget
17250 * @param obj The progress bar object
17251 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17252 * otherwise (and on errors)
17254 * @see elm_progressbar_icon_set() for more details
17256 * @ingroup Progressbar
17258 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17261 * Unset an icon set on a given progress bar widget
17263 * @param obj The progress bar object
17264 * @return The icon object that was being used, if any was set, or
17265 * @c NULL, otherwise (and on errors)
17267 * This call will unparent and return the icon object which was set
17268 * for this widget, previously, on success.
17270 * @see elm_progressbar_icon_set() for more details
17272 * @ingroup Progressbar
17274 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17277 * Set the (exact) length of the bar region of a given progress bar
17280 * @param obj The progress bar object
17281 * @param size The length of the progress bar's bar region
17283 * This sets the minimum width (when in horizontal mode) or height
17284 * (when in vertical mode) of the actual bar area of the progress
17285 * bar @p obj. This in turn affects the object's minimum size. Use
17286 * this when you're not setting other size hints expanding on the
17287 * given direction (like weight and alignment hints) and you would
17288 * like it to have a specific size.
17290 * @note Icon, label and unit text around @p obj will require their
17291 * own space, which will make @p obj to require more the @p size,
17294 * @see elm_progressbar_span_size_get()
17296 * @ingroup Progressbar
17298 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17301 * Get the length set for the bar region of a given progress bar
17304 * @param obj The progress bar object
17305 * @return The length of the progress bar's bar region
17307 * If that size was not set previously, with
17308 * elm_progressbar_span_size_set(), this call will return @c 0.
17310 * @ingroup Progressbar
17312 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17315 * Set the format string for a given progress bar widget's units
17318 * @param obj The progress bar object
17319 * @param format The format string for @p obj's units label
17321 * If @c NULL is passed on @p format, it will make @p obj's units
17322 * area to be hidden completely. If not, it'll set the <b>format
17323 * string</b> for the units label's @b text. The units label is
17324 * provided a floating point value, so the units text is up display
17325 * at most one floating point falue. Note that the units label is
17326 * optional. Use a format string such as "%1.2f meters" for
17329 * @note The default format string for a progress bar is an integer
17330 * percentage, as in @c "%.0f %%".
17332 * @see elm_progressbar_unit_format_get()
17334 * @ingroup Progressbar
17336 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17339 * Retrieve the format string set for a given progress bar widget's
17342 * @param obj The progress bar object
17343 * @return The format set string for @p obj's units label or
17344 * @c NULL, if none was set (and on errors)
17346 * @see elm_progressbar_unit_format_set() for more details
17348 * @ingroup Progressbar
17350 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17353 * Set the orientation of a given progress bar widget
17355 * @param obj The progress bar object
17356 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17357 * @b horizontal, @c EINA_FALSE to make it @b vertical
17359 * Use this function to change how your progress bar is to be
17360 * disposed: vertically or horizontally.
17362 * @see elm_progressbar_horizontal_get()
17364 * @ingroup Progressbar
17366 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17369 * Retrieve the orientation of a given progress bar widget
17371 * @param obj The progress bar object
17372 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17373 * @c EINA_FALSE if it's @b vertical (and on errors)
17375 * @see elm_progressbar_horizontal_set() for more details
17377 * @ingroup Progressbar
17379 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17382 * Invert a given progress bar widget's displaying values order
17384 * @param obj The progress bar object
17385 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17386 * @c EINA_FALSE to bring it back to default, non-inverted values.
17388 * A progress bar may be @b inverted, in which state it gets its
17389 * values inverted, with high values being on the left or top and
17390 * low values on the right or bottom, as opposed to normally have
17391 * the low values on the former and high values on the latter,
17392 * respectively, for horizontal and vertical modes.
17394 * @see elm_progressbar_inverted_get()
17396 * @ingroup Progressbar
17398 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17401 * Get whether a given progress bar widget's displaying values are
17404 * @param obj The progress bar object
17405 * @return @c EINA_TRUE, if @p obj has inverted values,
17406 * @c EINA_FALSE otherwise (and on errors)
17408 * @see elm_progressbar_inverted_set() for more details
17410 * @ingroup Progressbar
17412 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17415 * @defgroup Separator Separator
17417 * @brief Separator is a very thin object used to separate other objects.
17419 * A separator can be vertical or horizontal.
17421 * @ref tutorial_separator is a good example of how to use a separator.
17425 * @brief Add a separator object to @p parent
17427 * @param parent The parent object
17429 * @return The separator object, or NULL upon failure
17431 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17433 * @brief Set the horizontal mode of a separator object
17435 * @param obj The separator object
17436 * @param horizontal If true, the separator is horizontal
17438 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17440 * @brief Get the horizontal mode of a separator object
17442 * @param obj The separator object
17443 * @return If true, the separator is horizontal
17445 * @see elm_separator_horizontal_set()
17447 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17453 * @defgroup Spinner Spinner
17454 * @ingroup Elementary
17456 * @image html img/widget/spinner/preview-00.png
17457 * @image latex img/widget/spinner/preview-00.eps
17459 * A spinner is a widget which allows the user to increase or decrease
17460 * numeric values using arrow buttons, or edit values directly, clicking
17461 * over it and typing the new value.
17463 * By default the spinner will not wrap and has a label
17464 * of "%.0f" (just showing the integer value of the double).
17466 * A spinner has a label that is formatted with floating
17467 * point values and thus accepts a printf-style format string, like
17470 * It also allows specific values to be replaced by pre-defined labels.
17472 * Smart callbacks one can register to:
17474 * - "changed" - Whenever the spinner value is changed.
17475 * - "delay,changed" - A short time after the value is changed by the user.
17476 * This will be called only when the user stops dragging for a very short
17477 * period or when they release their finger/mouse, so it avoids possibly
17478 * expensive reactions to the value change.
17480 * Available styles for it:
17482 * - @c "vertical": up/down buttons at the right side and text left aligned.
17484 * Here is an example on its usage:
17485 * @ref spinner_example
17489 * @addtogroup Spinner
17494 * Add a new spinner widget to the given parent Elementary
17495 * (container) object.
17497 * @param parent The parent object.
17498 * @return a new spinner widget handle or @c NULL, on errors.
17500 * This function inserts a new spinner widget on the canvas.
17505 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17508 * Set the format string of the displayed label.
17510 * @param obj The spinner object.
17511 * @param fmt The format string for the label display.
17513 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17514 * string for the label text. The label text is provided a floating point
17515 * value, so the label text can display up to 1 floating point value.
17516 * Note that this is optional.
17518 * Use a format string such as "%1.2f meters" for example, and it will
17519 * display values like: "3.14 meters" for a value equal to 3.14159.
17521 * Default is "%0.f".
17523 * @see elm_spinner_label_format_get()
17527 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17530 * Get the label format of the spinner.
17532 * @param obj The spinner object.
17533 * @return The text label format string in UTF-8.
17535 * @see elm_spinner_label_format_set() for details.
17539 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17542 * Set the minimum and maximum values for the spinner.
17544 * @param obj The spinner object.
17545 * @param min The minimum value.
17546 * @param max The maximum value.
17548 * Define the allowed range of values to be selected by the user.
17550 * If actual value is less than @p min, it will be updated to @p min. If it
17551 * is bigger then @p max, will be updated to @p max. Actual value can be
17552 * get with elm_spinner_value_get().
17554 * By default, min is equal to 0, and max is equal to 100.
17556 * @warning Maximum must be greater than minimum.
17558 * @see elm_spinner_min_max_get()
17562 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17565 * Get the minimum and maximum values of the spinner.
17567 * @param obj The spinner object.
17568 * @param min Pointer where to store the minimum value.
17569 * @param max Pointer where to store the maximum value.
17571 * @note If only one value is needed, the other pointer can be passed
17574 * @see elm_spinner_min_max_set() for details.
17578 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17581 * Set the step used to increment or decrement the spinner value.
17583 * @param obj The spinner object.
17584 * @param step The step value.
17586 * This value will be incremented or decremented to the displayed value.
17587 * It will be incremented while the user keep right or top arrow pressed,
17588 * and will be decremented while the user keep left or bottom arrow pressed.
17590 * The interval to increment / decrement can be set with
17591 * elm_spinner_interval_set().
17593 * By default step value is equal to 1.
17595 * @see elm_spinner_step_get()
17599 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17602 * Get the step used to increment or decrement the spinner value.
17604 * @param obj The spinner object.
17605 * @return The step value.
17607 * @see elm_spinner_step_get() for more details.
17611 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17614 * Set the value the spinner displays.
17616 * @param obj The spinner object.
17617 * @param val The value to be displayed.
17619 * Value will be presented on the label following format specified with
17620 * elm_spinner_format_set().
17622 * @warning The value must to be between min and max values. This values
17623 * are set by elm_spinner_min_max_set().
17625 * @see elm_spinner_value_get().
17626 * @see elm_spinner_format_set().
17627 * @see elm_spinner_min_max_set().
17631 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17634 * Get the value displayed by the spinner.
17636 * @param obj The spinner object.
17637 * @return The value displayed.
17639 * @see elm_spinner_value_set() for details.
17643 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17646 * Set whether the spinner should wrap when it reaches its
17647 * minimum or maximum value.
17649 * @param obj The spinner object.
17650 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17653 * Disabled by default. If disabled, when the user tries to increment the
17655 * but displayed value plus step value is bigger than maximum value,
17657 * won't allow it. The same happens when the user tries to decrement it,
17658 * but the value less step is less than minimum value.
17660 * When wrap is enabled, in such situations it will allow these changes,
17661 * but will get the value that would be less than minimum and subtracts
17662 * from maximum. Or add the value that would be more than maximum to
17666 * @li min value = 10
17667 * @li max value = 50
17668 * @li step value = 20
17669 * @li displayed value = 20
17671 * When the user decrement value (using left or bottom arrow), it will
17672 * displays @c 40, because max - (min - (displayed - step)) is
17673 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17675 * @see elm_spinner_wrap_get().
17679 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17682 * Get whether the spinner should wrap when it reaches its
17683 * minimum or maximum value.
17685 * @param obj The spinner object
17686 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17687 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17689 * @see elm_spinner_wrap_set() for details.
17693 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17696 * Set whether the spinner can be directly edited by the user or not.
17698 * @param obj The spinner object.
17699 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17700 * don't allow users to edit it directly.
17702 * Spinner objects can have edition @b disabled, in which state they will
17703 * be changed only by arrows.
17704 * Useful for contexts
17705 * where you don't want your users to interact with it writting the value.
17707 * when using special values, the user can see real value instead
17708 * of special label on edition.
17710 * It's enabled by default.
17712 * @see elm_spinner_editable_get()
17716 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17719 * Get whether the spinner can be directly edited by the user or not.
17721 * @param obj The spinner object.
17722 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17723 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17725 * @see elm_spinner_editable_set() for details.
17729 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17732 * Set a special string to display in the place of the numerical value.
17734 * @param obj The spinner object.
17735 * @param value The value to be replaced.
17736 * @param label The label to be used.
17738 * It's useful for cases when a user should select an item that is
17739 * better indicated by a label than a value. For example, weekdays or months.
17743 * sp = elm_spinner_add(win);
17744 * elm_spinner_min_max_set(sp, 1, 3);
17745 * elm_spinner_special_value_add(sp, 1, "January");
17746 * elm_spinner_special_value_add(sp, 2, "February");
17747 * elm_spinner_special_value_add(sp, 3, "March");
17748 * evas_object_show(sp);
17753 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17756 * Set the interval on time updates for an user mouse button hold
17757 * on spinner widgets' arrows.
17759 * @param obj The spinner object.
17760 * @param interval The (first) interval value in seconds.
17762 * This interval value is @b decreased while the user holds the
17763 * mouse pointer either incrementing or decrementing spinner's value.
17765 * This helps the user to get to a given value distant from the
17766 * current one easier/faster, as it will start to change quicker and
17767 * quicker on mouse button holds.
17769 * The calculation for the next change interval value, starting from
17770 * the one set with this call, is the previous interval divided by
17771 * @c 1.05, so it decreases a little bit.
17773 * The default starting interval value for automatic changes is
17776 * @see elm_spinner_interval_get()
17780 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17783 * Get the interval on time updates for an user mouse button hold
17784 * on spinner widgets' arrows.
17786 * @param obj The spinner object.
17787 * @return The (first) interval value, in seconds, set on it.
17789 * @see elm_spinner_interval_set() for more details.
17793 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17800 * @defgroup Index Index
17802 * @image html img/widget/index/preview-00.png
17803 * @image latex img/widget/index/preview-00.eps
17805 * An index widget gives you an index for fast access to whichever
17806 * group of other UI items one might have. It's a list of text
17807 * items (usually letters, for alphabetically ordered access).
17809 * Index widgets are by default hidden and just appear when the
17810 * user clicks over it's reserved area in the canvas. In its
17811 * default theme, it's an area one @ref Fingers "finger" wide on
17812 * the right side of the index widget's container.
17814 * When items on the index are selected, smart callbacks get
17815 * called, so that its user can make other container objects to
17816 * show a given area or child object depending on the index item
17817 * selected. You'd probably be using an index together with @ref
17818 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17821 * Smart events one can add callbacks for are:
17822 * - @c "changed" - When the selected index item changes. @c
17823 * event_info is the selected item's data pointer.
17824 * - @c "delay,changed" - When the selected index item changes, but
17825 * after a small idling period. @c event_info is the selected
17826 * item's data pointer.
17827 * - @c "selected" - When the user releases a mouse button and
17828 * selects an item. @c event_info is the selected item's data
17830 * - @c "level,up" - when the user moves a finger from the first
17831 * level to the second level
17832 * - @c "level,down" - when the user moves a finger from the second
17833 * level to the first level
17835 * The @c "delay,changed" event is so that it'll wait a small time
17836 * before actually reporting those events and, moreover, just the
17837 * last event happening on those time frames will actually be
17840 * Here are some examples on its usage:
17841 * @li @ref index_example_01
17842 * @li @ref index_example_02
17846 * @addtogroup Index
17850 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17853 * Add a new index widget to the given parent Elementary
17854 * (container) object
17856 * @param parent The parent object
17857 * @return a new index widget handle or @c NULL, on errors
17859 * This function inserts a new index widget on the canvas.
17863 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17866 * Set whether a given index widget is or not visible,
17869 * @param obj The index object
17870 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17872 * Not to be confused with visible as in @c evas_object_show() --
17873 * visible with regard to the widget's auto hiding feature.
17875 * @see elm_index_active_get()
17879 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17882 * Get whether a given index widget is currently visible or not.
17884 * @param obj The index object
17885 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17887 * @see elm_index_active_set() for more details
17891 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17894 * Set the items level for a given index widget.
17896 * @param obj The index object.
17897 * @param level @c 0 or @c 1, the currently implemented levels.
17899 * @see elm_index_item_level_get()
17903 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17906 * Get the items level set for a given index widget.
17908 * @param obj The index object.
17909 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17911 * @see elm_index_item_level_set() for more information
17915 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17918 * Returns the last selected item's data, for a given index widget.
17920 * @param obj The index object.
17921 * @return The item @b data associated to the last selected item on
17922 * @p obj (or @c NULL, on errors).
17924 * @warning The returned value is @b not an #Elm_Index_Item item
17925 * handle, but the data associated to it (see the @c item parameter
17926 * in elm_index_item_append(), as an example).
17930 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17933 * Append a new item on a given index widget.
17935 * @param obj The index object.
17936 * @param letter Letter under which the item should be indexed
17937 * @param item The item data to set for the index's item
17939 * Despite the most common usage of the @p letter argument is for
17940 * single char strings, one could use arbitrary strings as index
17943 * @c item will be the pointer returned back on @c "changed", @c
17944 * "delay,changed" and @c "selected" smart events.
17948 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17951 * Prepend a new item on a given index widget.
17953 * @param obj The index object.
17954 * @param letter Letter under which the item should be indexed
17955 * @param item The item data to set for the index's item
17957 * Despite the most common usage of the @p letter argument is for
17958 * single char strings, one could use arbitrary strings as index
17961 * @c item will be the pointer returned back on @c "changed", @c
17962 * "delay,changed" and @c "selected" smart events.
17966 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17969 * Append a new item, on a given index widget, <b>after the item
17970 * having @p relative as data</b>.
17972 * @param obj The index object.
17973 * @param letter Letter under which the item should be indexed
17974 * @param item The item data to set for the index's item
17975 * @param relative The item data of the index item to be the
17976 * predecessor of this new one
17978 * Despite the most common usage of the @p letter argument is for
17979 * single char strings, one could use arbitrary strings as index
17982 * @c item will be the pointer returned back on @c "changed", @c
17983 * "delay,changed" and @c "selected" smart events.
17985 * @note If @p relative is @c NULL or if it's not found to be data
17986 * set on any previous item on @p obj, this function will behave as
17987 * elm_index_item_append().
17991 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17994 * Prepend a new item, on a given index widget, <b>after the item
17995 * having @p relative as data</b>.
17997 * @param obj The index object.
17998 * @param letter Letter under which the item should be indexed
17999 * @param item The item data to set for the index's item
18000 * @param relative The item data of the index item to be the
18001 * successor of this new one
18003 * Despite the most common usage of the @p letter argument is for
18004 * single char strings, one could use arbitrary strings as index
18007 * @c item will be the pointer returned back on @c "changed", @c
18008 * "delay,changed" and @c "selected" smart events.
18010 * @note If @p relative is @c NULL or if it's not found to be data
18011 * set on any previous item on @p obj, this function will behave as
18012 * elm_index_item_prepend().
18016 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18019 * Insert a new item into the given index widget, using @p cmp_func
18020 * function to sort items (by item handles).
18022 * @param obj The index object.
18023 * @param letter Letter under which the item should be indexed
18024 * @param item The item data to set for the index's item
18025 * @param cmp_func The comparing function to be used to sort index
18026 * items <b>by #Elm_Index_Item item handles</b>
18027 * @param cmp_data_func A @b fallback function to be called for the
18028 * sorting of index items <b>by item data</b>). It will be used
18029 * when @p cmp_func returns @c 0 (equality), which means an index
18030 * item with provided item data already exists. To decide which
18031 * data item should be pointed to by the index item in question, @p
18032 * cmp_data_func will be used. If @p cmp_data_func returns a
18033 * non-negative value, the previous index item data will be
18034 * replaced by the given @p item pointer. If the previous data need
18035 * to be freed, it should be done by the @p cmp_data_func function,
18036 * because all references to it will be lost. If this function is
18037 * not provided (@c NULL is given), index items will be @b
18038 * duplicated, if @p cmp_func returns @c 0.
18040 * Despite the most common usage of the @p letter argument is for
18041 * single char strings, one could use arbitrary strings as index
18044 * @c item will be the pointer returned back on @c "changed", @c
18045 * "delay,changed" and @c "selected" smart events.
18049 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);
18052 * Remove an item from a given index widget, <b>to be referenced by
18053 * it's data value</b>.
18055 * @param obj The index object
18056 * @param item The item's data pointer for the item to be removed
18059 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18060 * that callback function will be called by this one.
18062 * @warning The item to be removed from @p obj will be found via
18063 * its item data pointer, and not by an #Elm_Index_Item handle.
18067 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18070 * Find a given index widget's item, <b>using item data</b>.
18072 * @param obj The index object
18073 * @param item The item data pointed to by the desired index item
18074 * @return The index item handle, if found, or @c NULL otherwise
18078 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18081 * Removes @b all items from a given index widget.
18083 * @param obj The index object.
18085 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18086 * that callback function will be called for each item in @p obj.
18090 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18093 * Go to a given items level on a index widget
18095 * @param obj The index object
18096 * @param level The index level (one of @c 0 or @c 1)
18100 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18103 * Return the data associated with a given index widget item
18105 * @param it The index widget item handle
18106 * @return The data associated with @p it
18108 * @see elm_index_item_data_set()
18112 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18115 * Set the data associated with a given index widget item
18117 * @param it The index widget item handle
18118 * @param data The new data pointer to set to @p it
18120 * This sets new item data on @p it.
18122 * @warning The old data pointer won't be touched by this function, so
18123 * the user had better to free that old data himself/herself.
18127 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18130 * Set the function to be called when a given index widget item is freed.
18132 * @param it The item to set the callback on
18133 * @param func The function to call on the item's deletion
18135 * When called, @p func will have both @c data and @c event_info
18136 * arguments with the @p it item's data value and, naturally, the
18137 * @c obj argument with a handle to the parent index widget.
18141 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18144 * Get the letter (string) set on a given index widget item.
18146 * @param it The index item handle
18147 * @return The letter string set on @p it
18151 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18158 * @defgroup Photocam Photocam
18160 * @image html img/widget/photocam/preview-00.png
18161 * @image latex img/widget/photocam/preview-00.eps
18163 * This is a widget specifically for displaying high-resolution digital
18164 * camera photos giving speedy feedback (fast load), low memory footprint
18165 * and zooming and panning as well as fitting logic. It is entirely focused
18166 * on jpeg images, and takes advantage of properties of the jpeg format (via
18167 * evas loader features in the jpeg loader).
18169 * Signals that you can add callbacks for are:
18170 * @li "clicked" - This is called when a user has clicked the photo without
18172 * @li "press" - This is called when a user has pressed down on the photo.
18173 * @li "longpressed" - This is called when a user has pressed down on the
18174 * photo for a long time without dragging around.
18175 * @li "clicked,double" - This is called when a user has double-clicked the
18177 * @li "load" - Photo load begins.
18178 * @li "loaded" - This is called when the image file load is complete for the
18179 * first view (low resolution blurry version).
18180 * @li "load,detail" - Photo detailed data load begins.
18181 * @li "loaded,detail" - This is called when the image file load is complete
18182 * for the detailed image data (full resolution needed).
18183 * @li "zoom,start" - Zoom animation started.
18184 * @li "zoom,stop" - Zoom animation stopped.
18185 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18186 * @li "scroll" - the content has been scrolled (moved)
18187 * @li "scroll,anim,start" - scrolling animation has started
18188 * @li "scroll,anim,stop" - scrolling animation has stopped
18189 * @li "scroll,drag,start" - dragging the contents around has started
18190 * @li "scroll,drag,stop" - dragging the contents around has stopped
18192 * @ref tutorial_photocam shows the API in action.
18196 * @brief Types of zoom available.
18198 typedef enum _Elm_Photocam_Zoom_Mode
18200 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18201 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18202 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18203 ELM_PHOTOCAM_ZOOM_MODE_LAST
18204 } Elm_Photocam_Zoom_Mode;
18206 * @brief Add a new Photocam object
18208 * @param parent The parent object
18209 * @return The new object or NULL if it cannot be created
18211 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18213 * @brief Set the photo file to be shown
18215 * @param obj The photocam object
18216 * @param file The photo file
18217 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18219 * This sets (and shows) the specified file (with a relative or absolute
18220 * path) and will return a load error (same error that
18221 * evas_object_image_load_error_get() will return). The image will change and
18222 * adjust its size at this point and begin a background load process for this
18223 * photo that at some time in the future will be displayed at the full
18226 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18228 * @brief Returns the path of the current image file
18230 * @param obj The photocam object
18231 * @return Returns the path
18233 * @see elm_photocam_file_set()
18235 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18237 * @brief Set the zoom level of the photo
18239 * @param obj The photocam object
18240 * @param zoom The zoom level to set
18242 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18243 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18244 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18245 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18248 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18250 * @brief Get the zoom level of the photo
18252 * @param obj The photocam object
18253 * @return The current zoom level
18255 * This returns the current zoom level of the photocam object. Note that if
18256 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18257 * (which is the default), the zoom level may be changed at any time by the
18258 * photocam object itself to account for photo size and photocam viewpoer
18261 * @see elm_photocam_zoom_set()
18262 * @see elm_photocam_zoom_mode_set()
18264 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18266 * @brief Set the zoom mode
18268 * @param obj The photocam object
18269 * @param mode The desired mode
18271 * This sets the zoom mode to manual or one of several automatic levels.
18272 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18273 * elm_photocam_zoom_set() and will stay at that level until changed by code
18274 * or until zoom mode is changed. This is the default mode. The Automatic
18275 * modes will allow the photocam object to automatically adjust zoom mode
18276 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18277 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18278 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18279 * pixels within the frame are left unfilled.
18281 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18283 * @brief Get the zoom mode
18285 * @param obj The photocam object
18286 * @return The current zoom mode
18288 * This gets the current zoom mode of the photocam object.
18290 * @see elm_photocam_zoom_mode_set()
18292 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18294 * @brief Get the current image pixel width and height
18296 * @param obj The photocam object
18297 * @param w A pointer to the width return
18298 * @param h A pointer to the height return
18300 * This gets the current photo pixel width and height (for the original).
18301 * The size will be returned in the integers @p w and @p h that are pointed
18304 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18306 * @brief Get the area of the image that is currently shown
18309 * @param x A pointer to the X-coordinate of region
18310 * @param y A pointer to the Y-coordinate of region
18311 * @param w A pointer to the width
18312 * @param h A pointer to the height
18314 * @see elm_photocam_image_region_show()
18315 * @see elm_photocam_image_region_bring_in()
18317 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18319 * @brief Set the viewed portion of the image
18321 * @param obj The photocam object
18322 * @param x X-coordinate of region in image original pixels
18323 * @param y Y-coordinate of region in image original pixels
18324 * @param w Width of region in image original pixels
18325 * @param h Height of region in image original pixels
18327 * This shows the region of the image without using animation.
18329 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18331 * @brief Bring in the viewed portion of the image
18333 * @param obj The photocam object
18334 * @param x X-coordinate of region in image original pixels
18335 * @param y Y-coordinate of region in image original pixels
18336 * @param w Width of region in image original pixels
18337 * @param h Height of region in image original pixels
18339 * This shows the region of the image using animation.
18341 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18343 * @brief Set the paused state for photocam
18345 * @param obj The photocam object
18346 * @param paused The pause state to set
18348 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18349 * photocam. The default is off. This will stop zooming using animation on
18350 * zoom levels changes and change instantly. This will stop any existing
18351 * animations that are running.
18353 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18355 * @brief Get the paused state for photocam
18357 * @param obj The photocam object
18358 * @return The current paused state
18360 * This gets the current paused state for the photocam object.
18362 * @see elm_photocam_paused_set()
18364 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18366 * @brief Get the internal low-res image used for photocam
18368 * @param obj The photocam object
18369 * @return The internal image object handle, or NULL if none exists
18371 * This gets the internal image object inside photocam. Do not modify it. It
18372 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18373 * deleted at any time as well.
18375 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18377 * @brief Set the photocam scrolling bouncing.
18379 * @param obj The photocam object
18380 * @param h_bounce bouncing for horizontal
18381 * @param v_bounce bouncing for vertical
18383 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18385 * @brief Get the photocam scrolling bouncing.
18387 * @param obj The photocam object
18388 * @param h_bounce bouncing for horizontal
18389 * @param v_bounce bouncing for vertical
18391 * @see elm_photocam_bounce_set()
18393 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18399 * @defgroup Map Map
18400 * @ingroup Elementary
18402 * @image html img/widget/map/preview-00.png
18403 * @image latex img/widget/map/preview-00.eps
18405 * This is a widget specifically for displaying a map. It uses basically
18406 * OpenStreetMap provider http://www.openstreetmap.org/,
18407 * but custom providers can be added.
18409 * It supports some basic but yet nice features:
18410 * @li zoom and scroll
18411 * @li markers with content to be displayed when user clicks over it
18412 * @li group of markers
18415 * Smart callbacks one can listen to:
18417 * - "clicked" - This is called when a user has clicked the map without
18419 * - "press" - This is called when a user has pressed down on the map.
18420 * - "longpressed" - This is called when a user has pressed down on the map
18421 * for a long time without dragging around.
18422 * - "clicked,double" - This is called when a user has double-clicked
18424 * - "load,detail" - Map detailed data load begins.
18425 * - "loaded,detail" - This is called when all currently visible parts of
18426 * the map are loaded.
18427 * - "zoom,start" - Zoom animation started.
18428 * - "zoom,stop" - Zoom animation stopped.
18429 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18430 * - "scroll" - the content has been scrolled (moved).
18431 * - "scroll,anim,start" - scrolling animation has started.
18432 * - "scroll,anim,stop" - scrolling animation has stopped.
18433 * - "scroll,drag,start" - dragging the contents around has started.
18434 * - "scroll,drag,stop" - dragging the contents around has stopped.
18435 * - "downloaded" - This is called when all currently required map images
18437 * - "route,load" - This is called when route request begins.
18438 * - "route,loaded" - This is called when route request ends.
18439 * - "name,load" - This is called when name request begins.
18440 * - "name,loaded- This is called when name request ends.
18442 * Available style for map widget:
18445 * Available style for markers:
18450 * Available style for marker bubble:
18453 * List of examples:
18454 * @li @ref map_example_01
18455 * @li @ref map_example_02
18456 * @li @ref map_example_03
18465 * @enum _Elm_Map_Zoom_Mode
18466 * @typedef Elm_Map_Zoom_Mode
18468 * Set map's zoom behavior. It can be set to manual or automatic.
18470 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18472 * Values <b> don't </b> work as bitmask, only one can be choosen.
18474 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18475 * than the scroller view.
18477 * @see elm_map_zoom_mode_set()
18478 * @see elm_map_zoom_mode_get()
18482 typedef enum _Elm_Map_Zoom_Mode
18484 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18485 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18486 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18487 ELM_MAP_ZOOM_MODE_LAST
18488 } Elm_Map_Zoom_Mode;
18491 * @enum _Elm_Map_Route_Sources
18492 * @typedef Elm_Map_Route_Sources
18494 * Set route service to be used. By default used source is
18495 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18497 * @see elm_map_route_source_set()
18498 * @see elm_map_route_source_get()
18502 typedef enum _Elm_Map_Route_Sources
18504 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18505 ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
18506 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18507 ELM_MAP_ROUTE_SOURCE_LAST
18508 } Elm_Map_Route_Sources;
18510 typedef enum _Elm_Map_Name_Sources
18512 ELM_MAP_NAME_SOURCE_NOMINATIM,
18513 ELM_MAP_NAME_SOURCE_LAST
18514 } Elm_Map_Name_Sources;
18517 * @enum _Elm_Map_Route_Type
18518 * @typedef Elm_Map_Route_Type
18520 * Set type of transport used on route.
18522 * @see elm_map_route_add()
18526 typedef enum _Elm_Map_Route_Type
18528 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18529 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18530 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18531 ELM_MAP_ROUTE_TYPE_LAST
18532 } Elm_Map_Route_Type;
18535 * @enum _Elm_Map_Route_Method
18536 * @typedef Elm_Map_Route_Method
18538 * Set the routing method, what should be priorized, time or distance.
18540 * @see elm_map_route_add()
18544 typedef enum _Elm_Map_Route_Method
18546 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18547 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18548 ELM_MAP_ROUTE_METHOD_LAST
18549 } Elm_Map_Route_Method;
18551 typedef enum _Elm_Map_Name_Method
18553 ELM_MAP_NAME_METHOD_SEARCH,
18554 ELM_MAP_NAME_METHOD_REVERSE,
18555 ELM_MAP_NAME_METHOD_LAST
18556 } Elm_Map_Name_Method;
18558 typedef struct _Elm_Map_Marker Elm_Map_Marker; /**< A marker to be shown in a specific point of the map. Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove(). */
18559 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class; /**< Each marker must be associated to a class. It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new(). */
18560 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class; /**< Each marker must be associated to a group class. It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new(). */
18561 typedef struct _Elm_Map_Route Elm_Map_Route; /**< A route to be shown in the map. Can be created with elm_map_route_add() and deleted with elm_map_route_remove(). */
18562 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18563 typedef struct _Elm_Map_Track Elm_Map_Track;
18565 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Bubble content fetching class function for marker classes. When the user click on a marker, a bubble is displayed with a content. */
18566 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18567 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18568 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18570 typedef char *(*ElmMapModuleSourceFunc) (void);
18571 typedef int (*ElmMapModuleZoomMinFunc) (void);
18572 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18573 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18574 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18575 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18576 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18577 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18578 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18581 * Add a new map widget to the given parent Elementary (container) object.
18583 * @param parent The parent object.
18584 * @return a new map widget handle or @c NULL, on errors.
18586 * This function inserts a new map widget on the canvas.
18590 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18593 * Set the zoom level of the map.
18595 * @param obj The map object.
18596 * @param zoom The zoom level to set.
18598 * This sets the zoom level.
18600 * It will respect limits defined by elm_map_source_zoom_min_set() and
18601 * elm_map_source_zoom_max_set().
18603 * By default these values are 0 (world map) and 18 (maximum zoom).
18605 * This function should be used when zoom mode is set to
18606 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18607 * with elm_map_zoom_mode_set().
18609 * @see elm_map_zoom_mode_set().
18610 * @see elm_map_zoom_get().
18614 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18617 * Get the zoom level of the map.
18619 * @param obj The map object.
18620 * @return The current zoom level.
18622 * This returns the current zoom level of the map object.
18624 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18625 * (which is the default), the zoom level may be changed at any time by the
18626 * map object itself to account for map size and map viewport size.
18628 * @see elm_map_zoom_set() for details.
18632 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18635 * Set the zoom mode used by the map object.
18637 * @param obj The map object.
18638 * @param mode The zoom mode of the map, being it one of
18639 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18640 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18642 * This sets the zoom mode to manual or one of the automatic levels.
18643 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18644 * elm_map_zoom_set() and will stay at that level until changed by code
18645 * or until zoom mode is changed. This is the default mode.
18647 * The Automatic modes will allow the map object to automatically
18648 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18649 * adjust zoom so the map fits inside the scroll frame with no pixels
18650 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18651 * ensure no pixels within the frame are left unfilled. Do not forget that
18652 * the valid sizes are 2^zoom, consequently the map may be smaller than
18653 * the scroller view.
18655 * @see elm_map_zoom_set()
18659 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18662 * Get the zoom mode used by the map object.
18664 * @param obj The map object.
18665 * @return The zoom mode of the map, being it one of
18666 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18667 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18669 * This function returns the current zoom mode used by the map object.
18671 * @see elm_map_zoom_mode_set() for more details.
18675 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18678 * Get the current coordinates of the map.
18680 * @param obj The map object.
18681 * @param lon Pointer where to store longitude.
18682 * @param lat Pointer where to store latitude.
18684 * This gets the current center coordinates of the map object. It can be
18685 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18687 * @see elm_map_geo_region_bring_in()
18688 * @see elm_map_geo_region_show()
18692 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18695 * Animatedly bring in given coordinates to the center of the map.
18697 * @param obj The map object.
18698 * @param lon Longitude to center at.
18699 * @param lat Latitude to center at.
18701 * This causes map to jump to the given @p lat and @p lon coordinates
18702 * and show it (by scrolling) in the center of the viewport, if it is not
18703 * already centered. This will use animation to do so and take a period
18704 * of time to complete.
18706 * @see elm_map_geo_region_show() for a function to avoid animation.
18707 * @see elm_map_geo_region_get()
18711 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18714 * Show the given coordinates at the center of the map, @b immediately.
18716 * @param obj The map object.
18717 * @param lon Longitude to center at.
18718 * @param lat Latitude to center at.
18720 * This causes map to @b redraw its viewport's contents to the
18721 * region contining the given @p lat and @p lon, that will be moved to the
18722 * center of the map.
18724 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18725 * @see elm_map_geo_region_get()
18729 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18732 * Pause or unpause the map.
18734 * @param obj The map object.
18735 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18738 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18741 * The default is off.
18743 * This will stop zooming using animation, changing zoom levels will
18744 * change instantly. This will stop any existing animations that are running.
18746 * @see elm_map_paused_get()
18750 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18753 * Get a value whether map is paused or not.
18755 * @param obj The map object.
18756 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18757 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18759 * This gets the current paused state for the map object.
18761 * @see elm_map_paused_set() for details.
18765 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18768 * Set to show markers during zoom level changes or not.
18770 * @param obj The map object.
18771 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18774 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18777 * The default is off.
18779 * This will stop zooming using animation, changing zoom levels will
18780 * change instantly. This will stop any existing animations that are running.
18782 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18785 * The default is off.
18787 * Enabling it will force the map to stop displaying the markers during
18788 * zoom level changes. Set to on if you have a large number of markers.
18790 * @see elm_map_paused_markers_get()
18794 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18797 * Get a value whether markers will be displayed on zoom level changes or not
18799 * @param obj The map object.
18800 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18801 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18803 * This gets the current markers paused state for the map object.
18805 * @see elm_map_paused_markers_set() for details.
18809 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18812 * Get the information of downloading status.
18814 * @param obj The map object.
18815 * @param try_num Pointer where to store number of tiles being downloaded.
18816 * @param finish_num Pointer where to store number of tiles successfully
18819 * This gets the current downloading status for the map object, the number
18820 * of tiles being downloaded and the number of tiles already downloaded.
18824 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18827 * Convert a pixel coordinate (x,y) into a geographic coordinate
18828 * (longitude, latitude).
18830 * @param obj The map object.
18831 * @param x the coordinate.
18832 * @param y the coordinate.
18833 * @param size the size in pixels of the map.
18834 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18835 * @param lon Pointer where to store the longitude that correspond to x.
18836 * @param lat Pointer where to store the latitude that correspond to y.
18838 * @note Origin pixel point is the top left corner of the viewport.
18839 * Map zoom and size are taken on account.
18841 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18845 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);
18848 * Convert a geographic coordinate (longitude, latitude) into a pixel
18849 * coordinate (x, y).
18851 * @param obj The map object.
18852 * @param lon the longitude.
18853 * @param lat the latitude.
18854 * @param size the size in pixels of the map. The map is a square
18855 * and generally his size is : pow(2.0, zoom)*256.
18856 * @param x Pointer where to store the horizontal pixel coordinate that
18857 * correspond to the longitude.
18858 * @param y Pointer where to store the vertical pixel coordinate that
18859 * correspond to the latitude.
18861 * @note Origin pixel point is the top left corner of the viewport.
18862 * Map zoom and size are taken on account.
18864 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18868 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);
18871 * Convert a geographic coordinate (longitude, latitude) into a name
18874 * @param obj The map object.
18875 * @param lon the longitude.
18876 * @param lat the latitude.
18877 * @return name A #Elm_Map_Name handle for this coordinate.
18879 * To get the string for this address, elm_map_name_address_get()
18882 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18886 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18889 * Convert a name (address) into a geographic coordinate
18890 * (longitude, latitude).
18892 * @param obj The map object.
18893 * @param name The address.
18894 * @return name A #Elm_Map_Name handle for this address.
18896 * To get the longitude and latitude, elm_map_name_region_get()
18899 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18903 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18906 * Convert a pixel coordinate into a rotated pixel coordinate.
18908 * @param obj The map object.
18909 * @param x horizontal coordinate of the point to rotate.
18910 * @param y vertical coordinate of the point to rotate.
18911 * @param cx rotation's center horizontal position.
18912 * @param cy rotation's center vertical position.
18913 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18914 * @param xx Pointer where to store rotated x.
18915 * @param yy Pointer where to store rotated y.
18919 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);
18922 * Add a new marker to the map object.
18924 * @param obj The map object.
18925 * @param lon The longitude of the marker.
18926 * @param lat The latitude of the marker.
18927 * @param clas The class, to use when marker @b isn't grouped to others.
18928 * @param clas_group The class group, to use when marker is grouped to others
18929 * @param data The data passed to the callbacks.
18931 * @return The created marker or @c NULL upon failure.
18933 * A marker will be created and shown in a specific point of the map, defined
18934 * by @p lon and @p lat.
18936 * It will be displayed using style defined by @p class when this marker
18937 * is displayed alone (not grouped). A new class can be created with
18938 * elm_map_marker_class_new().
18940 * If the marker is grouped to other markers, it will be displayed with
18941 * style defined by @p class_group. Markers with the same group are grouped
18942 * if they are close. A new group class can be created with
18943 * elm_map_marker_group_class_new().
18945 * Markers created with this method can be deleted with
18946 * elm_map_marker_remove().
18948 * A marker can have associated content to be displayed by a bubble,
18949 * when a user click over it, as well as an icon. These objects will
18950 * be fetch using class' callback functions.
18952 * @see elm_map_marker_class_new()
18953 * @see elm_map_marker_group_class_new()
18954 * @see elm_map_marker_remove()
18958 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);
18961 * Set the maximum numbers of markers' content to be displayed in a group.
18963 * @param obj The map object.
18964 * @param max The maximum numbers of items displayed in a bubble.
18966 * A bubble will be displayed when the user clicks over the group,
18967 * and will place the content of markers that belong to this group
18970 * A group can have a long list of markers, consequently the creation
18971 * of the content of the bubble can be very slow.
18973 * In order to avoid this, a maximum number of items is displayed
18976 * By default this number is 30.
18978 * Marker with the same group class are grouped if they are close.
18980 * @see elm_map_marker_add()
18984 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18987 * Remove a marker from the map.
18989 * @param marker The marker to remove.
18991 * @see elm_map_marker_add()
18995 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18998 * Get the current coordinates of the marker.
19000 * @param marker marker.
19001 * @param lat Pointer where to store the marker's latitude.
19002 * @param lon Pointer where to store the marker's longitude.
19004 * These values are set when adding markers, with function
19005 * elm_map_marker_add().
19007 * @see elm_map_marker_add()
19011 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19014 * Animatedly bring in given marker to the center of the map.
19016 * @param marker The marker to center at.
19018 * This causes map to jump to the given @p marker's coordinates
19019 * and show it (by scrolling) in the center of the viewport, if it is not
19020 * already centered. This will use animation to do so and take a period
19021 * of time to complete.
19023 * @see elm_map_marker_show() for a function to avoid animation.
19024 * @see elm_map_marker_region_get()
19028 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19031 * Show the given marker at the center of the map, @b immediately.
19033 * @param marker The marker to center at.
19035 * This causes map to @b redraw its viewport's contents to the
19036 * region contining the given @p marker's coordinates, that will be
19037 * moved to the center of the map.
19039 * @see elm_map_marker_bring_in() for a function to move with animation.
19040 * @see elm_map_markers_list_show() if more than one marker need to be
19042 * @see elm_map_marker_region_get()
19046 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19049 * Move and zoom the map to display a list of markers.
19051 * @param markers A list of #Elm_Map_Marker handles.
19053 * The map will be centered on the center point of the markers in the list.
19054 * Then the map will be zoomed in order to fit the markers using the maximum
19055 * zoom which allows display of all the markers.
19057 * @warning All the markers should belong to the same map object.
19059 * @see elm_map_marker_show() to show a single marker.
19060 * @see elm_map_marker_bring_in()
19064 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19067 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19069 * @param marker The marker wich content should be returned.
19070 * @return Return the evas object if it exists, else @c NULL.
19072 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19073 * elm_map_marker_class_get_cb_set() should be used.
19075 * This content is what will be inside the bubble that will be displayed
19076 * when an user clicks over the marker.
19078 * This returns the actual Evas object used to be placed inside
19079 * the bubble. This may be @c NULL, as it may
19080 * not have been created or may have been deleted, at any time, by
19081 * the map. <b>Do not modify this object</b> (move, resize,
19082 * show, hide, etc.), as the map is controlling it. This
19083 * function is for querying, emitting custom signals or hooking
19084 * lower level callbacks for events on that object. Do not delete
19085 * this object under any circumstances.
19089 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19092 * Update the marker
19094 * @param marker The marker to be updated.
19096 * If a content is set to this marker, it will call function to delete it,
19097 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19098 * #ElmMapMarkerGetFunc.
19100 * These functions are set for the marker class with
19101 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19105 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19108 * Close all the bubbles opened by the user.
19110 * @param obj The map object.
19112 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19113 * when the user clicks on a marker.
19115 * This functions is set for the marker class with
19116 * elm_map_marker_class_get_cb_set().
19120 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19123 * Create a new group class.
19125 * @param obj The map object.
19126 * @return Returns the new group class.
19128 * Each marker must be associated to a group class. Markers in the same
19129 * group are grouped if they are close.
19131 * The group class defines the style of the marker when a marker is grouped
19132 * to others markers. When it is alone, another class will be used.
19134 * A group class will need to be provided when creating a marker with
19135 * elm_map_marker_add().
19137 * Some properties and functions can be set by class, as:
19138 * - style, with elm_map_group_class_style_set()
19139 * - data - to be associated to the group class. It can be set using
19140 * elm_map_group_class_data_set().
19141 * - min zoom to display markers, set with
19142 * elm_map_group_class_zoom_displayed_set().
19143 * - max zoom to group markers, set using
19144 * elm_map_group_class_zoom_grouped_set().
19145 * - visibility - set if markers will be visible or not, set with
19146 * elm_map_group_class_hide_set().
19147 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19148 * It can be set using elm_map_group_class_icon_cb_set().
19150 * @see elm_map_marker_add()
19151 * @see elm_map_group_class_style_set()
19152 * @see elm_map_group_class_data_set()
19153 * @see elm_map_group_class_zoom_displayed_set()
19154 * @see elm_map_group_class_zoom_grouped_set()
19155 * @see elm_map_group_class_hide_set()
19156 * @see elm_map_group_class_icon_cb_set()
19160 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19163 * Set the marker's style of a group class.
19165 * @param clas The group class.
19166 * @param style The style to be used by markers.
19168 * Each marker must be associated to a group class, and will use the style
19169 * defined by such class when grouped to other markers.
19171 * The following styles are provided by default theme:
19172 * @li @c radio - blue circle
19173 * @li @c radio2 - green circle
19176 * @see elm_map_group_class_new() for more details.
19177 * @see elm_map_marker_add()
19181 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19184 * Set the icon callback function of a group class.
19186 * @param clas The group class.
19187 * @param icon_get The callback function that will return the icon.
19189 * Each marker must be associated to a group class, and it can display a
19190 * custom icon. The function @p icon_get must return this icon.
19192 * @see elm_map_group_class_new() for more details.
19193 * @see elm_map_marker_add()
19197 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19200 * Set the data associated to the group class.
19202 * @param clas The group class.
19203 * @param data The new user data.
19205 * This data will be passed for callback functions, like icon get callback,
19206 * that can be set with elm_map_group_class_icon_cb_set().
19208 * If a data was previously set, the object will lose the pointer for it,
19209 * so if needs to be freed, you must do it yourself.
19211 * @see elm_map_group_class_new() for more details.
19212 * @see elm_map_group_class_icon_cb_set()
19213 * @see elm_map_marker_add()
19217 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19220 * Set the minimum zoom from where the markers are displayed.
19222 * @param clas The group class.
19223 * @param zoom The minimum zoom.
19225 * Markers only will be displayed when the map is displayed at @p zoom
19228 * @see elm_map_group_class_new() for more details.
19229 * @see elm_map_marker_add()
19233 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19236 * Set the zoom from where the markers are no more grouped.
19238 * @param clas The group class.
19239 * @param zoom The maximum zoom.
19241 * Markers only will be grouped when the map is displayed at
19242 * less than @p zoom.
19244 * @see elm_map_group_class_new() for more details.
19245 * @see elm_map_marker_add()
19249 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19252 * Set if the markers associated to the group class @clas are hidden or not.
19254 * @param clas The group class.
19255 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19258 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19263 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19266 * Create a new marker class.
19268 * @param obj The map object.
19269 * @return Returns the new group class.
19271 * Each marker must be associated to a class.
19273 * The marker class defines the style of the marker when a marker is
19274 * displayed alone, i.e., not grouped to to others markers. When grouped
19275 * it will use group class style.
19277 * A marker class will need to be provided when creating a marker with
19278 * elm_map_marker_add().
19280 * Some properties and functions can be set by class, as:
19281 * - style, with elm_map_marker_class_style_set()
19282 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19283 * It can be set using elm_map_marker_class_icon_cb_set().
19284 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19285 * Set using elm_map_marker_class_get_cb_set().
19286 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19287 * Set using elm_map_marker_class_del_cb_set().
19289 * @see elm_map_marker_add()
19290 * @see elm_map_marker_class_style_set()
19291 * @see elm_map_marker_class_icon_cb_set()
19292 * @see elm_map_marker_class_get_cb_set()
19293 * @see elm_map_marker_class_del_cb_set()
19297 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19300 * Set the marker's style of a marker class.
19302 * @param clas The marker class.
19303 * @param style The style to be used by markers.
19305 * Each marker must be associated to a marker class, and will use the style
19306 * defined by such class when alone, i.e., @b not grouped to other markers.
19308 * The following styles are provided by default theme:
19313 * @see elm_map_marker_class_new() for more details.
19314 * @see elm_map_marker_add()
19318 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19321 * Set the icon callback function of a marker class.
19323 * @param clas The marker class.
19324 * @param icon_get The callback function that will return the icon.
19326 * Each marker must be associated to a marker class, and it can display a
19327 * custom icon. The function @p icon_get must return this icon.
19329 * @see elm_map_marker_class_new() for more details.
19330 * @see elm_map_marker_add()
19334 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19337 * Set the bubble content callback function of a marker class.
19339 * @param clas The marker class.
19340 * @param get The callback function that will return the content.
19342 * Each marker must be associated to a marker class, and it can display a
19343 * a content on a bubble that opens when the user click over the marker.
19344 * The function @p get must return this content object.
19346 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19349 * @see elm_map_marker_class_new() for more details.
19350 * @see elm_map_marker_class_del_cb_set()
19351 * @see elm_map_marker_add()
19355 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19358 * Set the callback function used to delete bubble content of a marker class.
19360 * @param clas The marker class.
19361 * @param del The callback function that will delete the content.
19363 * Each marker must be associated to a marker class, and it can display a
19364 * a content on a bubble that opens when the user click over the marker.
19365 * The function to return such content can be set with
19366 * elm_map_marker_class_get_cb_set().
19368 * If this content must be freed, a callback function need to be
19369 * set for that task with this function.
19371 * If this callback is defined it will have to delete (or not) the
19372 * object inside, but if the callback is not defined the object will be
19373 * destroyed with evas_object_del().
19375 * @see elm_map_marker_class_new() for more details.
19376 * @see elm_map_marker_class_get_cb_set()
19377 * @see elm_map_marker_add()
19381 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19384 * Get the list of available sources.
19386 * @param obj The map object.
19387 * @return The source names list.
19389 * It will provide a list with all available sources, that can be set as
19390 * current source with elm_map_source_name_set(), or get with
19391 * elm_map_source_name_get().
19393 * Available sources:
19399 * @see elm_map_source_name_set() for more details.
19400 * @see elm_map_source_name_get()
19404 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19407 * Set the source of the map.
19409 * @param obj The map object.
19410 * @param source The source to be used.
19412 * Map widget retrieves images that composes the map from a web service.
19413 * This web service can be set with this method.
19415 * A different service can return a different maps with different
19416 * information and it can use different zoom values.
19418 * The @p source_name need to match one of the names provided by
19419 * elm_map_source_names_get().
19421 * The current source can be get using elm_map_source_name_get().
19423 * @see elm_map_source_names_get()
19424 * @see elm_map_source_name_get()
19429 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19432 * Get the name of currently used source.
19434 * @param obj The map object.
19435 * @return Returns the name of the source in use.
19437 * @see elm_map_source_name_set() for more details.
19441 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19444 * Set the source of the route service to be used by the map.
19446 * @param obj The map object.
19447 * @param source The route service to be used, being it one of
19448 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19449 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19451 * Each one has its own algorithm, so the route retrieved may
19452 * differ depending on the source route. Now, only the default is working.
19454 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19455 * http://www.yournavigation.org/.
19457 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19458 * assumptions. Its routing core is based on Contraction Hierarchies.
19460 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19462 * @see elm_map_route_source_get().
19466 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19469 * Get the current route source.
19471 * @param obj The map object.
19472 * @return The source of the route service used by the map.
19474 * @see elm_map_route_source_set() for details.
19478 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19481 * Set the minimum zoom of the source.
19483 * @param obj The map object.
19484 * @param zoom New minimum zoom value to be used.
19486 * By default, it's 0.
19490 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19493 * Get the minimum zoom of the source.
19495 * @param obj The map object.
19496 * @return Returns the minimum zoom of the source.
19498 * @see elm_map_source_zoom_min_set() for details.
19502 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19505 * Set the maximum zoom of the source.
19507 * @param obj The map object.
19508 * @param zoom New maximum zoom value to be used.
19510 * By default, it's 18.
19514 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19517 * Get the maximum zoom of the source.
19519 * @param obj The map object.
19520 * @return Returns the maximum zoom of the source.
19522 * @see elm_map_source_zoom_min_set() for details.
19526 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19529 * Set the user agent used by the map object to access routing services.
19531 * @param obj The map object.
19532 * @param user_agent The user agent to be used by the map.
19534 * User agent is a client application implementing a network protocol used
19535 * in communications within a client–server distributed computing system
19537 * The @p user_agent identification string will transmitted in a header
19538 * field @c User-Agent.
19540 * @see elm_map_user_agent_get()
19544 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19547 * Get the user agent used by the map object.
19549 * @param obj The map object.
19550 * @return The user agent identification string used by the map.
19552 * @see elm_map_user_agent_set() for details.
19556 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19559 * Add a new route to the map object.
19561 * @param obj The map object.
19562 * @param type The type of transport to be considered when tracing a route.
19563 * @param method The routing method, what should be priorized.
19564 * @param flon The start longitude.
19565 * @param flat The start latitude.
19566 * @param tlon The destination longitude.
19567 * @param tlat The destination latitude.
19569 * @return The created route or @c NULL upon failure.
19571 * A route will be traced by point on coordinates (@p flat, @p flon)
19572 * to point on coordinates (@p tlat, @p tlon), using the route service
19573 * set with elm_map_route_source_set().
19575 * It will take @p type on consideration to define the route,
19576 * depending if the user will be walking or driving, the route may vary.
19577 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19578 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19580 * Another parameter is what the route should priorize, the minor distance
19581 * or the less time to be spend on the route. So @p method should be one
19582 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19584 * Routes created with this method can be deleted with
19585 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19586 * and distance can be get with elm_map_route_distance_get().
19588 * @see elm_map_route_remove()
19589 * @see elm_map_route_color_set()
19590 * @see elm_map_route_distance_get()
19591 * @see elm_map_route_source_set()
19595 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);
19598 * Remove a route from the map.
19600 * @param route The route to remove.
19602 * @see elm_map_route_add()
19606 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19609 * Set the route color.
19611 * @param route The route object.
19612 * @param r Red channel value, from 0 to 255.
19613 * @param g Green channel value, from 0 to 255.
19614 * @param b Blue channel value, from 0 to 255.
19615 * @param a Alpha channel value, from 0 to 255.
19617 * It uses an additive color model, so each color channel represents
19618 * how much of each primary colors must to be used. 0 represents
19619 * ausence of this color, so if all of the three are set to 0,
19620 * the color will be black.
19622 * These component values should be integers in the range 0 to 255,
19623 * (single 8-bit byte).
19625 * This sets the color used for the route. By default, it is set to
19626 * solid red (r = 255, g = 0, b = 0, a = 255).
19628 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19630 * @see elm_map_route_color_get()
19634 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19637 * Get the route color.
19639 * @param route The route object.
19640 * @param r Pointer where to store the red channel value.
19641 * @param g Pointer where to store the green channel value.
19642 * @param b Pointer where to store the blue channel value.
19643 * @param a Pointer where to store the alpha channel value.
19645 * @see elm_map_route_color_set() for details.
19649 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19652 * Get the route distance in kilometers.
19654 * @param route The route object.
19655 * @return The distance of route (unit : km).
19659 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19662 * Get the information of route nodes.
19664 * @param route The route object.
19665 * @return Returns a string with the nodes of route.
19669 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19672 * Get the information of route waypoint.
19674 * @param route the route object.
19675 * @return Returns a string with information about waypoint of route.
19679 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19682 * Get the address of the name.
19684 * @param name The name handle.
19685 * @return Returns the address string of @p name.
19687 * This gets the coordinates of the @p name, created with one of the
19688 * conversion functions.
19690 * @see elm_map_utils_convert_name_into_coord()
19691 * @see elm_map_utils_convert_coord_into_name()
19695 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19698 * Get the current coordinates of the name.
19700 * @param name The name handle.
19701 * @param lat Pointer where to store the latitude.
19702 * @param lon Pointer where to store The longitude.
19704 * This gets the coordinates of the @p name, created with one of the
19705 * conversion functions.
19707 * @see elm_map_utils_convert_name_into_coord()
19708 * @see elm_map_utils_convert_coord_into_name()
19712 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19715 * Remove a name from the map.
19717 * @param name The name to remove.
19719 * Basically the struct handled by @p name will be freed, so convertions
19720 * between address and coordinates will be lost.
19722 * @see elm_map_utils_convert_name_into_coord()
19723 * @see elm_map_utils_convert_coord_into_name()
19727 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19732 * @param obj The map object.
19733 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19734 * @param cx Rotation's center horizontal position.
19735 * @param cy Rotation's center vertical position.
19737 * @see elm_map_rotate_get()
19741 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19744 * Get the rotate degree of the map
19746 * @param obj The map object
19747 * @param degree Pointer where to store degrees from 0.0 to 360.0
19748 * to rotate arount Z axis.
19749 * @param cx Pointer where to store rotation's center horizontal position.
19750 * @param cy Pointer where to store rotation's center vertical position.
19752 * @see elm_map_rotate_set() to set map rotation.
19756 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);
19759 * Enable or disable mouse wheel to be used to zoom in / out the map.
19761 * @param obj The map object.
19762 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19765 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19767 * It's disabled by default.
19769 * @see elm_map_wheel_disabled_get()
19773 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19776 * Get a value whether mouse wheel is enabled or not.
19778 * @param obj The map object.
19779 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19780 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19782 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19784 * @see elm_map_wheel_disabled_set() for details.
19788 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19792 * Add a track on the map
19794 * @param obj The map object.
19795 * @param emap The emap route object.
19796 * @return The route object. This is an elm object of type Route.
19798 * @see elm_route_add() for details.
19802 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19806 * Remove a track from the map
19808 * @param obj The map object.
19809 * @param route The track to remove.
19813 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19820 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19822 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19824 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19825 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19826 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19827 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19831 * @defgroup Panel Panel
19833 * @image html img/widget/panel/preview-00.png
19834 * @image latex img/widget/panel/preview-00.eps
19836 * @brief A panel is a type of animated container that contains subobjects.
19837 * It can be expanded or contracted by clicking the button on it's edge.
19839 * Orientations are as follows:
19840 * @li ELM_PANEL_ORIENT_TOP
19841 * @li ELM_PANEL_ORIENT_LEFT
19842 * @li ELM_PANEL_ORIENT_RIGHT
19844 * @ref tutorial_panel shows one way to use this widget.
19847 typedef enum _Elm_Panel_Orient
19849 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19850 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19851 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19852 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19853 } Elm_Panel_Orient;
19855 * @brief Adds a panel object
19857 * @param parent The parent object
19859 * @return The panel object, or NULL on failure
19861 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19863 * @brief Sets the orientation of the panel
19865 * @param parent The parent object
19866 * @param orient The panel orientation. Can be one of the following:
19867 * @li ELM_PANEL_ORIENT_TOP
19868 * @li ELM_PANEL_ORIENT_LEFT
19869 * @li ELM_PANEL_ORIENT_RIGHT
19871 * Sets from where the panel will (dis)appear.
19873 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19875 * @brief Get the orientation of the panel.
19877 * @param obj The panel object
19878 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19880 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19882 * @brief Set the content of the panel.
19884 * @param obj The panel object
19885 * @param content The panel content
19887 * Once the content object is set, a previously set one will be deleted.
19888 * If you want to keep that old content object, use the
19889 * elm_panel_content_unset() function.
19891 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19893 * @brief Get the content of the panel.
19895 * @param obj The panel object
19896 * @return The content that is being used
19898 * Return the content object which is set for this widget.
19900 * @see elm_panel_content_set()
19902 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19904 * @brief Unset the content of the panel.
19906 * @param obj The panel object
19907 * @return The content that was being used
19909 * Unparent and return the content object which was set for this widget.
19911 * @see elm_panel_content_set()
19913 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19915 * @brief Set the state of the panel.
19917 * @param obj The panel object
19918 * @param hidden If true, the panel will run the animation to contract
19920 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19922 * @brief Get the state of the panel.
19924 * @param obj The panel object
19925 * @param hidden If true, the panel is in the "hide" state
19927 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19929 * @brief Toggle the hidden state of the panel from code
19931 * @param obj The panel object
19933 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19939 * @defgroup Panes Panes
19940 * @ingroup Elementary
19942 * @image html img/widget/panes/preview-00.png
19943 * @image latex img/widget/panes/preview-00.eps width=\textwidth
19945 * @image html img/panes.png
19946 * @image latex img/panes.eps width=\textwidth
19948 * The panes adds a dragable bar between two contents. When dragged
19949 * this bar will resize contents size.
19951 * Panes can be displayed vertically or horizontally, and contents
19952 * size proportion can be customized (homogeneous by default).
19954 * Smart callbacks one can listen to:
19955 * - "press" - The panes has been pressed (button wasn't released yet).
19956 * - "unpressed" - The panes was released after being pressed.
19957 * - "clicked" - The panes has been clicked>
19958 * - "clicked,double" - The panes has been double clicked
19960 * Available styles for it:
19963 * Here is an example on its usage:
19964 * @li @ref panes_example
19968 * @addtogroup Panes
19973 * Add a new panes widget to the given parent Elementary
19974 * (container) object.
19976 * @param parent The parent object.
19977 * @return a new panes widget handle or @c NULL, on errors.
19979 * This function inserts a new panes widget on the canvas.
19983 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19986 * Set the left content of the panes widget.
19988 * @param obj The panes object.
19989 * @param content The new left content object.
19991 * Once the content object is set, a previously set one will be deleted.
19992 * If you want to keep that old content object, use the
19993 * elm_panes_content_left_unset() function.
19995 * If panes is displayed vertically, left content will be displayed at
19998 * @see elm_panes_content_left_get()
19999 * @see elm_panes_content_right_set() to set content on the other side.
20003 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20006 * Set the right content of the panes widget.
20008 * @param obj The panes object.
20009 * @param content The new right content object.
20011 * Once the content object is set, a previously set one will be deleted.
20012 * If you want to keep that old content object, use the
20013 * elm_panes_content_right_unset() function.
20015 * If panes is displayed vertically, left content will be displayed at
20018 * @see elm_panes_content_right_get()
20019 * @see elm_panes_content_left_set() to set content on the other side.
20023 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20026 * Get the left content of the panes.
20028 * @param obj The panes object.
20029 * @return The left content object that is being used.
20031 * Return the left content object which is set for this widget.
20033 * @see elm_panes_content_left_set() for details.
20037 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20040 * Get the right content of the panes.
20042 * @param obj The panes object
20043 * @return The right content object that is being used
20045 * Return the right content object which is set for this widget.
20047 * @see elm_panes_content_right_set() for details.
20051 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20054 * Unset the left content used for the panes.
20056 * @param obj The panes object.
20057 * @return The left content object that was being used.
20059 * Unparent and return the left content object which was set for this widget.
20061 * @see elm_panes_content_left_set() for details.
20062 * @see elm_panes_content_left_get().
20066 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20069 * Unset the right content used for the panes.
20071 * @param obj The panes object.
20072 * @return The right content object that was being used.
20074 * Unparent and return the right content object which was set for this
20077 * @see elm_panes_content_right_set() for details.
20078 * @see elm_panes_content_right_get().
20082 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20085 * Get the size proportion of panes widget's left side.
20087 * @param obj The panes object.
20088 * @return float value between 0.0 and 1.0 representing size proportion
20091 * @see elm_panes_content_left_size_set() for more details.
20095 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20098 * Set the size proportion of panes widget's left side.
20100 * @param obj The panes object.
20101 * @param size Value between 0.0 and 1.0 representing size proportion
20104 * By default it's homogeneous, i.e., both sides have the same size.
20106 * If something different is required, it can be set with this function.
20107 * For example, if the left content should be displayed over
20108 * 75% of the panes size, @p size should be passed as @c 0.75.
20109 * This way, right content will be resized to 25% of panes size.
20111 * If displayed vertically, left content is displayed at top, and
20112 * right content at bottom.
20114 * @note This proportion will change when user drags the panes bar.
20116 * @see elm_panes_content_left_size_get()
20120 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20123 * Set the orientation of a given panes widget.
20125 * @param obj The panes object.
20126 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20127 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20129 * Use this function to change how your panes is to be
20130 * disposed: vertically or horizontally.
20132 * By default it's displayed horizontally.
20134 * @see elm_panes_horizontal_get()
20138 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20141 * Retrieve the orientation of a given panes widget.
20143 * @param obj The panes object.
20144 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20145 * @c EINA_FALSE if it's @b vertical (and on errors).
20147 * @see elm_panes_horizontal_set() for more details.
20151 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @defgroup Flip Flip
20160 * @image html img/widget/flip/preview-00.png
20161 * @image latex img/widget/flip/preview-00.eps
20163 * This widget holds 2 content objects(Evas_Object): one on the front and one
20164 * on the back. It allows you to flip from front to back and vice-versa using
20165 * various animations.
20167 * If either the front or back contents are not set the flip will treat that
20168 * as transparent. So if you wore to set the front content but not the back,
20169 * and then call elm_flip_go() you would see whatever is below the flip.
20171 * For a list of supported animations see elm_flip_go().
20173 * Signals that you can add callbacks for are:
20174 * "animate,begin" - when a flip animation was started
20175 * "animate,done" - when a flip animation is finished
20177 * @ref tutorial_flip show how to use most of the API.
20181 typedef enum _Elm_Flip_Mode
20183 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20184 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20185 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20186 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20187 ELM_FLIP_CUBE_LEFT,
20188 ELM_FLIP_CUBE_RIGHT,
20190 ELM_FLIP_CUBE_DOWN,
20191 ELM_FLIP_PAGE_LEFT,
20192 ELM_FLIP_PAGE_RIGHT,
20196 typedef enum _Elm_Flip_Interaction
20198 ELM_FLIP_INTERACTION_NONE,
20199 ELM_FLIP_INTERACTION_ROTATE,
20200 ELM_FLIP_INTERACTION_CUBE,
20201 ELM_FLIP_INTERACTION_PAGE
20202 } Elm_Flip_Interaction;
20203 typedef enum _Elm_Flip_Direction
20205 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20206 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20207 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20208 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20209 } Elm_Flip_Direction;
20211 * @brief Add a new flip to the parent
20213 * @param parent The parent object
20214 * @return The new object or NULL if it cannot be created
20216 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20218 * @brief Set the front content of the flip widget.
20220 * @param obj The flip object
20221 * @param content The new front content object
20223 * Once the content object is set, a previously set one will be deleted.
20224 * If you want to keep that old content object, use the
20225 * elm_flip_content_front_unset() function.
20227 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20229 * @brief Set the back content of the flip widget.
20231 * @param obj The flip object
20232 * @param content The new back content object
20234 * Once the content object is set, a previously set one will be deleted.
20235 * If you want to keep that old content object, use the
20236 * elm_flip_content_back_unset() function.
20238 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20240 * @brief Get the front content used for the flip
20242 * @param obj The flip object
20243 * @return The front content object that is being used
20245 * Return the front content object which is set for this widget.
20247 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20249 * @brief Get the back content used for the flip
20251 * @param obj The flip object
20252 * @return The back content object that is being used
20254 * Return the back content object which is set for this widget.
20256 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20258 * @brief Unset the front content used for the flip
20260 * @param obj The flip object
20261 * @return The front content object that was being used
20263 * Unparent and return the front content object which was set for this widget.
20265 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20267 * @brief Unset the back content used for the flip
20269 * @param obj The flip object
20270 * @return The back content object that was being used
20272 * Unparent and return the back content object which was set for this widget.
20274 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20276 * @brief Get flip front visibility state
20278 * @param obj The flip objct
20279 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20282 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20284 * @brief Set flip perspective
20286 * @param obj The flip object
20287 * @param foc The coordinate to set the focus on
20288 * @param x The X coordinate
20289 * @param y The Y coordinate
20291 * @warning This function currently does nothing.
20293 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20295 * @brief Runs the flip animation
20297 * @param obj The flip object
20298 * @param mode The mode type
20300 * Flips the front and back contents using the @p mode animation. This
20301 * efectively hides the currently visible content and shows the hidden one.
20303 * There a number of possible animations to use for the flipping:
20304 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20305 * around a horizontal axis in the middle of its height, the other content
20306 * is shown as the other side of the flip.
20307 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20308 * around a vertical axis in the middle of its width, the other content is
20309 * shown as the other side of the flip.
20310 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20311 * around a diagonal axis in the middle of its width, the other content is
20312 * shown as the other side of the flip.
20313 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20314 * around a diagonal axis in the middle of its height, the other content is
20315 * shown as the other side of the flip.
20316 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20317 * as if the flip was a cube, the other content is show as the right face of
20319 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20320 * right as if the flip was a cube, the other content is show as the left
20321 * face of the cube.
20322 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20323 * flip was a cube, the other content is show as the bottom face of the cube.
20324 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20325 * the flip was a cube, the other content is show as the upper face of the
20327 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20328 * if the flip was a book, the other content is shown as the page below that.
20329 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20330 * as if the flip was a book, the other content is shown as the page below
20332 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20333 * flip was a book, the other content is shown as the page below that.
20334 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20335 * flip was a book, the other content is shown as the page below that.
20337 * @image html elm_flip.png
20338 * @image latex elm_flip.eps width=\textwidth
20340 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20342 * @brief Set the interactive flip mode
20344 * @param obj The flip object
20345 * @param mode The interactive flip mode to use
20347 * This sets if the flip should be interactive (allow user to click and
20348 * drag a side of the flip to reveal the back page and cause it to flip).
20349 * By default a flip is not interactive. You may also need to set which
20350 * sides of the flip are "active" for flipping and how much space they use
20351 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20352 * and elm_flip_interacton_direction_hitsize_set()
20354 * The four avilable mode of interaction are:
20355 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20356 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20357 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20358 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20360 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20361 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20362 * happen, those can only be acheived with elm_flip_go();
20364 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20366 * @brief Get the interactive flip mode
20368 * @param obj The flip object
20369 * @return The interactive flip mode
20371 * Returns the interactive flip mode set by elm_flip_interaction_set()
20373 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20375 * @brief Set which directions of the flip respond to interactive flip
20377 * @param obj The flip object
20378 * @param dir The direction to change
20379 * @param enabled If that direction is enabled or not
20381 * By default all directions are disabled, so you may want to enable the
20382 * desired directions for flipping if you need interactive flipping. You must
20383 * call this function once for each direction that should be enabled.
20385 * @see elm_flip_interaction_set()
20387 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20389 * @brief Get the enabled state of that flip direction
20391 * @param obj The flip object
20392 * @param dir The direction to check
20393 * @return If that direction is enabled or not
20395 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20397 * @see elm_flip_interaction_set()
20399 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20401 * @brief Set the amount of the flip that is sensitive to interactive flip
20403 * @param obj The flip object
20404 * @param dir The direction to modify
20405 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20407 * Set the amount of the flip that is sensitive to interactive flip, with 0
20408 * representing no area in the flip and 1 representing the entire flip. There
20409 * is however a consideration to be made in that the area will never be
20410 * smaller than the finger size set(as set in your Elementary configuration).
20412 * @see elm_flip_interaction_set()
20414 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20416 * @brief Get the amount of the flip that is sensitive to interactive flip
20418 * @param obj The flip object
20419 * @param dir The direction to check
20420 * @return The size set for that direction
20422 * Returns the amount os sensitive area set by
20423 * elm_flip_interacton_direction_hitsize_set().
20425 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20430 /* scrolledentry */
20431 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20432 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20433 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20434 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20435 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20436 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20437 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20438 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20439 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20440 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20441 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20442 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20443 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20444 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20445 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20446 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20447 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20448 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20449 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20450 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20451 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20452 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20453 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20454 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20455 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20456 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20457 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20458 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20459 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20460 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20461 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20462 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20463 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20464 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20465 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20466 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);
20467 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20468 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20469 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);
20470 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20471 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);
20472 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20473 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20474 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20476 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20477 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20478 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20479 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20480 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);
20481 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);
20482 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);
20483 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);
20484 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);
20485 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);
20486 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20487 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20488 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20489 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20490 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20491 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20492 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20495 * @defgroup Conformant Conformant
20496 * @ingroup Elementary
20498 * @image html img/widget/conformant/preview-00.png
20499 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20501 * @image html img/conformant.png
20502 * @image latex img/conformant.eps width=\textwidth
20504 * The aim is to provide a widget that can be used in elementary apps to
20505 * account for space taken up by the indicator, virtual keypad & softkey
20506 * windows when running the illume2 module of E17.
20508 * So conformant content will be sized and positioned considering the
20509 * space required for such stuff, and when they popup, as a keyboard
20510 * shows when an entry is selected, conformant content won't change.
20512 * Available styles for it:
20515 * See how to use this widget in this example:
20516 * @ref conformant_example
20520 * @addtogroup Conformant
20525 * Add a new conformant widget to the given parent Elementary
20526 * (container) object.
20528 * @param parent The parent object.
20529 * @return A new conformant widget handle or @c NULL, on errors.
20531 * This function inserts a new conformant widget on the canvas.
20533 * @ingroup Conformant
20535 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20538 * Set the content of the conformant widget.
20540 * @param obj The conformant object.
20541 * @param content The content to be displayed by the conformant.
20543 * Content will be sized and positioned considering the space required
20544 * to display a virtual keyboard. So it won't fill all the conformant
20545 * size. This way is possible to be sure that content won't resize
20546 * or be re-positioned after the keyboard is displayed.
20548 * Once the content object is set, a previously set one will be deleted.
20549 * If you want to keep that old content object, use the
20550 * elm_conformat_content_unset() function.
20552 * @see elm_conformant_content_unset()
20553 * @see elm_conformant_content_get()
20555 * @ingroup Conformant
20557 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20560 * Get the content of the conformant widget.
20562 * @param obj The conformant object.
20563 * @return The content that is being used.
20565 * Return the content object which is set for this widget.
20566 * It won't be unparent from conformant. For that, use
20567 * elm_conformant_content_unset().
20569 * @see elm_conformant_content_set() for more details.
20570 * @see elm_conformant_content_unset()
20572 * @ingroup Conformant
20574 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20577 * Unset the content of the conformant widget.
20579 * @param obj The conformant object.
20580 * @return The content that was being used.
20582 * Unparent and return the content object which was set for this widget.
20584 * @see elm_conformant_content_set() for more details.
20586 * @ingroup Conformant
20588 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20591 * Returns the Evas_Object that represents the content area.
20593 * @param obj The conformant object.
20594 * @return The content area of the widget.
20596 * @ingroup Conformant
20598 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20605 * @defgroup Mapbuf Mapbuf
20606 * @ingroup Elementary
20608 * @image html img/widget/mapbuf/preview-00.png
20609 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20611 * This holds one content object and uses an Evas Map of transformation
20612 * points to be later used with this content. So the content will be
20613 * moved, resized, etc as a single image. So it will improve performance
20614 * when you have a complex interafce, with a lot of elements, and will
20615 * need to resize or move it frequently (the content object and its
20618 * See how to use this widget in this example:
20619 * @ref mapbuf_example
20623 * @addtogroup Mapbuf
20628 * Add a new mapbuf widget to the given parent Elementary
20629 * (container) object.
20631 * @param parent The parent object.
20632 * @return A new mapbuf widget handle or @c NULL, on errors.
20634 * This function inserts a new mapbuf widget on the canvas.
20638 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20641 * Set the content of the mapbuf.
20643 * @param obj The mapbuf object.
20644 * @param content The content that will be filled in this mapbuf object.
20646 * Once the content object is set, a previously set one will be deleted.
20647 * If you want to keep that old content object, use the
20648 * elm_mapbuf_content_unset() function.
20650 * To enable map, elm_mapbuf_enabled_set() should be used.
20654 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20657 * Get the content of the mapbuf.
20659 * @param obj The mapbuf object.
20660 * @return The content that is being used.
20662 * Return the content object which is set for this widget.
20664 * @see elm_mapbuf_content_set() for details.
20668 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20671 * Unset the content of the mapbuf.
20673 * @param obj The mapbuf object.
20674 * @return The content that was being used.
20676 * Unparent and return the content object which was set for this widget.
20678 * @see elm_mapbuf_content_set() for details.
20682 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20685 * Enable or disable the map.
20687 * @param obj The mapbuf object.
20688 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20690 * This enables the map that is set or disables it. On enable, the object
20691 * geometry will be saved, and the new geometry will change (position and
20692 * size) to reflect the map geometry set.
20694 * Also, when enabled, alpha and smooth states will be used, so if the
20695 * content isn't solid, alpha should be enabled, for example, otherwise
20696 * a black retangle will fill the content.
20698 * When disabled, the stored map will be freed and geometry prior to
20699 * enabling the map will be restored.
20701 * It's disabled by default.
20703 * @see elm_mapbuf_alpha_set()
20704 * @see elm_mapbuf_smooth_set()
20708 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20711 * Get a value whether map is enabled or not.
20713 * @param obj The mapbuf object.
20714 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20715 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20717 * @see elm_mapbuf_enabled_set() for details.
20721 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20724 * Enable or disable smooth map rendering.
20726 * @param obj The mapbuf object.
20727 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20730 * This sets smoothing for map rendering. If the object is a type that has
20731 * its own smoothing settings, then both the smooth settings for this object
20732 * and the map must be turned off.
20734 * By default smooth maps are enabled.
20738 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20741 * Get a value whether smooth map rendering is enabled or not.
20743 * @param obj The mapbuf object.
20744 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20745 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20747 * @see elm_mapbuf_smooth_set() for details.
20751 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20754 * Set or unset alpha flag for map rendering.
20756 * @param obj The mapbuf object.
20757 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20760 * This sets alpha flag for map rendering. If the object is a type that has
20761 * its own alpha settings, then this will take precedence. Only image objects
20762 * have this currently. It stops alpha blending of the map area, and is
20763 * useful if you know the object and/or all sub-objects is 100% solid.
20765 * Alpha is enabled by default.
20769 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20772 * Get a value whether alpha blending is enabled or not.
20774 * @param obj The mapbuf object.
20775 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20776 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20778 * @see elm_mapbuf_alpha_set() for details.
20782 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20789 * @defgroup Flipselector Flip Selector
20791 * @image html img/widget/flipselector/preview-00.png
20792 * @image latex img/widget/flipselector/preview-00.eps
20794 * A flip selector is a widget to show a set of @b text items, one
20795 * at a time, with the same sheet switching style as the @ref Clock
20796 * "clock" widget, when one changes the current displaying sheet
20797 * (thus, the "flip" in the name).
20799 * User clicks to flip sheets which are @b held for some time will
20800 * make the flip selector to flip continuosly and automatically for
20801 * the user. The interval between flips will keep growing in time,
20802 * so that it helps the user to reach an item which is distant from
20803 * the current selection.
20805 * Smart callbacks one can register to:
20806 * - @c "selected" - when the widget's selected text item is changed
20807 * - @c "overflowed" - when the widget's current selection is changed
20808 * from the first item in its list to the last
20809 * - @c "underflowed" - when the widget's current selection is changed
20810 * from the last item in its list to the first
20812 * Available styles for it:
20815 * Here is an example on its usage:
20816 * @li @ref flipselector_example
20820 * @addtogroup Flipselector
20824 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20827 * Add a new flip selector widget to the given parent Elementary
20828 * (container) widget
20830 * @param parent The parent object
20831 * @return a new flip selector widget handle or @c NULL, on errors
20833 * This function inserts a new flip selector widget on the canvas.
20835 * @ingroup Flipselector
20837 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20840 * Programmatically select the next item of a flip selector widget
20842 * @param obj The flipselector object
20844 * @note The selection will be animated. Also, if it reaches the
20845 * end of its list of member items, it will continue with the first
20848 * @ingroup Flipselector
20850 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20853 * Programmatically select the previous item of a flip selector
20856 * @param obj The flipselector object
20858 * @note The selection will be animated. Also, if it reaches the
20859 * beginning of its list of member items, it will continue with the
20860 * last one backwards.
20862 * @ingroup Flipselector
20864 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20867 * Append a (text) item to a flip selector widget
20869 * @param obj The flipselector object
20870 * @param label The (text) label of the new item
20871 * @param func Convenience callback function to take place when
20873 * @param data Data passed to @p func, above
20874 * @return A handle to the item added or @c NULL, on errors
20876 * The widget's list of labels to show will be appended with the
20877 * given value. If the user wishes so, a callback function pointer
20878 * can be passed, which will get called when this same item is
20881 * @note The current selection @b won't be modified by appending an
20882 * element to the list.
20884 * @note The maximum length of the text label is going to be
20885 * determined <b>by the widget's theme</b>. Strings larger than
20886 * that value are going to be @b truncated.
20888 * @ingroup Flipselector
20890 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20893 * Prepend a (text) item to a flip selector widget
20895 * @param obj The flipselector object
20896 * @param label The (text) label of the new item
20897 * @param func Convenience callback function to take place when
20899 * @param data Data passed to @p func, above
20900 * @return A handle to the item added or @c NULL, on errors
20902 * The widget's list of labels to show will be prepended with the
20903 * given value. If the user wishes so, a callback function pointer
20904 * can be passed, which will get called when this same item is
20907 * @note The current selection @b won't be modified by prepending
20908 * an element to the list.
20910 * @note The maximum length of the text label is going to be
20911 * determined <b>by the widget's theme</b>. Strings larger than
20912 * that value are going to be @b truncated.
20914 * @ingroup Flipselector
20916 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20919 * Get the internal list of items in a given flip selector widget.
20921 * @param obj The flipselector object
20922 * @return The list of items (#Elm_Flipselector_Item as data) or
20923 * @c NULL on errors.
20925 * This list is @b not to be modified in any way and must not be
20926 * freed. Use the list members with functions like
20927 * elm_flipselector_item_label_set(),
20928 * elm_flipselector_item_label_get(),
20929 * elm_flipselector_item_del(),
20930 * elm_flipselector_item_selected_get(),
20931 * elm_flipselector_item_selected_set().
20933 * @warning This list is only valid until @p obj object's internal
20934 * items list is changed. It should be fetched again with another
20935 * call to this function when changes happen.
20937 * @ingroup Flipselector
20939 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20942 * Get the first item in the given flip selector widget's list of
20945 * @param obj The flipselector object
20946 * @return The first item or @c NULL, if it has no items (and on
20949 * @see elm_flipselector_item_append()
20950 * @see elm_flipselector_last_item_get()
20952 * @ingroup Flipselector
20954 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20957 * Get the last item in the given flip selector widget's list of
20960 * @param obj The flipselector object
20961 * @return The last item or @c NULL, if it has no items (and on
20964 * @see elm_flipselector_item_prepend()
20965 * @see elm_flipselector_first_item_get()
20967 * @ingroup Flipselector
20969 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20972 * Get the currently selected item in a flip selector widget.
20974 * @param obj The flipselector object
20975 * @return The selected item or @c NULL, if the widget has no items
20978 * @ingroup Flipselector
20980 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20983 * Set whether a given flip selector widget's item should be the
20984 * currently selected one.
20986 * @param item The flip selector item
20987 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20989 * This sets whether @p item is or not the selected (thus, under
20990 * display) one. If @p item is different than one under display,
20991 * the latter will be unselected. If the @p item is set to be
20992 * unselected, on the other hand, the @b first item in the widget's
20993 * internal members list will be the new selected one.
20995 * @see elm_flipselector_item_selected_get()
20997 * @ingroup Flipselector
20999 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
21002 * Get whether a given flip selector widget's item is the currently
21005 * @param item The flip selector item
21006 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21009 * @see elm_flipselector_item_selected_set()
21011 * @ingroup Flipselector
21013 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21016 * Delete a given item from a flip selector widget.
21018 * @param item The item to delete
21020 * @ingroup Flipselector
21022 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21025 * Get the label of a given flip selector widget's item.
21027 * @param item The item to get label from
21028 * @return The text label of @p item or @c NULL, on errors
21030 * @see elm_flipselector_item_label_set()
21032 * @ingroup Flipselector
21034 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21037 * Set the label of a given flip selector widget's item.
21039 * @param item The item to set label on
21040 * @param label The text label string, in UTF-8 encoding
21042 * @see elm_flipselector_item_label_get()
21044 * @ingroup Flipselector
21046 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21049 * Gets the item before @p item in a flip selector widget's
21050 * internal list of items.
21052 * @param item The item to fetch previous from
21053 * @return The item before the @p item, in its parent's list. If
21054 * there is no previous item for @p item or there's an
21055 * error, @c NULL is returned.
21057 * @see elm_flipselector_item_next_get()
21059 * @ingroup Flipselector
21061 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21064 * Gets the item after @p item in a flip selector widget's
21065 * internal list of items.
21067 * @param item The item to fetch next from
21068 * @return The item after the @p item, in its parent's list. If
21069 * there is no next item for @p item or there's an
21070 * error, @c NULL is returned.
21072 * @see elm_flipselector_item_next_get()
21074 * @ingroup Flipselector
21076 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21079 * Set the interval on time updates for an user mouse button hold
21080 * on a flip selector widget.
21082 * @param obj The flip selector object
21083 * @param interval The (first) interval value in seconds
21085 * This interval value is @b decreased while the user holds the
21086 * mouse pointer either flipping up or flipping doww a given flip
21089 * This helps the user to get to a given item distant from the
21090 * current one easier/faster, as it will start to flip quicker and
21091 * quicker on mouse button holds.
21093 * The calculation for the next flip interval value, starting from
21094 * the one set with this call, is the previous interval divided by
21095 * 1.05, so it decreases a little bit.
21097 * The default starting interval value for automatic flips is
21100 * @see elm_flipselector_interval_get()
21102 * @ingroup Flipselector
21104 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21107 * Get the interval on time updates for an user mouse button hold
21108 * on a flip selector widget.
21110 * @param obj The flip selector object
21111 * @return The (first) interval value, in seconds, set on it
21113 * @see elm_flipselector_interval_set() for more details
21115 * @ingroup Flipselector
21117 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21120 * @addtogroup Calendar
21125 * @enum _Elm_Calendar_Mark_Repeat
21126 * @typedef Elm_Calendar_Mark_Repeat
21128 * Event periodicity, used to define if a mark should be repeated
21129 * @b beyond event's day. It's set when a mark is added.
21131 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21132 * there will be marks every week after this date. Marks will be displayed
21133 * at 13th, 20th, 27th, 3rd June ...
21135 * Values don't work as bitmask, only one can be choosen.
21137 * @see elm_calendar_mark_add()
21139 * @ingroup Calendar
21141 typedef enum _Elm_Calendar_Mark_Repeat
21143 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21144 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21145 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21146 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*/
21147 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. */
21148 } Elm_Calendar_Mark_Repeat;
21150 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(). */
21153 * Add a new calendar widget to the given parent Elementary
21154 * (container) object.
21156 * @param parent The parent object.
21157 * @return a new calendar widget handle or @c NULL, on errors.
21159 * This function inserts a new calendar widget on the canvas.
21161 * @ref calendar_example_01
21163 * @ingroup Calendar
21165 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21168 * Get weekdays names displayed by the calendar.
21170 * @param obj The calendar object.
21171 * @return Array of seven strings to be used as weekday names.
21173 * By default, weekdays abbreviations get from system are displayed:
21174 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21175 * The first string is related to Sunday, the second to Monday...
21177 * @see elm_calendar_weekdays_name_set()
21179 * @ref calendar_example_05
21181 * @ingroup Calendar
21183 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21186 * Set weekdays names to be displayed by the calendar.
21188 * @param obj The calendar object.
21189 * @param weekdays Array of seven strings to be used as weekday names.
21190 * @warning It must have 7 elements, or it will access invalid memory.
21191 * @warning The strings must be NULL terminated ('@\0').
21193 * By default, weekdays abbreviations get from system are displayed:
21194 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21196 * The first string should be related to Sunday, the second to Monday...
21198 * The usage should be like this:
21200 * const char *weekdays[] =
21202 * "Sunday", "Monday", "Tuesday", "Wednesday",
21203 * "Thursday", "Friday", "Saturday"
21205 * elm_calendar_weekdays_names_set(calendar, weekdays);
21208 * @see elm_calendar_weekdays_name_get()
21210 * @ref calendar_example_02
21212 * @ingroup Calendar
21214 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21217 * Set the minimum and maximum values for the year
21219 * @param obj The calendar object
21220 * @param min The minimum year, greater than 1901;
21221 * @param max The maximum year;
21223 * Maximum must be greater than minimum, except if you don't wan't to set
21225 * Default values are 1902 and -1.
21227 * If the maximum year is a negative value, it will be limited depending
21228 * on the platform architecture (year 2037 for 32 bits);
21230 * @see elm_calendar_min_max_year_get()
21232 * @ref calendar_example_03
21234 * @ingroup Calendar
21236 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21239 * Get the minimum and maximum values for the year
21241 * @param obj The calendar object.
21242 * @param min The minimum year.
21243 * @param max The maximum year.
21245 * Default values are 1902 and -1.
21247 * @see elm_calendar_min_max_year_get() for more details.
21249 * @ref calendar_example_05
21251 * @ingroup Calendar
21253 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21256 * Enable or disable day selection
21258 * @param obj The calendar object.
21259 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21262 * Enabled by default. If disabled, the user still can select months,
21263 * but not days. Selected days are highlighted on calendar.
21264 * It should be used if you won't need such selection for the widget usage.
21266 * When a day is selected, or month is changed, smart callbacks for
21267 * signal "changed" will be called.
21269 * @see elm_calendar_day_selection_enable_get()
21271 * @ref calendar_example_04
21273 * @ingroup Calendar
21275 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21278 * Get a value whether day selection is enabled or not.
21280 * @see elm_calendar_day_selection_enable_set() for details.
21282 * @param obj The calendar object.
21283 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21284 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21286 * @ref calendar_example_05
21288 * @ingroup Calendar
21290 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21294 * Set selected date to be highlighted on calendar.
21296 * @param obj The calendar object.
21297 * @param selected_time A @b tm struct to represent the selected date.
21299 * Set the selected date, changing the displayed month if needed.
21300 * Selected date changes when the user goes to next/previous month or
21301 * select a day pressing over it on calendar.
21303 * @see elm_calendar_selected_time_get()
21305 * @ref calendar_example_04
21307 * @ingroup Calendar
21309 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21312 * Get selected date.
21314 * @param obj The calendar object
21315 * @param selected_time A @b tm struct to point to selected date
21316 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21319 * Get date selected by the user or set by function
21320 * elm_calendar_selected_time_set().
21321 * Selected date changes when the user goes to next/previous month or
21322 * select a day pressing over it on calendar.
21324 * @see elm_calendar_selected_time_get()
21326 * @ref calendar_example_05
21328 * @ingroup Calendar
21330 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21333 * Set a function to format the string that will be used to display
21336 * @param obj The calendar object
21337 * @param format_function Function to set the month-year string given
21338 * the selected date
21340 * By default it uses strftime with "%B %Y" format string.
21341 * It should allocate the memory that will be used by the string,
21342 * that will be freed by the widget after usage.
21343 * A pointer to the string and a pointer to the time struct will be provided.
21348 * _format_month_year(struct tm *selected_time)
21351 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21352 * return strdup(buf);
21355 * elm_calendar_format_function_set(calendar, _format_month_year);
21358 * @ref calendar_example_02
21360 * @ingroup Calendar
21362 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21365 * Add a new mark to the calendar
21367 * @param obj The calendar object
21368 * @param mark_type A string used to define the type of mark. It will be
21369 * emitted to the theme, that should display a related modification on these
21370 * days representation.
21371 * @param mark_time A time struct to represent the date of inclusion of the
21372 * mark. For marks that repeats it will just be displayed after the inclusion
21373 * date in the calendar.
21374 * @param repeat Repeat the event following this periodicity. Can be a unique
21375 * mark (that don't repeat), daily, weekly, monthly or annually.
21376 * @return The created mark or @p NULL upon failure.
21378 * Add a mark that will be drawn in the calendar respecting the insertion
21379 * time and periodicity. It will emit the type as signal to the widget theme.
21380 * Default theme supports "holiday" and "checked", but it can be extended.
21382 * It won't immediately update the calendar, drawing the marks.
21383 * For this, call elm_calendar_marks_draw(). However, when user selects
21384 * next or previous month calendar forces marks drawn.
21386 * Marks created with this method can be deleted with
21387 * elm_calendar_mark_del().
21391 * struct tm selected_time;
21392 * time_t current_time;
21394 * current_time = time(NULL) + 5 * 84600;
21395 * localtime_r(¤t_time, &selected_time);
21396 * elm_calendar_mark_add(cal, "holiday", selected_time,
21397 * ELM_CALENDAR_ANNUALLY);
21399 * current_time = time(NULL) + 1 * 84600;
21400 * localtime_r(¤t_time, &selected_time);
21401 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21403 * elm_calendar_marks_draw(cal);
21406 * @see elm_calendar_marks_draw()
21407 * @see elm_calendar_mark_del()
21409 * @ref calendar_example_06
21411 * @ingroup Calendar
21413 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);
21416 * Delete mark from the calendar.
21418 * @param mark The mark to be deleted.
21420 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21421 * should be used instead of getting marks list and deleting each one.
21423 * @see elm_calendar_mark_add()
21425 * @ref calendar_example_06
21427 * @ingroup Calendar
21429 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21432 * Remove all calendar's marks
21434 * @param obj The calendar object.
21436 * @see elm_calendar_mark_add()
21437 * @see elm_calendar_mark_del()
21439 * @ingroup Calendar
21441 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21445 * Get a list of all the calendar marks.
21447 * @param obj The calendar object.
21448 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21450 * @see elm_calendar_mark_add()
21451 * @see elm_calendar_mark_del()
21452 * @see elm_calendar_marks_clear()
21454 * @ingroup Calendar
21456 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21459 * Draw calendar marks.
21461 * @param obj The calendar object.
21463 * Should be used after adding, removing or clearing marks.
21464 * It will go through the entire marks list updating the calendar.
21465 * If lots of marks will be added, add all the marks and then call
21468 * When the month is changed, i.e. user selects next or previous month,
21469 * marks will be drawed.
21471 * @see elm_calendar_mark_add()
21472 * @see elm_calendar_mark_del()
21473 * @see elm_calendar_marks_clear()
21475 * @ref calendar_example_06
21477 * @ingroup Calendar
21479 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21482 * Set a day text color to the same that represents Saturdays.
21484 * @param obj The calendar object.
21485 * @param pos The text position. Position is the cell counter, from left
21486 * to right, up to down. It starts on 0 and ends on 41.
21488 * @deprecated use elm_calendar_mark_add() instead like:
21491 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21492 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21495 * @see elm_calendar_mark_add()
21497 * @ingroup Calendar
21499 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21502 * Set a day text color to the same that represents Sundays.
21504 * @param obj The calendar object.
21505 * @param pos The text position. Position is the cell counter, from left
21506 * to right, up to down. It starts on 0 and ends on 41.
21508 * @deprecated use elm_calendar_mark_add() instead like:
21511 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21512 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21515 * @see elm_calendar_mark_add()
21517 * @ingroup Calendar
21519 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21522 * Set a day text color to the same that represents Weekdays.
21524 * @param obj The calendar object
21525 * @param pos The text position. Position is the cell counter, from left
21526 * to right, up to down. It starts on 0 and ends on 41.
21528 * @deprecated use elm_calendar_mark_add() instead like:
21531 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21533 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21534 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21535 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21536 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21537 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21538 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21539 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21540 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21541 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21544 * @see elm_calendar_mark_add()
21546 * @ingroup Calendar
21548 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21551 * Set the interval on time updates for an user mouse button hold
21552 * on calendar widgets' month selection.
21554 * @param obj The calendar object
21555 * @param interval The (first) interval value in seconds
21557 * This interval value is @b decreased while the user holds the
21558 * mouse pointer either selecting next or previous month.
21560 * This helps the user to get to a given month distant from the
21561 * current one easier/faster, as it will start to change quicker and
21562 * quicker on mouse button holds.
21564 * The calculation for the next change interval value, starting from
21565 * the one set with this call, is the previous interval divided by
21566 * 1.05, so it decreases a little bit.
21568 * The default starting interval value for automatic changes is
21571 * @see elm_calendar_interval_get()
21573 * @ingroup Calendar
21575 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21578 * Get the interval on time updates for an user mouse button hold
21579 * on calendar widgets' month selection.
21581 * @param obj The calendar object
21582 * @return The (first) interval value, in seconds, set on it
21584 * @see elm_calendar_interval_set() for more details
21586 * @ingroup Calendar
21588 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21595 * @defgroup Diskselector Diskselector
21596 * @ingroup Elementary
21598 * @image html img/widget/diskselector/preview-00.png
21599 * @image latex img/widget/diskselector/preview-00.eps
21601 * A diskselector is a kind of list widget. It scrolls horizontally,
21602 * and can contain label and icon objects. Three items are displayed
21603 * with the selected one in the middle.
21605 * It can act like a circular list with round mode and labels can be
21606 * reduced for a defined length for side items.
21608 * Smart callbacks one can listen to:
21609 * - "selected" - when item is selected, i.e. scroller stops.
21611 * Available styles for it:
21614 * List of examples:
21615 * @li @ref diskselector_example_01
21616 * @li @ref diskselector_example_02
21620 * @addtogroup Diskselector
21624 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(). */
21627 * Add a new diskselector widget to the given parent Elementary
21628 * (container) object.
21630 * @param parent The parent object.
21631 * @return a new diskselector widget handle or @c NULL, on errors.
21633 * This function inserts a new diskselector widget on the canvas.
21635 * @ingroup Diskselector
21637 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21640 * Enable or disable round mode.
21642 * @param obj The diskselector object.
21643 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21646 * Disabled by default. If round mode is enabled the items list will
21647 * work like a circle list, so when the user reaches the last item,
21648 * the first one will popup.
21650 * @see elm_diskselector_round_get()
21652 * @ingroup Diskselector
21654 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21657 * Get a value whether round mode is enabled or not.
21659 * @see elm_diskselector_round_set() for details.
21661 * @param obj The diskselector object.
21662 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21663 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21665 * @ingroup Diskselector
21667 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21670 * Get the side labels max length.
21672 * @deprecated use elm_diskselector_side_label_length_get() instead:
21674 * @param obj The diskselector object.
21675 * @return The max length defined for side labels, or 0 if not a valid
21678 * @ingroup Diskselector
21680 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21683 * Set the side labels max length.
21685 * @deprecated use elm_diskselector_side_label_length_set() instead:
21687 * @param obj The diskselector object.
21688 * @param len The max length defined for side labels.
21690 * @ingroup Diskselector
21692 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21695 * Get the side labels max length.
21697 * @see elm_diskselector_side_label_length_set() for details.
21699 * @param obj The diskselector object.
21700 * @return The max length defined for side labels, or 0 if not a valid
21703 * @ingroup Diskselector
21705 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21708 * Set the side labels max length.
21710 * @param obj The diskselector object.
21711 * @param len The max length defined for side labels.
21713 * Length is the number of characters of items' label that will be
21714 * visible when it's set on side positions. It will just crop
21715 * the string after defined size. E.g.:
21717 * An item with label "January" would be displayed on side position as
21718 * "Jan" if max length is set to 3, or "Janu", if this property
21721 * When it's selected, the entire label will be displayed, except for
21722 * width restrictions. In this case label will be cropped and "..."
21723 * will be concatenated.
21725 * Default side label max length is 3.
21727 * This property will be applyed over all items, included before or
21728 * later this function call.
21730 * @ingroup Diskselector
21732 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21735 * Set the number of items to be displayed.
21737 * @param obj The diskselector object.
21738 * @param num The number of items the diskselector will display.
21740 * Default value is 3, and also it's the minimun. If @p num is less
21741 * than 3, it will be set to 3.
21743 * Also, it can be set on theme, using data item @c display_item_num
21744 * on group "elm/diskselector/item/X", where X is style set.
21747 * group { name: "elm/diskselector/item/X";
21749 * item: "display_item_num" "5";
21752 * @ingroup Diskselector
21754 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21757 * Set bouncing behaviour when the scrolled content reaches an edge.
21759 * Tell the internal scroller object whether it should bounce or not
21760 * when it reaches the respective edges for each axis.
21762 * @param obj The diskselector object.
21763 * @param h_bounce Whether to bounce or not in the horizontal axis.
21764 * @param v_bounce Whether to bounce or not in the vertical axis.
21766 * @see elm_scroller_bounce_set()
21768 * @ingroup Diskselector
21770 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21773 * Get the bouncing behaviour of the internal scroller.
21775 * Get whether the internal scroller should bounce when the edge of each
21776 * axis is reached scrolling.
21778 * @param obj The diskselector object.
21779 * @param h_bounce Pointer where to store the bounce state of the horizontal
21781 * @param v_bounce Pointer where to store the bounce state of the vertical
21784 * @see elm_scroller_bounce_get()
21785 * @see elm_diskselector_bounce_set()
21787 * @ingroup Diskselector
21789 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21792 * Get the scrollbar policy.
21794 * @see elm_diskselector_scroller_policy_get() for details.
21796 * @param obj The diskselector object.
21797 * @param policy_h Pointer where to store horizontal scrollbar policy.
21798 * @param policy_v Pointer where to store vertical scrollbar policy.
21800 * @ingroup Diskselector
21802 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);
21805 * Set the scrollbar policy.
21807 * @param obj The diskselector object.
21808 * @param policy_h Horizontal scrollbar policy.
21809 * @param policy_v Vertical scrollbar policy.
21811 * This sets the scrollbar visibility policy for the given scroller.
21812 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
21813 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
21814 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
21815 * This applies respectively for the horizontal and vertical scrollbars.
21817 * The both are disabled by default, i.e., are set to
21818 * #ELM_SCROLLER_POLICY_OFF.
21820 * @ingroup Diskselector
21822 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
21825 * Remove all diskselector's items.
21827 * @param obj The diskselector object.
21829 * @see elm_diskselector_item_del()
21830 * @see elm_diskselector_item_append()
21832 * @ingroup Diskselector
21834 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21837 * Get a list of all the diskselector items.
21839 * @param obj The diskselector object.
21840 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
21841 * or @c NULL on failure.
21843 * @see elm_diskselector_item_append()
21844 * @see elm_diskselector_item_del()
21845 * @see elm_diskselector_clear()
21847 * @ingroup Diskselector
21849 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21852 * Appends a new item to the diskselector object.
21854 * @param obj The diskselector object.
21855 * @param label The label of the diskselector item.
21856 * @param icon The icon object to use at left side of the item. An
21857 * icon can be any Evas object, but usually it is an icon created
21858 * with elm_icon_add().
21859 * @param func The function to call when the item is selected.
21860 * @param data The data to associate with the item for related callbacks.
21862 * @return The created item or @c NULL upon failure.
21864 * A new item will be created and appended to the diskselector, i.e., will
21865 * be set as last item. Also, if there is no selected item, it will
21866 * be selected. This will always happens for the first appended item.
21868 * If no icon is set, label will be centered on item position, otherwise
21869 * the icon will be placed at left of the label, that will be shifted
21872 * Items created with this method can be deleted with
21873 * elm_diskselector_item_del().
21875 * Associated @p data can be properly freed when item is deleted if a
21876 * callback function is set with elm_diskselector_item_del_cb_set().
21878 * If a function is passed as argument, it will be called everytime this item
21879 * is selected, i.e., the user stops the diskselector with this
21880 * item on center position. If such function isn't needed, just passing
21881 * @c NULL as @p func is enough. The same should be done for @p data.
21883 * Simple example (with no function callback or data associated):
21885 * disk = elm_diskselector_add(win);
21886 * ic = elm_icon_add(win);
21887 * elm_icon_file_set(ic, "path/to/image", NULL);
21888 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
21889 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
21892 * @see elm_diskselector_item_del()
21893 * @see elm_diskselector_item_del_cb_set()
21894 * @see elm_diskselector_clear()
21895 * @see elm_icon_add()
21897 * @ingroup Diskselector
21899 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);
21903 * Delete them item from the diskselector.
21905 * @param it The item of diskselector to be deleted.
21907 * If deleting all diskselector items is required, elm_diskselector_clear()
21908 * should be used instead of getting items list and deleting each one.
21910 * @see elm_diskselector_clear()
21911 * @see elm_diskselector_item_append()
21912 * @see elm_diskselector_item_del_cb_set()
21914 * @ingroup Diskselector
21916 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21919 * Set the function called when a diskselector item is freed.
21921 * @param it The item to set the callback on
21922 * @param func The function called
21924 * If there is a @p func, then it will be called prior item's memory release.
21925 * That will be called with the following arguments:
21927 * @li item's Evas object;
21930 * This way, a data associated to a diskselector item could be properly
21933 * @ingroup Diskselector
21935 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21938 * Get the data associated to the item.
21940 * @param it The diskselector item
21941 * @return The data associated to @p it
21943 * The return value is a pointer to data associated to @p item when it was
21944 * created, with function elm_diskselector_item_append(). If no data
21945 * was passed as argument, it will return @c NULL.
21947 * @see elm_diskselector_item_append()
21949 * @ingroup Diskselector
21951 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21954 * Set the icon associated to the item.
21956 * @param it The diskselector item
21957 * @param icon The icon object to associate with @p it
21959 * The icon object to use at left side of the item. An
21960 * icon can be any Evas object, but usually it is an icon created
21961 * with elm_icon_add().
21963 * Once the icon object is set, a previously set one will be deleted.
21964 * @warning Setting the same icon for two items will cause the icon to
21965 * dissapear from the first item.
21967 * If an icon was passed as argument on item creation, with function
21968 * elm_diskselector_item_append(), it will be already
21969 * associated to the item.
21971 * @see elm_diskselector_item_append()
21972 * @see elm_diskselector_item_icon_get()
21974 * @ingroup Diskselector
21976 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
21979 * Get the icon associated to the item.
21981 * @param it The diskselector item
21982 * @return The icon associated to @p it
21984 * The return value is a pointer to the icon associated to @p item when it was
21985 * created, with function elm_diskselector_item_append(), or later
21986 * with function elm_diskselector_item_icon_set. If no icon
21987 * was passed as argument, it will return @c NULL.
21989 * @see elm_diskselector_item_append()
21990 * @see elm_diskselector_item_icon_set()
21992 * @ingroup Diskselector
21994 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
21997 * Set the label of item.
21999 * @param it The item of diskselector.
22000 * @param label The label of item.
22002 * The label to be displayed by the item.
22004 * If no icon is set, label will be centered on item position, otherwise
22005 * the icon will be placed at left of the label, that will be shifted
22008 * An item with label "January" would be displayed on side position as
22009 * "Jan" if max length is set to 3 with function
22010 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22013 * When this @p item is selected, the entire label will be displayed,
22014 * except for width restrictions.
22015 * In this case label will be cropped and "..." will be concatenated,
22016 * but only for display purposes. It will keep the entire string, so
22017 * if diskselector is resized the remaining characters will be displayed.
22019 * If a label was passed as argument on item creation, with function
22020 * elm_diskselector_item_append(), it will be already
22021 * displayed by the item.
22023 * @see elm_diskselector_side_label_lenght_set()
22024 * @see elm_diskselector_item_label_get()
22025 * @see elm_diskselector_item_append()
22027 * @ingroup Diskselector
22029 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22032 * Get the label of item.
22034 * @param it The item of diskselector.
22035 * @return The label of item.
22037 * The return value is a pointer to the label associated to @p item when it was
22038 * created, with function elm_diskselector_item_append(), or later
22039 * with function elm_diskselector_item_label_set. If no label
22040 * was passed as argument, it will return @c NULL.
22042 * @see elm_diskselector_item_label_set() for more details.
22043 * @see elm_diskselector_item_append()
22045 * @ingroup Diskselector
22047 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22050 * Get the selected item.
22052 * @param obj The diskselector object.
22053 * @return The selected diskselector item.
22055 * The selected item can be unselected with function
22056 * elm_diskselector_item_selected_set(), and the first item of
22057 * diskselector will be selected.
22059 * The selected item always will be centered on diskselector, with
22060 * full label displayed, i.e., max lenght set to side labels won't
22061 * apply on the selected item. More details on
22062 * elm_diskselector_side_label_length_set().
22064 * @ingroup Diskselector
22066 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22069 * Set the selected state of an item.
22071 * @param it The diskselector item
22072 * @param selected The selected state
22074 * This sets the selected state of the given item @p it.
22075 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22077 * If a new item is selected the previosly selected will be unselected.
22078 * Previoulsy selected item can be get with function
22079 * elm_diskselector_selected_item_get().
22081 * If the item @p it is unselected, the first item of diskselector will
22084 * Selected items will be visible on center position of diskselector.
22085 * So if it was on another position before selected, or was invisible,
22086 * diskselector will animate items until the selected item reaches center
22089 * @see elm_diskselector_item_selected_get()
22090 * @see elm_diskselector_selected_item_get()
22092 * @ingroup Diskselector
22094 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22097 * Get whether the @p item is selected or not.
22099 * @param it The diskselector item.
22100 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22101 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22103 * @see elm_diskselector_selected_item_set() for details.
22104 * @see elm_diskselector_item_selected_get()
22106 * @ingroup Diskselector
22108 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22111 * Get the first item of the diskselector.
22113 * @param obj The diskselector object.
22114 * @return The first item, or @c NULL if none.
22116 * The list of items follows append order. So it will return the first
22117 * item appended to the widget that wasn't deleted.
22119 * @see elm_diskselector_item_append()
22120 * @see elm_diskselector_items_get()
22122 * @ingroup Diskselector
22124 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22127 * Get the last item of the diskselector.
22129 * @param obj The diskselector object.
22130 * @return The last item, or @c NULL if none.
22132 * The list of items follows append order. So it will return last first
22133 * item appended to the widget that wasn't deleted.
22135 * @see elm_diskselector_item_append()
22136 * @see elm_diskselector_items_get()
22138 * @ingroup Diskselector
22140 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22143 * Get the item before @p item in diskselector.
22145 * @param it The diskselector item.
22146 * @return The item before @p item, or @c NULL if none or on failure.
22148 * The list of items follows append order. So it will return item appended
22149 * just before @p item and that wasn't deleted.
22151 * If it is the first item, @c NULL will be returned.
22152 * First item can be get by elm_diskselector_first_item_get().
22154 * @see elm_diskselector_item_append()
22155 * @see elm_diskselector_items_get()
22157 * @ingroup Diskselector
22159 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22162 * Get the item after @p item in diskselector.
22164 * @param it The diskselector item.
22165 * @return The item after @p item, or @c NULL if none or on failure.
22167 * The list of items follows append order. So it will return item appended
22168 * just after @p item and that wasn't deleted.
22170 * If it is the last item, @c NULL will be returned.
22171 * Last item can be get by elm_diskselector_last_item_get().
22173 * @see elm_diskselector_item_append()
22174 * @see elm_diskselector_items_get()
22176 * @ingroup Diskselector
22178 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22181 * Set the text to be shown in the diskselector item.
22183 * @param item Target item
22184 * @param text The text to set in the content
22186 * Setup the text as tooltip to object. The item can have only one tooltip,
22187 * so any previous tooltip data is removed.
22189 * @see elm_object_tooltip_text_set() for more details.
22191 * @ingroup Diskselector
22193 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22196 * Set the content to be shown in the tooltip item.
22198 * Setup the tooltip to item. The item can have only one tooltip,
22199 * so any previous tooltip data is removed. @p func(with @p data) will
22200 * be called every time that need show the tooltip and it should
22201 * return a valid Evas_Object. This object is then managed fully by
22202 * tooltip system and is deleted when the tooltip is gone.
22204 * @param item the diskselector item being attached a tooltip.
22205 * @param func the function used to create the tooltip contents.
22206 * @param data what to provide to @a func as callback data/context.
22207 * @param del_cb called when data is not needed anymore, either when
22208 * another callback replaces @p func, the tooltip is unset with
22209 * elm_diskselector_item_tooltip_unset() or the owner @a item
22210 * dies. This callback receives as the first parameter the
22211 * given @a data, and @c event_info is the item.
22213 * @see elm_object_tooltip_content_cb_set() for more details.
22215 * @ingroup Diskselector
22217 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);
22220 * Unset tooltip from item.
22222 * @param item diskselector item to remove previously set tooltip.
22224 * Remove tooltip from item. The callback provided as del_cb to
22225 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22226 * it is not used anymore.
22228 * @see elm_object_tooltip_unset() for more details.
22229 * @see elm_diskselector_item_tooltip_content_cb_set()
22231 * @ingroup Diskselector
22233 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22237 * Sets a different style for this item tooltip.
22239 * @note before you set a style you should define a tooltip with
22240 * elm_diskselector_item_tooltip_content_cb_set() or
22241 * elm_diskselector_item_tooltip_text_set()
22243 * @param item diskselector item with tooltip already set.
22244 * @param style the theme style to use (default, transparent, ...)
22246 * @see elm_object_tooltip_style_set() for more details.
22248 * @ingroup Diskselector
22250 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22253 * Get the style for this item tooltip.
22255 * @param item diskselector item with tooltip already set.
22256 * @return style the theme style in use, defaults to "default". If the
22257 * object does not have a tooltip set, then NULL is returned.
22259 * @see elm_object_tooltip_style_get() for more details.
22260 * @see elm_diskselector_item_tooltip_style_set()
22262 * @ingroup Diskselector
22264 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22267 * Set the cursor to be shown when mouse is over the diskselector item
22269 * @param item Target item
22270 * @param cursor the cursor name to be used.
22272 * @see elm_object_cursor_set() for more details.
22274 * @ingroup Diskselector
22276 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22279 * Get the cursor to be shown when mouse is over the diskselector item
22281 * @param item diskselector item with cursor already set.
22282 * @return the cursor name.
22284 * @see elm_object_cursor_get() for more details.
22285 * @see elm_diskselector_cursor_set()
22287 * @ingroup Diskselector
22289 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22293 * Unset the cursor to be shown when mouse is over the diskselector item
22295 * @param item Target item
22297 * @see elm_object_cursor_unset() for more details.
22298 * @see elm_diskselector_cursor_set()
22300 * @ingroup Diskselector
22302 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22305 * Sets a different style for this item cursor.
22307 * @note before you set a style you should define a cursor with
22308 * elm_diskselector_item_cursor_set()
22310 * @param item diskselector item with cursor already set.
22311 * @param style the theme style to use (default, transparent, ...)
22313 * @see elm_object_cursor_style_set() for more details.
22315 * @ingroup Diskselector
22317 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22321 * Get the style for this item cursor.
22323 * @param item diskselector item with cursor already set.
22324 * @return style the theme style in use, defaults to "default". If the
22325 * object does not have a cursor set, then @c NULL is returned.
22327 * @see elm_object_cursor_style_get() for more details.
22328 * @see elm_diskselector_item_cursor_style_set()
22330 * @ingroup Diskselector
22332 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22336 * Set if the cursor set should be searched on the theme or should use
22337 * the provided by the engine, only.
22339 * @note before you set if should look on theme you should define a cursor
22340 * with elm_diskselector_item_cursor_set().
22341 * By default it will only look for cursors provided by the engine.
22343 * @param item widget item with cursor already set.
22344 * @param engine_only boolean to define if cursors set with
22345 * elm_diskselector_item_cursor_set() should be searched only
22346 * between cursors provided by the engine or searched on widget's
22349 * @see elm_object_cursor_engine_only_set() for more details.
22351 * @ingroup Diskselector
22353 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22356 * Get the cursor engine only usage for this item cursor.
22358 * @param item widget item with cursor already set.
22359 * @return engine_only boolean to define it cursors should be looked only
22360 * between the provided by the engine or searched on widget's theme as well.
22361 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22363 * @see elm_object_cursor_engine_only_get() for more details.
22364 * @see elm_diskselector_item_cursor_engine_only_set()
22366 * @ingroup Diskselector
22368 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22375 * @defgroup Colorselector Colorselector
22379 * @image html img/widget/colorselector/preview-00.png
22380 * @image latex img/widget/colorselector/preview-00.eps
22382 * @brief Widget for user to select a color.
22384 * Signals that you can add callbacks for are:
22385 * "changed" - When the color value changes(event_info is NULL).
22387 * See @ref tutorial_colorselector.
22390 * @brief Add a new colorselector to the parent
22392 * @param parent The parent object
22393 * @return The new object or NULL if it cannot be created
22395 * @ingroup Colorselector
22397 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22399 * Set a color for the colorselector
22401 * @param obj Colorselector object
22402 * @param r r-value of color
22403 * @param g g-value of color
22404 * @param b b-value of color
22405 * @param a a-value of color
22407 * @ingroup Colorselector
22409 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22411 * Get a color from the colorselector
22413 * @param obj Colorselector object
22414 * @param r integer pointer for r-value of color
22415 * @param g integer pointer for g-value of color
22416 * @param b integer pointer for b-value of color
22417 * @param a integer pointer for a-value of color
22419 * @ingroup Colorselector
22421 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22427 * @defgroup Ctxpopup Ctxpopup
22429 * @image html img/widget/ctxpopup/preview-00.png
22430 * @image latex img/widget/ctxpopup/preview-00.eps
22432 * @brief Context popup widet.
22434 * A ctxpopup is a widget that, when shown, pops up a list of items.
22435 * It automatically chooses an area inside its parent object's view
22436 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22437 * optimally fit into it. In the default theme, it will also point an
22438 * arrow to it's top left position at the time one shows it. Ctxpopup
22439 * items have a label and/or an icon. It is intended for a small
22440 * number of items (hence the use of list, not genlist).
22442 * @note Ctxpopup is a especialization of @ref Hover.
22444 * Signals that you can add callbacks for are:
22445 * "dismissed" - the ctxpopup was dismissed
22447 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22450 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22452 typedef enum _Elm_Ctxpopup_Direction
22454 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22456 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22457 the clicked area */
22458 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22459 the clicked area */
22460 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22462 } Elm_Ctxpopup_Direction;
22465 * @brief Add a new Ctxpopup object to the parent.
22467 * @param parent Parent object
22468 * @return New object or @c NULL, if it cannot be created
22470 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22472 * @brief Set the Ctxpopup's parent
22474 * @param obj The ctxpopup object
22475 * @param area The parent to use
22477 * Set the parent object.
22479 * @note elm_ctxpopup_add() will automatically call this function
22480 * with its @c parent argument.
22482 * @see elm_ctxpopup_add()
22483 * @see elm_hover_parent_set()
22485 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22487 * @brief Get the Ctxpopup's parent
22489 * @param obj The ctxpopup object
22491 * @see elm_ctxpopup_hover_parent_set() for more information
22493 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22495 * @brief Clear all items in the given ctxpopup object.
22497 * @param obj Ctxpopup object
22499 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22501 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22503 * @param obj Ctxpopup object
22504 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22506 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22508 * @brief Get the value of current ctxpopup object's orientation.
22510 * @param obj Ctxpopup object
22511 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22513 * @see elm_ctxpopup_horizontal_set()
22515 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22517 * @brief Add a new item to a ctxpopup object.
22519 * @param obj Ctxpopup object
22520 * @param icon Icon to be set on new item
22521 * @param label The Label of the new item
22522 * @param func Convenience function called when item selected
22523 * @param data Data passed to @p func
22524 * @return A handle to the item added or @c NULL, on errors
22526 * @warning Ctxpopup can't hold both an item list and a content at the same
22527 * time. When an item is added, any previous content will be removed.
22529 * @see elm_ctxpopup_content_set()
22531 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);
22533 * @brief Delete the given item in a ctxpopup object.
22535 * @param item Ctxpopup item to be deleted
22537 * @see elm_ctxpopup_item_append()
22539 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22541 * @brief Set the ctxpopup item's state as disabled or enabled.
22543 * @param item Ctxpopup item to be enabled/disabled
22544 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22546 * When disabled the item is greyed out to indicate it's state.
22548 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22550 * @brief Get the ctxpopup item's disabled/enabled state.
22552 * @param item Ctxpopup item to be enabled/disabled
22553 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22555 * @see elm_ctxpopup_item_disabled_set()
22557 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22559 * @brief Get the icon object for the given ctxpopup item.
22561 * @param item Ctxpopup item
22562 * @return icon object or @c NULL, if the item does not have icon or an error
22565 * @see elm_ctxpopup_item_append()
22566 * @see elm_ctxpopup_item_icon_set()
22568 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22570 * @brief Sets the side icon associated with the ctxpopup item
22572 * @param item Ctxpopup item
22573 * @param icon Icon object to be set
22575 * Once the icon object is set, a previously set one will be deleted.
22576 * @warning Setting the same icon for two items will cause the icon to
22577 * dissapear from the first item.
22579 * @see elm_ctxpopup_item_append()
22581 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22583 * @brief Get the label for the given ctxpopup item.
22585 * @param item Ctxpopup item
22586 * @return label string or @c NULL, if the item does not have label or an
22589 * @see elm_ctxpopup_item_append()
22590 * @see elm_ctxpopup_item_label_set()
22592 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22594 * @brief (Re)set the label on the given ctxpopup item.
22596 * @param item Ctxpopup item
22597 * @param label String to set as label
22599 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22601 * @brief Set an elm widget as the content of the ctxpopup.
22603 * @param obj Ctxpopup object
22604 * @param content Content to be swallowed
22606 * If the content object is already set, a previous one will bedeleted. If
22607 * you want to keep that old content object, use the
22608 * elm_ctxpopup_content_unset() function.
22610 * @deprecated use elm_object_content_set()
22612 * @warning Ctxpopup can't hold both a item list and a content at the same
22613 * time. When a content is set, any previous items will be removed.
22615 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22617 * @brief Unset the ctxpopup content
22619 * @param obj Ctxpopup object
22620 * @return The content that was being used
22622 * Unparent and return the content object which was set for this widget.
22624 * @deprecated use elm_object_content_unset()
22626 * @see elm_ctxpopup_content_set()
22628 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22630 * @brief Set the direction priority of a ctxpopup.
22632 * @param obj Ctxpopup object
22633 * @param first 1st priority of direction
22634 * @param second 2nd priority of direction
22635 * @param third 3th priority of direction
22636 * @param fourth 4th priority of direction
22638 * This functions gives a chance to user to set the priority of ctxpopup
22639 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22640 * requested direction.
22642 * @see Elm_Ctxpopup_Direction
22644 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);
22646 * @brief Get the direction priority of a ctxpopup.
22648 * @param obj Ctxpopup object
22649 * @param first 1st priority of direction to be returned
22650 * @param second 2nd priority of direction to be returned
22651 * @param third 3th priority of direction to be returned
22652 * @param fourth 4th priority of direction to be returned
22654 * @see elm_ctxpopup_direction_priority_set() for more information.
22656 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);
22664 * @defgroup Transit Transit
22665 * @ingroup Elementary
22667 * Transit is designed to apply various animated transition effects to @c
22668 * Evas_Object, such like translation, rotation, etc. For using these
22669 * effects, create an @ref Elm_Transit and add the desired transition effects.
22671 * Once the effects are added into transit, they will be automatically
22672 * managed (their callback will be called until the duration is ended, and
22673 * they will be deleted on completion).
22677 * Elm_Transit *trans = elm_transit_add();
22678 * elm_transit_object_add(trans, obj);
22679 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22680 * elm_transit_duration_set(transit, 1);
22681 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22682 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22683 * elm_transit_repeat_times_set(transit, 3);
22686 * Some transition effects are used to change the properties of objects. They
22688 * @li @ref elm_transit_effect_translation_add
22689 * @li @ref elm_transit_effect_color_add
22690 * @li @ref elm_transit_effect_rotation_add
22691 * @li @ref elm_transit_effect_wipe_add
22692 * @li @ref elm_transit_effect_zoom_add
22693 * @li @ref elm_transit_effect_resizing_add
22695 * Other transition effects are used to make one object disappear and another
22696 * object appear on its old place. These effects are:
22698 * @li @ref elm_transit_effect_flip_add
22699 * @li @ref elm_transit_effect_resizable_flip_add
22700 * @li @ref elm_transit_effect_fade_add
22701 * @li @ref elm_transit_effect_blend_add
22703 * It's also possible to make a transition chain with @ref
22704 * elm_transit_chain_transit_add.
22706 * @warning We strongly recommend to use elm_transit just when edje can not do
22707 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22708 * animations can be manipulated inside the theme.
22710 * List of examples:
22711 * @li @ref transit_example_01_explained
22712 * @li @ref transit_example_02_explained
22713 * @li @ref transit_example_03_c
22714 * @li @ref transit_example_04_c
22720 * @enum Elm_Transit_Tween_Mode
22722 * The type of acceleration used in the transition.
22726 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22727 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22728 over time, then decrease again
22730 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22732 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22734 } Elm_Transit_Tween_Mode;
22737 * @enum Elm_Transit_Effect_Flip_Axis
22739 * The axis where flip effect should be applied.
22743 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22744 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22745 } Elm_Transit_Effect_Flip_Axis;
22747 * @enum Elm_Transit_Effect_Wipe_Dir
22749 * The direction where the wipe effect should occur.
22753 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22754 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22755 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22756 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22757 } Elm_Transit_Effect_Wipe_Dir;
22758 /** @enum Elm_Transit_Effect_Wipe_Type
22760 * Whether the wipe effect should show or hide the object.
22764 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22766 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22768 } Elm_Transit_Effect_Wipe_Type;
22771 * @typedef Elm_Transit
22773 * The Transit created with elm_transit_add(). This type has the information
22774 * about the objects which the transition will be applied, and the
22775 * transition effects that will be used. It also contains info about
22776 * duration, number of repetitions, auto-reverse, etc.
22778 typedef struct _Elm_Transit Elm_Transit;
22779 typedef void Elm_Transit_Effect;
22781 * @typedef Elm_Transit_Effect_Transition_Cb
22783 * Transition callback called for this effect on each transition iteration.
22785 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
22787 * Elm_Transit_Effect_End_Cb
22789 * Transition callback called for this effect when the transition is over.
22791 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
22794 * Elm_Transit_Del_Cb
22796 * A callback called when the transit is deleted.
22798 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
22803 * @note Is not necessary to delete the transit object, it will be deleted at
22804 * the end of its operation.
22805 * @note The transit will start playing when the program enter in the main loop, is not
22806 * necessary to give a start to the transit.
22808 * @return The transit object.
22812 EAPI Elm_Transit *elm_transit_add(void);
22815 * Stops the animation and delete the @p transit object.
22817 * Call this function if you wants to stop the animation before the duration
22818 * time. Make sure the @p transit object is still alive with
22819 * elm_transit_del_cb_set() function.
22820 * All added effects will be deleted, calling its repective data_free_cb
22821 * functions. The function setted by elm_transit_del_cb_set() will be called.
22823 * @see elm_transit_del_cb_set()
22825 * @param transit The transit object to be deleted.
22828 * @warning Just call this function if you are sure the transit is alive.
22830 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
22833 * Add a new effect to the transit.
22835 * @note The cb function and the data are the key to the effect. If you try to
22836 * add an already added effect, nothing is done.
22837 * @note After the first addition of an effect in @p transit, if its
22838 * effect list become empty again, the @p transit will be killed by
22839 * elm_transit_del(transit) function.
22843 * Elm_Transit *transit = elm_transit_add();
22844 * elm_transit_effect_add(transit,
22845 * elm_transit_effect_blend_op,
22846 * elm_transit_effect_blend_context_new(),
22847 * elm_transit_effect_blend_context_free);
22850 * @param transit The transit object.
22851 * @param transition_cb The operation function. It is called when the
22852 * animation begins, it is the function that actually performs the animation.
22853 * It is called with the @p data, @p transit and the time progression of the
22854 * animation (a double value between 0.0 and 1.0).
22855 * @param effect The context data of the effect.
22856 * @param end_cb The function to free the context data, it will be called
22857 * at the end of the effect, it must finalize the animation and free the
22861 * @warning The transit free the context data at the and of the transition with
22862 * the data_free_cb function, do not use the context data in another transit.
22864 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);
22867 * Delete an added effect.
22869 * This function will remove the effect from the @p transit, calling the
22870 * data_free_cb to free the @p data.
22872 * @see elm_transit_effect_add()
22874 * @note If the effect is not found, nothing is done.
22875 * @note If the effect list become empty, this function will call
22876 * elm_transit_del(transit), that is, it will kill the @p transit.
22878 * @param transit The transit object.
22879 * @param transition_cb The operation function.
22880 * @param effect The context data of the effect.
22884 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);
22887 * Add new object to apply the effects.
22889 * @note After the first addition of an object in @p transit, if its
22890 * object list become empty again, the @p transit will be killed by
22891 * elm_transit_del(transit) function.
22892 * @note If the @p obj belongs to another transit, the @p obj will be
22893 * removed from it and it will only belong to the @p transit. If the old
22894 * transit stays without objects, it will die.
22895 * @note When you add an object into the @p transit, its state from
22896 * evas_object_pass_events_get(obj) is saved, and it is applied when the
22897 * transit ends, if you change this state whith evas_object_pass_events_set()
22898 * after add the object, this state will change again when @p transit stops to
22901 * @param transit The transit object.
22902 * @param obj Object to be animated.
22905 * @warning It is not allowed to add a new object after transit begins to go.
22907 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
22910 * Removes an added object from the transit.
22912 * @note If the @p obj is not in the @p transit, nothing is done.
22913 * @note If the list become empty, this function will call
22914 * elm_transit_del(transit), that is, it will kill the @p transit.
22916 * @param transit The transit object.
22917 * @param obj Object to be removed from @p transit.
22920 * @warning It is not allowed to remove objects after transit begins to go.
22922 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
22925 * Get the objects of the transit.
22927 * @param transit The transit object.
22928 * @return a Eina_List with the objects from the transit.
22932 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
22935 * Enable/disable keeping up the objects states.
22936 * If it is not kept, the objects states will be reset when transition ends.
22938 * @note @p transit can not be NULL.
22939 * @note One state includes geometry, color, map data.
22941 * @param transit The transit object.
22942 * @param state_keep Keeping or Non Keeping.
22946 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
22949 * Get a value whether the objects states will be reset or not.
22951 * @note @p transit can not be NULL
22953 * @see elm_transit_objects_final_state_keep_set()
22955 * @param transit The transit object.
22956 * @return EINA_TRUE means the states of the objects will be reset.
22957 * If @p transit is NULL, EINA_FALSE is returned
22961 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
22964 * Set the event enabled when transit is operating.
22966 * If @p enabled is EINA_TRUE, the objects of the transit will receives
22967 * events from mouse and keyboard during the animation.
22968 * @note When you add an object with elm_transit_object_add(), its state from
22969 * evas_object_pass_events_get(obj) is saved, and it is applied when the
22970 * transit ends, if you change this state with evas_object_pass_events_set()
22971 * after adding the object, this state will change again when @p transit stops
22974 * @param transit The transit object.
22975 * @param enabled Events are received when enabled is @c EINA_TRUE, and
22976 * ignored otherwise.
22980 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22983 * Get the value of event enabled status.
22985 * @see elm_transit_event_enabled_set()
22987 * @param transit The Transit object
22988 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
22989 * EINA_FALSE is returned
22993 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
22996 * Set the user-callback function when the transit is deleted.
22998 * @note Using this function twice will overwrite the first function setted.
22999 * @note the @p transit object will be deleted after call @p cb function.
23001 * @param transit The transit object.
23002 * @param cb Callback function pointer. This function will be called before
23003 * the deletion of the transit.
23004 * @param data Callback funtion user data. It is the @p op parameter.
23008 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23011 * Set reverse effect automatically.
23013 * If auto reverse is setted, after running the effects with the progress
23014 * parameter from 0 to 1, it will call the effecs again with the progress
23015 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23016 * where the duration was setted with the function elm_transit_add and
23017 * the repeat with the function elm_transit_repeat_times_set().
23019 * @param transit The transit object.
23020 * @param reverse EINA_TRUE means the auto_reverse is on.
23024 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23027 * Get if the auto reverse is on.
23029 * @see elm_transit_auto_reverse_set()
23031 * @param transit The transit object.
23032 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23033 * EINA_FALSE is returned
23037 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23040 * Set the transit repeat count. Effect will be repeated by repeat count.
23042 * This function sets the number of repetition the transit will run after
23043 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23044 * If the @p repeat is a negative number, it will repeat infinite times.
23046 * @note If this function is called during the transit execution, the transit
23047 * will run @p repeat times, ignoring the times it already performed.
23049 * @param transit The transit object
23050 * @param repeat Repeat count
23054 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23057 * Get the transit repeat count.
23059 * @see elm_transit_repeat_times_set()
23061 * @param transit The Transit object.
23062 * @return The repeat count. If @p transit is NULL
23067 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23070 * Set the transit animation acceleration type.
23072 * This function sets the tween mode of the transit that can be:
23073 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23074 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23075 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23076 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23078 * @param transit The transit object.
23079 * @param tween_mode The tween type.
23083 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23086 * Get the transit animation acceleration type.
23088 * @note @p transit can not be NULL
23090 * @param transit The transit object.
23091 * @return The tween type. If @p transit is NULL
23092 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23096 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23099 * Set the transit animation time
23101 * @note @p transit can not be NULL
23103 * @param transit The transit object.
23104 * @param duration The animation time.
23108 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23111 * Get the transit animation time
23113 * @note @p transit can not be NULL
23115 * @param transit The transit object.
23117 * @return The transit animation time.
23121 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23124 * Starts the transition.
23125 * Once this API is called, the transit begins to measure the time.
23127 * @note @p transit can not be NULL
23129 * @param transit The transit object.
23133 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23136 * Pause/Resume the transition.
23138 * If you call elm_transit_go again, the transit will be started from the
23139 * beginning, and will be unpaused.
23141 * @note @p transit can not be NULL
23143 * @param transit The transit object.
23144 * @param paused Whether the transition should be paused or not.
23148 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23151 * Get the value of paused status.
23153 * @see elm_transit_paused_set()
23155 * @note @p transit can not be NULL
23157 * @param transit The transit object.
23158 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23159 * EINA_FALSE is returned
23163 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23166 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23168 * The value returned is a fraction (current time / total time). It
23169 * represents the progression position relative to the total.
23171 * @note @p transit can not be NULL
23173 * @param transit The transit object.
23175 * @return The time progression value. If @p transit is NULL
23180 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23183 * Makes the chain relationship between two transits.
23185 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23186 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23188 * @param transit The transit object.
23189 * @param chain_transit The chain transit object. This transit will be operated
23190 * after transit is done.
23192 * This function adds @p chain_transit transition to a chain after the @p
23193 * transit, and will be started as soon as @p transit ends. See @ref
23194 * transit_example_02_explained for a full example.
23198 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23201 * Cut off the chain relationship between two transits.
23203 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23204 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23206 * @param transit The transit object.
23207 * @param chain_transit The chain transit object.
23209 * This function remove the @p chain_transit transition from the @p transit.
23213 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23216 * Get the current chain transit list.
23218 * @note @p transit can not be NULL.
23220 * @param transit The transit object.
23221 * @return chain transit list.
23225 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23228 * Add the Resizing Effect to Elm_Transit.
23230 * @note This API is one of the facades. It creates resizing effect context
23231 * and add it's required APIs to elm_transit_effect_add.
23233 * @see elm_transit_effect_add()
23235 * @param transit Transit object.
23236 * @param from_w Object width size when effect begins.
23237 * @param from_h Object height size when effect begins.
23238 * @param to_w Object width size when effect ends.
23239 * @param to_h Object height size when effect ends.
23240 * @return Resizing effect context data.
23244 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);
23247 * Add the Translation Effect to Elm_Transit.
23249 * @note This API is one of the facades. It creates translation effect context
23250 * and add it's required APIs to elm_transit_effect_add.
23252 * @see elm_transit_effect_add()
23254 * @param transit Transit object.
23255 * @param from_dx X Position variation when effect begins.
23256 * @param from_dy Y Position variation when effect begins.
23257 * @param to_dx X Position variation when effect ends.
23258 * @param to_dy Y Position variation when effect ends.
23259 * @return Translation effect context data.
23262 * @warning It is highly recommended just create a transit with this effect when
23263 * the window that the objects of the transit belongs has already been created.
23264 * This is because this effect needs the geometry information about the objects,
23265 * and if the window was not created yet, it can get a wrong information.
23267 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);
23270 * Add the Zoom Effect to Elm_Transit.
23272 * @note This API is one of the facades. It creates zoom effect context
23273 * and add it's required APIs to elm_transit_effect_add.
23275 * @see elm_transit_effect_add()
23277 * @param transit Transit object.
23278 * @param from_rate Scale rate when effect begins (1 is current rate).
23279 * @param to_rate Scale rate when effect ends.
23280 * @return Zoom effect context data.
23283 * @warning It is highly recommended just create a transit with this effect when
23284 * the window that the objects of the transit belongs has already been created.
23285 * This is because this effect needs the geometry information about the objects,
23286 * and if the window was not created yet, it can get a wrong information.
23288 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23291 * Add the Flip Effect to Elm_Transit.
23293 * @note This API is one of the facades. It creates flip effect context
23294 * and add it's required APIs to elm_transit_effect_add.
23295 * @note This effect is applied to each pair of objects in the order they are listed
23296 * in the transit list of objects. The first object in the pair will be the
23297 * "front" object and the second will be the "back" object.
23299 * @see elm_transit_effect_add()
23301 * @param transit Transit object.
23302 * @param axis Flipping Axis(X or Y).
23303 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23304 * @return Flip effect context data.
23307 * @warning It is highly recommended just create a transit with this effect when
23308 * the window that the objects of the transit belongs has already been created.
23309 * This is because this effect needs the geometry information about the objects,
23310 * and if the window was not created yet, it can get a wrong information.
23312 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23315 * Add the Resizable Flip Effect to Elm_Transit.
23317 * @note This API is one of the facades. It creates resizable flip effect context
23318 * and add it's required APIs to elm_transit_effect_add.
23319 * @note This effect is applied to each pair of objects in the order they are listed
23320 * in the transit list of objects. The first object in the pair will be the
23321 * "front" object and the second will be the "back" object.
23323 * @see elm_transit_effect_add()
23325 * @param transit Transit object.
23326 * @param axis Flipping Axis(X or Y).
23327 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23328 * @return Resizable flip effect context data.
23331 * @warning It is highly recommended just create a transit with this effect when
23332 * the window that the objects of the transit belongs has already been created.
23333 * This is because this effect needs the geometry information about the objects,
23334 * and if the window was not created yet, it can get a wrong information.
23336 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23339 * Add the Wipe Effect to Elm_Transit.
23341 * @note This API is one of the facades. It creates wipe effect context
23342 * and add it's required APIs to elm_transit_effect_add.
23344 * @see elm_transit_effect_add()
23346 * @param transit Transit object.
23347 * @param type Wipe type. Hide or show.
23348 * @param dir Wipe Direction.
23349 * @return Wipe effect context data.
23352 * @warning It is highly recommended just create a transit with this effect when
23353 * the window that the objects of the transit belongs has already been created.
23354 * This is because this effect needs the geometry information about the objects,
23355 * and if the window was not created yet, it can get a wrong information.
23357 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23360 * Add the Color Effect to Elm_Transit.
23362 * @note This API is one of the facades. It creates color effect context
23363 * and add it's required APIs to elm_transit_effect_add.
23365 * @see elm_transit_effect_add()
23367 * @param transit Transit object.
23368 * @param from_r RGB R when effect begins.
23369 * @param from_g RGB G when effect begins.
23370 * @param from_b RGB B when effect begins.
23371 * @param from_a RGB A when effect begins.
23372 * @param to_r RGB R when effect ends.
23373 * @param to_g RGB G when effect ends.
23374 * @param to_b RGB B when effect ends.
23375 * @param to_a RGB A when effect ends.
23376 * @return Color effect context data.
23380 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);
23383 * Add the Fade Effect to Elm_Transit.
23385 * @note This API is one of the facades. It creates fade effect context
23386 * and add it's required APIs to elm_transit_effect_add.
23387 * @note This effect is applied to each pair of objects in the order they are listed
23388 * in the transit list of objects. The first object in the pair will be the
23389 * "before" object and the second will be the "after" object.
23391 * @see elm_transit_effect_add()
23393 * @param transit Transit object.
23394 * @return Fade effect context data.
23397 * @warning It is highly recommended just create a transit with this effect when
23398 * the window that the objects of the transit belongs has already been created.
23399 * This is because this effect needs the color information about the objects,
23400 * and if the window was not created yet, it can get a wrong information.
23402 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23405 * Add the Blend Effect to Elm_Transit.
23407 * @note This API is one of the facades. It creates blend effect context
23408 * and add it's required APIs to elm_transit_effect_add.
23409 * @note This effect is applied to each pair of objects in the order they are listed
23410 * in the transit list of objects. The first object in the pair will be the
23411 * "before" object and the second will be the "after" object.
23413 * @see elm_transit_effect_add()
23415 * @param transit Transit object.
23416 * @return Blend effect context data.
23419 * @warning It is highly recommended just create a transit with this effect when
23420 * the window that the objects of the transit belongs has already been created.
23421 * This is because this effect needs the color information about the objects,
23422 * and if the window was not created yet, it can get a wrong information.
23424 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23427 * Add the Rotation Effect to Elm_Transit.
23429 * @note This API is one of the facades. It creates rotation effect context
23430 * and add it's required APIs to elm_transit_effect_add.
23432 * @see elm_transit_effect_add()
23434 * @param transit Transit object.
23435 * @param from_degree Degree when effect begins.
23436 * @param to_degree Degree when effect is ends.
23437 * @return Rotation effect context data.
23440 * @warning It is highly recommended just create a transit with this effect when
23441 * the window that the objects of the transit belongs has already been created.
23442 * This is because this effect needs the geometry information about the objects,
23443 * and if the window was not created yet, it can get a wrong information.
23445 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23448 * Add the ImageAnimation Effect to Elm_Transit.
23450 * @note This API is one of the facades. It creates image animation effect context
23451 * and add it's required APIs to elm_transit_effect_add.
23452 * The @p images parameter is a list images paths. This list and
23453 * its contents will be deleted at the end of the effect by
23454 * elm_transit_effect_image_animation_context_free() function.
23458 * char buf[PATH_MAX];
23459 * Eina_List *images = NULL;
23460 * Elm_Transit *transi = elm_transit_add();
23462 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23463 * images = eina_list_append(images, eina_stringshare_add(buf));
23465 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23466 * images = eina_list_append(images, eina_stringshare_add(buf));
23467 * elm_transit_effect_image_animation_add(transi, images);
23471 * @see elm_transit_effect_add()
23473 * @param transit Transit object.
23474 * @param images Eina_List of images file paths. This list and
23475 * its contents will be deleted at the end of the effect by
23476 * elm_transit_effect_image_animation_context_free() function.
23477 * @return Image Animation effect context data.
23481 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23486 typedef struct _Elm_Store Elm_Store;
23487 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23488 typedef struct _Elm_Store_Item Elm_Store_Item;
23489 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23490 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23491 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23492 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23493 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23494 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23495 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23496 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23498 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23499 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23500 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23501 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23505 ELM_STORE_ITEM_MAPPING_NONE = 0,
23506 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23507 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23508 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23509 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23510 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23511 // can add more here as needed by common apps
23512 ELM_STORE_ITEM_MAPPING_LAST
23513 } Elm_Store_Item_Mapping_Type;
23515 struct _Elm_Store_Item_Mapping_Icon
23517 // FIXME: allow edje file icons
23519 Elm_Icon_Lookup_Order lookup_order;
23520 Eina_Bool standard_name : 1;
23521 Eina_Bool no_scale : 1;
23522 Eina_Bool smooth : 1;
23523 Eina_Bool scale_up : 1;
23524 Eina_Bool scale_down : 1;
23527 struct _Elm_Store_Item_Mapping_Empty
23532 struct _Elm_Store_Item_Mapping_Photo
23537 struct _Elm_Store_Item_Mapping_Custom
23539 Elm_Store_Item_Mapping_Cb func;
23542 struct _Elm_Store_Item_Mapping
23544 Elm_Store_Item_Mapping_Type type;
23549 Elm_Store_Item_Mapping_Empty empty;
23550 Elm_Store_Item_Mapping_Icon icon;
23551 Elm_Store_Item_Mapping_Photo photo;
23552 Elm_Store_Item_Mapping_Custom custom;
23553 // add more types here
23557 struct _Elm_Store_Item_Info
23559 Elm_Genlist_Item_Class *item_class;
23560 const Elm_Store_Item_Mapping *mapping;
23565 struct _Elm_Store_Item_Info_Filesystem
23567 Elm_Store_Item_Info base;
23571 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23572 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23574 EAPI void elm_store_free(Elm_Store *st);
23576 EAPI Elm_Store *elm_store_filesystem_new(void);
23577 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23578 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23579 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23581 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23583 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23584 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23585 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23586 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23587 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23588 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23590 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23591 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23592 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23593 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23594 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23595 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23596 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23599 * @defgroup SegmentControl SegmentControl
23600 * @ingroup Elementary
23602 * @image html img/widget/segment_control/preview-00.png
23603 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23605 * @image html img/segment_control.png
23606 * @image latex img/segment_control.eps width=\textwidth
23608 * Segment control widget is a horizontal control made of multiple segment
23609 * items, each segment item functioning similar to discrete two state button.
23610 * A segment control groups the items together and provides compact
23611 * single button with multiple equal size segments.
23613 * Segment item size is determined by base widget
23614 * size and the number of items added.
23615 * Only one segment item can be at selected state. A segment item can display
23616 * combination of Text and any Evas_Object like Images or other widget.
23618 * Smart callbacks one can listen to:
23619 * - "changed" - When the user clicks on a segment item which is not
23620 * previously selected and get selected. The event_info parameter is the
23621 * segment item index.
23623 * Available styles for it:
23626 * Here is an example on its usage:
23627 * @li @ref segment_control_example
23631 * @addtogroup SegmentControl
23635 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23638 * Add a new segment control widget to the given parent Elementary
23639 * (container) object.
23641 * @param parent The parent object.
23642 * @return a new segment control widget handle or @c NULL, on errors.
23644 * This function inserts a new segment control widget on the canvas.
23646 * @ingroup SegmentControl
23648 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23651 * Append a new item to the segment control object.
23653 * @param obj The segment control object.
23654 * @param icon The icon object to use for the left side of the item. An
23655 * icon can be any Evas object, but usually it is an icon created
23656 * with elm_icon_add().
23657 * @param label The label of the item.
23658 * Note that, NULL is different from empty string "".
23659 * @return The created item or @c NULL upon failure.
23661 * A new item will be created and appended to the segment control, i.e., will
23662 * be set as @b last item.
23664 * If it should be inserted at another position,
23665 * elm_segment_control_item_insert_at() should be used instead.
23667 * Items created with this function can be deleted with function
23668 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23670 * @note @p label set to @c NULL is different from empty string "".
23672 * only has icon, it will be displayed bigger and centered. If it has
23673 * icon and label, even that an empty string, icon will be smaller and
23674 * positioned at left.
23678 * sc = elm_segment_control_add(win);
23679 * ic = elm_icon_add(win);
23680 * elm_icon_file_set(ic, "path/to/image", NULL);
23681 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23682 * elm_segment_control_item_add(sc, ic, "label");
23683 * evas_object_show(sc);
23686 * @see elm_segment_control_item_insert_at()
23687 * @see elm_segment_control_item_del()
23689 * @ingroup SegmentControl
23691 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23694 * Insert a new item to the segment control object at specified position.
23696 * @param obj The segment control object.
23697 * @param icon The icon object to use for the left side of the item. An
23698 * icon can be any Evas object, but usually it is an icon created
23699 * with elm_icon_add().
23700 * @param label The label of the item.
23701 * @param index Item position. Value should be between 0 and items count.
23702 * @return The created item or @c NULL upon failure.
23704 * Index values must be between @c 0, when item will be prepended to
23705 * segment control, and items count, that can be get with
23706 * elm_segment_control_item_count_get(), case when item will be appended
23707 * to segment control, just like elm_segment_control_item_add().
23709 * Items created with this function can be deleted with function
23710 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23712 * @note @p label set to @c NULL is different from empty string "".
23714 * only has icon, it will be displayed bigger and centered. If it has
23715 * icon and label, even that an empty string, icon will be smaller and
23716 * positioned at left.
23718 * @see elm_segment_control_item_add()
23719 * @see elm_segment_control_count_get()
23720 * @see elm_segment_control_item_del()
23722 * @ingroup SegmentControl
23724 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);
23727 * Remove a segment control item from its parent, deleting it.
23729 * @param it The item to be removed.
23731 * Items can be added with elm_segment_control_item_add() or
23732 * elm_segment_control_item_insert_at().
23734 * @ingroup SegmentControl
23736 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23739 * Remove a segment control item at given index from its parent,
23742 * @param obj The segment control object.
23743 * @param index The position of the segment control item to be deleted.
23745 * Items can be added with elm_segment_control_item_add() or
23746 * elm_segment_control_item_insert_at().
23748 * @ingroup SegmentControl
23750 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23753 * Get the Segment items count from segment control.
23755 * @param obj The segment control object.
23756 * @return Segment items count.
23758 * It will just return the number of items added to segment control @p obj.
23760 * @ingroup SegmentControl
23762 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23765 * Get the item placed at specified index.
23767 * @param obj The segment control object.
23768 * @param index The index of the segment item.
23769 * @return The segment control item or @c NULL on failure.
23771 * Index is the position of an item in segment control widget. Its
23772 * range is from @c 0 to <tt> count - 1 </tt>.
23773 * Count is the number of items, that can be get with
23774 * elm_segment_control_item_count_get().
23776 * @ingroup SegmentControl
23778 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23781 * Get the label of item.
23783 * @param obj The segment control object.
23784 * @param index The index of the segment item.
23785 * @return The label of the item at @p index.
23787 * The return value is a pointer to the label associated to the item when
23788 * it was created, with function elm_segment_control_item_add(), or later
23789 * with function elm_segment_control_item_label_set. If no label
23790 * was passed as argument, it will return @c NULL.
23792 * @see elm_segment_control_item_label_set() for more details.
23793 * @see elm_segment_control_item_add()
23795 * @ingroup SegmentControl
23797 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23800 * Set the label of item.
23802 * @param it The item of segment control.
23803 * @param text The label of item.
23805 * The label to be displayed by the item.
23806 * Label will be at right of the icon (if set).
23808 * If a label was passed as argument on item creation, with function
23809 * elm_control_segment_item_add(), it will be already
23810 * displayed by the item.
23812 * @see elm_segment_control_item_label_get()
23813 * @see elm_segment_control_item_add()
23815 * @ingroup SegmentControl
23817 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
23820 * Get the icon associated to the item.
23822 * @param obj The segment control object.
23823 * @param index The index of the segment item.
23824 * @return The left side icon associated to the item at @p index.
23826 * The return value is a pointer to the icon associated to the item when
23827 * it was created, with function elm_segment_control_item_add(), or later
23828 * with function elm_segment_control_item_icon_set(). If no icon
23829 * was passed as argument, it will return @c NULL.
23831 * @see elm_segment_control_item_add()
23832 * @see elm_segment_control_item_icon_set()
23834 * @ingroup SegmentControl
23836 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23839 * Set the icon associated to the item.
23841 * @param it The segment control item.
23842 * @param icon The icon object to associate with @p it.
23844 * The icon object to use at left side of the item. An
23845 * icon can be any Evas object, but usually it is an icon created
23846 * with elm_icon_add().
23848 * Once the icon object is set, a previously set one will be deleted.
23849 * @warning Setting the same icon for two items will cause the icon to
23850 * dissapear from the first item.
23852 * If an icon was passed as argument on item creation, with function
23853 * elm_segment_control_item_add(), it will be already
23854 * associated to the item.
23856 * @see elm_segment_control_item_add()
23857 * @see elm_segment_control_item_icon_get()
23859 * @ingroup SegmentControl
23861 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
23864 * Get the index of an item.
23866 * @param it The segment control item.
23867 * @return The position of item in segment control widget.
23869 * Index is the position of an item in segment control widget. Its
23870 * range is from @c 0 to <tt> count - 1 </tt>.
23871 * Count is the number of items, that can be get with
23872 * elm_segment_control_item_count_get().
23874 * @ingroup SegmentControl
23876 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23879 * Get the base object of the item.
23881 * @param it The segment control item.
23882 * @return The base object associated with @p it.
23884 * Base object is the @c Evas_Object that represents that item.
23886 * @ingroup SegmentControl
23888 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23891 * Get the selected item.
23893 * @param obj The segment control object.
23894 * @return The selected item or @c NULL if none of segment items is
23897 * The selected item can be unselected with function
23898 * elm_segment_control_item_selected_set().
23900 * The selected item always will be highlighted on segment control.
23902 * @ingroup SegmentControl
23904 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23907 * Set the selected state of an item.
23909 * @param it The segment control item
23910 * @param select The selected state
23912 * This sets the selected state of the given item @p it.
23913 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
23915 * If a new item is selected the previosly selected will be unselected.
23916 * Previoulsy selected item can be get with function
23917 * elm_segment_control_item_selected_get().
23919 * The selected item always will be highlighted on segment control.
23921 * @see elm_segment_control_item_selected_get()
23923 * @ingroup SegmentControl
23925 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
23932 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
23933 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
23934 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
23935 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
23936 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
23937 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
23938 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
23939 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
23942 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
23943 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
23944 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
23946 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
23947 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
23948 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
23949 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
23950 EAPI void elm_video_play(Evas_Object *video);
23951 EAPI void elm_video_pause(Evas_Object *video);
23952 EAPI void elm_video_stop(Evas_Object *video);
23953 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
23954 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
23955 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
23956 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
23957 EAPI double elm_video_audio_level_get(Evas_Object *video);
23958 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
23959 EAPI double elm_video_play_position_get(Evas_Object *video);
23960 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
23961 EAPI double elm_video_play_length_get(Evas_Object *video);
23962 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
23963 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
23964 EAPI const char *elm_video_title_get(Evas_Object *video);
23966 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
23967 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
23970 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23971 EAPI Elm_Object_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);
23972 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
23973 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
23974 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23975 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
23976 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
23977 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
23978 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
23979 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23980 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23981 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
23982 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
23983 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
23984 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);