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 html img/widget/button/preview-01.png
4001 * @image html img/widget/button/preview-02.png
4003 * This is a push-button. Press it and run some function. It can contain
4004 * a simple label and icon object and it also has an autorepeat feature.
4006 * This widgets emits the following signals:
4007 * @li "clicked": the user clicked the button (press/release).
4008 * @li "repeated": the user pressed the button without releasing it.
4009 * @li "pressed": button was pressed.
4010 * @li "unpressed": button was released after being pressed.
4011 * In all three cases, the @c event parameter of the callback will be
4014 * Also, defined in the default theme, the button has the following styles
4016 * @li default: a normal button.
4017 * @li anchor: Like default, but the button fades away when the mouse is not
4018 * over it, leaving only the text or icon.
4019 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4020 * continuous look across its options.
4021 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4023 * Follow through a complete example @ref button_example_01 "here".
4027 * Add a new button to the parent's canvas
4029 * @param parent The parent object
4030 * @return The new object or NULL if it cannot be created
4032 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4034 * Set the label used in the button
4036 * The passed @p label can be NULL to clean any existing text in it and
4037 * leave the button as an icon only object.
4039 * @param obj The button object
4040 * @param label The text will be written on the button
4041 * @deprecated use elm_object_text_set() instead.
4043 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4045 * Get the label set for the button
4047 * The string returned is an internal pointer and should not be freed or
4048 * altered. It will also become invalid when the button is destroyed.
4049 * The string returned, if not NULL, is a stringshare, so if you need to
4050 * keep it around even after the button is destroyed, you can use
4051 * eina_stringshare_ref().
4053 * @param obj The button object
4054 * @return The text set to the label, or NULL if nothing is set
4055 * @deprecated use elm_object_text_set() instead.
4057 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4059 * Set the icon used for the button
4061 * Setting a new icon will delete any other that was previously set, making
4062 * any reference to them invalid. If you need to maintain the previous
4063 * object alive, unset it first with elm_button_icon_unset().
4065 * @param obj The button object
4066 * @param icon The icon object for the button
4068 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4070 * Get the icon used for the button
4072 * Return the icon object which is set for this widget. If the button is
4073 * destroyed or another icon is set, the returned object will be deleted
4074 * and any reference to it will be invalid.
4076 * @param obj The button object
4077 * @return The icon object that is being used
4079 * @see elm_button_icon_unset()
4081 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083 * Remove the icon set without deleting it and return the object
4085 * This function drops the reference the button holds of the icon object
4086 * and returns this last object. It is used in case you want to remove any
4087 * icon, or set another one, without deleting the actual object. The button
4088 * will be left without an icon set.
4090 * @param obj The button object
4091 * @return The icon object that was being used
4093 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4095 * Turn on/off the autorepeat event generated when the button is kept pressed
4097 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4098 * signal when they are clicked.
4100 * When on, keeping a button pressed will continuously emit a @c repeated
4101 * signal until the button is released. The time it takes until it starts
4102 * emitting the signal is given by
4103 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4104 * new emission by elm_button_autorepeat_gap_timeout_set().
4106 * @param obj The button object
4107 * @param on A bool to turn on/off the event
4109 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4111 * Get whether the autorepeat feature is enabled
4113 * @param obj The button object
4114 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4116 * @see elm_button_autorepeat_set()
4118 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4120 * Set the initial timeout before the autorepeat event is generated
4122 * Sets the timeout, in seconds, since the button is pressed until the
4123 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4124 * won't be any delay and the even will be fired the moment the button is
4127 * @param obj The button object
4128 * @param t Timeout in seconds
4130 * @see elm_button_autorepeat_set()
4131 * @see elm_button_autorepeat_gap_timeout_set()
4133 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4135 * Get the initial timeout before the autorepeat event is generated
4137 * @param obj The button object
4138 * @return Timeout in seconds
4140 * @see elm_button_autorepeat_initial_timeout_set()
4142 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4144 * Set the interval between each generated autorepeat event
4146 * After the first @c repeated event is fired, all subsequent ones will
4147 * follow after a delay of @p t seconds for each.
4149 * @param obj The button object
4150 * @param t Interval in seconds
4152 * @see elm_button_autorepeat_initial_timeout_set()
4154 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4156 * Get the interval between each generated autorepeat event
4158 * @param obj The button object
4159 * @return Interval in seconds
4161 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4167 * @defgroup File_Selector_Button File Selector Button
4169 * @image html img/widget/fileselector_button/preview-00.png
4170 * @image html img/widget/fileselector_button/preview-01.png
4171 * @image html img/widget/fileselector_button/preview-02.png
4173 * This is a button that, when clicked, creates an Elementary
4174 * window (or inner window) <b> with a @ref Fileselector "file
4175 * selector widget" within</b>. When a file is chosen, the (inner)
4176 * window is closed and the button emits a signal having the
4177 * selected file as it's @c event_info.
4179 * This widget encapsulates operations on its internal file
4180 * selector on its own API. There is less control over its file
4181 * selector than that one would have instatiating one directly.
4183 * The following styles are available for this button:
4186 * @li @c "hoversel_vertical"
4187 * @li @c "hoversel_vertical_entry"
4189 * Smart callbacks one can register to:
4190 * - @c "file,chosen" - the user has selected a path, whose string
4191 * pointer comes as the @c event_info data (a stringshared
4194 * Here is an example on its usage:
4195 * @li @ref fileselector_button_example
4197 * @see @ref File_Selector_Entry for a similar widget.
4202 * Add a new file selector button widget to the given parent
4203 * Elementary (container) object
4205 * @param parent The parent object
4206 * @return a new file selector button widget handle or @c NULL, on
4209 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4212 * Set the label for a given file selector button widget
4214 * @param obj The file selector button widget
4215 * @param label The text label to be displayed on @p obj
4217 * @deprecated use elm_object_text_set() instead.
4219 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4222 * Get the label set for a given file selector button widget
4224 * @param obj The file selector button widget
4225 * @return The button label
4227 * @deprecated use elm_object_text_set() instead.
4229 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4232 * Set the icon on a given file selector button widget
4234 * @param obj The file selector button widget
4235 * @param icon The icon object for the button
4237 * Once the icon object is set, a previously set one will be
4238 * deleted. If you want to keep the latter, use the
4239 * elm_fileselector_button_icon_unset() function.
4241 * @see elm_fileselector_button_icon_get()
4243 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4246 * Get the icon set for a given file selector button widget
4248 * @param obj The file selector button widget
4249 * @return The icon object currently set on @p obj or @c NULL, if
4252 * @see elm_fileselector_button_icon_set()
4254 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4257 * Unset the icon used in a given file selector button widget
4259 * @param obj The file selector button widget
4260 * @return The icon object that was being used on @p obj or @c
4263 * Unparent and return the icon object which was set for this
4266 * @see elm_fileselector_button_icon_set()
4268 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4271 * Set the title for a given file selector button widget's window
4273 * @param obj The file selector button widget
4274 * @param title The title string
4276 * This will change the window's title, when the file selector pops
4277 * out after a click on the button. Those windows have the default
4278 * (unlocalized) value of @c "Select a file" as titles.
4280 * @note It will only take any effect if the file selector
4281 * button widget is @b not under "inwin mode".
4283 * @see elm_fileselector_button_window_title_get()
4285 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4288 * Get the title set for a given file selector button widget's
4291 * @param obj The file selector button widget
4292 * @return Title of the file selector button's window
4294 * @see elm_fileselector_button_window_title_get() for more details
4296 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299 * Set the size of a given file selector button widget's window,
4300 * holding the file selector itself.
4302 * @param obj The file selector button widget
4303 * @param width The window's width
4304 * @param height The window's height
4306 * @note it will only take any effect if the file selector button
4307 * widget is @b not under "inwin mode". The default size for the
4308 * window (when applicable) is 400x400 pixels.
4310 * @see elm_fileselector_button_window_size_get()
4312 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4315 * Get the size of a given file selector button widget's window,
4316 * holding the file selector itself.
4318 * @param obj The file selector button widget
4319 * @param width Pointer into which to store the width value
4320 * @param height Pointer into which to store the height value
4322 * @note Use @c NULL pointers on the size values you're not
4323 * interested in: they'll be ignored by the function.
4325 * @see elm_fileselector_button_window_size_set(), for more details
4327 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4330 * Set the initial file system path for a given file selector
4333 * @param obj The file selector button widget
4334 * @param path The path string
4336 * It must be a <b>directory</b> path, which will have the contents
4337 * displayed initially in the file selector's view, when invoked
4338 * from @p obj. The default initial path is the @c "HOME"
4339 * environment variable's value.
4341 * @see elm_fileselector_button_path_get()
4343 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4346 * Get the initial file system path set for a given file selector
4349 * @param obj The file selector button widget
4350 * @return path The path string
4352 * @see elm_fileselector_button_path_set() for more details
4354 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4357 * Enable/disable a tree view in the given file selector button
4358 * widget's internal file selector
4360 * @param obj The file selector button widget
4361 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4364 * This has the same effect as elm_fileselector_expandable_set(),
4365 * but now applied to a file selector button's internal file
4368 * @note There's no way to put a file selector button's internal
4369 * file selector in "grid mode", as one may do with "pure" file
4372 * @see elm_fileselector_expandable_get()
4374 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4377 * Get whether tree view is enabled for the given file selector
4378 * button widget's internal file selector
4380 * @param obj The file selector button widget
4381 * @return @c EINA_TRUE if @p obj widget's internal file selector
4382 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4384 * @see elm_fileselector_expandable_set() for more details
4386 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4389 * Set whether a given file selector button widget's internal file
4390 * selector is to display folders only or the directory contents,
4393 * @param obj The file selector button widget
4394 * @param only @c EINA_TRUE to make @p obj widget's internal file
4395 * selector only display directories, @c EINA_FALSE to make files
4396 * to be displayed in it too
4398 * This has the same effect as elm_fileselector_folder_only_set(),
4399 * but now applied to a file selector button's internal file
4402 * @see elm_fileselector_folder_only_get()
4404 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4407 * Get whether a given file selector button widget's internal file
4408 * selector is displaying folders only or the directory contents,
4411 * @param obj The file selector button widget
4412 * @return @c EINA_TRUE if @p obj widget's internal file
4413 * selector is only displaying directories, @c EINA_FALSE if files
4414 * are being displayed in it too (and on errors)
4416 * @see elm_fileselector_button_folder_only_set() for more details
4418 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4421 * Enable/disable the file name entry box where the user can type
4422 * in a name for a file, in a given file selector button widget's
4423 * internal file selector.
4425 * @param obj The file selector button widget
4426 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4427 * file selector a "saving dialog", @c EINA_FALSE otherwise
4429 * This has the same effect as elm_fileselector_is_save_set(),
4430 * but now applied to a file selector button's internal file
4433 * @see elm_fileselector_is_save_get()
4435 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4438 * Get whether the given file selector button widget's internal
4439 * file selector is in "saving dialog" mode
4441 * @param obj The file selector button widget
4442 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4443 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4446 * @see elm_fileselector_button_is_save_set() for more details
4448 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4451 * Set whether a given file selector button widget's internal file
4452 * selector will raise an Elementary "inner window", instead of a
4453 * dedicated Elementary window. By default, it won't.
4455 * @param obj The file selector button widget
4456 * @param value @c EINA_TRUE to make it use an inner window, @c
4457 * EINA_TRUE to make it use a dedicated window
4459 * @see elm_win_inwin_add() for more information on inner windows
4460 * @see elm_fileselector_button_inwin_mode_get()
4462 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4465 * Get whether a given file selector button widget's internal file
4466 * selector will raise an Elementary "inner window", instead of a
4467 * dedicated Elementary window.
4469 * @param obj The file selector button widget
4470 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4471 * if it will use a dedicated window
4473 * @see elm_fileselector_button_inwin_mode_set() for more details
4475 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4482 * @defgroup File_Selector_Entry File Selector Entry
4484 * @image html img/widget/fileselector_entry/preview-00.png
4485 * @image latex img/widget/fileselector_entry/preview-00.eps
4487 * This is an entry made to be filled with or display a <b>file
4488 * system path string</b>. Besides the entry itself, the widget has
4489 * a @ref File_Selector_Button "file selector button" on its side,
4490 * which will raise an internal @ref Fileselector "file selector widget",
4491 * when clicked, for path selection aided by file system
4494 * This file selector may appear in an Elementary window or in an
4495 * inner window. When a file is chosen from it, the (inner) window
4496 * is closed and the selected file's path string is exposed both as
4497 * an smart event and as the new text on the entry.
4499 * This widget encapsulates operations on its internal file
4500 * selector on its own API. There is less control over its file
4501 * selector than that one would have instatiating one directly.
4503 * Smart callbacks one can register to:
4504 * - @c "changed" - The text within the entry was changed
4505 * - @c "activated" - The entry has had editing finished and
4506 * changes are to be "committed"
4507 * - @c "press" - The entry has been clicked
4508 * - @c "longpressed" - The entry has been clicked (and held) for a
4510 * - @c "clicked" - The entry has been clicked
4511 * - @c "clicked,double" - The entry has been double clicked
4512 * - @c "focused" - The entry has received focus
4513 * - @c "unfocused" - The entry has lost focus
4514 * - @c "selection,paste" - A paste action has occurred on the
4516 * - @c "selection,copy" - A copy action has occurred on the entry
4517 * - @c "selection,cut" - A cut action has occurred on the entry
4518 * - @c "unpressed" - The file selector entry's button was released
4519 * after being pressed.
4520 * - @c "file,chosen" - The user has selected a path via the file
4521 * selector entry's internal file selector, whose string pointer
4522 * comes as the @c event_info data (a stringshared string)
4524 * Here is an example on its usage:
4525 * @li @ref fileselector_entry_example
4527 * @see @ref File_Selector_Button for a similar widget.
4532 * Add a new file selector entry widget to the given parent
4533 * Elementary (container) object
4535 * @param parent The parent object
4536 * @return a new file selector entry widget handle or @c NULL, on
4539 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4542 * Set the label for a given file selector entry widget's button
4544 * @param obj The file selector entry widget
4545 * @param label The text label to be displayed on @p obj widget's
4548 * @deprecated use elm_object_text_set() instead.
4550 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4553 * Get the label set for a given file selector entry widget's button
4555 * @param obj The file selector entry widget
4556 * @return The widget button's label
4558 * @deprecated use elm_object_text_set() instead.
4560 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4563 * Set the icon on a given file selector entry widget's button
4565 * @param obj The file selector entry widget
4566 * @param icon The icon object for the entry's button
4568 * Once the icon object is set, a previously set one will be
4569 * deleted. If you want to keep the latter, use the
4570 * elm_fileselector_entry_button_icon_unset() function.
4572 * @see elm_fileselector_entry_button_icon_get()
4574 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4577 * Get the icon set for a given file selector entry widget's button
4579 * @param obj The file selector entry widget
4580 * @return The icon object currently set on @p obj widget's button
4581 * or @c NULL, if none is
4583 * @see elm_fileselector_entry_button_icon_set()
4585 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4588 * Unset the icon used in a given file selector entry widget's
4591 * @param obj The file selector entry widget
4592 * @return The icon object that was being used on @p obj widget's
4593 * button or @c NULL, on errors
4595 * Unparent and return the icon object which was set for this
4598 * @see elm_fileselector_entry_button_icon_set()
4600 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4603 * Set the title for a given file selector entry widget's window
4605 * @param obj The file selector entry widget
4606 * @param title The title string
4608 * This will change the window's title, when the file selector pops
4609 * out after a click on the entry's button. Those windows have the
4610 * default (unlocalized) value of @c "Select a file" as titles.
4612 * @note It will only take any effect if the file selector
4613 * entry widget is @b not under "inwin mode".
4615 * @see elm_fileselector_entry_window_title_get()
4617 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4620 * Get the title set for a given file selector entry widget's
4623 * @param obj The file selector entry widget
4624 * @return Title of the file selector entry's window
4626 * @see elm_fileselector_entry_window_title_get() for more details
4628 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4631 * Set the size of a given file selector entry widget's window,
4632 * holding the file selector itself.
4634 * @param obj The file selector entry widget
4635 * @param width The window's width
4636 * @param height The window's height
4638 * @note it will only take any effect if the file selector entry
4639 * widget is @b not under "inwin mode". The default size for the
4640 * window (when applicable) is 400x400 pixels.
4642 * @see elm_fileselector_entry_window_size_get()
4644 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4647 * Get the size of a given file selector entry widget's window,
4648 * holding the file selector itself.
4650 * @param obj The file selector entry widget
4651 * @param width Pointer into which to store the width value
4652 * @param height Pointer into which to store the height value
4654 * @note Use @c NULL pointers on the size values you're not
4655 * interested in: they'll be ignored by the function.
4657 * @see elm_fileselector_entry_window_size_set(), for more details
4659 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4662 * Set the initial file system path and the entry's path string for
4663 * a given file selector entry widget
4665 * @param obj The file selector entry widget
4666 * @param path The path string
4668 * It must be a <b>directory</b> path, which will have the contents
4669 * displayed initially in the file selector's view, when invoked
4670 * from @p obj. The default initial path is the @c "HOME"
4671 * environment variable's value.
4673 * @see elm_fileselector_entry_path_get()
4675 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4678 * Get the entry's path string for a given file selector entry
4681 * @param obj The file selector entry widget
4682 * @return path The path string
4684 * @see elm_fileselector_entry_path_set() for more details
4686 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4689 * Enable/disable a tree view in the given file selector entry
4690 * widget's internal file selector
4692 * @param obj The file selector entry widget
4693 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4696 * This has the same effect as elm_fileselector_expandable_set(),
4697 * but now applied to a file selector entry's internal file
4700 * @note There's no way to put a file selector entry's internal
4701 * file selector in "grid mode", as one may do with "pure" file
4704 * @see elm_fileselector_expandable_get()
4706 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4709 * Get whether tree view is enabled for the given file selector
4710 * entry widget's internal file selector
4712 * @param obj The file selector entry widget
4713 * @return @c EINA_TRUE if @p obj widget's internal file selector
4714 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4716 * @see elm_fileselector_expandable_set() for more details
4718 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4721 * Set whether a given file selector entry widget's internal file
4722 * selector is to display folders only or the directory contents,
4725 * @param obj The file selector entry widget
4726 * @param only @c EINA_TRUE to make @p obj widget's internal file
4727 * selector only display directories, @c EINA_FALSE to make files
4728 * to be displayed in it too
4730 * This has the same effect as elm_fileselector_folder_only_set(),
4731 * but now applied to a file selector entry's internal file
4734 * @see elm_fileselector_folder_only_get()
4736 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4739 * Get whether a given file selector entry widget's internal file
4740 * selector is displaying folders only or the directory contents,
4743 * @param obj The file selector entry widget
4744 * @return @c EINA_TRUE if @p obj widget's internal file
4745 * selector is only displaying directories, @c EINA_FALSE if files
4746 * are being displayed in it too (and on errors)
4748 * @see elm_fileselector_entry_folder_only_set() for more details
4750 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4753 * Enable/disable the file name entry box where the user can type
4754 * in a name for a file, in a given file selector entry widget's
4755 * internal file selector.
4757 * @param obj The file selector entry widget
4758 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4759 * file selector a "saving dialog", @c EINA_FALSE otherwise
4761 * This has the same effect as elm_fileselector_is_save_set(),
4762 * but now applied to a file selector entry's internal file
4765 * @see elm_fileselector_is_save_get()
4767 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4770 * Get whether the given file selector entry widget's internal
4771 * file selector is in "saving dialog" mode
4773 * @param obj The file selector entry widget
4774 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4775 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4778 * @see elm_fileselector_entry_is_save_set() for more details
4780 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4783 * Set whether a given file selector entry widget's internal file
4784 * selector will raise an Elementary "inner window", instead of a
4785 * dedicated Elementary window. By default, it won't.
4787 * @param obj The file selector entry widget
4788 * @param value @c EINA_TRUE to make it use an inner window, @c
4789 * EINA_TRUE to make it use a dedicated window
4791 * @see elm_win_inwin_add() for more information on inner windows
4792 * @see elm_fileselector_entry_inwin_mode_get()
4794 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4797 * Get whether a given file selector entry widget's internal file
4798 * selector will raise an Elementary "inner window", instead of a
4799 * dedicated Elementary window.
4801 * @param obj The file selector entry widget
4802 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4803 * if it will use a dedicated window
4805 * @see elm_fileselector_entry_inwin_mode_set() for more details
4807 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4810 * Set the initial file system path for a given file selector entry
4813 * @param obj The file selector entry widget
4814 * @param path The path string
4816 * It must be a <b>directory</b> path, which will have the contents
4817 * displayed initially in the file selector's view, when invoked
4818 * from @p obj. The default initial path is the @c "HOME"
4819 * environment variable's value.
4821 * @see elm_fileselector_entry_path_get()
4823 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4826 * Get the parent directory's path to the latest file selection on
4827 * a given filer selector entry widget
4829 * @param obj The file selector object
4830 * @return The (full) path of the directory of the last selection
4831 * on @p obj widget, a @b stringshared string
4833 * @see elm_fileselector_entry_path_set()
4835 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4842 * @defgroup Scroller Scroller
4844 * A scroller holds a single object and "scrolls it around". This means that
4845 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4846 * region around, allowing to move through a much larger object that is
4847 * contained in the scroller. The scroiller will always have a small minimum
4848 * size by default as it won't be limited by the contents of the scroller.
4850 * Signals that you can add callbacks for are:
4851 * @li "edge,left" - the left edge of the content has been reached
4852 * @li "edge,right" - the right edge of the content has been reached
4853 * @li "edge,top" - the top edge of the content has been reached
4854 * @li "edge,bottom" - the bottom edge of the content has been reached
4855 * @li "scroll" - the content has been scrolled (moved)
4856 * @li "scroll,anim,start" - scrolling animation has started
4857 * @li "scroll,anim,stop" - scrolling animation has stopped
4858 * @li "scroll,drag,start" - dragging the contents around has started
4859 * @li "scroll,drag,stop" - dragging the contents around has stopped
4860 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4863 * @note When Elemementary is in embedded mode the scrollbars will not be
4864 * dragable, they appear merely as indicators of how much has been scrolled.
4865 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4866 * fingerscroll) won't work.
4868 * In @ref tutorial_scroller you'll find an example of how to use most of
4873 * @brief Type that controls when scrollbars should appear.
4875 * @see elm_scroller_policy_set()
4877 typedef enum _Elm_Scroller_Policy
4879 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4880 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4881 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4882 ELM_SCROLLER_POLICY_LAST
4883 } Elm_Scroller_Policy;
4885 * @brief Add a new scroller to the parent
4887 * @param parent The parent object
4888 * @return The new object or NULL if it cannot be created
4890 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4892 * @brief Set the content of the scroller widget (the object to be scrolled around).
4894 * @param obj The scroller object
4895 * @param content The new content object
4897 * Once the content object is set, a previously set one will be deleted.
4898 * If you want to keep that old content object, use the
4899 * elm_scroller_content_unset() function.
4901 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4903 * @brief Get the content of the scroller widget
4905 * @param obj The slider object
4906 * @return The content that is being used
4908 * Return the content object which is set for this widget
4910 * @see elm_scroller_content_set()
4912 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4914 * @brief Unset the content of the scroller widget
4916 * @param obj The slider object
4917 * @return The content that was being used
4919 * Unparent and return the content object which was set for this widget
4921 * @see elm_scroller_content_set()
4923 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4925 * @brief Set custom theme elements for the scroller
4927 * @param obj The scroller object
4928 * @param widget The widget name to use (default is "scroller")
4929 * @param base The base name to use (default is "base")
4931 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4933 * @brief Make the scroller minimum size limited to the minimum size of the content
4935 * @param obj The scroller object
4936 * @param w Enable limiting minimum size horizontally
4937 * @param h Enable limiting minimum size vertically
4939 * By default the scroller will be as small as its design allows,
4940 * irrespective of its content. This will make the scroller minimum size the
4941 * right size horizontally and/or vertically to perfectly fit its content in
4944 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4946 * @brief Show a specific virtual region within the scroller content object
4948 * @param obj The scroller object
4949 * @param x X coordinate of the region
4950 * @param y Y coordinate of the region
4951 * @param w Width of the region
4952 * @param h Height of the region
4954 * This will ensure all (or part if it does not fit) of the designated
4955 * region in the virtual content object (0, 0 starting at the top-left of the
4956 * virtual content object) is shown within the scroller.
4958 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);
4960 * @brief Set the scrollbar visibility policy
4962 * @param obj The scroller object
4963 * @param policy_h Horizontal scrollbar policy
4964 * @param policy_v Vertical scrollbar policy
4966 * This sets the scrollbar visibility policy for the given scroller.
4967 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4968 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4969 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4970 * respectively for the horizontal and vertical scrollbars.
4972 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4974 * @brief Gets scrollbar visibility policy
4976 * @param obj The scroller object
4977 * @param policy_h Horizontal scrollbar policy
4978 * @param policy_v Vertical scrollbar policy
4980 * @see elm_scroller_policy_set()
4982 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4984 * @brief Get the currently visible content region
4986 * @param obj The scroller object
4987 * @param x X coordinate of the region
4988 * @param y Y coordinate of the region
4989 * @param w Width of the region
4990 * @param h Height of the region
4992 * This gets the current region in the content object that is visible through
4993 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4994 * w, @p h values pointed to.
4996 * @note All coordinates are relative to the content.
4998 * @see elm_scroller_region_show()
5000 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);
5002 * @brief Get the size of the content object
5004 * @param obj The scroller object
5005 * @param w Width return
5006 * @param h Height return
5008 * This gets the size of the content object of the scroller.
5010 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5012 * @brief Set bouncing behavior
5014 * @param obj The scroller object
5015 * @param h_bounce Will the scroller bounce horizontally or not
5016 * @param v_bounce Will the scroller bounce vertically or not
5018 * When scrolling, the scroller may "bounce" when reaching an edge of the
5019 * content object. This is a visual way to indicate the end has been reached.
5020 * This is enabled by default for both axis. This will set if it is enabled
5021 * for that axis with the boolean parameters for each axis.
5023 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5025 * @brief Get the bounce mode
5027 * @param obj The Scroller object
5028 * @param h_bounce Allow bounce horizontally
5029 * @param v_bounce Allow bounce vertically
5031 * @see elm_scroller_bounce_set()
5033 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5035 * @brief Set scroll page size relative to viewport size.
5037 * @param obj The scroller object
5038 * @param h_pagerel The horizontal page relative size
5039 * @param v_pagerel The vertical page relative size
5041 * The scroller is capable of limiting scrolling by the user to "pages". That
5042 * is to jump by and only show a "whole page" at a time as if the continuous
5043 * area of the scroller content is split into page sized pieces. This sets
5044 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5045 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5046 * axis. This is mutually exclusive with page size
5047 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5048 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5049 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5052 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5054 * @brief Set scroll page size.
5056 * @param obj The scroller object
5057 * @param h_pagesize The horizontal page size
5058 * @param v_pagesize The vertical page size
5060 * This sets the page size to an absolute fixed value, with 0 turning it off
5063 * @see elm_scroller_page_relative_set()
5065 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5067 * @brief Show a specific virtual region within the scroller content object.
5069 * @param obj The scroller object
5070 * @param x X coordinate of the region
5071 * @param y Y coordinate of the region
5072 * @param w Width of the region
5073 * @param h Height of the region
5075 * This will ensure all (or part if it does not fit) of the designated
5076 * region in the virtual content object (0, 0 starting at the top-left of the
5077 * virtual content object) is shown within the scroller. Unlike
5078 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5079 * to this location (if configuration in general calls for transitions). It
5080 * may not jump immediately to the new location and make take a while and
5081 * show other content along the way.
5083 * @see elm_scroller_region_show()
5085 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);
5087 * @brief Set event propagation on a scroller
5089 * @param obj The scroller object
5090 * @param propagation If propagation is enabled or not
5092 * This enables or disabled event propagation from the scroller content to
5093 * the scroller and its parent. By default event propagation is disabled.
5095 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5097 * @brief Get event propagation for a scroller
5099 * @param obj The scroller object
5100 * @return The propagation state
5102 * This gets the event propagation for a scroller.
5104 * @see elm_scroller_propagate_events_set()
5106 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5112 * @defgroup Label Label
5114 * @image html img/widget/label/preview-00.png
5115 * @image latex img/widget/label/preview-00.eps
5117 * @brief Widget to display text, with simple html-like markup.
5119 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5120 * text doesn't fit the geometry of the label it will be ellipsized or be
5121 * cut. Elementary provides several themes for this widget:
5122 * @li default - No animation
5123 * @li marker - Centers the text in the label and make it bold by default
5124 * @li slide_long - The entire text appears from the right of the screen and
5125 * slides until it disappears in the left of the screen(reappering on the
5127 * @li slide_short - The text appears in the left of the label and slides to
5128 * the right to show the overflow. When all of the text has been shown the
5129 * position is reset.
5130 * @li slide_bounce - The text appears in the left of the label and slides to
5131 * the right to show the overflow. When all of the text has been shown the
5132 * animation reverses, moving the text to the left.
5134 * Custom themes can of course invent new markup tags and style them any way
5137 * See @ref tutorial_label for a demonstration of how to use a label widget.
5141 * @brief Add a new label to the parent
5143 * @param parent The parent object
5144 * @return The new object or NULL if it cannot be created
5146 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5148 * @brief Set the label on the label object
5150 * @param obj The label object
5151 * @param label The label will be used on the label object
5152 * @deprecated See elm_object_text_set()
5154 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 */
5156 * @brief Get the label used on the label object
5158 * @param obj The label object
5159 * @return The string inside the label
5160 * @deprecated See elm_object_text_get()
5162 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5164 * @brief Set the wrapping behavior of the label
5166 * @param obj The label object
5167 * @param wrap To wrap text or not
5169 * By default no wrapping is done. Possible values for @p wrap are:
5170 * @li ELM_WRAP_NONE - No wrapping
5171 * @li ELM_WRAP_CHAR - wrap between characters
5172 * @li ELM_WRAP_WORD - wrap between words
5173 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5175 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5177 * @brief Get the wrapping behavior of the label
5179 * @param obj The label object
5182 * @see elm_label_line_wrap_set()
5184 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5186 * @brief Set wrap width of the label
5188 * @param obj The label object
5189 * @param w The wrap width in pixels at a minimum where words need to wrap
5191 * This function sets the maximum width size hint of the label.
5193 * @warning This is only relevant if the label is inside a container.
5195 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5197 * @brief Get wrap width of the label
5199 * @param obj The label object
5200 * @return The wrap width in pixels at a minimum where words need to wrap
5202 * @see elm_label_wrap_width_set()
5204 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5206 * @brief Set wrap height of the label
5208 * @param obj The label object
5209 * @param h The wrap height in pixels at a minimum where words need to wrap
5211 * This function sets the maximum height size hint of the label.
5213 * @warning This is only relevant if the label is inside a container.
5215 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5217 * @brief get wrap width of the label
5219 * @param obj The label object
5220 * @return The wrap height in pixels at a minimum where words need to wrap
5222 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224 * @brief Set the font size on the label object.
5226 * @param obj The label object
5227 * @param size font size
5229 * @warning NEVER use this. It is for hyper-special cases only. use styles
5230 * instead. e.g. "big", "medium", "small" - or better name them by use:
5231 * "title", "footnote", "quote" etc.
5233 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5235 * @brief Set the text color on the label object
5237 * @param obj The label object
5238 * @param r Red property background color of The label object
5239 * @param g Green property background color of The label object
5240 * @param b Blue property background color of The label object
5241 * @param a Alpha property background color of The label object
5243 * @warning NEVER use this. It is for hyper-special cases only. use styles
5244 * instead. e.g. "big", "medium", "small" - or better name them by use:
5245 * "title", "footnote", "quote" etc.
5247 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);
5249 * @brief Set the text align on the label object
5251 * @param obj The label object
5252 * @param align align mode ("left", "center", "right")
5254 * @warning NEVER use this. It is for hyper-special cases only. use styles
5255 * instead. e.g. "big", "medium", "small" - or better name them by use:
5256 * "title", "footnote", "quote" etc.
5258 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5260 * @brief Set background color of the label
5262 * @param obj The label object
5263 * @param r Red property background color of The label object
5264 * @param g Green property background color of The label object
5265 * @param b Blue property background color of The label object
5266 * @param a Alpha property background alpha of The label object
5268 * @warning NEVER use this. It is for hyper-special cases only. use styles
5269 * instead. e.g. "big", "medium", "small" - or better name them by use:
5270 * "title", "footnote", "quote" etc.
5272 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);
5274 * @brief Set the ellipsis behavior of the label
5276 * @param obj The label object
5277 * @param ellipsis To ellipsis text or not
5279 * If set to true and the text doesn't fit in the label an ellipsis("...")
5280 * will be shown at the end of the widget.
5282 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5283 * choosen wrap method was ELM_WRAP_WORD.
5285 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5287 * @brief Set the text slide of the label
5289 * @param obj The label object
5290 * @param slide To start slide or stop
5292 * If set to true the text of the label will slide throught the length of
5295 * @warning This only work with the themes "slide_short", "slide_long" and
5298 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5300 * @brief Get the text slide mode of the label
5302 * @param obj The label object
5303 * @return slide slide mode value
5305 * @see elm_label_slide_set()
5307 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5309 * @brief Set the slide duration(speed) of the label
5311 * @param obj The label object
5312 * @return The duration in seconds in moving text from slide begin position
5313 * to slide end position
5315 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5317 * @brief Get the slide duration(speed) of the label
5319 * @param obj The label object
5320 * @return The duration time in moving text from slide begin position to slide end position
5322 * @see elm_label_slide_duration_set()
5324 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5330 * @defgroup Toggle Toggle
5332 * @image html img/widget/toggle/preview-00.png
5333 * @image latex img/widget/toggle/preview-00.eps
5335 * @brief A toggle is a slider which can be used to toggle between
5336 * two values. It has two states: on and off.
5338 * Signals that you can add callbacks for are:
5339 * @li "changed" - Whenever the toggle value has been changed. Is not called
5340 * until the toggle is released by the cursor (assuming it
5341 * has been triggered by the cursor in the first place).
5343 * @ref tutorial_toggle show how to use a toggle.
5347 * @brief Add a toggle to @p parent.
5349 * @param parent The parent object
5351 * @return The toggle object
5353 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5355 * @brief Sets the label to be displayed with the toggle.
5357 * @param obj The toggle object
5358 * @param label The label to be displayed
5360 * @deprecated use elm_object_text_set() instead.
5362 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5364 * @brief Gets the label of the toggle
5366 * @param obj toggle object
5367 * @return The label of the toggle
5369 * @deprecated use elm_object_text_get() instead.
5371 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5373 * @brief Set the icon used for the toggle
5375 * @param obj The toggle object
5376 * @param icon The icon object for the button
5378 * Once the icon object is set, a previously set one will be deleted
5379 * If you want to keep that old content object, use the
5380 * elm_toggle_icon_unset() function.
5382 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5384 * @brief Get the icon used for the toggle
5386 * @param obj The toggle object
5387 * @return The icon object that is being used
5389 * Return the icon object which is set for this widget.
5391 * @see elm_toggle_icon_set()
5393 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5395 * @brief Unset the icon used for the toggle
5397 * @param obj The toggle object
5398 * @return The icon object that was being used
5400 * Unparent and return the icon object which was set for this widget.
5402 * @see elm_toggle_icon_set()
5404 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5406 * @brief Sets the labels to be associated with the on and off states of the toggle.
5408 * @param obj The toggle object
5409 * @param onlabel The label displayed when the toggle is in the "on" state
5410 * @param offlabel The label displayed when the toggle is in the "off" state
5412 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5414 * @brief Gets the labels associated with the on and off states of the toggle.
5416 * @param obj The toggle object
5417 * @param onlabel A char** to place the onlabel of @p obj into
5418 * @param offlabel A char** to place the offlabel of @p obj into
5420 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5422 * @brief Sets the state of the toggle to @p state.
5424 * @param obj The toggle object
5425 * @param state The state of @p obj
5427 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5429 * @brief Gets the state of the toggle to @p state.
5431 * @param obj The toggle object
5432 * @return The state of @p obj
5434 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5436 * @brief Sets the state pointer of the toggle to @p statep.
5438 * @param obj The toggle object
5439 * @param statep The state pointer of @p obj
5441 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5447 * @defgroup Frame Frame
5449 * @image html img/widget/frame/preview-00.png
5450 * @image latex img/widget/frame/preview-00.eps
5452 * @brief Frame is a widget that holds some content and has a title.
5454 * The default look is a frame with a title, but Frame supports multple
5462 * @li outdent_bottom
5464 * Of all this styles only default shows the title. Frame emits no signals.
5466 * For a detailed example see the @ref tutorial_frame.
5471 * @brief Add a new frame to the parent
5473 * @param parent The parent object
5474 * @return The new object or NULL if it cannot be created
5476 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5478 * @brief Set the frame label
5480 * @param obj The frame object
5481 * @param label The label of this frame object
5483 * @deprecated use elm_object_text_set() instead.
5485 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5487 * @brief Get the frame label
5489 * @param obj The frame object
5491 * @return The label of this frame objet or NULL if unable to get frame
5493 * @deprecated use elm_object_text_get() instead.
5495 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5497 * @brief Set the content of the frame widget
5499 * Once the content object is set, a previously set one will be deleted.
5500 * If you want to keep that old content object, use the
5501 * elm_frame_content_unset() function.
5503 * @param obj The frame object
5504 * @param content The content will be filled in this frame object
5506 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5508 * @brief Get the content of the frame widget
5510 * Return the content object which is set for this widget
5512 * @param obj The frame object
5513 * @return The content that is being used
5515 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5517 * @brief Unset the content of the frame widget
5519 * Unparent and return the content object which was set for this widget
5521 * @param obj The frame object
5522 * @return The content that was being used
5524 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5530 * @defgroup Table Table
5532 * A container widget to arrange other widgets in a table where items can
5533 * also span multiple columns or rows - even overlap (and then be raised or
5534 * lowered accordingly to adjust stacking if they do overlap).
5536 * The followin are examples of how to use a table:
5537 * @li @ref tutorial_table_01
5538 * @li @ref tutorial_table_02
5543 * @brief Add a new table to the parent
5545 * @param parent The parent object
5546 * @return The new object or NULL if it cannot be created
5548 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5550 * @brief Set the homogeneous layout in the table
5552 * @param obj The layout object
5553 * @param homogeneous A boolean to set if the layout is homogeneous in the
5554 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5556 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5558 * @brief Get the current table homogeneous mode.
5560 * @param obj The table object
5561 * @return A boolean to indicating if the layout is homogeneous in the table
5562 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5564 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5566 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5568 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5570 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5572 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5574 * @brief Set padding between cells.
5576 * @param obj The layout object.
5577 * @param horizontal set the horizontal padding.
5578 * @param vertical set the vertical padding.
5580 * Default value is 0.
5582 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5584 * @brief Get padding between cells.
5586 * @param obj The layout object.
5587 * @param horizontal set the horizontal padding.
5588 * @param vertical set the vertical padding.
5590 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5592 * @brief Add a subobject on the table with the coordinates passed
5594 * @param obj The table object
5595 * @param subobj The subobject to be added to the table
5596 * @param x Row number
5597 * @param y Column number
5601 * @note All positioning inside the table is relative to rows and columns, so
5602 * a value of 0 for x and y, means the top left cell of the table, and a
5603 * value of 1 for w and h means @p subobj only takes that 1 cell.
5605 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5607 * @brief Remove child from table.
5609 * @param obj The table object
5610 * @param subobj The subobject
5612 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5614 * @brief Faster way to remove all child objects from a table object.
5616 * @param obj The table object
5617 * @param clear If true, will delete children, else just remove from table.
5619 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5621 * @brief Set the packing location of an existing child of the table
5623 * @param subobj The subobject to be modified in the table
5624 * @param x Row number
5625 * @param y Column number
5629 * Modifies the position of an object already in the table.
5631 * @note All positioning inside the table is relative to rows and columns, so
5632 * a value of 0 for x and y, means the top left cell of the table, and a
5633 * value of 1 for w and h means @p subobj only takes that 1 cell.
5635 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5637 * @brief Get the packing location of an existing child of the table
5639 * @param subobj The subobject to be modified in the table
5640 * @param x Row number
5641 * @param y Column number
5645 * @see elm_table_pack_set()
5647 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5653 * @defgroup Gengrid Gengrid (Generic grid)
5655 * This widget aims to position objects in a grid layout while
5656 * actually creating and rendering only the visible ones, using the
5657 * same idea as the @ref Genlist "genlist": the user defines a @b
5658 * class for each item, specifying functions that will be called at
5659 * object creation, deletion, etc. When those items are selected by
5660 * the user, a callback function is issued. Users may interact with
5661 * a gengrid via the mouse (by clicking on items to select them and
5662 * clicking on the grid's viewport and swiping to pan the whole
5663 * view) or via the keyboard, navigating through item with the
5666 * @section Gengrid_Layouts Gengrid layouts
5668 * Gengrids may layout its items in one of two possible layouts:
5672 * When in "horizontal mode", items will be placed in @b columns,
5673 * from top to bottom and, when the space for a column is filled,
5674 * another one is started on the right, thus expanding the grid
5675 * horizontally, making for horizontal scrolling. When in "vertical
5676 * mode" , though, items will be placed in @b rows, from left to
5677 * right and, when the space for a row is filled, another one is
5678 * started below, thus expanding the grid vertically (and making
5679 * for vertical scrolling).
5681 * @section Gengrid_Items Gengrid items
5683 * An item in a gengrid can have 0 or more text labels (they can be
5684 * regular text or textblock Evas objects - that's up to the style
5685 * to determine), 0 or more icons (which are simply objects
5686 * swallowed into the gengrid item's theming Edje object) and 0 or
5687 * more <b>boolean states</b>, which have the behavior left to the
5688 * user to define. The Edje part names for each of these properties
5689 * will be looked up, in the theme file for the gengrid, under the
5690 * Edje (string) data items named @c "labels", @c "icons" and @c
5691 * "states", respectively. For each of those properties, if more
5692 * than one part is provided, they must have names listed separated
5693 * by spaces in the data fields. For the default gengrid item
5694 * theme, we have @b one label part (@c "elm.text"), @b two icon
5695 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5698 * A gengrid item may be at one of several styles. Elementary
5699 * provides one by default - "default", but this can be extended by
5700 * system or application custom themes/overlays/extensions (see
5701 * @ref Theme "themes" for more details).
5703 * @section Gengrid_Item_Class Gengrid item classes
5705 * In order to have the ability to add and delete items on the fly,
5706 * gengrid implements a class (callback) system where the
5707 * application provides a structure with information about that
5708 * type of item (gengrid may contain multiple different items with
5709 * different classes, states and styles). Gengrid will call the
5710 * functions in this struct (methods) when an item is "realized"
5711 * (i.e., created dynamically, while the user is scrolling the
5712 * grid). All objects will simply be deleted when no longer needed
5713 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5714 * contains the following members:
5715 * - @c item_style - This is a constant string and simply defines
5716 * the name of the item style. It @b must be specified and the
5717 * default should be @c "default".
5718 * - @c func.label_get - This function is called when an item
5719 * object is actually created. The @c data parameter will point to
5720 * the same data passed to elm_gengrid_item_append() and related
5721 * item creation functions. The @c obj parameter is the gengrid
5722 * object itself, while the @c part one is the name string of one
5723 * of the existing text parts in the Edje group implementing the
5724 * item's theme. This function @b must return a strdup'()ed string,
5725 * as the caller will free() it when done. See
5726 * #GridItemLabelGetFunc.
5727 * - @c func.icon_get - This function is called when an item object
5728 * is actually created. The @c data parameter will point to the
5729 * same data passed to elm_gengrid_item_append() and related item
5730 * creation functions. The @c obj parameter is the gengrid object
5731 * itself, while the @c part one is the name string of one of the
5732 * existing (icon) swallow parts in the Edje group implementing the
5733 * item's theme. It must return @c NULL, when no icon is desired,
5734 * or a valid object handle, otherwise. The object will be deleted
5735 * by the gengrid on its deletion or when the item is "unrealized".
5736 * See #GridItemIconGetFunc.
5737 * - @c func.state_get - This function is called when an item
5738 * object is actually created. The @c data parameter will point to
5739 * the same data passed to elm_gengrid_item_append() and related
5740 * item creation functions. The @c obj parameter is the gengrid
5741 * object itself, while the @c part one is the name string of one
5742 * of the state parts in the Edje group implementing the item's
5743 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5744 * true/on. Gengrids will emit a signal to its theming Edje object
5745 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5746 * "source" arguments, respectively, when the state is true (the
5747 * default is false), where @c XXX is the name of the (state) part.
5748 * See #GridItemStateGetFunc.
5749 * - @c func.del - This is called when elm_gengrid_item_del() is
5750 * called on an item or elm_gengrid_clear() is called on the
5751 * gengrid. This is intended for use when gengrid items are
5752 * deleted, so any data attached to the item (e.g. its data
5753 * parameter on creation) can be deleted. See #GridItemDelFunc.
5755 * @section Gengrid_Usage_Hints Usage hints
5757 * If the user wants to have multiple items selected at the same
5758 * time, elm_gengrid_multi_select_set() will permit it. If the
5759 * gengrid is single-selection only (the default), then
5760 * elm_gengrid_select_item_get() will return the selected item or
5761 * @c NULL, if none is selected. If the gengrid is under
5762 * multi-selection, then elm_gengrid_selected_items_get() will
5763 * return a list (that is only valid as long as no items are
5764 * modified (added, deleted, selected or unselected) of child items
5767 * If an item changes (internal (boolean) state, label or icon
5768 * changes), then use elm_gengrid_item_update() to have gengrid
5769 * update the item with the new state. A gengrid will re-"realize"
5770 * the item, thus calling the functions in the
5771 * #Elm_Gengrid_Item_Class set for that item.
5773 * To programmatically (un)select an item, use
5774 * elm_gengrid_item_selected_set(). To get its selected state use
5775 * elm_gengrid_item_selected_get(). To make an item disabled
5776 * (unable to be selected and appear differently) use
5777 * elm_gengrid_item_disabled_set() to set this and
5778 * elm_gengrid_item_disabled_get() to get the disabled state.
5780 * Grid cells will only have their selection smart callbacks called
5781 * when firstly getting selected. Any further clicks will do
5782 * nothing, unless you enable the "always select mode", with
5783 * elm_gengrid_always_select_mode_set(), thus making every click to
5784 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5785 * turn off the ability to select items entirely in the widget and
5786 * they will neither appear selected nor call the selection smart
5789 * Remember that you can create new styles and add your own theme
5790 * augmentation per application with elm_theme_extension_add(). If
5791 * you absolutely must have a specific style that overrides any
5792 * theme the user or system sets up you can use
5793 * elm_theme_overlay_add() to add such a file.
5795 * @section Gengrid_Smart_Events Gengrid smart events
5797 * Smart events that you can add callbacks for are:
5798 * - @c "activated" - The user has double-clicked or pressed
5799 * (enter|return|spacebar) on an item. The @c event_info parameter
5800 * is the gengrid item that was activated.
5801 * - @c "clicked,double" - The user has double-clicked an item.
5802 * The @c event_info parameter is the gengrid item that was double-clicked.
5803 * - @c "selected" - The user has made an item selected. The
5804 * @c event_info parameter is the gengrid item that was selected.
5805 * - @c "unselected" - The user has made an item unselected. The
5806 * @c event_info parameter is the gengrid item that was unselected.
5807 * - @c "realized" - This is called when the item in the gengrid
5808 * has its implementing Evas object instantiated, de facto. @c
5809 * event_info is the gengrid item that was created. The object
5810 * may be deleted at any time, so it is highly advised to the
5811 * caller @b not to use the object pointer returned from
5812 * elm_gengrid_item_object_get(), because it may point to freed
5814 * - @c "unrealized" - This is called when the implementing Evas
5815 * object for this item is deleted. @c event_info is the gengrid
5816 * item that was deleted.
5817 * - @c "changed" - Called when an item is added, removed, resized
5818 * or moved and when the gengrid is resized or gets "horizontal"
5820 * - @c "drag,start,up" - Called when the item in the gengrid has
5821 * been dragged (not scrolled) up.
5822 * - @c "drag,start,down" - Called when the item in the gengrid has
5823 * been dragged (not scrolled) down.
5824 * - @c "drag,start,left" - Called when the item in the gengrid has
5825 * been dragged (not scrolled) left.
5826 * - @c "drag,start,right" - Called when the item in the gengrid has
5827 * been dragged (not scrolled) right.
5828 * - @c "drag,stop" - Called when the item in the gengrid has
5829 * stopped being dragged.
5830 * - @c "drag" - Called when the item in the gengrid is being
5832 * - @c "scroll" - called when the content has been scrolled
5834 * - @c "scroll,drag,start" - called when dragging the content has
5836 * - @c "scroll,drag,stop" - called when dragging the content has
5839 * List of gendrid examples:
5840 * @li @ref gengrid_example
5844 * @addtogroup Gengrid
5848 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5849 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5850 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5851 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5852 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5853 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5854 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5857 * @struct _Elm_Gengrid_Item_Class
5859 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5862 struct _Elm_Gengrid_Item_Class
5864 const char *item_style;
5865 struct _Elm_Gengrid_Item_Class_Func
5867 GridItemLabelGetFunc label_get;
5868 GridItemIconGetFunc icon_get;
5869 GridItemStateGetFunc state_get;
5870 GridItemDelFunc del;
5872 }; /**< #Elm_Gengrid_Item_Class member definitions */
5875 * Add a new gengrid widget to the given parent Elementary
5876 * (container) object
5878 * @param parent The parent object
5879 * @return a new gengrid widget handle or @c NULL, on errors
5881 * This function inserts a new gengrid widget on the canvas.
5883 * @see elm_gengrid_item_size_set()
5884 * @see elm_gengrid_horizontal_set()
5885 * @see elm_gengrid_item_append()
5886 * @see elm_gengrid_item_del()
5887 * @see elm_gengrid_clear()
5891 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5894 * Set the size for the items of a given gengrid widget
5896 * @param obj The gengrid object.
5897 * @param w The items' width.
5898 * @param h The items' height;
5900 * A gengrid, after creation, has still no information on the size
5901 * to give to each of its cells. So, you most probably will end up
5902 * with squares one @ref Fingers "finger" wide, the default
5903 * size. Use this function to force a custom size for you items,
5904 * making them as big as you wish.
5906 * @see elm_gengrid_item_size_get()
5910 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5913 * Get the size set for the items of a given gengrid widget
5915 * @param obj The gengrid object.
5916 * @param w Pointer to a variable where to store the items' width.
5917 * @param h Pointer to a variable where to store the items' height.
5919 * @note Use @c NULL pointers on the size values you're not
5920 * interested in: they'll be ignored by the function.
5922 * @see elm_gengrid_item_size_get() for more details
5926 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5929 * Set the items grid's alignment within a given gengrid widget
5931 * @param obj The gengrid object.
5932 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5933 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5935 * This sets the alignment of the whole grid of items of a gengrid
5936 * within its given viewport. By default, those values are both
5937 * 0.5, meaning that the gengrid will have its items grid placed
5938 * exactly in the middle of its viewport.
5940 * @note If given alignment values are out of the cited ranges,
5941 * they'll be changed to the nearest boundary values on the valid
5944 * @see elm_gengrid_align_get()
5948 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5951 * Get the items grid's alignment values within a given gengrid
5954 * @param obj The gengrid object.
5955 * @param align_x Pointer to a variable where to store the
5956 * horizontal alignment.
5957 * @param align_y Pointer to a variable where to store the vertical
5960 * @note Use @c NULL pointers on the alignment values you're not
5961 * interested in: they'll be ignored by the function.
5963 * @see elm_gengrid_align_set() for more details
5967 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5970 * Set whether a given gengrid widget is or not able have items
5973 * @param obj The gengrid object
5974 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5975 * @c EINA_FALSE to turn it off
5977 * If a gengrid is set to allow reordering, a click held for more
5978 * than 0.5 over a given item will highlight it specially,
5979 * signalling the gengrid has entered the reordering state. From
5980 * that time on, the user will be able to, while still holding the
5981 * mouse button down, move the item freely in the gengrid's
5982 * viewport, replacing to said item to the locations it goes to.
5983 * The replacements will be animated and, whenever the user
5984 * releases the mouse button, the item being replaced gets a new
5985 * definitive place in the grid.
5987 * @see elm_gengrid_reorder_mode_get()
5991 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5994 * Get whether a given gengrid widget is or not able have items
5997 * @param obj The gengrid object
5998 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6001 * @see elm_gengrid_reorder_mode_set() for more details
6005 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6008 * Append a new item in a given gengrid widget.
6010 * @param obj The gengrid object.
6011 * @param gic The item class for the item.
6012 * @param data The item data.
6013 * @param func Convenience function called when the item is
6015 * @param func_data Data to be passed to @p func.
6016 * @return A handle to the item added or @c NULL, on errors.
6018 * This adds an item to the beginning of the gengrid.
6020 * @see elm_gengrid_item_prepend()
6021 * @see elm_gengrid_item_insert_before()
6022 * @see elm_gengrid_item_insert_after()
6023 * @see elm_gengrid_item_del()
6027 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);
6030 * Prepend a new item in a given gengrid widget.
6032 * @param obj The gengrid object.
6033 * @param gic The item class for the item.
6034 * @param data The item data.
6035 * @param func Convenience function called when the item is
6037 * @param func_data Data to be passed to @p func.
6038 * @return A handle to the item added or @c NULL, on errors.
6040 * This adds an item to the end of the gengrid.
6042 * @see elm_gengrid_item_append()
6043 * @see elm_gengrid_item_insert_before()
6044 * @see elm_gengrid_item_insert_after()
6045 * @see elm_gengrid_item_del()
6049 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);
6052 * Insert an item before another in a gengrid widget
6054 * @param obj The gengrid object.
6055 * @param gic The item class for the item.
6056 * @param data The item data.
6057 * @param relative The item to place this new one before.
6058 * @param func Convenience function called when the item is
6060 * @param func_data Data to be passed to @p func.
6061 * @return A handle to the item added or @c NULL, on errors.
6063 * This inserts an item before another in the gengrid.
6065 * @see elm_gengrid_item_append()
6066 * @see elm_gengrid_item_prepend()
6067 * @see elm_gengrid_item_insert_after()
6068 * @see elm_gengrid_item_del()
6072 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);
6075 * Insert an item after another in a gengrid widget
6077 * @param obj The gengrid object.
6078 * @param gic The item class for the item.
6079 * @param data The item data.
6080 * @param relative The item to place this new one after.
6081 * @param func Convenience function called when the item is
6083 * @param func_data Data to be passed to @p func.
6084 * @return A handle to the item added or @c NULL, on errors.
6086 * This inserts an item after another in the gengrid.
6088 * @see elm_gengrid_item_append()
6089 * @see elm_gengrid_item_prepend()
6090 * @see elm_gengrid_item_insert_after()
6091 * @see elm_gengrid_item_del()
6095 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);
6097 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);
6099 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);
6102 * Set whether items on a given gengrid widget are to get their
6103 * selection callbacks issued for @b every subsequent selection
6104 * click on them or just for the first click.
6106 * @param obj The gengrid object
6107 * @param always_select @c EINA_TRUE to make items "always
6108 * selected", @c EINA_FALSE, otherwise
6110 * By default, grid items will only call their selection callback
6111 * function when firstly getting selected, any subsequent further
6112 * clicks will do nothing. With this call, you make those
6113 * subsequent clicks also to issue the selection callbacks.
6115 * @note <b>Double clicks</b> will @b always be reported on items.
6117 * @see elm_gengrid_always_select_mode_get()
6121 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6124 * Get whether items on a given gengrid widget have their selection
6125 * callbacks issued for @b every subsequent selection click on them
6126 * or just for the first click.
6128 * @param obj The gengrid object.
6129 * @return @c EINA_TRUE if the gengrid items are "always selected",
6130 * @c EINA_FALSE, otherwise
6132 * @see elm_gengrid_always_select_mode_set() for more details
6136 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6139 * Set whether items on a given gengrid widget can be selected or not.
6141 * @param obj The gengrid object
6142 * @param no_select @c EINA_TRUE to make items selectable,
6143 * @c EINA_FALSE otherwise
6145 * This will make items in @p obj selectable or not. In the latter
6146 * case, any user interacion on the gendrid items will neither make
6147 * them appear selected nor them call their selection callback
6150 * @see elm_gengrid_no_select_mode_get()
6154 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6157 * Get whether items on a given gengrid widget can be selected or
6160 * @param obj The gengrid object
6161 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6164 * @see elm_gengrid_no_select_mode_set() for more details
6168 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6171 * Enable or disable multi-selection in a given gengrid widget
6173 * @param obj The gengrid object.
6174 * @param multi @c EINA_TRUE, to enable multi-selection,
6175 * @c EINA_FALSE to disable it.
6177 * Multi-selection is the ability for one to have @b more than one
6178 * item selected, on a given gengrid, simultaneously. When it is
6179 * enabled, a sequence of clicks on different items will make them
6180 * all selected, progressively. A click on an already selected item
6181 * will unselect it. If interecting via the keyboard,
6182 * multi-selection is enabled while holding the "Shift" key.
6184 * @note By default, multi-selection is @b disabled on gengrids
6186 * @see elm_gengrid_multi_select_get()
6190 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6193 * Get whether multi-selection is enabled or disabled for a given
6196 * @param obj The gengrid object.
6197 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6198 * EINA_FALSE otherwise
6200 * @see elm_gengrid_multi_select_set() for more details
6204 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6207 * Enable or disable bouncing effect for a given gengrid widget
6209 * @param obj The gengrid object
6210 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6211 * @c EINA_FALSE to disable it
6212 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6213 * @c EINA_FALSE to disable it
6215 * The bouncing effect occurs whenever one reaches the gengrid's
6216 * edge's while panning it -- it will scroll past its limits a
6217 * little bit and return to the edge again, in a animated for,
6220 * @note By default, gengrids have bouncing enabled on both axis
6222 * @see elm_gengrid_bounce_get()
6226 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6229 * Get whether bouncing effects are enabled or disabled, for a
6230 * given gengrid widget, on each axis
6232 * @param obj The gengrid object
6233 * @param h_bounce Pointer to a variable where to store the
6234 * horizontal bouncing flag.
6235 * @param v_bounce Pointer to a variable where to store the
6236 * vertical bouncing flag.
6238 * @see elm_gengrid_bounce_set() for more details
6242 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6245 * Set a given gengrid widget's scrolling page size, relative to
6246 * its viewport size.
6248 * @param obj The gengrid object
6249 * @param h_pagerel The horizontal page (relative) size
6250 * @param v_pagerel The vertical page (relative) size
6252 * The gengrid's scroller is capable of binding scrolling by the
6253 * user to "pages". It means that, while scrolling and, specially
6254 * after releasing the mouse button, the grid will @b snap to the
6255 * nearest displaying page's area. When page sizes are set, the
6256 * grid's continuous content area is split into (equal) page sized
6259 * This function sets the size of a page <b>relatively to the
6260 * viewport dimensions</b> of the gengrid, for each axis. A value
6261 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6262 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6263 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6264 * 1.0. Values beyond those will make it behave behave
6265 * inconsistently. If you only want one axis to snap to pages, use
6266 * the value @c 0.0 for the other one.
6268 * There is a function setting page size values in @b absolute
6269 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6270 * is mutually exclusive to this one.
6272 * @see elm_gengrid_page_relative_get()
6276 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6279 * Get a given gengrid widget's scrolling page size, relative to
6280 * its viewport size.
6282 * @param obj The gengrid object
6283 * @param h_pagerel Pointer to a variable where to store the
6284 * horizontal page (relative) size
6285 * @param v_pagerel Pointer to a variable where to store the
6286 * vertical page (relative) size
6288 * @see elm_gengrid_page_relative_set() for more details
6292 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6295 * Set a given gengrid widget's scrolling page size
6297 * @param obj The gengrid object
6298 * @param h_pagerel The horizontal page size, in pixels
6299 * @param v_pagerel The vertical page size, in pixels
6301 * The gengrid's scroller is capable of binding scrolling by the
6302 * user to "pages". It means that, while scrolling and, specially
6303 * after releasing the mouse button, the grid will @b snap to the
6304 * nearest displaying page's area. When page sizes are set, the
6305 * grid's continuous content area is split into (equal) page sized
6308 * This function sets the size of a page of the gengrid, in pixels,
6309 * for each axis. Sane usable values are, between @c 0 and the
6310 * dimensions of @p obj, for each axis. Values beyond those will
6311 * make it behave behave inconsistently. If you only want one axis
6312 * to snap to pages, use the value @c 0 for the other one.
6314 * There is a function setting page size values in @b relative
6315 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6316 * use is mutually exclusive to this one.
6320 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6323 * Set for what direction a given gengrid widget will expand while
6324 * placing its items.
6326 * @param obj The gengrid object.
6327 * @param setting @c EINA_TRUE to make the gengrid expand
6328 * horizontally, @c EINA_FALSE to expand vertically.
6330 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6331 * in @b columns, from top to bottom and, when the space for a
6332 * column is filled, another one is started on the right, thus
6333 * expanding the grid horizontally. When in "vertical mode"
6334 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6335 * to right and, when the space for a row is filled, another one is
6336 * started below, thus expanding the grid vertically.
6338 * @see elm_gengrid_horizontal_get()
6342 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6345 * Get for what direction a given gengrid widget will expand while
6346 * placing its items.
6348 * @param obj The gengrid object.
6349 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6350 * @c EINA_FALSE if it's set to expand vertically.
6352 * @see elm_gengrid_horizontal_set() for more detais
6356 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6359 * Get the first item in a given gengrid widget
6361 * @param obj The gengrid object
6362 * @return The first item's handle or @c NULL, if there are no
6363 * items in @p obj (and on errors)
6365 * This returns the first item in the @p obj's internal list of
6368 * @see elm_gengrid_last_item_get()
6372 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6375 * Get the last item in a given gengrid widget
6377 * @param obj The gengrid object
6378 * @return The last item's handle or @c NULL, if there are no
6379 * items in @p obj (and on errors)
6381 * This returns the last item in the @p obj's internal list of
6384 * @see elm_gengrid_first_item_get()
6388 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6391 * Get the @b next item in a gengrid widget's internal list of items,
6392 * given a handle to one of those items.
6394 * @param item The gengrid item to fetch next from
6395 * @return The item after @p item, or @c NULL if there's none (and
6398 * This returns the item placed after the @p item, on the container
6401 * @see elm_gengrid_item_prev_get()
6405 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6408 * Get the @b previous item in a gengrid widget's internal list of items,
6409 * given a handle to one of those items.
6411 * @param item The gengrid item to fetch previous from
6412 * @return The item before @p item, or @c NULL if there's none (and
6415 * This returns the item placed before the @p item, on the container
6418 * @see elm_gengrid_item_next_get()
6422 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6425 * Get the gengrid object's handle which contains a given gengrid
6428 * @param item The item to fetch the container from
6429 * @return The gengrid (parent) object
6431 * This returns the gengrid object itself that an item belongs to.
6435 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6438 * Remove a gengrid item from the its parent, deleting it.
6440 * @param item The item to be removed.
6441 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6443 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6448 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6451 * Update the contents of a given gengrid item
6453 * @param item The gengrid item
6455 * This updates an item by calling all the item class functions
6456 * again to get the icons, labels and states. Use this when the
6457 * original item data has changed and you want thta changes to be
6462 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6463 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6464 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6467 * Return the data associated to a given gengrid item
6469 * @param item The gengrid item.
6470 * @return the data associated to this item.
6472 * This returns the @c data value passed on the
6473 * elm_gengrid_item_append() and related item addition calls.
6475 * @see elm_gengrid_item_append()
6476 * @see elm_gengrid_item_data_set()
6480 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6483 * Set the data associated to a given gengrid item
6485 * @param item The gengrid item
6486 * @param data The new data pointer to set on it
6488 * This @b overrides the @c data value passed on the
6489 * elm_gengrid_item_append() and related item addition calls. This
6490 * function @b won't call elm_gengrid_item_update() automatically,
6491 * so you'd issue it afterwards if you want to hove the item
6492 * updated to reflect the that new data.
6494 * @see elm_gengrid_item_data_get()
6498 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6501 * Get a given gengrid item's position, relative to the whole
6502 * gengrid's grid area.
6504 * @param item The Gengrid item.
6505 * @param x Pointer to variable where to store the item's <b>row
6507 * @param y Pointer to variable where to store the item's <b>column
6510 * This returns the "logical" position of the item whithin the
6511 * gengrid. For example, @c (0, 1) would stand for first row,
6516 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6519 * Set whether a given gengrid item is selected or not
6521 * @param item The gengrid item
6522 * @param selected Use @c EINA_TRUE, to make it selected, @c
6523 * EINA_FALSE to make it unselected
6525 * This sets the selected state of an item. If multi selection is
6526 * not enabled on the containing gengrid and @p selected is @c
6527 * EINA_TRUE, any other previously selected items will get
6528 * unselected in favor of this new one.
6530 * @see elm_gengrid_item_selected_get()
6534 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6537 * Get whether a given gengrid item is selected or not
6539 * @param item The gengrid item
6540 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6542 * @see elm_gengrid_item_selected_set() for more details
6546 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6549 * Get the real Evas object created to implement the view of a
6550 * given gengrid item
6552 * @param item The gengrid item.
6553 * @return the Evas object implementing this item's view.
6555 * This returns the actual Evas object used to implement the
6556 * specified gengrid item's view. This may be @c NULL, as it may
6557 * not have been created or may have been deleted, at any time, by
6558 * the gengrid. <b>Do not modify this object</b> (move, resize,
6559 * show, hide, etc.), as the gengrid is controlling it. This
6560 * function is for querying, emitting custom signals or hooking
6561 * lower level callbacks for events on that object. Do not delete
6562 * this object under any circumstances.
6564 * @see elm_gengrid_item_data_get()
6568 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6571 * Show the portion of a gengrid's internal grid containing a given
6572 * item, @b immediately.
6574 * @param item The item to display
6576 * This causes gengrid to @b redraw its viewport's contents to the
6577 * region contining the given @p item item, if it is not fully
6580 * @see elm_gengrid_item_bring_in()
6584 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6587 * Animatedly bring in, to the visible are of a gengrid, a given
6590 * @param item The gengrid item to display
6592 * This causes gengrig to jump to the given @p item item and show
6593 * it (by scrolling), if it is not fully visible. This will use
6594 * animation to do so and take a period of time to complete.
6596 * @see elm_gengrid_item_show()
6600 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6603 * Set whether a given gengrid item is disabled or not.
6605 * @param item The gengrid item
6606 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6607 * to enable it back.
6609 * A disabled item cannot be selected or unselected. It will also
6610 * change its appearance, to signal the user it's disabled.
6612 * @see elm_gengrid_item_disabled_get()
6616 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6619 * Get whether a given gengrid item is disabled or not.
6621 * @param item The gengrid item
6622 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6625 * @see elm_gengrid_item_disabled_set() for more details
6629 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6632 * Set the text to be shown in a given gengrid item's tooltips.
6634 * @param item The gengrid item
6635 * @param text The text to set in the content
6637 * This call will setup the text to be used as tooltip to that item
6638 * (analogous to elm_object_tooltip_text_set(), but being item
6639 * tooltips with higher precedence than object tooltips). It can
6640 * have only one tooltip at a time, so any previous tooltip data
6645 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6648 * Set the content to be shown in a given gengrid item's tooltips
6650 * @param item The gengrid item.
6651 * @param func The function returning the tooltip contents.
6652 * @param data What to provide to @a func as callback data/context.
6653 * @param del_cb Called when data is not needed anymore, either when
6654 * another callback replaces @p func, the tooltip is unset with
6655 * elm_gengrid_item_tooltip_unset() or the owner @p item
6656 * dies. This callback receives as its first parameter the
6657 * given @p data, being @c event_info the item handle.
6659 * This call will setup the tooltip's contents to @p item
6660 * (analogous to elm_object_tooltip_content_cb_set(), but being
6661 * item tooltips with higher precedence than object tooltips). It
6662 * can have only one tooltip at a time, so any previous tooltip
6663 * content will get removed. @p func (with @p data) will be called
6664 * every time Elementary needs to show the tooltip and it should
6665 * return a valid Evas object, which will be fully managed by the
6666 * tooltip system, getting deleted when the tooltip is gone.
6670 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);
6673 * Unset a tooltip from a given gengrid item
6675 * @param item gengrid item to remove a previously set tooltip from.
6677 * This call removes any tooltip set on @p item. The callback
6678 * provided as @c del_cb to
6679 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6680 * notify it is not used anymore (and have resources cleaned, if
6683 * @see elm_gengrid_item_tooltip_content_cb_set()
6687 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6690 * Set a different @b style for a given gengrid item's tooltip.
6692 * @param item gengrid item with tooltip set
6693 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6694 * "default", @c "transparent", etc)
6696 * Tooltips can have <b>alternate styles</b> to be displayed on,
6697 * which are defined by the theme set on Elementary. This function
6698 * works analogously as elm_object_tooltip_style_set(), but here
6699 * applied only to gengrid item objects. The default style for
6700 * tooltips is @c "default".
6702 * @note before you set a style you should define a tooltip with
6703 * elm_gengrid_item_tooltip_content_cb_set() or
6704 * elm_gengrid_item_tooltip_text_set()
6706 * @see elm_gengrid_item_tooltip_style_get()
6710 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6713 * Get the style set a given gengrid item's tooltip.
6715 * @param item gengrid item with tooltip already set on.
6716 * @return style the theme style in use, which defaults to
6717 * "default". If the object does not have a tooltip set,
6718 * then @c NULL is returned.
6720 * @see elm_gengrid_item_tooltip_style_set() for more details
6724 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6726 * @brief Disable size restrictions on an object's tooltip
6727 * @param item The tooltip's anchor object
6728 * @param disable If EINA_TRUE, size restrictions are disabled
6729 * @return EINA_FALSE on failure, EINA_TRUE on success
6731 * This function allows a tooltip to expand beyond its parant window's canvas.
6732 * It will instead be limited only by the size of the display.
6734 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6736 * @brief Retrieve size restriction state of an object's tooltip
6737 * @param item The tooltip's anchor object
6738 * @return If EINA_TRUE, size restrictions are disabled
6740 * This function returns whether a tooltip is allowed to expand beyond
6741 * its parant window's canvas.
6742 * It will instead be limited only by the size of the display.
6744 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6746 * Set the type of mouse pointer/cursor decoration to be shown,
6747 * when the mouse pointer is over the given gengrid widget item
6749 * @param item gengrid item to customize cursor on
6750 * @param cursor the cursor type's name
6752 * This function works analogously as elm_object_cursor_set(), but
6753 * here the cursor's changing area is restricted to the item's
6754 * area, and not the whole widget's. Note that that item cursors
6755 * have precedence over widget cursors, so that a mouse over @p
6756 * item will always show cursor @p type.
6758 * If this function is called twice for an object, a previously set
6759 * cursor will be unset on the second call.
6761 * @see elm_object_cursor_set()
6762 * @see elm_gengrid_item_cursor_get()
6763 * @see elm_gengrid_item_cursor_unset()
6767 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6770 * Get the type of mouse pointer/cursor decoration set to be shown,
6771 * when the mouse pointer is over the given gengrid widget item
6773 * @param item gengrid item with custom cursor set
6774 * @return the cursor type's name or @c NULL, if no custom cursors
6775 * were set to @p item (and on errors)
6777 * @see elm_object_cursor_get()
6778 * @see elm_gengrid_item_cursor_set() for more details
6779 * @see elm_gengrid_item_cursor_unset()
6783 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6786 * Unset any custom mouse pointer/cursor decoration set to be
6787 * shown, when the mouse pointer is over the given gengrid widget
6788 * item, thus making it show the @b default cursor again.
6790 * @param item a gengrid item
6792 * Use this call to undo any custom settings on this item's cursor
6793 * decoration, bringing it back to defaults (no custom style set).
6795 * @see elm_object_cursor_unset()
6796 * @see elm_gengrid_item_cursor_set() for more details
6800 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6803 * Set a different @b style for a given custom cursor set for a
6806 * @param item gengrid item with custom cursor set
6807 * @param style the <b>theme style</b> to use (e.g. @c "default",
6808 * @c "transparent", etc)
6810 * This function only makes sense when one is using custom mouse
6811 * cursor decorations <b>defined in a theme file</b> , which can
6812 * have, given a cursor name/type, <b>alternate styles</b> on
6813 * it. It works analogously as elm_object_cursor_style_set(), but
6814 * here applied only to gengrid item objects.
6816 * @warning Before you set a cursor style you should have defined a
6817 * custom cursor previously on the item, with
6818 * elm_gengrid_item_cursor_set()
6820 * @see elm_gengrid_item_cursor_engine_only_set()
6821 * @see elm_gengrid_item_cursor_style_get()
6825 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6828 * Get the current @b style set for a given gengrid item's custom
6831 * @param item gengrid item with custom cursor set.
6832 * @return style the cursor style in use. If the object does not
6833 * have a cursor set, then @c NULL is returned.
6835 * @see elm_gengrid_item_cursor_style_set() for more details
6839 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6842 * Set if the (custom) cursor for a given gengrid item should be
6843 * searched in its theme, also, or should only rely on the
6846 * @param item item with custom (custom) cursor already set on
6847 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6848 * only on those provided by the rendering engine, @c EINA_FALSE to
6849 * have them searched on the widget's theme, as well.
6851 * @note This call is of use only if you've set a custom cursor
6852 * for gengrid items, with elm_gengrid_item_cursor_set().
6854 * @note By default, cursors will only be looked for between those
6855 * provided by the rendering engine.
6859 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6862 * Get if the (custom) cursor for a given gengrid item is being
6863 * searched in its theme, also, or is only relying on the rendering
6866 * @param item a gengrid item
6867 * @return @c EINA_TRUE, if cursors are being looked for only on
6868 * those provided by the rendering engine, @c EINA_FALSE if they
6869 * are being searched on the widget's theme, as well.
6871 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6875 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6878 * Remove all items from a given gengrid widget
6880 * @param obj The gengrid object.
6882 * This removes (and deletes) all items in @p obj, leaving it
6885 * @see elm_gengrid_item_del(), to remove just one item.
6889 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6892 * Get the selected item in a given gengrid widget
6894 * @param obj The gengrid object.
6895 * @return The selected item's handleor @c NULL, if none is
6896 * selected at the moment (and on errors)
6898 * This returns the selected item in @p obj. If multi selection is
6899 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6900 * the first item in the list is selected, which might not be very
6901 * useful. For that case, see elm_gengrid_selected_items_get().
6905 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6908 * Get <b>a list</b> of selected items in a given gengrid
6910 * @param obj The gengrid object.
6911 * @return The list of selected items or @c NULL, if none is
6912 * selected at the moment (and on errors)
6914 * This returns a list of the selected items, in the order that
6915 * they appear in the grid. This list is only valid as long as no
6916 * more items are selected or unselected (or unselected implictly
6917 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6920 * @see elm_gengrid_selected_item_get()
6924 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6931 * @defgroup Clock Clock
6933 * @image html img/widget/clock/preview-00.png
6934 * @image latex img/widget/clock/preview-00.eps
6936 * This is a @b digital clock widget. In its default theme, it has a
6937 * vintage "flipping numbers clock" appearance, which will animate
6938 * sheets of individual algarisms individually as time goes by.
6940 * A newly created clock will fetch system's time (already
6941 * considering local time adjustments) to start with, and will tick
6942 * accondingly. It may or may not show seconds.
6944 * Clocks have an @b edition mode. When in it, the sheets will
6945 * display extra arrow indications on the top and bottom and the
6946 * user may click on them to raise or lower the time values. After
6947 * it's told to exit edition mode, it will keep ticking with that
6948 * new time set (it keeps the difference from local time).
6950 * Also, when under edition mode, user clicks on the cited arrows
6951 * which are @b held for some time will make the clock to flip the
6952 * sheet, thus editing the time, continuosly and automatically for
6953 * the user. The interval between sheet flips will keep growing in
6954 * time, so that it helps the user to reach a time which is distant
6957 * The time display is, by default, in military mode (24h), but an
6958 * am/pm indicator may be optionally shown, too, when it will
6961 * Smart callbacks one can register to:
6962 * - "changed" - the clock's user changed the time
6964 * Here is an example on its usage:
6965 * @li @ref clock_example
6974 * Identifiers for which clock digits should be editable, when a
6975 * clock widget is in edition mode. Values may be ORed together to
6976 * make a mask, naturally.
6978 * @see elm_clock_edit_set()
6979 * @see elm_clock_digit_edit_set()
6981 typedef enum _Elm_Clock_Digedit
6983 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6984 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6985 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6986 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6987 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6988 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6989 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
6990 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
6991 } Elm_Clock_Digedit;
6994 * Add a new clock widget to the given parent Elementary
6995 * (container) object
6997 * @param parent The parent object
6998 * @return a new clock widget handle or @c NULL, on errors
7000 * This function inserts a new clock widget on the canvas.
7004 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7007 * Set a clock widget's time, programmatically
7009 * @param obj The clock widget object
7010 * @param hrs The hours to set
7011 * @param min The minutes to set
7012 * @param sec The secondes to set
7014 * This function updates the time that is showed by the clock
7017 * Values @b must be set within the following ranges:
7018 * - 0 - 23, for hours
7019 * - 0 - 59, for minutes
7020 * - 0 - 59, for seconds,
7022 * even if the clock is not in "military" mode.
7024 * @warning The behavior for values set out of those ranges is @b
7029 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7032 * Get a clock widget's time values
7034 * @param obj The clock object
7035 * @param[out] hrs Pointer to the variable to get the hours value
7036 * @param[out] min Pointer to the variable to get the minutes value
7037 * @param[out] sec Pointer to the variable to get the seconds value
7039 * This function gets the time set for @p obj, returning
7040 * it on the variables passed as the arguments to function
7042 * @note Use @c NULL pointers on the time values you're not
7043 * interested in: they'll be ignored by the function.
7047 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7050 * Set whether a given clock widget is under <b>edition mode</b> or
7051 * under (default) displaying-only mode.
7053 * @param obj The clock object
7054 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7055 * put it back to "displaying only" mode
7057 * This function makes a clock's time to be editable or not <b>by
7058 * user interaction</b>. When in edition mode, clocks @b stop
7059 * ticking, until one brings them back to canonical mode. The
7060 * elm_clock_digit_edit_set() function will influence which digits
7061 * of the clock will be editable. By default, all of them will be
7062 * (#ELM_CLOCK_NONE).
7064 * @note am/pm sheets, if being shown, will @b always be editable
7065 * under edition mode.
7067 * @see elm_clock_edit_get()
7071 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7074 * Retrieve whether a given clock widget is under <b>edition
7075 * mode</b> or under (default) displaying-only mode.
7077 * @param obj The clock object
7078 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7081 * This function retrieves whether the clock's time can be edited
7082 * or not by user interaction.
7084 * @see elm_clock_edit_set() for more details
7088 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7091 * Set what digits of the given clock widget should be editable
7092 * when in edition mode.
7094 * @param obj The clock object
7095 * @param digedit Bit mask indicating the digits to be editable
7096 * (values in #Elm_Clock_Digedit).
7098 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7099 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7102 * @see elm_clock_digit_edit_get()
7106 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7109 * Retrieve what digits of the given clock widget should be
7110 * editable when in edition mode.
7112 * @param obj The clock object
7113 * @return Bit mask indicating the digits to be editable
7114 * (values in #Elm_Clock_Digedit).
7116 * @see elm_clock_digit_edit_set() for more details
7120 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7123 * Set if the given clock widget must show hours in military or
7126 * @param obj The clock object
7127 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7130 * This function sets if the clock must show hours in military or
7131 * am/pm mode. In some countries like Brazil the military mode
7132 * (00-24h-format) is used, in opposition to the USA, where the
7133 * am/pm mode is more commonly used.
7135 * @see elm_clock_show_am_pm_get()
7139 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7142 * Get if the given clock widget shows hours in military or am/pm
7145 * @param obj The clock object
7146 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7149 * This function gets if the clock shows hours in military or am/pm
7152 * @see elm_clock_show_am_pm_set() for more details
7156 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7159 * Set if the given clock widget must show time with seconds or not
7161 * @param obj The clock object
7162 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7164 * This function sets if the given clock must show or not elapsed
7165 * seconds. By default, they are @b not shown.
7167 * @see elm_clock_show_seconds_get()
7171 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7174 * Get whether the given clock widget is showing time with seconds
7177 * @param obj The clock object
7178 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7180 * This function gets whether @p obj is showing or not the elapsed
7183 * @see elm_clock_show_seconds_set()
7187 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7190 * Set the interval on time updates for an user mouse button hold
7191 * on clock widgets' time edition.
7193 * @param obj The clock object
7194 * @param interval The (first) interval value in seconds
7196 * This interval value is @b decreased while the user holds the
7197 * mouse pointer either incrementing or decrementing a given the
7198 * clock digit's value.
7200 * This helps the user to get to a given time distant from the
7201 * current one easier/faster, as it will start to flip quicker and
7202 * quicker on mouse button holds.
7204 * The calculation for the next flip interval value, starting from
7205 * the one set with this call, is the previous interval divided by
7206 * 1.05, so it decreases a little bit.
7208 * The default starting interval value for automatic flips is
7211 * @see elm_clock_interval_get()
7215 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7218 * Get the interval on time updates for an user mouse button hold
7219 * on clock widgets' time edition.
7221 * @param obj The clock object
7222 * @return The (first) interval value, in seconds, set on it
7224 * @see elm_clock_interval_set() for more details
7228 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7235 * @defgroup Layout Layout
7237 * @image html img/widget/layout/preview-00.png
7238 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7240 * @image html img/layout-predefined.png
7241 * @image latex img/layout-predefined.eps width=\textwidth
7243 * This is a container widget that takes a standard Edje design file and
7244 * wraps it very thinly in a widget.
7246 * An Edje design (theme) file has a very wide range of possibilities to
7247 * describe the behavior of elements added to the Layout. Check out the Edje
7248 * documentation and the EDC reference to get more information about what can
7249 * be done with Edje.
7251 * Just like @ref List, @ref Box, and other container widgets, any
7252 * object added to the Layout will become its child, meaning that it will be
7253 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7255 * The Layout widget can contain as many Contents, Boxes or Tables as
7256 * described in its theme file. For instance, objects can be added to
7257 * different Tables by specifying the respective Table part names. The same
7258 * is valid for Content and Box.
7260 * The objects added as child of the Layout will behave as described in the
7261 * part description where they were added. There are 3 possible types of
7262 * parts where a child can be added:
7264 * @section secContent Content (SWALLOW part)
7266 * Only one object can be added to the @c SWALLOW part (but you still can
7267 * have many @c SWALLOW parts and one object on each of them). Use the @c
7268 * elm_layout_content_* set of functions to set, retrieve and unset objects
7269 * as content of the @c SWALLOW. After being set to this part, the object
7270 * size, position, visibility, clipping and other description properties
7271 * will be totally controled by the description of the given part (inside
7272 * the Edje theme file).
7274 * One can use @c evas_object_size_hint_* functions on the child to have some
7275 * kind of control over its behavior, but the resulting behavior will still
7276 * depend heavily on the @c SWALLOW part description.
7278 * The Edje theme also can change the part description, based on signals or
7279 * scripts running inside the theme. This change can also be animated. All of
7280 * this will affect the child object set as content accordingly. The object
7281 * size will be changed if the part size is changed, it will animate move if
7282 * the part is moving, and so on.
7284 * The following picture demonstrates a Layout widget with a child object
7285 * added to its @c SWALLOW:
7287 * @image html layout_swallow.png
7288 * @image latex layout_swallow.eps width=\textwidth
7290 * @section secBox Box (BOX part)
7292 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7293 * allows one to add objects to the box and have them distributed along its
7294 * area, accordingly to the specified @a layout property (now by @a layout we
7295 * mean the chosen layouting design of the Box, not the Layout widget
7298 * A similar effect for having a box with its position, size and other things
7299 * controled by the Layout theme would be to create an Elementary @ref Box
7300 * widget and add it as a Content in the @c SWALLOW part.
7302 * The main difference of using the Layout Box is that its behavior, the box
7303 * properties like layouting format, padding, align, etc. will be all
7304 * controled by the theme. This means, for example, that a signal could be
7305 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7306 * handled the signal by changing the box padding, or align, or both. Using
7307 * the Elementary @ref Box widget is not necessarily harder or easier, it
7308 * just depends on the circunstances and requirements.
7310 * The Layout Box can be used through the @c elm_layout_box_* set of
7313 * The following picture demonstrates a Layout widget with many child objects
7314 * added to its @c BOX part:
7316 * @image html layout_box.png
7317 * @image latex layout_box.eps width=\textwidth
7319 * @section secTable Table (TABLE part)
7321 * Just like the @ref secBox, the Layout Table is very similar to the
7322 * Elementary @ref Table widget. It allows one to add objects to the Table
7323 * specifying the row and column where the object should be added, and any
7324 * column or row span if necessary.
7326 * Again, we could have this design by adding a @ref Table widget to the @c
7327 * SWALLOW part using elm_layout_content_set(). The same difference happens
7328 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7329 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7331 * The Layout Table can be used through the @c elm_layout_table_* set of
7334 * The following picture demonstrates a Layout widget with many child objects
7335 * added to its @c TABLE part:
7337 * @image html layout_table.png
7338 * @image latex layout_table.eps width=\textwidth
7340 * @section secPredef Predefined Layouts
7342 * Another interesting thing about the Layout widget is that it offers some
7343 * predefined themes that come with the default Elementary theme. These
7344 * themes can be set by the call elm_layout_theme_set(), and provide some
7345 * basic functionality depending on the theme used.
7347 * Most of them already send some signals, some already provide a toolbar or
7348 * back and next buttons.
7350 * These are available predefined theme layouts. All of them have class = @c
7351 * layout, group = @c application, and style = one of the following options:
7353 * @li @c toolbar-content - application with toolbar and main content area
7354 * @li @c toolbar-content-back - application with toolbar and main content
7355 * area with a back button and title area
7356 * @li @c toolbar-content-back-next - application with toolbar and main
7357 * content area with a back and next buttons and title area
7358 * @li @c content-back - application with a main content area with a back
7359 * button and title area
7360 * @li @c content-back-next - application with a main content area with a
7361 * back and next buttons and title area
7362 * @li @c toolbar-vbox - application with toolbar and main content area as a
7364 * @li @c toolbar-table - application with toolbar and main content area as a
7367 * @section secExamples Examples
7369 * Some examples of the Layout widget can be found here:
7370 * @li @ref layout_example_01
7371 * @li @ref layout_example_02
7372 * @li @ref layout_example_03
7373 * @li @ref layout_example_edc
7378 * Add a new layout to the parent
7380 * @param parent The parent object
7381 * @return The new object or NULL if it cannot be created
7383 * @see elm_layout_file_set()
7384 * @see elm_layout_theme_set()
7388 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7390 * Set the file that will be used as layout
7392 * @param obj The layout object
7393 * @param file The path to file (edj) that will be used as layout
7394 * @param group The group that the layout belongs in edje file
7396 * @return (1 = success, 0 = error)
7400 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7402 * Set the edje group from the elementary theme that will be used as layout
7404 * @param obj The layout object
7405 * @param clas the clas of the group
7406 * @param group the group
7407 * @param style the style to used
7409 * @return (1 = success, 0 = error)
7413 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7415 * Set the layout content.
7417 * @param obj The layout object
7418 * @param swallow The swallow part name in the edje file
7419 * @param content The child that will be added in this layout object
7421 * Once the content object is set, a previously set one will be deleted.
7422 * If you want to keep that old content object, use the
7423 * elm_layout_content_unset() function.
7425 * @note In an Edje theme, the part used as a content container is called @c
7426 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7427 * expected to be a part name just like the second parameter of
7428 * elm_layout_box_append().
7430 * @see elm_layout_box_append()
7431 * @see elm_layout_content_get()
7432 * @see elm_layout_content_unset()
7437 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7439 * Get the child object in the given content part.
7441 * @param obj The layout object
7442 * @param swallow The SWALLOW part to get its content
7444 * @return The swallowed object or NULL if none or an error occurred
7446 * @see elm_layout_content_set()
7450 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7452 * Unset the layout content.
7454 * @param obj The layout object
7455 * @param swallow The swallow part name in the edje file
7456 * @return The content that was being used
7458 * Unparent and return the content object which was set for this part.
7460 * @see elm_layout_content_set()
7464 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7466 * Set the text of the given part
7468 * @param obj The layout object
7469 * @param part The TEXT part where to set the text
7470 * @param text The text to set
7473 * @deprecated use elm_object_text_* instead.
7475 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7477 * Get the text set in the given part
7479 * @param obj The layout object
7480 * @param part The TEXT part to retrieve the text off
7482 * @return The text set in @p part
7485 * @deprecated use elm_object_text_* instead.
7487 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7489 * Append child to layout box part.
7491 * @param obj the layout object
7492 * @param part the box part to which the object will be appended.
7493 * @param child the child object to append to box.
7495 * Once the object is appended, it will become child of the layout. Its
7496 * lifetime will be bound to the layout, whenever the layout dies the child
7497 * will be deleted automatically. One should use elm_layout_box_remove() to
7498 * make this layout forget about the object.
7500 * @see elm_layout_box_prepend()
7501 * @see elm_layout_box_insert_before()
7502 * @see elm_layout_box_insert_at()
7503 * @see elm_layout_box_remove()
7507 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7509 * Prepend child to layout box part.
7511 * @param obj the layout object
7512 * @param part the box part to prepend.
7513 * @param child the child object to prepend to box.
7515 * Once the object is prepended, it will become child of the layout. Its
7516 * lifetime will be bound to the layout, whenever the layout dies the child
7517 * will be deleted automatically. One should use elm_layout_box_remove() to
7518 * make this layout forget about the object.
7520 * @see elm_layout_box_append()
7521 * @see elm_layout_box_insert_before()
7522 * @see elm_layout_box_insert_at()
7523 * @see elm_layout_box_remove()
7527 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7529 * Insert child to layout box part before a reference object.
7531 * @param obj the layout object
7532 * @param part the box part to insert.
7533 * @param child the child object to insert into box.
7534 * @param reference another reference object to insert before in box.
7536 * Once the object is inserted, it will become child of the layout. Its
7537 * lifetime will be bound to the layout, whenever the layout dies the child
7538 * will be deleted automatically. One should use elm_layout_box_remove() to
7539 * make this layout forget about the object.
7541 * @see elm_layout_box_append()
7542 * @see elm_layout_box_prepend()
7543 * @see elm_layout_box_insert_before()
7544 * @see elm_layout_box_remove()
7548 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7550 * Insert child to layout box part at a given position.
7552 * @param obj the layout object
7553 * @param part the box part to insert.
7554 * @param child the child object to insert into box.
7555 * @param pos the numeric position >=0 to insert the child.
7557 * Once the object is inserted, it will become child of the layout. Its
7558 * lifetime will be bound to the layout, whenever the layout dies the child
7559 * will be deleted automatically. One should use elm_layout_box_remove() to
7560 * make this layout forget about the object.
7562 * @see elm_layout_box_append()
7563 * @see elm_layout_box_prepend()
7564 * @see elm_layout_box_insert_before()
7565 * @see elm_layout_box_remove()
7569 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7571 * Remove a child of the given part box.
7573 * @param obj The layout object
7574 * @param part The box part name to remove child.
7575 * @param child The object to remove from box.
7576 * @return The object that was being used, or NULL if not found.
7578 * The object will be removed from the box part and its lifetime will
7579 * not be handled by the layout anymore. This is equivalent to
7580 * elm_layout_content_unset() for box.
7582 * @see elm_layout_box_append()
7583 * @see elm_layout_box_remove_all()
7587 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7589 * Remove all child of the given part box.
7591 * @param obj The layout object
7592 * @param part The box part name to remove child.
7593 * @param clear If EINA_TRUE, then all objects will be deleted as
7594 * well, otherwise they will just be removed and will be
7595 * dangling on the canvas.
7597 * The objects will be removed from the box part and their lifetime will
7598 * not be handled by the layout anymore. This is equivalent to
7599 * elm_layout_box_remove() for all box children.
7601 * @see elm_layout_box_append()
7602 * @see elm_layout_box_remove()
7606 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7608 * Insert child to layout table part.
7610 * @param obj the layout object
7611 * @param part the box part to pack child.
7612 * @param child_obj the child object to pack into table.
7613 * @param col the column to which the child should be added. (>= 0)
7614 * @param row the row to which the child should be added. (>= 0)
7615 * @param colspan how many columns should be used to store this object. (>=
7617 * @param rowspan how many rows should be used to store this object. (>= 1)
7619 * Once the object is inserted, it will become child of the table. Its
7620 * lifetime will be bound to the layout, and whenever the layout dies the
7621 * child will be deleted automatically. One should use
7622 * elm_layout_table_remove() to make this layout forget about the object.
7624 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7625 * more space than a single cell. For instance, the following code:
7627 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7630 * Would result in an object being added like the following picture:
7632 * @image html layout_colspan.png
7633 * @image latex layout_colspan.eps width=\textwidth
7635 * @see elm_layout_table_unpack()
7636 * @see elm_layout_table_clear()
7640 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);
7642 * Unpack (remove) a child of the given part table.
7644 * @param obj The layout object
7645 * @param part The table part name to remove child.
7646 * @param child_obj The object to remove from table.
7647 * @return The object that was being used, or NULL if not found.
7649 * The object will be unpacked from the table part and its lifetime
7650 * will not be handled by the layout anymore. This is equivalent to
7651 * elm_layout_content_unset() for table.
7653 * @see elm_layout_table_pack()
7654 * @see elm_layout_table_clear()
7658 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7660 * Remove all child of the given part table.
7662 * @param obj The layout object
7663 * @param part The table part name to remove child.
7664 * @param clear If EINA_TRUE, then all objects will be deleted as
7665 * well, otherwise they will just be removed and will be
7666 * dangling on the canvas.
7668 * The objects will be removed from the table part and their lifetime will
7669 * not be handled by the layout anymore. This is equivalent to
7670 * elm_layout_table_unpack() for all table children.
7672 * @see elm_layout_table_pack()
7673 * @see elm_layout_table_unpack()
7677 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7679 * Get the edje layout
7681 * @param obj The layout object
7683 * @return A Evas_Object with the edje layout settings loaded
7684 * with function elm_layout_file_set
7686 * This returns the edje object. It is not expected to be used to then
7687 * swallow objects via edje_object_part_swallow() for example. Use
7688 * elm_layout_content_set() instead so child object handling and sizing is
7691 * @note This function should only be used if you really need to call some
7692 * low level Edje function on this edje object. All the common stuff (setting
7693 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7694 * with proper elementary functions.
7696 * @see elm_object_signal_callback_add()
7697 * @see elm_object_signal_emit()
7698 * @see elm_object_text_part_set()
7699 * @see elm_layout_content_set()
7700 * @see elm_layout_box_append()
7701 * @see elm_layout_table_pack()
7702 * @see elm_layout_data_get()
7706 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7708 * Get the edje data from the given layout
7710 * @param obj The layout object
7711 * @param key The data key
7713 * @return The edje data string
7715 * This function fetches data specified inside the edje theme of this layout.
7716 * This function return NULL if data is not found.
7718 * In EDC this comes from a data block within the group block that @p
7719 * obj was loaded from. E.g.
7726 * item: "key1" "value1";
7727 * item: "key2" "value2";
7735 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7739 * @param obj The layout object
7741 * Manually forces a sizing re-evaluation. This is useful when the minimum
7742 * size required by the edje theme of this layout has changed. The change on
7743 * the minimum size required by the edje theme is not immediately reported to
7744 * the elementary layout, so one needs to call this function in order to tell
7745 * the widget (layout) that it needs to reevaluate its own size.
7747 * The minimum size of the theme is calculated based on minimum size of
7748 * parts, the size of elements inside containers like box and table, etc. All
7749 * of this can change due to state changes, and that's when this function
7752 * Also note that a standard signal of "size,eval" "elm" emitted from the
7753 * edje object will cause this to happen too.
7757 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7758 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7759 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7760 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7761 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7762 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7763 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);
7764 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7766 * @def elm_layout_icon_set
7767 * Convienience macro to set the icon object in a layout that follows the
7768 * Elementary naming convention for its parts.
7772 #define elm_layout_icon_set(_ly, _obj) \
7775 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7776 if ((_obj)) sig = "elm,state,icon,visible"; \
7777 else sig = "elm,state,icon,hidden"; \
7778 elm_object_signal_emit((_ly), sig, "elm"); \
7782 * @def elm_layout_icon_get
7783 * Convienience macro to get the icon object from a layout that follows the
7784 * Elementary naming convention for its parts.
7788 #define elm_layout_icon_get(_ly) \
7789 elm_layout_content_get((_ly), "elm.swallow.icon")
7792 * @def elm_layout_end_set
7793 * Convienience macro to set the end object in a layout that follows the
7794 * Elementary naming convention for its parts.
7798 #define elm_layout_end_set(_ly, _obj) \
7801 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7802 if ((_obj)) sig = "elm,state,end,visible"; \
7803 else sig = "elm,state,end,hidden"; \
7804 elm_object_signal_emit((_ly), sig, "elm"); \
7808 * @def elm_layout_end_get
7809 * Convienience macro to get the end object in a layout that follows the
7810 * Elementary naming convention for its parts.
7814 #define elm_layout_end_get(_ly) \
7815 elm_layout_content_get((_ly), "elm.swallow.end")
7818 * @def elm_layout_label_set
7819 * Convienience macro to set the label in a layout that follows the
7820 * Elementary naming convention for its parts.
7823 * @deprecated use elm_object_text_* instead.
7825 #define elm_layout_label_set(_ly, _txt) \
7826 elm_layout_text_set((_ly), "elm.text", (_txt))
7829 * @def elm_layout_label_get
7830 * Convienience macro to get the label in a layout that follows the
7831 * Elementary naming convention for its parts.
7834 * @deprecated use elm_object_text_* instead.
7836 #define elm_layout_label_get(_ly) \
7837 elm_layout_text_get((_ly), "elm.text")
7839 /* smart callbacks called:
7840 * "theme,changed" - when elm theme is changed.
7844 * @defgroup Notify Notify
7846 * @image html img/widget/notify/preview-00.png
7847 * @image latex img/widget/notify/preview-00.eps
7849 * Display a container in a particular region of the parent(top, bottom,
7850 * etc. A timeout can be set to automatically hide the notify. This is so
7851 * that, after an evas_object_show() on a notify object, if a timeout was set
7852 * on it, it will @b automatically get hidden after that time.
7854 * Signals that you can add callbacks for are:
7855 * @li "timeout" - when timeout happens on notify and it's hidden
7856 * @li "block,clicked" - when a click outside of the notify happens
7858 * @ref tutorial_notify show usage of the API.
7863 * @brief Possible orient values for notify.
7865 * This values should be used in conjunction to elm_notify_orient_set() to
7866 * set the position in which the notify should appear(relative to its parent)
7867 * and in conjunction with elm_notify_orient_get() to know where the notify
7870 typedef enum _Elm_Notify_Orient
7872 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7873 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7874 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7875 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7876 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7877 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7878 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7879 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7880 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7881 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7882 } Elm_Notify_Orient;
7884 * @brief Add a new notify to the parent
7886 * @param parent The parent object
7887 * @return The new object or NULL if it cannot be created
7889 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7891 * @brief Set the content of the notify widget
7893 * @param obj The notify object
7894 * @param content The content will be filled in this notify object
7896 * Once the content object is set, a previously set one will be deleted. If
7897 * you want to keep that old content object, use the
7898 * elm_notify_content_unset() function.
7900 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7902 * @brief Unset the content of the notify widget
7904 * @param obj The notify object
7905 * @return The content that was being used
7907 * Unparent and return the content object which was set for this widget
7909 * @see elm_notify_content_set()
7911 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7913 * @brief Return the content of the notify widget
7915 * @param obj The notify object
7916 * @return The content that is being used
7918 * @see elm_notify_content_set()
7920 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7922 * @brief Set the notify parent
7924 * @param obj The notify object
7925 * @param content The new parent
7927 * Once the parent object is set, a previously set one will be disconnected
7930 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7932 * @brief Get the notify parent
7934 * @param obj The notify object
7935 * @return The parent
7937 * @see elm_notify_parent_set()
7939 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7941 * @brief Set the orientation
7943 * @param obj The notify object
7944 * @param orient The new orientation
7946 * Sets the position in which the notify will appear in its parent.
7948 * @see @ref Elm_Notify_Orient for possible values.
7950 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7952 * @brief Return the orientation
7953 * @param obj The notify object
7954 * @return The orientation of the notification
7956 * @see elm_notify_orient_set()
7957 * @see Elm_Notify_Orient
7959 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7961 * @brief Set the time interval after which the notify window is going to be
7964 * @param obj The notify object
7965 * @param time The timeout in seconds
7967 * This function sets a timeout and starts the timer controlling when the
7968 * notify is hidden. Since calling evas_object_show() on a notify restarts
7969 * the timer controlling when the notify is hidden, setting this before the
7970 * notify is shown will in effect mean starting the timer when the notify is
7973 * @note Set a value <= 0.0 to disable a running timer.
7975 * @note If the value > 0.0 and the notify is previously visible, the
7976 * timer will be started with this value, canceling any running timer.
7978 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7980 * @brief Return the timeout value (in seconds)
7981 * @param obj the notify object
7983 * @see elm_notify_timeout_set()
7985 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7987 * @brief Sets whether events should be passed to by a click outside
7990 * @param obj The notify object
7991 * @param repeats EINA_TRUE Events are repeats, else no
7993 * When true if the user clicks outside the window the events will be caught
7994 * by the others widgets, else the events are blocked.
7996 * @note The default value is EINA_TRUE.
7998 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8000 * @brief Return true if events are repeat below the notify object
8001 * @param obj the notify object
8003 * @see elm_notify_repeat_events_set()
8005 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8011 * @defgroup Hover Hover
8013 * @image html img/widget/hover/preview-00.png
8014 * @image latex img/widget/hover/preview-00.eps
8016 * A Hover object will hover over its @p parent object at the @p target
8017 * location. Anything in the background will be given a darker coloring to
8018 * indicate that the hover object is on top (at the default theme). When the
8019 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8020 * clicked that @b doesn't cause the hover to be dismissed.
8022 * @note The hover object will take up the entire space of @p target
8025 * Elementary has the following styles for the hover widget:
8029 * @li hoversel_vertical
8031 * The following are the available position for content:
8043 * Signals that you can add callbacks for are:
8044 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8045 * @li "smart,changed" - a content object placed under the "smart"
8046 * policy was replaced to a new slot direction.
8048 * See @ref tutorial_hover for more information.
8052 typedef enum _Elm_Hover_Axis
8054 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8055 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8056 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8057 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8060 * @brief Adds a hover object to @p parent
8062 * @param parent The parent object
8063 * @return The hover object or NULL if one could not be created
8065 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8067 * @brief Sets the target object for the hover.
8069 * @param obj The hover object
8070 * @param target The object to center the hover onto. The hover
8072 * This function will cause the hover to be centered on the target object.
8074 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8076 * @brief Gets the target object for the hover.
8078 * @param obj The hover object
8079 * @param parent The object to locate the hover over.
8081 * @see elm_hover_target_set()
8083 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8085 * @brief Sets the parent object for the hover.
8087 * @param obj The hover object
8088 * @param parent The object to locate the hover over.
8090 * This function will cause the hover to take up the entire space that the
8091 * parent object fills.
8093 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8095 * @brief Gets the parent object for the hover.
8097 * @param obj The hover object
8098 * @return The parent object to locate the hover over.
8100 * @see elm_hover_parent_set()
8102 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8104 * @brief Sets the content of the hover object and the direction in which it
8107 * @param obj The hover object
8108 * @param swallow The direction that the object will be displayed
8109 * at. Accepted values are "left", "top-left", "top", "top-right",
8110 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8112 * @param content The content to place at @p swallow
8114 * Once the content object is set for a given direction, a previously
8115 * set one (on the same direction) will be deleted. If you want to
8116 * keep that old content object, use the elm_hover_content_unset()
8119 * All directions may have contents at the same time, except for
8120 * "smart". This is a special placement hint and its use case
8121 * independs of the calculations coming from
8122 * elm_hover_best_content_location_get(). Its use is for cases when
8123 * one desires only one hover content, but with a dinamic special
8124 * placement within the hover area. The content's geometry, whenever
8125 * it changes, will be used to decide on a best location not
8126 * extrapolating the hover's parent object view to show it in (still
8127 * being the hover's target determinant of its medium part -- move and
8128 * resize it to simulate finger sizes, for example). If one of the
8129 * directions other than "smart" are used, a previously content set
8130 * using it will be deleted, and vice-versa.
8132 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8134 * @brief Get the content of the hover object, in a given direction.
8136 * Return the content object which was set for this widget in the
8137 * @p swallow direction.
8139 * @param obj The hover object
8140 * @param swallow The direction that the object was display at.
8141 * @return The content that was being used
8143 * @see elm_hover_content_set()
8145 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8147 * @brief Unset the content of the hover object, in a given direction.
8149 * Unparent and return the content object set at @p swallow direction.
8151 * @param obj The hover object
8152 * @param swallow The direction that the object was display at.
8153 * @return The content that was being used.
8155 * @see elm_hover_content_set()
8157 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8159 * @brief Returns the best swallow location for content in the hover.
8161 * @param obj The hover object
8162 * @param pref_axis The preferred orientation axis for the hover object to use
8163 * @return The edje location to place content into the hover or @c
8166 * Best is defined here as the location at which there is the most available
8169 * @p pref_axis may be one of
8170 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8171 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8172 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8173 * - @c ELM_HOVER_AXIS_BOTH -- both
8175 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8176 * nescessarily be along the horizontal axis("left" or "right"). If
8177 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8178 * be along the vertical axis("top" or "bottom"). Chossing
8179 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8180 * returned position may be in either axis.
8182 * @see elm_hover_content_set()
8184 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8191 * @defgroup Entry Entry
8193 * @image html img/widget/entry/preview-00.png
8194 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8195 * @image html img/widget/entry/preview-01.png
8196 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8197 * @image html img/widget/entry/preview-02.png
8198 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8199 * @image html img/widget/entry/preview-03.png
8200 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8202 * An entry is a convenience widget which shows a box that the user can
8203 * enter text into. Entries by default don't scroll, so they grow to
8204 * accomodate the entire text, resizing the parent window as needed. This
8205 * can be changed with the elm_entry_scrollable_set() function.
8207 * They can also be single line or multi line (the default) and when set
8208 * to multi line mode they support text wrapping in any of the modes
8209 * indicated by #Elm_Wrap_Type.
8211 * Other features include password mode, filtering of inserted text with
8212 * elm_entry_text_filter_append() and related functions, inline "items" and
8213 * formatted markup text.
8215 * @section entry-markup Formatted text
8217 * The markup tags supported by the Entry are defined by the theme, but
8218 * even when writing new themes or extensions it's a good idea to stick to
8219 * a sane default, to maintain coherency and avoid application breakages.
8220 * Currently defined by the default theme are the following tags:
8221 * @li \<br\>: Inserts a line break.
8222 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8224 * @li \<tab\>: Inserts a tab.
8225 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8227 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8228 * @li \<link\>...\</link\>: Underlines the enclosed text.
8229 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8231 * @section entry-special Special markups
8233 * Besides those used to format text, entries support two special markup
8234 * tags used to insert clickable portions of text or items inlined within
8237 * @subsection entry-anchors Anchors
8239 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8240 * \</a\> tags and an event will be generated when this text is clicked,
8244 * This text is outside <a href=anc-01>but this one is an anchor</a>
8247 * The @c href attribute in the opening tag gives the name that will be
8248 * used to identify the anchor and it can be any valid utf8 string.
8250 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8251 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8252 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8253 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8256 * @subsection entry-items Items
8258 * Inlined in the text, any other @c Evas_Object can be inserted by using
8259 * \<item\> tags this way:
8262 * <item size=16x16 vsize=full href=emoticon/haha></item>
8265 * Just like with anchors, the @c href identifies each item, but these need,
8266 * in addition, to indicate their size, which is done using any one of
8267 * @c size, @c absize or @c relsize attributes. These attributes take their
8268 * value in the WxH format, where W is the width and H the height of the
8271 * @li absize: Absolute pixel size for the item. Whatever value is set will
8272 * be the item's size regardless of any scale value the object may have
8273 * been set to. The final line height will be adjusted to fit larger items.
8274 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8276 * @li relsize: Size is adjusted for the item to fit within the current
8279 * Besides their size, items are specificed a @c vsize value that affects
8280 * how their final size and position are calculated. The possible values
8282 * @li ascent: Item will be placed within the line's baseline and its
8283 * ascent. That is, the height between the line where all characters are
8284 * positioned and the highest point in the line. For @c size and @c absize
8285 * items, the descent value will be added to the total line height to make
8286 * them fit. @c relsize items will be adjusted to fit within this space.
8287 * @li full: Items will be placed between the descent and ascent, or the
8288 * lowest point in the line and its highest.
8290 * The next image shows different configurations of items and how they
8291 * are the previously mentioned options affect their sizes. In all cases,
8292 * the green line indicates the ascent, blue for the baseline and red for
8295 * @image html entry_item.png
8296 * @image latex entry_item.eps width=\textwidth
8298 * And another one to show how size differs from absize. In the first one,
8299 * the scale value is set to 1.0, while the second one is using one of 2.0.
8301 * @image html entry_item_scale.png
8302 * @image latex entry_item_scale.eps width=\textwidth
8304 * After the size for an item is calculated, the entry will request an
8305 * object to place in its space. For this, the functions set with
8306 * elm_entry_item_provider_append() and related functions will be called
8307 * in order until one of them returns a @c non-NULL value. If no providers
8308 * are available, or all of them return @c NULL, then the entry falls back
8309 * to one of the internal defaults, provided the name matches with one of
8312 * All of the following are currently supported:
8315 * - emoticon/angry-shout
8316 * - emoticon/crazy-laugh
8317 * - emoticon/evil-laugh
8319 * - emoticon/goggle-smile
8321 * - emoticon/grumpy-smile
8323 * - emoticon/guilty-smile
8325 * - emoticon/half-smile
8326 * - emoticon/happy-panting
8328 * - emoticon/indifferent
8330 * - emoticon/knowing-grin
8332 * - emoticon/little-bit-sorry
8333 * - emoticon/love-lots
8335 * - emoticon/minimal-smile
8336 * - emoticon/not-happy
8337 * - emoticon/not-impressed
8339 * - emoticon/opensmile
8342 * - emoticon/squint-laugh
8343 * - emoticon/surprised
8344 * - emoticon/suspicious
8345 * - emoticon/tongue-dangling
8346 * - emoticon/tongue-poke
8348 * - emoticon/unhappy
8349 * - emoticon/very-sorry
8352 * - emoticon/worried
8355 * Alternatively, an item may reference an image by its path, using
8356 * the URI form @c file:///path/to/an/image.png and the entry will then
8357 * use that image for the item.
8359 * @section entry-files Loading and saving files
8361 * Entries have convinience functions to load text from a file and save
8362 * changes back to it after a short delay. The automatic saving is enabled
8363 * by default, but can be disabled with elm_entry_autosave_set() and files
8364 * can be loaded directly as plain text or have any markup in them
8365 * recognized. See elm_entry_file_set() for more details.
8367 * @section entry-signals Emitted signals
8369 * This widget emits the following signals:
8371 * @li "changed": The text within the entry was changed.
8372 * @li "changed,user": The text within the entry was changed because of user interaction.
8373 * @li "activated": The enter key was pressed on a single line entry.
8374 * @li "press": A mouse button has been pressed on the entry.
8375 * @li "longpressed": A mouse button has been pressed and held for a couple
8377 * @li "clicked": The entry has been clicked (mouse press and release).
8378 * @li "clicked,double": The entry has been double clicked.
8379 * @li "clicked,triple": The entry has been triple clicked.
8380 * @li "focused": The entry has received focus.
8381 * @li "unfocused": The entry has lost focus.
8382 * @li "selection,paste": A paste of the clipboard contents was requested.
8383 * @li "selection,copy": A copy of the selected text into the clipboard was
8385 * @li "selection,cut": A cut of the selected text into the clipboard was
8387 * @li "selection,start": A selection has begun and no previous selection
8389 * @li "selection,changed": The current selection has changed.
8390 * @li "selection,cleared": The current selection has been cleared.
8391 * @li "cursor,changed": The cursor has changed position.
8392 * @li "anchor,clicked": An anchor has been clicked. The event_info
8393 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8394 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8395 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8396 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8397 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8398 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8399 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8400 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8401 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8402 * @li "preedit,changed": The preedit string has changed.
8404 * @section entry-examples
8406 * An overview of the Entry API can be seen in @ref entry_example_01
8411 * @typedef Elm_Entry_Anchor_Info
8413 * The info sent in the callback for the "anchor,clicked" signals emitted
8416 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8418 * @struct _Elm_Entry_Anchor_Info
8420 * The info sent in the callback for the "anchor,clicked" signals emitted
8423 struct _Elm_Entry_Anchor_Info
8425 const char *name; /**< The name of the anchor, as stated in its href */
8426 int button; /**< The mouse button used to click on it */
8427 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8428 y, /**< Anchor geometry, relative to canvas */
8429 w, /**< Anchor geometry, relative to canvas */
8430 h; /**< Anchor geometry, relative to canvas */
8433 * @typedef Elm_Entry_Filter_Cb
8434 * This callback type is used by entry filters to modify text.
8435 * @param data The data specified as the last param when adding the filter
8436 * @param entry The entry object
8437 * @param text A pointer to the location of the text being filtered. This data can be modified,
8438 * but any additional allocations must be managed by the user.
8439 * @see elm_entry_text_filter_append
8440 * @see elm_entry_text_filter_prepend
8442 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8445 * This adds an entry to @p parent object.
8447 * By default, entries are:
8451 * @li autosave is enabled
8453 * @param parent The parent object
8454 * @return The new object or NULL if it cannot be created
8456 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8458 * Sets the entry to single line mode.
8460 * In single line mode, entries don't ever wrap when the text reaches the
8461 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8462 * key will generate an @c "activate" event instead of adding a new line.
8464 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8465 * and pressing enter will break the text into a different line
8466 * without generating any events.
8468 * @param obj The entry object
8469 * @param single_line If true, the text in the entry
8470 * will be on a single line.
8472 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8474 * Gets whether the entry is set to be single line.
8476 * @param obj The entry object
8477 * @return single_line If true, the text in the entry is set to display
8480 * @see elm_entry_single_line_set()
8482 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8484 * Sets the entry to password mode.
8486 * In password mode, entries are implicitly single line and the display of
8487 * any text in them is replaced with asterisks (*).
8489 * @param obj The entry object
8490 * @param password If true, password mode is enabled.
8492 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8494 * Gets whether the entry is set to password mode.
8496 * @param obj The entry object
8497 * @return If true, the entry is set to display all characters
8500 * @see elm_entry_password_set()
8502 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8504 * This sets the text displayed within the entry to @p entry.
8506 * @param obj The entry object
8507 * @param entry The text to be displayed
8509 * @deprecated Use elm_object_text_set() instead.
8511 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8513 * This returns the text currently shown in object @p entry.
8514 * See also elm_entry_entry_set().
8516 * @param obj The entry object
8517 * @return The currently displayed text or NULL on failure
8519 * @deprecated Use elm_object_text_get() instead.
8521 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8523 * Appends @p entry to the text of the entry.
8525 * Adds the text in @p entry to the end of any text already present in the
8528 * The appended text is subject to any filters set for the widget.
8530 * @param obj The entry object
8531 * @param entry The text to be displayed
8533 * @see elm_entry_text_filter_append()
8535 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8537 * Gets whether the entry is empty.
8539 * Empty means no text at all. If there are any markup tags, like an item
8540 * tag for which no provider finds anything, and no text is displayed, this
8541 * function still returns EINA_FALSE.
8543 * @param obj The entry object
8544 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8546 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8548 * Gets any selected text within the entry.
8550 * If there's any selected text in the entry, this function returns it as
8551 * a string in markup format. NULL is returned if no selection exists or
8552 * if an error occurred.
8554 * The returned value points to an internal string and should not be freed
8555 * or modified in any way. If the @p entry object is deleted or its
8556 * contents are changed, the returned pointer should be considered invalid.
8558 * @param obj The entry object
8559 * @return The selected text within the entry or NULL on failure
8561 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8563 * Inserts the given text into the entry at the current cursor position.
8565 * This inserts text at the cursor position as if it was typed
8566 * by the user (note that this also allows markup which a user
8567 * can't just "type" as it would be converted to escaped text, so this
8568 * call can be used to insert things like emoticon items or bold push/pop
8569 * tags, other font and color change tags etc.)
8571 * If any selection exists, it will be replaced by the inserted text.
8573 * The inserted text is subject to any filters set for the widget.
8575 * @param obj The entry object
8576 * @param entry The text to insert
8578 * @see elm_entry_text_filter_append()
8580 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8582 * Set the line wrap type to use on multi-line entries.
8584 * Sets the wrap type used by the entry to any of the specified in
8585 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8586 * line (without inserting a line break or paragraph separator) when it
8587 * reaches the far edge of the widget.
8589 * Note that this only makes sense for multi-line entries. A widget set
8590 * to be single line will never wrap.
8592 * @param obj The entry object
8593 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8595 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8597 * Gets the wrap mode the entry was set to use.
8599 * @param obj The entry object
8602 * @see also elm_entry_line_wrap_set()
8604 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8606 * Sets if the entry is to be editable or not.
8608 * By default, entries are editable and when focused, any text input by the
8609 * user will be inserted at the current cursor position. But calling this
8610 * function with @p editable as EINA_FALSE will prevent the user from
8611 * inputting text into the entry.
8613 * The only way to change the text of a non-editable entry is to use
8614 * elm_object_text_set(), elm_entry_entry_insert() and other related
8617 * @param obj The entry object
8618 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8619 * if not, the entry is read-only and no user input is allowed.
8621 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8623 * Gets whether the entry is editable or not.
8625 * @param obj The entry object
8626 * @return If true, the entry is editable by the user.
8627 * If false, it is not editable by the user
8629 * @see elm_entry_editable_set()
8631 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8633 * This drops any existing text selection within the entry.
8635 * @param obj The entry object
8637 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8639 * This selects all text within the entry.
8641 * @param obj The entry object
8643 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8645 * This moves the cursor one place to the right within the entry.
8647 * @param obj The entry object
8648 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8650 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8652 * This moves the cursor one place to the left within the entry.
8654 * @param obj The entry object
8655 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8657 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8659 * This moves the cursor one line up within the entry.
8661 * @param obj The entry object
8662 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8664 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8666 * This moves the cursor one line down within the entry.
8668 * @param obj The entry object
8669 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8671 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8673 * This moves the cursor to the beginning of the entry.
8675 * @param obj The entry object
8677 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8679 * This moves the cursor to the end of the entry.
8681 * @param obj The entry object
8683 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8685 * This moves the cursor to the beginning of the current line.
8687 * @param obj The entry object
8689 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8691 * This moves the cursor to the end of the current line.
8693 * @param obj The entry object
8695 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8697 * This begins a selection within the entry as though
8698 * the user were holding down the mouse button to make a selection.
8700 * @param obj The entry object
8702 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8704 * This ends a selection within the entry as though
8705 * the user had just released the mouse button while making a selection.
8707 * @param obj The entry object
8709 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8711 * Gets whether a format node exists at the current cursor position.
8713 * A format node is anything that defines how the text is rendered. It can
8714 * be a visible format node, such as a line break or a paragraph separator,
8715 * or an invisible one, such as bold begin or end tag.
8716 * This function returns whether any format node exists at the current
8719 * @param obj The entry object
8720 * @return EINA_TRUE if the current cursor position contains a format node,
8721 * EINA_FALSE otherwise.
8723 * @see elm_entry_cursor_is_visible_format_get()
8725 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8727 * Gets if the current cursor position holds a visible format node.
8729 * @param obj The entry object
8730 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8731 * if it's an invisible one or no format exists.
8733 * @see elm_entry_cursor_is_format_get()
8735 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8737 * Gets the character pointed by the cursor at its current position.
8739 * This function returns a string with the utf8 character stored at the
8740 * current cursor position.
8741 * Only the text is returned, any format that may exist will not be part
8742 * of the return value.
8744 * @param obj The entry object
8745 * @return The text pointed by the cursors.
8747 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8749 * This function returns the geometry of the cursor.
8751 * It's useful if you want to draw something on the cursor (or where it is),
8752 * or for example in the case of scrolled entry where you want to show the
8755 * @param obj The entry object
8756 * @param x returned geometry
8757 * @param y returned geometry
8758 * @param w returned geometry
8759 * @param h returned geometry
8760 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8762 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);
8764 * Sets the cursor position in the entry to the given value
8766 * The value in @p pos is the index of the character position within the
8767 * contents of the string as returned by elm_entry_cursor_pos_get().
8769 * @param obj The entry object
8770 * @param pos The position of the cursor
8772 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8774 * Retrieves the current position of the cursor in the entry
8776 * @param obj The entry object
8777 * @return The cursor position
8779 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8781 * This executes a "cut" action on the selected text in the entry.
8783 * @param obj The entry object
8785 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8787 * This executes a "copy" action on the selected text in the entry.
8789 * @param obj The entry object
8791 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8793 * This executes a "paste" action in the entry.
8795 * @param obj The entry object
8797 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8799 * This clears and frees the items in a entry's contextual (longpress)
8802 * @param obj The entry object
8804 * @see elm_entry_context_menu_item_add()
8806 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8808 * This adds an item to the entry's contextual menu.
8810 * A longpress on an entry will make the contextual menu show up, if this
8811 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8812 * By default, this menu provides a few options like enabling selection mode,
8813 * which is useful on embedded devices that need to be explicit about it,
8814 * and when a selection exists it also shows the copy and cut actions.
8816 * With this function, developers can add other options to this menu to
8817 * perform any action they deem necessary.
8819 * @param obj The entry object
8820 * @param label The item's text label
8821 * @param icon_file The item's icon file
8822 * @param icon_type The item's icon type
8823 * @param func The callback to execute when the item is clicked
8824 * @param data The data to associate with the item for related functions
8826 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);
8828 * This disables the entry's contextual (longpress) menu.
8830 * @param obj The entry object
8831 * @param disabled If true, the menu is disabled
8833 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8835 * This returns whether the entry's contextual (longpress) menu is
8838 * @param obj The entry object
8839 * @return If true, the menu is disabled
8841 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8843 * This appends a custom item provider to the list for that entry
8845 * This appends the given callback. The list is walked from beginning to end
8846 * with each function called given the item href string in the text. If the
8847 * function returns an object handle other than NULL (it should create an
8848 * object to do this), then this object is used to replace that item. If
8849 * not the next provider is called until one provides an item object, or the
8850 * default provider in entry does.
8852 * @param obj The entry object
8853 * @param func The function called to provide the item object
8854 * @param data The data passed to @p func
8856 * @see @ref entry-items
8858 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);
8860 * This prepends a custom item provider to the list for that entry
8862 * This prepends the given callback. See elm_entry_item_provider_append() for
8865 * @param obj The entry object
8866 * @param func The function called to provide the item object
8867 * @param data The data passed to @p func
8869 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);
8871 * This removes a custom item provider to the list for that entry
8873 * This removes the given callback. See elm_entry_item_provider_append() for
8876 * @param obj The entry object
8877 * @param func The function called to provide the item object
8878 * @param data The data passed to @p func
8880 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);
8882 * Append a filter function for text inserted in the entry
8884 * Append the given callback to the list. This functions will be called
8885 * whenever any text is inserted into the entry, with the text to be inserted
8886 * as a parameter. The callback function is free to alter the text in any way
8887 * it wants, but it must remember to free the given pointer and update it.
8888 * If the new text is to be discarded, the function can free it and set its
8889 * text parameter to NULL. This will also prevent any following filters from
8892 * @param obj The entry object
8893 * @param func The function to use as text filter
8894 * @param data User data to pass to @p func
8896 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8898 * Prepend a filter function for text insdrted in the entry
8900 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8901 * for more information
8903 * @param obj The entry object
8904 * @param func The function to use as text filter
8905 * @param data User data to pass to @p func
8907 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8909 * Remove a filter from the list
8911 * Removes the given callback from the filter list. See
8912 * elm_entry_text_filter_append() for more information.
8914 * @param obj The entry object
8915 * @param func The filter function to remove
8916 * @param data The user data passed when adding the function
8918 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8920 * This converts a markup (HTML-like) string into UTF-8.
8922 * The returned string is a malloc'ed buffer and it should be freed when
8923 * not needed anymore.
8925 * @param s The string (in markup) to be converted
8926 * @return The converted string (in UTF-8). It should be freed.
8928 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8930 * This converts a UTF-8 string into markup (HTML-like).
8932 * The returned string is a malloc'ed buffer and it should be freed when
8933 * not needed anymore.
8935 * @param s The string (in UTF-8) to be converted
8936 * @return The converted string (in markup). It should be freed.
8938 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8940 * This sets the file (and implicitly loads it) for the text to display and
8941 * then edit. All changes are written back to the file after a short delay if
8942 * the entry object is set to autosave (which is the default).
8944 * If the entry had any other file set previously, any changes made to it
8945 * will be saved if the autosave feature is enabled, otherwise, the file
8946 * will be silently discarded and any non-saved changes will be lost.
8948 * @param obj The entry object
8949 * @param file The path to the file to load and save
8950 * @param format The file format
8952 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8954 * Gets the file being edited by the entry.
8956 * This function can be used to retrieve any file set on the entry for
8957 * edition, along with the format used to load and save it.
8959 * @param obj The entry object
8960 * @param file The path to the file to load and save
8961 * @param format The file format
8963 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8965 * This function writes any changes made to the file set with
8966 * elm_entry_file_set()
8968 * @param obj The entry object
8970 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8972 * This sets the entry object to 'autosave' the loaded text file or not.
8974 * @param obj The entry object
8975 * @param autosave Autosave the loaded file or not
8977 * @see elm_entry_file_set()
8979 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8981 * This gets the entry object's 'autosave' status.
8983 * @param obj The entry object
8984 * @return Autosave the loaded file or not
8986 * @see elm_entry_file_set()
8988 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8990 * Control pasting of text and images for the widget.
8992 * Normally the entry allows both text and images to be pasted. By setting
8993 * textonly to be true, this prevents images from being pasted.
8995 * Note this only changes the behaviour of text.
8997 * @param obj The entry object
8998 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9001 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9003 * Getting elm_entry text paste/drop mode.
9005 * In textonly mode, only text may be pasted or dropped into the widget.
9007 * @param obj The entry object
9008 * @return If the widget only accepts text from pastes.
9010 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9012 * Enable or disable scrolling in entry
9014 * Normally the entry is not scrollable unless you enable it with this call.
9016 * @param obj The entry object
9017 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9019 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9021 * Get the scrollable state of the entry
9023 * Normally the entry is not scrollable. This gets the scrollable state
9024 * of the entry. See elm_entry_scrollable_set() for more information.
9026 * @param obj The entry object
9027 * @return The scrollable state
9029 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9031 * This sets a widget to be displayed to the left of a scrolled entry.
9033 * @param obj The scrolled entry object
9034 * @param icon The widget to display on the left side of the scrolled
9037 * @note A previously set widget will be destroyed.
9038 * @note If the object being set does not have minimum size hints set,
9039 * it won't get properly displayed.
9041 * @see elm_entry_end_set()
9043 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9045 * Gets the leftmost widget of the scrolled entry. This object is
9046 * owned by the scrolled entry and should not be modified.
9048 * @param obj The scrolled entry object
9049 * @return the left widget inside the scroller
9051 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9053 * Unset the leftmost widget of the scrolled entry, unparenting and
9056 * @param obj The scrolled entry object
9057 * @return the previously set icon sub-object of this entry, on
9060 * @see elm_entry_icon_set()
9062 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9064 * Sets the visibility of the left-side widget of the scrolled entry,
9065 * set by elm_entry_icon_set().
9067 * @param obj The scrolled entry object
9068 * @param setting EINA_TRUE if the object should be displayed,
9069 * EINA_FALSE if not.
9071 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9073 * This sets a widget to be displayed to the end of a scrolled entry.
9075 * @param obj The scrolled entry object
9076 * @param end The widget to display on the right side of the scrolled
9079 * @note A previously set widget will be destroyed.
9080 * @note If the object being set does not have minimum size hints set,
9081 * it won't get properly displayed.
9083 * @see elm_entry_icon_set
9085 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9087 * Gets the endmost widget of the scrolled entry. This object is owned
9088 * by the scrolled entry and should not be modified.
9090 * @param obj The scrolled entry object
9091 * @return the right widget inside the scroller
9093 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9095 * Unset the endmost widget of the scrolled entry, unparenting and
9098 * @param obj The scrolled entry object
9099 * @return the previously set icon sub-object of this entry, on
9102 * @see elm_entry_icon_set()
9104 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9106 * Sets the visibility of the end widget of the scrolled entry, set by
9107 * elm_entry_end_set().
9109 * @param obj The scrolled entry object
9110 * @param setting EINA_TRUE if the object should be displayed,
9111 * EINA_FALSE if not.
9113 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9115 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9118 * Setting an entry to single-line mode with elm_entry_single_line_set()
9119 * will automatically disable the display of scrollbars when the entry
9120 * moves inside its scroller.
9122 * @param obj The scrolled entry object
9123 * @param h The horizontal scrollbar policy to apply
9124 * @param v The vertical scrollbar policy to apply
9126 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9128 * This enables/disables bouncing within the entry.
9130 * This function sets whether the entry will bounce when scrolling reaches
9131 * the end of the contained entry.
9133 * @param obj The scrolled entry object
9134 * @param h The horizontal bounce state
9135 * @param v The vertical bounce state
9137 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9139 * Get the bounce mode
9141 * @param obj The Entry object
9142 * @param h_bounce Allow bounce horizontally
9143 * @param v_bounce Allow bounce vertically
9145 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9147 /* pre-made filters for entries */
9149 * @typedef Elm_Entry_Filter_Limit_Size
9151 * Data for the elm_entry_filter_limit_size() entry filter.
9153 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9155 * @struct _Elm_Entry_Filter_Limit_Size
9157 * Data for the elm_entry_filter_limit_size() entry filter.
9159 struct _Elm_Entry_Filter_Limit_Size
9161 int max_char_count; /**< The maximum number of characters allowed. */
9162 int max_byte_count; /**< The maximum number of bytes allowed*/
9165 * Filter inserted text based on user defined character and byte limits
9167 * Add this filter to an entry to limit the characters that it will accept
9168 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9169 * The funtion works on the UTF-8 representation of the string, converting
9170 * it from the set markup, thus not accounting for any format in it.
9172 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9173 * it as data when setting the filter. In it, it's possible to set limits
9174 * by character count or bytes (any of them is disabled if 0), and both can
9175 * be set at the same time. In that case, it first checks for characters,
9178 * The function will cut the inserted text in order to allow only the first
9179 * number of characters that are still allowed. The cut is made in
9180 * characters, even when limiting by bytes, in order to always contain
9181 * valid ones and avoid half unicode characters making it in.
9183 * This filter, like any others, does not apply when setting the entry text
9184 * directly with elm_object_text_set() (or the deprecated
9185 * elm_entry_entry_set()).
9187 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9189 * @typedef Elm_Entry_Filter_Accept_Set
9191 * Data for the elm_entry_filter_accept_set() entry filter.
9193 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9195 * @struct _Elm_Entry_Filter_Accept_Set
9197 * Data for the elm_entry_filter_accept_set() entry filter.
9199 struct _Elm_Entry_Filter_Accept_Set
9201 const char *accepted; /**< Set of characters accepted in the entry. */
9202 const char *rejected; /**< Set of characters rejected from the entry. */
9205 * Filter inserted text based on accepted or rejected sets of characters
9207 * Add this filter to an entry to restrict the set of accepted characters
9208 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9209 * This structure contains both accepted and rejected sets, but they are
9210 * mutually exclusive.
9212 * The @c accepted set takes preference, so if it is set, the filter will
9213 * only work based on the accepted characters, ignoring anything in the
9214 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9216 * In both cases, the function filters by matching utf8 characters to the
9217 * raw markup text, so it can be used to remove formatting tags.
9219 * This filter, like any others, does not apply when setting the entry text
9220 * directly with elm_object_text_set() (or the deprecated
9221 * elm_entry_entry_set()).
9223 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9228 /* composite widgets - these basically put together basic widgets above
9229 * in convenient packages that do more than basic stuff */
9233 * @defgroup Anchorview Anchorview
9235 * @image html img/widget/anchorview/preview-00.png
9236 * @image latex img/widget/anchorview/preview-00.eps
9238 * Anchorview is for displaying text that contains markup with anchors
9239 * like <c>\<a href=1234\>something\</\></c> in it.
9241 * Besides being styled differently, the anchorview widget provides the
9242 * necessary functionality so that clicking on these anchors brings up a
9243 * popup with user defined content such as "call", "add to contacts" or
9244 * "open web page". This popup is provided using the @ref Hover widget.
9246 * This widget is very similar to @ref Anchorblock, so refer to that
9247 * widget for an example. The only difference Anchorview has is that the
9248 * widget is already provided with scrolling functionality, so if the
9249 * text set to it is too large to fit in the given space, it will scroll,
9250 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9251 * text can be displayed.
9253 * This widget emits the following signals:
9254 * @li "anchor,clicked": will be called when an anchor is clicked. The
9255 * @p event_info parameter on the callback will be a pointer of type
9256 * ::Elm_Entry_Anchorview_Info.
9258 * See @ref Anchorblock for an example on how to use both of them.
9267 * @typedef Elm_Entry_Anchorview_Info
9269 * The info sent in the callback for "anchor,clicked" signals emitted by
9270 * the Anchorview widget.
9272 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9274 * @struct _Elm_Entry_Anchorview_Info
9276 * The info sent in the callback for "anchor,clicked" signals emitted by
9277 * the Anchorview widget.
9279 struct _Elm_Entry_Anchorview_Info
9281 const char *name; /**< Name of the anchor, as indicated in its href
9283 int button; /**< The mouse button used to click on it */
9284 Evas_Object *hover; /**< The hover object to use for the popup */
9286 Evas_Coord x, y, w, h;
9287 } anchor, /**< Geometry selection of text used as anchor */
9288 hover_parent; /**< Geometry of the object used as parent by the
9290 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9291 for content on the left side of
9292 the hover. Before calling the
9293 callback, the widget will make the
9294 necessary calculations to check
9295 which sides are fit to be set with
9296 content, based on the position the
9297 hover is activated and its distance
9298 to the edges of its parent object
9300 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9301 the right side of the hover.
9302 See @ref hover_left */
9303 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9304 of the hover. See @ref hover_left */
9305 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9306 below the hover. See @ref
9310 * Add a new Anchorview object
9312 * @param parent The parent object
9313 * @return The new object or NULL if it cannot be created
9315 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9317 * Set the text to show in the anchorview
9319 * Sets the text of the anchorview to @p text. This text can include markup
9320 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9321 * text that will be specially styled and react to click events, ended with
9322 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9323 * "anchor,clicked" signal that you can attach a callback to with
9324 * evas_object_smart_callback_add(). The name of the anchor given in the
9325 * event info struct will be the one set in the href attribute, in this
9328 * Other markup can be used to style the text in different ways, but it's
9329 * up to the style defined in the theme which tags do what.
9330 * @deprecated use elm_object_text_set() instead.
9332 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9334 * Get the markup text set for the anchorview
9336 * Retrieves the text set on the anchorview, with markup tags included.
9338 * @param obj The anchorview object
9339 * @return The markup text set or @c NULL if nothing was set or an error
9341 * @deprecated use elm_object_text_set() instead.
9343 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9345 * Set the parent of the hover popup
9347 * Sets the parent object to use by the hover created by the anchorview
9348 * when an anchor is clicked. See @ref Hover for more details on this.
9349 * If no parent is set, the same anchorview object will be used.
9351 * @param obj The anchorview object
9352 * @param parent The object to use as parent for the hover
9354 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9356 * Get the parent of the hover popup
9358 * Get the object used as parent for the hover created by the anchorview
9359 * widget. See @ref Hover for more details on this.
9361 * @param obj The anchorview object
9362 * @return The object used as parent for the hover, NULL if none is set.
9364 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9366 * Set the style that the hover should use
9368 * When creating the popup hover, anchorview will request that it's
9369 * themed according to @p style.
9371 * @param obj The anchorview object
9372 * @param style The style to use for the underlying hover
9374 * @see elm_object_style_set()
9376 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9378 * Get the style that the hover should use
9380 * Get the style the hover created by anchorview will use.
9382 * @param obj The anchorview object
9383 * @return The style to use by the hover. NULL means the default is used.
9385 * @see elm_object_style_set()
9387 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9389 * Ends the hover popup in the anchorview
9391 * When an anchor is clicked, the anchorview widget will create a hover
9392 * object to use as a popup with user provided content. This function
9393 * terminates this popup, returning the anchorview to its normal state.
9395 * @param obj The anchorview object
9397 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9399 * Set bouncing behaviour when the scrolled content reaches an edge
9401 * Tell the internal scroller object whether it should bounce or not
9402 * when it reaches the respective edges for each axis.
9404 * @param obj The anchorview object
9405 * @param h_bounce Whether to bounce or not in the horizontal axis
9406 * @param v_bounce Whether to bounce or not in the vertical axis
9408 * @see elm_scroller_bounce_set()
9410 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9412 * Get the set bouncing behaviour of the internal scroller
9414 * Get whether the internal scroller should bounce when the edge of each
9415 * axis is reached scrolling.
9417 * @param obj The anchorview object
9418 * @param h_bounce Pointer where to store the bounce state of the horizontal
9420 * @param v_bounce Pointer where to store the bounce state of the vertical
9423 * @see elm_scroller_bounce_get()
9425 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9427 * Appends a custom item provider to the given anchorview
9429 * Appends the given function to the list of items providers. This list is
9430 * called, one function at a time, with the given @p data pointer, the
9431 * anchorview object and, in the @p item parameter, the item name as
9432 * referenced in its href string. Following functions in the list will be
9433 * called in order until one of them returns something different to NULL,
9434 * which should be an Evas_Object which will be used in place of the item
9437 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9438 * href=item/name\>\</item\>
9440 * @param obj The anchorview object
9441 * @param func The function to add to the list of providers
9442 * @param data User data that will be passed to the callback function
9444 * @see elm_entry_item_provider_append()
9446 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);
9448 * Prepend a custom item provider to the given anchorview
9450 * Like elm_anchorview_item_provider_append(), but it adds the function
9451 * @p func to the beginning of the list, instead of the end.
9453 * @param obj The anchorview object
9454 * @param func The function to add to the list of providers
9455 * @param data User data that will be passed to the callback function
9457 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);
9459 * Remove a custom item provider from the list of the given anchorview
9461 * Removes the function and data pairing that matches @p func and @p data.
9462 * That is, unless the same function and same user data are given, the
9463 * function will not be removed from the list. This allows us to add the
9464 * same callback several times, with different @p data pointers and be
9465 * able to remove them later without conflicts.
9467 * @param obj The anchorview object
9468 * @param func The function to remove from the list
9469 * @param data The data matching the function to remove from the list
9471 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);
9478 * @defgroup Anchorblock Anchorblock
9480 * @image html img/widget/anchorblock/preview-00.png
9481 * @image latex img/widget/anchorblock/preview-00.eps
9483 * Anchorblock is for displaying text that contains markup with anchors
9484 * like <c>\<a href=1234\>something\</\></c> in it.
9486 * Besides being styled differently, the anchorblock widget provides the
9487 * necessary functionality so that clicking on these anchors brings up a
9488 * popup with user defined content such as "call", "add to contacts" or
9489 * "open web page". This popup is provided using the @ref Hover widget.
9491 * This widget emits the following signals:
9492 * @li "anchor,clicked": will be called when an anchor is clicked. The
9493 * @p event_info parameter on the callback will be a pointer of type
9494 * ::Elm_Entry_Anchorblock_Info.
9500 * Since examples are usually better than plain words, we might as well
9501 * try @ref tutorial_anchorblock_example "one".
9504 * @addtogroup Anchorblock
9508 * @typedef Elm_Entry_Anchorblock_Info
9510 * The info sent in the callback for "anchor,clicked" signals emitted by
9511 * the Anchorblock widget.
9513 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9515 * @struct _Elm_Entry_Anchorblock_Info
9517 * The info sent in the callback for "anchor,clicked" signals emitted by
9518 * the Anchorblock widget.
9520 struct _Elm_Entry_Anchorblock_Info
9522 const char *name; /**< Name of the anchor, as indicated in its href
9524 int button; /**< The mouse button used to click on it */
9525 Evas_Object *hover; /**< The hover object to use for the popup */
9527 Evas_Coord x, y, w, h;
9528 } anchor, /**< Geometry selection of text used as anchor */
9529 hover_parent; /**< Geometry of the object used as parent by the
9531 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9532 for content on the left side of
9533 the hover. Before calling the
9534 callback, the widget will make the
9535 necessary calculations to check
9536 which sides are fit to be set with
9537 content, based on the position the
9538 hover is activated and its distance
9539 to the edges of its parent object
9541 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9542 the right side of the hover.
9543 See @ref hover_left */
9544 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9545 of the hover. See @ref hover_left */
9546 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9547 below the hover. See @ref
9551 * Add a new Anchorblock object
9553 * @param parent The parent object
9554 * @return The new object or NULL if it cannot be created
9556 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9558 * Set the text to show in the anchorblock
9560 * Sets the text of the anchorblock to @p text. This text can include markup
9561 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9562 * of text that will be specially styled and react to click events, ended
9563 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9564 * "anchor,clicked" signal that you can attach a callback to with
9565 * evas_object_smart_callback_add(). The name of the anchor given in the
9566 * event info struct will be the one set in the href attribute, in this
9569 * Other markup can be used to style the text in different ways, but it's
9570 * up to the style defined in the theme which tags do what.
9571 * @deprecated use elm_object_text_set() instead.
9573 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9575 * Get the markup text set for the anchorblock
9577 * Retrieves the text set on the anchorblock, with markup tags included.
9579 * @param obj The anchorblock object
9580 * @return The markup text set or @c NULL if nothing was set or an error
9582 * @deprecated use elm_object_text_set() instead.
9584 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9586 * Set the parent of the hover popup
9588 * Sets the parent object to use by the hover created by the anchorblock
9589 * when an anchor is clicked. See @ref Hover for more details on this.
9591 * @param obj The anchorblock object
9592 * @param parent The object to use as parent for the hover
9594 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9596 * Get the parent of the hover popup
9598 * Get the object used as parent for the hover created by the anchorblock
9599 * widget. See @ref Hover for more details on this.
9600 * If no parent is set, the same anchorblock object will be used.
9602 * @param obj The anchorblock object
9603 * @return The object used as parent for the hover, NULL if none is set.
9605 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9607 * Set the style that the hover should use
9609 * When creating the popup hover, anchorblock will request that it's
9610 * themed according to @p style.
9612 * @param obj The anchorblock object
9613 * @param style The style to use for the underlying hover
9615 * @see elm_object_style_set()
9617 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9619 * Get the style that the hover should use
9621 * Get the style the hover created by anchorblock will use.
9623 * @param obj The anchorblock object
9624 * @return The style to use by the hover. NULL means the default is used.
9626 * @see elm_object_style_set()
9628 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9630 * Ends the hover popup in the anchorblock
9632 * When an anchor is clicked, the anchorblock widget will create a hover
9633 * object to use as a popup with user provided content. This function
9634 * terminates this popup, returning the anchorblock to its normal state.
9636 * @param obj The anchorblock object
9638 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9640 * Appends a custom item provider to the given anchorblock
9642 * Appends the given function to the list of items providers. This list is
9643 * called, one function at a time, with the given @p data pointer, the
9644 * anchorblock object and, in the @p item parameter, the item name as
9645 * referenced in its href string. Following functions in the list will be
9646 * called in order until one of them returns something different to NULL,
9647 * which should be an Evas_Object which will be used in place of the item
9650 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9651 * href=item/name\>\</item\>
9653 * @param obj The anchorblock object
9654 * @param func The function to add to the list of providers
9655 * @param data User data that will be passed to the callback function
9657 * @see elm_entry_item_provider_append()
9659 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);
9661 * Prepend a custom item provider to the given anchorblock
9663 * Like elm_anchorblock_item_provider_append(), but it adds the function
9664 * @p func to the beginning of the list, instead of the end.
9666 * @param obj The anchorblock object
9667 * @param func The function to add to the list of providers
9668 * @param data User data that will be passed to the callback function
9670 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);
9672 * Remove a custom item provider from the list of the given anchorblock
9674 * Removes the function and data pairing that matches @p func and @p data.
9675 * That is, unless the same function and same user data are given, the
9676 * function will not be removed from the list. This allows us to add the
9677 * same callback several times, with different @p data pointers and be
9678 * able to remove them later without conflicts.
9680 * @param obj The anchorblock object
9681 * @param func The function to remove from the list
9682 * @param data The data matching the function to remove from the list
9684 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);
9690 * @defgroup Bubble Bubble
9692 * @image html img/widget/bubble/preview-00.png
9693 * @image html img/widget/bubble/preview-01.png
9694 * @image html img/widget/bubble/preview-02.png
9696 * @brief The Bubble is a widget to show text similarly to how speech is
9697 * represented in comics.
9699 * The bubble widget contains 5 important visual elements:
9700 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9701 * @li The @p icon is an image to which the frame's arrow points to.
9702 * @li The @p label is a text which appears to the right of the icon if the
9703 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9705 * @li The @p info is a text which appears to the right of the label. Info's
9706 * font is of a ligther color than label.
9707 * @li The @p content is an evas object that is shown inside the frame.
9709 * The position of the arrow, icon, label and info depends on which corner is
9710 * selected. The four available corners are:
9711 * @li "top_left" - Default
9714 * @li "bottom_right"
9716 * Signals that you can add callbacks for are:
9717 * @li "clicked" - This is called when a user has clicked the bubble.
9719 * For an example of using a buble see @ref bubble_01_example_page "this".
9724 * Add a new bubble to the parent
9726 * @param parent The parent object
9727 * @return The new object or NULL if it cannot be created
9729 * This function adds a text bubble to the given parent evas object.
9731 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9733 * Set the label of the bubble
9735 * @param obj The bubble object
9736 * @param label The string to set in the label
9738 * This function sets the title of the bubble. Where this appears depends on
9739 * the selected corner.
9740 * @deprecated use elm_object_text_set() instead.
9742 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9744 * Get the label of the bubble
9746 * @param obj The bubble object
9747 * @return The string of set in the label
9749 * This function gets the title of the bubble.
9750 * @deprecated use elm_object_text_set() instead.
9752 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9754 * Set the info of the bubble
9756 * @param obj The bubble object
9757 * @param info The given info about the bubble
9759 * This function sets the info of the bubble. Where this appears depends on
9760 * the selected corner.
9761 * @deprecated use elm_object_text_set() instead.
9763 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9765 * Get the info of the bubble
9767 * @param obj The bubble object
9769 * @return The "info" string of the bubble
9771 * This function gets the info text.
9772 * @deprecated use elm_object_text_set() instead.
9774 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9776 * Set the content to be shown in the bubble
9778 * Once the content object is set, a previously set one will be deleted.
9779 * If you want to keep the old content object, use the
9780 * elm_bubble_content_unset() function.
9782 * @param obj The bubble object
9783 * @param content The given content of the bubble
9785 * This function sets the content shown on the middle of the bubble.
9787 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9789 * Get the content shown in the bubble
9791 * Return the content object which is set for this widget.
9793 * @param obj The bubble object
9794 * @return The content that is being used
9796 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9798 * Unset the content shown in the bubble
9800 * Unparent and return the content object which was set for this widget.
9802 * @param obj The bubble object
9803 * @return The content that was being used
9805 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9807 * Set the icon of the bubble
9809 * Once the icon object is set, a previously set one will be deleted.
9810 * If you want to keep the old content object, use the
9811 * elm_icon_content_unset() function.
9813 * @param obj The bubble object
9814 * @param icon The given icon for the bubble
9816 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9818 * Get the icon of the bubble
9820 * @param obj The bubble object
9821 * @return The icon for the bubble
9823 * This function gets the icon shown on the top left of bubble.
9825 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9827 * Unset the icon of the bubble
9829 * Unparent and return the icon object which was set for this widget.
9831 * @param obj The bubble object
9832 * @return The icon that was being used
9834 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9836 * Set the corner of the bubble
9838 * @param obj The bubble object.
9839 * @param corner The given corner for the bubble.
9841 * This function sets the corner of the bubble. The corner will be used to
9842 * determine where the arrow in the frame points to and where label, icon and
9845 * Possible values for corner are:
9846 * @li "top_left" - Default
9849 * @li "bottom_right"
9851 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9853 * Get the corner of the bubble
9855 * @param obj The bubble object.
9856 * @return The given corner for the bubble.
9858 * This function gets the selected corner of the bubble.
9860 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9866 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9867 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9868 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9869 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9870 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9871 /* smart callbacks called:
9872 * "clicked" - the user clicked the icon
9873 * "drag,start" - Someone started dragging the image out of the object
9874 * "drag,end" - Dragged item was dropped (somewhere)
9879 * @defgroup Elm_Gesture_Layer Gesture Layer
9880 * Gesture Layer Usage:
9882 * Use Gesture Layer to detect gestures.
9883 * The advantage is that you don't have to implement
9884 * gesture detection, just set callbacks of gesture state.
9885 * By using gesture layer we make standard interface.
9887 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9888 * with a parent object parameter.
9889 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9890 * call. Usually with same object as target (2nd parameter).
9892 * Now you need to tell gesture layer what gestures you follow.
9893 * This is done with @ref elm_gesture_layer_cb_set call.
9894 * By setting the callback you actually saying to gesture layer:
9895 * I would like to know when the gesture @ref Elm_Gesture_Types
9896 * switches to state @ref Elm_Gesture_State.
9898 * Next, you need to implement the actual action that follows the input
9901 * Note that if you like to stop being reported about a gesture, just set
9902 * all callbacks referring this gesture to NULL.
9903 * (again with @ref elm_gesture_layer_cb_set)
9905 * The information reported by gesture layer to your callback is depending
9906 * on @ref Elm_Gesture_Types:
9907 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9908 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9909 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9911 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9912 * @ref ELM_GESTURE_MOMENTUM.
9914 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9915 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9916 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9917 * Note that we consider a flick as a line-gesture that should be completed
9918 * in flick-time-limit as defined in @ref Config.
9920 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9922 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9926 * @enum _Elm_Gesture_Types
9927 * Enum of supported gesture types.
9928 * @ingroup Elm_Gesture_Layer
9930 enum _Elm_Gesture_Types
9932 ELM_GESTURE_FIRST = 0,
9934 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9935 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9936 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9937 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9939 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9941 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9942 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9944 ELM_GESTURE_ZOOM, /**< Zoom */
9945 ELM_GESTURE_ROTATE, /**< Rotate */
9951 * @typedef Elm_Gesture_Types
9952 * gesture types enum
9953 * @ingroup Elm_Gesture_Layer
9955 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9958 * @enum _Elm_Gesture_State
9959 * Enum of gesture states.
9960 * @ingroup Elm_Gesture_Layer
9962 enum _Elm_Gesture_State
9964 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9965 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9966 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9967 ELM_GESTURE_STATE_END, /**< Gesture completed */
9968 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9972 * @typedef Elm_Gesture_State
9973 * gesture states enum
9974 * @ingroup Elm_Gesture_Layer
9976 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9979 * @struct _Elm_Gesture_Taps_Info
9980 * Struct holds taps info for user
9981 * @ingroup Elm_Gesture_Layer
9983 struct _Elm_Gesture_Taps_Info
9985 Evas_Coord x, y; /**< Holds center point between fingers */
9986 unsigned int n; /**< Number of fingers tapped */
9987 unsigned int timestamp; /**< event timestamp */
9991 * @typedef Elm_Gesture_Taps_Info
9992 * holds taps info for user
9993 * @ingroup Elm_Gesture_Layer
9995 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
9998 * @struct _Elm_Gesture_Momentum_Info
9999 * Struct holds momentum info for user
10000 * x1 and y1 are not necessarily in sync
10001 * x1 holds x value of x direction starting point
10002 * and same holds for y1.
10003 * This is noticeable when doing V-shape movement
10004 * @ingroup Elm_Gesture_Layer
10006 struct _Elm_Gesture_Momentum_Info
10007 { /* Report line ends, timestamps, and momentum computed */
10008 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10009 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10010 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10011 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10013 unsigned int tx; /**< Timestamp of start of final x-swipe */
10014 unsigned int ty; /**< Timestamp of start of final y-swipe */
10016 Evas_Coord mx; /**< Momentum on X */
10017 Evas_Coord my; /**< Momentum on Y */
10021 * @typedef Elm_Gesture_Momentum_Info
10022 * holds momentum info for user
10023 * @ingroup Elm_Gesture_Layer
10025 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10028 * @struct _Elm_Gesture_Line_Info
10029 * Struct holds line info for user
10030 * @ingroup Elm_Gesture_Layer
10032 struct _Elm_Gesture_Line_Info
10033 { /* Report line ends, timestamps, and momentum computed */
10034 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10035 unsigned int n; /**< Number of fingers (lines) */
10036 /* FIXME should be radians, bot degrees */
10037 double angle; /**< Angle (direction) of lines */
10041 * @typedef Elm_Gesture_Line_Info
10042 * Holds line info for user
10043 * @ingroup Elm_Gesture_Layer
10045 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10048 * @struct _Elm_Gesture_Zoom_Info
10049 * Struct holds zoom info for user
10050 * @ingroup Elm_Gesture_Layer
10052 struct _Elm_Gesture_Zoom_Info
10054 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10055 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10056 double zoom; /**< Zoom value: 1.0 means no zoom */
10057 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10061 * @typedef Elm_Gesture_Zoom_Info
10062 * Holds zoom info for user
10063 * @ingroup Elm_Gesture_Layer
10065 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10068 * @struct _Elm_Gesture_Rotate_Info
10069 * Struct holds rotation info for user
10070 * @ingroup Elm_Gesture_Layer
10072 struct _Elm_Gesture_Rotate_Info
10074 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10075 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10076 double base_angle; /**< Holds start-angle */
10077 double angle; /**< Rotation value: 0.0 means no rotation */
10078 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10082 * @typedef Elm_Gesture_Rotate_Info
10083 * Holds rotation info for user
10084 * @ingroup Elm_Gesture_Layer
10086 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10089 * @typedef Elm_Gesture_Event_Cb
10090 * User callback used to stream gesture info from gesture layer
10091 * @param data user data
10092 * @param event_info gesture report info
10093 * Returns a flag field to be applied on the causing event.
10094 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10095 * upon the event, in an irreversible way.
10097 * @ingroup Elm_Gesture_Layer
10099 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10102 * Use function to set callbacks to be notified about
10103 * change of state of gesture.
10104 * When a user registers a callback with this function
10105 * this means this gesture has to be tested.
10107 * When ALL callbacks for a gesture are set to NULL
10108 * it means user isn't interested in gesture-state
10109 * and it will not be tested.
10111 * @param obj Pointer to gesture-layer.
10112 * @param idx The gesture you would like to track its state.
10113 * @param cb callback function pointer.
10114 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10115 * @param data user info to be sent to callback (usually, Smart Data)
10117 * @ingroup Elm_Gesture_Layer
10119 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);
10122 * Call this function to get repeat-events settings.
10124 * @param obj Pointer to gesture-layer.
10126 * @return repeat events settings.
10127 * @see elm_gesture_layer_hold_events_set()
10128 * @ingroup Elm_Gesture_Layer
10130 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10133 * This function called in order to make gesture-layer repeat events.
10134 * Set this of you like to get the raw events only if gestures were not detected.
10135 * Clear this if you like gesture layer to fwd events as testing gestures.
10137 * @param obj Pointer to gesture-layer.
10138 * @param r Repeat: TRUE/FALSE
10140 * @ingroup Elm_Gesture_Layer
10142 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10145 * This function sets step-value for zoom action.
10146 * Set step to any positive value.
10147 * Cancel step setting by setting to 0.0
10149 * @param obj Pointer to gesture-layer.
10150 * @param s new zoom step value.
10152 * @ingroup Elm_Gesture_Layer
10154 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10157 * This function sets step-value for rotate action.
10158 * Set step to any positive value.
10159 * Cancel step setting by setting to 0.0
10161 * @param obj Pointer to gesture-layer.
10162 * @param s new roatate step value.
10164 * @ingroup Elm_Gesture_Layer
10166 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10169 * This function called to attach gesture-layer to an Evas_Object.
10170 * @param obj Pointer to gesture-layer.
10171 * @param t Pointer to underlying object (AKA Target)
10173 * @return TRUE, FALSE on success, failure.
10175 * @ingroup Elm_Gesture_Layer
10177 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10180 * Call this function to construct a new gesture-layer object.
10181 * This does not activate the gesture layer. You have to
10182 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10184 * @param parent the parent object.
10186 * @return Pointer to new gesture-layer object.
10188 * @ingroup Elm_Gesture_Layer
10190 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10193 * @defgroup Thumb Thumb
10195 * @image html img/widget/thumb/preview-00.png
10196 * @image latex img/widget/thumb/preview-00.eps
10198 * A thumb object is used for displaying the thumbnail of an image or video.
10199 * You must have compiled Elementary with Ethumb_Client support and the DBus
10200 * service must be present and auto-activated in order to have thumbnails to
10203 * Once the thumbnail object becomes visible, it will check if there is a
10204 * previously generated thumbnail image for the file set on it. If not, it
10205 * will start generating this thumbnail.
10207 * Different config settings will cause different thumbnails to be generated
10208 * even on the same file.
10210 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10211 * Ethumb documentation to change this path, and to see other configuration
10214 * Signals that you can add callbacks for are:
10216 * - "clicked" - This is called when a user has clicked the thumb without dragging
10218 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10219 * - "press" - This is called when a user has pressed down the thumb.
10220 * - "generate,start" - The thumbnail generation started.
10221 * - "generate,stop" - The generation process stopped.
10222 * - "generate,error" - The generation failed.
10223 * - "load,error" - The thumbnail image loading failed.
10225 * available styles:
10229 * An example of use of thumbnail:
10231 * - @ref thumb_example_01
10235 * @addtogroup Thumb
10240 * @enum _Elm_Thumb_Animation_Setting
10241 * @typedef Elm_Thumb_Animation_Setting
10243 * Used to set if a video thumbnail is animating or not.
10247 typedef enum _Elm_Thumb_Animation_Setting
10249 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10250 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10251 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10252 ELM_THUMB_ANIMATION_LAST
10253 } Elm_Thumb_Animation_Setting;
10256 * Add a new thumb object to the parent.
10258 * @param parent The parent object.
10259 * @return The new object or NULL if it cannot be created.
10261 * @see elm_thumb_file_set()
10262 * @see elm_thumb_ethumb_client_get()
10266 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10268 * Reload thumbnail if it was generated before.
10270 * @param obj The thumb object to reload
10272 * This is useful if the ethumb client configuration changed, like its
10273 * size, aspect or any other property one set in the handle returned
10274 * by elm_thumb_ethumb_client_get().
10276 * If the options didn't change, the thumbnail won't be generated again, but
10277 * the old one will still be used.
10279 * @see elm_thumb_file_set()
10283 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10285 * Set the file that will be used as thumbnail.
10287 * @param obj The thumb object.
10288 * @param file The path to file that will be used as thumb.
10289 * @param key The key used in case of an EET file.
10291 * The file can be an image or a video (in that case, acceptable extensions are:
10292 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10293 * function elm_thumb_animate().
10295 * @see elm_thumb_file_get()
10296 * @see elm_thumb_reload()
10297 * @see elm_thumb_animate()
10301 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10303 * Get the image or video path and key used to generate the thumbnail.
10305 * @param obj The thumb object.
10306 * @param file Pointer to filename.
10307 * @param key Pointer to key.
10309 * @see elm_thumb_file_set()
10310 * @see elm_thumb_path_get()
10314 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10316 * Get the path and key to the image or video generated by ethumb.
10318 * One just need to make sure that the thumbnail was generated before getting
10319 * its path; otherwise, the path will be NULL. One way to do that is by asking
10320 * for the path when/after the "generate,stop" smart callback is called.
10322 * @param obj The thumb object.
10323 * @param file Pointer to thumb path.
10324 * @param key Pointer to thumb key.
10326 * @see elm_thumb_file_get()
10330 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10332 * Set the animation state for the thumb object. If its content is an animated
10333 * video, you may start/stop the animation or tell it to play continuously and
10336 * @param obj The thumb object.
10337 * @param setting The animation setting.
10339 * @see elm_thumb_file_set()
10343 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10345 * Get the animation state for the thumb object.
10347 * @param obj The thumb object.
10348 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10351 * @see elm_thumb_animate_set()
10355 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10357 * Get the ethumb_client handle so custom configuration can be made.
10359 * @return Ethumb_Client instance or NULL.
10361 * This must be called before the objects are created to be sure no object is
10362 * visible and no generation started.
10364 * Example of usage:
10367 * #include <Elementary.h>
10368 * #ifndef ELM_LIB_QUICKLAUNCH
10370 * elm_main(int argc, char **argv)
10372 * Ethumb_Client *client;
10374 * elm_need_ethumb();
10378 * client = elm_thumb_ethumb_client_get();
10381 * ERR("could not get ethumb_client");
10384 * ethumb_client_size_set(client, 100, 100);
10385 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10388 * // Create elm_thumb objects here
10398 * @note There's only one client handle for Ethumb, so once a configuration
10399 * change is done to it, any other request for thumbnails (for any thumbnail
10400 * object) will use that configuration. Thus, this configuration is global.
10404 EAPI void *elm_thumb_ethumb_client_get(void);
10406 * Get the ethumb_client connection state.
10408 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10411 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10413 * Make the thumbnail 'editable'.
10415 * @param obj Thumb object.
10416 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10418 * This means the thumbnail is a valid drag target for drag and drop, and can be
10419 * cut or pasted too.
10421 * @see elm_thumb_editable_get()
10425 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10427 * Make the thumbnail 'editable'.
10429 * @param obj Thumb object.
10430 * @return Editability.
10432 * This means the thumbnail is a valid drag target for drag and drop, and can be
10433 * cut or pasted too.
10435 * @see elm_thumb_editable_set()
10439 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10446 * @defgroup Hoversel Hoversel
10448 * @image html img/widget/hoversel/preview-00.png
10449 * @image latex img/widget/hoversel/preview-00.eps
10451 * A hoversel is a button that pops up a list of items (automatically
10452 * choosing the direction to display) that have a label and, optionally, an
10453 * icon to select from. It is a convenience widget to avoid the need to do
10454 * all the piecing together yourself. It is intended for a small number of
10455 * items in the hoversel menu (no more than 8), though is capable of many
10458 * Signals that you can add callbacks for are:
10459 * "clicked" - the user clicked the hoversel button and popped up the sel
10460 * "selected" - an item in the hoversel list is selected. event_info is the item
10461 * "dismissed" - the hover is dismissed
10463 * See @ref tutorial_hoversel for an example.
10466 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10468 * @brief Add a new Hoversel object
10470 * @param parent The parent object
10471 * @return The new object or NULL if it cannot be created
10473 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10475 * @brief This sets the hoversel to expand horizontally.
10477 * @param obj The hoversel object
10478 * @param horizontal If true, the hover will expand horizontally to the
10481 * @note The initial button will display horizontally regardless of this
10484 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10486 * @brief This returns whether the hoversel is set to expand horizontally.
10488 * @param obj The hoversel object
10489 * @return If true, the hover will expand horizontally to the right.
10491 * @see elm_hoversel_horizontal_set()
10493 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10495 * @brief Set the Hover parent
10497 * @param obj The hoversel object
10498 * @param parent The parent to use
10500 * Sets the hover parent object, the area that will be darkened when the
10501 * hoversel is clicked. Should probably be the window that the hoversel is
10502 * in. See @ref Hover objects for more information.
10504 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10506 * @brief Get the Hover parent
10508 * @param obj The hoversel object
10509 * @return The used parent
10511 * Gets the hover parent object.
10513 * @see elm_hoversel_hover_parent_set()
10515 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10517 * @brief Set the hoversel button label
10519 * @param obj The hoversel object
10520 * @param label The label text.
10522 * This sets the label of the button that is always visible (before it is
10523 * clicked and expanded).
10525 * @deprecated elm_object_text_set()
10527 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10529 * @brief Get the hoversel button label
10531 * @param obj The hoversel object
10532 * @return The label text.
10534 * @deprecated elm_object_text_get()
10536 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10538 * @brief Set the icon of the hoversel button
10540 * @param obj The hoversel object
10541 * @param icon The icon object
10543 * Sets the icon of the button that is always visible (before it is clicked
10544 * and expanded). Once the icon object is set, a previously set one will be
10545 * deleted, if you want to keep that old content object, use the
10546 * elm_hoversel_icon_unset() function.
10548 * @see elm_button_icon_set()
10550 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10552 * @brief Get the icon of the hoversel button
10554 * @param obj The hoversel object
10555 * @return The icon object
10557 * Get the icon of the button that is always visible (before it is clicked
10558 * and expanded). Also see elm_button_icon_get().
10560 * @see elm_hoversel_icon_set()
10562 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10564 * @brief Get and unparent the icon of the hoversel button
10566 * @param obj The hoversel object
10567 * @return The icon object that was being used
10569 * Unparent and return the icon of the button that is always visible
10570 * (before it is clicked and expanded).
10572 * @see elm_hoversel_icon_set()
10573 * @see elm_button_icon_unset()
10575 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10577 * @brief This triggers the hoversel popup from code, the same as if the user
10578 * had clicked the button.
10580 * @param obj The hoversel object
10582 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10584 * @brief This dismisses the hoversel popup as if the user had clicked
10585 * outside the hover.
10587 * @param obj The hoversel object
10589 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10591 * @brief Returns whether the hoversel is expanded.
10593 * @param obj The hoversel object
10594 * @return This will return EINA_TRUE if the hoversel is expanded or
10595 * EINA_FALSE if it is not expanded.
10597 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10599 * @brief This will remove all the children items from the hoversel.
10601 * @param obj The hoversel object
10603 * @warning Should @b not be called while the hoversel is active; use
10604 * elm_hoversel_expanded_get() to check first.
10606 * @see elm_hoversel_item_del_cb_set()
10607 * @see elm_hoversel_item_del()
10609 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10611 * @brief Get the list of items within the given hoversel.
10613 * @param obj The hoversel object
10614 * @return Returns a list of Elm_Hoversel_Item*
10616 * @see elm_hoversel_item_add()
10618 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10620 * @brief Add an item to the hoversel button
10622 * @param obj The hoversel object
10623 * @param label The text label to use for the item (NULL if not desired)
10624 * @param icon_file An image file path on disk to use for the icon or standard
10625 * icon name (NULL if not desired)
10626 * @param icon_type The icon type if relevant
10627 * @param func Convenience function to call when this item is selected
10628 * @param data Data to pass to item-related functions
10629 * @return A handle to the item added.
10631 * This adds an item to the hoversel to show when it is clicked. Note: if you
10632 * need to use an icon from an edje file then use
10633 * elm_hoversel_item_icon_set() right after the this function, and set
10634 * icon_file to NULL here.
10636 * For more information on what @p icon_file and @p icon_type are see the
10637 * @ref Icon "icon documentation".
10639 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);
10641 * @brief Delete an item from the hoversel
10643 * @param item The item to delete
10645 * This deletes the item from the hoversel (should not be called while the
10646 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10648 * @see elm_hoversel_item_add()
10649 * @see elm_hoversel_item_del_cb_set()
10651 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10653 * @brief Set the function to be called when an item from the hoversel is
10656 * @param item The item to set the callback on
10657 * @param func The function called
10659 * That function will receive these parameters:
10660 * @li void *item_data
10661 * @li Evas_Object *the_item_object
10662 * @li Elm_Hoversel_Item *the_object_struct
10664 * @see elm_hoversel_item_add()
10666 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10668 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10669 * that will be passed to associated function callbacks.
10671 * @param item The item to get the data from
10672 * @return The data pointer set with elm_hoversel_item_add()
10674 * @see elm_hoversel_item_add()
10676 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10678 * @brief This returns the label text of the given hoversel item.
10680 * @param item The item to get the label
10681 * @return The label text of the hoversel item
10683 * @see elm_hoversel_item_add()
10685 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10687 * @brief This sets the icon for the given hoversel item.
10689 * @param item The item to set the icon
10690 * @param icon_file An image file path on disk to use for the icon or standard
10692 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10693 * to NULL if the icon is not an edje file
10694 * @param icon_type The icon type
10696 * The icon can be loaded from the standard set, from an image file, or from
10699 * @see elm_hoversel_item_add()
10701 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);
10703 * @brief Get the icon object of the hoversel item
10705 * @param item The item to get the icon from
10706 * @param icon_file The image file path on disk used for the icon or standard
10708 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10709 * if the icon is not an edje file
10710 * @param icon_type The icon type
10712 * @see elm_hoversel_item_icon_set()
10713 * @see elm_hoversel_item_add()
10715 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);
10721 * @defgroup Toolbar Toolbar
10722 * @ingroup Elementary
10724 * @image html img/widget/toolbar/preview-00.png
10725 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10727 * @image html img/toolbar.png
10728 * @image latex img/toolbar.eps width=\textwidth
10730 * A toolbar is a widget that displays a list of items inside
10731 * a box. It can be scrollable, show a menu with items that don't fit
10732 * to toolbar size or even crop them.
10734 * Only one item can be selected at a time.
10736 * Items can have multiple states, or show menus when selected by the user.
10738 * Smart callbacks one can listen to:
10739 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10741 * Available styles for it:
10743 * - @c "transparent" - no background or shadow, just show the content
10745 * List of examples:
10746 * @li @ref toolbar_example_01
10747 * @li @ref toolbar_example_02
10748 * @li @ref toolbar_example_03
10752 * @addtogroup Toolbar
10757 * @enum _Elm_Toolbar_Shrink_Mode
10758 * @typedef Elm_Toolbar_Shrink_Mode
10760 * Set toolbar's items display behavior, it can be scrollabel,
10761 * show a menu with exceeding items, or simply hide them.
10763 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10766 * Values <b> don't </b> work as bitmask, only one can be choosen.
10768 * @see elm_toolbar_mode_shrink_set()
10769 * @see elm_toolbar_mode_shrink_get()
10773 typedef enum _Elm_Toolbar_Shrink_Mode
10775 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10776 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10777 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10778 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10779 } Elm_Toolbar_Shrink_Mode;
10781 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(). */
10783 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(). */
10786 * Add a new toolbar widget to the given parent Elementary
10787 * (container) object.
10789 * @param parent The parent object.
10790 * @return a new toolbar widget handle or @c NULL, on errors.
10792 * This function inserts a new toolbar widget on the canvas.
10796 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10799 * Set the icon size, in pixels, to be used by toolbar items.
10801 * @param obj The toolbar object
10802 * @param icon_size The icon size in pixels
10804 * @note Default value is @c 32. It reads value from elm config.
10806 * @see elm_toolbar_icon_size_get()
10810 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10813 * Get the icon size, in pixels, to be used by toolbar items.
10815 * @param obj The toolbar object.
10816 * @return The icon size in pixels.
10818 * @see elm_toolbar_icon_size_set() for details.
10822 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10825 * Sets icon lookup order, for toolbar items' icons.
10827 * @param obj The toolbar object.
10828 * @param order The icon lookup order.
10830 * Icons added before calling this function will not be affected.
10831 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10833 * @see elm_toolbar_icon_order_lookup_get()
10837 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10840 * Gets the icon lookup order.
10842 * @param obj The toolbar object.
10843 * @return The icon lookup order.
10845 * @see elm_toolbar_icon_order_lookup_set() for details.
10849 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10852 * Set whether the toolbar items' should be selected by the user or not.
10854 * @param obj The toolbar object.
10855 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10858 * This will turn off the ability to select items entirely and they will
10859 * neither appear selected nor emit selected signals. The clicked
10860 * callback function will still be called.
10862 * Selection is enabled by default.
10864 * @see elm_toolbar_no_select_mode_get().
10868 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10871 * Set whether the toolbar items' should be selected by the user or not.
10873 * @param obj The toolbar object.
10874 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10875 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10877 * @see elm_toolbar_no_select_mode_set() for details.
10881 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10884 * Append item to the toolbar.
10886 * @param obj The toolbar object.
10887 * @param icon A string with icon name or the absolute path of an image file.
10888 * @param label The label of the item.
10889 * @param func The function to call when the item is clicked.
10890 * @param data The data to associate with the item for related callbacks.
10891 * @return The created item or @c NULL upon failure.
10893 * A new item will be created and appended to the toolbar, i.e., will
10894 * be set as @b last item.
10896 * Items created with this method can be deleted with
10897 * elm_toolbar_item_del().
10899 * Associated @p data can be properly freed when item is deleted if a
10900 * callback function is set with elm_toolbar_item_del_cb_set().
10902 * If a function is passed as argument, it will be called everytime this item
10903 * is selected, i.e., the user clicks over an unselected item.
10904 * If such function isn't needed, just passing
10905 * @c NULL as @p func is enough. The same should be done for @p data.
10907 * Toolbar will load icon image from fdo or current theme.
10908 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10909 * If an absolute path is provided it will load it direct from a file.
10911 * @see elm_toolbar_item_icon_set()
10912 * @see elm_toolbar_item_del()
10913 * @see elm_toolbar_item_del_cb_set()
10917 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);
10920 * Prepend item to the toolbar.
10922 * @param obj The toolbar object.
10923 * @param icon A string with icon name or the absolute path of an image file.
10924 * @param label The label of the item.
10925 * @param func The function to call when the item is clicked.
10926 * @param data The data to associate with the item for related callbacks.
10927 * @return The created item or @c NULL upon failure.
10929 * A new item will be created and prepended to the toolbar, i.e., will
10930 * be set as @b first item.
10932 * Items created with this method can be deleted with
10933 * elm_toolbar_item_del().
10935 * Associated @p data can be properly freed when item is deleted if a
10936 * callback function is set with elm_toolbar_item_del_cb_set().
10938 * If a function is passed as argument, it will be called everytime this item
10939 * is selected, i.e., the user clicks over an unselected item.
10940 * If such function isn't needed, just passing
10941 * @c NULL as @p func is enough. The same should be done for @p data.
10943 * Toolbar will load icon image from fdo or current theme.
10944 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10945 * If an absolute path is provided it will load it direct from a file.
10947 * @see elm_toolbar_item_icon_set()
10948 * @see elm_toolbar_item_del()
10949 * @see elm_toolbar_item_del_cb_set()
10953 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);
10956 * Insert a new item into the toolbar object before item @p before.
10958 * @param obj The toolbar object.
10959 * @param before The toolbar item to insert before.
10960 * @param icon A string with icon name or the absolute path of an image file.
10961 * @param label The label of the item.
10962 * @param func The function to call when the item is clicked.
10963 * @param data The data to associate with the item for related callbacks.
10964 * @return The created item or @c NULL upon failure.
10966 * A new item will be created and added to the toolbar. Its position in
10967 * this toolbar will be just before item @p before.
10969 * Items created with this method can be deleted with
10970 * elm_toolbar_item_del().
10972 * Associated @p data can be properly freed when item is deleted if a
10973 * callback function is set with elm_toolbar_item_del_cb_set().
10975 * If a function is passed as argument, it will be called everytime this item
10976 * is selected, i.e., the user clicks over an unselected item.
10977 * If such function isn't needed, just passing
10978 * @c NULL as @p func is enough. The same should be done for @p data.
10980 * Toolbar will load icon image from fdo or current theme.
10981 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10982 * If an absolute path is provided it will load it direct from a file.
10984 * @see elm_toolbar_item_icon_set()
10985 * @see elm_toolbar_item_del()
10986 * @see elm_toolbar_item_del_cb_set()
10990 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);
10993 * Insert a new item into the toolbar object after item @p after.
10995 * @param obj The toolbar object.
10996 * @param before The toolbar item to insert before.
10997 * @param icon A string with icon name or the absolute path of an image file.
10998 * @param label The label of the item.
10999 * @param func The function to call when the item is clicked.
11000 * @param data The data to associate with the item for related callbacks.
11001 * @return The created item or @c NULL upon failure.
11003 * A new item will be created and added to the toolbar. Its position in
11004 * this toolbar will be just after item @p after.
11006 * Items created with this method can be deleted with
11007 * elm_toolbar_item_del().
11009 * Associated @p data can be properly freed when item is deleted if a
11010 * callback function is set with elm_toolbar_item_del_cb_set().
11012 * If a function is passed as argument, it will be called everytime this item
11013 * is selected, i.e., the user clicks over an unselected item.
11014 * If such function isn't needed, just passing
11015 * @c NULL as @p func is enough. The same should be done for @p data.
11017 * Toolbar will load icon image from fdo or current theme.
11018 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11019 * If an absolute path is provided it will load it direct from a file.
11021 * @see elm_toolbar_item_icon_set()
11022 * @see elm_toolbar_item_del()
11023 * @see elm_toolbar_item_del_cb_set()
11027 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);
11030 * Get the first item in the given toolbar widget's list of
11033 * @param obj The toolbar object
11034 * @return The first item or @c NULL, if it has no items (and on
11037 * @see elm_toolbar_item_append()
11038 * @see elm_toolbar_last_item_get()
11042 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11045 * Get the last item in the given toolbar widget's list of
11048 * @param obj The toolbar object
11049 * @return The last item or @c NULL, if it has no items (and on
11052 * @see elm_toolbar_item_prepend()
11053 * @see elm_toolbar_first_item_get()
11057 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11060 * Get the item after @p item in toolbar.
11062 * @param item The toolbar item.
11063 * @return The item after @p item, or @c NULL if none or on failure.
11065 * @note If it is the last item, @c NULL will be returned.
11067 * @see elm_toolbar_item_append()
11071 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11074 * Get the item before @p item in toolbar.
11076 * @param item The toolbar item.
11077 * @return The item before @p item, or @c NULL if none or on failure.
11079 * @note If it is the first item, @c NULL will be returned.
11081 * @see elm_toolbar_item_prepend()
11085 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11088 * Get the toolbar object from an item.
11090 * @param item The item.
11091 * @return The toolbar object.
11093 * This returns the toolbar object itself that an item belongs to.
11097 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11100 * Set the priority of a toolbar item.
11102 * @param item The toolbar item.
11103 * @param priority The item priority. The default is zero.
11105 * This is used only when the toolbar shrink mode is set to
11106 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11107 * When space is less than required, items with low priority
11108 * will be removed from the toolbar and added to a dynamically-created menu,
11109 * while items with higher priority will remain on the toolbar,
11110 * with the same order they were added.
11112 * @see elm_toolbar_item_priority_get()
11116 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11119 * Get the priority of a toolbar item.
11121 * @param item The toolbar item.
11122 * @return The @p item priority, or @c 0 on failure.
11124 * @see elm_toolbar_item_priority_set() for details.
11128 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11131 * Get the label of item.
11133 * @param item The item of toolbar.
11134 * @return The label of item.
11136 * The return value is a pointer to the label associated to @p item when
11137 * it was created, with function elm_toolbar_item_append() or similar,
11139 * with function elm_toolbar_item_label_set. If no label
11140 * was passed as argument, it will return @c NULL.
11142 * @see elm_toolbar_item_label_set() for more details.
11143 * @see elm_toolbar_item_append()
11147 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11150 * Set the label of item.
11152 * @param item The item of toolbar.
11153 * @param text The label of item.
11155 * The label to be displayed by the item.
11156 * Label will be placed at icons bottom (if set).
11158 * If a label was passed as argument on item creation, with function
11159 * elm_toolbar_item_append() or similar, it will be already
11160 * displayed by the item.
11162 * @see elm_toolbar_item_label_get()
11163 * @see elm_toolbar_item_append()
11167 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11170 * Return the data associated with a given toolbar widget item.
11172 * @param item The toolbar widget item handle.
11173 * @return The data associated with @p item.
11175 * @see elm_toolbar_item_data_set()
11179 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11182 * Set the data associated with a given toolbar widget item.
11184 * @param item The toolbar widget item handle.
11185 * @param data The new data pointer to set to @p item.
11187 * This sets new item data on @p item.
11189 * @warning The old data pointer won't be touched by this function, so
11190 * the user had better to free that old data himself/herself.
11194 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11197 * Returns a pointer to a toolbar item by its label.
11199 * @param obj The toolbar object.
11200 * @param label The label of the item to find.
11202 * @return The pointer to the toolbar item matching @p label or @c NULL
11207 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11210 * Get whether the @p item is selected or not.
11212 * @param item The toolbar item.
11213 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11214 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11216 * @see elm_toolbar_selected_item_set() for details.
11217 * @see elm_toolbar_item_selected_get()
11221 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11224 * Set the selected state of an item.
11226 * @param item The toolbar item
11227 * @param selected The selected state
11229 * This sets the selected state of the given item @p it.
11230 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11232 * If a new item is selected the previosly selected will be unselected.
11233 * Previoulsy selected item can be get with function
11234 * elm_toolbar_selected_item_get().
11236 * Selected items will be highlighted.
11238 * @see elm_toolbar_item_selected_get()
11239 * @see elm_toolbar_selected_item_get()
11243 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11246 * Get the selected item.
11248 * @param obj The toolbar object.
11249 * @return The selected toolbar item.
11251 * The selected item can be unselected with function
11252 * elm_toolbar_item_selected_set().
11254 * The selected item always will be highlighted on toolbar.
11256 * @see elm_toolbar_selected_items_get()
11260 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11263 * Set the icon associated with @p item.
11265 * @param obj The parent of this item.
11266 * @param item The toolbar item.
11267 * @param icon A string with icon name or the absolute path of an image file.
11269 * Toolbar will load icon image from fdo or current theme.
11270 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11271 * If an absolute path is provided it will load it direct from a file.
11273 * @see elm_toolbar_icon_order_lookup_set()
11274 * @see elm_toolbar_icon_order_lookup_get()
11278 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11281 * Get the string used to set the icon of @p item.
11283 * @param item The toolbar item.
11284 * @return The string associated with the icon object.
11286 * @see elm_toolbar_item_icon_set() for details.
11290 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11293 * Delete them item from the toolbar.
11295 * @param item The item of toolbar to be deleted.
11297 * @see elm_toolbar_item_append()
11298 * @see elm_toolbar_item_del_cb_set()
11302 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11305 * Set the function called when a toolbar item is freed.
11307 * @param item The item to set the callback on.
11308 * @param func The function called.
11310 * If there is a @p func, then it will be called prior item's memory release.
11311 * That will be called with the following arguments:
11313 * @li item's Evas object;
11316 * This way, a data associated to a toolbar item could be properly freed.
11320 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11323 * Get a value whether toolbar item is disabled or not.
11325 * @param item The item.
11326 * @return The disabled state.
11328 * @see elm_toolbar_item_disabled_set() for more details.
11332 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11335 * Sets the disabled/enabled state of a toolbar item.
11337 * @param item The item.
11338 * @param disabled The disabled state.
11340 * A disabled item cannot be selected or unselected. It will also
11341 * change its appearance (generally greyed out). This sets the
11342 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11347 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11350 * Set or unset item as a separator.
11352 * @param item The toolbar item.
11353 * @param setting @c EINA_TRUE to set item @p item as separator or
11354 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11356 * Items aren't set as separator by default.
11358 * If set as separator it will display separator theme, so won't display
11361 * @see elm_toolbar_item_separator_get()
11365 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11368 * Get a value whether item is a separator or not.
11370 * @param item The toolbar item.
11371 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11372 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11374 * @see elm_toolbar_item_separator_set() for details.
11378 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11381 * Set the shrink state of toolbar @p obj.
11383 * @param obj The toolbar object.
11384 * @param shrink_mode Toolbar's items display behavior.
11386 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11387 * but will enforce a minimun size so all the items will fit, won't scroll
11388 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11389 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11390 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11394 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11397 * Get the shrink mode of toolbar @p obj.
11399 * @param obj The toolbar object.
11400 * @return Toolbar's items display behavior.
11402 * @see elm_toolbar_mode_shrink_set() for details.
11406 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11409 * Enable/disable homogenous mode.
11411 * @param obj The toolbar object
11412 * @param homogeneous Assume the items within the toolbar are of the
11413 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11415 * This will enable the homogeneous mode where items are of the same size.
11416 * @see elm_toolbar_homogeneous_get()
11420 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11423 * Get whether the homogenous mode is enabled.
11425 * @param obj The toolbar object.
11426 * @return Assume the items within the toolbar are of the same height
11427 * and width (EINA_TRUE = on, EINA_FALSE = off).
11429 * @see elm_toolbar_homogeneous_set()
11433 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11436 * Enable/disable homogenous mode.
11438 * @param obj The toolbar object
11439 * @param homogeneous Assume the items within the toolbar are of the
11440 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11442 * This will enable the homogeneous mode where items are of the same size.
11443 * @see elm_toolbar_homogeneous_get()
11445 * @deprecated use elm_toolbar_homogeneous_set() instead.
11449 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11452 * Get whether the homogenous mode is enabled.
11454 * @param obj The toolbar object.
11455 * @return Assume the items within the toolbar are of the same height
11456 * and width (EINA_TRUE = on, EINA_FALSE = off).
11458 * @see elm_toolbar_homogeneous_set()
11459 * @deprecated use elm_toolbar_homogeneous_get() instead.
11463 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11466 * Set the parent object of the toolbar items' menus.
11468 * @param obj The toolbar object.
11469 * @param parent The parent of the menu objects.
11471 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11473 * For more details about setting the parent for toolbar menus, see
11474 * elm_menu_parent_set().
11476 * @see elm_menu_parent_set() for details.
11477 * @see elm_toolbar_item_menu_set() for details.
11481 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11484 * Get the parent object of the toolbar items' menus.
11486 * @param obj The toolbar object.
11487 * @return The parent of the menu objects.
11489 * @see elm_toolbar_menu_parent_set() for details.
11493 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11496 * Set the alignment of the items.
11498 * @param obj The toolbar object.
11499 * @param align The new alignment, a float between <tt> 0.0 </tt>
11500 * and <tt> 1.0 </tt>.
11502 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11503 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11506 * Centered items by default.
11508 * @see elm_toolbar_align_get()
11512 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11515 * Get the alignment of the items.
11517 * @param obj The toolbar object.
11518 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11521 * @see elm_toolbar_align_set() for details.
11525 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11528 * Set whether the toolbar item opens a menu.
11530 * @param item The toolbar item.
11531 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11533 * A toolbar item can be set to be a menu, using this function.
11535 * Once it is set to be a menu, it can be manipulated through the
11536 * menu-like function elm_toolbar_menu_parent_set() and the other
11537 * elm_menu functions, using the Evas_Object @c menu returned by
11538 * elm_toolbar_item_menu_get().
11540 * So, items to be displayed in this item's menu should be added with
11541 * elm_menu_item_add().
11543 * The following code exemplifies the most basic usage:
11545 * tb = elm_toolbar_add(win)
11546 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11547 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11548 * elm_toolbar_menu_parent_set(tb, win);
11549 * menu = elm_toolbar_item_menu_get(item);
11550 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11551 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11555 * @see elm_toolbar_item_menu_get()
11559 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11562 * Get toolbar item's menu.
11564 * @param item The toolbar item.
11565 * @return Item's menu object or @c NULL on failure.
11567 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11568 * this function will set it.
11570 * @see elm_toolbar_item_menu_set() for details.
11574 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11577 * Add a new state to @p item.
11579 * @param item The item.
11580 * @param icon A string with icon name or the absolute path of an image file.
11581 * @param label The label of the new state.
11582 * @param func The function to call when the item is clicked when this
11583 * state is selected.
11584 * @param data The data to associate with the state.
11585 * @return The toolbar item state, or @c NULL upon failure.
11587 * Toolbar will load icon image from fdo or current theme.
11588 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11589 * If an absolute path is provided it will load it direct from a file.
11591 * States created with this function can be removed with
11592 * elm_toolbar_item_state_del().
11594 * @see elm_toolbar_item_state_del()
11595 * @see elm_toolbar_item_state_sel()
11596 * @see elm_toolbar_item_state_get()
11600 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);
11603 * Delete a previoulsy added state to @p item.
11605 * @param item The toolbar item.
11606 * @param state The state to be deleted.
11607 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11609 * @see elm_toolbar_item_state_add()
11611 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11614 * Set @p state as the current state of @p it.
11616 * @param it The item.
11617 * @param state The state to use.
11618 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11620 * If @p state is @c NULL, it won't select any state and the default item's
11621 * icon and label will be used. It's the same behaviour than
11622 * elm_toolbar_item_state_unser().
11624 * @see elm_toolbar_item_state_unset()
11628 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11631 * Unset the state of @p it.
11633 * @param it The item.
11635 * The default icon and label from this item will be displayed.
11637 * @see elm_toolbar_item_state_set() for more details.
11641 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11644 * Get the current state of @p it.
11646 * @param item The item.
11647 * @return The selected state or @c NULL if none is selected or on failure.
11649 * @see elm_toolbar_item_state_set() for details.
11650 * @see elm_toolbar_item_state_unset()
11651 * @see elm_toolbar_item_state_add()
11655 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11658 * Get the state after selected state in toolbar's @p item.
11660 * @param it The toolbar item to change state.
11661 * @return The state after current state, or @c NULL on failure.
11663 * If last state is selected, this function will return first state.
11665 * @see elm_toolbar_item_state_set()
11666 * @see elm_toolbar_item_state_add()
11670 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11673 * Get the state before selected state in toolbar's @p item.
11675 * @param it The toolbar item to change state.
11676 * @return The state before current state, or @c NULL on failure.
11678 * If first state is selected, this function will return last state.
11680 * @see elm_toolbar_item_state_set()
11681 * @see elm_toolbar_item_state_add()
11685 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11688 * Set the text to be shown in a given toolbar item's tooltips.
11690 * @param item Target item.
11691 * @param text The text to set in the content.
11693 * Setup the text as tooltip to object. The item can have only one tooltip,
11694 * so any previous tooltip data - set with this function or
11695 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11697 * @see elm_object_tooltip_text_set() for more details.
11701 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11704 * Set the content to be shown in the tooltip item.
11706 * Setup the tooltip to item. The item can have only one tooltip,
11707 * so any previous tooltip data is removed. @p func(with @p data) will
11708 * be called every time that need show the tooltip and it should
11709 * return a valid Evas_Object. This object is then managed fully by
11710 * tooltip system and is deleted when the tooltip is gone.
11712 * @param item the toolbar item being attached a tooltip.
11713 * @param func the function used to create the tooltip contents.
11714 * @param data what to provide to @a func as callback data/context.
11715 * @param del_cb called when data is not needed anymore, either when
11716 * another callback replaces @a func, the tooltip is unset with
11717 * elm_toolbar_item_tooltip_unset() or the owner @a item
11718 * dies. This callback receives as the first parameter the
11719 * given @a data, and @c event_info is the item.
11721 * @see elm_object_tooltip_content_cb_set() for more details.
11725 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);
11728 * Unset tooltip from item.
11730 * @param item toolbar item to remove previously set tooltip.
11732 * Remove tooltip from item. The callback provided as del_cb to
11733 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11734 * it is not used anymore.
11736 * @see elm_object_tooltip_unset() for more details.
11737 * @see elm_toolbar_item_tooltip_content_cb_set()
11741 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11744 * Sets a different style for this item tooltip.
11746 * @note before you set a style you should define a tooltip with
11747 * elm_toolbar_item_tooltip_content_cb_set() or
11748 * elm_toolbar_item_tooltip_text_set()
11750 * @param item toolbar item with tooltip already set.
11751 * @param style the theme style to use (default, transparent, ...)
11753 * @see elm_object_tooltip_style_set() for more details.
11757 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11760 * Get the style for this item tooltip.
11762 * @param item toolbar item with tooltip already set.
11763 * @return style the theme style in use, defaults to "default". If the
11764 * object does not have a tooltip set, then NULL is returned.
11766 * @see elm_object_tooltip_style_get() for more details.
11767 * @see elm_toolbar_item_tooltip_style_set()
11771 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11774 * Set the type of mouse pointer/cursor decoration to be shown,
11775 * when the mouse pointer is over the given toolbar widget item
11777 * @param item toolbar item to customize cursor on
11778 * @param cursor the cursor type's name
11780 * This function works analogously as elm_object_cursor_set(), but
11781 * here the cursor's changing area is restricted to the item's
11782 * area, and not the whole widget's. Note that that item cursors
11783 * have precedence over widget cursors, so that a mouse over an
11784 * item with custom cursor set will always show @b that cursor.
11786 * If this function is called twice for an object, a previously set
11787 * cursor will be unset on the second call.
11789 * @see elm_object_cursor_set()
11790 * @see elm_toolbar_item_cursor_get()
11791 * @see elm_toolbar_item_cursor_unset()
11795 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11798 * Get the type of mouse pointer/cursor decoration set to be shown,
11799 * when the mouse pointer is over the given toolbar widget item
11801 * @param item toolbar item with custom cursor set
11802 * @return the cursor type's name or @c NULL, if no custom cursors
11803 * were set to @p item (and on errors)
11805 * @see elm_object_cursor_get()
11806 * @see elm_toolbar_item_cursor_set()
11807 * @see elm_toolbar_item_cursor_unset()
11811 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11814 * Unset any custom mouse pointer/cursor decoration set to be
11815 * shown, when the mouse pointer is over the given toolbar widget
11816 * item, thus making it show the @b default cursor again.
11818 * @param item a toolbar item
11820 * Use this call to undo any custom settings on this item's cursor
11821 * decoration, bringing it back to defaults (no custom style set).
11823 * @see elm_object_cursor_unset()
11824 * @see elm_toolbar_item_cursor_set()
11828 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11831 * Set a different @b style for a given custom cursor set for a
11834 * @param item toolbar item with custom cursor set
11835 * @param style the <b>theme style</b> to use (e.g. @c "default",
11836 * @c "transparent", etc)
11838 * This function only makes sense when one is using custom mouse
11839 * cursor decorations <b>defined in a theme file</b>, which can have,
11840 * given a cursor name/type, <b>alternate styles</b> on it. It
11841 * works analogously as elm_object_cursor_style_set(), but here
11842 * applyed only to toolbar item objects.
11844 * @warning Before you set a cursor style you should have definen a
11845 * custom cursor previously on the item, with
11846 * elm_toolbar_item_cursor_set()
11848 * @see elm_toolbar_item_cursor_engine_only_set()
11849 * @see elm_toolbar_item_cursor_style_get()
11853 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11856 * Get the current @b style set for a given toolbar item's custom
11859 * @param item toolbar item with custom cursor set.
11860 * @return style the cursor style in use. If the object does not
11861 * have a cursor set, then @c NULL is returned.
11863 * @see elm_toolbar_item_cursor_style_set() for more details
11867 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11870 * Set if the (custom)cursor for a given toolbar item should be
11871 * searched in its theme, also, or should only rely on the
11872 * rendering engine.
11874 * @param item item with custom (custom) cursor already set on
11875 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11876 * only on those provided by the rendering engine, @c EINA_FALSE to
11877 * have them searched on the widget's theme, as well.
11879 * @note This call is of use only if you've set a custom cursor
11880 * for toolbar items, with elm_toolbar_item_cursor_set().
11882 * @note By default, cursors will only be looked for between those
11883 * provided by the rendering engine.
11887 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11890 * Get if the (custom) cursor for a given toolbar item is being
11891 * searched in its theme, also, or is only relying on the rendering
11894 * @param item a toolbar item
11895 * @return @c EINA_TRUE, if cursors are being looked for only on
11896 * those provided by the rendering engine, @c EINA_FALSE if they
11897 * are being searched on the widget's theme, as well.
11899 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11903 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11910 EAPI double elm_tooltip_delay_get(void);
11911 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11912 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11913 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11914 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11915 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);
11916 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11917 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11918 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11919 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11920 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11921 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11922 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11923 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11924 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11925 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11926 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11927 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11930 EAPI int elm_cursor_engine_only_get(void);
11931 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11934 * @defgroup Menu Menu
11936 * @image html img/widget/menu/preview-00.png
11937 * @image latex img/widget/menu/preview-00.eps
11939 * A menu is a list of items displayed above its parent. When the menu is
11940 * showing its parent is darkened. Each item can have a sub-menu. The menu
11941 * object can be used to display a menu on a right click event, in a toolbar,
11944 * Signals that you can add callbacks for are:
11945 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11946 * event_info is NULL.
11948 * @see @ref tutorial_menu
11951 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11953 * @brief Add a new menu to the parent
11955 * @param parent The parent object.
11956 * @return The new object or NULL if it cannot be created.
11958 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11960 * @brief Set the parent for the given menu widget
11962 * @param obj The menu object.
11963 * @param parent The new parent.
11965 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11967 * @brief Get the parent for the given menu widget
11969 * @param obj The menu object.
11970 * @return The parent.
11972 * @see elm_menu_parent_set()
11974 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11976 * @brief Move the menu to a new position
11978 * @param obj The menu object.
11979 * @param x The new position.
11980 * @param y The new position.
11982 * Sets the top-left position of the menu to (@p x,@p y).
11984 * @note @p x and @p y coordinates are relative to parent.
11986 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
11988 * @brief Close a opened menu
11990 * @param obj the menu object
11993 * Hides the menu and all it's sub-menus.
11995 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
11997 * @brief Returns a list of @p item's items.
11999 * @param obj The menu object
12000 * @return An Eina_List* of @p item's items
12002 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12004 * @brief Get the Evas_Object of an Elm_Menu_Item
12006 * @param item The menu item object.
12007 * @return The edje object containing the swallowed content
12009 * @warning Don't manipulate this object!
12011 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12013 * @brief Add an item at the end of the given menu widget
12015 * @param obj The menu object.
12016 * @param parent The parent menu item (optional)
12017 * @param icon A icon display on the item. The icon will be destryed by the menu.
12018 * @param label The label of the item.
12019 * @param func Function called when the user select the item.
12020 * @param data Data sent by the callback.
12021 * @return Returns the new item.
12023 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);
12025 * @brief Add an object swallowed in an item at the end of the given menu
12028 * @param obj The menu object.
12029 * @param parent The parent menu item (optional)
12030 * @param subobj The object to swallow
12031 * @param func Function called when the user select the item.
12032 * @param data Data sent by the callback.
12033 * @return Returns the new item.
12035 * Add an evas object as an item to the menu.
12037 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);
12039 * @brief Set the label of a menu item
12041 * @param item The menu item object.
12042 * @param label The label to set for @p item
12044 * @warning Don't use this funcion on items created with
12045 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12047 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12049 * @brief Get the label of a menu item
12051 * @param item The menu item object.
12052 * @return The label of @p item
12054 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12056 * @brief Set the icon of a menu item to the standard icon with name @p icon
12058 * @param item The menu item object.
12059 * @param icon The icon object to set for the content of @p item
12061 * Once this icon is set, any previously set icon will be deleted.
12063 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12065 * @brief Get the string representation from the icon of a menu item
12067 * @param item The menu item object.
12068 * @return The string representation of @p item's icon or NULL
12070 * @see elm_menu_item_object_icon_name_set()
12072 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12074 * @deprecated Use elm_menu_item_object_icon_name_set()
12076 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12078 * @deprecated Use elm_menu_item_object_icon_name_get()
12080 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12082 * @brief Set the content object of a menu item
12084 * @param item The menu item object
12085 * @param The content object or NULL
12086 * @return EINA_TRUE on success, else EINA_FALSE
12088 * Use this function to change the object swallowed by a menu item, deleting
12089 * any previously swallowed object.
12091 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12093 * @brief Get the content object of a menu item
12095 * @param item The menu item object
12096 * @return The content object or NULL
12097 * @note If @p item was added with elm_menu_item_add_object, this
12098 * function will return the object passed, else it will return the
12101 * @see elm_menu_item_object_content_set()
12103 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12105 * @deprecated Use elm_menu_item_object_content_get() instead.
12107 EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12109 * @brief Set the selected state of @p item.
12111 * @param item The menu item object.
12112 * @param selected The selected/unselected state of the item
12114 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12116 * @brief Get the selected state of @p item.
12118 * @param item The menu item object.
12119 * @return The selected/unselected state of the item
12121 * @see elm_menu_item_selected_set()
12123 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12125 * @brief Set the disabled state of @p item.
12127 * @param item The menu item object.
12128 * @param disabled The enabled/disabled state of the item
12130 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12132 * @brief Get the disabled state of @p item.
12134 * @param item The menu item object.
12135 * @return The enabled/disabled state of the item
12137 * @see elm_menu_item_disabled_set()
12139 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12141 * @brief Add a separator item to menu @p obj under @p parent.
12143 * @param obj The menu object
12144 * @param parent The item to add the separator under
12145 * @return The created item or NULL on failure
12147 * This is item is a @ref Separator.
12149 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12151 * @brief Returns whether @p item is a separator.
12153 * @param item The item to check
12154 * @return If true, @p item is a separator
12156 * @see elm_menu_item_separator_add()
12158 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12160 * @brief Deletes an item from the menu.
12162 * @param item The item to delete.
12164 * @see elm_menu_item_add()
12166 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12168 * @brief Set the function called when a menu item is deleted.
12170 * @param item The item to set the callback on
12171 * @param func The function called
12173 * @see elm_menu_item_add()
12174 * @see elm_menu_item_del()
12176 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12178 * @brief Returns the data associated with menu item @p item.
12180 * @param item The item
12181 * @return The data associated with @p item or NULL if none was set.
12183 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12185 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12187 * @brief Sets the data to be associated with menu item @p item.
12189 * @param item The item
12190 * @param data The data to be associated with @p item
12192 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12194 * @brief Returns a list of @p item's subitems.
12196 * @param item The item
12197 * @return An Eina_List* of @p item's subitems
12199 * @see elm_menu_add()
12201 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12203 * @brief Get the position of a menu item
12205 * @param item The menu item
12206 * @return The item's index
12208 * This function returns the index position of a menu item in a menu.
12209 * For a sub-menu, this number is relative to the first item in the sub-menu.
12211 * @note Index values begin with 0
12213 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12215 * @brief @brief Return a menu item's owner menu
12217 * @param item The menu item
12218 * @return The menu object owning @p item, or NULL on failure
12220 * Use this function to get the menu object owning an item.
12222 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12224 * @brief Get the selected item in the menu
12226 * @param obj The menu object
12227 * @return The selected item, or NULL if none
12229 * @see elm_menu_item_selected_get()
12230 * @see elm_menu_item_selected_set()
12232 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12234 * @brief Get the last item in the menu
12236 * @param obj The menu object
12237 * @return The last item, or NULL if none
12239 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12241 * @brief Get the first item in the menu
12243 * @param obj The menu object
12244 * @return The first item, or NULL if none
12246 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12248 * @brief Get the next item in the menu.
12250 * @param item The menu item object.
12251 * @return The item after it, or NULL if none
12253 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12255 * @brief Get the previous item in the menu.
12257 * @param item The menu item object.
12258 * @return The item before it, or NULL if none
12260 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12266 * @defgroup List List
12267 * @ingroup Elementary
12269 * @image html img/widget/list/preview-00.png
12270 * @image latex img/widget/list/preview-00.eps width=\textwidth
12272 * @image html img/list.png
12273 * @image latex img/list.eps width=\textwidth
12275 * A list widget is a container whose children are displayed vertically or
12276 * horizontally, in order, and can be selected.
12277 * The list can accept only one or multiple items selection. Also has many
12278 * modes of items displaying.
12280 * A list is a very simple type of list widget. For more robust
12281 * lists, @ref Genlist should probably be used.
12283 * Smart callbacks one can listen to:
12284 * - @c "activated" - The user has double-clicked or pressed
12285 * (enter|return|spacebar) on an item. The @c event_info parameter
12286 * is the item that was activated.
12287 * - @c "clicked,double" - The user has double-clicked an item.
12288 * The @c event_info parameter is the item that was double-clicked.
12289 * - "selected" - when the user selected an item
12290 * - "unselected" - when the user unselected an item
12291 * - "longpressed" - an item in the list is long-pressed
12292 * - "scroll,edge,top" - the list is scrolled until the top edge
12293 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12294 * - "scroll,edge,left" - the list is scrolled until the left edge
12295 * - "scroll,edge,right" - the list is scrolled until the right edge
12297 * Available styles for it:
12300 * List of examples:
12301 * @li @ref list_example_01
12302 * @li @ref list_example_02
12303 * @li @ref list_example_03
12312 * @enum _Elm_List_Mode
12313 * @typedef Elm_List_Mode
12315 * Set list's resize behavior, transverse axis scroll and
12316 * items cropping. See each mode's description for more details.
12318 * @note Default value is #ELM_LIST_SCROLL.
12320 * Values <b> don't </b> work as bitmask, only one can be choosen.
12322 * @see elm_list_mode_set()
12323 * @see elm_list_mode_get()
12327 typedef enum _Elm_List_Mode
12329 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. */
12330 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). */
12331 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. */
12332 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. */
12333 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12336 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(). */
12339 * Add a new list widget to the given parent Elementary
12340 * (container) object.
12342 * @param parent The parent object.
12343 * @return a new list widget handle or @c NULL, on errors.
12345 * This function inserts a new list widget on the canvas.
12349 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12354 * @param obj The list object
12356 * @note Call before running show() on the list object.
12357 * @warning If not called, it won't display the list properly.
12360 * li = elm_list_add(win);
12361 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12362 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12364 * evas_object_show(li);
12369 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12372 * Enable or disable multiple items selection on the list object.
12374 * @param obj The list object
12375 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12378 * Disabled by default. If disabled, the user can select a single item of
12379 * the list each time. Selected items are highlighted on list.
12380 * If enabled, many items can be selected.
12382 * If a selected item is selected again, it will be unselected.
12384 * @see elm_list_multi_select_get()
12388 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12391 * Get a value whether multiple items selection is enabled or not.
12393 * @see elm_list_multi_select_set() for details.
12395 * @param obj The list object.
12396 * @return @c EINA_TRUE means multiple items selection is enabled.
12397 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12398 * @c EINA_FALSE is returned.
12402 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12405 * Set which mode to use for the list object.
12407 * @param obj The list object
12408 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12409 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12411 * Set list's resize behavior, transverse axis scroll and
12412 * items cropping. See each mode's description for more details.
12414 * @note Default value is #ELM_LIST_SCROLL.
12416 * Only one can be set, if a previous one was set, it will be changed
12417 * by the new mode set. Bitmask won't work as well.
12419 * @see elm_list_mode_get()
12423 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12426 * Get the mode the list is at.
12428 * @param obj The list object
12429 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12430 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12432 * @note see elm_list_mode_set() for more information.
12436 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12439 * Enable or disable horizontal mode on the list object.
12441 * @param obj The list object.
12442 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12443 * disable it, i.e., to enable vertical mode.
12445 * @note Vertical mode is set by default.
12447 * On horizontal mode items are displayed on list from left to right,
12448 * instead of from top to bottom. Also, the list will scroll horizontally.
12449 * Each item will presents left icon on top and right icon, or end, at
12452 * @see elm_list_horizontal_get()
12456 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12459 * Get a value whether horizontal mode is enabled or not.
12461 * @param obj The list object.
12462 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12463 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12464 * @c EINA_FALSE is returned.
12466 * @see elm_list_horizontal_set() for details.
12470 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12473 * Enable or disable always select mode on the list object.
12475 * @param obj The list object
12476 * @param always_select @c EINA_TRUE to enable always select mode or
12477 * @c EINA_FALSE to disable it.
12479 * @note Always select mode is disabled by default.
12481 * Default behavior of list items is to only call its callback function
12482 * the first time it's pressed, i.e., when it is selected. If a selected
12483 * item is pressed again, and multi-select is disabled, it won't call
12484 * this function (if multi-select is enabled it will unselect the item).
12486 * If always select is enabled, it will call the callback function
12487 * everytime a item is pressed, so it will call when the item is selected,
12488 * and again when a selected item is pressed.
12490 * @see elm_list_always_select_mode_get()
12491 * @see elm_list_multi_select_set()
12495 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12498 * Get a value whether always select mode is enabled or not, meaning that
12499 * an item will always call its callback function, even if already selected.
12501 * @param obj The list object
12502 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12503 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12504 * @c EINA_FALSE is returned.
12506 * @see elm_list_always_select_mode_set() for details.
12510 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12513 * Set bouncing behaviour when the scrolled content reaches an edge.
12515 * Tell the internal scroller object whether it should bounce or not
12516 * when it reaches the respective edges for each axis.
12518 * @param obj The list object
12519 * @param h_bounce Whether to bounce or not in the horizontal axis.
12520 * @param v_bounce Whether to bounce or not in the vertical axis.
12522 * @see elm_scroller_bounce_set()
12526 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12529 * Get the bouncing behaviour of the internal scroller.
12531 * Get whether the internal scroller should bounce when the edge of each
12532 * axis is reached scrolling.
12534 * @param obj The list object.
12535 * @param h_bounce Pointer where to store the bounce state of the horizontal
12537 * @param v_bounce Pointer where to store the bounce state of the vertical
12540 * @see elm_scroller_bounce_get()
12541 * @see elm_list_bounce_set()
12545 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12548 * Set the scrollbar policy.
12550 * @param obj The list object
12551 * @param policy_h Horizontal scrollbar policy.
12552 * @param policy_v Vertical scrollbar policy.
12554 * This sets the scrollbar visibility policy for the given scroller.
12555 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12556 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12557 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12558 * This applies respectively for the horizontal and vertical scrollbars.
12560 * The both are disabled by default, i.e., are set to
12561 * #ELM_SCROLLER_POLICY_OFF.
12565 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12568 * Get the scrollbar policy.
12570 * @see elm_list_scroller_policy_get() for details.
12572 * @param obj The list object.
12573 * @param policy_h Pointer where to store horizontal scrollbar policy.
12574 * @param policy_v Pointer where to store vertical scrollbar policy.
12578 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);
12581 * Append a new item to the list object.
12583 * @param obj The list object.
12584 * @param label The label of the list item.
12585 * @param icon The icon object to use for the left side of the item. An
12586 * icon can be any Evas object, but usually it is an icon created
12587 * with elm_icon_add().
12588 * @param end The icon object to use for the right side of the item. An
12589 * icon can be any Evas object.
12590 * @param func The function to call when the item is clicked.
12591 * @param data The data to associate with the item for related callbacks.
12593 * @return The created item or @c NULL upon failure.
12595 * A new item will be created and appended to the list, i.e., will
12596 * be set as @b last item.
12598 * Items created with this method can be deleted with
12599 * elm_list_item_del().
12601 * Associated @p data can be properly freed when item is deleted if a
12602 * callback function is set with elm_list_item_del_cb_set().
12604 * If a function is passed as argument, it will be called everytime this item
12605 * is selected, i.e., the user clicks over an unselected item.
12606 * If always select is enabled it will call this function every time
12607 * user clicks over an item (already selected or not).
12608 * If such function isn't needed, just passing
12609 * @c NULL as @p func is enough. The same should be done for @p data.
12611 * Simple example (with no function callback or data associated):
12613 * li = elm_list_add(win);
12614 * ic = elm_icon_add(win);
12615 * elm_icon_file_set(ic, "path/to/image", NULL);
12616 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12617 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12619 * evas_object_show(li);
12622 * @see elm_list_always_select_mode_set()
12623 * @see elm_list_item_del()
12624 * @see elm_list_item_del_cb_set()
12625 * @see elm_list_clear()
12626 * @see elm_icon_add()
12630 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);
12633 * Prepend a new item to the list object.
12635 * @param obj The list object.
12636 * @param label The label of the list item.
12637 * @param icon The icon object to use for the left side of the item. An
12638 * icon can be any Evas object, but usually it is an icon created
12639 * with elm_icon_add().
12640 * @param end The icon object to use for the right side of the item. An
12641 * icon can be any Evas object.
12642 * @param func The function to call when the item is clicked.
12643 * @param data The data to associate with the item for related callbacks.
12645 * @return The created item or @c NULL upon failure.
12647 * A new item will be created and prepended to the list, i.e., will
12648 * be set as @b first item.
12650 * Items created with this method can be deleted with
12651 * elm_list_item_del().
12653 * Associated @p data can be properly freed when item is deleted if a
12654 * callback function is set with elm_list_item_del_cb_set().
12656 * If a function is passed as argument, it will be called everytime this item
12657 * is selected, i.e., the user clicks over an unselected item.
12658 * If always select is enabled it will call this function every time
12659 * user clicks over an item (already selected or not).
12660 * If such function isn't needed, just passing
12661 * @c NULL as @p func is enough. The same should be done for @p data.
12663 * @see elm_list_item_append() for a simple code example.
12664 * @see elm_list_always_select_mode_set()
12665 * @see elm_list_item_del()
12666 * @see elm_list_item_del_cb_set()
12667 * @see elm_list_clear()
12668 * @see elm_icon_add()
12672 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);
12675 * Insert a new item into the list object before item @p before.
12677 * @param obj The list object.
12678 * @param before The list item to insert before.
12679 * @param label The label of the list item.
12680 * @param icon The icon object to use for the left side of the item. An
12681 * icon can be any Evas object, but usually it is an icon created
12682 * with elm_icon_add().
12683 * @param end The icon object to use for the right side of the item. An
12684 * icon can be any Evas object.
12685 * @param func The function to call when the item is clicked.
12686 * @param data The data to associate with the item for related callbacks.
12688 * @return The created item or @c NULL upon failure.
12690 * A new item will be created and added to the list. Its position in
12691 * this list will be just before item @p before.
12693 * Items created with this method can be deleted with
12694 * elm_list_item_del().
12696 * Associated @p data can be properly freed when item is deleted if a
12697 * callback function is set with elm_list_item_del_cb_set().
12699 * If a function is passed as argument, it will be called everytime this item
12700 * is selected, i.e., the user clicks over an unselected item.
12701 * If always select is enabled it will call this function every time
12702 * user clicks over an item (already selected or not).
12703 * If such function isn't needed, just passing
12704 * @c NULL as @p func is enough. The same should be done for @p data.
12706 * @see elm_list_item_append() for a simple code example.
12707 * @see elm_list_always_select_mode_set()
12708 * @see elm_list_item_del()
12709 * @see elm_list_item_del_cb_set()
12710 * @see elm_list_clear()
12711 * @see elm_icon_add()
12715 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);
12718 * Insert a new item into the list object after item @p after.
12720 * @param obj The list object.
12721 * @param after The list item to insert after.
12722 * @param label The label of the list item.
12723 * @param icon The icon object to use for the left side of the item. An
12724 * icon can be any Evas object, but usually it is an icon created
12725 * with elm_icon_add().
12726 * @param end The icon object to use for the right side of the item. An
12727 * icon can be any Evas object.
12728 * @param func The function to call when the item is clicked.
12729 * @param data The data to associate with the item for related callbacks.
12731 * @return The created item or @c NULL upon failure.
12733 * A new item will be created and added to the list. Its position in
12734 * this list will be just after item @p after.
12736 * Items created with this method can be deleted with
12737 * elm_list_item_del().
12739 * Associated @p data can be properly freed when item is deleted if a
12740 * callback function is set with elm_list_item_del_cb_set().
12742 * If a function is passed as argument, it will be called everytime this item
12743 * is selected, i.e., the user clicks over an unselected item.
12744 * If always select is enabled it will call this function every time
12745 * user clicks over an item (already selected or not).
12746 * If such function isn't needed, just passing
12747 * @c NULL as @p func is enough. The same should be done for @p data.
12749 * @see elm_list_item_append() for a simple code example.
12750 * @see elm_list_always_select_mode_set()
12751 * @see elm_list_item_del()
12752 * @see elm_list_item_del_cb_set()
12753 * @see elm_list_clear()
12754 * @see elm_icon_add()
12758 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);
12761 * Insert a new item into the sorted list object.
12763 * @param obj The list object.
12764 * @param label The label of the list item.
12765 * @param icon The icon object to use for the left side of the item. An
12766 * icon can be any Evas object, but usually it is an icon created
12767 * with elm_icon_add().
12768 * @param end The icon object to use for the right side of the item. An
12769 * icon can be any Evas object.
12770 * @param func The function to call when the item is clicked.
12771 * @param data The data to associate with the item for related callbacks.
12772 * @param cmp_func The comparing function to be used to sort list
12773 * items <b>by #Elm_List_Item item handles</b>. This function will
12774 * receive two items and compare them, returning a non-negative integer
12775 * if the second item should be place after the first, or negative value
12776 * if should be placed before.
12778 * @return The created item or @c NULL upon failure.
12780 * @note This function inserts values into a list object assuming it was
12781 * sorted and the result will be sorted.
12783 * A new item will be created and added to the list. Its position in
12784 * this list will be found comparing the new item with previously inserted
12785 * items using function @p cmp_func.
12787 * Items created with this method can be deleted with
12788 * elm_list_item_del().
12790 * Associated @p data can be properly freed when item is deleted if a
12791 * callback function is set with elm_list_item_del_cb_set().
12793 * If a function is passed as argument, it will be called everytime this item
12794 * is selected, i.e., the user clicks over an unselected item.
12795 * If always select is enabled it will call this function every time
12796 * user clicks over an item (already selected or not).
12797 * If such function isn't needed, just passing
12798 * @c NULL as @p func is enough. The same should be done for @p data.
12800 * @see elm_list_item_append() for a simple code example.
12801 * @see elm_list_always_select_mode_set()
12802 * @see elm_list_item_del()
12803 * @see elm_list_item_del_cb_set()
12804 * @see elm_list_clear()
12805 * @see elm_icon_add()
12809 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);
12812 * Remove all list's items.
12814 * @param obj The list object
12816 * @see elm_list_item_del()
12817 * @see elm_list_item_append()
12821 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12824 * Get a list of all the list items.
12826 * @param obj The list object
12827 * @return An @c Eina_List of list items, #Elm_List_Item,
12828 * or @c NULL on failure.
12830 * @see elm_list_item_append()
12831 * @see elm_list_item_del()
12832 * @see elm_list_clear()
12836 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12839 * Get the selected item.
12841 * @param obj The list object.
12842 * @return The selected list item.
12844 * The selected item can be unselected with function
12845 * elm_list_item_selected_set().
12847 * The selected item always will be highlighted on list.
12849 * @see elm_list_selected_items_get()
12853 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12856 * Return a list of the currently selected list items.
12858 * @param obj The list object.
12859 * @return An @c Eina_List of list items, #Elm_List_Item,
12860 * or @c NULL on failure.
12862 * Multiple items can be selected if multi select is enabled. It can be
12863 * done with elm_list_multi_select_set().
12865 * @see elm_list_selected_item_get()
12866 * @see elm_list_multi_select_set()
12870 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12873 * Set the selected state of an item.
12875 * @param item The list item
12876 * @param selected The selected state
12878 * This sets the selected state of the given item @p it.
12879 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12881 * If a new item is selected the previosly selected will be unselected,
12882 * unless multiple selection is enabled with elm_list_multi_select_set().
12883 * Previoulsy selected item can be get with function
12884 * elm_list_selected_item_get().
12886 * Selected items will be highlighted.
12888 * @see elm_list_item_selected_get()
12889 * @see elm_list_selected_item_get()
12890 * @see elm_list_multi_select_set()
12894 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12897 * Get whether the @p item is selected or not.
12899 * @param item The list item.
12900 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12901 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12903 * @see elm_list_selected_item_set() for details.
12904 * @see elm_list_item_selected_get()
12908 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12911 * Set or unset item as a separator.
12913 * @param it The list item.
12914 * @param setting @c EINA_TRUE to set item @p it as separator or
12915 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12917 * Items aren't set as separator by default.
12919 * If set as separator it will display separator theme, so won't display
12922 * @see elm_list_item_separator_get()
12926 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12929 * Get a value whether item is a separator or not.
12931 * @see elm_list_item_separator_set() for details.
12933 * @param it The list item.
12934 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12935 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12939 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12942 * Show @p item in the list view.
12944 * @param item The list item to be shown.
12946 * It won't animate list until item is visible. If such behavior is wanted,
12947 * use elm_list_bring_in() intead.
12951 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12954 * Bring in the given item to list view.
12956 * @param item The item.
12958 * This causes list to jump to the given item @p item and show it
12959 * (by scrolling), if it is not fully visible.
12961 * This may use animation to do so and take a period of time.
12963 * If animation isn't wanted, elm_list_item_show() can be used.
12967 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12970 * Delete them item from the list.
12972 * @param item The item of list to be deleted.
12974 * If deleting all list items is required, elm_list_clear()
12975 * should be used instead of getting items list and deleting each one.
12977 * @see elm_list_clear()
12978 * @see elm_list_item_append()
12979 * @see elm_list_item_del_cb_set()
12983 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12986 * Set the function called when a list item is freed.
12988 * @param item The item to set the callback on
12989 * @param func The function called
12991 * If there is a @p func, then it will be called prior item's memory release.
12992 * That will be called with the following arguments:
12994 * @li item's Evas object;
12997 * This way, a data associated to a list item could be properly freed.
13001 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13004 * Get the data associated to the item.
13006 * @param item The list item
13007 * @return The data associated to @p item
13009 * The return value is a pointer to data associated to @p item when it was
13010 * created, with function elm_list_item_append() or similar. If no data
13011 * was passed as argument, it will return @c NULL.
13013 * @see elm_list_item_append()
13017 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13020 * Get the left side icon associated to the item.
13022 * @param item The list item
13023 * @return The left side icon associated to @p item
13025 * The return value is a pointer to the icon associated to @p item when
13027 * created, with function elm_list_item_append() or similar, or later
13028 * with function elm_list_item_icon_set(). If no icon
13029 * was passed as argument, it will return @c NULL.
13031 * @see elm_list_item_append()
13032 * @see elm_list_item_icon_set()
13036 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13039 * Set the left side icon associated to the item.
13041 * @param item The list item
13042 * @param icon The left side icon object to associate with @p item
13044 * The icon object to use at left side of the item. An
13045 * icon can be any Evas object, but usually it is an icon created
13046 * with elm_icon_add().
13048 * Once the icon object is set, a previously set one will be deleted.
13049 * @warning Setting the same icon for two items will cause the icon to
13050 * dissapear from the first item.
13052 * If an icon was passed as argument on item creation, with function
13053 * elm_list_item_append() or similar, it will be already
13054 * associated to the item.
13056 * @see elm_list_item_append()
13057 * @see elm_list_item_icon_get()
13061 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13064 * Get the right side icon associated to the item.
13066 * @param item The list item
13067 * @return The right side icon associated to @p item
13069 * The return value is a pointer to the icon associated to @p item when
13071 * created, with function elm_list_item_append() or similar, or later
13072 * with function elm_list_item_icon_set(). If no icon
13073 * was passed as argument, it will return @c NULL.
13075 * @see elm_list_item_append()
13076 * @see elm_list_item_icon_set()
13080 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13083 * Set the right side icon associated to the item.
13085 * @param item The list item
13086 * @param end The right side icon object to associate with @p item
13088 * The icon object to use at right side of the item. An
13089 * icon can be any Evas object, but usually it is an icon created
13090 * with elm_icon_add().
13092 * Once the icon object is set, a previously set one will be deleted.
13093 * @warning Setting the same icon for two items will cause the icon to
13094 * dissapear from the first item.
13096 * If an icon was passed as argument on item creation, with function
13097 * elm_list_item_append() or similar, it will be already
13098 * associated to the item.
13100 * @see elm_list_item_append()
13101 * @see elm_list_item_end_get()
13105 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13108 * Gets the base object of the item.
13110 * @param item The list item
13111 * @return The base object associated with @p item
13113 * Base object is the @c Evas_Object that represents that item.
13117 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13120 * Get the label of item.
13122 * @param item The item of list.
13123 * @return The label of item.
13125 * The return value is a pointer to the label associated to @p item when
13126 * it was created, with function elm_list_item_append(), or later
13127 * with function elm_list_item_label_set. If no label
13128 * was passed as argument, it will return @c NULL.
13130 * @see elm_list_item_label_set() for more details.
13131 * @see elm_list_item_append()
13135 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13138 * Set the label of item.
13140 * @param item The item of list.
13141 * @param text The label of item.
13143 * The label to be displayed by the item.
13144 * Label will be placed between left and right side icons (if set).
13146 * If a label was passed as argument on item creation, with function
13147 * elm_list_item_append() or similar, it will be already
13148 * displayed by the item.
13150 * @see elm_list_item_label_get()
13151 * @see elm_list_item_append()
13155 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13159 * Get the item before @p it in list.
13161 * @param it The list item.
13162 * @return The item before @p it, or @c NULL if none or on failure.
13164 * @note If it is the first item, @c NULL will be returned.
13166 * @see elm_list_item_append()
13167 * @see elm_list_items_get()
13171 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13174 * Get the item after @p it in list.
13176 * @param it The list item.
13177 * @return The item after @p it, or @c NULL if none or on failure.
13179 * @note If it is the last 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_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13189 * Sets the disabled/enabled state of a list item.
13191 * @param it The item.
13192 * @param disabled The disabled state.
13194 * A disabled item cannot be selected or unselected. It will also
13195 * change its appearance (generally greyed out). This sets the
13196 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13201 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13204 * Get a value whether list item is disabled or not.
13206 * @param it The item.
13207 * @return The disabled state.
13209 * @see elm_list_item_disabled_set() for more details.
13213 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13216 * Set the text to be shown in a given list item's tooltips.
13218 * @param item Target item.
13219 * @param text The text to set in the content.
13221 * Setup the text as tooltip to object. The item can have only one tooltip,
13222 * so any previous tooltip data - set with this function or
13223 * elm_list_item_tooltip_content_cb_set() - is removed.
13225 * @see elm_object_tooltip_text_set() for more details.
13229 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13233 * @brief Disable size restrictions on an object's tooltip
13234 * @param item The tooltip's anchor object
13235 * @param disable If EINA_TRUE, size restrictions are disabled
13236 * @return EINA_FALSE on failure, EINA_TRUE on success
13238 * This function allows a tooltip to expand beyond its parant window's canvas.
13239 * It will instead be limited only by the size of the display.
13241 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13243 * @brief Retrieve size restriction state of an object's tooltip
13244 * @param obj The tooltip's anchor object
13245 * @return If EINA_TRUE, size restrictions are disabled
13247 * This function returns whether a tooltip is allowed to expand beyond
13248 * its parant window's canvas.
13249 * It will instead be limited only by the size of the display.
13251 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13254 * Set the content to be shown in the tooltip item.
13256 * Setup the tooltip to item. The item can have only one tooltip,
13257 * so any previous tooltip data is removed. @p func(with @p data) will
13258 * be called every time that need show the tooltip and it should
13259 * return a valid Evas_Object. This object is then managed fully by
13260 * tooltip system and is deleted when the tooltip is gone.
13262 * @param item the list item being attached a tooltip.
13263 * @param func the function used to create the tooltip contents.
13264 * @param data what to provide to @a func as callback data/context.
13265 * @param del_cb called when data is not needed anymore, either when
13266 * another callback replaces @a func, the tooltip is unset with
13267 * elm_list_item_tooltip_unset() or the owner @a item
13268 * dies. This callback receives as the first parameter the
13269 * given @a data, and @c event_info is the item.
13271 * @see elm_object_tooltip_content_cb_set() for more details.
13275 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);
13278 * Unset tooltip from item.
13280 * @param item list item to remove previously set tooltip.
13282 * Remove tooltip from item. The callback provided as del_cb to
13283 * elm_list_item_tooltip_content_cb_set() will be called to notify
13284 * it is not used anymore.
13286 * @see elm_object_tooltip_unset() for more details.
13287 * @see elm_list_item_tooltip_content_cb_set()
13291 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13294 * Sets a different style for this item tooltip.
13296 * @note before you set a style you should define a tooltip with
13297 * elm_list_item_tooltip_content_cb_set() or
13298 * elm_list_item_tooltip_text_set()
13300 * @param item list item with tooltip already set.
13301 * @param style the theme style to use (default, transparent, ...)
13303 * @see elm_object_tooltip_style_set() for more details.
13307 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13310 * Get the style for this item tooltip.
13312 * @param item list item with tooltip already set.
13313 * @return style the theme style in use, defaults to "default". If the
13314 * object does not have a tooltip set, then NULL is returned.
13316 * @see elm_object_tooltip_style_get() for more details.
13317 * @see elm_list_item_tooltip_style_set()
13321 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13324 * Set the type of mouse pointer/cursor decoration to be shown,
13325 * when the mouse pointer is over the given list widget item
13327 * @param item list item to customize cursor on
13328 * @param cursor the cursor type's name
13330 * This function works analogously as elm_object_cursor_set(), but
13331 * here the cursor's changing area is restricted to the item's
13332 * area, and not the whole widget's. Note that that item cursors
13333 * have precedence over widget cursors, so that a mouse over an
13334 * item with custom cursor set will always show @b that cursor.
13336 * If this function is called twice for an object, a previously set
13337 * cursor will be unset on the second call.
13339 * @see elm_object_cursor_set()
13340 * @see elm_list_item_cursor_get()
13341 * @see elm_list_item_cursor_unset()
13345 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13348 * Get the type of mouse pointer/cursor decoration set to be shown,
13349 * when the mouse pointer is over the given list widget item
13351 * @param item list item with custom cursor set
13352 * @return the cursor type's name or @c NULL, if no custom cursors
13353 * were set to @p item (and on errors)
13355 * @see elm_object_cursor_get()
13356 * @see elm_list_item_cursor_set()
13357 * @see elm_list_item_cursor_unset()
13361 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13364 * Unset any custom mouse pointer/cursor decoration set to be
13365 * shown, when the mouse pointer is over the given list widget
13366 * item, thus making it show the @b default cursor again.
13368 * @param item a list item
13370 * Use this call to undo any custom settings on this item's cursor
13371 * decoration, bringing it back to defaults (no custom style set).
13373 * @see elm_object_cursor_unset()
13374 * @see elm_list_item_cursor_set()
13378 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13381 * Set a different @b style for a given custom cursor set for a
13384 * @param item list item with custom cursor set
13385 * @param style the <b>theme style</b> to use (e.g. @c "default",
13386 * @c "transparent", etc)
13388 * This function only makes sense when one is using custom mouse
13389 * cursor decorations <b>defined in a theme file</b>, which can have,
13390 * given a cursor name/type, <b>alternate styles</b> on it. It
13391 * works analogously as elm_object_cursor_style_set(), but here
13392 * applyed only to list item objects.
13394 * @warning Before you set a cursor style you should have definen a
13395 * custom cursor previously on the item, with
13396 * elm_list_item_cursor_set()
13398 * @see elm_list_item_cursor_engine_only_set()
13399 * @see elm_list_item_cursor_style_get()
13403 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13406 * Get the current @b style set for a given list item's custom
13409 * @param item list item with custom cursor set.
13410 * @return style the cursor style in use. If the object does not
13411 * have a cursor set, then @c NULL is returned.
13413 * @see elm_list_item_cursor_style_set() for more details
13417 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13420 * Set if the (custom)cursor for a given list item should be
13421 * searched in its theme, also, or should only rely on the
13422 * rendering engine.
13424 * @param item item with custom (custom) cursor already set on
13425 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13426 * only on those provided by the rendering engine, @c EINA_FALSE to
13427 * have them searched on the widget's theme, as well.
13429 * @note This call is of use only if you've set a custom cursor
13430 * for list items, with elm_list_item_cursor_set().
13432 * @note By default, cursors will only be looked for between those
13433 * provided by the rendering engine.
13437 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13440 * Get if the (custom) cursor for a given list item is being
13441 * searched in its theme, also, or is only relying on the rendering
13444 * @param item a list item
13445 * @return @c EINA_TRUE, if cursors are being looked for only on
13446 * those provided by the rendering engine, @c EINA_FALSE if they
13447 * are being searched on the widget's theme, as well.
13449 * @see elm_list_item_cursor_engine_only_set(), for more details
13453 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13460 * @defgroup Slider Slider
13461 * @ingroup Elementary
13463 * @image html img/widget/slider/preview-00.png
13464 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13466 * The slider adds a dragable “slider” widget for selecting the value of
13467 * something within a range.
13469 * A slider can be horizontal or vertical. It can contain an Icon and has a
13470 * primary label as well as a units label (that is formatted with floating
13471 * point values and thus accepts a printf-style format string, like
13472 * “%1.2f units”. There is also an indicator string that may be somewhere
13473 * else (like on the slider itself) that also accepts a format string like
13474 * units. Label, Icon Unit and Indicator strings/objects are optional.
13476 * A slider may be inverted which means values invert, with high vales being
13477 * on the left or top and low values on the right or bottom (as opposed to
13478 * normally being low on the left or top and high on the bottom and right).
13480 * The slider should have its minimum and maximum values set by the
13481 * application with elm_slider_min_max_set() and value should also be set by
13482 * the application before use with elm_slider_value_set(). The span of the
13483 * slider is its length (horizontally or vertically). This will be scaled by
13484 * the object or applications scaling factor. At any point code can query the
13485 * slider for its value with elm_slider_value_get().
13487 * Smart callbacks one can listen to:
13488 * - "changed" - Whenever the slider value is changed by the user.
13489 * - "slider,drag,start" - dragging the slider indicator around has started.
13490 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13491 * - "delay,changed" - A short time after the value is changed by the user.
13492 * This will be called only when the user stops dragging for
13493 * a very short period or when they release their
13494 * finger/mouse, so it avoids possibly expensive reactions to
13495 * the value change.
13497 * Available styles for it:
13500 * Here is an example on its usage:
13501 * @li @ref slider_example
13505 * @addtogroup Slider
13510 * Add a new slider widget to the given parent Elementary
13511 * (container) object.
13513 * @param parent The parent object.
13514 * @return a new slider widget handle or @c NULL, on errors.
13516 * This function inserts a new slider widget on the canvas.
13520 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13523 * Set the label of a given slider widget
13525 * @param obj The progress bar object
13526 * @param label The text label string, in UTF-8
13529 * @deprecated use elm_object_text_set() instead.
13531 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13534 * Get the label of a given slider widget
13536 * @param obj The progressbar object
13537 * @return The text label string, in UTF-8
13540 * @deprecated use elm_object_text_get() instead.
13542 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13545 * Set the icon object of the slider object.
13547 * @param obj The slider object.
13548 * @param icon The icon object.
13550 * On horizontal mode, icon is placed at left, and on vertical mode,
13553 * @note Once the icon object is set, a previously set one will be deleted.
13554 * If you want to keep that old content object, use the
13555 * elm_slider_icon_unset() function.
13557 * @warning If the object being set does not have minimum size hints set,
13558 * it won't get properly displayed.
13562 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13565 * Unset an icon set on a given slider widget.
13567 * @param obj The slider object.
13568 * @return The icon object that was being used, if any was set, or
13569 * @c NULL, otherwise (and on errors).
13571 * On horizontal mode, icon is placed at left, and on vertical mode,
13574 * This call will unparent and return the icon object which was set
13575 * for this widget, previously, on success.
13577 * @see elm_slider_icon_set() for more details
13578 * @see elm_slider_icon_get()
13582 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13585 * Retrieve the icon object set for a given slider widget.
13587 * @param obj The slider object.
13588 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13589 * otherwise (and on errors).
13591 * On horizontal mode, icon is placed at left, and on vertical mode,
13594 * @see elm_slider_icon_set() for more details
13595 * @see elm_slider_icon_unset()
13599 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13602 * Set the end object of the slider object.
13604 * @param obj The slider object.
13605 * @param end The end object.
13607 * On horizontal mode, end is placed at left, and on vertical mode,
13608 * placed at bottom.
13610 * @note Once the icon object is set, a previously set one will be deleted.
13611 * If you want to keep that old content object, use the
13612 * elm_slider_end_unset() function.
13614 * @warning If the object being set does not have minimum size hints set,
13615 * it won't get properly displayed.
13619 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13622 * Unset an end object set on a given slider widget.
13624 * @param obj The slider object.
13625 * @return The end object that was being used, if any was set, or
13626 * @c NULL, otherwise (and on errors).
13628 * On horizontal mode, end is placed at left, and on vertical mode,
13629 * placed at bottom.
13631 * This call will unparent and return the icon object which was set
13632 * for this widget, previously, on success.
13634 * @see elm_slider_end_set() for more details.
13635 * @see elm_slider_end_get()
13639 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13642 * Retrieve the end object set for a given slider widget.
13644 * @param obj The slider object.
13645 * @return The end object's handle, if @p obj had one set, or @c NULL,
13646 * otherwise (and on errors).
13648 * On horizontal mode, icon is placed at right, and on vertical mode,
13649 * placed at bottom.
13651 * @see elm_slider_end_set() for more details.
13652 * @see elm_slider_end_unset()
13656 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13659 * Set the (exact) length of the bar region of a given slider widget.
13661 * @param obj The slider object.
13662 * @param size The length of the slider's bar region.
13664 * This sets the minimum width (when in horizontal mode) or height
13665 * (when in vertical mode) of the actual bar area of the slider
13666 * @p obj. This in turn affects the object's minimum size. Use
13667 * this when you're not setting other size hints expanding on the
13668 * given direction (like weight and alignment hints) and you would
13669 * like it to have a specific size.
13671 * @note Icon, end, label, indicator and unit text around @p obj
13672 * will require their
13673 * own space, which will make @p obj to require more the @p size,
13676 * @see elm_slider_span_size_get()
13680 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13683 * Get the length set for the bar region of a given slider widget
13685 * @param obj The slider object.
13686 * @return The length of the slider's bar region.
13688 * If that size was not set previously, with
13689 * elm_slider_span_size_set(), this call will return @c 0.
13693 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13696 * Set the format string for the unit label.
13698 * @param obj The slider object.
13699 * @param format The format string for the unit display.
13701 * Unit label is displayed all the time, if set, after slider's bar.
13702 * In horizontal mode, at right and in vertical mode, at bottom.
13704 * If @c NULL, unit label won't be visible. If not it sets the format
13705 * string for the label text. To the label text is provided a floating point
13706 * value, so the label text can display up to 1 floating point value.
13707 * Note that this is optional.
13709 * Use a format string such as "%1.2f meters" for example, and it will
13710 * display values like: "3.14 meters" for a value equal to 3.14159.
13712 * Default is unit label disabled.
13714 * @see elm_slider_indicator_format_get()
13718 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13721 * Get the unit label format of the slider.
13723 * @param obj The slider object.
13724 * @return The unit label format string in UTF-8.
13726 * Unit label is displayed all the time, if set, after slider's bar.
13727 * In horizontal mode, at right and in vertical mode, at bottom.
13729 * @see elm_slider_unit_format_set() for more
13730 * information on how this works.
13734 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13737 * Set the format string for the indicator label.
13739 * @param obj The slider object.
13740 * @param indicator The format string for the indicator display.
13742 * The slider may display its value somewhere else then unit label,
13743 * for example, above the slider knob that is dragged around. This function
13744 * sets the format string used for this.
13746 * If @c NULL, indicator label won't be visible. If not it sets the format
13747 * string for the label text. To the label text is provided a floating point
13748 * value, so the label text can display up to 1 floating point value.
13749 * Note that this is optional.
13751 * Use a format string such as "%1.2f meters" for example, and it will
13752 * display values like: "3.14 meters" for a value equal to 3.14159.
13754 * Default is indicator label disabled.
13756 * @see elm_slider_indicator_format_get()
13760 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13763 * Get the indicator label format of the slider.
13765 * @param obj The slider object.
13766 * @return The indicator label format string in UTF-8.
13768 * The slider may display its value somewhere else then unit label,
13769 * for example, above the slider knob that is dragged around. This function
13770 * gets the format string used for this.
13772 * @see elm_slider_indicator_format_set() for more
13773 * information on how this works.
13777 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13780 * Set the format function pointer for the indicator label
13782 * @param obj The slider object.
13783 * @param func The indicator format function.
13784 * @param free_func The freeing function for the format string.
13786 * Set the callback function to format the indicator string.
13788 * @see elm_slider_indicator_format_set() for more info on how this works.
13792 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);
13795 * Set the format function pointer for the units label
13797 * @param obj The slider object.
13798 * @param func The units 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_units_format_set() for more info on how this works.
13807 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);
13810 * Set the orientation of a given slider widget.
13812 * @param obj The slider object.
13813 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13814 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13816 * Use this function to change how your slider is to be
13817 * disposed: vertically or horizontally.
13819 * By default it's displayed horizontally.
13821 * @see elm_slider_horizontal_get()
13825 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13828 * Retrieve the orientation of a given slider widget
13830 * @param obj The slider object.
13831 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13832 * @c EINA_FALSE if it's @b vertical (and on errors).
13834 * @see elm_slider_horizontal_set() for more details.
13838 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13841 * Set the minimum and maximum values for the slider.
13843 * @param obj The slider object.
13844 * @param min The minimum value.
13845 * @param max The maximum value.
13847 * Define the allowed range of values to be selected by the user.
13849 * If actual value is less than @p min, it will be updated to @p min. If it
13850 * is bigger then @p max, will be updated to @p max. Actual value can be
13851 * get with elm_slider_value_get().
13853 * By default, min is equal to 0.0, and max is equal to 1.0.
13855 * @warning Maximum must be greater than minimum, otherwise behavior
13858 * @see elm_slider_min_max_get()
13862 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13865 * Get the minimum and maximum values of the slider.
13867 * @param obj The slider object.
13868 * @param min Pointer where to store the minimum value.
13869 * @param max Pointer where to store the maximum value.
13871 * @note If only one value is needed, the other pointer can be passed
13874 * @see elm_slider_min_max_set() for details.
13878 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13881 * Set the value the slider displays.
13883 * @param obj The slider object.
13884 * @param val The value to be displayed.
13886 * Value will be presented on the unit label following format specified with
13887 * elm_slider_unit_format_set() and on indicator with
13888 * elm_slider_indicator_format_set().
13890 * @warning The value must to be between min and max values. This values
13891 * are set by elm_slider_min_max_set().
13893 * @see elm_slider_value_get()
13894 * @see elm_slider_unit_format_set()
13895 * @see elm_slider_indicator_format_set()
13896 * @see elm_slider_min_max_set()
13900 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13903 * Get the value displayed by the spinner.
13905 * @param obj The spinner object.
13906 * @return The value displayed.
13908 * @see elm_spinner_value_set() for details.
13912 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13915 * Invert a given slider widget's displaying values order
13917 * @param obj The slider object.
13918 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13919 * @c EINA_FALSE to bring it back to default, non-inverted values.
13921 * A slider may be @b inverted, in which state it gets its
13922 * values inverted, with high vales being on the left or top and
13923 * low values on the right or bottom, as opposed to normally have
13924 * the low values on the former and high values on the latter,
13925 * respectively, for horizontal and vertical modes.
13927 * @see elm_slider_inverted_get()
13931 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13934 * Get whether a given slider widget's displaying values are
13937 * @param obj The slider object.
13938 * @return @c EINA_TRUE, if @p obj has inverted values,
13939 * @c EINA_FALSE otherwise (and on errors).
13941 * @see elm_slider_inverted_set() for more details.
13945 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13948 * Set whether to enlarge slider indicator (augmented knob) or not.
13950 * @param obj The slider object.
13951 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13952 * let the knob always at default size.
13954 * By default, indicator will be bigger while dragged by the user.
13956 * @warning It won't display values set with
13957 * elm_slider_indicator_format_set() if you disable indicator.
13961 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13964 * Get whether a given slider widget's enlarging indicator or not.
13966 * @param obj The slider object.
13967 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13968 * @c EINA_FALSE otherwise (and on errors).
13970 * @see elm_slider_indicator_show_set() for details.
13974 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13981 * @addtogroup Actionslider Actionslider
13983 * @image html img/widget/actionslider/preview-00.png
13984 * @image latex img/widget/actionslider/preview-00.eps
13986 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13987 * properties. The indicator is the element the user drags to choose a label.
13988 * When the position is set with magnet, when released the indicator will be
13989 * moved to it if it's nearest the magnetized position.
13991 * @note By default all positions are set as enabled.
13993 * Signals that you can add callbacks for are:
13995 * "selected" - when user selects an enabled position (the label is passed
13998 * "pos_changed" - when the indicator reaches any of the positions("left",
13999 * "right" or "center").
14001 * See an example of actionslider usage @ref actionslider_example_page "here"
14004 typedef enum _Elm_Actionslider_Pos
14006 ELM_ACTIONSLIDER_NONE = 0,
14007 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14008 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14009 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14010 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14011 } Elm_Actionslider_Pos;
14014 * Add a new actionslider to the parent.
14016 * @param parent The parent object
14017 * @return The new actionslider object or NULL if it cannot be created
14019 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14021 * Set actionslider labels.
14023 * @param obj The actionslider object
14024 * @param left_label The label to be set on the left.
14025 * @param center_label The label to be set on the center.
14026 * @param right_label The label to be set on the right.
14027 * @deprecated use elm_object_text_set() instead.
14029 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);
14031 * Get actionslider labels.
14033 * @param obj The actionslider object
14034 * @param left_label A char** to place the left_label of @p obj into.
14035 * @param center_label A char** to place the center_label of @p obj into.
14036 * @param right_label A char** to place the right_label of @p obj into.
14037 * @deprecated use elm_object_text_set() instead.
14039 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);
14041 * Get actionslider selected label.
14043 * @param obj The actionslider object
14044 * @return The selected label
14046 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14048 * Set actionslider indicator position.
14050 * @param obj The actionslider object.
14051 * @param pos The position of the indicator.
14053 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14055 * Get actionslider indicator position.
14057 * @param obj The actionslider object.
14058 * @return The position of the indicator.
14060 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14062 * Set actionslider magnet position. To make multiple positions magnets @c or
14063 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14065 * @param obj The actionslider object.
14066 * @param pos Bit mask indicating the magnet positions.
14068 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14070 * Get actionslider magnet position.
14072 * @param obj The actionslider object.
14073 * @return The positions with magnet property.
14075 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14077 * Set actionslider enabled position. To set multiple positions as enabled @c or
14078 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14080 * @note All the positions are enabled by default.
14082 * @param obj The actionslider object.
14083 * @param pos Bit mask indicating the enabled positions.
14085 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14087 * Get actionslider enabled position.
14089 * @param obj The actionslider object.
14090 * @return The enabled positions.
14092 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14094 * Set the label used on the indicator.
14096 * @param obj The actionslider object
14097 * @param label The label to be set on the indicator.
14098 * @deprecated use elm_object_text_set() instead.
14100 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14102 * Get the label used on the indicator object.
14104 * @param obj The actionslider object
14105 * @return The indicator label
14106 * @deprecated use elm_object_text_get() instead.
14108 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14114 * @defgroup Genlist Genlist
14116 * @image html img/widget/genlist/preview-00.png
14117 * @image latex img/widget/genlist/preview-00.eps
14118 * @image html img/genlist.png
14119 * @image latex img/genlist.eps
14121 * This widget aims to have more expansive list than the simple list in
14122 * Elementary that could have more flexible items and allow many more entries
14123 * while still being fast and low on memory usage. At the same time it was
14124 * also made to be able to do tree structures. But the price to pay is more
14125 * complexity when it comes to usage. If all you want is a simple list with
14126 * icons and a single label, use the normal @ref List object.
14128 * Genlist has a fairly large API, mostly because it's relatively complex,
14129 * trying to be both expansive, powerful and efficient. First we will begin
14130 * an overview on the theory behind genlist.
14132 * @section Genlist_Item_Class Genlist item classes - creating items
14134 * In order to have the ability to add and delete items on the fly, genlist
14135 * implements a class (callback) system where the application provides a
14136 * structure with information about that type of item (genlist may contain
14137 * multiple different items with different classes, states and styles).
14138 * Genlist will call the functions in this struct (methods) when an item is
14139 * "realized" (i.e., created dynamically, while the user is scrolling the
14140 * grid). All objects will simply be deleted when no longer needed with
14141 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14142 * following members:
14143 * - @c item_style - This is a constant string and simply defines the name
14144 * of the item style. It @b must be specified and the default should be @c
14147 * - @c func - A struct with pointers to functions that will be called when
14148 * an item is going to be actually created. All of them receive a @c data
14149 * parameter that will point to the same data passed to
14150 * elm_genlist_item_append() and related item creation functions, and a @c
14151 * obj parameter that points to the genlist object itself.
14153 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14154 * state_get and @c del. The 3 first functions also receive a @c part
14155 * parameter described below. A brief description of these functions follows:
14157 * - @c label_get - The @c part parameter is the name string of one of the
14158 * existing text parts in the Edje group implementing the item's theme.
14159 * This function @b must return a strdup'()ed string, as the caller will
14160 * free() it when done. See #GenlistItemLabelGetFunc.
14161 * - @c icon_get - The @c part parameter is the name string of one of the
14162 * existing (icon) swallow parts in the Edje group implementing the item's
14163 * theme. It must return @c NULL, when no icon is desired, or a valid
14164 * object handle, otherwise. The object will be deleted by the genlist on
14165 * its deletion or when the item is "unrealized". See
14166 * #GenlistItemIconGetFunc.
14167 * - @c func.state_get - The @c part parameter is the name string of one of
14168 * the state parts in the Edje group implementing the item's theme. Return
14169 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14170 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14171 * and @c "elm" as "emission" and "source" arguments, respectively, when
14172 * the state is true (the default is false), where @c XXX is the name of
14173 * the (state) part. See #GenlistItemStateGetFunc.
14174 * - @c func.del - This is intended for use when genlist items are deleted,
14175 * so any data attached to the item (e.g. its data parameter on creation)
14176 * can be deleted. See #GenlistItemDelFunc.
14178 * available item styles:
14180 * - default_style - The text part is a textblock
14182 * @image html img/widget/genlist/preview-04.png
14183 * @image latex img/widget/genlist/preview-04.eps
14187 * @image html img/widget/genlist/preview-01.png
14188 * @image latex img/widget/genlist/preview-01.eps
14190 * - icon_top_text_bottom
14192 * @image html img/widget/genlist/preview-02.png
14193 * @image latex img/widget/genlist/preview-02.eps
14197 * @image html img/widget/genlist/preview-03.png
14198 * @image latex img/widget/genlist/preview-03.eps
14200 * @section Genlist_Items Structure of items
14202 * An item in a genlist can have 0 or more text labels (they can be regular
14203 * text or textblock Evas objects - that's up to the style to determine), 0
14204 * or more icons (which are simply objects swallowed into the genlist item's
14205 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14206 * behavior left to the user to define. The Edje part names for each of
14207 * these properties will be looked up, in the theme file for the genlist,
14208 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14209 * "states", respectively. For each of those properties, if more than one
14210 * part is provided, they must have names listed separated by spaces in the
14211 * data fields. For the default genlist item theme, we have @b one label
14212 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14213 * "elm.swallow.end") and @b no state parts.
14215 * A genlist item may be at one of several styles. Elementary provides one
14216 * by default - "default", but this can be extended by system or application
14217 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14220 * @section Genlist_Manipulation Editing and Navigating
14222 * Items can be added by several calls. All of them return a @ref
14223 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14224 * They all take a data parameter that is meant to be used for a handle to
14225 * the applications internal data (eg the struct with the original item
14226 * data). The parent parameter is the parent genlist item this belongs to if
14227 * it is a tree or an indexed group, and NULL if there is no parent. The
14228 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14229 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14230 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14231 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14232 * is set then this item is group index item that is displayed at the top
14233 * until the next group comes. The func parameter is a convenience callback
14234 * that is called when the item is selected and the data parameter will be
14235 * the func_data parameter, obj be the genlist object and event_info will be
14236 * the genlist item.
14238 * elm_genlist_item_append() adds an item to the end of the list, or if
14239 * there is a parent, to the end of all the child items of the parent.
14240 * elm_genlist_item_prepend() is the same but adds to the beginning of
14241 * the list or children list. elm_genlist_item_insert_before() inserts at
14242 * item before another item and elm_genlist_item_insert_after() inserts after
14243 * the indicated item.
14245 * The application can clear the list with elm_genlist_clear() which deletes
14246 * all the items in the list and elm_genlist_item_del() will delete a specific
14247 * item. elm_genlist_item_subitems_clear() will clear all items that are
14248 * children of the indicated parent item.
14250 * To help inspect list items you can jump to the item at the top of the list
14251 * with elm_genlist_first_item_get() which will return the item pointer, and
14252 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14253 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14254 * and previous items respectively relative to the indicated item. Using
14255 * these calls you can walk the entire item list/tree. Note that as a tree
14256 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14257 * let you know which item is the parent (and thus know how to skip them if
14260 * @section Genlist_Muti_Selection Multi-selection
14262 * If the application wants multiple items to be able to be selected,
14263 * elm_genlist_multi_select_set() can enable this. If the list is
14264 * single-selection only (the default), then elm_genlist_selected_item_get()
14265 * will return the selected item, if any, or NULL I none is selected. If the
14266 * list is multi-select then elm_genlist_selected_items_get() will return a
14267 * list (that is only valid as long as no items are modified (added, deleted,
14268 * selected or unselected)).
14270 * @section Genlist_Usage_Hints Usage hints
14272 * There are also convenience functions. elm_genlist_item_genlist_get() will
14273 * return the genlist object the item belongs to. elm_genlist_item_show()
14274 * will make the scroller scroll to show that specific item so its visible.
14275 * elm_genlist_item_data_get() returns the data pointer set by the item
14276 * creation functions.
14278 * If an item changes (state of boolean changes, label or icons change),
14279 * then use elm_genlist_item_update() to have genlist update the item with
14280 * the new state. Genlist will re-realize the item thus call the functions
14281 * in the _Elm_Genlist_Item_Class for that item.
14283 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14284 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14285 * to expand/contract an item and get its expanded state, use
14286 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14287 * again to make an item disabled (unable to be selected and appear
14288 * differently) use elm_genlist_item_disabled_set() to set this and
14289 * elm_genlist_item_disabled_get() to get the disabled state.
14291 * In general to indicate how the genlist should expand items horizontally to
14292 * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
14293 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14294 * mode means that if items are too wide to fit, the scroller will scroll
14295 * horizontally. Otherwise items are expanded to fill the width of the
14296 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14297 * to the viewport width and limited to that size. This can be combined with
14298 * a different style that uses edjes' ellipsis feature (cutting text off like
14301 * Items will only call their selection func and callback when first becoming
14302 * selected. Any further clicks will do nothing, unless you enable always
14303 * select with elm_genlist_always_select_mode_set(). This means even if
14304 * selected, every click will make the selected callbacks be called.
14305 * elm_genlist_no_select_mode_set() will turn off the ability to select
14306 * items entirely and they will neither appear selected nor call selected
14307 * callback functions.
14309 * Remember that you can create new styles and add your own theme augmentation
14310 * per application with elm_theme_extension_add(). If you absolutely must
14311 * have a specific style that overrides any theme the user or system sets up
14312 * you can use elm_theme_overlay_add() to add such a file.
14314 * @section Genlist_Implementation Implementation
14316 * Evas tracks every object you create. Every time it processes an event
14317 * (mouse move, down, up etc.) it needs to walk through objects and find out
14318 * what event that affects. Even worse every time it renders display updates,
14319 * in order to just calculate what to re-draw, it needs to walk through many
14320 * many many objects. Thus, the more objects you keep active, the more
14321 * overhead Evas has in just doing its work. It is advisable to keep your
14322 * active objects to the minimum working set you need. Also remember that
14323 * object creation and deletion carries an overhead, so there is a
14324 * middle-ground, which is not easily determined. But don't keep massive lists
14325 * of objects you can't see or use. Genlist does this with list objects. It
14326 * creates and destroys them dynamically as you scroll around. It groups them
14327 * into blocks so it can determine the visibility etc. of a whole block at
14328 * once as opposed to having to walk the whole list. This 2-level list allows
14329 * for very large numbers of items to be in the list (tests have used up to
14330 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14331 * may be different sizes, every item added needs to be calculated as to its
14332 * size and thus this presents a lot of overhead on populating the list, this
14333 * genlist employs a queue. Any item added is queued and spooled off over
14334 * time, actually appearing some time later, so if your list has many members
14335 * you may find it takes a while for them to all appear, with your process
14336 * consuming a lot of CPU while it is busy spooling.
14338 * Genlist also implements a tree structure, but it does so with callbacks to
14339 * the application, with the application filling in tree structures when
14340 * requested (allowing for efficient building of a very deep tree that could
14341 * even be used for file-management). See the above smart signal callbacks for
14344 * @section Genlist_Smart_Events Genlist smart events
14346 * Signals that you can add callbacks for are:
14347 * - @c "activated" - The user has double-clicked or pressed
14348 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14349 * item that was activated.
14350 * - @c "clicked,double" - The user has double-clicked an item. The @c
14351 * event_info parameter is the item that was double-clicked.
14352 * - @c "selected" - This is called when a user has made an item selected.
14353 * The event_info parameter is the genlist item that was selected.
14354 * - @c "unselected" - This is called when a user has made an item
14355 * unselected. The event_info parameter is the genlist item that was
14357 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14358 * called and the item is now meant to be expanded. The event_info
14359 * parameter is the genlist item that was indicated to expand. It is the
14360 * job of this callback to then fill in the child items.
14361 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14362 * called and the item is now meant to be contracted. The event_info
14363 * parameter is the genlist item that was indicated to contract. It is the
14364 * job of this callback to then delete the child items.
14365 * - @c "expand,request" - This is called when a user has indicated they want
14366 * to expand a tree branch item. The callback should decide if the item can
14367 * expand (has any children) and then call elm_genlist_item_expanded_set()
14368 * appropriately to set the state. The event_info parameter is the genlist
14369 * item that was indicated to expand.
14370 * - @c "contract,request" - This is called when a user has indicated they
14371 * want to contract a tree branch item. The callback should decide if the
14372 * item can contract (has any children) and then call
14373 * elm_genlist_item_expanded_set() appropriately to set the state. The
14374 * event_info parameter is the genlist item that was indicated to contract.
14375 * - @c "realized" - This is called when the item in the list is created as a
14376 * real evas object. event_info parameter is the genlist item that was
14377 * created. The object may be deleted at any time, so it is up to the
14378 * caller to not use the object pointer from elm_genlist_item_object_get()
14379 * in a way where it may point to freed objects.
14380 * - @c "unrealized" - This is called just before an item is unrealized.
14381 * After this call icon objects provided will be deleted and the item
14382 * object itself delete or be put into a floating cache.
14383 * - @c "drag,start,up" - This is called when the item in the list has been
14384 * dragged (not scrolled) up.
14385 * - @c "drag,start,down" - This is called when the item in the list has been
14386 * dragged (not scrolled) down.
14387 * - @c "drag,start,left" - This is called when the item in the list has been
14388 * dragged (not scrolled) left.
14389 * - @c "drag,start,right" - This is called when the item in the list has
14390 * been dragged (not scrolled) right.
14391 * - @c "drag,stop" - This is called when the item in the list has stopped
14393 * - @c "drag" - This is called when the item in the list is being dragged.
14394 * - @c "longpressed" - This is called when the item is pressed for a certain
14395 * amount of time. By default it's 1 second.
14396 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14398 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14399 * until the bottom edge.
14400 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14401 * until the left edge.
14402 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14403 * until the right edge.
14404 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14406 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14408 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14410 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14412 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14413 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14414 * multi-touch pinched in.
14415 * - @c "swipe" - This is called when the genlist is swiped.
14417 * @section Genlist_Examples Examples
14419 * Here is a list of examples that use the genlist, trying to show some of
14420 * its capabilities:
14421 * - @ref genlist_example_01
14422 * - @ref genlist_example_02
14423 * - @ref genlist_example_03
14424 * - @ref genlist_example_04
14425 * - @ref genlist_example_05
14429 * @addtogroup Genlist
14434 * @enum _Elm_Genlist_Item_Flags
14435 * @typedef Elm_Genlist_Item_Flags
14437 * Defines if the item is of any special type (has subitems or it's the
14438 * index of a group), or is just a simple item.
14442 typedef enum _Elm_Genlist_Item_Flags
14444 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14445 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14446 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14447 } Elm_Genlist_Item_Flags;
14448 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14449 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14450 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14451 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14452 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14453 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14454 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14455 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14458 * @struct _Elm_Genlist_Item_Class
14460 * Genlist item class definition structs.
14462 * This struct contains the style and fetching functions that will define the
14463 * contents of each item.
14465 * @see @ref Genlist_Item_Class
14467 struct _Elm_Genlist_Item_Class
14469 const char *item_style; /**< style of this class. */
14472 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14473 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14474 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14475 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14476 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14478 const char *mode_item_style;
14482 * Add a new genlist widget to the given parent Elementary
14483 * (container) object
14485 * @param parent The parent object
14486 * @return a new genlist widget handle or @c NULL, on errors
14488 * This function inserts a new genlist widget on the canvas.
14490 * @see elm_genlist_item_append()
14491 * @see elm_genlist_item_del()
14492 * @see elm_genlist_clear()
14496 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14498 * Remove all items from a given genlist widget.
14500 * @param obj The genlist object
14502 * This removes (and deletes) all items in @p obj, leaving it empty.
14504 * @see elm_genlist_item_del(), to remove just one item.
14508 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14510 * Enable or disable multi-selection in the genlist
14512 * @param obj The genlist object
14513 * @param multi Multi-select enable/disable. Default is disabled.
14515 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14516 * the list. This allows more than 1 item to be selected. To retrieve the list
14517 * of selected items, use elm_genlist_selected_items_get().
14519 * @see elm_genlist_selected_items_get()
14520 * @see elm_genlist_multi_select_get()
14524 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14526 * Gets if multi-selection in genlist is enabled or disabled.
14528 * @param obj The genlist object
14529 * @return Multi-select enabled/disabled
14530 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14532 * @see elm_genlist_multi_select_set()
14536 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14538 * This sets the horizontal stretching mode.
14540 * @param obj The genlist object
14541 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14543 * This sets the mode used for sizing items horizontally. Valid modes
14544 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14545 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14546 * the scroller will scroll horizontally. Otherwise items are expanded
14547 * to fill the width of the viewport of the scroller. If it is
14548 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14549 * limited to that size.
14551 * @see elm_genlist_horizontal_mode_get()
14555 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14557 * Gets the horizontal stretching mode.
14559 * @param obj The genlist object
14560 * @return The mode to use
14561 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14563 * @see elm_genlist_horizontal_mode_set()
14567 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14569 * Set the always select mode.
14571 * @param obj The genlist object
14572 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14573 * EINA_FALSE = off). Default is @c EINA_FALSE.
14575 * Items will only call their selection func and callback when first
14576 * becoming selected. Any further clicks will do nothing, unless you
14577 * enable always select with elm_genlist_always_select_mode_set().
14578 * This means that, even if selected, every click will make the selected
14579 * callbacks be called.
14581 * @see elm_genlist_always_select_mode_get()
14585 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14587 * Get the always select mode.
14589 * @param obj The genlist object
14590 * @return The always select mode
14591 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14593 * @see elm_genlist_always_select_mode_set()
14597 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14599 * Enable/disable the no select mode.
14601 * @param obj The genlist object
14602 * @param no_select The no select mode
14603 * (EINA_TRUE = on, EINA_FALSE = off)
14605 * This will turn off the ability to select items entirely and they
14606 * will neither appear selected nor call selected callback functions.
14608 * @see elm_genlist_no_select_mode_get()
14612 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14614 * Gets whether the no select mode is enabled.
14616 * @param obj The genlist object
14617 * @return The no select mode
14618 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14620 * @see elm_genlist_no_select_mode_set()
14624 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14626 * Enable/disable compress mode.
14628 * @param obj The genlist object
14629 * @param compress The compress mode
14630 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14632 * This will enable the compress mode where items are "compressed"
14633 * horizontally to fit the genlist scrollable viewport width. This is
14634 * special for genlist. Do not rely on
14635 * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
14636 * work as genlist needs to handle it specially.
14638 * @see elm_genlist_compress_mode_get()
14642 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14644 * Get whether the compress mode is enabled.
14646 * @param obj The genlist object
14647 * @return The compress mode
14648 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14650 * @see elm_genlist_compress_mode_set()
14654 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14656 * Enable/disable height-for-width mode.
14658 * @param obj The genlist object
14659 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14660 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14662 * With height-for-width mode the item width will be fixed (restricted
14663 * to a minimum of) to the list width when calculating its size in
14664 * order to allow the height to be calculated based on it. This allows,
14665 * for instance, text block to wrap lines if the Edje part is
14666 * configured with "text.min: 0 1".
14668 * @note This mode will make list resize slower as it will have to
14669 * recalculate every item height again whenever the list width
14672 * @note When height-for-width mode is enabled, it also enables
14673 * compress mode (see elm_genlist_compress_mode_set()) and
14674 * disables homogeneous (see elm_genlist_homogeneous_set()).
14678 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14680 * Get whether the height-for-width mode is enabled.
14682 * @param obj The genlist object
14683 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14688 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14690 * Enable/disable horizontal and vertical bouncing effect.
14692 * @param obj The genlist object
14693 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14694 * EINA_FALSE = off). Default is @c EINA_FALSE.
14695 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14696 * EINA_FALSE = off). Default is @c EINA_TRUE.
14698 * This will enable or disable the scroller bouncing effect for the
14699 * genlist. See elm_scroller_bounce_set() for details.
14701 * @see elm_scroller_bounce_set()
14702 * @see elm_genlist_bounce_get()
14706 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14708 * Get whether the horizontal and vertical bouncing effect is enabled.
14710 * @param obj The genlist object
14711 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14713 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14716 * @see elm_genlist_bounce_set()
14720 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14722 * Enable/disable homogenous mode.
14724 * @param obj The genlist object
14725 * @param homogeneous Assume the items within the genlist are of the
14726 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14729 * This will enable the homogeneous mode where items are of the same
14730 * height and width so that genlist may do the lazy-loading at its
14731 * maximum (which increases the performance for scrolling the list). This
14732 * implies 'compressed' mode.
14734 * @see elm_genlist_compress_mode_set()
14735 * @see elm_genlist_homogeneous_get()
14739 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14741 * Get whether the homogenous mode is enabled.
14743 * @param obj The genlist object
14744 * @return Assume the items within the genlist are of the same height
14745 * and width (EINA_TRUE = on, EINA_FALSE = off)
14747 * @see elm_genlist_homogeneous_set()
14751 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14753 * Set the maximum number of items within an item block
14755 * @param obj The genlist object
14756 * @param n Maximum number of items within an item block. Default is 32.
14758 * This will configure the block count to tune to the target with
14759 * particular performance matrix.
14761 * A block of objects will be used to reduce the number of operations due to
14762 * many objects in the screen. It can determine the visibility, or if the
14763 * object has changed, it theme needs to be updated, etc. doing this kind of
14764 * calculation to the entire block, instead of per object.
14766 * The default value for the block count is enough for most lists, so unless
14767 * you know you will have a lot of objects visible in the screen at the same
14768 * time, don't try to change this.
14770 * @see elm_genlist_block_count_get()
14771 * @see @ref Genlist_Implementation
14775 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14777 * Get the maximum number of items within an item block
14779 * @param obj The genlist object
14780 * @return Maximum number of items within an item block
14782 * @see elm_genlist_block_count_set()
14786 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14788 * Set the timeout in seconds for the longpress event.
14790 * @param obj The genlist object
14791 * @param timeout timeout in seconds. Default is 1.
14793 * This option will change how long it takes to send an event "longpressed"
14794 * after the mouse down signal is sent to the list. If this event occurs, no
14795 * "clicked" event will be sent.
14797 * @see elm_genlist_longpress_timeout_set()
14801 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14803 * Get the timeout in seconds for the longpress event.
14805 * @param obj The genlist object
14806 * @return timeout in seconds
14808 * @see elm_genlist_longpress_timeout_get()
14812 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14814 * Append a new item in a given genlist widget.
14816 * @param obj The genlist object
14817 * @param itc The item class for the item
14818 * @param data The item data
14819 * @param parent The parent item, or NULL if none
14820 * @param flags Item flags
14821 * @param func Convenience function called when the item is selected
14822 * @param func_data Data passed to @p func above.
14823 * @return A handle to the item added or @c NULL if not possible
14825 * This adds the given item to the end of the list or the end of
14826 * the children list if the @p parent is given.
14828 * @see elm_genlist_item_prepend()
14829 * @see elm_genlist_item_insert_before()
14830 * @see elm_genlist_item_insert_after()
14831 * @see elm_genlist_item_del()
14835 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);
14837 * Prepend a new item in a given genlist widget.
14839 * @param obj The genlist object
14840 * @param itc The item class for the item
14841 * @param data The item data
14842 * @param parent The parent item, or NULL if none
14843 * @param flags Item flags
14844 * @param func Convenience function called when the item is selected
14845 * @param func_data Data passed to @p func above.
14846 * @return A handle to the item added or NULL if not possible
14848 * This adds an item to the beginning of the list or beginning of the
14849 * children of the parent if given.
14851 * @see elm_genlist_item_append()
14852 * @see elm_genlist_item_insert_before()
14853 * @see elm_genlist_item_insert_after()
14854 * @see elm_genlist_item_del()
14858 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);
14860 * Insert an item before another in a genlist widget
14862 * @param obj The genlist object
14863 * @param itc The item class for the item
14864 * @param data The item data
14865 * @param before The item to place this new one before.
14866 * @param flags Item flags
14867 * @param func Convenience function called when the item is selected
14868 * @param func_data Data passed to @p func above.
14869 * @return A handle to the item added or @c NULL if not possible
14871 * This inserts an item before another in the list. It will be in the
14872 * same tree level or group as the item it is inserted before.
14874 * @see elm_genlist_item_append()
14875 * @see elm_genlist_item_prepend()
14876 * @see elm_genlist_item_insert_after()
14877 * @see elm_genlist_item_del()
14881 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);
14883 * Insert an item after another in a genlist widget
14885 * @param obj The genlist object
14886 * @param itc The item class for the item
14887 * @param data The item data
14888 * @param after The item to place this new one after.
14889 * @param flags Item flags
14890 * @param func Convenience function called when the item is selected
14891 * @param func_data Data passed to @p func above.
14892 * @return A handle to the item added or @c NULL if not possible
14894 * This inserts an item after another in the list. It will be in the
14895 * same tree level or group as the item it is inserted after.
14897 * @see elm_genlist_item_append()
14898 * @see elm_genlist_item_prepend()
14899 * @see elm_genlist_item_insert_before()
14900 * @see elm_genlist_item_del()
14904 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);
14906 * Insert a new item into the sorted genlist object
14908 * @param obj The genlist object
14909 * @param itc The item class for the item
14910 * @param data The item data
14911 * @param parent The parent item, or NULL if none
14912 * @param flags Item flags
14913 * @param comp The function called for the sort
14914 * @param func Convenience function called when item selected
14915 * @param func_data Data passed to @p func above.
14916 * @return A handle to the item added or NULL if not possible
14920 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);
14921 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);
14922 /* operations to retrieve existing items */
14924 * Get the selectd item in the genlist.
14926 * @param obj The genlist object
14927 * @return The selected item, or NULL if none is selected.
14929 * This gets the selected item in the list (if multi-selection is enabled, only
14930 * the item that was first selected in the list is returned - which is not very
14931 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14934 * If no item is selected, NULL is returned.
14936 * @see elm_genlist_selected_items_get()
14940 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14942 * Get a list of selected items in the genlist.
14944 * @param obj The genlist object
14945 * @return The list of selected items, or NULL if none are selected.
14947 * It returns a list of the selected items. This list pointer is only valid so
14948 * long as the selection doesn't change (no items are selected or unselected, or
14949 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14950 * pointers. The order of the items in this list is the order which they were
14951 * selected, i.e. the first item in this list is the first item that was
14952 * selected, and so on.
14954 * @note If not in multi-select mode, consider using function
14955 * elm_genlist_selected_item_get() instead.
14957 * @see elm_genlist_multi_select_set()
14958 * @see elm_genlist_selected_item_get()
14962 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14964 * Get a list of realized items in genlist
14966 * @param obj The genlist object
14967 * @return The list of realized items, nor NULL if none are realized.
14969 * This returns a list of the realized items in the genlist. The list
14970 * contains Elm_Genlist_Item pointers. The list must be freed by the
14971 * caller when done with eina_list_free(). The item pointers in the
14972 * list are only valid so long as those items are not deleted or the
14973 * genlist is not deleted.
14975 * @see elm_genlist_realized_items_update()
14979 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14981 * Get the item that is at the x, y canvas coords.
14983 * @param obj The gelinst object.
14984 * @param x The input x coordinate
14985 * @param y The input y coordinate
14986 * @param posret The position relative to the item returned here
14987 * @return The item at the coordinates or NULL if none
14989 * This returns the item at the given coordinates (which are canvas
14990 * relative, not object-relative). If an item is at that coordinate,
14991 * that item handle is returned, and if @p posret is not NULL, the
14992 * integer pointed to is set to a value of -1, 0 or 1, depending if
14993 * the coordinate is on the upper portion of that item (-1), on the
14994 * middle section (0) or on the lower part (1). If NULL is returned as
14995 * an item (no item found there), then posret may indicate -1 or 1
14996 * based if the coordinate is above or below all items respectively in
15001 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);
15003 * Get the first item in the genlist
15005 * This returns the first item in the list.
15007 * @param obj The genlist object
15008 * @return The first item, or NULL if none
15012 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15014 * Get the last item in the genlist
15016 * This returns the last item in the list.
15018 * @return The last item, or NULL if none
15022 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15024 * Set the scrollbar policy
15026 * @param obj The genlist object
15027 * @param policy_h Horizontal scrollbar policy.
15028 * @param policy_v Vertical scrollbar policy.
15030 * This sets the scrollbar visibility policy for the given genlist
15031 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15032 * made visible if it is needed, and otherwise kept hidden.
15033 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15034 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15035 * respectively for the horizontal and vertical scrollbars. Default is
15036 * #ELM_SMART_SCROLLER_POLICY_AUTO
15038 * @see elm_genlist_scroller_policy_get()
15042 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15044 * Get the scrollbar policy
15046 * @param obj The genlist object
15047 * @param policy_h Pointer to store the horizontal scrollbar policy.
15048 * @param policy_v Pointer to store the vertical scrollbar policy.
15050 * @see elm_genlist_scroller_policy_set()
15054 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);
15056 * Get the @b next item in a genlist widget's internal list of items,
15057 * given a handle to one of those items.
15059 * @param item The genlist item to fetch next from
15060 * @return The item after @p item, or @c NULL if there's none (and
15063 * This returns the item placed after the @p item, on the container
15066 * @see elm_genlist_item_prev_get()
15070 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15072 * Get the @b previous item in a genlist widget's internal list of items,
15073 * given a handle to one of those items.
15075 * @param item The genlist item to fetch previous from
15076 * @return The item before @p item, or @c NULL if there's none (and
15079 * This returns the item placed before the @p item, on the container
15082 * @see elm_genlist_item_next_get()
15086 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15088 * Get the genlist object's handle which contains a given genlist
15091 * @param item The item to fetch the container from
15092 * @return The genlist (parent) object
15094 * This returns the genlist object itself that an item belongs to.
15098 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15100 * Get the parent item of the given item
15102 * @param it The item
15103 * @return The parent of the item or @c NULL if it has no parent.
15105 * This returns the item that was specified as parent of the item @p it on
15106 * elm_genlist_item_append() and insertion related functions.
15110 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15112 * Remove all sub-items (children) of the given item
15114 * @param it The item
15116 * This removes all items that are children (and their descendants) of the
15117 * given item @p it.
15119 * @see elm_genlist_clear()
15120 * @see elm_genlist_item_del()
15124 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15126 * Set whether a given genlist item is selected or not
15128 * @param it The item
15129 * @param selected Use @c EINA_TRUE, to make it selected, @c
15130 * EINA_FALSE to make it unselected
15132 * This sets the selected state of an item. If multi selection is
15133 * not enabled on the containing genlist and @p selected is @c
15134 * EINA_TRUE, any other previously selected items will get
15135 * unselected in favor of this new one.
15137 * @see elm_genlist_item_selected_get()
15141 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15143 * Get whether a given genlist item is selected or not
15145 * @param it The item
15146 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15148 * @see elm_genlist_item_selected_set() for more details
15152 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15154 * Sets the expanded state of an item.
15156 * @param it The item
15157 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15159 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15162 * The theme will respond to this change visually, and a signal "expanded" or
15163 * "contracted" will be sent from the genlist with a pointer to the item that
15164 * has been expanded/contracted.
15166 * Calling this function won't show or hide any child of this item (if it is
15167 * a parent). You must manually delete and create them on the callbacks fo
15168 * the "expanded" or "contracted" signals.
15170 * @see elm_genlist_item_expanded_get()
15174 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15176 * Get the expanded state of an item
15178 * @param it The item
15179 * @return The expanded state
15181 * This gets the expanded state of an item.
15183 * @see elm_genlist_item_expanded_set()
15187 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15189 * Get the depth of expanded item
15191 * @param it The genlist item object
15192 * @return The depth of expanded item
15196 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15198 * Set whether a given genlist item is disabled or not.
15200 * @param it The item
15201 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15202 * to enable it back.
15204 * A disabled item cannot be selected or unselected. It will also
15205 * change its appearance, to signal the user it's disabled.
15207 * @see elm_genlist_item_disabled_get()
15211 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15213 * Get whether a given genlist item is disabled or not.
15215 * @param it The item
15216 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15219 * @see elm_genlist_item_disabled_set() for more details
15223 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15225 * Sets the display only state of an item.
15227 * @param it The item
15228 * @param display_only @c EINA_TRUE if the item is display only, @c
15229 * EINA_FALSE otherwise.
15231 * A display only item cannot be selected or unselected. It is for
15232 * display only and not selecting or otherwise clicking, dragging
15233 * etc. by the user, thus finger size rules will not be applied to
15236 * It's good to set group index items to display only state.
15238 * @see elm_genlist_item_display_only_get()
15242 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15244 * Get the display only state of an item
15246 * @param it The item
15247 * @return @c EINA_TRUE if the item is display only, @c
15248 * EINA_FALSE otherwise.
15250 * @see elm_genlist_item_display_only_set()
15254 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15256 * Show the portion of a genlist's internal list containing a given
15257 * item, immediately.
15259 * @param it The item to display
15261 * This causes genlist to jump to the given item @p it and show it (by
15262 * immediately scrolling to that position), if it is not fully visible.
15264 * @see elm_genlist_item_bring_in()
15265 * @see elm_genlist_item_top_show()
15266 * @see elm_genlist_item_middle_show()
15270 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15272 * Animatedly bring in, to the visible are of a genlist, a given
15275 * @param it The item to display
15277 * This causes genlist to jump to the given item @p it and show it (by
15278 * animatedly scrolling), if it is not fully visible. This may use animation
15279 * to do so and take a period of time
15281 * @see elm_genlist_item_show()
15282 * @see elm_genlist_item_top_bring_in()
15283 * @see elm_genlist_item_middle_bring_in()
15287 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15289 * Show the portion of a genlist's internal list containing a given
15290 * item, immediately.
15292 * @param it The item to display
15294 * This causes genlist to jump to the given item @p it and show it (by
15295 * immediately scrolling to that position), if it is not fully visible.
15297 * The item will be positioned at the top of the genlist viewport.
15299 * @see elm_genlist_item_show()
15300 * @see elm_genlist_item_top_bring_in()
15304 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15306 * Animatedly bring in, to the visible are of a genlist, a given
15309 * @param it The item
15311 * This causes genlist to jump to the given item @p it and show it (by
15312 * animatedly scrolling), if it is not fully visible. This may use animation
15313 * to do so and take a period of time
15315 * The item will be positioned at the top of the genlist viewport.
15317 * @see elm_genlist_item_bring_in()
15318 * @see elm_genlist_item_top_show()
15322 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15324 * Show the portion of a genlist's internal list containing a given
15325 * item, immediately.
15327 * @param it The item to display
15329 * This causes genlist to jump to the given item @p it and show it (by
15330 * immediately scrolling to that position), if it is not fully visible.
15332 * The item will be positioned at the middle of the genlist viewport.
15334 * @see elm_genlist_item_show()
15335 * @see elm_genlist_item_middle_bring_in()
15339 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15341 * Animatedly bring in, to the visible are of a genlist, a given
15344 * @param it The item
15346 * This causes genlist to jump to the given item @p it and show it (by
15347 * animatedly scrolling), if it is not fully visible. This may use animation
15348 * to do so and take a period of time
15350 * The item will be positioned at the middle of the genlist viewport.
15352 * @see elm_genlist_item_bring_in()
15353 * @see elm_genlist_item_middle_show()
15357 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15359 * Remove a genlist item from the its parent, deleting it.
15361 * @param item The item to be removed.
15362 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15364 * @see elm_genlist_clear(), to remove all items in a genlist at
15369 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15371 * Return the data associated to a given genlist item
15373 * @param item The genlist item.
15374 * @return the data associated to this item.
15376 * This returns the @c data value passed on the
15377 * elm_genlist_item_append() and related item addition calls.
15379 * @see elm_genlist_item_append()
15380 * @see elm_genlist_item_data_set()
15384 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15386 * Set the data associated to a given genlist item
15388 * @param item The genlist item
15389 * @param data The new data pointer to set on it
15391 * This @b overrides the @c data value passed on the
15392 * elm_genlist_item_append() and related item addition calls. This
15393 * function @b won't call elm_genlist_item_update() automatically,
15394 * so you'd issue it afterwards if you want to hove the item
15395 * updated to reflect the that new data.
15397 * @see elm_genlist_item_data_get()
15401 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15403 * Tells genlist to "orphan" icons fetchs by the item class
15405 * @param it The item
15407 * This instructs genlist to release references to icons in the item,
15408 * meaning that they will no longer be managed by genlist and are
15409 * floating "orphans" that can be re-used elsewhere if the user wants
15414 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15416 * Get the real Evas object created to implement the view of a
15417 * given genlist item
15419 * @param item The genlist item.
15420 * @return the Evas object implementing this item's view.
15422 * This returns the actual Evas object used to implement the
15423 * specified genlist item's view. This may be @c NULL, as it may
15424 * not have been created or may have been deleted, at any time, by
15425 * the genlist. <b>Do not modify this object</b> (move, resize,
15426 * show, hide, etc.), as the genlist is controlling it. This
15427 * function is for querying, emitting custom signals or hooking
15428 * lower level callbacks for events on that object. Do not delete
15429 * this object under any circumstances.
15431 * @see elm_genlist_item_data_get()
15435 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15437 * Update the contents of an item
15439 * @param it The item
15441 * This updates an item by calling all the item class functions again
15442 * to get the icons, labels and states. Use this when the original
15443 * item data has changed and the changes are desired to be reflected.
15445 * Use elm_genlist_realized_items_update() to update all already realized
15448 * @see elm_genlist_realized_items_update()
15452 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15454 * Update the item class of an item
15456 * @param it The item
15457 * @param itc The item class for the item
15459 * This sets another class fo the item, changing the way that it is
15460 * displayed. After changing the item class, elm_genlist_item_update() is
15461 * called on the item @p it.
15465 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15466 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15468 * Set the text to be shown in a given genlist item's tooltips.
15470 * @param item The genlist item
15471 * @param text The text to set in the content
15473 * This call will setup the text to be used as tooltip to that item
15474 * (analogous to elm_object_tooltip_text_set(), but being item
15475 * tooltips with higher precedence than object tooltips). It can
15476 * have only one tooltip at a time, so any previous tooltip data
15477 * will get removed.
15479 * In order to set an icon or something else as a tooltip, look at
15480 * elm_genlist_item_tooltip_content_cb_set().
15484 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15486 * Set the content to be shown in a given genlist item's tooltips
15488 * @param item The genlist item.
15489 * @param func The function returning the tooltip contents.
15490 * @param data What to provide to @a func as callback data/context.
15491 * @param del_cb Called when data is not needed anymore, either when
15492 * another callback replaces @p func, the tooltip is unset with
15493 * elm_genlist_item_tooltip_unset() or the owner @p item
15494 * dies. This callback receives as its first parameter the
15495 * given @p data, being @c event_info the item handle.
15497 * This call will setup the tooltip's contents to @p item
15498 * (analogous to elm_object_tooltip_content_cb_set(), but being
15499 * item tooltips with higher precedence than object tooltips). It
15500 * can have only one tooltip at a time, so any previous tooltip
15501 * content will get removed. @p func (with @p data) will be called
15502 * every time Elementary needs to show the tooltip and it should
15503 * return a valid Evas object, which will be fully managed by the
15504 * tooltip system, getting deleted when the tooltip is gone.
15506 * In order to set just a text as a tooltip, look at
15507 * elm_genlist_item_tooltip_text_set().
15511 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);
15513 * Unset a tooltip from a given genlist item
15515 * @param item genlist item to remove a previously set tooltip from.
15517 * This call removes any tooltip set on @p item. The callback
15518 * provided as @c del_cb to
15519 * elm_genlist_item_tooltip_content_cb_set() will be called to
15520 * notify it is not used anymore (and have resources cleaned, if
15523 * @see elm_genlist_item_tooltip_content_cb_set()
15527 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15529 * Set a different @b style for a given genlist item's tooltip.
15531 * @param item genlist item with tooltip set
15532 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15533 * "default", @c "transparent", etc)
15535 * Tooltips can have <b>alternate styles</b> to be displayed on,
15536 * which are defined by the theme set on Elementary. This function
15537 * works analogously as elm_object_tooltip_style_set(), but here
15538 * applied only to genlist item objects. The default style for
15539 * tooltips is @c "default".
15541 * @note before you set a style you should define a tooltip with
15542 * elm_genlist_item_tooltip_content_cb_set() or
15543 * elm_genlist_item_tooltip_text_set()
15545 * @see elm_genlist_item_tooltip_style_get()
15549 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15551 * Get the style set a given genlist item's tooltip.
15553 * @param item genlist item with tooltip already set on.
15554 * @return style the theme style in use, which defaults to
15555 * "default". If the object does not have a tooltip set,
15556 * then @c NULL is returned.
15558 * @see elm_genlist_item_tooltip_style_set() for more details
15562 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15564 * @brief Disable size restrictions on an object's tooltip
15565 * @param item The tooltip's anchor object
15566 * @param disable If EINA_TRUE, size restrictions are disabled
15567 * @return EINA_FALSE on failure, EINA_TRUE on success
15569 * This function allows a tooltip to expand beyond its parant window's canvas.
15570 * It will instead be limited only by the size of the display.
15572 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15574 * @brief Retrieve size restriction state of an object's tooltip
15575 * @param item The tooltip's anchor object
15576 * @return If EINA_TRUE, size restrictions are disabled
15578 * This function returns whether a tooltip is allowed to expand beyond
15579 * its parant window's canvas.
15580 * It will instead be limited only by the size of the display.
15582 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15584 * Set the type of mouse pointer/cursor decoration to be shown,
15585 * when the mouse pointer is over the given genlist widget item
15587 * @param item genlist item to customize cursor on
15588 * @param cursor the cursor type's name
15590 * This function works analogously as elm_object_cursor_set(), but
15591 * here the cursor's changing area is restricted to the item's
15592 * area, and not the whole widget's. Note that that item cursors
15593 * have precedence over widget cursors, so that a mouse over @p
15594 * item will always show cursor @p type.
15596 * If this function is called twice for an object, a previously set
15597 * cursor will be unset on the second call.
15599 * @see elm_object_cursor_set()
15600 * @see elm_genlist_item_cursor_get()
15601 * @see elm_genlist_item_cursor_unset()
15605 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15607 * Get the type of mouse pointer/cursor decoration set to be shown,
15608 * when the mouse pointer is over the given genlist widget item
15610 * @param item genlist item with custom cursor set
15611 * @return the cursor type's name or @c NULL, if no custom cursors
15612 * were set to @p item (and on errors)
15614 * @see elm_object_cursor_get()
15615 * @see elm_genlist_item_cursor_set() for more details
15616 * @see elm_genlist_item_cursor_unset()
15620 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15622 * Unset any custom mouse pointer/cursor decoration set to be
15623 * shown, when the mouse pointer is over the given genlist widget
15624 * item, thus making it show the @b default cursor again.
15626 * @param item a genlist item
15628 * Use this call to undo any custom settings on this item's cursor
15629 * decoration, bringing it back to defaults (no custom style set).
15631 * @see elm_object_cursor_unset()
15632 * @see elm_genlist_item_cursor_set() for more details
15636 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15638 * Set a different @b style for a given custom cursor set for a
15641 * @param item genlist item with custom cursor set
15642 * @param style the <b>theme style</b> to use (e.g. @c "default",
15643 * @c "transparent", etc)
15645 * This function only makes sense when one is using custom mouse
15646 * cursor decorations <b>defined in a theme file</b> , which can
15647 * have, given a cursor name/type, <b>alternate styles</b> on
15648 * it. It works analogously as elm_object_cursor_style_set(), but
15649 * here applied only to genlist item objects.
15651 * @warning Before you set a cursor style you should have defined a
15652 * custom cursor previously on the item, with
15653 * elm_genlist_item_cursor_set()
15655 * @see elm_genlist_item_cursor_engine_only_set()
15656 * @see elm_genlist_item_cursor_style_get()
15660 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15662 * Get the current @b style set for a given genlist item's custom
15665 * @param item genlist item with custom cursor set.
15666 * @return style the cursor style in use. If the object does not
15667 * have a cursor set, then @c NULL is returned.
15669 * @see elm_genlist_item_cursor_style_set() for more details
15673 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15675 * Set if the (custom) cursor for a given genlist item should be
15676 * searched in its theme, also, or should only rely on the
15677 * rendering engine.
15679 * @param item item with custom (custom) cursor already set on
15680 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15681 * only on those provided by the rendering engine, @c EINA_FALSE to
15682 * have them searched on the widget's theme, as well.
15684 * @note This call is of use only if you've set a custom cursor
15685 * for genlist items, with elm_genlist_item_cursor_set().
15687 * @note By default, cursors will only be looked for between those
15688 * provided by the rendering engine.
15692 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15694 * Get if the (custom) cursor for a given genlist item is being
15695 * searched in its theme, also, or is only relying on the rendering
15698 * @param item a genlist item
15699 * @return @c EINA_TRUE, if cursors are being looked for only on
15700 * those provided by the rendering engine, @c EINA_FALSE if they
15701 * are being searched on the widget's theme, as well.
15703 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15707 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15709 * Update the contents of all realized items.
15711 * @param obj The genlist object.
15713 * This updates all realized items by calling all the item class functions again
15714 * to get the icons, labels and states. Use this when the original
15715 * item data has changed and the changes are desired to be reflected.
15717 * To update just one item, use elm_genlist_item_update().
15719 * @see elm_genlist_realized_items_get()
15720 * @see elm_genlist_item_update()
15724 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15725 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15726 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15727 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15728 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15729 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15736 * @defgroup Check Check
15738 * @image html img/widget/check/preview-00.png
15739 * @image latex img/widget/check/preview-00.eps
15740 * @image html img/widget/check/preview-01.png
15741 * @image latex img/widget/check/preview-01.eps
15742 * @image html img/widget/check/preview-02.png
15743 * @image latex img/widget/check/preview-02.eps
15745 * @brief The check widget allows for toggling a value between true and
15748 * Check objects are a lot like radio objects in layout and functionality
15749 * except they do not work as a group, but independently and only toggle the
15750 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15751 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15752 * returns the current state. For convenience, like the radio objects, you
15753 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15754 * for it to modify.
15756 * Signals that you can add callbacks for are:
15757 * "changed" - This is called whenever the user changes the state of one of
15758 * the check object(event_info is NULL).
15760 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15764 * @brief Add a new Check object
15766 * @param parent The parent object
15767 * @return The new object or NULL if it cannot be created
15769 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15771 * @brief Set the text label of the check object
15773 * @param obj The check object
15774 * @param label The text label string in UTF-8
15776 * @deprecated use elm_object_text_set() instead.
15778 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15780 * @brief Get the text label of the check object
15782 * @param obj The check object
15783 * @return The text label string in UTF-8
15785 * @deprecated use elm_object_text_get() instead.
15787 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15789 * @brief Set the icon object of the check object
15791 * @param obj The check object
15792 * @param icon The icon object
15794 * Once the icon object is set, a previously set one will be deleted.
15795 * If you want to keep that old content object, use the
15796 * elm_check_icon_unset() function.
15798 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15800 * @brief Get the icon object of the check object
15802 * @param obj The check object
15803 * @return The icon object
15805 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15807 * @brief Unset the icon used for the check object
15809 * @param obj The check object
15810 * @return The icon object that was being used
15812 * Unparent and return the icon object which was set for this widget.
15814 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15816 * @brief Set the on/off state of the check object
15818 * @param obj The check object
15819 * @param state The state to use (1 == on, 0 == off)
15821 * This sets the state of the check. If set
15822 * with elm_check_state_pointer_set() the state of that variable is also
15823 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15825 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15827 * @brief Get the state of the check object
15829 * @param obj The check object
15830 * @return The boolean state
15832 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15834 * @brief Set a convenience pointer to a boolean to change
15836 * @param obj The check object
15837 * @param statep Pointer to the boolean to modify
15839 * This sets a pointer to a boolean, that, in addition to the check objects
15840 * state will also be modified directly. To stop setting the object pointed
15841 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15842 * then when this is called, the check objects state will also be modified to
15843 * reflect the value of the boolean @p statep points to, just like calling
15844 * elm_check_state_set().
15846 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15852 * @defgroup Radio Radio
15854 * @image html img/widget/radio/preview-00.png
15855 * @image latex img/widget/radio/preview-00.eps
15857 * @brief Radio is a widget that allows for 1 or more options to be displayed
15858 * and have the user choose only 1 of them.
15860 * A radio object contains an indicator, an optional Label and an optional
15861 * icon object. While it's possible to have a group of only one radio they,
15862 * are normally used in groups of 2 or more. To add a radio to a group use
15863 * elm_radio_group_add(). The radio object(s) will select from one of a set
15864 * of integer values, so any value they are configuring needs to be mapped to
15865 * a set of integers. To configure what value that radio object represents,
15866 * use elm_radio_state_value_set() to set the integer it represents. To set
15867 * the value the whole group(which one is currently selected) is to indicate
15868 * use elm_radio_value_set() on any group member, and to get the groups value
15869 * use elm_radio_value_get(). For convenience the radio objects are also able
15870 * to directly set an integer(int) to the value that is selected. To specify
15871 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15872 * The radio objects will modify this directly. That implies the pointer must
15873 * point to valid memory for as long as the radio objects exist.
15875 * Signals that you can add callbacks for are:
15876 * @li changed - This is called whenever the user changes the state of one of
15877 * the radio objects within the group of radio objects that work together.
15879 * @ref tutorial_radio show most of this API in action.
15883 * @brief Add a new radio to the parent
15885 * @param parent The parent object
15886 * @return The new object or NULL if it cannot be created
15888 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15890 * @brief Set the text label of the radio object
15892 * @param obj The radio object
15893 * @param label The text label string in UTF-8
15895 * @deprecated use elm_object_text_set() instead.
15897 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15899 * @brief Get the text label of the radio object
15901 * @param obj The radio object
15902 * @return The text label string in UTF-8
15904 * @deprecated use elm_object_text_set() instead.
15906 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15908 * @brief Set the icon object of the radio object
15910 * @param obj The radio object
15911 * @param icon The icon object
15913 * Once the icon object is set, a previously set one will be deleted. If you
15914 * want to keep that old content object, use the elm_radio_icon_unset()
15917 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15919 * @brief Get the icon object of the radio object
15921 * @param obj The radio object
15922 * @return The icon object
15924 * @see elm_radio_icon_set()
15926 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15928 * @brief Unset the icon used for the radio object
15930 * @param obj The radio object
15931 * @return The icon object that was being used
15933 * Unparent and return the icon object which was set for this widget.
15935 * @see elm_radio_icon_set()
15937 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15939 * @brief Add this radio to a group of other radio objects
15941 * @param obj The radio object
15942 * @param group Any object whose group the @p obj is to join.
15944 * Radio objects work in groups. Each member should have a different integer
15945 * value assigned. In order to have them work as a group, they need to know
15946 * about each other. This adds the given radio object to the group of which
15947 * the group object indicated is a member.
15949 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
15951 * @brief Set the integer value that this radio object represents
15953 * @param obj The radio object
15954 * @param value The value to use if this radio object is selected
15956 * This sets the value of the radio.
15958 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15960 * @brief Get the integer value that this radio object represents
15962 * @param obj The radio object
15963 * @return The value used if this radio object is selected
15965 * This gets the value of the radio.
15967 * @see elm_radio_value_set()
15969 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15971 * @brief Set the value of the radio.
15973 * @param obj The radio object
15974 * @param value The value to use for the group
15976 * This sets the value of the radio group and will also set the value if
15977 * pointed to, to the value supplied, but will not call any callbacks.
15979 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15981 * @brief Get the state of the radio object
15983 * @param obj The radio object
15984 * @return The integer state
15986 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15988 * @brief Set a convenience pointer to a integer to change
15990 * @param obj The radio object
15991 * @param valuep Pointer to the integer to modify
15993 * This sets a pointer to a integer, that, in addition to the radio objects
15994 * state will also be modified directly. To stop setting the object pointed
15995 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
15996 * when this is called, the radio objects state will also be modified to
15997 * reflect the value of the integer valuep points to, just like calling
15998 * elm_radio_value_set().
16000 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16006 * @defgroup Pager Pager
16008 * @image html img/widget/pager/preview-00.png
16009 * @image latex img/widget/pager/preview-00.eps
16011 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16013 * The flipping between “pages” of objects is animated. All content in pager
16014 * is kept in a stack, the last content to be added will be on the top of the
16015 * stack(be visible).
16017 * Objects can be pushed or popped from the stack or deleted as normal.
16018 * Pushes and pops will animate (and a pop will delete the object once the
16019 * animation is finished). Any object already in the pager can be promoted to
16020 * the top(from its current stacking position) through the use of
16021 * elm_pager_content_promote(). Objects are pushed to the top with
16022 * elm_pager_content_push() and when the top item is no longer wanted, simply
16023 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16024 * object is no longer needed and is not the top item, just delete it as
16025 * normal. You can query which objects are the top and bottom with
16026 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16028 * Signals that you can add callbacks for are:
16029 * "hide,finished" - when the previous page is hided
16031 * This widget has the following styles available:
16034 * @li fade_translucide
16035 * @li fade_invisible
16036 * @note This styles affect only the flipping animations, the appearance when
16037 * not animating is unaffected by styles.
16039 * @ref tutorial_pager gives a good overview of the usage of the API.
16043 * Add a new pager to the parent
16045 * @param parent The parent object
16046 * @return The new object or NULL if it cannot be created
16050 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16052 * @brief Push an object to the top of the pager stack (and show it).
16054 * @param obj The pager object
16055 * @param content The object to push
16057 * The object pushed becomes a child of the pager, it will be controlled and
16058 * deleted when the pager is deleted.
16060 * @note If the content is already in the stack use
16061 * elm_pager_content_promote().
16062 * @warning Using this function on @p content already in the stack results in
16063 * undefined behavior.
16065 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16067 * @brief Pop the object that is on top of the stack
16069 * @param obj The pager object
16071 * This pops the object that is on the top(visible) of the pager, makes it
16072 * disappear, then deletes the object. The object that was underneath it on
16073 * the stack will become visible.
16075 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16077 * @brief Moves an object already in the pager stack to the top of the stack.
16079 * @param obj The pager object
16080 * @param content The object to promote
16082 * This will take the @p content and move it to the top of the stack as
16083 * if it had been pushed there.
16085 * @note If the content isn't already in the stack use
16086 * elm_pager_content_push().
16087 * @warning Using this function on @p content not already in the stack
16088 * results in undefined behavior.
16090 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16092 * @brief Return the object at the bottom of the pager stack
16094 * @param obj The pager object
16095 * @return The bottom object or NULL if none
16097 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16099 * @brief Return the object at the top of the pager stack
16101 * @param obj The pager object
16102 * @return The top object or NULL if none
16104 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16110 * @defgroup Slideshow Slideshow
16112 * @image html img/widget/slideshow/preview-00.png
16113 * @image latex img/widget/slideshow/preview-00.eps
16115 * This widget, as the name indicates, is a pre-made image
16116 * slideshow panel, with API functions acting on (child) image
16117 * items presentation. Between those actions, are:
16118 * - advance to next/previous image
16119 * - select the style of image transition animation
16120 * - set the exhibition time for each image
16121 * - start/stop the slideshow
16123 * The transition animations are defined in the widget's theme,
16124 * consequently new animations can be added without having to
16125 * update the widget's code.
16127 * @section Slideshow_Items Slideshow items
16129 * For slideshow items, just like for @ref Genlist "genlist" ones,
16130 * the user defines a @b classes, specifying functions that will be
16131 * called on the item's creation and deletion times.
16133 * The #Elm_Slideshow_Item_Class structure contains the following
16136 * - @c func.get - When an item is displayed, this function is
16137 * called, and it's where one should create the item object, de
16138 * facto. For example, the object can be a pure Evas image object
16139 * or an Elementary @ref Photocam "photocam" widget. See
16140 * #SlideshowItemGetFunc.
16141 * - @c func.del - When an item is no more displayed, this function
16142 * is called, where the user must delete any data associated to
16143 * the item. See #SlideshowItemDelFunc.
16145 * @section Slideshow_Caching Slideshow caching
16147 * The slideshow provides facilities to have items adjacent to the
16148 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16149 * you, so that the system does not have to decode image data
16150 * anymore at the time it has to actually switch images on its
16151 * viewport. The user is able to set the numbers of items to be
16152 * cached @b before and @b after the current item, in the widget's
16155 * Smart events one can add callbacks for are:
16157 * - @c "changed" - when the slideshow switches its view to a new
16160 * List of examples for the slideshow widget:
16161 * @li @ref slideshow_example
16165 * @addtogroup Slideshow
16169 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16170 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16171 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16172 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16173 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16176 * @struct _Elm_Slideshow_Item_Class
16178 * Slideshow item class definition. See @ref Slideshow_Items for
16181 struct _Elm_Slideshow_Item_Class
16183 struct _Elm_Slideshow_Item_Class_Func
16185 SlideshowItemGetFunc get;
16186 SlideshowItemDelFunc del;
16188 }; /**< #Elm_Slideshow_Item_Class member definitions */
16191 * Add a new slideshow widget to the given parent Elementary
16192 * (container) object
16194 * @param parent The parent object
16195 * @return A new slideshow widget handle or @c NULL, on errors
16197 * This function inserts a new slideshow widget on the canvas.
16199 * @ingroup Slideshow
16201 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16204 * Add (append) a new item in a given slideshow widget.
16206 * @param obj The slideshow object
16207 * @param itc The item class for the item
16208 * @param data The item's data
16209 * @return A handle to the item added or @c NULL, on errors
16211 * Add a new item to @p obj's internal list of items, appending it.
16212 * The item's class must contain the function really fetching the
16213 * image object to show for this item, which could be an Evas image
16214 * object or an Elementary photo, for example. The @p data
16215 * parameter is going to be passed to both class functions of the
16218 * @see #Elm_Slideshow_Item_Class
16219 * @see elm_slideshow_item_sorted_insert()
16221 * @ingroup Slideshow
16223 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16226 * Insert a new item into the given slideshow widget, using the @p func
16227 * function to sort items (by item handles).
16229 * @param obj The slideshow object
16230 * @param itc The item class for the item
16231 * @param data The item's data
16232 * @param func The comparing function to be used to sort slideshow
16233 * items <b>by #Elm_Slideshow_Item item handles</b>
16234 * @return Returns The slideshow item handle, on success, or
16235 * @c NULL, on errors
16237 * Add a new item to @p obj's internal list of items, in a position
16238 * determined by the @p func comparing function. The item's class
16239 * must contain the function really fetching the image object to
16240 * show for this item, which could be an Evas image object or an
16241 * Elementary photo, for example. The @p data parameter is going to
16242 * be passed to both class functions of the item.
16244 * @see #Elm_Slideshow_Item_Class
16245 * @see elm_slideshow_item_add()
16247 * @ingroup Slideshow
16249 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);
16252 * Display a given slideshow widget's item, programmatically.
16254 * @param obj The slideshow object
16255 * @param item The item to display on @p obj's viewport
16257 * The change between the current item and @p item will use the
16258 * transition @p obj is set to use (@see
16259 * elm_slideshow_transition_set()).
16261 * @ingroup Slideshow
16263 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16266 * Slide to the @b next item, in a given slideshow widget
16268 * @param obj The slideshow object
16270 * The sliding animation @p obj is set to use will be the
16271 * transition effect used, after this call is issued.
16273 * @note If the end of the slideshow's internal list of items is
16274 * reached, it'll wrap around to the list's beginning, again.
16276 * @ingroup Slideshow
16278 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16281 * Slide to the @b previous item, in a given slideshow widget
16283 * @param obj The slideshow object
16285 * The sliding animation @p obj is set to use will be the
16286 * transition effect used, after this call is issued.
16288 * @note If the beginning of the slideshow's internal list of items
16289 * is reached, it'll wrap around to the list's end, again.
16291 * @ingroup Slideshow
16293 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16296 * Returns the list of sliding transition/effect names available, for a
16297 * given slideshow widget.
16299 * @param obj The slideshow object
16300 * @return The list of transitions (list of @b stringshared strings
16303 * The transitions, which come from @p obj's theme, must be an EDC
16304 * data item named @c "transitions" on the theme file, with (prefix)
16305 * names of EDC programs actually implementing them.
16307 * The available transitions for slideshows on the default theme are:
16308 * - @c "fade" - the current item fades out, while the new one
16309 * fades in to the slideshow's viewport.
16310 * - @c "black_fade" - the current item fades to black, and just
16311 * then, the new item will fade in.
16312 * - @c "horizontal" - the current item slides horizontally, until
16313 * it gets out of the slideshow's viewport, while the new item
16314 * comes from the left to take its place.
16315 * - @c "vertical" - the current item slides vertically, until it
16316 * gets out of the slideshow's viewport, while the new item comes
16317 * from the bottom to take its place.
16318 * - @c "square" - the new item starts to appear from the middle of
16319 * the current one, but with a tiny size, growing until its
16320 * target (full) size and covering the old one.
16322 * @warning The stringshared strings get no new references
16323 * exclusive to the user grabbing the list, here, so if you'd like
16324 * to use them out of this call's context, you'd better @c
16325 * eina_stringshare_ref() them.
16327 * @see elm_slideshow_transition_set()
16329 * @ingroup Slideshow
16331 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16334 * Set the current slide transition/effect in use for a given
16337 * @param obj The slideshow object
16338 * @param transition The new transition's name string
16340 * If @p transition is implemented in @p obj's theme (i.e., is
16341 * contained in the list returned by
16342 * elm_slideshow_transitions_get()), this new sliding effect will
16343 * be used on the widget.
16345 * @see elm_slideshow_transitions_get() for more details
16347 * @ingroup Slideshow
16349 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16352 * Get the current slide transition/effect in use for a given
16355 * @param obj The slideshow object
16356 * @return The current transition's name
16358 * @see elm_slideshow_transition_set() for more details
16360 * @ingroup Slideshow
16362 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16365 * Set the interval between each image transition on a given
16366 * slideshow widget, <b>and start the slideshow, itself</b>
16368 * @param obj The slideshow object
16369 * @param timeout The new displaying timeout for images
16371 * After this call, the slideshow widget will start cycling its
16372 * view, sequentially and automatically, with the images of the
16373 * items it has. The time between each new image displayed is going
16374 * to be @p timeout, in @b seconds. If a different timeout was set
16375 * previously and an slideshow was in progress, it will continue
16376 * with the new time between transitions, after this call.
16378 * @note A value less than or equal to 0 on @p timeout will disable
16379 * the widget's internal timer, thus halting any slideshow which
16380 * could be happening on @p obj.
16382 * @see elm_slideshow_timeout_get()
16384 * @ingroup Slideshow
16386 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16389 * Get the interval set for image transitions on a given slideshow
16392 * @param obj The slideshow object
16393 * @return Returns the timeout set on it
16395 * @see elm_slideshow_timeout_set() for more details
16397 * @ingroup Slideshow
16399 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16402 * Set if, after a slideshow is started, for a given slideshow
16403 * widget, its items should be displayed cyclically or not.
16405 * @param obj The slideshow object
16406 * @param loop Use @c EINA_TRUE to make it cycle through items or
16407 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16410 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16411 * ignore what is set by this functions, i.e., they'll @b always
16412 * cycle through items. This affects only the "automatic"
16413 * slideshow, as set by elm_slideshow_timeout_set().
16415 * @see elm_slideshow_loop_get()
16417 * @ingroup Slideshow
16419 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16422 * Get if, after a slideshow is started, for a given slideshow
16423 * widget, its items are to be displayed cyclically or not.
16425 * @param obj The slideshow object
16426 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16427 * through or @c EINA_FALSE, otherwise
16429 * @see elm_slideshow_loop_set() for more details
16431 * @ingroup Slideshow
16433 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16436 * Remove all items from a given slideshow widget
16438 * @param obj The slideshow object
16440 * This removes (and deletes) all items in @p obj, leaving it
16443 * @see elm_slideshow_item_del(), to remove just one item.
16445 * @ingroup Slideshow
16447 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16450 * Get the internal list of items in a given slideshow widget.
16452 * @param obj The slideshow object
16453 * @return The list of items (#Elm_Slideshow_Item as data) or
16454 * @c NULL on errors.
16456 * This list is @b not to be modified in any way and must not be
16457 * freed. Use the list members with functions like
16458 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16460 * @warning This list is only valid until @p obj object's internal
16461 * items list is changed. It should be fetched again with another
16462 * call to this function when changes happen.
16464 * @ingroup Slideshow
16466 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16469 * Delete a given item from a slideshow widget.
16471 * @param item The slideshow item
16473 * @ingroup Slideshow
16475 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16478 * Return the data associated with a given slideshow item
16480 * @param item The slideshow item
16481 * @return Returns the data associated to this item
16483 * @ingroup Slideshow
16485 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16488 * Returns the currently displayed item, in a given slideshow widget
16490 * @param obj The slideshow object
16491 * @return A handle to the item being displayed in @p obj or
16492 * @c NULL, if none is (and on errors)
16494 * @ingroup Slideshow
16496 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16499 * Get the real Evas object created to implement the view of a
16500 * given slideshow item
16502 * @param item The slideshow item.
16503 * @return the Evas object implementing this item's view.
16505 * This returns the actual Evas object used to implement the
16506 * specified slideshow item's view. This may be @c NULL, as it may
16507 * not have been created or may have been deleted, at any time, by
16508 * the slideshow. <b>Do not modify this object</b> (move, resize,
16509 * show, hide, etc.), as the slideshow is controlling it. This
16510 * function is for querying, emitting custom signals or hooking
16511 * lower level callbacks for events on that object. Do not delete
16512 * this object under any circumstances.
16514 * @see elm_slideshow_item_data_get()
16516 * @ingroup Slideshow
16518 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16521 * Get the the item, in a given slideshow widget, placed at
16522 * position @p nth, in its internal items list
16524 * @param obj The slideshow object
16525 * @param nth The number of the item to grab a handle to (0 being
16527 * @return The item stored in @p obj at position @p nth or @c NULL,
16528 * if there's no item with that index (and on errors)
16530 * @ingroup Slideshow
16532 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16535 * Set the current slide layout in use for a given slideshow widget
16537 * @param obj The slideshow object
16538 * @param layout The new layout's name string
16540 * If @p layout is implemented in @p obj's theme (i.e., is contained
16541 * in the list returned by elm_slideshow_layouts_get()), this new
16542 * images layout will be used on the widget.
16544 * @see elm_slideshow_layouts_get() for more details
16546 * @ingroup Slideshow
16548 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16551 * Get the current slide layout in use for a given slideshow widget
16553 * @param obj The slideshow object
16554 * @return The current layout's name
16556 * @see elm_slideshow_layout_set() for more details
16558 * @ingroup Slideshow
16560 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16563 * Returns the list of @b layout names available, for a given
16564 * slideshow widget.
16566 * @param obj The slideshow object
16567 * @return The list of layouts (list of @b stringshared strings
16570 * Slideshow layouts will change how the widget is to dispose each
16571 * image item in its viewport, with regard to cropping, scaling,
16574 * The layouts, which come from @p obj's theme, must be an EDC
16575 * data item name @c "layouts" on the theme file, with (prefix)
16576 * names of EDC programs actually implementing them.
16578 * The available layouts for slideshows on the default theme are:
16579 * - @c "fullscreen" - item images with original aspect, scaled to
16580 * touch top and down slideshow borders or, if the image's heigh
16581 * is not enough, left and right slideshow borders.
16582 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16583 * one, but always leaving 10% of the slideshow's dimensions of
16584 * distance between the item image's borders and the slideshow
16585 * borders, for each axis.
16587 * @warning The stringshared strings get no new references
16588 * exclusive to the user grabbing the list, here, so if you'd like
16589 * to use them out of this call's context, you'd better @c
16590 * eina_stringshare_ref() them.
16592 * @see elm_slideshow_layout_set()
16594 * @ingroup Slideshow
16596 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16599 * Set the number of items to cache, on a given slideshow widget,
16600 * <b>before the current item</b>
16602 * @param obj The slideshow object
16603 * @param count Number of items to cache before the current one
16605 * The default value for this property is @c 2. See
16606 * @ref Slideshow_Caching "slideshow caching" for more details.
16608 * @see elm_slideshow_cache_before_get()
16610 * @ingroup Slideshow
16612 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16615 * Retrieve the number of items to cache, on a given slideshow widget,
16616 * <b>before the current item</b>
16618 * @param obj The slideshow object
16619 * @return The number of items set to be cached before the current one
16621 * @see elm_slideshow_cache_before_set() for more details
16623 * @ingroup Slideshow
16625 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16628 * Set the number of items to cache, on a given slideshow widget,
16629 * <b>after the current item</b>
16631 * @param obj The slideshow object
16632 * @param count Number of items to cache after the current one
16634 * The default value for this property is @c 2. See
16635 * @ref Slideshow_Caching "slideshow caching" for more details.
16637 * @see elm_slideshow_cache_after_get()
16639 * @ingroup Slideshow
16641 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16644 * Retrieve the number of items to cache, on a given slideshow widget,
16645 * <b>after the current item</b>
16647 * @param obj The slideshow object
16648 * @return The number of items set to be cached after the current one
16650 * @see elm_slideshow_cache_after_set() for more details
16652 * @ingroup Slideshow
16654 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16657 * Get the number of items stored in a given slideshow widget
16659 * @param obj The slideshow object
16660 * @return The number of items on @p obj, at the moment of this call
16662 * @ingroup Slideshow
16664 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16671 * @defgroup Fileselector File Selector
16673 * @image html img/widget/fileselector/preview-00.png
16674 * @image latex img/widget/fileselector/preview-00.eps
16676 * A file selector is a widget that allows a user to navigate
16677 * through a file system, reporting file selections back via its
16680 * It contains shortcut buttons for home directory (@c ~) and to
16681 * jump one directory upwards (..), as well as cancel/ok buttons to
16682 * confirm/cancel a given selection. After either one of those two
16683 * former actions, the file selector will issue its @c "done" smart
16686 * There's a text entry on it, too, showing the name of the current
16687 * selection. There's the possibility of making it editable, so it
16688 * is useful on file saving dialogs on applications, where one
16689 * gives a file name to save contents to, in a given directory in
16690 * the system. This custom file name will be reported on the @c
16691 * "done" smart callback (explained in sequence).
16693 * Finally, it has a view to display file system items into in two
16698 * If Elementary is built with support of the Ethumb thumbnailing
16699 * library, the second form of view will display preview thumbnails
16700 * of files which it supports.
16702 * Smart callbacks one can register to:
16704 * - @c "selected" - the user has clicked on a file (when not in
16705 * folders-only mode) or directory (when in folders-only mode)
16706 * - @c "directory,open" - the list has been populated with new
16707 * content (@c event_info is a pointer to the directory's
16708 * path, a @b stringshared string)
16709 * - @c "done" - the user has clicked on the "ok" or "cancel"
16710 * buttons (@c event_info is a pointer to the selection's
16711 * path, a @b stringshared string)
16713 * Here is an example on its usage:
16714 * @li @ref fileselector_example
16718 * @addtogroup Fileselector
16723 * Defines how a file selector widget is to layout its contents
16724 * (file system entries).
16726 typedef enum _Elm_Fileselector_Mode
16728 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16729 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16730 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16731 } Elm_Fileselector_Mode;
16734 * Add a new file selector widget to the given parent Elementary
16735 * (container) object
16737 * @param parent The parent object
16738 * @return a new file selector widget handle or @c NULL, on errors
16740 * This function inserts a new file selector widget on the canvas.
16742 * @ingroup Fileselector
16744 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16747 * Enable/disable the file name entry box where the user can type
16748 * in a name for a file, in a given file selector widget
16750 * @param obj The file selector object
16751 * @param is_save @c EINA_TRUE to make the file selector a "saving
16752 * dialog", @c EINA_FALSE otherwise
16754 * Having the entry editable is useful on file saving dialogs on
16755 * applications, where one gives a file name to save contents to,
16756 * in a given directory in the system. This custom file name will
16757 * be reported on the @c "done" smart callback.
16759 * @see elm_fileselector_is_save_get()
16761 * @ingroup Fileselector
16763 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16766 * Get whether the given file selector is in "saving dialog" mode
16768 * @param obj The file selector object
16769 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16770 * mode, @c EINA_FALSE otherwise (and on errors)
16772 * @see elm_fileselector_is_save_set() for more details
16774 * @ingroup Fileselector
16776 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16779 * Enable/disable folder-only view for a given file selector widget
16781 * @param obj The file selector object
16782 * @param only @c EINA_TRUE to make @p obj only display
16783 * directories, @c EINA_FALSE to make files to be displayed in it
16786 * If enabled, the widget's view will only display folder items,
16789 * @see elm_fileselector_folder_only_get()
16791 * @ingroup Fileselector
16793 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16796 * Get whether folder-only view is set for a given file selector
16799 * @param obj The file selector object
16800 * @return only @c EINA_TRUE if @p obj is only displaying
16801 * directories, @c EINA_FALSE if files are being displayed in it
16802 * too (and on errors)
16804 * @see elm_fileselector_folder_only_get()
16806 * @ingroup Fileselector
16808 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16811 * Enable/disable the "ok" and "cancel" buttons on a given file
16814 * @param obj The file selector object
16815 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16817 * @note A file selector without those buttons will never emit the
16818 * @c "done" smart event, and is only usable if one is just hooking
16819 * to the other two events.
16821 * @see elm_fileselector_buttons_ok_cancel_get()
16823 * @ingroup Fileselector
16825 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16828 * Get whether the "ok" and "cancel" buttons on a given file
16829 * selector widget are being shown.
16831 * @param obj The file selector object
16832 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16833 * otherwise (and on errors)
16835 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16837 * @ingroup Fileselector
16839 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16842 * Enable/disable a tree view in the given file selector widget,
16843 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16845 * @param obj The file selector object
16846 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16849 * In a tree view, arrows are created on the sides of directories,
16850 * allowing them to expand in place.
16852 * @note If it's in other mode, the changes made by this function
16853 * will only be visible when one switches back to "list" mode.
16855 * @see elm_fileselector_expandable_get()
16857 * @ingroup Fileselector
16859 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16862 * Get whether tree view is enabled for the given file selector
16865 * @param obj The file selector object
16866 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16867 * otherwise (and or errors)
16869 * @see elm_fileselector_expandable_set() for more details
16871 * @ingroup Fileselector
16873 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16876 * Set, programmatically, the @b directory that a given file
16877 * selector widget will display contents from
16879 * @param obj The file selector object
16880 * @param path The path to display in @p obj
16882 * This will change the @b directory that @p obj is displaying. It
16883 * will also clear the text entry area on the @p obj object, which
16884 * displays select files' names.
16886 * @see elm_fileselector_path_get()
16888 * @ingroup Fileselector
16890 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16893 * Get the parent directory's path that a given file selector
16894 * widget is displaying
16896 * @param obj The file selector object
16897 * @return The (full) path of the directory the file selector is
16898 * displaying, a @b stringshared string
16900 * @see elm_fileselector_path_set()
16902 * @ingroup Fileselector
16904 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16907 * Set, programmatically, the currently selected file/directory in
16908 * the given file selector widget
16910 * @param obj The file selector object
16911 * @param path The (full) path to a file or directory
16912 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16913 * latter case occurs if the directory or file pointed to do not
16916 * @see elm_fileselector_selected_get()
16918 * @ingroup Fileselector
16920 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16923 * Get the currently selected item's (full) path, in the given file
16926 * @param obj The file selector object
16927 * @return The absolute path of the selected item, a @b
16928 * stringshared string
16930 * @note Custom editions on @p obj object's text entry, if made,
16931 * will appear on the return string of this function, naturally.
16933 * @see elm_fileselector_selected_set() for more details
16935 * @ingroup Fileselector
16937 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16940 * Set the mode in which a given file selector widget will display
16941 * (layout) file system entries in its view
16943 * @param obj The file selector object
16944 * @param mode The mode of the fileselector, being it one of
16945 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
16946 * first one, naturally, will display the files in a list. The
16947 * latter will make the widget to display its entries in a grid
16950 * @note By using elm_fileselector_expandable_set(), the user may
16951 * trigger a tree view for that list.
16953 * @note If Elementary is built with support of the Ethumb
16954 * thumbnailing library, the second form of view will display
16955 * preview thumbnails of files which it supports. You must have
16956 * elm_need_ethumb() called in your Elementary for thumbnailing to
16959 * @see elm_fileselector_expandable_set().
16960 * @see elm_fileselector_mode_get().
16962 * @ingroup Fileselector
16964 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
16967 * Get the mode in which a given file selector widget is displaying
16968 * (layouting) file system entries in its view
16970 * @param obj The fileselector object
16971 * @return The mode in which the fileselector is at
16973 * @see elm_fileselector_mode_set() for more details
16975 * @ingroup Fileselector
16977 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16984 * @defgroup Progressbar Progress bar
16986 * The progress bar is a widget for visually representing the
16987 * progress status of a given job/task.
16989 * A progress bar may be horizontal or vertical. It may display an
16990 * icon besides it, as well as primary and @b units labels. The
16991 * former is meant to label the widget as a whole, while the
16992 * latter, which is formatted with floating point values (and thus
16993 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
16994 * units"</c>), is meant to label the widget's <b>progress
16995 * value</b>. Label, icon and unit strings/objects are @b optional
16996 * for progress bars.
16998 * A progress bar may be @b inverted, in which state it gets its
16999 * values inverted, with high values being on the left or top and
17000 * low values on the right or bottom, as opposed to normally have
17001 * the low values on the former and high values on the latter,
17002 * respectively, for horizontal and vertical modes.
17004 * The @b span of the progress, as set by
17005 * elm_progressbar_span_size_set(), is its length (horizontally or
17006 * vertically), unless one puts size hints on the widget to expand
17007 * on desired directions, by any container. That length will be
17008 * scaled by the object or applications scaling factor. At any
17009 * point code can query the progress bar for its value with
17010 * elm_progressbar_value_get().
17012 * Available widget styles for progress bars:
17014 * - @c "wheel" (simple style, no text, no progression, only
17015 * "pulse" effect is available)
17017 * Here is an example on its usage:
17018 * @li @ref progressbar_example
17022 * Add a new progress bar widget to the given parent Elementary
17023 * (container) object
17025 * @param parent The parent object
17026 * @return a new progress bar widget handle or @c NULL, on errors
17028 * This function inserts a new progress bar widget on the canvas.
17030 * @ingroup Progressbar
17032 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17035 * Set whether a given progress bar widget is at "pulsing mode" or
17038 * @param obj The progress bar object
17039 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17040 * @c EINA_FALSE to put it back to its default one
17042 * By default, progress bars will display values from the low to
17043 * high value boundaries. There are, though, contexts in which the
17044 * state of progression of a given task is @b unknown. For those,
17045 * one can set a progress bar widget to a "pulsing state", to give
17046 * the user an idea that some computation is being held, but
17047 * without exact progress values. In the default theme it will
17048 * animate its bar with the contents filling in constantly and back
17049 * to non-filled, in a loop. To start and stop this pulsing
17050 * animation, one has to explicitly call elm_progressbar_pulse().
17052 * @see elm_progressbar_pulse_get()
17053 * @see elm_progressbar_pulse()
17055 * @ingroup Progressbar
17057 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17060 * Get whether a given progress bar widget is at "pulsing mode" or
17063 * @param obj The progress bar object
17064 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17065 * if it's in the default one (and on errors)
17067 * @ingroup Progressbar
17069 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17072 * Start/stop a given progress bar "pulsing" animation, if its
17075 * @param obj The progress bar object
17076 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17077 * @c EINA_FALSE to @b stop it
17079 * @note This call won't do anything if @p obj is not under "pulsing mode".
17081 * @see elm_progressbar_pulse_set() for more details.
17083 * @ingroup Progressbar
17085 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17088 * Set the progress value (in percentage) on a given progress bar
17091 * @param obj The progress bar object
17092 * @param val The progress value (@b must be between @c 0.0 and @c
17095 * Use this call to set progress bar levels.
17097 * @note If you passes a value out of the specified range for @p
17098 * val, it will be interpreted as the @b closest of the @b boundary
17099 * values in the range.
17101 * @ingroup Progressbar
17103 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17106 * Get the progress value (in percentage) on a given progress bar
17109 * @param obj The progress bar object
17110 * @return The value of the progressbar
17112 * @see elm_progressbar_value_set() for more details
17114 * @ingroup Progressbar
17116 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17119 * Set the label of a given progress bar widget
17121 * @param obj The progress bar object
17122 * @param label The text label string, in UTF-8
17124 * @ingroup Progressbar
17125 * @deprecated use elm_object_text_set() instead.
17127 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17130 * Get the label of a given progress bar widget
17132 * @param obj The progressbar object
17133 * @return The text label string, in UTF-8
17135 * @ingroup Progressbar
17136 * @deprecated use elm_object_text_set() instead.
17138 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17141 * Set the icon object of a given progress bar widget
17143 * @param obj The progress bar object
17144 * @param icon The icon object
17146 * Use this call to decorate @p obj with an icon next to it.
17148 * @note Once the icon object is set, a previously set one will be
17149 * deleted. If you want to keep that old content object, use the
17150 * elm_progressbar_icon_unset() function.
17152 * @see elm_progressbar_icon_get()
17154 * @ingroup Progressbar
17156 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17159 * Retrieve the icon object set for a given progress bar widget
17161 * @param obj The progress bar object
17162 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17163 * otherwise (and on errors)
17165 * @see elm_progressbar_icon_set() for more details
17167 * @ingroup Progressbar
17169 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17172 * Unset an icon set on a given progress bar widget
17174 * @param obj The progress bar object
17175 * @return The icon object that was being used, if any was set, or
17176 * @c NULL, otherwise (and on errors)
17178 * This call will unparent and return the icon object which was set
17179 * for this widget, previously, on success.
17181 * @see elm_progressbar_icon_set() for more details
17183 * @ingroup Progressbar
17185 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17188 * Set the (exact) length of the bar region of a given progress bar
17191 * @param obj The progress bar object
17192 * @param size The length of the progress bar's bar region
17194 * This sets the minimum width (when in horizontal mode) or height
17195 * (when in vertical mode) of the actual bar area of the progress
17196 * bar @p obj. This in turn affects the object's minimum size. Use
17197 * this when you're not setting other size hints expanding on the
17198 * given direction (like weight and alignment hints) and you would
17199 * like it to have a specific size.
17201 * @note Icon, label and unit text around @p obj will require their
17202 * own space, which will make @p obj to require more the @p size,
17205 * @see elm_progressbar_span_size_get()
17207 * @ingroup Progressbar
17209 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17212 * Get the length set for the bar region of a given progress bar
17215 * @param obj The progress bar object
17216 * @return The length of the progress bar's bar region
17218 * If that size was not set previously, with
17219 * elm_progressbar_span_size_set(), this call will return @c 0.
17221 * @ingroup Progressbar
17223 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17226 * Set the format string for a given progress bar widget's units
17229 * @param obj The progress bar object
17230 * @param format The format string for @p obj's units label
17232 * If @c NULL is passed on @p format, it will make @p obj's units
17233 * area to be hidden completely. If not, it'll set the <b>format
17234 * string</b> for the units label's @b text. The units label is
17235 * provided a floating point value, so the units text is up display
17236 * at most one floating point falue. Note that the units label is
17237 * optional. Use a format string such as "%1.2f meters" for
17240 * @note The default format string for a progress bar is an integer
17241 * percentage, as in @c "%.0f %%".
17243 * @see elm_progressbar_unit_format_get()
17245 * @ingroup Progressbar
17247 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17250 * Retrieve the format string set for a given progress bar widget's
17253 * @param obj The progress bar object
17254 * @return The format set string for @p obj's units label or
17255 * @c NULL, if none was set (and on errors)
17257 * @see elm_progressbar_unit_format_set() for more details
17259 * @ingroup Progressbar
17261 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17264 * Set the orientation of a given progress bar widget
17266 * @param obj The progress bar object
17267 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17268 * @b horizontal, @c EINA_FALSE to make it @b vertical
17270 * Use this function to change how your progress bar is to be
17271 * disposed: vertically or horizontally.
17273 * @see elm_progressbar_horizontal_get()
17275 * @ingroup Progressbar
17277 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17280 * Retrieve the orientation of a given progress bar widget
17282 * @param obj The progress bar object
17283 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17284 * @c EINA_FALSE if it's @b vertical (and on errors)
17286 * @see elm_progressbar_horizontal_set() for more details
17288 * @ingroup Progressbar
17290 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17293 * Invert a given progress bar widget's displaying values order
17295 * @param obj The progress bar object
17296 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17297 * @c EINA_FALSE to bring it back to default, non-inverted values.
17299 * A progress bar may be @b inverted, in which state it gets its
17300 * values inverted, with high values being on the left or top and
17301 * low values on the right or bottom, as opposed to normally have
17302 * the low values on the former and high values on the latter,
17303 * respectively, for horizontal and vertical modes.
17305 * @see elm_progressbar_inverted_get()
17307 * @ingroup Progressbar
17309 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17312 * Get whether a given progress bar widget's displaying values are
17315 * @param obj The progress bar object
17316 * @return @c EINA_TRUE, if @p obj has inverted values,
17317 * @c EINA_FALSE otherwise (and on errors)
17319 * @see elm_progressbar_inverted_set() for more details
17321 * @ingroup Progressbar
17323 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17326 * @defgroup Separator Separator
17328 * @brief Separator is a very thin object used to separate other objects.
17330 * A separator can be vertical or horizontal.
17332 * @ref tutorial_separator is a good example of how to use a separator.
17336 * @brief Add a separator object to @p parent
17338 * @param parent The parent object
17340 * @return The separator object, or NULL upon failure
17342 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17344 * @brief Set the horizontal mode of a separator object
17346 * @param obj The separator object
17347 * @param horizontal If true, the separator is horizontal
17349 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17351 * @brief Get the horizontal mode of a separator object
17353 * @param obj The separator object
17354 * @return If true, the separator is horizontal
17356 * @see elm_separator_horizontal_set()
17358 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17364 * @defgroup Spinner Spinner
17365 * @ingroup Elementary
17367 * @image html img/widget/spinner/preview-00.png
17368 * @image latex img/widget/spinner/preview-00.eps
17370 * A spinner is a widget which allows the user to increase or decrease
17371 * numeric values using arrow buttons, or edit values directly, clicking
17372 * over it and typing the new value.
17374 * By default the spinner will not wrap and has a label
17375 * of "%.0f" (just showing the integer value of the double).
17377 * A spinner has a label that is formatted with floating
17378 * point values and thus accepts a printf-style format string, like
17381 * It also allows specific values to be replaced by pre-defined labels.
17383 * Smart callbacks one can register to:
17385 * - "changed" - Whenever the spinner value is changed.
17386 * - "delay,changed" - A short time after the value is changed by the user.
17387 * This will be called only when the user stops dragging for a very short
17388 * period or when they release their finger/mouse, so it avoids possibly
17389 * expensive reactions to the value change.
17391 * Available styles for it:
17393 * - @c "vertical": up/down buttons at the right side and text left aligned.
17395 * Here is an example on its usage:
17396 * @ref spinner_example
17400 * @addtogroup Spinner
17405 * Add a new spinner widget to the given parent Elementary
17406 * (container) object.
17408 * @param parent The parent object.
17409 * @return a new spinner widget handle or @c NULL, on errors.
17411 * This function inserts a new spinner widget on the canvas.
17416 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17419 * Set the format string of the displayed label.
17421 * @param obj The spinner object.
17422 * @param fmt The format string for the label display.
17424 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17425 * string for the label text. The label text is provided a floating point
17426 * value, so the label text can display up to 1 floating point value.
17427 * Note that this is optional.
17429 * Use a format string such as "%1.2f meters" for example, and it will
17430 * display values like: "3.14 meters" for a value equal to 3.14159.
17432 * Default is "%0.f".
17434 * @see elm_spinner_label_format_get()
17438 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17441 * Get the label format of the spinner.
17443 * @param obj The spinner object.
17444 * @return The text label format string in UTF-8.
17446 * @see elm_spinner_label_format_set() for details.
17450 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17453 * Set the minimum and maximum values for the spinner.
17455 * @param obj The spinner object.
17456 * @param min The minimum value.
17457 * @param max The maximum value.
17459 * Define the allowed range of values to be selected by the user.
17461 * If actual value is less than @p min, it will be updated to @p min. If it
17462 * is bigger then @p max, will be updated to @p max. Actual value can be
17463 * get with elm_spinner_value_get().
17465 * By default, min is equal to 0, and max is equal to 100.
17467 * @warning Maximum must be greater than minimum.
17469 * @see elm_spinner_min_max_get()
17473 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17476 * Get the minimum and maximum values of the spinner.
17478 * @param obj The spinner object.
17479 * @param min Pointer where to store the minimum value.
17480 * @param max Pointer where to store the maximum value.
17482 * @note If only one value is needed, the other pointer can be passed
17485 * @see elm_spinner_min_max_set() for details.
17489 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17492 * Set the step used to increment or decrement the spinner value.
17494 * @param obj The spinner object.
17495 * @param step The step value.
17497 * This value will be incremented or decremented to the displayed value.
17498 * It will be incremented while the user keep right or top arrow pressed,
17499 * and will be decremented while the user keep left or bottom arrow pressed.
17501 * The interval to increment / decrement can be set with
17502 * elm_spinner_interval_set().
17504 * By default step value is equal to 1.
17506 * @see elm_spinner_step_get()
17510 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17513 * Get the step used to increment or decrement the spinner value.
17515 * @param obj The spinner object.
17516 * @return The step value.
17518 * @see elm_spinner_step_get() for more details.
17522 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17525 * Set the value the spinner displays.
17527 * @param obj The spinner object.
17528 * @param val The value to be displayed.
17530 * Value will be presented on the label following format specified with
17531 * elm_spinner_format_set().
17533 * @warning The value must to be between min and max values. This values
17534 * are set by elm_spinner_min_max_set().
17536 * @see elm_spinner_value_get().
17537 * @see elm_spinner_format_set().
17538 * @see elm_spinner_min_max_set().
17542 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17545 * Get the value displayed by the spinner.
17547 * @param obj The spinner object.
17548 * @return The value displayed.
17550 * @see elm_spinner_value_set() for details.
17554 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17557 * Set whether the spinner should wrap when it reaches its
17558 * minimum or maximum value.
17560 * @param obj The spinner object.
17561 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17564 * Disabled by default. If disabled, when the user tries to increment the
17566 * but displayed value plus step value is bigger than maximum value,
17568 * won't allow it. The same happens when the user tries to decrement it,
17569 * but the value less step is less than minimum value.
17571 * When wrap is enabled, in such situations it will allow these changes,
17572 * but will get the value that would be less than minimum and subtracts
17573 * from maximum. Or add the value that would be more than maximum to
17577 * @li min value = 10
17578 * @li max value = 50
17579 * @li step value = 20
17580 * @li displayed value = 20
17582 * When the user decrement value (using left or bottom arrow), it will
17583 * displays @c 40, because max - (min - (displayed - step)) is
17584 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17586 * @see elm_spinner_wrap_get().
17590 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17593 * Get whether the spinner should wrap when it reaches its
17594 * minimum or maximum value.
17596 * @param obj The spinner object
17597 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17598 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17600 * @see elm_spinner_wrap_set() for details.
17604 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17607 * Set whether the spinner can be directly edited by the user or not.
17609 * @param obj The spinner object.
17610 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17611 * don't allow users to edit it directly.
17613 * Spinner objects can have edition @b disabled, in which state they will
17614 * be changed only by arrows.
17615 * Useful for contexts
17616 * where you don't want your users to interact with it writting the value.
17618 * when using special values, the user can see real value instead
17619 * of special label on edition.
17621 * It's enabled by default.
17623 * @see elm_spinner_editable_get()
17627 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17630 * Get whether the spinner can be directly edited by the user or not.
17632 * @param obj The spinner object.
17633 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17634 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17636 * @see elm_spinner_editable_set() for details.
17640 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17643 * Set a special string to display in the place of the numerical value.
17645 * @param obj The spinner object.
17646 * @param value The value to be replaced.
17647 * @param label The label to be used.
17649 * It's useful for cases when a user should select an item that is
17650 * better indicated by a label than a value. For example, weekdays or months.
17654 * sp = elm_spinner_add(win);
17655 * elm_spinner_min_max_set(sp, 1, 3);
17656 * elm_spinner_special_value_add(sp, 1, "January");
17657 * elm_spinner_special_value_add(sp, 2, "February");
17658 * elm_spinner_special_value_add(sp, 3, "March");
17659 * evas_object_show(sp);
17664 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17667 * Set the interval on time updates for an user mouse button hold
17668 * on spinner widgets' arrows.
17670 * @param obj The spinner object.
17671 * @param interval The (first) interval value in seconds.
17673 * This interval value is @b decreased while the user holds the
17674 * mouse pointer either incrementing or decrementing spinner's value.
17676 * This helps the user to get to a given value distant from the
17677 * current one easier/faster, as it will start to change quicker and
17678 * quicker on mouse button holds.
17680 * The calculation for the next change interval value, starting from
17681 * the one set with this call, is the previous interval divided by
17682 * @c 1.05, so it decreases a little bit.
17684 * The default starting interval value for automatic changes is
17687 * @see elm_spinner_interval_get()
17691 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17694 * Get the interval on time updates for an user mouse button hold
17695 * on spinner widgets' arrows.
17697 * @param obj The spinner object.
17698 * @return The (first) interval value, in seconds, set on it.
17700 * @see elm_spinner_interval_set() for more details.
17704 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17711 * @defgroup Index Index
17713 * @image html img/widget/index/preview-00.png
17715 * An index widget gives you an index for fast access to whichever
17716 * group of other UI items one might have. It's a list of text
17717 * items (usually letters, for alphabetically ordered access).
17719 * Index widgets are by default hidden and just appear when the
17720 * user clicks over it's reserved area in the canvas. In its
17721 * default theme, it's an area one @ref Fingers "finger" wide on
17722 * the right side of the index widget's container.
17724 * When items on the index are selected, smart callbacks get
17725 * called, so that its user can make other container objects to
17726 * show a given area or child object depending on the index item
17727 * selected. You'd probably be using an index together with @ref
17728 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17731 * Smart events one can add callbacks for are:
17732 * - @c "changed" - When the selected index item changes. @c
17733 * event_info is the selected item's data pointer.
17734 * - @c "delay,changed" - When the selected index item changes, but
17735 * after a small idling period. @c event_info is the selected
17736 * item's data pointer.
17737 * - @c "selected" - When the user releases a mouse button and
17738 * selects an item. @c event_info is the selected item's data
17740 * - @c "level,up" - when the user moves a finger from the first
17741 * level to the second level
17742 * - @c "level,down" - when the user moves a finger from the second
17743 * level to the first level
17745 * The @c "delay,changed" event is so that it'll wait a small time
17746 * before actually reporting those events and, moreover, just the
17747 * last event happening on those time frames will actually be
17750 * Here are some examples on its usage:
17751 * @li @ref index_example_01
17752 * @li @ref index_example_02
17756 * @addtogroup Index
17760 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17763 * Add a new index widget to the given parent Elementary
17764 * (container) object
17766 * @param parent The parent object
17767 * @return a new index widget handle or @c NULL, on errors
17769 * This function inserts a new index widget on the canvas.
17773 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17776 * Set whether a given index widget is or not visible,
17779 * @param obj The index object
17780 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17782 * Not to be confused with visible as in @c evas_object_show() --
17783 * visible with regard to the widget's auto hiding feature.
17785 * @see elm_index_active_get()
17789 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17792 * Get whether a given index widget is currently visible or not.
17794 * @param obj The index object
17795 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17797 * @see elm_index_active_set() for more details
17801 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17804 * Set the items level for a given index widget.
17806 * @param obj The index object.
17807 * @param level @c 0 or @c 1, the currently implemented levels.
17809 * @see elm_index_item_level_get()
17813 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17816 * Get the items level set for a given index widget.
17818 * @param obj The index object.
17819 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17821 * @see elm_index_item_level_set() for more information
17825 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17828 * Returns the last selected item's data, for a given index widget.
17830 * @param obj The index object.
17831 * @return The item @b data associated to the last selected item on
17832 * @p obj (or @c NULL, on errors).
17834 * @warning The returned value is @b not an #Elm_Index_Item item
17835 * handle, but the data associated to it (see the @c item parameter
17836 * in elm_index_item_append(), as an example).
17840 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17843 * Append a new item on a given index widget.
17845 * @param obj The index object.
17846 * @param letter Letter under which the item should be indexed
17847 * @param item The item data to set for the index's item
17849 * Despite the most common usage of the @p letter argument is for
17850 * single char strings, one could use arbitrary strings as index
17853 * @c item will be the pointer returned back on @c "changed", @c
17854 * "delay,changed" and @c "selected" smart events.
17858 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17861 * Prepend a new item on a given index widget.
17863 * @param obj The index object.
17864 * @param letter Letter under which the item should be indexed
17865 * @param item The item data to set for the index's item
17867 * Despite the most common usage of the @p letter argument is for
17868 * single char strings, one could use arbitrary strings as index
17871 * @c item will be the pointer returned back on @c "changed", @c
17872 * "delay,changed" and @c "selected" smart events.
17876 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17879 * Append a new item, on a given index widget, <b>after the item
17880 * having @p relative as data</b>.
17882 * @param obj The index object.
17883 * @param letter Letter under which the item should be indexed
17884 * @param item The item data to set for the index's item
17885 * @param relative The item data of the index item to be the
17886 * predecessor of this new one
17888 * Despite the most common usage of the @p letter argument is for
17889 * single char strings, one could use arbitrary strings as index
17892 * @c item will be the pointer returned back on @c "changed", @c
17893 * "delay,changed" and @c "selected" smart events.
17895 * @note If @p relative is @c NULL or if it's not found to be data
17896 * set on any previous item on @p obj, this function will behave as
17897 * elm_index_item_append().
17901 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17904 * Prepend a new item, on a given index widget, <b>after the item
17905 * having @p relative as data</b>.
17907 * @param obj The index object.
17908 * @param letter Letter under which the item should be indexed
17909 * @param item The item data to set for the index's item
17910 * @param relative The item data of the index item to be the
17911 * successor of this new one
17913 * Despite the most common usage of the @p letter argument is for
17914 * single char strings, one could use arbitrary strings as index
17917 * @c item will be the pointer returned back on @c "changed", @c
17918 * "delay,changed" and @c "selected" smart events.
17920 * @note If @p relative is @c NULL or if it's not found to be data
17921 * set on any previous item on @p obj, this function will behave as
17922 * elm_index_item_prepend().
17926 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17929 * Insert a new item into the given index widget, using @p cmp_func
17930 * function to sort items (by item handles).
17932 * @param obj The index object.
17933 * @param letter Letter under which the item should be indexed
17934 * @param item The item data to set for the index's item
17935 * @param cmp_func The comparing function to be used to sort index
17936 * items <b>by #Elm_Index_Item item handles</b>
17937 * @param cmp_data_func A @b fallback function to be called for the
17938 * sorting of index items <b>by item data</b>). It will be used
17939 * when @p cmp_func returns @c 0 (equality), which means an index
17940 * item with provided item data already exists. To decide which
17941 * data item should be pointed to by the index item in question, @p
17942 * cmp_data_func will be used. If @p cmp_data_func returns a
17943 * non-negative value, the previous index item data will be
17944 * replaced by the given @p item pointer. If the previous data need
17945 * to be freed, it should be done by the @p cmp_data_func function,
17946 * because all references to it will be lost. If this function is
17947 * not provided (@c NULL is given), index items will be @b
17948 * duplicated, if @p cmp_func returns @c 0.
17950 * Despite the most common usage of the @p letter argument is for
17951 * single char strings, one could use arbitrary strings as index
17954 * @c item will be the pointer returned back on @c "changed", @c
17955 * "delay,changed" and @c "selected" smart events.
17959 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);
17962 * Remove an item from a given index widget, <b>to be referenced by
17963 * it's data value</b>.
17965 * @param obj The index object
17966 * @param item The item's data pointer for the item to be removed
17969 * If a deletion callback is set, via elm_index_item_del_cb_set(),
17970 * that callback function will be called by this one.
17972 * @warning The item to be removed from @p obj will be found via
17973 * its item data pointer, and not by an #Elm_Index_Item handle.
17977 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17980 * Find a given index widget's item, <b>using item data</b>.
17982 * @param obj The index object
17983 * @param item The item data pointed to by the desired index item
17984 * @return The index item handle, if found, or @c NULL otherwise
17988 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17991 * Removes @b all items from a given index widget.
17993 * @param obj The index object.
17995 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
17996 * that callback function will be called for each item in @p obj.
18000 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18003 * Go to a given items level on a index widget
18005 * @param obj The index object
18006 * @param level The index level (one of @c 0 or @c 1)
18010 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18013 * Return the data associated with a given index widget item
18015 * @param it The index widget item handle
18016 * @return The data associated with @p it
18018 * @see elm_index_item_data_set()
18022 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18025 * Set the data associated with a given index widget item
18027 * @param it The index widget item handle
18028 * @param data The new data pointer to set to @p it
18030 * This sets new item data on @p it.
18032 * @warning The old data pointer won't be touched by this function, so
18033 * the user had better to free that old data himself/herself.
18037 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18040 * Set the function to be called when a given index widget item is freed.
18042 * @param it The item to set the callback on
18043 * @param func The function to call on the item's deletion
18045 * When called, @p func will have both @c data and @c event_info
18046 * arguments with the @p it item's data value and, naturally, the
18047 * @c obj argument with a handle to the parent index widget.
18051 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18054 * Get the letter (string) set on a given index widget item.
18056 * @param it The index item handle
18057 * @return The letter string set on @p it
18061 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18068 * @defgroup Photocam Photocam
18070 * @image html img/widget/photocam/preview-00.png
18071 * @image latex img/widget/photocam/preview-00.eps
18073 * This is a widget specifically for displaying high-resolution digital
18074 * camera photos giving speedy feedback (fast load), low memory footprint
18075 * and zooming and panning as well as fitting logic. It is entirely focused
18076 * on jpeg images, and takes advantage of properties of the jpeg format (via
18077 * evas loader features in the jpeg loader).
18079 * Signals that you can add callbacks for are:
18080 * @li "clicked" - This is called when a user has clicked the photo without
18082 * @li "press" - This is called when a user has pressed down on the photo.
18083 * @li "longpressed" - This is called when a user has pressed down on the
18084 * photo for a long time without dragging around.
18085 * @li "clicked,double" - This is called when a user has double-clicked the
18087 * @li "load" - Photo load begins.
18088 * @li "loaded" - This is called when the image file load is complete for the
18089 * first view (low resolution blurry version).
18090 * @li "load,detail" - Photo detailed data load begins.
18091 * @li "loaded,detail" - This is called when the image file load is complete
18092 * for the detailed image data (full resolution needed).
18093 * @li "zoom,start" - Zoom animation started.
18094 * @li "zoom,stop" - Zoom animation stopped.
18095 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18096 * @li "scroll" - the content has been scrolled (moved)
18097 * @li "scroll,anim,start" - scrolling animation has started
18098 * @li "scroll,anim,stop" - scrolling animation has stopped
18099 * @li "scroll,drag,start" - dragging the contents around has started
18100 * @li "scroll,drag,stop" - dragging the contents around has stopped
18102 * @ref tutorial_photocam shows the API in action.
18106 * @brief Types of zoom available.
18108 typedef enum _Elm_Photocam_Zoom_Mode
18110 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18111 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18112 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18113 ELM_PHOTOCAM_ZOOM_MODE_LAST
18114 } Elm_Photocam_Zoom_Mode;
18116 * @brief Add a new Photocam object
18118 * @param parent The parent object
18119 * @return The new object or NULL if it cannot be created
18121 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18123 * @brief Set the photo file to be shown
18125 * @param obj The photocam object
18126 * @param file The photo file
18127 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18129 * This sets (and shows) the specified file (with a relative or absolute
18130 * path) and will return a load error (same error that
18131 * evas_object_image_load_error_get() will return). The image will change and
18132 * adjust its size at this point and begin a background load process for this
18133 * photo that at some time in the future will be displayed at the full
18136 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18138 * @brief Returns the path of the current image file
18140 * @param obj The photocam object
18141 * @return Returns the path
18143 * @see elm_photocam_file_set()
18145 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18147 * @brief Set the zoom level of the photo
18149 * @param obj The photocam object
18150 * @param zoom The zoom level to set
18152 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18153 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18154 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18155 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18158 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18160 * @brief Get the zoom level of the photo
18162 * @param obj The photocam object
18163 * @return The current zoom level
18165 * This returns the current zoom level of the photocam object. Note that if
18166 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18167 * (which is the default), the zoom level may be changed at any time by the
18168 * photocam object itself to account for photo size and photocam viewpoer
18171 * @see elm_photocam_zoom_set()
18172 * @see elm_photocam_zoom_mode_set()
18174 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18176 * @brief Set the zoom mode
18178 * @param obj The photocam object
18179 * @param mode The desired mode
18181 * This sets the zoom mode to manual or one of several automatic levels.
18182 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18183 * elm_photocam_zoom_set() and will stay at that level until changed by code
18184 * or until zoom mode is changed. This is the default mode. The Automatic
18185 * modes will allow the photocam object to automatically adjust zoom mode
18186 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18187 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18188 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18189 * pixels within the frame are left unfilled.
18191 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18193 * @brief Get the zoom mode
18195 * @param obj The photocam object
18196 * @return The current zoom mode
18198 * This gets the current zoom mode of the photocam object.
18200 * @see elm_photocam_zoom_mode_set()
18202 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18204 * @brief Get the current image pixel width and height
18206 * @param obj The photocam object
18207 * @param w A pointer to the width return
18208 * @param h A pointer to the height return
18210 * This gets the current photo pixel width and height (for the original).
18211 * The size will be returned in the integers @p w and @p h that are pointed
18214 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18216 * @brief Get the area of the image that is currently shown
18219 * @param x A pointer to the X-coordinate of region
18220 * @param y A pointer to the Y-coordinate of region
18221 * @param w A pointer to the width
18222 * @param h A pointer to the height
18224 * @see elm_photocam_image_region_show()
18225 * @see elm_photocam_image_region_bring_in()
18227 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18229 * @brief Set the viewed portion of the image
18231 * @param obj The photocam object
18232 * @param x X-coordinate of region in image original pixels
18233 * @param y Y-coordinate of region in image original pixels
18234 * @param w Width of region in image original pixels
18235 * @param h Height of region in image original pixels
18237 * This shows the region of the image without using animation.
18239 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18241 * @brief Bring in the viewed portion of the image
18243 * @param obj The photocam object
18244 * @param x X-coordinate of region in image original pixels
18245 * @param y Y-coordinate of region in image original pixels
18246 * @param w Width of region in image original pixels
18247 * @param h Height of region in image original pixels
18249 * This shows the region of the image using animation.
18251 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18253 * @brief Set the paused state for photocam
18255 * @param obj The photocam object
18256 * @param paused The pause state to set
18258 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18259 * photocam. The default is off. This will stop zooming using animation on
18260 * zoom levels changes and change instantly. This will stop any existing
18261 * animations that are running.
18263 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18265 * @brief Get the paused state for photocam
18267 * @param obj The photocam object
18268 * @return The current paused state
18270 * This gets the current paused state for the photocam object.
18272 * @see elm_photocam_paused_set()
18274 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18276 * @brief Get the internal low-res image used for photocam
18278 * @param obj The photocam object
18279 * @return The internal image object handle, or NULL if none exists
18281 * This gets the internal image object inside photocam. Do not modify it. It
18282 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18283 * deleted at any time as well.
18285 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18287 * @brief Set the photocam scrolling bouncing.
18289 * @param obj The photocam object
18290 * @param h_bounce bouncing for horizontal
18291 * @param v_bounce bouncing for vertical
18293 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18295 * @brief Get the photocam scrolling bouncing.
18297 * @param obj The photocam object
18298 * @param h_bounce bouncing for horizontal
18299 * @param v_bounce bouncing for vertical
18301 * @see elm_photocam_bounce_set()
18303 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18309 * @defgroup Map Map
18310 * @ingroup Elementary
18312 * @image html img/widget/map/preview-00.png
18313 * @image latex img/widget/map/preview-00.eps
18315 * This is a widget specifically for displaying a map. It uses basically
18316 * OpenStreetMap provider http://www.openstreetmap.org/,
18317 * but custom providers can be added.
18319 * It supports some basic but yet nice features:
18320 * @li zoom and scroll
18321 * @li markers with content to be displayed when user clicks over it
18322 * @li group of markers
18325 * Smart callbacks one can listen to:
18327 * - "clicked" - This is called when a user has clicked the map without
18329 * - "press" - This is called when a user has pressed down on the map.
18330 * - "longpressed" - This is called when a user has pressed down on the map
18331 * for a long time without dragging around.
18332 * - "clicked,double" - This is called when a user has double-clicked
18334 * - "load,detail" - Map detailed data load begins.
18335 * - "loaded,detail" - This is called when all currently visible parts of
18336 * the map are loaded.
18337 * - "zoom,start" - Zoom animation started.
18338 * - "zoom,stop" - Zoom animation stopped.
18339 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18340 * - "scroll" - the content has been scrolled (moved).
18341 * - "scroll,anim,start" - scrolling animation has started.
18342 * - "scroll,anim,stop" - scrolling animation has stopped.
18343 * - "scroll,drag,start" - dragging the contents around has started.
18344 * - "scroll,drag,stop" - dragging the contents around has stopped.
18345 * - "downloaded" - This is called when all currently required map images
18347 * - "route,load" - This is called when route request begins.
18348 * - "route,loaded" - This is called when route request ends.
18349 * - "name,load" - This is called when name request begins.
18350 * - "name,loaded- This is called when name request ends.
18352 * Available style for map widget:
18355 * Available style for markers:
18360 * Available style for marker bubble:
18363 * List of examples:
18364 * @li @ref map_example_01
18365 * @li @ref map_example_02
18366 * @li @ref map_example_03
18375 * @enum _Elm_Map_Zoom_Mode
18376 * @typedef Elm_Map_Zoom_Mode
18378 * Set map's zoom behavior. It can be set to manual or automatic.
18380 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18382 * Values <b> don't </b> work as bitmask, only one can be choosen.
18384 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18385 * than the scroller view.
18387 * @see elm_map_zoom_mode_set()
18388 * @see elm_map_zoom_mode_get()
18392 typedef enum _Elm_Map_Zoom_Mode
18394 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18395 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18396 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18397 ELM_MAP_ZOOM_MODE_LAST
18398 } Elm_Map_Zoom_Mode;
18401 * @enum _Elm_Map_Route_Sources
18402 * @typedef Elm_Map_Route_Sources
18404 * Set route service to be used. By default used source is
18405 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18407 * @see elm_map_route_source_set()
18408 * @see elm_map_route_source_get()
18412 typedef enum _Elm_Map_Route_Sources
18414 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18415 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. */
18416 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18417 ELM_MAP_ROUTE_SOURCE_LAST
18418 } Elm_Map_Route_Sources;
18420 typedef enum _Elm_Map_Name_Sources
18422 ELM_MAP_NAME_SOURCE_NOMINATIM,
18423 ELM_MAP_NAME_SOURCE_LAST
18424 } Elm_Map_Name_Sources;
18427 * @enum _Elm_Map_Route_Type
18428 * @typedef Elm_Map_Route_Type
18430 * Set type of transport used on route.
18432 * @see elm_map_route_add()
18436 typedef enum _Elm_Map_Route_Type
18438 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18439 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18440 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18441 ELM_MAP_ROUTE_TYPE_LAST
18442 } Elm_Map_Route_Type;
18445 * @enum _Elm_Map_Route_Method
18446 * @typedef Elm_Map_Route_Method
18448 * Set the routing method, what should be priorized, time or distance.
18450 * @see elm_map_route_add()
18454 typedef enum _Elm_Map_Route_Method
18456 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18457 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18458 ELM_MAP_ROUTE_METHOD_LAST
18459 } Elm_Map_Route_Method;
18461 typedef enum _Elm_Map_Name_Method
18463 ELM_MAP_NAME_METHOD_SEARCH,
18464 ELM_MAP_NAME_METHOD_REVERSE,
18465 ELM_MAP_NAME_METHOD_LAST
18466 } Elm_Map_Name_Method;
18468 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(). */
18469 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(). */
18470 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(). */
18471 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(). */
18472 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18473 typedef struct _Elm_Map_Track Elm_Map_Track;
18475 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. */
18476 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18477 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18478 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18480 typedef char *(*ElmMapModuleSourceFunc) (void);
18481 typedef int (*ElmMapModuleZoomMinFunc) (void);
18482 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18483 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18484 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18485 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18486 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18487 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18488 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18491 * Add a new map widget to the given parent Elementary (container) object.
18493 * @param parent The parent object.
18494 * @return a new map widget handle or @c NULL, on errors.
18496 * This function inserts a new map widget on the canvas.
18500 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18503 * Set the zoom level of the map.
18505 * @param obj The map object.
18506 * @param zoom The zoom level to set.
18508 * This sets the zoom level.
18510 * It will respect limits defined by elm_map_source_zoom_min_set() and
18511 * elm_map_source_zoom_max_set().
18513 * By default these values are 0 (world map) and 18 (maximum zoom).
18515 * This function should be used when zoom mode is set to
18516 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18517 * with elm_map_zoom_mode_set().
18519 * @see elm_map_zoom_mode_set().
18520 * @see elm_map_zoom_get().
18524 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18527 * Get the zoom level of the map.
18529 * @param obj The map object.
18530 * @return The current zoom level.
18532 * This returns the current zoom level of the map object.
18534 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18535 * (which is the default), the zoom level may be changed at any time by the
18536 * map object itself to account for map size and map viewport size.
18538 * @see elm_map_zoom_set() for details.
18542 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18545 * Set the zoom mode used by the map object.
18547 * @param obj The map object.
18548 * @param mode The zoom mode of the map, being it one of
18549 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18550 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18552 * This sets the zoom mode to manual or one of the automatic levels.
18553 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18554 * elm_map_zoom_set() and will stay at that level until changed by code
18555 * or until zoom mode is changed. This is the default mode.
18557 * The Automatic modes will allow the map object to automatically
18558 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18559 * adjust zoom so the map fits inside the scroll frame with no pixels
18560 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18561 * ensure no pixels within the frame are left unfilled. Do not forget that
18562 * the valid sizes are 2^zoom, consequently the map may be smaller than
18563 * the scroller view.
18565 * @see elm_map_zoom_set()
18569 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18572 * Get the zoom mode used by the map object.
18574 * @param obj The map object.
18575 * @return The zoom mode of the map, being it one of
18576 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18577 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18579 * This function returns the current zoom mode used by the map object.
18581 * @see elm_map_zoom_mode_set() for more details.
18585 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18588 * Get the current coordinates of the map.
18590 * @param obj The map object.
18591 * @param lon Pointer where to store longitude.
18592 * @param lat Pointer where to store latitude.
18594 * This gets the current center coordinates of the map object. It can be
18595 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18597 * @see elm_map_geo_region_bring_in()
18598 * @see elm_map_geo_region_show()
18602 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18605 * Animatedly bring in given coordinates to the center of the map.
18607 * @param obj The map object.
18608 * @param lon Longitude to center at.
18609 * @param lat Latitude to center at.
18611 * This causes map to jump to the given @p lat and @p lon coordinates
18612 * and show it (by scrolling) in the center of the viewport, if it is not
18613 * already centered. This will use animation to do so and take a period
18614 * of time to complete.
18616 * @see elm_map_geo_region_show() for a function to avoid animation.
18617 * @see elm_map_geo_region_get()
18621 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18624 * Show the given coordinates at the center of the map, @b immediately.
18626 * @param obj The map object.
18627 * @param lon Longitude to center at.
18628 * @param lat Latitude to center at.
18630 * This causes map to @b redraw its viewport's contents to the
18631 * region contining the given @p lat and @p lon, that will be moved to the
18632 * center of the map.
18634 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18635 * @see elm_map_geo_region_get()
18639 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18642 * Pause or unpause the map.
18644 * @param obj The map object.
18645 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18648 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18651 * The default is off.
18653 * This will stop zooming using animation, changing zoom levels will
18654 * change instantly. This will stop any existing animations that are running.
18656 * @see elm_map_paused_get()
18660 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18663 * Get a value whether map is paused or not.
18665 * @param obj The map object.
18666 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18667 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18669 * This gets the current paused state for the map object.
18671 * @see elm_map_paused_set() for details.
18675 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18678 * Set to show markers during zoom level changes or not.
18680 * @param obj The map object.
18681 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18684 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18687 * The default is off.
18689 * This will stop zooming using animation, changing zoom levels will
18690 * change instantly. This will stop any existing animations that are running.
18692 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18695 * The default is off.
18697 * Enabling it will force the map to stop displaying the markers during
18698 * zoom level changes. Set to on if you have a large number of markers.
18700 * @see elm_map_paused_markers_get()
18704 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18707 * Get a value whether markers will be displayed on zoom level changes or not
18709 * @param obj The map object.
18710 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18711 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18713 * This gets the current markers paused state for the map object.
18715 * @see elm_map_paused_markers_set() for details.
18719 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18722 * Get the information of downloading status.
18724 * @param obj The map object.
18725 * @param try_num Pointer where to store number of tiles being downloaded.
18726 * @param finish_num Pointer where to store number of tiles successfully
18729 * This gets the current downloading status for the map object, the number
18730 * of tiles being downloaded and the number of tiles already downloaded.
18734 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18737 * Convert a pixel coordinate (x,y) into a geographic coordinate
18738 * (longitude, latitude).
18740 * @param obj The map object.
18741 * @param x the coordinate.
18742 * @param y the coordinate.
18743 * @param size the size in pixels of the map.
18744 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18745 * @param lon Pointer where to store the longitude that correspond to x.
18746 * @param lat Pointer where to store the latitude that correspond to y.
18748 * @note Origin pixel point is the top left corner of the viewport.
18749 * Map zoom and size are taken on account.
18751 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18755 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);
18758 * Convert a geographic coordinate (longitude, latitude) into a pixel
18759 * coordinate (x, y).
18761 * @param obj The map object.
18762 * @param lon the longitude.
18763 * @param lat the latitude.
18764 * @param size the size in pixels of the map. The map is a square
18765 * and generally his size is : pow(2.0, zoom)*256.
18766 * @param x Pointer where to store the horizontal pixel coordinate that
18767 * correspond to the longitude.
18768 * @param y Pointer where to store the vertical pixel coordinate that
18769 * correspond to the latitude.
18771 * @note Origin pixel point is the top left corner of the viewport.
18772 * Map zoom and size are taken on account.
18774 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18778 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);
18781 * Convert a geographic coordinate (longitude, latitude) into a name
18784 * @param obj The map object.
18785 * @param lon the longitude.
18786 * @param lat the latitude.
18787 * @return name A #Elm_Map_Name handle for this coordinate.
18789 * To get the string for this address, elm_map_name_address_get()
18792 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18796 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18799 * Convert a name (address) into a geographic coordinate
18800 * (longitude, latitude).
18802 * @param obj The map object.
18803 * @param name The address.
18804 * @return name A #Elm_Map_Name handle for this address.
18806 * To get the longitude and latitude, elm_map_name_region_get()
18809 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18813 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18816 * Convert a pixel coordinate into a rotated pixel coordinate.
18818 * @param obj The map object.
18819 * @param x horizontal coordinate of the point to rotate.
18820 * @param y vertical coordinate of the point to rotate.
18821 * @param cx rotation's center horizontal position.
18822 * @param cy rotation's center vertical position.
18823 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18824 * @param xx Pointer where to store rotated x.
18825 * @param yy Pointer where to store rotated y.
18829 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);
18832 * Add a new marker to the map object.
18834 * @param obj The map object.
18835 * @param lon The longitude of the marker.
18836 * @param lat The latitude of the marker.
18837 * @param clas The class, to use when marker @b isn't grouped to others.
18838 * @param clas_group The class group, to use when marker is grouped to others
18839 * @param data The data passed to the callbacks.
18841 * @return The created marker or @c NULL upon failure.
18843 * A marker will be created and shown in a specific point of the map, defined
18844 * by @p lon and @p lat.
18846 * It will be displayed using style defined by @p class when this marker
18847 * is displayed alone (not grouped). A new class can be created with
18848 * elm_map_marker_class_new().
18850 * If the marker is grouped to other markers, it will be displayed with
18851 * style defined by @p class_group. Markers with the same group are grouped
18852 * if they are close. A new group class can be created with
18853 * elm_map_marker_group_class_new().
18855 * Markers created with this method can be deleted with
18856 * elm_map_marker_remove().
18858 * A marker can have associated content to be displayed by a bubble,
18859 * when a user click over it, as well as an icon. These objects will
18860 * be fetch using class' callback functions.
18862 * @see elm_map_marker_class_new()
18863 * @see elm_map_marker_group_class_new()
18864 * @see elm_map_marker_remove()
18868 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);
18871 * Set the maximum numbers of markers' content to be displayed in a group.
18873 * @param obj The map object.
18874 * @param max The maximum numbers of items displayed in a bubble.
18876 * A bubble will be displayed when the user clicks over the group,
18877 * and will place the content of markers that belong to this group
18880 * A group can have a long list of markers, consequently the creation
18881 * of the content of the bubble can be very slow.
18883 * In order to avoid this, a maximum number of items is displayed
18886 * By default this number is 30.
18888 * Marker with the same group class are grouped if they are close.
18890 * @see elm_map_marker_add()
18894 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18897 * Remove a marker from the map.
18899 * @param marker The marker to remove.
18901 * @see elm_map_marker_add()
18905 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18908 * Get the current coordinates of the marker.
18910 * @param marker marker.
18911 * @param lat Pointer where to store the marker's latitude.
18912 * @param lon Pointer where to store the marker's longitude.
18914 * These values are set when adding markers, with function
18915 * elm_map_marker_add().
18917 * @see elm_map_marker_add()
18921 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
18924 * Animatedly bring in given marker to the center of the map.
18926 * @param marker The marker to center at.
18928 * This causes map to jump to the given @p marker's coordinates
18929 * and show it (by scrolling) in the center of the viewport, if it is not
18930 * already centered. This will use animation to do so and take a period
18931 * of time to complete.
18933 * @see elm_map_marker_show() for a function to avoid animation.
18934 * @see elm_map_marker_region_get()
18938 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18941 * Show the given marker at the center of the map, @b immediately.
18943 * @param marker The marker to center at.
18945 * This causes map to @b redraw its viewport's contents to the
18946 * region contining the given @p marker's coordinates, that will be
18947 * moved to the center of the map.
18949 * @see elm_map_marker_bring_in() for a function to move with animation.
18950 * @see elm_map_markers_list_show() if more than one marker need to be
18952 * @see elm_map_marker_region_get()
18956 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18959 * Move and zoom the map to display a list of markers.
18961 * @param markers A list of #Elm_Map_Marker handles.
18963 * The map will be centered on the center point of the markers in the list.
18964 * Then the map will be zoomed in order to fit the markers using the maximum
18965 * zoom which allows display of all the markers.
18967 * @warning All the markers should belong to the same map object.
18969 * @see elm_map_marker_show() to show a single marker.
18970 * @see elm_map_marker_bring_in()
18974 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
18977 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
18979 * @param marker The marker wich content should be returned.
18980 * @return Return the evas object if it exists, else @c NULL.
18982 * To set callback function #ElmMapMarkerGetFunc for the marker class,
18983 * elm_map_marker_class_get_cb_set() should be used.
18985 * This content is what will be inside the bubble that will be displayed
18986 * when an user clicks over the marker.
18988 * This returns the actual Evas object used to be placed inside
18989 * the bubble. This may be @c NULL, as it may
18990 * not have been created or may have been deleted, at any time, by
18991 * the map. <b>Do not modify this object</b> (move, resize,
18992 * show, hide, etc.), as the map is controlling it. This
18993 * function is for querying, emitting custom signals or hooking
18994 * lower level callbacks for events on that object. Do not delete
18995 * this object under any circumstances.
18999 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19002 * Update the marker
19004 * @param marker The marker to be updated.
19006 * If a content is set to this marker, it will call function to delete it,
19007 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19008 * #ElmMapMarkerGetFunc.
19010 * These functions are set for the marker class with
19011 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19015 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19018 * Close all the bubbles opened by the user.
19020 * @param obj The map object.
19022 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19023 * when the user clicks on a marker.
19025 * This functions is set for the marker class with
19026 * elm_map_marker_class_get_cb_set().
19030 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19033 * Create a new group class.
19035 * @param obj The map object.
19036 * @return Returns the new group class.
19038 * Each marker must be associated to a group class. Markers in the same
19039 * group are grouped if they are close.
19041 * The group class defines the style of the marker when a marker is grouped
19042 * to others markers. When it is alone, another class will be used.
19044 * A group class will need to be provided when creating a marker with
19045 * elm_map_marker_add().
19047 * Some properties and functions can be set by class, as:
19048 * - style, with elm_map_group_class_style_set()
19049 * - data - to be associated to the group class. It can be set using
19050 * elm_map_group_class_data_set().
19051 * - min zoom to display markers, set with
19052 * elm_map_group_class_zoom_displayed_set().
19053 * - max zoom to group markers, set using
19054 * elm_map_group_class_zoom_grouped_set().
19055 * - visibility - set if markers will be visible or not, set with
19056 * elm_map_group_class_hide_set().
19057 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19058 * It can be set using elm_map_group_class_icon_cb_set().
19060 * @see elm_map_marker_add()
19061 * @see elm_map_group_class_style_set()
19062 * @see elm_map_group_class_data_set()
19063 * @see elm_map_group_class_zoom_displayed_set()
19064 * @see elm_map_group_class_zoom_grouped_set()
19065 * @see elm_map_group_class_hide_set()
19066 * @see elm_map_group_class_icon_cb_set()
19070 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19073 * Set the marker's style of a group class.
19075 * @param clas The group class.
19076 * @param style The style to be used by markers.
19078 * Each marker must be associated to a group class, and will use the style
19079 * defined by such class when grouped to other markers.
19081 * The following styles are provided by default theme:
19082 * @li @c radio - blue circle
19083 * @li @c radio2 - green circle
19086 * @see elm_map_group_class_new() for more details.
19087 * @see elm_map_marker_add()
19091 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19094 * Set the icon callback function of a group class.
19096 * @param clas The group class.
19097 * @param icon_get The callback function that will return the icon.
19099 * Each marker must be associated to a group class, and it can display a
19100 * custom icon. The function @p icon_get must return this icon.
19102 * @see elm_map_group_class_new() for more details.
19103 * @see elm_map_marker_add()
19107 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19110 * Set the data associated to the group class.
19112 * @param clas The group class.
19113 * @param data The new user data.
19115 * This data will be passed for callback functions, like icon get callback,
19116 * that can be set with elm_map_group_class_icon_cb_set().
19118 * If a data was previously set, the object will lose the pointer for it,
19119 * so if needs to be freed, you must do it yourself.
19121 * @see elm_map_group_class_new() for more details.
19122 * @see elm_map_group_class_icon_cb_set()
19123 * @see elm_map_marker_add()
19127 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19130 * Set the minimum zoom from where the markers are displayed.
19132 * @param clas The group class.
19133 * @param zoom The minimum zoom.
19135 * Markers only will be displayed when the map is displayed at @p zoom
19138 * @see elm_map_group_class_new() for more details.
19139 * @see elm_map_marker_add()
19143 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19146 * Set the zoom from where the markers are no more grouped.
19148 * @param clas The group class.
19149 * @param zoom The maximum zoom.
19151 * Markers only will be grouped when the map is displayed at
19152 * less than @p zoom.
19154 * @see elm_map_group_class_new() for more details.
19155 * @see elm_map_marker_add()
19159 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19162 * Set if the markers associated to the group class @clas are hidden or not.
19164 * @param clas The group class.
19165 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19168 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19173 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19176 * Create a new marker class.
19178 * @param obj The map object.
19179 * @return Returns the new group class.
19181 * Each marker must be associated to a class.
19183 * The marker class defines the style of the marker when a marker is
19184 * displayed alone, i.e., not grouped to to others markers. When grouped
19185 * it will use group class style.
19187 * A marker class will need to be provided when creating a marker with
19188 * elm_map_marker_add().
19190 * Some properties and functions can be set by class, as:
19191 * - style, with elm_map_marker_class_style_set()
19192 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19193 * It can be set using elm_map_marker_class_icon_cb_set().
19194 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19195 * Set using elm_map_marker_class_get_cb_set().
19196 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19197 * Set using elm_map_marker_class_del_cb_set().
19199 * @see elm_map_marker_add()
19200 * @see elm_map_marker_class_style_set()
19201 * @see elm_map_marker_class_icon_cb_set()
19202 * @see elm_map_marker_class_get_cb_set()
19203 * @see elm_map_marker_class_del_cb_set()
19207 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19210 * Set the marker's style of a marker class.
19212 * @param clas The marker class.
19213 * @param style The style to be used by markers.
19215 * Each marker must be associated to a marker class, and will use the style
19216 * defined by such class when alone, i.e., @b not grouped to other markers.
19218 * The following styles are provided by default theme:
19223 * @see elm_map_marker_class_new() for more details.
19224 * @see elm_map_marker_add()
19228 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19231 * Set the icon callback function of a marker class.
19233 * @param clas The marker class.
19234 * @param icon_get The callback function that will return the icon.
19236 * Each marker must be associated to a marker class, and it can display a
19237 * custom icon. The function @p icon_get must return this icon.
19239 * @see elm_map_marker_class_new() for more details.
19240 * @see elm_map_marker_add()
19244 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19247 * Set the bubble content callback function of a marker class.
19249 * @param clas The marker class.
19250 * @param get The callback function that will return the content.
19252 * Each marker must be associated to a marker class, and it can display a
19253 * a content on a bubble that opens when the user click over the marker.
19254 * The function @p get must return this content object.
19256 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19259 * @see elm_map_marker_class_new() for more details.
19260 * @see elm_map_marker_class_del_cb_set()
19261 * @see elm_map_marker_add()
19265 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19268 * Set the callback function used to delete bubble content of a marker class.
19270 * @param clas The marker class.
19271 * @param del The callback function that will delete the content.
19273 * Each marker must be associated to a marker class, and it can display a
19274 * a content on a bubble that opens when the user click over the marker.
19275 * The function to return such content can be set with
19276 * elm_map_marker_class_get_cb_set().
19278 * If this content must be freed, a callback function need to be
19279 * set for that task with this function.
19281 * If this callback is defined it will have to delete (or not) the
19282 * object inside, but if the callback is not defined the object will be
19283 * destroyed with evas_object_del().
19285 * @see elm_map_marker_class_new() for more details.
19286 * @see elm_map_marker_class_get_cb_set()
19287 * @see elm_map_marker_add()
19291 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19294 * Get the list of available sources.
19296 * @param obj The map object.
19297 * @return The source names list.
19299 * It will provide a list with all available sources, that can be set as
19300 * current source with elm_map_source_name_set(), or get with
19301 * elm_map_source_name_get().
19303 * Available sources:
19309 * @see elm_map_source_name_set() for more details.
19310 * @see elm_map_source_name_get()
19314 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19317 * Set the source of the map.
19319 * @param obj The map object.
19320 * @param source The source to be used.
19322 * Map widget retrieves images that composes the map from a web service.
19323 * This web service can be set with this method.
19325 * A different service can return a different maps with different
19326 * information and it can use different zoom values.
19328 * The @p source_name need to match one of the names provided by
19329 * elm_map_source_names_get().
19331 * The current source can be get using elm_map_source_name_get().
19333 * @see elm_map_source_names_get()
19334 * @see elm_map_source_name_get()
19339 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19342 * Get the name of currently used source.
19344 * @param obj The map object.
19345 * @return Returns the name of the source in use.
19347 * @see elm_map_source_name_set() for more details.
19351 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19354 * Set the source of the route service to be used by the map.
19356 * @param obj The map object.
19357 * @param source The route service to be used, being it one of
19358 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19359 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19361 * Each one has its own algorithm, so the route retrieved may
19362 * differ depending on the source route. Now, only the default is working.
19364 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19365 * http://www.yournavigation.org/.
19367 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19368 * assumptions. Its routing core is based on Contraction Hierarchies.
19370 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19372 * @see elm_map_route_source_get().
19376 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19379 * Get the current route source.
19381 * @param obj The map object.
19382 * @return The source of the route service used by the map.
19384 * @see elm_map_route_source_set() for details.
19388 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19391 * Set the minimum zoom of the source.
19393 * @param obj The map object.
19394 * @param zoom New minimum zoom value to be used.
19396 * By default, it's 0.
19400 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19403 * Get the minimum zoom of the source.
19405 * @param obj The map object.
19406 * @return Returns the minimum zoom of the source.
19408 * @see elm_map_source_zoom_min_set() for details.
19412 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19415 * Set the maximum zoom of the source.
19417 * @param obj The map object.
19418 * @param zoom New maximum zoom value to be used.
19420 * By default, it's 18.
19424 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19427 * Get the maximum zoom of the source.
19429 * @param obj The map object.
19430 * @return Returns the maximum zoom of the source.
19432 * @see elm_map_source_zoom_min_set() for details.
19436 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19439 * Set the user agent used by the map object to access routing services.
19441 * @param obj The map object.
19442 * @param user_agent The user agent to be used by the map.
19444 * User agent is a client application implementing a network protocol used
19445 * in communications within a client–server distributed computing system
19447 * The @p user_agent identification string will transmitted in a header
19448 * field @c User-Agent.
19450 * @see elm_map_user_agent_get()
19454 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19457 * Get the user agent used by the map object.
19459 * @param obj The map object.
19460 * @return The user agent identification string used by the map.
19462 * @see elm_map_user_agent_set() for details.
19466 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19469 * Add a new route to the map object.
19471 * @param obj The map object.
19472 * @param type The type of transport to be considered when tracing a route.
19473 * @param method The routing method, what should be priorized.
19474 * @param flon The start longitude.
19475 * @param flat The start latitude.
19476 * @param tlon The destination longitude.
19477 * @param tlat The destination latitude.
19479 * @return The created route or @c NULL upon failure.
19481 * A route will be traced by point on coordinates (@p flat, @p flon)
19482 * to point on coordinates (@p tlat, @p tlon), using the route service
19483 * set with elm_map_route_source_set().
19485 * It will take @p type on consideration to define the route,
19486 * depending if the user will be walking or driving, the route may vary.
19487 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19488 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19490 * Another parameter is what the route should priorize, the minor distance
19491 * or the less time to be spend on the route. So @p method should be one
19492 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19494 * Routes created with this method can be deleted with
19495 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19496 * and distance can be get with elm_map_route_distance_get().
19498 * @see elm_map_route_remove()
19499 * @see elm_map_route_color_set()
19500 * @see elm_map_route_distance_get()
19501 * @see elm_map_route_source_set()
19505 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);
19508 * Remove a route from the map.
19510 * @param route The route to remove.
19512 * @see elm_map_route_add()
19516 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19519 * Set the route color.
19521 * @param route The route object.
19522 * @param r Red channel value, from 0 to 255.
19523 * @param g Green channel value, from 0 to 255.
19524 * @param b Blue channel value, from 0 to 255.
19525 * @param a Alpha channel value, from 0 to 255.
19527 * It uses an additive color model, so each color channel represents
19528 * how much of each primary colors must to be used. 0 represents
19529 * ausence of this color, so if all of the three are set to 0,
19530 * the color will be black.
19532 * These component values should be integers in the range 0 to 255,
19533 * (single 8-bit byte).
19535 * This sets the color used for the route. By default, it is set to
19536 * solid red (r = 255, g = 0, b = 0, a = 255).
19538 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19540 * @see elm_map_route_color_get()
19544 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19547 * Get the route color.
19549 * @param route The route object.
19550 * @param r Pointer where to store the red channel value.
19551 * @param g Pointer where to store the green channel value.
19552 * @param b Pointer where to store the blue channel value.
19553 * @param a Pointer where to store the alpha channel value.
19555 * @see elm_map_route_color_set() for details.
19559 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19562 * Get the route distance in kilometers.
19564 * @param route The route object.
19565 * @return The distance of route (unit : km).
19569 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19572 * Get the information of route nodes.
19574 * @param route The route object.
19575 * @return Returns a string with the nodes of route.
19579 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19582 * Get the information of route waypoint.
19584 * @param route the route object.
19585 * @return Returns a string with information about waypoint of route.
19589 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19592 * Get the address of the name.
19594 * @param name The name handle.
19595 * @return Returns the address string of @p name.
19597 * This gets the coordinates of the @p name, created with one of the
19598 * conversion functions.
19600 * @see elm_map_utils_convert_name_into_coord()
19601 * @see elm_map_utils_convert_coord_into_name()
19605 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19608 * Get the current coordinates of the name.
19610 * @param name The name handle.
19611 * @param lat Pointer where to store the latitude.
19612 * @param lon Pointer where to store The longitude.
19614 * This gets the coordinates of the @p name, created with one of the
19615 * conversion functions.
19617 * @see elm_map_utils_convert_name_into_coord()
19618 * @see elm_map_utils_convert_coord_into_name()
19622 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19625 * Remove a name from the map.
19627 * @param name The name to remove.
19629 * Basically the struct handled by @p name will be freed, so convertions
19630 * between address and coordinates will be lost.
19632 * @see elm_map_utils_convert_name_into_coord()
19633 * @see elm_map_utils_convert_coord_into_name()
19637 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19642 * @param obj The map object.
19643 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19644 * @param cx Rotation's center horizontal position.
19645 * @param cy Rotation's center vertical position.
19647 * @see elm_map_rotate_get()
19651 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19654 * Get the rotate degree of the map
19656 * @param obj The map object
19657 * @param degree Pointer where to store degrees from 0.0 to 360.0
19658 * to rotate arount Z axis.
19659 * @param cx Pointer where to store rotation's center horizontal position.
19660 * @param cy Pointer where to store rotation's center vertical position.
19662 * @see elm_map_rotate_set() to set map rotation.
19666 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);
19669 * Enable or disable mouse wheel to be used to zoom in / out the map.
19671 * @param obj The map object.
19672 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19675 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19677 * It's disabled by default.
19679 * @see elm_map_wheel_disabled_get()
19683 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19686 * Get a value whether mouse wheel is enabled or not.
19688 * @param obj The map object.
19689 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19690 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19692 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19694 * @see elm_map_wheel_disabled_set() for details.
19698 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19702 * Add a track on the map
19704 * @param obj The map object.
19705 * @param emap The emap route object.
19706 * @return The route object. This is an elm object of type Route.
19708 * @see elm_route_add() for details.
19712 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19716 * Remove a track from the map
19718 * @param obj The map object.
19719 * @param route The track to remove.
19723 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19730 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19732 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19734 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19735 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19736 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19737 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19741 * @defgroup Panel Panel
19743 * @image html img/widget/panel/preview-00.png
19744 * @image latex img/widget/panel/preview-00.eps
19746 * @brief A panel is a type of animated container that contains subobjects.
19747 * It can be expanded or contracted by clicking the button on it's edge.
19749 * Orientations are as follows:
19750 * @li ELM_PANEL_ORIENT_TOP
19751 * @li ELM_PANEL_ORIENT_LEFT
19752 * @li ELM_PANEL_ORIENT_RIGHT
19754 * @ref tutorial_panel shows one way to use this widget.
19757 typedef enum _Elm_Panel_Orient
19759 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19760 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19761 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19762 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19763 } Elm_Panel_Orient;
19765 * @brief Adds a panel object
19767 * @param parent The parent object
19769 * @return The panel object, or NULL on failure
19771 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19773 * @brief Sets the orientation of the panel
19775 * @param parent The parent object
19776 * @param orient The panel orientation. Can be one of the following:
19777 * @li ELM_PANEL_ORIENT_TOP
19778 * @li ELM_PANEL_ORIENT_LEFT
19779 * @li ELM_PANEL_ORIENT_RIGHT
19781 * Sets from where the panel will (dis)appear.
19783 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19785 * @brief Get the orientation of the panel.
19787 * @param obj The panel object
19788 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19790 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19792 * @brief Set the content of the panel.
19794 * @param obj The panel object
19795 * @param content The panel content
19797 * Once the content object is set, a previously set one will be deleted.
19798 * If you want to keep that old content object, use the
19799 * elm_panel_content_unset() function.
19801 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19803 * @brief Get the content of the panel.
19805 * @param obj The panel object
19806 * @return The content that is being used
19808 * Return the content object which is set for this widget.
19810 * @see elm_panel_content_set()
19812 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19814 * @brief Unset the content of the panel.
19816 * @param obj The panel object
19817 * @return The content that was being used
19819 * Unparent and return the content object which was set for this widget.
19821 * @see elm_panel_content_set()
19823 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19825 * @brief Set the state of the panel.
19827 * @param obj The panel object
19828 * @param hidden If true, the panel will run the animation to contract
19830 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19832 * @brief Get the state of the panel.
19834 * @param obj The panel object
19835 * @param hidden If true, the panel is in the "hide" state
19837 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19839 * @brief Toggle the hidden state of the panel from code
19841 * @param obj The panel object
19843 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19849 * @defgroup Panes Panes
19850 * @ingroup Elementary
19852 * @image html img/widget/panes/preview-00.png
19853 * @image latex img/widget/panes/preview-00.eps width=\textwidth
19855 * @image html img/panes.png
19856 * @image latex img/panes.eps width=\textwidth
19858 * The panes adds a dragable bar between two contents. When dragged
19859 * this bar will resize contents size.
19861 * Panes can be displayed vertically or horizontally, and contents
19862 * size proportion can be customized (homogeneous by default).
19864 * Smart callbacks one can listen to:
19865 * - "press" - The panes has been pressed (button wasn't released yet).
19866 * - "unpressed" - The panes was released after being pressed.
19867 * - "clicked" - The panes has been clicked>
19868 * - "clicked,double" - The panes has been double clicked
19870 * Available styles for it:
19873 * Here is an example on its usage:
19874 * @li @ref panes_example
19878 * @addtogroup Panes
19883 * Add a new panes widget to the given parent Elementary
19884 * (container) object.
19886 * @param parent The parent object.
19887 * @return a new panes widget handle or @c NULL, on errors.
19889 * This function inserts a new panes widget on the canvas.
19893 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19896 * Set the left content of the panes widget.
19898 * @param obj The panes object.
19899 * @param content The new left content object.
19901 * Once the content object is set, a previously set one will be deleted.
19902 * If you want to keep that old content object, use the
19903 * elm_panes_content_left_unset() function.
19905 * If panes is displayed vertically, left content will be displayed at
19908 * @see elm_panes_content_left_get()
19909 * @see elm_panes_content_right_set() to set content on the other side.
19913 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19916 * Set the right content of the panes widget.
19918 * @param obj The panes object.
19919 * @param content The new right content object.
19921 * Once the content object is set, a previously set one will be deleted.
19922 * If you want to keep that old content object, use the
19923 * elm_panes_content_right_unset() function.
19925 * If panes is displayed vertically, left content will be displayed at
19928 * @see elm_panes_content_right_get()
19929 * @see elm_panes_content_left_set() to set content on the other side.
19933 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19936 * Get the left content of the panes.
19938 * @param obj The panes object.
19939 * @return The left content object that is being used.
19941 * Return the left content object which is set for this widget.
19943 * @see elm_panes_content_left_set() for details.
19947 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19950 * Get the right content of the panes.
19952 * @param obj The panes object
19953 * @return The right content object that is being used
19955 * Return the right content object which is set for this widget.
19957 * @see elm_panes_content_right_set() for details.
19961 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19964 * Unset the left content used for the panes.
19966 * @param obj The panes object.
19967 * @return The left content object that was being used.
19969 * Unparent and return the left content object which was set for this widget.
19971 * @see elm_panes_content_left_set() for details.
19972 * @see elm_panes_content_left_get().
19976 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19979 * Unset the right content used for the panes.
19981 * @param obj The panes object.
19982 * @return The right content object that was being used.
19984 * Unparent and return the right content object which was set for this
19987 * @see elm_panes_content_right_set() for details.
19988 * @see elm_panes_content_right_get().
19992 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19995 * Get the size proportion of panes widget's left side.
19997 * @param obj The panes object.
19998 * @return float value between 0.0 and 1.0 representing size proportion
20001 * @see elm_panes_content_left_size_set() for more details.
20005 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20008 * Set the size proportion of panes widget's left side.
20010 * @param obj The panes object.
20011 * @param size Value between 0.0 and 1.0 representing size proportion
20014 * By default it's homogeneous, i.e., both sides have the same size.
20016 * If something different is required, it can be set with this function.
20017 * For example, if the left content should be displayed over
20018 * 75% of the panes size, @p size should be passed as @c 0.75.
20019 * This way, right content will be resized to 25% of panes size.
20021 * If displayed vertically, left content is displayed at top, and
20022 * right content at bottom.
20024 * @note This proportion will change when user drags the panes bar.
20026 * @see elm_panes_content_left_size_get()
20030 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20033 * Set the orientation of a given panes widget.
20035 * @param obj The panes object.
20036 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20037 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20039 * Use this function to change how your panes is to be
20040 * disposed: vertically or horizontally.
20042 * By default it's displayed horizontally.
20044 * @see elm_panes_horizontal_get()
20048 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20051 * Retrieve the orientation of a given panes widget.
20053 * @param obj The panes object.
20054 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20055 * @c EINA_FALSE if it's @b vertical (and on errors).
20057 * @see elm_panes_horizontal_set() for more details.
20061 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20068 * @defgroup Flip Flip
20070 * @image html img/widget/flip/preview-00.png
20071 * @image latex img/widget/flip/preview-00.eps
20073 * This widget holds 2 content objects(Evas_Object): one on the front and one
20074 * on the back. It allows you to flip from front to back and vice-versa using
20075 * various animations.
20077 * If either the front or back contents are not set the flip will treat that
20078 * as transparent. So if you wore to set the front content but not the back,
20079 * and then call elm_flip_go() you would see whatever is below the flip.
20081 * For a list of supported animations see elm_flip_go().
20083 * Signals that you can add callbacks for are:
20084 * "animate,begin" - when a flip animation was started
20085 * "animate,done" - when a flip animation is finished
20087 * @ref tutorial_flip show how to use most of the API.
20091 typedef enum _Elm_Flip_Mode
20093 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20094 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20095 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20096 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20097 ELM_FLIP_CUBE_LEFT,
20098 ELM_FLIP_CUBE_RIGHT,
20100 ELM_FLIP_CUBE_DOWN,
20101 ELM_FLIP_PAGE_LEFT,
20102 ELM_FLIP_PAGE_RIGHT,
20106 typedef enum _Elm_Flip_Interaction
20108 ELM_FLIP_INTERACTION_NONE,
20109 ELM_FLIP_INTERACTION_ROTATE,
20110 ELM_FLIP_INTERACTION_CUBE,
20111 ELM_FLIP_INTERACTION_PAGE
20112 } Elm_Flip_Interaction;
20113 typedef enum _Elm_Flip_Direction
20115 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20116 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20117 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20118 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20119 } Elm_Flip_Direction;
20121 * @brief Add a new flip to the parent
20123 * @param parent The parent object
20124 * @return The new object or NULL if it cannot be created
20126 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20128 * @brief Set the front content of the flip widget.
20130 * @param obj The flip object
20131 * @param content The new front content object
20133 * Once the content object is set, a previously set one will be deleted.
20134 * If you want to keep that old content object, use the
20135 * elm_flip_content_front_unset() function.
20137 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20139 * @brief Set the back content of the flip widget.
20141 * @param obj The flip object
20142 * @param content The new back content object
20144 * Once the content object is set, a previously set one will be deleted.
20145 * If you want to keep that old content object, use the
20146 * elm_flip_content_back_unset() function.
20148 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20150 * @brief Get the front content used for the flip
20152 * @param obj The flip object
20153 * @return The front content object that is being used
20155 * Return the front content object which is set for this widget.
20157 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20159 * @brief Get the back content used for the flip
20161 * @param obj The flip object
20162 * @return The back content object that is being used
20164 * Return the back content object which is set for this widget.
20166 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20168 * @brief Unset the front content used for the flip
20170 * @param obj The flip object
20171 * @return The front content object that was being used
20173 * Unparent and return the front content object which was set for this widget.
20175 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20177 * @brief Unset the back content used for the flip
20179 * @param obj The flip object
20180 * @return The back content object that was being used
20182 * Unparent and return the back content object which was set for this widget.
20184 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20186 * @brief Get flip front visibility state
20188 * @param obj The flip objct
20189 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20192 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20194 * @brief Set flip perspective
20196 * @param obj The flip object
20197 * @param foc The coordinate to set the focus on
20198 * @param x The X coordinate
20199 * @param y The Y coordinate
20201 * @warning This function currently does nothing.
20203 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20205 * @brief Runs the flip animation
20207 * @param obj The flip object
20208 * @param mode The mode type
20210 * Flips the front and back contents using the @p mode animation. This
20211 * efectively hides the currently visible content and shows the hidden one.
20213 * There a number of possible animations to use for the flipping:
20214 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20215 * around a horizontal axis in the middle of its height, the other content
20216 * is shown as the other side of the flip.
20217 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20218 * around a vertical axis in the middle of its width, the other content is
20219 * shown as the other side of the flip.
20220 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20221 * around a diagonal axis in the middle of its width, the other content is
20222 * shown as the other side of the flip.
20223 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20224 * around a diagonal axis in the middle of its height, the other content is
20225 * shown as the other side of the flip.
20226 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20227 * as if the flip was a cube, the other content is show as the right face of
20229 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20230 * right as if the flip was a cube, the other content is show as the left
20231 * face of the cube.
20232 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20233 * flip was a cube, the other content is show as the bottom face of the cube.
20234 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20235 * the flip was a cube, the other content is show as the upper face of the
20237 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20238 * if the flip was a book, the other content is shown as the page below that.
20239 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20240 * as if the flip was a book, the other content is shown as the page below
20242 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20243 * flip was a book, the other content is shown as the page below that.
20244 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20245 * flip was a book, the other content is shown as the page below that.
20247 * @image html elm_flip.png
20248 * @image latex elm_flip.eps width=\textwidth
20250 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20252 * @brief Set the interactive flip mode
20254 * @param obj The flip object
20255 * @param mode The interactive flip mode to use
20257 * This sets if the flip should be interactive (allow user to click and
20258 * drag a side of the flip to reveal the back page and cause it to flip).
20259 * By default a flip is not interactive. You may also need to set which
20260 * sides of the flip are "active" for flipping and how much space they use
20261 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20262 * and elm_flip_interacton_direction_hitsize_set()
20264 * The four avilable mode of interaction are:
20265 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20266 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20267 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20268 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20270 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20271 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20272 * happen, those can only be acheived with elm_flip_go();
20274 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20276 * @brief Get the interactive flip mode
20278 * @param obj The flip object
20279 * @return The interactive flip mode
20281 * Returns the interactive flip mode set by elm_flip_interaction_set()
20283 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20285 * @brief Set which directions of the flip respond to interactive flip
20287 * @param obj The flip object
20288 * @param dir The direction to change
20289 * @param enabled If that direction is enabled or not
20291 * By default all directions are disabled, so you may want to enable the
20292 * desired directions for flipping if you need interactive flipping. You must
20293 * call this function once for each direction that should be enabled.
20295 * @see elm_flip_interaction_set()
20297 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20299 * @brief Get the enabled state of that flip direction
20301 * @param obj The flip object
20302 * @param dir The direction to check
20303 * @return If that direction is enabled or not
20305 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20307 * @see elm_flip_interaction_set()
20309 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20311 * @brief Set the amount of the flip that is sensitive to interactive flip
20313 * @param obj The flip object
20314 * @param dir The direction to modify
20315 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20317 * Set the amount of the flip that is sensitive to interactive flip, with 0
20318 * representing no area in the flip and 1 representing the entire flip. There
20319 * is however a consideration to be made in that the area will never be
20320 * smaller than the finger size set(as set in your Elementary configuration).
20322 * @see elm_flip_interaction_set()
20324 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20326 * @brief Get the amount of the flip that is sensitive to interactive flip
20328 * @param obj The flip object
20329 * @param dir The direction to check
20330 * @return The size set for that direction
20332 * Returns the amount os sensitive area set by
20333 * elm_flip_interacton_direction_hitsize_set().
20335 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20340 /* scrolledentry */
20341 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20342 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20343 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20344 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20345 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20346 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20347 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20348 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20349 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20350 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20351 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20352 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20353 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20354 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20355 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20356 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20357 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20358 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20359 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20360 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20361 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20362 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20363 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20364 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20365 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20366 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20367 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20368 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20369 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20370 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20371 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20372 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20373 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20374 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20375 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20376 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);
20377 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20378 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20379 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);
20380 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20381 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);
20382 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20383 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20384 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20385 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20386 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20387 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20388 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20389 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20390 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);
20391 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);
20392 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);
20393 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);
20394 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);
20395 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);
20396 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20397 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20398 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20399 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20400 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20401 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20402 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20405 * @defgroup Conformant Conformant
20406 * @ingroup Elementary
20408 * @image html img/widget/conformant/preview-00.png
20409 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20411 * @image html img/conformant.png
20412 * @image latex img/conformant.eps width=\textwidth
20414 * The aim is to provide a widget that can be used in elementary apps to
20415 * account for space taken up by the indicator, virtual keypad & softkey
20416 * windows when running the illume2 module of E17.
20418 * So conformant content will be sized and positioned considering the
20419 * space required for such stuff, and when they popup, as a keyboard
20420 * shows when an entry is selected, conformant content won't change.
20422 * Available styles for it:
20425 * See how to use this widget in this example:
20426 * @ref conformant_example
20430 * @addtogroup Conformant
20435 * Add a new conformant widget to the given parent Elementary
20436 * (container) object.
20438 * @param parent The parent object.
20439 * @return A new conformant widget handle or @c NULL, on errors.
20441 * This function inserts a new conformant widget on the canvas.
20443 * @ingroup Conformant
20445 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20448 * Set the content of the conformant widget.
20450 * @param obj The conformant object.
20451 * @param content The content to be displayed by the conformant.
20453 * Content will be sized and positioned considering the space required
20454 * to display a virtual keyboard. So it won't fill all the conformant
20455 * size. This way is possible to be sure that content won't resize
20456 * or be re-positioned after the keyboard is displayed.
20458 * Once the content object is set, a previously set one will be deleted.
20459 * If you want to keep that old content object, use the
20460 * elm_conformat_content_unset() function.
20462 * @see elm_conformant_content_unset()
20463 * @see elm_conformant_content_get()
20465 * @ingroup Conformant
20467 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20470 * Get the content of the conformant widget.
20472 * @param obj The conformant object.
20473 * @return The content that is being used.
20475 * Return the content object which is set for this widget.
20476 * It won't be unparent from conformant. For that, use
20477 * elm_conformant_content_unset().
20479 * @see elm_conformant_content_set() for more details.
20480 * @see elm_conformant_content_unset()
20482 * @ingroup Conformant
20484 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20487 * Unset the content of the conformant widget.
20489 * @param obj The conformant object.
20490 * @return The content that was being used.
20492 * Unparent and return the content object which was set for this widget.
20494 * @see elm_conformant_content_set() for more details.
20496 * @ingroup Conformant
20498 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20501 * Returns the Evas_Object that represents the content area.
20503 * @param obj The conformant object.
20504 * @return The content area of the widget.
20506 * @ingroup Conformant
20508 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20515 * @defgroup Mapbuf Mapbuf
20516 * @ingroup Elementary
20518 * @image html img/widget/mapbuf/preview-00.png
20519 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20521 * This holds one content object and uses an Evas Map of transformation
20522 * points to be later used with this content. So the content will be
20523 * moved, resized, etc as a single image. So it will improve performance
20524 * when you have a complex interafce, with a lot of elements, and will
20525 * need to resize or move it frequently (the content object and its
20528 * See how to use this widget in this example:
20529 * @ref mapbuf_example
20533 * @addtogroup Mapbuf
20538 * Add a new mapbuf widget to the given parent Elementary
20539 * (container) object.
20541 * @param parent The parent object.
20542 * @return A new mapbuf widget handle or @c NULL, on errors.
20544 * This function inserts a new mapbuf widget on the canvas.
20548 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20551 * Set the content of the mapbuf.
20553 * @param obj The mapbuf object.
20554 * @param content The content that will be filled in this mapbuf object.
20556 * Once the content object is set, a previously set one will be deleted.
20557 * If you want to keep that old content object, use the
20558 * elm_mapbuf_content_unset() function.
20560 * To enable map, elm_mapbuf_enabled_set() should be used.
20564 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20567 * Get the content of the mapbuf.
20569 * @param obj The mapbuf object.
20570 * @return The content that is being used.
20572 * Return the content object which is set for this widget.
20574 * @see elm_mapbuf_content_set() for details.
20578 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20581 * Unset the content of the mapbuf.
20583 * @param obj The mapbuf object.
20584 * @return The content that was being used.
20586 * Unparent and return the content object which was set for this widget.
20588 * @see elm_mapbuf_content_set() for details.
20592 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20595 * Enable or disable the map.
20597 * @param obj The mapbuf object.
20598 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20600 * This enables the map that is set or disables it. On enable, the object
20601 * geometry will be saved, and the new geometry will change (position and
20602 * size) to reflect the map geometry set.
20604 * Also, when enabled, alpha and smooth states will be used, so if the
20605 * content isn't solid, alpha should be enabled, for example, otherwise
20606 * a black retangle will fill the content.
20608 * When disabled, the stored map will be freed and geometry prior to
20609 * enabling the map will be restored.
20611 * It's disabled by default.
20613 * @see elm_mapbuf_alpha_set()
20614 * @see elm_mapbuf_smooth_set()
20618 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20621 * Get a value whether map is enabled or not.
20623 * @param obj The mapbuf object.
20624 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20625 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20627 * @see elm_mapbuf_enabled_set() for details.
20631 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20634 * Enable or disable smooth map rendering.
20636 * @param obj The mapbuf object.
20637 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20640 * This sets smoothing for map rendering. If the object is a type that has
20641 * its own smoothing settings, then both the smooth settings for this object
20642 * and the map must be turned off.
20644 * By default smooth maps are enabled.
20648 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20651 * Get a value whether smooth map rendering is enabled or not.
20653 * @param obj The mapbuf object.
20654 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20655 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20657 * @see elm_mapbuf_smooth_set() for details.
20661 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20664 * Set or unset alpha flag for map rendering.
20666 * @param obj The mapbuf object.
20667 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20670 * This sets alpha flag for map rendering. If the object is a type that has
20671 * its own alpha settings, then this will take precedence. Only image objects
20672 * have this currently. It stops alpha blending of the map area, and is
20673 * useful if you know the object and/or all sub-objects is 100% solid.
20675 * Alpha is enabled by default.
20679 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20682 * Get a value whether alpha blending is enabled or not.
20684 * @param obj The mapbuf object.
20685 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20686 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20688 * @see elm_mapbuf_alpha_set() for details.
20692 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20699 * @defgroup Flipselector Flip Selector
20701 * @image html img/widget/flipselector/preview-00.png
20702 * @image latex img/widget/flipselector/preview-00.eps
20704 * A flip selector is a widget to show a set of @b text items, one
20705 * at a time, with the same sheet switching style as the @ref Clock
20706 * "clock" widget, when one changes the current displaying sheet
20707 * (thus, the "flip" in the name).
20709 * User clicks to flip sheets which are @b held for some time will
20710 * make the flip selector to flip continuosly and automatically for
20711 * the user. The interval between flips will keep growing in time,
20712 * so that it helps the user to reach an item which is distant from
20713 * the current selection.
20715 * Smart callbacks one can register to:
20716 * - @c "selected" - when the widget's selected text item is changed
20717 * - @c "overflowed" - when the widget's current selection is changed
20718 * from the first item in its list to the last
20719 * - @c "underflowed" - when the widget's current selection is changed
20720 * from the last item in its list to the first
20722 * Available styles for it:
20725 * Here is an example on its usage:
20726 * @li @ref flipselector_example
20730 * @addtogroup Flipselector
20734 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20737 * Add a new flip selector widget to the given parent Elementary
20738 * (container) widget
20740 * @param parent The parent object
20741 * @return a new flip selector widget handle or @c NULL, on errors
20743 * This function inserts a new flip selector widget on the canvas.
20745 * @ingroup Flipselector
20747 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20750 * Programmatically select the next item of a flip selector widget
20752 * @param obj The flipselector object
20754 * @note The selection will be animated. Also, if it reaches the
20755 * end of its list of member items, it will continue with the first
20758 * @ingroup Flipselector
20760 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20763 * Programmatically select the previous item of a flip selector
20766 * @param obj The flipselector object
20768 * @note The selection will be animated. Also, if it reaches the
20769 * beginning of its list of member items, it will continue with the
20770 * last one backwards.
20772 * @ingroup Flipselector
20774 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20777 * Append a (text) item to a flip selector widget
20779 * @param obj The flipselector object
20780 * @param label The (text) label of the new item
20781 * @param func Convenience callback function to take place when
20783 * @param data Data passed to @p func, above
20784 * @return A handle to the item added or @c NULL, on errors
20786 * The widget's list of labels to show will be appended with the
20787 * given value. If the user wishes so, a callback function pointer
20788 * can be passed, which will get called when this same item is
20791 * @note The current selection @b won't be modified by appending an
20792 * element to the list.
20794 * @note The maximum length of the text label is going to be
20795 * determined <b>by the widget's theme</b>. Strings larger than
20796 * that value are going to be @b truncated.
20798 * @ingroup Flipselector
20800 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20803 * Prepend a (text) item to a flip selector widget
20805 * @param obj The flipselector object
20806 * @param label The (text) label of the new item
20807 * @param func Convenience callback function to take place when
20809 * @param data Data passed to @p func, above
20810 * @return A handle to the item added or @c NULL, on errors
20812 * The widget's list of labels to show will be prepended with the
20813 * given value. If the user wishes so, a callback function pointer
20814 * can be passed, which will get called when this same item is
20817 * @note The current selection @b won't be modified by prepending
20818 * an element to the list.
20820 * @note The maximum length of the text label is going to be
20821 * determined <b>by the widget's theme</b>. Strings larger than
20822 * that value are going to be @b truncated.
20824 * @ingroup Flipselector
20826 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20829 * Get the internal list of items in a given flip selector widget.
20831 * @param obj The flipselector object
20832 * @return The list of items (#Elm_Flipselector_Item as data) or
20833 * @c NULL on errors.
20835 * This list is @b not to be modified in any way and must not be
20836 * freed. Use the list members with functions like
20837 * elm_flipselector_item_label_set(),
20838 * elm_flipselector_item_label_get(),
20839 * elm_flipselector_item_del(),
20840 * elm_flipselector_item_selected_get(),
20841 * elm_flipselector_item_selected_set().
20843 * @warning This list is only valid until @p obj object's internal
20844 * items list is changed. It should be fetched again with another
20845 * call to this function when changes happen.
20847 * @ingroup Flipselector
20849 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852 * Get the first item in the given flip selector widget's list of
20855 * @param obj The flipselector object
20856 * @return The first item or @c NULL, if it has no items (and on
20859 * @see elm_flipselector_item_append()
20860 * @see elm_flipselector_last_item_get()
20862 * @ingroup Flipselector
20864 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20867 * Get the last item in the given flip selector widget's list of
20870 * @param obj The flipselector object
20871 * @return The last item or @c NULL, if it has no items (and on
20874 * @see elm_flipselector_item_prepend()
20875 * @see elm_flipselector_first_item_get()
20877 * @ingroup Flipselector
20879 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20882 * Get the currently selected item in a flip selector widget.
20884 * @param obj The flipselector object
20885 * @return The selected item or @c NULL, if the widget has no items
20888 * @ingroup Flipselector
20890 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20893 * Set whether a given flip selector widget's item should be the
20894 * currently selected one.
20896 * @param item The flip selector item
20897 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20899 * This sets whether @p item is or not the selected (thus, under
20900 * display) one. If @p item is different than one under display,
20901 * the latter will be unselected. If the @p item is set to be
20902 * unselected, on the other hand, the @b first item in the widget's
20903 * internal members list will be the new selected one.
20905 * @see elm_flipselector_item_selected_get()
20907 * @ingroup Flipselector
20909 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20912 * Get whether a given flip selector widget's item is the currently
20915 * @param item The flip selector item
20916 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20919 * @see elm_flipselector_item_selected_set()
20921 * @ingroup Flipselector
20923 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20926 * Delete a given item from a flip selector widget.
20928 * @param item The item to delete
20930 * @ingroup Flipselector
20932 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20935 * Get the label of a given flip selector widget's item.
20937 * @param item The item to get label from
20938 * @return The text label of @p item or @c NULL, on errors
20940 * @see elm_flipselector_item_label_set()
20942 * @ingroup Flipselector
20944 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20947 * Set the label of a given flip selector widget's item.
20949 * @param item The item to set label on
20950 * @param label The text label string, in UTF-8 encoding
20952 * @see elm_flipselector_item_label_get()
20954 * @ingroup Flipselector
20956 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
20959 * Gets the item before @p item in a flip selector widget's
20960 * internal list of items.
20962 * @param item The item to fetch previous from
20963 * @return The item before the @p item, in its parent's list. If
20964 * there is no previous item for @p item or there's an
20965 * error, @c NULL is returned.
20967 * @see elm_flipselector_item_next_get()
20969 * @ingroup Flipselector
20971 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20974 * Gets the item after @p item in a flip selector widget's
20975 * internal list of items.
20977 * @param item The item to fetch next from
20978 * @return The item after the @p item, in its parent's list. If
20979 * there is no next item for @p item or there's an
20980 * error, @c NULL is returned.
20982 * @see elm_flipselector_item_next_get()
20984 * @ingroup Flipselector
20986 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20989 * Set the interval on time updates for an user mouse button hold
20990 * on a flip selector widget.
20992 * @param obj The flip selector object
20993 * @param interval The (first) interval value in seconds
20995 * This interval value is @b decreased while the user holds the
20996 * mouse pointer either flipping up or flipping doww a given flip
20999 * This helps the user to get to a given item distant from the
21000 * current one easier/faster, as it will start to flip quicker and
21001 * quicker on mouse button holds.
21003 * The calculation for the next flip interval value, starting from
21004 * the one set with this call, is the previous interval divided by
21005 * 1.05, so it decreases a little bit.
21007 * The default starting interval value for automatic flips is
21010 * @see elm_flipselector_interval_get()
21012 * @ingroup Flipselector
21014 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21017 * Get the interval on time updates for an user mouse button hold
21018 * on a flip selector widget.
21020 * @param obj The flip selector object
21021 * @return The (first) interval value, in seconds, set on it
21023 * @see elm_flipselector_interval_set() for more details
21025 * @ingroup Flipselector
21027 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21034 * @addtogroup Animator Animator
21035 * @ingroup Elementary
21037 * @brief Functions to ease creation of animations.
21039 * elm_animator is designed to provide an easy way to create animations.
21040 * Creating an animation with elm_animator is as simple as setting a
21041 * duration, an operating callback and telling it to run the animation.
21042 * However that is not the full extent of elm_animator's ability, animations
21043 * can be paused and resumed, reversed and the animation need not be linear.
21045 * To run an animation you must specify at least a duration and operation
21046 * callback, not setting any other properties will create a linear animation
21047 * that runs once and is not reversed.
21049 * @ref elm_animator_example_page_01 "This" example should make all of that
21052 * @warning elm_animator is @b not a widget.
21056 * @brief Type of curve desired for animation.
21058 * The speed in which an animation happens doesn't have to be linear, some
21059 * animations will look better if they're accelerating or decelerating, so
21060 * elm_animator provides four options in this regard:
21062 * @image html elm_animator_curve_style.png
21063 * @image latex elm_animator_curve_style.eps width=\textwidth
21064 * As can be seen in the image the speed of the animation will be:
21065 * @li ELM_ANIMATOR_CURVE_LINEAR constant
21066 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21067 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21068 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21072 ELM_ANIMATOR_CURVE_LINEAR,
21073 ELM_ANIMATOR_CURVE_IN_OUT,
21074 ELM_ANIMATOR_CURVE_IN,
21075 ELM_ANIMATOR_CURVE_OUT
21076 } Elm_Animator_Curve_Style;
21077 typedef struct _Elm_Animator Elm_Animator;
21079 * Called back per loop of an elementary animators cycle
21080 * @param data user-data given to elm_animator_operation_callback_set()
21081 * @param animator the animator being run
21082 * @param double the position in the animation
21084 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21086 * Called back when an elementary animator finishes
21087 * @param data user-data given to elm_animator_completion_callback_set()
21089 typedef void (*Elm_Animator_Completion_Cb) (void *data);
21092 * @brief Create a new animator.
21094 * @param[in] parent Parent object
21096 * The @a parent argument can be set to NULL for no parent. If a parent is set
21097 * there is no need to call elm_animator_del(), when the parent is deleted it
21098 * will delete the animator.
21099 * @deprecated Use @ref Transit instead.
21101 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
21103 * Deletes the animator freeing any resources it used. If the animator was
21104 * created with a NULL parent this must be called, otherwise it will be
21105 * automatically called when the parent is deleted.
21107 * @param[in] animator Animator object
21108 * @deprecated Use @ref Transit instead.
21110 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21112 * Set the duration of the animation.
21114 * @param[in] animator Animator object
21115 * @param[in] duration Duration in second
21116 * @deprecated Use @ref Transit instead.
21118 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21120 * @brief Set the callback function for animator operation.
21122 * @param[in] animator Animator object
21123 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21124 * @param[in] data Callback function user argument
21126 * The @p func callback will be called with a frame value in range [0, 1] which
21127 * indicates how far along the animation should be. It is the job of @p func to
21128 * actually change the state of any object(or objects) that are being animated.
21129 * @deprecated Use @ref Transit instead.
21131 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21133 * Set the callback function for the when the animation ends.
21135 * @param[in] animator Animator object
21136 * @param[in] func Callback function pointe
21137 * @param[in] data Callback function user argument
21139 * @warning @a func will not be executed if elm_animator_stop() is called.
21140 * @deprecated Use @ref Transit instead.
21142 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21144 * @brief Stop animator.
21146 * @param[in] animator Animator object
21148 * If called before elm_animator_animate() it does nothing. If there is an
21149 * animation in progress the animation will be stopped(the operation callback
21150 * will not be executed again) and it can't be restarted using
21151 * elm_animator_resume().
21152 * @deprecated Use @ref Transit instead.
21154 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21156 * Set the animator repeat count.
21158 * @param[in] animator Animator object
21159 * @param[in] repeat_cnt Repeat count
21160 * @deprecated Use @ref Transit instead.
21162 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21164 * @brief Start animation.
21166 * @param[in] animator Animator object
21168 * This function starts the animation if the nescessary properties(duration
21169 * and operation callback) have been set. Once started the animation will
21170 * run until complete or elm_animator_stop() is called.
21171 * @deprecated Use @ref Transit instead.
21173 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21175 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21177 * @param[in] animator Animator object
21178 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21179 * @deprecated Use @ref Transit instead.
21181 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21183 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21185 * @param[in] animator Animator object
21186 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21187 * @deprecated Use @ref Transit instead.
21189 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21191 * @brief Sets wether the animation should be automatically reversed.
21193 * @param[in] animator Animator object
21194 * @param[in] reverse Reverse or not
21196 * This controls wether the animation will be run on reverse imediately after
21197 * running forward. When this is set together with repetition the animation
21198 * will run in reverse once for each time it ran forward.@n
21199 * Runnin an animation in reverse is accomplished by calling the operation
21200 * callback with a frame value starting at 1 and diminshing until 0.
21201 * @deprecated Use @ref Transit instead.
21203 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21205 * Gets wether the animation will automatically reversed
21207 * @param[in] animator Animator object
21208 * @deprecated Use @ref Transit instead.
21210 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21212 * Gets the status for the animator operation. The status of the animator @b
21213 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21214 * only informs if the animation was started and has not ended(either normally
21215 * or through elm_animator_stop()).
21217 * @param[in] animator Animator object
21218 * @deprecated Use @ref Transit instead.
21220 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21222 * Gets how many times the animation will be repeated
21224 * @param[in] animator Animator object
21225 * @deprecated Use @ref Transit instead.
21227 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21229 * Pause the animator.
21231 * @param[in] animator Animator object
21233 * This causes the animation to be temporarily stopped(the operation callback
21234 * will not be called). If the animation is not yet running this is a no-op.
21235 * Once an animation has been paused with this function it can be resumed
21236 * using elm_animator_resume().
21237 * @deprecated Use @ref Transit instead.
21239 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21241 * @brief Resumes the animator.
21243 * @param[in] animator Animator object
21245 * Resumes an animation that was paused using elm_animator_pause(), after
21246 * calling this function calls to the operation callback will happen
21247 * normally. If an animation is stopped by means of elm_animator_stop it
21248 * @b can't be restarted with this function.@n
21250 * @warning When an animation is resumed it doesn't start from where it was paused, it
21251 * will go to where it would have been if it had not been paused. If an
21252 * animation with a duration of 3 seconds is paused after 1 second for 1 second
21253 * it will resume as if it had ben animating for 2 seconds, the operating
21254 * callback will be called with a frame value of aproximately 2/3.
21255 * @deprecated Use @ref Transit instead.
21257 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21263 * @defgroup Calendar Calendar
21264 * @ingroup Elementary
21266 * @image html img/widget/calendar/preview-00.png
21267 * @image latex img/widget/calendar/preview-00.eps
21269 * A calendar is a widget that displays a regular calendar, one
21270 * month at a time, to the user, and can allows the user to select a date.
21272 * It has support to adding check marks (holidays and checks are supported
21273 * by default theme).
21275 * Weekday names and the function used to format month and year to
21276 * be displayed can be set, giving more flexibility to this widget.
21278 * Smart callbacks one can register to:
21279 * - "changed" - emitted when the user selects a day or changes the
21280 * displayed month, what actually changes the selected day as well.
21282 * Available styles for it:
21285 * List of examples:
21286 * @li @ref calendar_example_01
21287 * @li @ref calendar_example_02
21288 * @li @ref calendar_example_03
21289 * @li @ref calendar_example_04
21290 * @li @ref calendar_example_05
21291 * @li @ref calendar_example_06
21295 * @addtogroup Calendar
21300 * @enum _Elm_Calendar_Mark_Repeat
21301 * @typedef Elm_Calendar_Mark_Repeat
21303 * Event periodicity, used to define if a mark should be repeated
21304 * @b beyond event's day. It's set when a mark is added.
21306 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21307 * there will be marks every week after this date. Marks will be displayed
21308 * at 13th, 20th, 27th, 3rd June ...
21310 * Values don't work as bitmask, only one can be choosen.
21312 * @see elm_calendar_mark_add()
21314 * @ingroup Calendar
21316 typedef enum _Elm_Calendar_Mark_Repeat
21318 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21319 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21320 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21321 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*/
21322 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. */
21323 } Elm_Calendar_Mark_Repeat;
21325 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(). */
21328 * Add a new calendar widget to the given parent Elementary
21329 * (container) object.
21331 * @param parent The parent object.
21332 * @return a new calendar widget handle or @c NULL, on errors.
21334 * This function inserts a new calendar widget on the canvas.
21336 * @ref calendar_example_01
21338 * @ingroup Calendar
21340 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21343 * Get weekdays names displayed by the calendar.
21345 * @param obj The calendar object.
21346 * @return Array of seven strings to be used as weekday names.
21348 * By default, weekdays abbreviations get from system are displayed:
21349 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21350 * The first string is related to Sunday, the second to Monday...
21352 * @see elm_calendar_weekdays_name_set()
21354 * @ref calendar_example_05
21356 * @ingroup Calendar
21358 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21361 * Set weekdays names to be displayed by the calendar.
21363 * @param obj The calendar object.
21364 * @param weekdays Array of seven strings to be used as weekday names.
21365 * @warning It must have 7 elements, or it will access invalid memory.
21366 * @warning The strings must be NULL terminated ('@\0').
21368 * By default, weekdays abbreviations get from system are displayed:
21369 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21371 * The first string should be related to Sunday, the second to Monday...
21373 * The usage should be like this:
21375 * const char *weekdays[] =
21377 * "Sunday", "Monday", "Tuesday", "Wednesday",
21378 * "Thursday", "Friday", "Saturday"
21380 * elm_calendar_weekdays_names_set(calendar, weekdays);
21383 * @see elm_calendar_weekdays_name_get()
21385 * @ref calendar_example_02
21387 * @ingroup Calendar
21389 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21392 * Set the minimum and maximum values for the year
21394 * @param obj The calendar object
21395 * @param min The minimum year, greater than 1901;
21396 * @param max The maximum year;
21398 * Maximum must be greater than minimum, except if you don't wan't to set
21400 * Default values are 1902 and -1.
21402 * If the maximum year is a negative value, it will be limited depending
21403 * on the platform architecture (year 2037 for 32 bits);
21405 * @see elm_calendar_min_max_year_get()
21407 * @ref calendar_example_03
21409 * @ingroup Calendar
21411 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21414 * Get the minimum and maximum values for the year
21416 * @param obj The calendar object.
21417 * @param min The minimum year.
21418 * @param max The maximum year.
21420 * Default values are 1902 and -1.
21422 * @see elm_calendar_min_max_year_get() for more details.
21424 * @ref calendar_example_05
21426 * @ingroup Calendar
21428 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21431 * Enable or disable day selection
21433 * @param obj The calendar object.
21434 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21437 * Enabled by default. If disabled, the user still can select months,
21438 * but not days. Selected days are highlighted on calendar.
21439 * It should be used if you won't need such selection for the widget usage.
21441 * When a day is selected, or month is changed, smart callbacks for
21442 * signal "changed" will be called.
21444 * @see elm_calendar_day_selection_enable_get()
21446 * @ref calendar_example_04
21448 * @ingroup Calendar
21450 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21453 * Get a value whether day selection is enabled or not.
21455 * @see elm_calendar_day_selection_enable_set() for details.
21457 * @param obj The calendar object.
21458 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21459 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21461 * @ref calendar_example_05
21463 * @ingroup Calendar
21465 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21469 * Set selected date to be highlighted on calendar.
21471 * @param obj The calendar object.
21472 * @param selected_time A @b tm struct to represent the selected date.
21474 * Set the selected date, changing the displayed month if needed.
21475 * Selected date changes when the user goes to next/previous month or
21476 * select a day pressing over it on calendar.
21478 * @see elm_calendar_selected_time_get()
21480 * @ref calendar_example_04
21482 * @ingroup Calendar
21484 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21487 * Get selected date.
21489 * @param obj The calendar object
21490 * @param selected_time A @b tm struct to point to selected date
21491 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21494 * Get date selected by the user or set by function
21495 * elm_calendar_selected_time_set().
21496 * Selected date changes when the user goes to next/previous month or
21497 * select a day pressing over it on calendar.
21499 * @see elm_calendar_selected_time_get()
21501 * @ref calendar_example_05
21503 * @ingroup Calendar
21505 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21508 * Set a function to format the string that will be used to display
21511 * @param obj The calendar object
21512 * @param format_function Function to set the month-year string given
21513 * the selected date
21515 * By default it uses strftime with "%B %Y" format string.
21516 * It should allocate the memory that will be used by the string,
21517 * that will be freed by the widget after usage.
21518 * A pointer to the string and a pointer to the time struct will be provided.
21523 * _format_month_year(struct tm *selected_time)
21526 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21527 * return strdup(buf);
21530 * elm_calendar_format_function_set(calendar, _format_month_year);
21533 * @ref calendar_example_02
21535 * @ingroup Calendar
21537 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21540 * Add a new mark to the calendar
21542 * @param obj The calendar object
21543 * @param mark_type A string used to define the type of mark. It will be
21544 * emitted to the theme, that should display a related modification on these
21545 * days representation.
21546 * @param mark_time A time struct to represent the date of inclusion of the
21547 * mark. For marks that repeats it will just be displayed after the inclusion
21548 * date in the calendar.
21549 * @param repeat Repeat the event following this periodicity. Can be a unique
21550 * mark (that don't repeat), daily, weekly, monthly or annually.
21551 * @return The created mark or @p NULL upon failure.
21553 * Add a mark that will be drawn in the calendar respecting the insertion
21554 * time and periodicity. It will emit the type as signal to the widget theme.
21555 * Default theme supports "holiday" and "checked", but it can be extended.
21557 * It won't immediately update the calendar, drawing the marks.
21558 * For this, call elm_calendar_marks_draw(). However, when user selects
21559 * next or previous month calendar forces marks drawn.
21561 * Marks created with this method can be deleted with
21562 * elm_calendar_mark_del().
21566 * struct tm selected_time;
21567 * time_t current_time;
21569 * current_time = time(NULL) + 5 * 84600;
21570 * localtime_r(¤t_time, &selected_time);
21571 * elm_calendar_mark_add(cal, "holiday", selected_time,
21572 * ELM_CALENDAR_ANNUALLY);
21574 * current_time = time(NULL) + 1 * 84600;
21575 * localtime_r(¤t_time, &selected_time);
21576 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21578 * elm_calendar_marks_draw(cal);
21581 * @see elm_calendar_marks_draw()
21582 * @see elm_calendar_mark_del()
21584 * @ref calendar_example_06
21586 * @ingroup Calendar
21588 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);
21591 * Delete mark from the calendar.
21593 * @param mark The mark to be deleted.
21595 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21596 * should be used instead of getting marks list and deleting each one.
21598 * @see elm_calendar_mark_add()
21600 * @ref calendar_example_06
21602 * @ingroup Calendar
21604 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21607 * Remove all calendar's marks
21609 * @param obj The calendar object.
21611 * @see elm_calendar_mark_add()
21612 * @see elm_calendar_mark_del()
21614 * @ingroup Calendar
21616 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21620 * Get a list of all the calendar marks.
21622 * @param obj The calendar object.
21623 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21625 * @see elm_calendar_mark_add()
21626 * @see elm_calendar_mark_del()
21627 * @see elm_calendar_marks_clear()
21629 * @ingroup Calendar
21631 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21634 * Draw calendar marks.
21636 * @param obj The calendar object.
21638 * Should be used after adding, removing or clearing marks.
21639 * It will go through the entire marks list updating the calendar.
21640 * If lots of marks will be added, add all the marks and then call
21643 * When the month is changed, i.e. user selects next or previous month,
21644 * marks will be drawed.
21646 * @see elm_calendar_mark_add()
21647 * @see elm_calendar_mark_del()
21648 * @see elm_calendar_marks_clear()
21650 * @ref calendar_example_06
21652 * @ingroup Calendar
21654 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21657 * Set a day text color to the same that represents Saturdays.
21659 * @param obj The calendar object.
21660 * @param pos The text position. Position is the cell counter, from left
21661 * to right, up to down. It starts on 0 and ends on 41.
21663 * @deprecated use elm_calendar_mark_add() instead like:
21666 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21667 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21670 * @see elm_calendar_mark_add()
21672 * @ingroup Calendar
21674 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21677 * Set a day text color to the same that represents Sundays.
21679 * @param obj The calendar object.
21680 * @param pos The text position. Position is the cell counter, from left
21681 * to right, up to down. It starts on 0 and ends on 41.
21683 * @deprecated use elm_calendar_mark_add() instead like:
21686 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21687 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21690 * @see elm_calendar_mark_add()
21692 * @ingroup Calendar
21694 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21697 * Set a day text color to the same that represents Weekdays.
21699 * @param obj The calendar object
21700 * @param pos The text position. Position is the cell counter, from left
21701 * to right, up to down. It starts on 0 and ends on 41.
21703 * @deprecated use elm_calendar_mark_add() instead like:
21706 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21708 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21709 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21710 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21711 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21712 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21713 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21714 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21715 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21716 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21719 * @see elm_calendar_mark_add()
21721 * @ingroup Calendar
21723 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21726 * Set the interval on time updates for an user mouse button hold
21727 * on calendar widgets' month selection.
21729 * @param obj The calendar object
21730 * @param interval The (first) interval value in seconds
21732 * This interval value is @b decreased while the user holds the
21733 * mouse pointer either selecting next or previous month.
21735 * This helps the user to get to a given month distant from the
21736 * current one easier/faster, as it will start to change quicker and
21737 * quicker on mouse button holds.
21739 * The calculation for the next change interval value, starting from
21740 * the one set with this call, is the previous interval divided by
21741 * 1.05, so it decreases a little bit.
21743 * The default starting interval value for automatic changes is
21746 * @see elm_calendar_interval_get()
21748 * @ingroup Calendar
21750 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21753 * Get the interval on time updates for an user mouse button hold
21754 * on calendar widgets' month selection.
21756 * @param obj The calendar object
21757 * @return The (first) interval value, in seconds, set on it
21759 * @see elm_calendar_interval_set() for more details
21761 * @ingroup Calendar
21763 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21770 * @defgroup Diskselector Diskselector
21771 * @ingroup Elementary
21773 * @image html img/widget/diskselector/preview-00.png
21774 * @image latex img/widget/diskselector/preview-00.eps
21776 * A diskselector is a kind of list widget. It scrolls horizontally,
21777 * and can contain label and icon objects. Three items are displayed
21778 * with the selected one in the middle.
21780 * It can act like a circular list with round mode and labels can be
21781 * reduced for a defined length for side items.
21783 * Smart callbacks one can listen to:
21784 * - "selected" - when item is selected, i.e. scroller stops.
21786 * Available styles for it:
21789 * List of examples:
21790 * @li @ref diskselector_example_01
21791 * @li @ref diskselector_example_02
21795 * @addtogroup Diskselector
21799 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(). */
21802 * Add a new diskselector widget to the given parent Elementary
21803 * (container) object.
21805 * @param parent The parent object.
21806 * @return a new diskselector widget handle or @c NULL, on errors.
21808 * This function inserts a new diskselector widget on the canvas.
21810 * @ingroup Diskselector
21812 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21815 * Enable or disable round mode.
21817 * @param obj The diskselector object.
21818 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21821 * Disabled by default. If round mode is enabled the items list will
21822 * work like a circle list, so when the user reaches the last item,
21823 * the first one will popup.
21825 * @see elm_diskselector_round_get()
21827 * @ingroup Diskselector
21829 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21832 * Get a value whether round mode is enabled or not.
21834 * @see elm_diskselector_round_set() for details.
21836 * @param obj The diskselector object.
21837 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21838 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21840 * @ingroup Diskselector
21842 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21845 * Get the side labels max length.
21847 * @deprecated use elm_diskselector_side_label_length_get() instead:
21849 * @param obj The diskselector object.
21850 * @return The max length defined for side labels, or 0 if not a valid
21853 * @ingroup Diskselector
21855 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21858 * Set the side labels max length.
21860 * @deprecated use elm_diskselector_side_label_length_set() instead:
21862 * @param obj The diskselector object.
21863 * @param len The max length defined for side labels.
21865 * @ingroup Diskselector
21867 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21870 * Get the side labels max length.
21872 * @see elm_diskselector_side_label_length_set() for details.
21874 * @param obj The diskselector object.
21875 * @return The max length defined for side labels, or 0 if not a valid
21878 * @ingroup Diskselector
21880 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21883 * Set the side labels max length.
21885 * @param obj The diskselector object.
21886 * @param len The max length defined for side labels.
21888 * Length is the number of characters of items' label that will be
21889 * visible when it's set on side positions. It will just crop
21890 * the string after defined size. E.g.:
21892 * An item with label "January" would be displayed on side position as
21893 * "Jan" if max length is set to 3, or "Janu", if this property
21896 * When it's selected, the entire label will be displayed, except for
21897 * width restrictions. In this case label will be cropped and "..."
21898 * will be concatenated.
21900 * Default side label max length is 3.
21902 * This property will be applyed over all items, included before or
21903 * later this function call.
21905 * @ingroup Diskselector
21907 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21910 * Set the number of items to be displayed.
21912 * @param obj The diskselector object.
21913 * @param num The number of items the diskselector will display.
21915 * Default value is 3, and also it's the minimun. If @p num is less
21916 * than 3, it will be set to 3.
21918 * Also, it can be set on theme, using data item @c display_item_num
21919 * on group "elm/diskselector/item/X", where X is style set.
21922 * group { name: "elm/diskselector/item/X";
21924 * item: "display_item_num" "5";
21927 * @ingroup Diskselector
21929 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21932 * Set bouncing behaviour when the scrolled content reaches an edge.
21934 * Tell the internal scroller object whether it should bounce or not
21935 * when it reaches the respective edges for each axis.
21937 * @param obj The diskselector object.
21938 * @param h_bounce Whether to bounce or not in the horizontal axis.
21939 * @param v_bounce Whether to bounce or not in the vertical axis.
21941 * @see elm_scroller_bounce_set()
21943 * @ingroup Diskselector
21945 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21948 * Get the bouncing behaviour of the internal scroller.
21950 * Get whether the internal scroller should bounce when the edge of each
21951 * axis is reached scrolling.
21953 * @param obj The diskselector object.
21954 * @param h_bounce Pointer where to store the bounce state of the horizontal
21956 * @param v_bounce Pointer where to store the bounce state of the vertical
21959 * @see elm_scroller_bounce_get()
21960 * @see elm_diskselector_bounce_set()
21962 * @ingroup Diskselector
21964 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21967 * Get the scrollbar policy.
21969 * @see elm_diskselector_scroller_policy_get() for details.
21971 * @param obj The diskselector object.
21972 * @param policy_h Pointer where to store horizontal scrollbar policy.
21973 * @param policy_v Pointer where to store vertical scrollbar policy.
21975 * @ingroup Diskselector
21977 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);
21980 * Set the scrollbar policy.
21982 * @param obj The diskselector object.
21983 * @param policy_h Horizontal scrollbar policy.
21984 * @param policy_v Vertical scrollbar policy.
21986 * This sets the scrollbar visibility policy for the given scroller.
21987 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
21988 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
21989 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
21990 * This applies respectively for the horizontal and vertical scrollbars.
21992 * The both are disabled by default, i.e., are set to
21993 * #ELM_SCROLLER_POLICY_OFF.
21995 * @ingroup Diskselector
21997 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22000 * Remove all diskselector's items.
22002 * @param obj The diskselector object.
22004 * @see elm_diskselector_item_del()
22005 * @see elm_diskselector_item_append()
22007 * @ingroup Diskselector
22009 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22012 * Get a list of all the diskselector items.
22014 * @param obj The diskselector object.
22015 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22016 * or @c NULL on failure.
22018 * @see elm_diskselector_item_append()
22019 * @see elm_diskselector_item_del()
22020 * @see elm_diskselector_clear()
22022 * @ingroup Diskselector
22024 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22027 * Appends a new item to the diskselector object.
22029 * @param obj The diskselector object.
22030 * @param label The label of the diskselector item.
22031 * @param icon The icon object to use at left side of the item. An
22032 * icon can be any Evas object, but usually it is an icon created
22033 * with elm_icon_add().
22034 * @param func The function to call when the item is selected.
22035 * @param data The data to associate with the item for related callbacks.
22037 * @return The created item or @c NULL upon failure.
22039 * A new item will be created and appended to the diskselector, i.e., will
22040 * be set as last item. Also, if there is no selected item, it will
22041 * be selected. This will always happens for the first appended item.
22043 * If no icon is set, label will be centered on item position, otherwise
22044 * the icon will be placed at left of the label, that will be shifted
22047 * Items created with this method can be deleted with
22048 * elm_diskselector_item_del().
22050 * Associated @p data can be properly freed when item is deleted if a
22051 * callback function is set with elm_diskselector_item_del_cb_set().
22053 * If a function is passed as argument, it will be called everytime this item
22054 * is selected, i.e., the user stops the diskselector with this
22055 * item on center position. If such function isn't needed, just passing
22056 * @c NULL as @p func is enough. The same should be done for @p data.
22058 * Simple example (with no function callback or data associated):
22060 * disk = elm_diskselector_add(win);
22061 * ic = elm_icon_add(win);
22062 * elm_icon_file_set(ic, "path/to/image", NULL);
22063 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22064 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22067 * @see elm_diskselector_item_del()
22068 * @see elm_diskselector_item_del_cb_set()
22069 * @see elm_diskselector_clear()
22070 * @see elm_icon_add()
22072 * @ingroup Diskselector
22074 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);
22078 * Delete them item from the diskselector.
22080 * @param it The item of diskselector to be deleted.
22082 * If deleting all diskselector items is required, elm_diskselector_clear()
22083 * should be used instead of getting items list and deleting each one.
22085 * @see elm_diskselector_clear()
22086 * @see elm_diskselector_item_append()
22087 * @see elm_diskselector_item_del_cb_set()
22089 * @ingroup Diskselector
22091 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22094 * Set the function called when a diskselector item is freed.
22096 * @param it The item to set the callback on
22097 * @param func The function called
22099 * If there is a @p func, then it will be called prior item's memory release.
22100 * That will be called with the following arguments:
22102 * @li item's Evas object;
22105 * This way, a data associated to a diskselector item could be properly
22108 * @ingroup Diskselector
22110 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22113 * Get the data associated to the item.
22115 * @param it The diskselector item
22116 * @return The data associated to @p it
22118 * The return value is a pointer to data associated to @p item when it was
22119 * created, with function elm_diskselector_item_append(). If no data
22120 * was passed as argument, it will return @c NULL.
22122 * @see elm_diskselector_item_append()
22124 * @ingroup Diskselector
22126 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22129 * Set the icon associated to the item.
22131 * @param it The diskselector item
22132 * @param icon The icon object to associate with @p it
22134 * The icon object to use at left side of the item. An
22135 * icon can be any Evas object, but usually it is an icon created
22136 * with elm_icon_add().
22138 * Once the icon object is set, a previously set one will be deleted.
22139 * @warning Setting the same icon for two items will cause the icon to
22140 * dissapear from the first item.
22142 * If an icon was passed as argument on item creation, with function
22143 * elm_diskselector_item_append(), it will be already
22144 * associated to the item.
22146 * @see elm_diskselector_item_append()
22147 * @see elm_diskselector_item_icon_get()
22149 * @ingroup Diskselector
22151 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22154 * Get the icon associated to the item.
22156 * @param it The diskselector item
22157 * @return The icon associated to @p it
22159 * The return value is a pointer to the icon associated to @p item when it was
22160 * created, with function elm_diskselector_item_append(), or later
22161 * with function elm_diskselector_item_icon_set. If no icon
22162 * was passed as argument, it will return @c NULL.
22164 * @see elm_diskselector_item_append()
22165 * @see elm_diskselector_item_icon_set()
22167 * @ingroup Diskselector
22169 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22172 * Set the label of item.
22174 * @param it The item of diskselector.
22175 * @param label The label of item.
22177 * The label to be displayed by the item.
22179 * If no icon is set, label will be centered on item position, otherwise
22180 * the icon will be placed at left of the label, that will be shifted
22183 * An item with label "January" would be displayed on side position as
22184 * "Jan" if max length is set to 3 with function
22185 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22188 * When this @p item is selected, the entire label will be displayed,
22189 * except for width restrictions.
22190 * In this case label will be cropped and "..." will be concatenated,
22191 * but only for display purposes. It will keep the entire string, so
22192 * if diskselector is resized the remaining characters will be displayed.
22194 * If a label was passed as argument on item creation, with function
22195 * elm_diskselector_item_append(), it will be already
22196 * displayed by the item.
22198 * @see elm_diskselector_side_label_lenght_set()
22199 * @see elm_diskselector_item_label_get()
22200 * @see elm_diskselector_item_append()
22202 * @ingroup Diskselector
22204 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22207 * Get the label of item.
22209 * @param it The item of diskselector.
22210 * @return The label of item.
22212 * The return value is a pointer to the label associated to @p item when it was
22213 * created, with function elm_diskselector_item_append(), or later
22214 * with function elm_diskselector_item_label_set. If no label
22215 * was passed as argument, it will return @c NULL.
22217 * @see elm_diskselector_item_label_set() for more details.
22218 * @see elm_diskselector_item_append()
22220 * @ingroup Diskselector
22222 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22225 * Get the selected item.
22227 * @param obj The diskselector object.
22228 * @return The selected diskselector item.
22230 * The selected item can be unselected with function
22231 * elm_diskselector_item_selected_set(), and the first item of
22232 * diskselector will be selected.
22234 * The selected item always will be centered on diskselector, with
22235 * full label displayed, i.e., max lenght set to side labels won't
22236 * apply on the selected item. More details on
22237 * elm_diskselector_side_label_length_set().
22239 * @ingroup Diskselector
22241 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22244 * Set the selected state of an item.
22246 * @param it The diskselector item
22247 * @param selected The selected state
22249 * This sets the selected state of the given item @p it.
22250 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22252 * If a new item is selected the previosly selected will be unselected.
22253 * Previoulsy selected item can be get with function
22254 * elm_diskselector_selected_item_get().
22256 * If the item @p it is unselected, the first item of diskselector will
22259 * Selected items will be visible on center position of diskselector.
22260 * So if it was on another position before selected, or was invisible,
22261 * diskselector will animate items until the selected item reaches center
22264 * @see elm_diskselector_item_selected_get()
22265 * @see elm_diskselector_selected_item_get()
22267 * @ingroup Diskselector
22269 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22272 * Get whether the @p item is selected or not.
22274 * @param it The diskselector item.
22275 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22276 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22278 * @see elm_diskselector_selected_item_set() for details.
22279 * @see elm_diskselector_item_selected_get()
22281 * @ingroup Diskselector
22283 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22286 * Get the first item of the diskselector.
22288 * @param obj The diskselector object.
22289 * @return The first item, or @c NULL if none.
22291 * The list of items follows append order. So it will return the first
22292 * item appended to the widget that wasn't deleted.
22294 * @see elm_diskselector_item_append()
22295 * @see elm_diskselector_items_get()
22297 * @ingroup Diskselector
22299 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22302 * Get the last item of the diskselector.
22304 * @param obj The diskselector object.
22305 * @return The last item, or @c NULL if none.
22307 * The list of items follows append order. So it will return last first
22308 * item appended to the widget that wasn't deleted.
22310 * @see elm_diskselector_item_append()
22311 * @see elm_diskselector_items_get()
22313 * @ingroup Diskselector
22315 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22318 * Get the item before @p item in diskselector.
22320 * @param it The diskselector item.
22321 * @return The item before @p item, or @c NULL if none or on failure.
22323 * The list of items follows append order. So it will return item appended
22324 * just before @p item and that wasn't deleted.
22326 * If it is the first item, @c NULL will be returned.
22327 * First item can be get by elm_diskselector_first_item_get().
22329 * @see elm_diskselector_item_append()
22330 * @see elm_diskselector_items_get()
22332 * @ingroup Diskselector
22334 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22337 * Get the item after @p item in diskselector.
22339 * @param it The diskselector item.
22340 * @return The item after @p item, or @c NULL if none or on failure.
22342 * The list of items follows append order. So it will return item appended
22343 * just after @p item and that wasn't deleted.
22345 * If it is the last item, @c NULL will be returned.
22346 * Last item can be get by elm_diskselector_last_item_get().
22348 * @see elm_diskselector_item_append()
22349 * @see elm_diskselector_items_get()
22351 * @ingroup Diskselector
22353 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22356 * Set the text to be shown in the diskselector item.
22358 * @param item Target item
22359 * @param text The text to set in the content
22361 * Setup the text as tooltip to object. The item can have only one tooltip,
22362 * so any previous tooltip data is removed.
22364 * @see elm_object_tooltip_text_set() for more details.
22366 * @ingroup Diskselector
22368 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22371 * Set the content to be shown in the tooltip item.
22373 * Setup the tooltip to item. The item can have only one tooltip,
22374 * so any previous tooltip data is removed. @p func(with @p data) will
22375 * be called every time that need show the tooltip and it should
22376 * return a valid Evas_Object. This object is then managed fully by
22377 * tooltip system and is deleted when the tooltip is gone.
22379 * @param item the diskselector item being attached a tooltip.
22380 * @param func the function used to create the tooltip contents.
22381 * @param data what to provide to @a func as callback data/context.
22382 * @param del_cb called when data is not needed anymore, either when
22383 * another callback replaces @p func, the tooltip is unset with
22384 * elm_diskselector_item_tooltip_unset() or the owner @a item
22385 * dies. This callback receives as the first parameter the
22386 * given @a data, and @c event_info is the item.
22388 * @see elm_object_tooltip_content_cb_set() for more details.
22390 * @ingroup Diskselector
22392 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);
22395 * Unset tooltip from item.
22397 * @param item diskselector item to remove previously set tooltip.
22399 * Remove tooltip from item. The callback provided as del_cb to
22400 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22401 * it is not used anymore.
22403 * @see elm_object_tooltip_unset() for more details.
22404 * @see elm_diskselector_item_tooltip_content_cb_set()
22406 * @ingroup Diskselector
22408 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22412 * Sets a different style for this item tooltip.
22414 * @note before you set a style you should define a tooltip with
22415 * elm_diskselector_item_tooltip_content_cb_set() or
22416 * elm_diskselector_item_tooltip_text_set()
22418 * @param item diskselector item with tooltip already set.
22419 * @param style the theme style to use (default, transparent, ...)
22421 * @see elm_object_tooltip_style_set() for more details.
22423 * @ingroup Diskselector
22425 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22428 * Get the style for this item tooltip.
22430 * @param item diskselector item with tooltip already set.
22431 * @return style the theme style in use, defaults to "default". If the
22432 * object does not have a tooltip set, then NULL is returned.
22434 * @see elm_object_tooltip_style_get() for more details.
22435 * @see elm_diskselector_item_tooltip_style_set()
22437 * @ingroup Diskselector
22439 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22442 * Set the cursor to be shown when mouse is over the diskselector item
22444 * @param item Target item
22445 * @param cursor the cursor name to be used.
22447 * @see elm_object_cursor_set() for more details.
22449 * @ingroup Diskselector
22451 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22454 * Get the cursor to be shown when mouse is over the diskselector item
22456 * @param item diskselector item with cursor already set.
22457 * @return the cursor name.
22459 * @see elm_object_cursor_get() for more details.
22460 * @see elm_diskselector_cursor_set()
22462 * @ingroup Diskselector
22464 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22468 * Unset the cursor to be shown when mouse is over the diskselector item
22470 * @param item Target item
22472 * @see elm_object_cursor_unset() for more details.
22473 * @see elm_diskselector_cursor_set()
22475 * @ingroup Diskselector
22477 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22480 * Sets a different style for this item cursor.
22482 * @note before you set a style you should define a cursor with
22483 * elm_diskselector_item_cursor_set()
22485 * @param item diskselector item with cursor already set.
22486 * @param style the theme style to use (default, transparent, ...)
22488 * @see elm_object_cursor_style_set() for more details.
22490 * @ingroup Diskselector
22492 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22496 * Get the style for this item cursor.
22498 * @param item diskselector item with cursor already set.
22499 * @return style the theme style in use, defaults to "default". If the
22500 * object does not have a cursor set, then @c NULL is returned.
22502 * @see elm_object_cursor_style_get() for more details.
22503 * @see elm_diskselector_item_cursor_style_set()
22505 * @ingroup Diskselector
22507 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22511 * Set if the cursor set should be searched on the theme or should use
22512 * the provided by the engine, only.
22514 * @note before you set if should look on theme you should define a cursor
22515 * with elm_diskselector_item_cursor_set().
22516 * By default it will only look for cursors provided by the engine.
22518 * @param item widget item with cursor already set.
22519 * @param engine_only boolean to define if cursors set with
22520 * elm_diskselector_item_cursor_set() should be searched only
22521 * between cursors provided by the engine or searched on widget's
22524 * @see elm_object_cursor_engine_only_set() for more details.
22526 * @ingroup Diskselector
22528 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22531 * Get the cursor engine only usage for this item cursor.
22533 * @param item widget item with cursor already set.
22534 * @return engine_only boolean to define it cursors should be looked only
22535 * between the provided by the engine or searched on widget's theme as well.
22536 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22538 * @see elm_object_cursor_engine_only_get() for more details.
22539 * @see elm_diskselector_item_cursor_engine_only_set()
22541 * @ingroup Diskselector
22543 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22550 * @defgroup Colorselector Colorselector
22554 * @image html img/widget/colorselector/preview-00.png
22556 * @brief Widget for user to select a color.
22558 * Signals that you can add callbacks for are:
22559 * "changed" - When the color value changes(event_info is NULL).
22561 * See @ref tutorial_colorselector.
22564 * @brief Add a new colorselector to the parent
22566 * @param parent The parent object
22567 * @return The new object or NULL if it cannot be created
22569 * @ingroup Colorselector
22571 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22573 * Set a color for the colorselector
22575 * @param obj Colorselector object
22576 * @param r r-value of color
22577 * @param g g-value of color
22578 * @param b b-value of color
22579 * @param a a-value of color
22581 * @ingroup Colorselector
22583 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22585 * Get a color from the colorselector
22587 * @param obj Colorselector object
22588 * @param r integer pointer for r-value of color
22589 * @param g integer pointer for g-value of color
22590 * @param b integer pointer for b-value of color
22591 * @param a integer pointer for a-value of color
22593 * @ingroup Colorselector
22595 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22601 * @defgroup Ctxpopup Ctxpopup
22603 * @image html img/widget/ctxpopup/preview-00.png
22604 * @image latex img/widget/ctxpopup/preview-00.eps
22606 * @brief Context popup widet.
22608 * A ctxpopup is a widget that, when shown, pops up a list of items.
22609 * It automatically chooses an area inside its parent object's view
22610 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22611 * optimally fit into it. In the default theme, it will also point an
22612 * arrow to it's top left position at the time one shows it. Ctxpopup
22613 * items have a label and/or an icon. It is intended for a small
22614 * number of items (hence the use of list, not genlist).
22616 * @note Ctxpopup is a especialization of @ref Hover.
22618 * Signals that you can add callbacks for are:
22619 * "dismissed" - the ctxpopup was dismissed
22621 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22624 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22626 typedef enum _Elm_Ctxpopup_Direction
22628 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22630 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22631 the clicked area */
22632 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22633 the clicked area */
22634 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22636 } Elm_Ctxpopup_Direction;
22639 * @brief Add a new Ctxpopup object to the parent.
22641 * @param parent Parent object
22642 * @return New object or @c NULL, if it cannot be created
22644 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22646 * @brief Set the Ctxpopup's parent
22648 * @param obj The ctxpopup object
22649 * @param area The parent to use
22651 * Set the parent object.
22653 * @note elm_ctxpopup_add() will automatically call this function
22654 * with its @c parent argument.
22656 * @see elm_ctxpopup_add()
22657 * @see elm_hover_parent_set()
22659 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22661 * @brief Get the Ctxpopup's parent
22663 * @param obj The ctxpopup object
22665 * @see elm_ctxpopup_hover_parent_set() for more information
22667 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22669 * @brief Clear all items in the given ctxpopup object.
22671 * @param obj Ctxpopup object
22673 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22675 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22677 * @param obj Ctxpopup object
22678 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22680 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22682 * @brief Get the value of current ctxpopup object's orientation.
22684 * @param obj Ctxpopup object
22685 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22687 * @see elm_ctxpopup_horizontal_set()
22689 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22691 * @brief Add a new item to a ctxpopup object.
22693 * @param obj Ctxpopup object
22694 * @param icon Icon to be set on new item
22695 * @param label The Label of the new item
22696 * @param func Convenience function called when item selected
22697 * @param data Data passed to @p func
22698 * @return A handle to the item added or @c NULL, on errors
22700 * @warning Ctxpopup can't hold both an item list and a content at the same
22701 * time. When an item is added, any previous content will be removed.
22703 * @see elm_ctxpopup_content_set()
22705 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);
22707 * @brief Delete the given item in a ctxpopup object.
22709 * @param item Ctxpopup item to be deleted
22711 * @see elm_ctxpopup_item_append()
22713 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22715 * @brief Set the ctxpopup item's state as disabled or enabled.
22717 * @param item Ctxpopup item to be enabled/disabled
22718 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22720 * When disabled the item is greyed out to indicate it's state.
22722 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22724 * @brief Get the ctxpopup item's disabled/enabled state.
22726 * @param item Ctxpopup item to be enabled/disabled
22727 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22729 * @see elm_ctxpopup_item_disabled_set()
22731 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22733 * @brief Get the icon object for the given ctxpopup item.
22735 * @param item Ctxpopup item
22736 * @return icon object or @c NULL, if the item does not have icon or an error
22739 * @see elm_ctxpopup_item_append()
22740 * @see elm_ctxpopup_item_icon_set()
22742 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22744 * @brief Sets the side icon associated with the ctxpopup item
22746 * @param item Ctxpopup item
22747 * @param icon Icon object to be set
22749 * Once the icon object is set, a previously set one will be deleted.
22750 * @warning Setting the same icon for two items will cause the icon to
22751 * dissapear from the first item.
22753 * @see elm_ctxpopup_item_append()
22755 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22757 * @brief Get the label for the given ctxpopup item.
22759 * @param item Ctxpopup item
22760 * @return label string or @c NULL, if the item does not have label or an
22763 * @see elm_ctxpopup_item_append()
22764 * @see elm_ctxpopup_item_label_set()
22766 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22768 * @brief (Re)set the label on the given ctxpopup item.
22770 * @param item Ctxpopup item
22771 * @param label String to set as label
22773 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22775 * @brief Set an elm widget as the content of the ctxpopup.
22777 * @param obj Ctxpopup object
22778 * @param content Content to be swallowed
22780 * If the content object is already set, a previous one will bedeleted. If
22781 * you want to keep that old content object, use the
22782 * elm_ctxpopup_content_unset() function.
22784 * @deprecated use elm_object_content_set()
22786 * @warning Ctxpopup can't hold both a item list and a content at the same
22787 * time. When a content is set, any previous items will be removed.
22789 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22791 * @brief Unset the ctxpopup content
22793 * @param obj Ctxpopup object
22794 * @return The content that was being used
22796 * Unparent and return the content object which was set for this widget.
22798 * @deprecated use elm_object_content_unset()
22800 * @see elm_ctxpopup_content_set()
22802 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22804 * @brief Set the direction priority of a ctxpopup.
22806 * @param obj Ctxpopup object
22807 * @param first 1st priority of direction
22808 * @param second 2nd priority of direction
22809 * @param third 3th priority of direction
22810 * @param fourth 4th priority of direction
22812 * This functions gives a chance to user to set the priority of ctxpopup
22813 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22814 * requested direction.
22816 * @see Elm_Ctxpopup_Direction
22818 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);
22820 * @brief Get the direction priority of a ctxpopup.
22822 * @param obj Ctxpopup object
22823 * @param first 1st priority of direction to be returned
22824 * @param second 2nd priority of direction to be returned
22825 * @param third 3th priority of direction to be returned
22826 * @param fourth 4th priority of direction to be returned
22828 * @see elm_ctxpopup_direction_priority_set() for more information.
22830 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);
22838 * @defgroup Transit Transit
22839 * @ingroup Elementary
22841 * Transit is designed to apply various animated transition effects to @c
22842 * Evas_Object, such like translation, rotation, etc. For using these
22843 * effects, create an @ref Elm_Transit and add the desired transition effects.
22845 * Once the effects are added into transit, they will be automatically
22846 * managed (their callback will be called until the duration is ended, and
22847 * they will be deleted on completion).
22851 * Elm_Transit *trans = elm_transit_add();
22852 * elm_transit_object_add(trans, obj);
22853 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22854 * elm_transit_duration_set(transit, 1);
22855 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22856 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22857 * elm_transit_repeat_times_set(transit, 3);
22860 * Some transition effects are used to change the properties of objects. They
22862 * @li @ref elm_transit_effect_translation_add
22863 * @li @ref elm_transit_effect_color_add
22864 * @li @ref elm_transit_effect_rotation_add
22865 * @li @ref elm_transit_effect_wipe_add
22866 * @li @ref elm_transit_effect_zoom_add
22867 * @li @ref elm_transit_effect_resizing_add
22869 * Other transition effects are used to make one object disappear and another
22870 * object appear on its old place. These effects are:
22872 * @li @ref elm_transit_effect_flip_add
22873 * @li @ref elm_transit_effect_resizable_flip_add
22874 * @li @ref elm_transit_effect_fade_add
22875 * @li @ref elm_transit_effect_blend_add
22877 * It's also possible to make a transition chain with @ref
22878 * elm_transit_chain_transit_add.
22880 * @warning We strongly recommend to use elm_transit just when edje can not do
22881 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22882 * animations can be manipulated inside the theme.
22884 * List of examples:
22885 * @li @ref transit_example_01_explained
22886 * @li @ref transit_example_02_explained
22887 * @li @ref transit_example_03_c
22888 * @li @ref transit_example_04_c
22894 * @enum Elm_Transit_Tween_Mode
22896 * The type of acceleration used in the transition.
22900 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22901 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22902 over time, then decrease again
22904 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22906 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22908 } Elm_Transit_Tween_Mode;
22911 * @enum Elm_Transit_Effect_Flip_Axis
22913 * The axis where flip effect should be applied.
22917 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22918 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22919 } Elm_Transit_Effect_Flip_Axis;
22921 * @enum Elm_Transit_Effect_Wipe_Dir
22923 * The direction where the wipe effect should occur.
22927 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22928 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22929 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22930 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22931 } Elm_Transit_Effect_Wipe_Dir;
22932 /** @enum Elm_Transit_Effect_Wipe_Type
22934 * Whether the wipe effect should show or hide the object.
22938 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22940 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22942 } Elm_Transit_Effect_Wipe_Type;
22945 * @typedef Elm_Transit
22947 * The Transit created with elm_transit_add(). This type has the information
22948 * about the objects which the transition will be applied, and the
22949 * transition effects that will be used. It also contains info about
22950 * duration, number of repetitions, auto-reverse, etc.
22952 typedef struct _Elm_Transit Elm_Transit;
22953 typedef void Elm_Transit_Effect;
22955 * @typedef Elm_Transit_Effect_Transition_Cb
22957 * Transition callback called for this effect on each transition iteration.
22959 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
22961 * Elm_Transit_Effect_End_Cb
22963 * Transition callback called for this effect when the transition is over.
22965 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
22968 * Elm_Transit_Del_Cb
22970 * A callback called when the transit is deleted.
22972 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
22977 * @note Is not necessary to delete the transit object, it will be deleted at
22978 * the end of its operation.
22979 * @note The transit will start playing when the program enter in the main loop, is not
22980 * necessary to give a start to the transit.
22982 * @return The transit object.
22986 EAPI Elm_Transit *elm_transit_add(void);
22989 * Stops the animation and delete the @p transit object.
22991 * Call this function if you wants to stop the animation before the duration
22992 * time. Make sure the @p transit object is still alive with
22993 * elm_transit_del_cb_set() function.
22994 * All added effects will be deleted, calling its repective data_free_cb
22995 * functions. The function setted by elm_transit_del_cb_set() will be called.
22997 * @see elm_transit_del_cb_set()
22999 * @param transit The transit object to be deleted.
23002 * @warning Just call this function if you are sure the transit is alive.
23004 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23007 * Add a new effect to the transit.
23009 * @note The cb function and the data are the key to the effect. If you try to
23010 * add an already added effect, nothing is done.
23011 * @note After the first addition of an effect in @p transit, if its
23012 * effect list become empty again, the @p transit will be killed by
23013 * elm_transit_del(transit) function.
23017 * Elm_Transit *transit = elm_transit_add();
23018 * elm_transit_effect_add(transit,
23019 * elm_transit_effect_blend_op,
23020 * elm_transit_effect_blend_context_new(),
23021 * elm_transit_effect_blend_context_free);
23024 * @param transit The transit object.
23025 * @param transition_cb The operation function. It is called when the
23026 * animation begins, it is the function that actually performs the animation.
23027 * It is called with the @p data, @p transit and the time progression of the
23028 * animation (a double value between 0.0 and 1.0).
23029 * @param effect The context data of the effect.
23030 * @param end_cb The function to free the context data, it will be called
23031 * at the end of the effect, it must finalize the animation and free the
23035 * @warning The transit free the context data at the and of the transition with
23036 * the data_free_cb function, do not use the context data in another transit.
23038 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);
23041 * Delete an added effect.
23043 * This function will remove the effect from the @p transit, calling the
23044 * data_free_cb to free the @p data.
23046 * @see elm_transit_effect_add()
23048 * @note If the effect is not found, nothing is done.
23049 * @note If the effect list become empty, this function will call
23050 * elm_transit_del(transit), that is, it will kill the @p transit.
23052 * @param transit The transit object.
23053 * @param transition_cb The operation function.
23054 * @param effect The context data of the effect.
23058 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);
23061 * Add new object to apply the effects.
23063 * @note After the first addition of an object in @p transit, if its
23064 * object list become empty again, the @p transit will be killed by
23065 * elm_transit_del(transit) function.
23066 * @note If the @p obj belongs to another transit, the @p obj will be
23067 * removed from it and it will only belong to the @p transit. If the old
23068 * transit stays without objects, it will die.
23069 * @note When you add an object into the @p transit, its state from
23070 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23071 * transit ends, if you change this state whith evas_object_pass_events_set()
23072 * after add the object, this state will change again when @p transit stops to
23075 * @param transit The transit object.
23076 * @param obj Object to be animated.
23079 * @warning It is not allowed to add a new object after transit begins to go.
23081 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23084 * Removes an added object from the transit.
23086 * @note If the @p obj is not in the @p transit, nothing is done.
23087 * @note If the list become empty, this function will call
23088 * elm_transit_del(transit), that is, it will kill the @p transit.
23090 * @param transit The transit object.
23091 * @param obj Object to be removed from @p transit.
23094 * @warning It is not allowed to remove objects after transit begins to go.
23096 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23099 * Get the objects of the transit.
23101 * @param transit The transit object.
23102 * @return a Eina_List with the objects from the transit.
23106 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23109 * Enable/disable keeping up the objects states.
23110 * If it is not kept, the objects states will be reset when transition ends.
23112 * @note @p transit can not be NULL.
23113 * @note One state includes geometry, color, map data.
23115 * @param transit The transit object.
23116 * @param state_keep Keeping or Non Keeping.
23120 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23123 * Get a value whether the objects states will be reset or not.
23125 * @note @p transit can not be NULL
23127 * @see elm_transit_objects_final_state_keep_set()
23129 * @param transit The transit object.
23130 * @return EINA_TRUE means the states of the objects will be reset.
23131 * If @p transit is NULL, EINA_FALSE is returned
23135 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23138 * Set the event enabled when transit is operating.
23140 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23141 * events from mouse and keyboard during the animation.
23142 * @note When you add an object with elm_transit_object_add(), its state from
23143 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23144 * transit ends, if you change this state with evas_object_pass_events_set()
23145 * after adding the object, this state will change again when @p transit stops
23148 * @param transit The transit object.
23149 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23150 * ignored otherwise.
23154 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23157 * Get the value of event enabled status.
23159 * @see elm_transit_event_enabled_set()
23161 * @param transit The Transit object
23162 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23163 * EINA_FALSE is returned
23167 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23170 * Set the user-callback function when the transit is deleted.
23172 * @note Using this function twice will overwrite the first function setted.
23173 * @note the @p transit object will be deleted after call @p cb function.
23175 * @param transit The transit object.
23176 * @param cb Callback function pointer. This function will be called before
23177 * the deletion of the transit.
23178 * @param data Callback funtion user data. It is the @p op parameter.
23182 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23185 * Set reverse effect automatically.
23187 * If auto reverse is setted, after running the effects with the progress
23188 * parameter from 0 to 1, it will call the effecs again with the progress
23189 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23190 * where the duration was setted with the function elm_transit_add and
23191 * the repeat with the function elm_transit_repeat_times_set().
23193 * @param transit The transit object.
23194 * @param reverse EINA_TRUE means the auto_reverse is on.
23198 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23201 * Get if the auto reverse is on.
23203 * @see elm_transit_auto_reverse_set()
23205 * @param transit The transit object.
23206 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23207 * EINA_FALSE is returned
23211 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23214 * Set the transit repeat count. Effect will be repeated by repeat count.
23216 * This function sets the number of repetition the transit will run after
23217 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23218 * If the @p repeat is a negative number, it will repeat infinite times.
23220 * @note If this function is called during the transit execution, the transit
23221 * will run @p repeat times, ignoring the times it already performed.
23223 * @param transit The transit object
23224 * @param repeat Repeat count
23228 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23231 * Get the transit repeat count.
23233 * @see elm_transit_repeat_times_set()
23235 * @param transit The Transit object.
23236 * @return The repeat count. If @p transit is NULL
23241 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23244 * Set the transit animation acceleration type.
23246 * This function sets the tween mode of the transit that can be:
23247 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23248 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23249 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23250 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23252 * @param transit The transit object.
23253 * @param tween_mode The tween type.
23257 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23260 * Get the transit animation acceleration type.
23262 * @note @p transit can not be NULL
23264 * @param transit The transit object.
23265 * @return The tween type. If @p transit is NULL
23266 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23270 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23273 * Set the transit animation time
23275 * @note @p transit can not be NULL
23277 * @param transit The transit object.
23278 * @param duration The animation time.
23282 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23285 * Get the transit animation time
23287 * @note @p transit can not be NULL
23289 * @param transit The transit object.
23291 * @return The transit animation time.
23295 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23298 * Starts the transition.
23299 * Once this API is called, the transit begins to measure the time.
23301 * @note @p transit can not be NULL
23303 * @param transit The transit object.
23307 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23310 * Pause/Resume the transition.
23312 * If you call elm_transit_go again, the transit will be started from the
23313 * beginning, and will be unpaused.
23315 * @note @p transit can not be NULL
23317 * @param transit The transit object.
23318 * @param paused Whether the transition should be paused or not.
23322 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23325 * Get the value of paused status.
23327 * @see elm_transit_paused_set()
23329 * @note @p transit can not be NULL
23331 * @param transit The transit object.
23332 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23333 * EINA_FALSE is returned
23337 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23340 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23342 * The value returned is a fraction (current time / total time). It
23343 * represents the progression position relative to the total.
23345 * @note @p transit can not be NULL
23347 * @param transit The transit object.
23349 * @return The time progression value. If @p transit is NULL
23354 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23357 * Makes the chain relationship between two transits.
23359 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23360 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23362 * @param transit The transit object.
23363 * @param chain_transit The chain transit object. This transit will be operated
23364 * after transit is done.
23366 * This function adds @p chain_transit transition to a chain after the @p
23367 * transit, and will be started as soon as @p transit ends. See @ref
23368 * transit_example_02_explained for a full example.
23372 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23375 * Cut off the chain relationship between two transits.
23377 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23378 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23380 * @param transit The transit object.
23381 * @param chain_transit The chain transit object.
23383 * This function remove the @p chain_transit transition from the @p transit.
23387 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23390 * Get the current chain transit list.
23392 * @note @p transit can not be NULL.
23394 * @param transit The transit object.
23395 * @return chain transit list.
23399 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23402 * Add the Resizing Effect to Elm_Transit.
23404 * @note This API is one of the facades. It creates resizing effect context
23405 * and add it's required APIs to elm_transit_effect_add.
23407 * @see elm_transit_effect_add()
23409 * @param transit Transit object.
23410 * @param from_w Object width size when effect begins.
23411 * @param from_h Object height size when effect begins.
23412 * @param to_w Object width size when effect ends.
23413 * @param to_h Object height size when effect ends.
23414 * @return Resizing effect context data.
23418 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);
23421 * Add the Translation Effect to Elm_Transit.
23423 * @note This API is one of the facades. It creates translation effect context
23424 * and add it's required APIs to elm_transit_effect_add.
23426 * @see elm_transit_effect_add()
23428 * @param transit Transit object.
23429 * @param from_dx X Position variation when effect begins.
23430 * @param from_dy Y Position variation when effect begins.
23431 * @param to_dx X Position variation when effect ends.
23432 * @param to_dy Y Position variation when effect ends.
23433 * @return Translation effect context data.
23436 * @warning It is highly recommended just create a transit with this effect when
23437 * the window that the objects of the transit belongs has already been created.
23438 * This is because this effect needs the geometry information about the objects,
23439 * and if the window was not created yet, it can get a wrong information.
23441 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);
23444 * Add the Zoom Effect to Elm_Transit.
23446 * @note This API is one of the facades. It creates zoom effect context
23447 * and add it's required APIs to elm_transit_effect_add.
23449 * @see elm_transit_effect_add()
23451 * @param transit Transit object.
23452 * @param from_rate Scale rate when effect begins (1 is current rate).
23453 * @param to_rate Scale rate when effect ends.
23454 * @return Zoom effect context data.
23457 * @warning It is highly recommended just create a transit with this effect when
23458 * the window that the objects of the transit belongs has already been created.
23459 * This is because this effect needs the geometry information about the objects,
23460 * and if the window was not created yet, it can get a wrong information.
23462 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23465 * Add the Flip Effect to Elm_Transit.
23467 * @note This API is one of the facades. It creates flip effect context
23468 * and add it's required APIs to elm_transit_effect_add.
23469 * @note This effect is applied to each pair of objects in the order they are listed
23470 * in the transit list of objects. The first object in the pair will be the
23471 * "front" object and the second will be the "back" object.
23473 * @see elm_transit_effect_add()
23475 * @param transit Transit object.
23476 * @param axis Flipping Axis(X or Y).
23477 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23478 * @return Flip effect context data.
23481 * @warning It is highly recommended just create a transit with this effect when
23482 * the window that the objects of the transit belongs has already been created.
23483 * This is because this effect needs the geometry information about the objects,
23484 * and if the window was not created yet, it can get a wrong information.
23486 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23489 * Add the Resizable Flip Effect to Elm_Transit.
23491 * @note This API is one of the facades. It creates resizable flip effect context
23492 * and add it's required APIs to elm_transit_effect_add.
23493 * @note This effect is applied to each pair of objects in the order they are listed
23494 * in the transit list of objects. The first object in the pair will be the
23495 * "front" object and the second will be the "back" object.
23497 * @see elm_transit_effect_add()
23499 * @param transit Transit object.
23500 * @param axis Flipping Axis(X or Y).
23501 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23502 * @return Resizable flip effect context data.
23505 * @warning It is highly recommended just create a transit with this effect when
23506 * the window that the objects of the transit belongs has already been created.
23507 * This is because this effect needs the geometry information about the objects,
23508 * and if the window was not created yet, it can get a wrong information.
23510 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23513 * Add the Wipe Effect to Elm_Transit.
23515 * @note This API is one of the facades. It creates wipe effect context
23516 * and add it's required APIs to elm_transit_effect_add.
23518 * @see elm_transit_effect_add()
23520 * @param transit Transit object.
23521 * @param type Wipe type. Hide or show.
23522 * @param dir Wipe Direction.
23523 * @return Wipe effect context data.
23526 * @warning It is highly recommended just create a transit with this effect when
23527 * the window that the objects of the transit belongs has already been created.
23528 * This is because this effect needs the geometry information about the objects,
23529 * and if the window was not created yet, it can get a wrong information.
23531 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23534 * Add the Color Effect to Elm_Transit.
23536 * @note This API is one of the facades. It creates color effect context
23537 * and add it's required APIs to elm_transit_effect_add.
23539 * @see elm_transit_effect_add()
23541 * @param transit Transit object.
23542 * @param from_r RGB R when effect begins.
23543 * @param from_g RGB G when effect begins.
23544 * @param from_b RGB B when effect begins.
23545 * @param from_a RGB A when effect begins.
23546 * @param to_r RGB R when effect ends.
23547 * @param to_g RGB G when effect ends.
23548 * @param to_b RGB B when effect ends.
23549 * @param to_a RGB A when effect ends.
23550 * @return Color effect context data.
23554 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);
23557 * Add the Fade Effect to Elm_Transit.
23559 * @note This API is one of the facades. It creates fade effect context
23560 * and add it's required APIs to elm_transit_effect_add.
23561 * @note This effect is applied to each pair of objects in the order they are listed
23562 * in the transit list of objects. The first object in the pair will be the
23563 * "before" object and the second will be the "after" object.
23565 * @see elm_transit_effect_add()
23567 * @param transit Transit object.
23568 * @return Fade effect context data.
23571 * @warning It is highly recommended just create a transit with this effect when
23572 * the window that the objects of the transit belongs has already been created.
23573 * This is because this effect needs the color information about the objects,
23574 * and if the window was not created yet, it can get a wrong information.
23576 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23579 * Add the Blend Effect to Elm_Transit.
23581 * @note This API is one of the facades. It creates blend effect context
23582 * and add it's required APIs to elm_transit_effect_add.
23583 * @note This effect is applied to each pair of objects in the order they are listed
23584 * in the transit list of objects. The first object in the pair will be the
23585 * "before" object and the second will be the "after" object.
23587 * @see elm_transit_effect_add()
23589 * @param transit Transit object.
23590 * @return Blend effect context data.
23593 * @warning It is highly recommended just create a transit with this effect when
23594 * the window that the objects of the transit belongs has already been created.
23595 * This is because this effect needs the color information about the objects,
23596 * and if the window was not created yet, it can get a wrong information.
23598 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23601 * Add the Rotation Effect to Elm_Transit.
23603 * @note This API is one of the facades. It creates rotation effect context
23604 * and add it's required APIs to elm_transit_effect_add.
23606 * @see elm_transit_effect_add()
23608 * @param transit Transit object.
23609 * @param from_degree Degree when effect begins.
23610 * @param to_degree Degree when effect is ends.
23611 * @return Rotation effect context data.
23614 * @warning It is highly recommended just create a transit with this effect when
23615 * the window that the objects of the transit belongs has already been created.
23616 * This is because this effect needs the geometry information about the objects,
23617 * and if the window was not created yet, it can get a wrong information.
23619 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23622 * Add the ImageAnimation Effect to Elm_Transit.
23624 * @note This API is one of the facades. It creates image animation effect context
23625 * and add it's required APIs to elm_transit_effect_add.
23626 * The @p images parameter is a list images paths. This list and
23627 * its contents will be deleted at the end of the effect by
23628 * elm_transit_effect_image_animation_context_free() function.
23632 * char buf[PATH_MAX];
23633 * Eina_List *images = NULL;
23634 * Elm_Transit *transi = elm_transit_add();
23636 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23637 * images = eina_list_append(images, eina_stringshare_add(buf));
23639 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23640 * images = eina_list_append(images, eina_stringshare_add(buf));
23641 * elm_transit_effect_image_animation_add(transi, images);
23645 * @see elm_transit_effect_add()
23647 * @param transit Transit object.
23648 * @param images Eina_List of images file paths. This list and
23649 * its contents will be deleted at the end of the effect by
23650 * elm_transit_effect_image_animation_context_free() function.
23651 * @return Image Animation effect context data.
23655 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23660 typedef struct _Elm_Store Elm_Store;
23661 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23662 typedef struct _Elm_Store_Item Elm_Store_Item;
23663 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23664 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23665 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23666 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23667 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23668 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23669 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23670 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23672 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23673 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23674 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23675 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23679 ELM_STORE_ITEM_MAPPING_NONE = 0,
23680 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23681 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23682 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23683 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23684 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23685 // can add more here as needed by common apps
23686 ELM_STORE_ITEM_MAPPING_LAST
23687 } Elm_Store_Item_Mapping_Type;
23689 struct _Elm_Store_Item_Mapping_Icon
23691 // FIXME: allow edje file icons
23693 Elm_Icon_Lookup_Order lookup_order;
23694 Eina_Bool standard_name : 1;
23695 Eina_Bool no_scale : 1;
23696 Eina_Bool smooth : 1;
23697 Eina_Bool scale_up : 1;
23698 Eina_Bool scale_down : 1;
23701 struct _Elm_Store_Item_Mapping_Empty
23706 struct _Elm_Store_Item_Mapping_Photo
23711 struct _Elm_Store_Item_Mapping_Custom
23713 Elm_Store_Item_Mapping_Cb func;
23716 struct _Elm_Store_Item_Mapping
23718 Elm_Store_Item_Mapping_Type type;
23723 Elm_Store_Item_Mapping_Empty empty;
23724 Elm_Store_Item_Mapping_Icon icon;
23725 Elm_Store_Item_Mapping_Photo photo;
23726 Elm_Store_Item_Mapping_Custom custom;
23727 // add more types here
23731 struct _Elm_Store_Item_Info
23733 Elm_Genlist_Item_Class *item_class;
23734 const Elm_Store_Item_Mapping *mapping;
23739 struct _Elm_Store_Item_Info_Filesystem
23741 Elm_Store_Item_Info base;
23745 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23746 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23748 EAPI void elm_store_free(Elm_Store *st);
23750 EAPI Elm_Store *elm_store_filesystem_new(void);
23751 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23752 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23753 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23755 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23757 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23758 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23759 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23760 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23761 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23762 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23764 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23765 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23766 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23767 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23768 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23769 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23770 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23773 * @defgroup SegmentControl SegmentControl
23774 * @ingroup Elementary
23776 * @image html img/widget/segment_control/preview-00.png
23777 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23779 * @image html img/segment_control.png
23780 * @image latex img/segment_control.eps width=\textwidth
23782 * Segment control widget is a horizontal control made of multiple segment
23783 * items, each segment item functioning similar to discrete two state button.
23784 * A segment control groups the items together and provides compact
23785 * single button with multiple equal size segments.
23787 * Segment item size is determined by base widget
23788 * size and the number of items added.
23789 * Only one segment item can be at selected state. A segment item can display
23790 * combination of Text and any Evas_Object like Images or other widget.
23792 * Smart callbacks one can listen to:
23793 * - "changed" - When the user clicks on a segment item which is not
23794 * previously selected and get selected. The event_info parameter is the
23795 * segment item index.
23797 * Available styles for it:
23800 * Here is an example on its usage:
23801 * @li @ref segment_control_example
23805 * @addtogroup SegmentControl
23809 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23812 * Add a new segment control widget to the given parent Elementary
23813 * (container) object.
23815 * @param parent The parent object.
23816 * @return a new segment control widget handle or @c NULL, on errors.
23818 * This function inserts a new segment control widget on the canvas.
23820 * @ingroup SegmentControl
23822 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23825 * Append a new item to the segment control object.
23827 * @param obj The segment control object.
23828 * @param icon The icon object to use for the left side of the item. An
23829 * icon can be any Evas object, but usually it is an icon created
23830 * with elm_icon_add().
23831 * @param label The label of the item.
23832 * Note that, NULL is different from empty string "".
23833 * @return The created item or @c NULL upon failure.
23835 * A new item will be created and appended to the segment control, i.e., will
23836 * be set as @b last item.
23838 * If it should be inserted at another position,
23839 * elm_segment_control_item_insert_at() should be used instead.
23841 * Items created with this function can be deleted with function
23842 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23844 * @note @p label set to @c NULL is different from empty string "".
23846 * only has icon, it will be displayed bigger and centered. If it has
23847 * icon and label, even that an empty string, icon will be smaller and
23848 * positioned at left.
23852 * sc = elm_segment_control_add(win);
23853 * ic = elm_icon_add(win);
23854 * elm_icon_file_set(ic, "path/to/image", NULL);
23855 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23856 * elm_segment_control_item_add(sc, ic, "label");
23857 * evas_object_show(sc);
23860 * @see elm_segment_control_item_insert_at()
23861 * @see elm_segment_control_item_del()
23863 * @ingroup SegmentControl
23865 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23868 * Insert a new item to the segment control object at specified position.
23870 * @param obj The segment control object.
23871 * @param icon The icon object to use for the left side of the item. An
23872 * icon can be any Evas object, but usually it is an icon created
23873 * with elm_icon_add().
23874 * @param label The label of the item.
23875 * @param index Item position. Value should be between 0 and items count.
23876 * @return The created item or @c NULL upon failure.
23878 * Index values must be between @c 0, when item will be prepended to
23879 * segment control, and items count, that can be get with
23880 * elm_segment_control_item_count_get(), case when item will be appended
23881 * to segment control, just like elm_segment_control_item_add().
23883 * Items created with this function can be deleted with function
23884 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23886 * @note @p label set to @c NULL is different from empty string "".
23888 * only has icon, it will be displayed bigger and centered. If it has
23889 * icon and label, even that an empty string, icon will be smaller and
23890 * positioned at left.
23892 * @see elm_segment_control_item_add()
23893 * @see elm_segment_control_count_get()
23894 * @see elm_segment_control_item_del()
23896 * @ingroup SegmentControl
23898 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);
23901 * Remove a segment control item from its parent, deleting it.
23903 * @param it The item to be removed.
23905 * Items can be added with elm_segment_control_item_add() or
23906 * elm_segment_control_item_insert_at().
23908 * @ingroup SegmentControl
23910 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23913 * Remove a segment control item at given index from its parent,
23916 * @param obj The segment control object.
23917 * @param index The position of the segment control item to be deleted.
23919 * Items can be added with elm_segment_control_item_add() or
23920 * elm_segment_control_item_insert_at().
23922 * @ingroup SegmentControl
23924 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23927 * Get the Segment items count from segment control.
23929 * @param obj The segment control object.
23930 * @return Segment items count.
23932 * It will just return the number of items added to segment control @p obj.
23934 * @ingroup SegmentControl
23936 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23939 * Get the item placed at specified index.
23941 * @param obj The segment control object.
23942 * @param index The index of the segment item.
23943 * @return The segment control item or @c NULL on failure.
23945 * Index is the position of an item in segment control widget. Its
23946 * range is from @c 0 to <tt> count - 1 </tt>.
23947 * Count is the number of items, that can be get with
23948 * elm_segment_control_item_count_get().
23950 * @ingroup SegmentControl
23952 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23955 * Get the label of item.
23957 * @param obj The segment control object.
23958 * @param index The index of the segment item.
23959 * @return The label of the item at @p index.
23961 * The return value is a pointer to the label associated to the item when
23962 * it was created, with function elm_segment_control_item_add(), or later
23963 * with function elm_segment_control_item_label_set. If no label
23964 * was passed as argument, it will return @c NULL.
23966 * @see elm_segment_control_item_label_set() for more details.
23967 * @see elm_segment_control_item_add()
23969 * @ingroup SegmentControl
23971 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23974 * Set the label of item.
23976 * @param it The item of segment control.
23977 * @param text The label of item.
23979 * The label to be displayed by the item.
23980 * Label will be at right of the icon (if set).
23982 * If a label was passed as argument on item creation, with function
23983 * elm_control_segment_item_add(), it will be already
23984 * displayed by the item.
23986 * @see elm_segment_control_item_label_get()
23987 * @see elm_segment_control_item_add()
23989 * @ingroup SegmentControl
23991 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
23994 * Get the icon associated to the item.
23996 * @param obj The segment control object.
23997 * @param index The index of the segment item.
23998 * @return The left side icon associated to the item at @p index.
24000 * The return value is a pointer to the icon associated to the item when
24001 * it was created, with function elm_segment_control_item_add(), or later
24002 * with function elm_segment_control_item_icon_set(). If no icon
24003 * was passed as argument, it will return @c NULL.
24005 * @see elm_segment_control_item_add()
24006 * @see elm_segment_control_item_icon_set()
24008 * @ingroup SegmentControl
24010 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24013 * Set the icon associated to the item.
24015 * @param it The segment control item.
24016 * @param icon The icon object to associate with @p it.
24018 * The icon object to use at left side of the item. An
24019 * icon can be any Evas object, but usually it is an icon created
24020 * with elm_icon_add().
24022 * Once the icon object is set, a previously set one will be deleted.
24023 * @warning Setting the same icon for two items will cause the icon to
24024 * dissapear from the first item.
24026 * If an icon was passed as argument on item creation, with function
24027 * elm_segment_control_item_add(), it will be already
24028 * associated to the item.
24030 * @see elm_segment_control_item_add()
24031 * @see elm_segment_control_item_icon_get()
24033 * @ingroup SegmentControl
24035 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24038 * Get the index of an item.
24040 * @param it The segment control item.
24041 * @return The position of item in segment control widget.
24043 * Index is the position of an item in segment control widget. Its
24044 * range is from @c 0 to <tt> count - 1 </tt>.
24045 * Count is the number of items, that can be get with
24046 * elm_segment_control_item_count_get().
24048 * @ingroup SegmentControl
24050 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24053 * Get the base object of the item.
24055 * @param it The segment control item.
24056 * @return The base object associated with @p it.
24058 * Base object is the @c Evas_Object that represents that item.
24060 * @ingroup SegmentControl
24062 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24065 * Get the selected item.
24067 * @param obj The segment control object.
24068 * @return The selected item or @c NULL if none of segment items is
24071 * The selected item can be unselected with function
24072 * elm_segment_control_item_selected_set().
24074 * The selected item always will be highlighted on segment control.
24076 * @ingroup SegmentControl
24078 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24081 * Set the selected state of an item.
24083 * @param it The segment control item
24084 * @param select The selected state
24086 * This sets the selected state of the given item @p it.
24087 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24089 * If a new item is selected the previosly selected will be unselected.
24090 * Previoulsy selected item can be get with function
24091 * elm_segment_control_item_selected_get().
24093 * The selected item always will be highlighted on segment control.
24095 * @see elm_segment_control_item_selected_get()
24097 * @ingroup SegmentControl
24099 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24106 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24107 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24108 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24109 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24110 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24111 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24112 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24113 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24115 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
24116 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
24118 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24119 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24120 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24121 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24122 EAPI void elm_video_play(Evas_Object *video);
24123 EAPI void elm_video_pause(Evas_Object *video);
24124 EAPI void elm_video_stop(Evas_Object *video);
24125 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24126 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24127 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24128 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24129 EAPI double elm_video_audio_level_get(Evas_Object *video);
24130 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24131 EAPI double elm_video_play_position_get(Evas_Object *video);
24132 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24133 EAPI double elm_video_play_length_get(Evas_Object *video);
24134 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24135 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24136 EAPI const char *elm_video_title_get(Evas_Object *video);
24138 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24139 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24144 ELM_NAVIFRAME_PREV_BUTTON,
24145 ELM_NAVIFRAME_NEXT_BUTTON
24146 } Elm_Naviframe_Button_Type;
24148 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24149 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);
24150 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24151 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24152 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24153 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24154 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24155 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24156 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24157 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24158 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24159 EAPI void elm_naviframe_item_button_set(Elm_Object_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24160 EAPI Evas_Object *elm_naviframe_item_button_get(const Elm_Object_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24161 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24162 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24163 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24164 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);