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
328 } Elm_Focus_Direction;
330 typedef enum _Elm_Text_Format
332 ELM_TEXT_FORMAT_PLAIN_UTF8,
333 ELM_TEXT_FORMAT_MARKUP_UTF8
337 * Line wrapping types.
339 typedef enum _Elm_Wrap_Type
341 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
342 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
343 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
344 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
349 * @typedef Elm_Object_Item
350 * An Elementary Object item handle.
353 typedef struct _Elm_Object_Item Elm_Object_Item;
357 * Called back when a widget's tooltip is activated and needs content.
358 * @param data user-data given to elm_object_tooltip_content_cb_set()
359 * @param obj owner widget.
360 * @param tooltip The tooltip object (affix content to this!)
362 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
365 * Called back when a widget's item tooltip is activated and needs content.
366 * @param data user-data given to elm_object_tooltip_content_cb_set()
367 * @param obj owner widget.
368 * @param tooltip The tooltip object (affix content to this!)
369 * @param item context dependent item. As an example, if tooltip was
370 * set on Elm_List_Item, then it is of this type.
372 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
374 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
376 #ifndef ELM_LIB_QUICKLAUNCH
377 #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 */
379 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
382 /**************************************************************************/
386 * Initialize Elementary
388 * @param[in] argc System's argument count value
389 * @param[in] argv System's pointer to array of argument strings
390 * @return The init counter value.
392 * This function initializes Elementary and increments a counter of
393 * the number of calls to it. It returs the new counter's value.
395 * @warning This call is exported only for use by the @c ELM_MAIN()
396 * macro. There is no need to use this if you use this macro (which
397 * is highly advisable). An elm_main() should contain the entry
398 * point code for your application, having the same prototype as
399 * elm_init(), and @b not being static (putting the @c EAPI symbol
400 * in front of its type declaration is advisable). The @c
401 * ELM_MAIN() call should be placed just after it.
404 * @dontinclude bg_example_01.c
408 * See the full @ref bg_example_01_c "example".
410 * @see elm_shutdown().
413 EAPI int elm_init(int argc, char **argv);
416 * Shut down Elementary
418 * @return The init counter value.
420 * This should be called at the end of your application, just
421 * before it ceases to do any more processing. This will clean up
422 * any permanent resources your application may have allocated via
423 * Elementary that would otherwise persist.
425 * @see elm_init() for an example
429 EAPI int elm_shutdown(void);
432 * Run Elementary's main loop
434 * This call should be issued just after all initialization is
435 * completed. This function will not return until elm_exit() is
436 * called. It will keep looping, running the main
437 * (event/processing) loop for Elementary.
439 * @see elm_init() for an example
443 EAPI void elm_run(void);
446 * Exit Elementary's main loop
448 * If this call is issued, it will flag the main loop to cease
449 * processing and return back to its parent function (usually your
450 * elm_main() function).
452 * @see elm_init() for an example. There, just after a request to
453 * close the window comes, the main loop will be left.
455 * @note By using the #ELM_POLICY_QUIT on your Elementary
456 * applications, you'll this function called automatically for you.
460 EAPI void elm_exit(void);
463 * Provide information in order to make Elementary determine the @b
464 * run time location of the software in question, so other data files
465 * such as images, sound files, executable utilities, libraries,
466 * modules and locale files can be found.
468 * @param mainfunc This is your application's main function name,
469 * whose binary's location is to be found. Providing @c NULL
470 * will make Elementary not to use it
471 * @param dom This will be used as the application's "domain", in the
472 * form of a prefix to any environment variables that may
473 * override prefix detection and the directory name, inside the
474 * standard share or data directories, where the software's
475 * data files will be looked for.
476 * @param checkfile This is an (optional) magic file's path to check
477 * for existence (and it must be located in the data directory,
478 * under the share directory provided above). Its presence will
479 * help determine the prefix found was correct. Pass @c NULL if
480 * the check is not to be done.
482 * This function allows one to re-locate the application somewhere
483 * else after compilation, if the developer wishes for easier
484 * distribution of pre-compiled binaries.
486 * The prefix system is designed to locate where the given software is
487 * installed (under a common path prefix) at run time and then report
488 * specific locations of this prefix and common directories inside
489 * this prefix like the binary, library, data and locale directories,
490 * through the @c elm_app_*_get() family of functions.
492 * Call elm_app_info_set() early on before you change working
493 * directory or anything about @c argv[0], so it gets accurate
496 * It will then try and trace back which file @p mainfunc comes from,
497 * if provided, to determine the application's prefix directory.
499 * The @p dom parameter provides a string prefix to prepend before
500 * environment variables, allowing a fallback to @b specific
501 * environment variables to locate the software. You would most
502 * probably provide a lowercase string there, because it will also
503 * serve as directory domain, explained next. For environment
504 * variables purposes, this string is made uppercase. For example if
505 * @c "myapp" is provided as the prefix, then the program would expect
506 * @c "MYAPP_PREFIX" as a master environment variable to specify the
507 * exact install prefix for the software, or more specific environment
508 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
509 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
510 * the user or scripts before launching. If not provided (@c NULL),
511 * environment variables will not be used to override compiled-in
512 * defaults or auto detections.
514 * The @p dom string also provides a subdirectory inside the system
515 * shared data directory for data files. For example, if the system
516 * directory is @c /usr/local/share, then this directory name is
517 * appended, creating @c /usr/local/share/myapp, if it @p was @c
518 * "myapp". It is expected the application installs data files in
521 * The @p checkfile is a file name or path of something inside the
522 * share or data directory to be used to test that the prefix
523 * detection worked. For example, your app will install a wallpaper
524 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
525 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
528 * @see elm_app_compile_bin_dir_set()
529 * @see elm_app_compile_lib_dir_set()
530 * @see elm_app_compile_data_dir_set()
531 * @see elm_app_compile_locale_set()
532 * @see elm_app_prefix_dir_get()
533 * @see elm_app_bin_dir_get()
534 * @see elm_app_lib_dir_get()
535 * @see elm_app_data_dir_get()
536 * @see elm_app_locale_dir_get()
538 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
541 * Provide information on the @b fallback application's binaries
542 * directory, on scenarios where they get overriden by
543 * elm_app_info_set().
545 * @param dir The path to the default binaries directory (compile time
548 * @note Elementary will as well use this path to determine actual
549 * names of binaries' directory paths, maybe changing it to be @c
550 * something/local/bin instead of @c something/bin, only, for
553 * @warning You should call this function @b before
554 * elm_app_info_set().
556 EAPI void elm_app_compile_bin_dir_set(const char *dir);
559 * Provide information on the @b fallback application's libraries
560 * directory, on scenarios where they get overriden by
561 * elm_app_info_set().
563 * @param dir The path to the default libraries directory (compile
566 * @note Elementary will as well use this path to determine actual
567 * names of libraries' directory paths, maybe changing it to be @c
568 * something/lib32 or @c something/lib64 instead of @c something/lib,
571 * @warning You should call this function @b before
572 * elm_app_info_set().
574 EAPI void elm_app_compile_lib_dir_set(const char *dir);
577 * Provide information on the @b fallback application's data
578 * directory, on scenarios where they get overriden by
579 * elm_app_info_set().
581 * @param dir The path to the default data directory (compile time
584 * @note Elementary will as well use this path to determine actual
585 * names of data directory paths, maybe changing it to be @c
586 * something/local/share instead of @c something/share, only, for
589 * @warning You should call this function @b before
590 * elm_app_info_set().
592 EAPI void elm_app_compile_data_dir_set(const char *dir);
595 * Provide information on the @b fallback application's locale
596 * directory, on scenarios where they get overriden by
597 * elm_app_info_set().
599 * @param dir The path to the default locale directory (compile time
602 * @warning You should call this function @b before
603 * elm_app_info_set().
605 EAPI void elm_app_compile_locale_set(const char *dir);
608 * Retrieve the application's run time prefix directory, as set by
609 * elm_app_info_set() and the way (environment) the application was
612 * @return The directory prefix the application is actually using
614 EAPI const char *elm_app_prefix_dir_get(void);
617 * Retrieve the application's run time binaries prefix directory, as
618 * set by elm_app_info_set() and the way (environment) the application
621 * @return The binaries directory prefix the application is actually
624 EAPI const char *elm_app_bin_dir_get(void);
627 * Retrieve the application's run time libraries prefix directory, as
628 * set by elm_app_info_set() and the way (environment) the application
631 * @return The libraries directory prefix the application is actually
634 EAPI const char *elm_app_lib_dir_get(void);
637 * Retrieve the application's run time data prefix directory, as
638 * set by elm_app_info_set() and the way (environment) the application
641 * @return The data directory prefix the application is actually
644 EAPI const char *elm_app_data_dir_get(void);
647 * Retrieve the application's run time locale prefix directory, as
648 * set by elm_app_info_set() and the way (environment) the application
651 * @return The locale directory prefix the application is actually
654 EAPI const char *elm_app_locale_dir_get(void);
656 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
657 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
658 EAPI int elm_quicklaunch_init(int argc, char **argv);
659 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
660 EAPI int elm_quicklaunch_sub_shutdown(void);
661 EAPI int elm_quicklaunch_shutdown(void);
662 EAPI void elm_quicklaunch_seed(void);
663 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
664 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
665 EAPI void elm_quicklaunch_cleanup(void);
666 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
667 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
669 EAPI Eina_Bool elm_need_efreet(void);
670 EAPI Eina_Bool elm_need_e_dbus(void);
671 EAPI Eina_Bool elm_need_ethumb(void);
674 * Set a new policy's value (for a given policy group/identifier).
676 * @param policy policy identifier, as in @ref Elm_Policy.
677 * @param value policy value, which depends on the identifier
679 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
681 * Elementary policies define applications' behavior,
682 * somehow. These behaviors are divided in policy groups (see
683 * #Elm_Policy enumeration). This call will emit the Ecore event
684 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
685 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
688 * @note Currently, we have only one policy identifier/group
689 * (#ELM_POLICY_QUIT), which has two possible values.
693 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
696 * Gets the policy value set for given policy identifier.
698 * @param policy policy identifier, as in #Elm_Policy.
699 * @return The currently set policy value, for that
700 * identifier. Will be @c 0 if @p policy passed is invalid.
704 EAPI int elm_policy_get(unsigned int policy);
707 * Set a label of an object
709 * @param obj The Elementary object
710 * @param part The text part name to set (NULL for the default label)
711 * @param label The new text of the label
713 * @note Elementary objects may have many labels (e.g. Action Slider)
717 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
719 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
722 * Get a label of an object
724 * @param obj The Elementary object
725 * @param part The text part name to get (NULL for the default label)
726 * @return text of the label or NULL for any error
728 * @note Elementary objects may have many labels (e.g. Action Slider)
732 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
734 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
737 * Set a content of an object
739 * @param obj The Elementary object
740 * @param part The content part name to set (NULL for the default content)
741 * @param content The new content of the object
743 * @note Elementary objects may have many contents
747 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
749 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
752 * Get a content of an object
754 * @param obj The Elementary object
755 * @param item The content part name to get (NULL for the default content)
756 * @return content of the object or NULL for any error
758 * @note Elementary objects may have many contents
762 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
764 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
767 * Unset a content of an object
769 * @param obj The Elementary object
770 * @param item The content part name to unset (NULL for the default content)
772 * @note Elementary objects may have many contents
776 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
778 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
781 * Set a content of an object item
783 * @param it The Elementary object item
784 * @param part The content part name to unset (NULL for the default content)
785 * @param content The new content of the object item
787 * @note Elementary object items may have many contents
791 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
793 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
796 * Get a content of an object item
798 * @param it The Elementary object item
799 * @param part The content part name to unset (NULL for the default content)
800 * @return content of the object item or NULL for any error
802 * @note Elementary object items may have many contents
806 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
808 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
811 * Unset a content of an object item
813 * @param it The Elementary object item
814 * @param part The content part name to unset (NULL for the default content)
816 * @note Elementary object items may have many contents
820 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
822 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
825 * Set a label of an objec itemt
827 * @param it The Elementary object item
828 * @param part The text part name to set (NULL for the default label)
829 * @param label The new text of the label
831 * @note Elementary object items may have many labels
835 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
837 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
840 * Get a label of an object
842 * @param it The Elementary object item
843 * @param part The text part name to get (NULL for the default label)
844 * @return text of the label or NULL for any error
846 * @note Elementary object items may have many labels
850 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
852 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
858 EAPI void elm_all_flush(void);
859 EAPI int elm_cache_flush_interval_get(void);
860 EAPI void elm_cache_flush_interval_set(int size);
861 EAPI void elm_cache_flush_interval_all_set(int size);
862 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
863 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
864 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
865 EAPI int elm_font_cache_get(void);
866 EAPI void elm_font_cache_set(int size);
867 EAPI void elm_font_cache_all_set(int size);
868 EAPI int elm_image_cache_get(void);
869 EAPI void elm_image_cache_set(int size);
870 EAPI void elm_image_cache_all_set(int size);
871 EAPI int elm_edje_file_cache_get(void);
872 EAPI void elm_edje_file_cache_set(int size);
873 EAPI void elm_edje_file_cache_all_set(int size);
874 EAPI int elm_edje_collection_cache_get(void);
875 EAPI void elm_edje_collection_cache_set(int size);
876 EAPI void elm_edje_collection_cache_all_set(int size);
879 * @defgroup Scaling Selective Widget Scaling
881 * Different widgets can be scaled independently. These functions
882 * allow you to manipulate this scaling on a per-widget basis. The
883 * object and all its children get their scaling factors multiplied
884 * by the scale factor set. This is multiplicative, in that if a
885 * child also has a scale size set it is in turn multiplied by its
886 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
887 * double size, @c 0.5 is half, etc.
889 * @ref general_functions_example_page "This" example contemplates
890 * some of these functions.
894 * Set the scaling factor for a given Elementary object
896 * @param obj The Elementary to operate on
897 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
902 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
905 * Get the scaling factor for a given Elementary object
907 * @param obj The object
908 * @return The scaling factor set by elm_object_scale_set()
912 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
913 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
914 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
915 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
916 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
918 * Set the style to use by a widget
920 * Sets the style name that will define the appearance of a widget. Styles
921 * vary from widget to widget and may also be defined by other themes
922 * by means of extensions and overlays.
924 * @param obj The Elementary widget to style
925 * @param style The style name to use
927 * @see elm_theme_extension_add()
928 * @see elm_theme_overlay_add()
932 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
934 * Get the style used by the widget
936 * This gets the style being used for that widget. Note that the string
937 * pointer is only valid as longas the object is valid and the style doesn't
940 * @param obj The Elementary widget to query for its style
941 * @return The style name used
943 * @see elm_object_style_set()
947 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
950 * @defgroup Styles Styles
952 * Widgets can have different styles of look. These generic API's
953 * set styles of widgets, if they support them (and if the theme(s)
956 * @ref general_functions_example_page "This" example contemplates
957 * some of these functions.
961 * Set the disabled state of an Elementary object.
963 * @param obj The Elementary object to operate on
964 * @param disabled The state to put in in: @c EINA_TRUE for
965 * disabled, @c EINA_FALSE for enabled
967 * Elementary objects can be @b disabled, in which state they won't
968 * receive input and, in general, will be themed differently from
969 * their normal state, usually greyed out. Useful for contexts
970 * where you don't want your users to interact with some of the
971 * parts of you interface.
973 * This sets the state for the widget, either disabling it or
978 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
981 * Get the disabled state of an Elementary object.
983 * @param obj The Elementary object to operate on
984 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
985 * if it's enabled (or on errors)
987 * This gets the state of the widget, which might be enabled or disabled.
991 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
994 * @defgroup WidgetNavigation Widget Tree Navigation.
996 * How to check if an Evas Object is an Elementary widget? How to
997 * get the first elementary widget that is parent of the given
998 * object? These are all covered in widget tree navigation.
1000 * @ref general_functions_example_page "This" example contemplates
1001 * some of these functions.
1004 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1007 * Get the first parent of the given object that is an Elementary
1010 * @param obj the Elementary object to query parent from.
1011 * @return the parent object that is an Elementary widget, or @c
1012 * NULL, if it was not found.
1014 * Use this to query for an object's parent widget.
1016 * @note Most of Elementary users wouldn't be mixing non-Elementary
1017 * smart objects in the objects tree of an application, as this is
1018 * an advanced usage of Elementary with Evas. So, except for the
1019 * application's window, which is the root of that tree, all other
1020 * objects would have valid Elementary widget parents.
1022 * @ingroup WidgetNavigation
1024 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1025 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1026 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1028 EAPI double elm_scale_get(void);
1029 EAPI void elm_scale_set(double scale);
1030 EAPI void elm_scale_all_set(double scale);
1032 EAPI Eina_Bool elm_mirrored_get(void);
1033 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1035 EAPI Eina_Bool elm_config_save(void);
1036 EAPI void elm_config_reload(void);
1038 EAPI const char *elm_profile_current_get(void);
1039 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1040 EAPI void elm_profile_dir_free(const char *p_dir);
1041 EAPI Eina_List *elm_profile_list_get(void);
1042 EAPI void elm_profile_list_free(Eina_List *l);
1043 EAPI void elm_profile_set(const char *profile);
1044 EAPI void elm_profile_all_set(const char *profile);
1046 EAPI const char *elm_engine_current_get(void);
1047 EAPI void elm_engine_set(const char *engine);
1049 typedef struct _Elm_Text_Class
1055 typedef struct _Elm_Font_Overlay
1057 const char *text_class;
1059 Evas_Font_Size size;
1062 typedef struct _Elm_Font_Properties
1066 } Elm_Font_Properties;
1068 EAPI const Eina_List *elm_text_classes_list_get(void);
1069 EAPI void elm_text_classes_list_free(const Eina_List *list);
1071 EAPI const Eina_List *elm_font_overlay_list_get(void);
1072 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1073 EAPI void elm_font_overlay_unset(const char *text_class);
1074 EAPI void elm_font_overlay_apply(void);
1075 EAPI void elm_font_overlay_all_apply(void);
1077 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1078 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1079 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1080 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1081 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1082 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1085 * @defgroup Fingers Fingers
1087 * Elementary is designed to be finger-friendly for touchscreens,
1088 * and so in addition to scaling for display resolution, it can
1089 * also scale based on finger "resolution" (or size). You can then
1090 * customize the granularity of the areas meant to receive clicks
1093 * Different profiles may have pre-set values for finger sizes.
1095 * @ref general_functions_example_page "This" example contemplates
1096 * some of these functions.
1100 * Get the configured "finger size"
1102 * @return The finger size
1104 * This gets the globally configured finger size, <b>in pixels</b>
1108 EAPI Evas_Coord elm_finger_size_get(void);
1109 EAPI void elm_finger_size_set(Evas_Coord size);
1110 EAPI void elm_finger_size_all_set(Evas_Coord size);
1113 * @defgroup Focus Focus
1115 * An Elementary application has, at all times, one (and only one)
1116 * @b focused object. This is what determines where the input
1117 * events go to within the application's window. Also, focused
1118 * objects can be decorated differently, in order to signal to the
1119 * user where the input is, at a given moment.
1121 * Elementary applications also have the concept of <b>focus
1122 * chain</b>: one can cycle through all the windows' focusable
1123 * objects by input (tab key) or programmatically. The default
1124 * focus chain for an application is the one define by the order in
1125 * which the widgets where added in code. One will cycle through
1126 * top level widgets, and, for each one containg sub-objects, cycle
1127 * through them all, before returning to the level
1128 * above. Elementary also allows one to set @b custom focus chains
1129 * for their applications.
1131 * Besides the focused decoration a widget may exhibit, when it
1132 * gets focus, Elementary has a @b global focus highlight object
1133 * that can be enabled for a window. If one chooses to do so, this
1134 * extra highlight effect will surround the current focused object,
1137 * @note Some Elementary widgets are @b unfocusable, after
1138 * creation, by their very nature: they are not meant to be
1139 * interacted with input events, but are there just for visual
1142 * @ref general_functions_example_page "This" example contemplates
1143 * some of these functions.
1146 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1147 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1148 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1149 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1152 * Get the whether an Elementary object has the focus or not.
1154 * @param obj The Elementary object to get the information from
1155 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1156 * not (and on errors).
1158 * @see elm_object_focus()
1162 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1165 * Set/unset focus to a given Elementary object.
1167 * @param obj The Elementary object to operate on.
1168 * @param enable @c EINA_TRUE Set focus to a given object,
1169 * @c EINA_FALSE Unset focus to a given object.
1171 * @note When you set focus to this object, if it can handle focus, will
1172 * take the focus away from the one who had it previously and will, for
1173 * now on, be the one receiving input events. Unsetting focus will remove
1174 * the focus from @p obj, passing it back to the previous element in the
1177 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1181 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1184 * Make a given Elementary object the focused one.
1186 * @param obj The Elementary object to make focused.
1188 * @note This object, if it can handle focus, will take the focus
1189 * away from the one who had it previously and will, for now on, be
1190 * the one receiving input events.
1192 * @see elm_object_focus_get()
1193 * @deprecated use elm_object_focus_set() instead.
1197 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1200 * Remove the focus from an Elementary object
1202 * @param obj The Elementary to take focus from
1204 * This removes the focus from @p obj, passing it back to the
1205 * previous element in the focus chain list.
1207 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1208 * @deprecated use elm_object_focus_set() instead.
1212 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1215 * Set the ability for an Element object to be focused
1217 * @param obj The Elementary object to operate on
1218 * @param enable @c EINA_TRUE if the object can be focused, @c
1219 * EINA_FALSE if not (and on errors)
1221 * This sets whether the object @p obj is able to take focus or
1222 * not. Unfocusable objects do nothing when programmatically
1223 * focused, being the nearest focusable parent object the one
1224 * really getting focus. Also, when they receive mouse input, they
1225 * will get the event, but not take away the focus from where it
1230 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1233 * Get whether an Elementary object is focusable or not
1235 * @param obj The Elementary object to operate on
1236 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1237 * EINA_FALSE if not (and on errors)
1239 * @note Objects which are meant to be interacted with by input
1240 * events are created able to be focused, by default. All the
1245 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1247 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1248 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1249 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1250 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1251 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1252 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1253 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1256 * Make the elementary object and its children to be unfocusable (or focusable).
1258 * @param obj The Elementary object to operate on
1259 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1260 * @c EINA_FALSE for focusable.
1262 * This sets whether the object @p obj and its children objects
1263 * are able to take focus or not. If the tree is set as unfocusable,
1264 * newest focused object which is not in this tree will get focus.
1265 * This API can be helpful for an object to be deleted.
1266 * When an object will be deleted soon, it and its children may not
1267 * want to get focus (by focus reverting or by other focus controls).
1268 * Then, just use this API before deleting.
1270 * @see elm_object_tree_unfocusable_get()
1274 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1277 * Get whether an Elementary object and its children are unfocusable or not.
1279 * @param obj The Elementary object to get the information from
1280 * @return @c EINA_TRUE, if the tree is unfocussable,
1281 * @c EINA_FALSE if not (and on errors).
1283 * @see elm_object_tree_unfocusable_set()
1287 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1289 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1290 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1291 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1292 EAPI double elm_scroll_bounce_friction_get(void);
1293 EAPI void elm_scroll_bounce_friction_set(double friction);
1294 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1295 EAPI double elm_scroll_page_scroll_friction_get(void);
1296 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1297 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1298 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1299 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1300 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1301 EAPI double elm_scroll_zoom_friction_get(void);
1302 EAPI void elm_scroll_zoom_friction_set(double friction);
1303 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1304 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1305 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1306 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1307 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1308 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1309 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1310 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1311 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1312 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1313 EAPI double elm_scroll_thumbscroll_friction_get(void);
1314 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1315 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1316 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1317 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1318 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1320 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1321 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1322 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1323 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1324 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1325 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1326 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1327 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1329 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1330 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);
1331 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);
1333 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1334 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1337 * Adjust size of an element for finger usage.
1339 * @param times_w How many fingers should fit horizontally
1340 * @param w Pointer to the width size to adjust
1341 * @param times_h How many fingers should fit vertically
1342 * @param h Pointer to the height size to adjust
1344 * This takes width and height sizes (in pixels) as input and a
1345 * size multiple (which is how many fingers you want to place
1346 * within the area, being "finger" the size set by
1347 * elm_finger_size_set()), and adjusts the size to be large enough
1348 * to accommodate the resulting size -- if it doesn't already
1349 * accommodate it. On return the @p w and @p h sizes pointed to by
1350 * these parameters will be modified, on those conditions.
1352 * @note This is kind of a low level Elementary call, most useful
1353 * on size evaluation times for widgets. An external user wouldn't
1354 * be calling, most of the time.
1358 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1360 EAPI double elm_longpress_timeout_get(void);
1361 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1364 * don't use it unless you are sure
1366 EAPI void elm_object_tree_dump(const Evas_Object *top);
1367 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1372 * @defgroup Theme Theme
1374 * Elementary uses Edje to theme its widgets, naturally. But for the most
1375 * part this is hidden behind a simpler interface that lets the user set
1376 * extensions and choose the style of widgets in a much easier way.
1378 * Instead of thinking in terms of paths to Edje files and their groups
1379 * each time you want to change the appearance of a widget, Elementary
1380 * works so you can add any theme file with extensions or replace the
1381 * main theme at one point in the application, and then just set the style
1382 * of widgets with elm_object_style_set() and related functions. Elementary
1383 * will then look in its list of themes for a matching group and apply it,
1384 * and when the theme changes midway through the application, all widgets
1385 * will be updated accordingly.
1387 * There are three concepts you need to know to understand how Elementary
1388 * theming works: default theme, extensions and overlays.
1390 * Default theme, obviously enough, is the one that provides the default
1391 * look of all widgets. End users can change the theme used by Elementary
1392 * by setting the @c ELM_THEME environment variable before running an
1393 * application, or globally for all programs using the @c elementary_config
1394 * utility. Applications can change the default theme using elm_theme_set(),
1395 * but this can go against the user wishes, so it's not an adviced practice.
1397 * Ideally, applications should find everything they need in the already
1398 * provided theme, but there may be occasions when that's not enough and
1399 * custom styles are required to correctly express the idea. For this
1400 * cases, Elementary has extensions.
1402 * Extensions allow the application developer to write styles of its own
1403 * to apply to some widgets. This requires knowledge of how each widget
1404 * is themed, as extensions will always replace the entire group used by
1405 * the widget, so important signals and parts need to be there for the
1406 * object to behave properly (see documentation of Edje for details).
1407 * Once the theme for the extension is done, the application needs to add
1408 * it to the list of themes Elementary will look into, using
1409 * elm_theme_extension_add(), and set the style of the desired widgets as
1410 * he would normally with elm_object_style_set().
1412 * Overlays, on the other hand, can replace the look of all widgets by
1413 * overriding the default style. Like extensions, it's up to the application
1414 * developer to write the theme for the widgets it wants, the difference
1415 * being that when looking for the theme, Elementary will check first the
1416 * list of overlays, then the set theme and lastly the list of extensions,
1417 * so with overlays it's possible to replace the default view and every
1418 * widget will be affected. This is very much alike to setting the whole
1419 * theme for the application and will probably clash with the end user
1420 * options, not to mention the risk of ending up with not matching styles
1421 * across the program. Unless there's a very special reason to use them,
1422 * overlays should be avoided for the resons exposed before.
1424 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1425 * keeps one default internally and every function that receives one of
1426 * these can be called with NULL to refer to this default (except for
1427 * elm_theme_free()). It's possible to create a new instance of a
1428 * ::Elm_Theme to set other theme for a specific widget (and all of its
1429 * children), but this is as discouraged, if not even more so, than using
1430 * overlays. Don't use this unless you really know what you are doing.
1432 * But to be less negative about things, you can look at the following
1434 * @li @ref theme_example_01 "Using extensions"
1435 * @li @ref theme_example_02 "Using overlays"
1440 * @typedef Elm_Theme
1442 * Opaque handler for the list of themes Elementary looks for when
1443 * rendering widgets.
1445 * Stay out of this unless you really know what you are doing. For most
1446 * cases, sticking to the default is all a developer needs.
1448 typedef struct _Elm_Theme Elm_Theme;
1451 * Create a new specific theme
1453 * This creates an empty specific theme that only uses the default theme. A
1454 * specific theme has its own private set of extensions and overlays too
1455 * (which are empty by default). Specific themes do not fall back to themes
1456 * of parent objects. They are not intended for this use. Use styles, overlays
1457 * and extensions when needed, but avoid specific themes unless there is no
1458 * other way (example: you want to have a preview of a new theme you are
1459 * selecting in a "theme selector" window. The preview is inside a scroller
1460 * and should display what the theme you selected will look like, but not
1461 * actually apply it yet. The child of the scroller will have a specific
1462 * theme set to show this preview before the user decides to apply it to all
1465 EAPI Elm_Theme *elm_theme_new(void);
1467 * Free a specific theme
1469 * @param th The theme to free
1471 * This frees a theme created with elm_theme_new().
1473 EAPI void elm_theme_free(Elm_Theme *th);
1475 * Copy the theme fom the source to the destination theme
1477 * @param th The source theme to copy from
1478 * @param thdst The destination theme to copy data to
1480 * This makes a one-time static copy of all the theme config, extensions
1481 * and overlays from @p th to @p thdst. If @p th references a theme, then
1482 * @p thdst is also set to reference it, with all the theme settings,
1483 * overlays and extensions that @p th had.
1485 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1487 * Tell the source theme to reference the ref theme
1489 * @param th The theme that will do the referencing
1490 * @param thref The theme that is the reference source
1492 * This clears @p th to be empty and then sets it to refer to @p thref
1493 * so @p th acts as an override to @p thref, but where its overrides
1494 * don't apply, it will fall through to @p thref for configuration.
1496 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1498 * Return the theme referred to
1500 * @param th The theme to get the reference from
1501 * @return The referenced theme handle
1503 * This gets the theme set as the reference theme by elm_theme_ref_set().
1504 * If no theme is set as a reference, NULL is returned.
1506 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1508 * Return the default theme
1510 * @return The default theme handle
1512 * This returns the internal default theme setup handle that all widgets
1513 * use implicitly unless a specific theme is set. This is also often use
1514 * as a shorthand of NULL.
1516 EAPI Elm_Theme *elm_theme_default_get(void);
1518 * Prepends a theme overlay to the list of overlays
1520 * @param th The theme to add to, or if NULL, the default theme
1521 * @param item The Edje file path to be used
1523 * Use this if your application needs to provide some custom overlay theme
1524 * (An Edje file that replaces some default styles of widgets) where adding
1525 * new styles, or changing system theme configuration is not possible. Do
1526 * NOT use this instead of a proper system theme configuration. Use proper
1527 * configuration files, profiles, environment variables etc. to set a theme
1528 * so that the theme can be altered by simple confiugration by a user. Using
1529 * this call to achieve that effect is abusing the API and will create lots
1532 * @see elm_theme_extension_add()
1534 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1536 * Delete a theme overlay from the list of overlays
1538 * @param th The theme to delete from, or if NULL, the default theme
1539 * @param item The name of the theme overlay
1541 * @see elm_theme_overlay_add()
1543 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1545 * Appends a theme extension to the list of extensions.
1547 * @param th The theme to add to, or if NULL, the default theme
1548 * @param item The Edje file path to be used
1550 * This is intended when an application needs more styles of widgets or new
1551 * widget themes that the default does not provide (or may not provide). The
1552 * application has "extended" usage by coming up with new custom style names
1553 * for widgets for specific uses, but as these are not "standard", they are
1554 * not guaranteed to be provided by a default theme. This means the
1555 * application is required to provide these extra elements itself in specific
1556 * Edje files. This call adds one of those Edje files to the theme search
1557 * path to be search after the default theme. The use of this call is
1558 * encouraged when default styles do not meet the needs of the application.
1559 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1561 * @see elm_object_style_set()
1563 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1565 * Deletes a theme extension from the list of extensions.
1567 * @param th The theme to delete from, or if NULL, the default theme
1568 * @param item The name of the theme extension
1570 * @see elm_theme_extension_add()
1572 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1574 * Set the theme search order for the given theme
1576 * @param th The theme to set the search order, or if NULL, the default theme
1577 * @param theme Theme search string
1579 * This sets the search string for the theme in path-notation from first
1580 * theme to search, to last, delimited by the : character. Example:
1582 * "shiny:/path/to/file.edj:default"
1584 * See the ELM_THEME environment variable for more information.
1586 * @see elm_theme_get()
1587 * @see elm_theme_list_get()
1589 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1591 * Return the theme search order
1593 * @param th The theme to get the search order, or if NULL, the default theme
1594 * @return The internal search order path
1596 * This function returns a colon separated string of theme elements as
1597 * returned by elm_theme_list_get().
1599 * @see elm_theme_set()
1600 * @see elm_theme_list_get()
1602 EAPI const char *elm_theme_get(Elm_Theme *th);
1604 * Return a list of theme elements to be used in a theme.
1606 * @param th Theme to get the list of theme elements from.
1607 * @return The internal list of theme elements
1609 * This returns the internal list of theme elements (will only be valid as
1610 * long as the theme is not modified by elm_theme_set() or theme is not
1611 * freed by elm_theme_free(). This is a list of strings which must not be
1612 * altered as they are also internal. If @p th is NULL, then the default
1613 * theme element list is returned.
1615 * A theme element can consist of a full or relative path to a .edj file,
1616 * or a name, without extension, for a theme to be searched in the known
1617 * theme paths for Elemementary.
1619 * @see elm_theme_set()
1620 * @see elm_theme_get()
1622 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1624 * Return the full patrh for a theme element
1626 * @param f The theme element name
1627 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1628 * @return The full path to the file found.
1630 * This returns a string you should free with free() on success, NULL on
1631 * failure. This will search for the given theme element, and if it is a
1632 * full or relative path element or a simple searchable name. The returned
1633 * path is the full path to the file, if searched, and the file exists, or it
1634 * is simply the full path given in the element or a resolved path if
1635 * relative to home. The @p in_search_path boolean pointed to is set to
1636 * EINA_TRUE if the file was a searchable file andis in the search path,
1637 * and EINA_FALSE otherwise.
1639 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1641 * Flush the current theme.
1643 * @param th Theme to flush
1645 * This flushes caches that let elementary know where to find theme elements
1646 * in the given theme. If @p th is NULL, then the default theme is flushed.
1647 * Call this function if source theme data has changed in such a way as to
1648 * make any caches Elementary kept invalid.
1650 EAPI void elm_theme_flush(Elm_Theme *th);
1652 * This flushes all themes (default and specific ones).
1654 * This will flush all themes in the current application context, by calling
1655 * elm_theme_flush() on each of them.
1657 EAPI void elm_theme_full_flush(void);
1659 * Set the theme for all elementary using applications on the current display
1661 * @param theme The name of the theme to use. Format same as the ELM_THEME
1662 * environment variable.
1664 EAPI void elm_theme_all_set(const char *theme);
1666 * Return a list of theme elements in the theme search path
1668 * @return A list of strings that are the theme element names.
1670 * This lists all available theme files in the standard Elementary search path
1671 * for theme elements, and returns them in alphabetical order as theme
1672 * element names in a list of strings. Free this with
1673 * elm_theme_name_available_list_free() when you are done with the list.
1675 EAPI Eina_List *elm_theme_name_available_list_new(void);
1677 * Free the list returned by elm_theme_name_available_list_new()
1679 * This frees the list of themes returned by
1680 * elm_theme_name_available_list_new(). Once freed the list should no longer
1681 * be used. a new list mys be created.
1683 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1685 * Set a specific theme to be used for this object and its children
1687 * @param obj The object to set the theme on
1688 * @param th The theme to set
1690 * This sets a specific theme that will be used for the given object and any
1691 * child objects it has. If @p th is NULL then the theme to be used is
1692 * cleared and the object will inherit its theme from its parent (which
1693 * ultimately will use the default theme if no specific themes are set).
1695 * Use special themes with great care as this will annoy users and make
1696 * configuration difficult. Avoid any custom themes at all if it can be
1699 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1701 * Get the specific theme to be used
1703 * @param obj The object to get the specific theme from
1704 * @return The specifc theme set.
1706 * This will return a specific theme set, or NULL if no specific theme is
1707 * set on that object. It will not return inherited themes from parents, only
1708 * the specific theme set for that specific object. See elm_object_theme_set()
1709 * for more information.
1711 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1717 /** @defgroup Win Win
1719 * @image html img/widget/win/preview-00.png
1720 * @image latex img/widget/win/preview-00.eps
1722 * The window class of Elementary. Contains functions to manipulate
1723 * windows. The Evas engine used to render the window contents is specified
1724 * in the system or user elementary config files (whichever is found last),
1725 * and can be overridden with the ELM_ENGINE environment variable for
1726 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1727 * compilation setup and modules actually installed at runtime) are (listed
1728 * in order of best supported and most likely to be complete and work to
1731 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1732 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1734 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1736 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1738 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1740 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1741 * rendering using SDL as the buffer)
1742 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1743 * GDI with software)
1744 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1745 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1746 * grayscale using dedicated 8bit software engine in X11)
1747 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1748 * X11 using 16bit software engine)
1749 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1750 * (Windows CE rendering via GDI with 16bit software renderer)
1751 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1752 * buffer with 16bit software renderer)
1754 * All engines use a simple string to select the engine to render, EXCEPT
1755 * the "shot" engine. This actually encodes the output of the virtual
1756 * screenshot and how long to delay in the engine string. The engine string
1757 * is encoded in the following way:
1759 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1761 * Where options are separated by a ":" char if more than one option is
1762 * given, with delay, if provided being the first option and file the last
1763 * (order is important). The delay specifies how long to wait after the
1764 * window is shown before doing the virtual "in memory" rendering and then
1765 * save the output to the file specified by the file option (and then exit).
1766 * If no delay is given, the default is 0.5 seconds. If no file is given the
1767 * default output file is "out.png". Repeat option is for continous
1768 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1769 * fixed to "out001.png" Some examples of using the shot engine:
1771 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1772 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1773 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1774 * ELM_ENGINE="shot:delay=2.0" elementary_test
1775 * ELM_ENGINE="shot:" elementary_test
1777 * Signals that you can add callbacks for are:
1779 * @li "delete,request": the user requested to close the window. See
1780 * elm_win_autodel_set().
1781 * @li "focus,in": window got focus
1782 * @li "focus,out": window lost focus
1783 * @li "moved": window that holds the canvas was moved
1786 * @li @ref win_example_01
1791 * Defines the types of window that can be created
1793 * These are hints set on the window so that a running Window Manager knows
1794 * how the window should be handled and/or what kind of decorations it
1797 * Currently, only the X11 backed engines use them.
1799 typedef enum _Elm_Win_Type
1801 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1802 window. Almost every window will be created with this
1804 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1805 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1806 window holding desktop icons. */
1807 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1808 be kept on top of any other window by the Window
1810 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1812 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1813 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1815 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1816 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1817 entry in a menubar is clicked. Typically used
1818 with elm_win_override_set(). This hint exists
1819 for completion only, as the EFL way of
1820 implementing a menu would not normally use a
1821 separate window for its contents. */
1822 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1823 triggered by right-clicking an object. */
1824 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1825 explanatory text that typically appear after the
1826 mouse cursor hovers over an object for a while.
1827 Typically used with elm_win_override_set() and also
1828 not very commonly used in the EFL. */
1829 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1830 battery life or a new E-Mail received. */
1831 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1832 usually used in the EFL. */
1833 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1834 object being dragged across different windows, or even
1835 applications. Typically used with
1836 elm_win_override_set(). */
1837 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1838 buffer. No actual window is created for this
1839 type, instead the window and all of its
1840 contents will be rendered to an image buffer.
1841 This allows to have children window inside a
1842 parent one just like any other object would
1843 be, and do other things like applying @c
1844 Evas_Map effects to it. This is the only type
1845 of window that requires the @c parent
1846 parameter of elm_win_add() to be a valid @c
1851 * The differents layouts that can be requested for the virtual keyboard.
1853 * When the application window is being managed by Illume, it may request
1854 * any of the following layouts for the virtual keyboard.
1856 typedef enum _Elm_Win_Keyboard_Mode
1858 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1859 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1860 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1861 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1862 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1863 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1864 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1865 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1866 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1867 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1868 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1869 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1870 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1871 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1872 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1873 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1874 } Elm_Win_Keyboard_Mode;
1877 * Available commands that can be sent to the Illume manager.
1879 * When running under an Illume session, a window may send commands to the
1880 * Illume manager to perform different actions.
1882 typedef enum _Elm_Illume_Command
1884 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1886 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1888 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1890 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1891 } Elm_Illume_Command;
1894 * Adds a window object. If this is the first window created, pass NULL as
1897 * @param parent Parent object to add the window to, or NULL
1898 * @param name The name of the window
1899 * @param type The window type, one of #Elm_Win_Type.
1901 * The @p parent paramter can be @c NULL for every window @p type except
1902 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1903 * which the image object will be created.
1905 * @return The created object, or NULL on failure
1907 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1909 * Add @p subobj as a resize object of window @p obj.
1912 * Setting an object as a resize object of the window means that the
1913 * @p subobj child's size and position will be controlled by the window
1914 * directly. That is, the object will be resized to match the window size
1915 * and should never be moved or resized manually by the developer.
1917 * In addition, resize objects of the window control what the minimum size
1918 * of it will be, as well as whether it can or not be resized by the user.
1920 * For the end user to be able to resize a window by dragging the handles
1921 * or borders provided by the Window Manager, or using any other similar
1922 * mechanism, all of the resize objects in the window should have their
1923 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1925 * @param obj The window object
1926 * @param subobj The resize object to add
1928 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1930 * Delete @p subobj as a resize object of window @p obj.
1932 * This function removes the object @p subobj from the resize objects of
1933 * the window @p obj. It will not delete the object itself, which will be
1934 * left unmanaged and should be deleted by the developer, manually handled
1935 * or set as child of some other container.
1937 * @param obj The window object
1938 * @param subobj The resize object to add
1940 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1942 * Set the title of the window
1944 * @param obj The window object
1945 * @param title The title to set
1947 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1949 * Get the title of the window
1951 * The returned string is an internal one and should not be freed or
1952 * modified. It will also be rendered invalid if a new title is set or if
1953 * the window is destroyed.
1955 * @param obj The window object
1958 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1960 * Set the window's autodel state.
1962 * When closing the window in any way outside of the program control, like
1963 * pressing the X button in the titlebar or using a command from the
1964 * Window Manager, a "delete,request" signal is emitted to indicate that
1965 * this event occurred and the developer can take any action, which may
1966 * include, or not, destroying the window object.
1968 * When the @p autodel parameter is set, the window will be automatically
1969 * destroyed when this event occurs, after the signal is emitted.
1970 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1971 * and is up to the program to do so when it's required.
1973 * @param obj The window object
1974 * @param autodel If true, the window will automatically delete itself when
1977 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1979 * Get the window's autodel state.
1981 * @param obj The window object
1982 * @return If the window will automatically delete itself when closed
1984 * @see elm_win_autodel_set()
1986 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1988 * Activate a window object.
1990 * This function sends a request to the Window Manager to activate the
1991 * window pointed by @p obj. If honored by the WM, the window will receive
1992 * the keyboard focus.
1994 * @note This is just a request that a Window Manager may ignore, so calling
1995 * this function does not ensure in any way that the window will be the
1996 * active one after it.
1998 * @param obj The window object
2000 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2002 * Lower a window object.
2004 * Places the window pointed by @p obj at the bottom of the stack, so that
2005 * no other window is covered by it.
2007 * If elm_win_override_set() is not set, the Window Manager may ignore this
2010 * @param obj The window object
2012 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2014 * Raise a window object.
2016 * Places the window pointed by @p obj at the top of the stack, so that it's
2017 * not covered by any other window.
2019 * If elm_win_override_set() is not set, the Window Manager may ignore this
2022 * @param obj The window object
2024 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2026 * Set the borderless state of a window.
2028 * This function requests the Window Manager to not draw any decoration
2029 * around the window.
2031 * @param obj The window object
2032 * @param borderless If true, the window is borderless
2034 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2036 * Get the borderless state of a window.
2038 * @param obj The window object
2039 * @return If true, the window is borderless
2041 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2043 * Set the shaped state of a window.
2045 * Shaped windows, when supported, will render the parts of the window that
2046 * has no content, transparent.
2048 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2049 * background object or cover the entire window in any other way, or the
2050 * parts of the canvas that have no data will show framebuffer artifacts.
2052 * @param obj The window object
2053 * @param shaped If true, the window is shaped
2055 * @see elm_win_alpha_set()
2057 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2059 * Get the shaped state of a window.
2061 * @param obj The window object
2062 * @return If true, the window is shaped
2064 * @see elm_win_shaped_set()
2066 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2068 * Set the alpha channel state of a window.
2070 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2071 * possibly making parts of the window completely or partially transparent.
2072 * This is also subject to the underlying system supporting it, like for
2073 * example, running under a compositing manager. If no compositing is
2074 * available, enabling this option will instead fallback to using shaped
2075 * windows, with elm_win_shaped_set().
2077 * @param obj The window object
2078 * @param alpha If true, the window has an alpha channel
2080 * @see elm_win_alpha_set()
2082 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2084 * Get the transparency state of a window.
2086 * @param obj The window object
2087 * @return If true, the window is transparent
2089 * @see elm_win_transparent_set()
2091 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2093 * Set the transparency state of a window.
2095 * Use elm_win_alpha_set() instead.
2097 * @param obj The window object
2098 * @param transparent If true, the window is transparent
2100 * @see elm_win_alpha_set()
2102 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2104 * Get the alpha channel state of a window.
2106 * @param obj The window object
2107 * @return If true, the window has an alpha channel
2109 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2111 * Set the override state of a window.
2113 * A window with @p override set to EINA_TRUE will not be managed by the
2114 * Window Manager. This means that no decorations of any kind will be shown
2115 * for it, moving and resizing must be handled by the application, as well
2116 * as the window visibility.
2118 * This should not be used for normal windows, and even for not so normal
2119 * ones, it should only be used when there's a good reason and with a lot
2120 * of care. Mishandling override windows may result situations that
2121 * disrupt the normal workflow of the end user.
2123 * @param obj The window object
2124 * @param override If true, the window is overridden
2126 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2128 * Get the override state of a window.
2130 * @param obj The window object
2131 * @return If true, the window is overridden
2133 * @see elm_win_override_set()
2135 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2137 * Set the fullscreen state of a window.
2139 * @param obj The window object
2140 * @param fullscreen If true, the window is fullscreen
2142 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2144 * Get the fullscreen state of a window.
2146 * @param obj The window object
2147 * @return If true, the window is fullscreen
2149 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2151 * Set the maximized state of a window.
2153 * @param obj The window object
2154 * @param maximized If true, the window is maximized
2156 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2158 * Get the maximized state of a window.
2160 * @param obj The window object
2161 * @return If true, the window is maximized
2163 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2165 * Set the iconified state of a window.
2167 * @param obj The window object
2168 * @param iconified If true, the window is iconified
2170 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2172 * Get the iconified state of a window.
2174 * @param obj The window object
2175 * @return If true, the window is iconified
2177 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2179 * Set the layer of the window.
2181 * What this means exactly will depend on the underlying engine used.
2183 * In the case of X11 backed engines, the value in @p layer has the
2184 * following meanings:
2185 * @li < 3: The window will be placed below all others.
2186 * @li > 5: The window will be placed above all others.
2187 * @li other: The window will be placed in the default layer.
2189 * @param obj The window object
2190 * @param layer The layer of the window
2192 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2194 * Get the layer of the window.
2196 * @param obj The window object
2197 * @return The layer of the window
2199 * @see elm_win_layer_set()
2201 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2203 * Set the rotation of the window.
2205 * Most engines only work with multiples of 90.
2207 * This function is used to set the orientation of the window @p obj to
2208 * match that of the screen. The window itself will be resized to adjust
2209 * to the new geometry of its contents. If you want to keep the window size,
2210 * see elm_win_rotation_with_resize_set().
2212 * @param obj The window object
2213 * @param rotation The rotation of the window, in degrees (0-360),
2214 * counter-clockwise.
2216 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2218 * Rotates the window and resizes it.
2220 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2221 * that they fit inside the current window geometry.
2223 * @param obj The window object
2224 * @param layer The rotation of the window in degrees (0-360),
2225 * counter-clockwise.
2227 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2229 * Get the rotation of the window.
2231 * @param obj The window object
2232 * @return The rotation of the window in degrees (0-360)
2234 * @see elm_win_rotation_set()
2235 * @see elm_win_rotation_with_resize_set()
2237 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2239 * Set the sticky state of the window.
2241 * Hints the Window Manager that the window in @p obj should be left fixed
2242 * at its position even when the virtual desktop it's on moves or changes.
2244 * @param obj The window object
2245 * @param sticky If true, the window's sticky state is enabled
2247 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2249 * Get the sticky state of the window.
2251 * @param obj The window object
2252 * @return If true, the window's sticky state is enabled
2254 * @see elm_win_sticky_set()
2256 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2258 * Set if this window is an illume conformant window
2260 * @param obj The window object
2261 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2263 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2265 * Get if this window is an illume conformant window
2267 * @param obj The window object
2268 * @return A boolean if this window is illume conformant or not
2270 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2272 * Set a window to be an illume quickpanel window
2274 * By default window objects are not quickpanel windows.
2276 * @param obj The window object
2277 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2279 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2281 * Get if this window is a quickpanel or not
2283 * @param obj The window object
2284 * @return A boolean if this window is a quickpanel or not
2286 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2288 * Set the major priority of a quickpanel window
2290 * @param obj The window object
2291 * @param priority The major priority for this quickpanel
2293 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2295 * Get the major priority of a quickpanel window
2297 * @param obj The window object
2298 * @return The major priority of this quickpanel
2300 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2302 * Set the minor priority of a quickpanel window
2304 * @param obj The window object
2305 * @param priority The minor priority for this quickpanel
2307 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2309 * Get the minor priority of a quickpanel window
2311 * @param obj The window object
2312 * @return The minor priority of this quickpanel
2314 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2316 * Set which zone this quickpanel should appear in
2318 * @param obj The window object
2319 * @param zone The requested zone for this quickpanel
2321 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2323 * Get which zone this quickpanel should appear in
2325 * @param obj The window object
2326 * @return The requested zone for this quickpanel
2328 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2330 * Set the window to be skipped by keyboard focus
2332 * This sets the window to be skipped by normal keyboard input. This means
2333 * a window manager will be asked to not focus this window as well as omit
2334 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2336 * Call this and enable it on a window BEFORE you show it for the first time,
2337 * otherwise it may have no effect.
2339 * Use this for windows that have only output information or might only be
2340 * interacted with by the mouse or fingers, and never for typing input.
2341 * Be careful that this may have side-effects like making the window
2342 * non-accessible in some cases unless the window is specially handled. Use
2345 * @param obj The window object
2346 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2348 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2350 * Send a command to the windowing environment
2352 * This is intended to work in touchscreen or small screen device
2353 * environments where there is a more simplistic window management policy in
2354 * place. This uses the window object indicated to select which part of the
2355 * environment to control (the part that this window lives in), and provides
2356 * a command and an optional parameter structure (use NULL for this if not
2359 * @param obj The window object that lives in the environment to control
2360 * @param command The command to send
2361 * @param params Optional parameters for the command
2363 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2365 * Get the inlined image object handle
2367 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2368 * then the window is in fact an evas image object inlined in the parent
2369 * canvas. You can get this object (be careful to not manipulate it as it
2370 * is under control of elementary), and use it to do things like get pixel
2371 * data, save the image to a file, etc.
2373 * @param obj The window object to get the inlined image from
2374 * @return The inlined image object, or NULL if none exists
2376 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2378 * Set the enabled status for the focus highlight in a window
2380 * This function will enable or disable the focus highlight only for the
2381 * given window, regardless of the global setting for it
2383 * @param obj The window where to enable the highlight
2384 * @param enabled The enabled value for the highlight
2386 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2388 * Get the enabled value of the focus highlight for this window
2390 * @param obj The window in which to check if the focus highlight is enabled
2392 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2394 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2396 * Set the style for the focus highlight on this window
2398 * Sets the style to use for theming the highlight of focused objects on
2399 * the given window. If @p style is NULL, the default will be used.
2401 * @param obj The window where to set the style
2402 * @param style The style to set
2404 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2406 * Get the style set for the focus highlight object
2408 * Gets the style set for this windows highilght object, or NULL if none
2411 * @param obj The window to retrieve the highlights style from
2413 * @return The style set or NULL if none was. Default is used in that case.
2415 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2417 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2418 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2419 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2420 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2421 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2422 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2423 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2425 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2426 * (blank mouse, private mouse obj, defaultmouse)
2430 * Sets the keyboard mode of the window.
2432 * @param obj The window object
2433 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2435 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2437 * Gets the keyboard mode of the window.
2439 * @param obj The window object
2440 * @return The mode, one of #Elm_Win_Keyboard_Mode
2442 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2444 * Sets whether the window is a keyboard.
2446 * @param obj The window object
2447 * @param is_keyboard If true, the window is a virtual keyboard
2449 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2451 * Gets whether the window is a keyboard.
2453 * @param obj The window object
2454 * @return If the window is a virtual keyboard
2456 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2459 * Get the screen position of a window.
2461 * @param obj The window object
2462 * @param x The int to store the x coordinate to
2463 * @param y The int to store the y coordinate to
2465 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2471 * @defgroup Inwin Inwin
2473 * @image html img/widget/inwin/preview-00.png
2474 * @image latex img/widget/inwin/preview-00.eps
2475 * @image html img/widget/inwin/preview-01.png
2476 * @image latex img/widget/inwin/preview-01.eps
2477 * @image html img/widget/inwin/preview-02.png
2478 * @image latex img/widget/inwin/preview-02.eps
2480 * An inwin is a window inside a window that is useful for a quick popup.
2481 * It does not hover.
2483 * It works by creating an object that will occupy the entire window, so it
2484 * must be created using an @ref Win "elm_win" as parent only. The inwin
2485 * object can be hidden or restacked below every other object if it's
2486 * needed to show what's behind it without destroying it. If this is done,
2487 * the elm_win_inwin_activate() function can be used to bring it back to
2488 * full visibility again.
2490 * There are three styles available in the default theme. These are:
2491 * @li default: The inwin is sized to take over most of the window it's
2493 * @li minimal: The size of the inwin will be the minimum necessary to show
2495 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2496 * possible, but it's sized vertically the most it needs to fit its\
2499 * Some examples of Inwin can be found in the following:
2500 * @li @ref inwin_example_01
2505 * Adds an inwin to the current window
2507 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2508 * Never call this function with anything other than the top-most window
2509 * as its parameter, unless you are fond of undefined behavior.
2511 * After creating the object, the widget will set itself as resize object
2512 * for the window with elm_win_resize_object_add(), so when shown it will
2513 * appear to cover almost the entire window (how much of it depends on its
2514 * content and the style used). It must not be added into other container
2515 * objects and it needs not be moved or resized manually.
2517 * @param parent The parent object
2518 * @return The new object or NULL if it cannot be created
2520 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2522 * Activates an inwin object, ensuring its visibility
2524 * This function will make sure that the inwin @p obj is completely visible
2525 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2526 * to the front. It also sets the keyboard focus to it, which will be passed
2529 * The object's theme will also receive the signal "elm,action,show" with
2532 * @param obj The inwin to activate
2534 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2536 * Set the content of an inwin object.
2538 * Once the content object is set, a previously set one will be deleted.
2539 * If you want to keep that old content object, use the
2540 * elm_win_inwin_content_unset() function.
2542 * @param obj The inwin object
2543 * @param content The object to set as content
2545 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2547 * Get the content of an inwin object.
2549 * Return the content object which is set for this widget.
2551 * The returned object is valid as long as the inwin is still alive and no
2552 * other content is set on it. Deleting the object will notify the inwin
2553 * about it and this one will be left empty.
2555 * If you need to remove an inwin's content to be reused somewhere else,
2556 * see elm_win_inwin_content_unset().
2558 * @param obj The inwin object
2559 * @return The content that is being used
2561 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2563 * Unset the content of an inwin object.
2565 * Unparent and return the content object which was set for this widget.
2567 * @param obj The inwin object
2568 * @return The content that was being used
2570 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2574 /* X specific calls - won't work on non-x engines (return 0) */
2575 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2576 /* smart callbacks called:
2577 * "delete,request" - the user requested to delete the window
2578 * "focus,in" - window got focus
2579 * "focus,out" - window lost focus
2580 * "moved" - window that holds the canvas was moved
2586 * @image html img/widget/bg/preview-00.png
2587 * @image latex img/widget/bg/preview-00.eps
2589 * @brief Background object, used for setting a solid color, image or Edje
2590 * group as background to a window or any container object.
2592 * The bg object is used for setting a solid background to a window or
2593 * packing into any container object. It works just like an image, but has
2594 * some properties useful to a background, like setting it to tiled,
2595 * centered, scaled or stretched.
2597 * Here is some sample code using it:
2598 * @li @ref bg_01_example_page
2599 * @li @ref bg_02_example_page
2600 * @li @ref bg_03_example_page
2604 typedef enum _Elm_Bg_Option
2606 ELM_BG_OPTION_CENTER, /**< center the background */
2607 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2608 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2609 ELM_BG_OPTION_TILE /**< tile background at its original size */
2613 * Add a new background to the parent
2615 * @param parent The parent object
2616 * @return The new object or NULL if it cannot be created
2620 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2623 * Set the file (image or edje) used for the background
2625 * @param obj The bg object
2626 * @param file The file path
2627 * @param group Optional key (group in Edje) within the file
2629 * This sets the image file used in the background object. The image (or edje)
2630 * will be stretched (retaining aspect if its an image file) to completely fill
2631 * the bg object. This may mean some parts are not visible.
2633 * @note Once the image of @p obj is set, a previously set one will be deleted,
2634 * even if @p file is NULL.
2638 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2641 * Get the file (image or edje) used for the background
2643 * @param obj The bg object
2644 * @param file The file path
2645 * @param group Optional key (group in Edje) within the file
2649 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2652 * Set the option used for the background image
2654 * @param obj The bg object
2655 * @param option The desired background option (TILE, SCALE)
2657 * This sets the option used for manipulating the display of the background
2658 * image. The image can be tiled or scaled.
2662 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2665 * Get the option used for the background image
2667 * @param obj The bg object
2668 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2672 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2674 * Set the option used for the background color
2676 * @param obj The bg object
2681 * This sets the color used for the background rectangle. Its range goes
2686 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2688 * Get the option used for the background color
2690 * @param obj The bg object
2697 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2700 * Set the overlay object used for the background object.
2702 * @param obj The bg object
2703 * @param overlay The overlay object
2705 * This provides a way for elm_bg to have an 'overlay' that will be on top
2706 * of the bg. Once the over object is set, a previously set one will be
2707 * deleted, even if you set the new one to NULL. If you want to keep that
2708 * old content object, use the elm_bg_overlay_unset() function.
2713 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2716 * Get the overlay object used for the background object.
2718 * @param obj The bg object
2719 * @return The content that is being used
2721 * Return the content object which is set for this widget
2725 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2728 * Get the overlay object used for the background object.
2730 * @param obj The bg object
2731 * @return The content that was being used
2733 * Unparent and return the overlay object which was set for this widget
2737 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2740 * Set the size of the pixmap representation of the image.
2742 * This option just makes sense if an image is going to be set in the bg.
2744 * @param obj The bg object
2745 * @param w The new width of the image pixmap representation.
2746 * @param h The new height of the image pixmap representation.
2748 * This function sets a new size for pixmap representation of the given bg
2749 * image. It allows the image to be loaded already in the specified size,
2750 * reducing the memory usage and load time when loading a big image with load
2751 * size set to a smaller size.
2753 * NOTE: this is just a hint, the real size of the pixmap may differ
2754 * depending on the type of image being loaded, being bigger than requested.
2758 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2759 /* smart callbacks called:
2763 * @defgroup Icon Icon
2765 * @image html img/widget/icon/preview-00.png
2766 * @image latex img/widget/icon/preview-00.eps
2768 * An object that provides standard icon images (delete, edit, arrows, etc.)
2769 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2771 * The icon image requested can be in the elementary theme, or in the
2772 * freedesktop.org paths. It's possible to set the order of preference from
2773 * where the image will be used.
2775 * This API is very similar to @ref Image, but with ready to use images.
2777 * Default images provided by the theme are described below.
2779 * The first list contains icons that were first intended to be used in
2780 * toolbars, but can be used in many other places too:
2796 * Now some icons that were designed to be used in menus (but again, you can
2797 * use them anywhere else):
2802 * @li menu/arrow_down
2803 * @li menu/arrow_left
2804 * @li menu/arrow_right
2813 * And here we have some media player specific icons:
2814 * @li media_player/forward
2815 * @li media_player/info
2816 * @li media_player/next
2817 * @li media_player/pause
2818 * @li media_player/play
2819 * @li media_player/prev
2820 * @li media_player/rewind
2821 * @li media_player/stop
2823 * Signals that you can add callbacks for are:
2825 * "clicked" - This is called when a user has clicked the icon
2827 * An example of usage for this API follows:
2828 * @li @ref tutorial_icon
2836 typedef enum _Elm_Icon_Type
2843 * @enum _Elm_Icon_Lookup_Order
2844 * @typedef Elm_Icon_Lookup_Order
2846 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2847 * theme, FDO paths, or both?
2851 typedef enum _Elm_Icon_Lookup_Order
2853 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2854 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2855 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2856 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2857 } Elm_Icon_Lookup_Order;
2860 * Add a new icon object to the parent.
2862 * @param parent The parent object
2863 * @return The new object or NULL if it cannot be created
2865 * @see elm_icon_file_set()
2869 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2871 * Set the file that will be used as icon.
2873 * @param obj The icon object
2874 * @param file The path to file that will be used as icon image
2875 * @param group The group that the icon belongs to in edje file
2877 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2879 * @note The icon image set by this function can be changed by
2880 * elm_icon_standard_set().
2882 * @see elm_icon_file_get()
2886 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2888 * Set a location in memory to be used as an icon
2890 * @param obj The icon object
2891 * @param img The binary data that will be used as an image
2892 * @param size The size of binary data @p img
2893 * @param format Optional format of @p img to pass to the image loader
2894 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2896 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2898 * @note The icon image set by this function can be changed by
2899 * elm_icon_standard_set().
2903 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);
2905 * Get the file that will be used as icon.
2907 * @param obj The icon object
2908 * @param file The path to file that will be used as icon icon image
2909 * @param group The group that the icon belongs to in edje file
2911 * @see elm_icon_file_set()
2915 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2916 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2918 * Set the icon by icon standards names.
2920 * @param obj The icon object
2921 * @param name The icon name
2923 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2925 * For example, freedesktop.org defines standard icon names such as "home",
2926 * "network", etc. There can be different icon sets to match those icon
2927 * keys. The @p name given as parameter is one of these "keys", and will be
2928 * used to look in the freedesktop.org paths and elementary theme. One can
2929 * change the lookup order with elm_icon_order_lookup_set().
2931 * If name is not found in any of the expected locations and it is the
2932 * absolute path of an image file, this image will be used.
2934 * @note The icon image set by this function can be changed by
2935 * elm_icon_file_set().
2937 * @see elm_icon_standard_get()
2938 * @see elm_icon_file_set()
2942 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2944 * Get the icon name set by icon standard names.
2946 * @param obj The icon object
2947 * @return The icon name
2949 * If the icon image was set using elm_icon_file_set() instead of
2950 * elm_icon_standard_set(), then this function will return @c NULL.
2952 * @see elm_icon_standard_set()
2956 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2958 * Set the smooth effect for an icon object.
2960 * @param obj The icon object
2961 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2962 * otherwise. Default is @c EINA_TRUE.
2964 * Set the scaling algorithm to be used when scaling the icon image. Smooth
2965 * scaling provides a better resulting image, but is slower.
2967 * The smooth scaling should be disabled when making animations that change
2968 * the icon size, since they will be faster. Animations that don't require
2969 * resizing of the icon can keep the smooth scaling enabled (even if the icon
2970 * is already scaled, since the scaled icon image will be cached).
2972 * @see elm_icon_smooth_get()
2976 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2978 * Get the smooth effect for an icon object.
2980 * @param obj The icon object
2981 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2983 * @see elm_icon_smooth_set()
2987 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2989 * Disable scaling of this object.
2991 * @param obj The icon object.
2992 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2993 * otherwise. Default is @c EINA_FALSE.
2995 * This function disables scaling of the icon object through the function
2996 * elm_object_scale_set(). However, this does not affect the object
2997 * size/resize in any way. For that effect, take a look at
2998 * elm_icon_scale_set().
3000 * @see elm_icon_no_scale_get()
3001 * @see elm_icon_scale_set()
3002 * @see elm_object_scale_set()
3006 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3008 * Get whether scaling is disabled on the object.
3010 * @param obj The icon object
3011 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3013 * @see elm_icon_no_scale_set()
3017 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3019 * Set if the object is (up/down) resizeable.
3021 * @param obj The icon object
3022 * @param scale_up A bool to set if the object is resizeable up. Default is
3024 * @param scale_down A bool to set if the object is resizeable down. Default
3027 * This function limits the icon object resize ability. If @p scale_up is set to
3028 * @c EINA_FALSE, the object can't have its height or width resized to a value
3029 * higher than the original icon size. Same is valid for @p scale_down.
3031 * @see elm_icon_scale_get()
3035 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3037 * Get if the object is (up/down) resizeable.
3039 * @param obj The icon object
3040 * @param scale_up A bool to set if the object is resizeable up
3041 * @param scale_down A bool to set if the object is resizeable down
3043 * @see elm_icon_scale_set()
3047 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3049 * Get the object's image size
3051 * @param obj The icon object
3052 * @param w A pointer to store the width in
3053 * @param h A pointer to store the height in
3057 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3059 * Set if the icon fill the entire object area.
3061 * @param obj The icon object
3062 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3063 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3065 * When the icon object is resized to a different aspect ratio from the
3066 * original icon image, the icon image will still keep its aspect. This flag
3067 * tells how the image should fill the object's area. They are: keep the
3068 * entire icon inside the limits of height and width of the object (@p
3069 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3070 * of the object, and the icon will fill the entire object (@p fill_outside
3073 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3074 * retain property to false. Thus, the icon image will always keep its
3075 * original aspect ratio.
3077 * @see elm_icon_fill_outside_get()
3078 * @see elm_image_fill_outside_set()
3082 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3084 * Get if the object is filled outside.
3086 * @param obj The icon object
3087 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3089 * @see elm_icon_fill_outside_set()
3093 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3095 * Set the prescale size for the icon.
3097 * @param obj The icon object
3098 * @param size The prescale size. This value is used for both width and
3101 * This function sets a new size for pixmap representation of the given
3102 * icon. It allows the icon to be loaded already in the specified size,
3103 * reducing the memory usage and load time when loading a big icon with load
3104 * size set to a smaller size.
3106 * It's equivalent to the elm_bg_load_size_set() function for bg.
3108 * @note this is just a hint, the real size of the pixmap may differ
3109 * depending on the type of icon being loaded, being bigger than requested.
3111 * @see elm_icon_prescale_get()
3112 * @see elm_bg_load_size_set()
3116 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3118 * Get the prescale size for the icon.
3120 * @param obj The icon object
3121 * @return The prescale size
3123 * @see elm_icon_prescale_set()
3127 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3129 * Sets the icon lookup order used by elm_icon_standard_set().
3131 * @param obj The icon object
3132 * @param order The icon lookup order (can be one of
3133 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3134 * or ELM_ICON_LOOKUP_THEME)
3136 * @see elm_icon_order_lookup_get()
3137 * @see Elm_Icon_Lookup_Order
3141 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3143 * Gets the icon lookup order.
3145 * @param obj The icon object
3146 * @return The icon lookup order
3148 * @see elm_icon_order_lookup_set()
3149 * @see Elm_Icon_Lookup_Order
3153 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3160 * @defgroup Image Image
3162 * @image html img/widget/image/preview-00.png
3163 * @image latex img/widget/image/preview-00.eps
3165 * An object that allows one to load an image file to it. It can be used
3166 * anywhere like any other elementary widget.
3168 * This widget provides most of the functionality provided from @ref Bg or @ref
3169 * Icon, but with a slightly different API (use the one that fits better your
3172 * The features not provided by those two other image widgets are:
3173 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3174 * @li change the object orientation with elm_image_orient_set();
3175 * @li and turning the image editable with elm_image_editable_set().
3177 * Signals that you can add callbacks for are:
3179 * @li @c "clicked" - This is called when a user has clicked the image
3181 * An example of usage for this API follows:
3182 * @li @ref tutorial_image
3191 * @enum _Elm_Image_Orient
3192 * @typedef Elm_Image_Orient
3194 * Possible orientation options for elm_image_orient_set().
3196 * @image html elm_image_orient_set.png
3197 * @image latex elm_image_orient_set.eps width=\textwidth
3201 typedef enum _Elm_Image_Orient
3203 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3204 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3205 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3206 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3207 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3208 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3209 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3210 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3214 * Add a new image to the parent.
3216 * @param parent The parent object
3217 * @return The new object or NULL if it cannot be created
3219 * @see elm_image_file_set()
3223 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3225 * Set the file that will be used as image.
3227 * @param obj The image object
3228 * @param file The path to file that will be used as image
3229 * @param group The group that the image belongs in edje file (if it's an
3232 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3234 * @see elm_image_file_get()
3238 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3240 * Get the file that will be used as image.
3242 * @param obj The image object
3243 * @param file The path to file
3244 * @param group The group that the image belongs in edje file
3246 * @see elm_image_file_set()
3250 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3252 * Set the smooth effect for an image.
3254 * @param obj The image object
3255 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3256 * otherwise. Default is @c EINA_TRUE.
3258 * Set the scaling algorithm to be used when scaling the image. Smooth
3259 * scaling provides a better resulting image, but is slower.
3261 * The smooth scaling should be disabled when making animations that change
3262 * the image size, since it will be faster. Animations that don't require
3263 * resizing of the image can keep the smooth scaling enabled (even if the
3264 * image is already scaled, since the scaled image will be cached).
3266 * @see elm_image_smooth_get()
3270 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3272 * Get the smooth effect for an image.
3274 * @param obj The image object
3275 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3277 * @see elm_image_smooth_get()
3281 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3283 * Gets the current size of the image.
3285 * @param obj The image object.
3286 * @param w Pointer to store width, or NULL.
3287 * @param h Pointer to store height, or NULL.
3289 * This is the real size of the image, not the size of the object.
3291 * On error, neither w or h will be written.
3295 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3297 * Disable scaling of this object.
3299 * @param obj The image object.
3300 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3301 * otherwise. Default is @c EINA_FALSE.
3303 * This function disables scaling of the elm_image widget through the
3304 * function elm_object_scale_set(). However, this does not affect the widget
3305 * size/resize in any way. For that effect, take a look at
3306 * elm_image_scale_set().
3308 * @see elm_image_no_scale_get()
3309 * @see elm_image_scale_set()
3310 * @see elm_object_scale_set()
3314 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3316 * Get whether scaling is disabled on the object.
3318 * @param obj The image object
3319 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3321 * @see elm_image_no_scale_set()
3325 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3327 * Set if the object is (up/down) resizeable.
3329 * @param obj The image object
3330 * @param scale_up A bool to set if the object is resizeable up. Default is
3332 * @param scale_down A bool to set if the object is resizeable down. Default
3335 * This function limits the image resize ability. If @p scale_up is set to
3336 * @c EINA_FALSE, the object can't have its height or width resized to a value
3337 * higher than the original image size. Same is valid for @p scale_down.
3339 * @see elm_image_scale_get()
3343 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3345 * Get if the object is (up/down) resizeable.
3347 * @param obj The image object
3348 * @param scale_up A bool to set if the object is resizeable up
3349 * @param scale_down A bool to set if the object is resizeable down
3351 * @see elm_image_scale_set()
3355 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3357 * Set if the image fill the entire object area when keeping the aspect ratio.
3359 * @param obj The image object
3360 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3361 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3363 * When the image should keep its aspect ratio even if resized to another
3364 * aspect ratio, there are two possibilities to resize it: keep the entire
3365 * image inside the limits of height and width of the object (@p fill_outside
3366 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3367 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3369 * @note This option will have no effect if
3370 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3372 * @see elm_image_fill_outside_get()
3373 * @see elm_image_aspect_ratio_retained_set()
3377 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3379 * Get if the object is filled outside
3381 * @param obj The image object
3382 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3384 * @see elm_image_fill_outside_set()
3388 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3390 * Set the prescale size for the image
3392 * @param obj The image object
3393 * @param size The prescale size. This value is used for both width and
3396 * This function sets a new size for pixmap representation of the given
3397 * image. It allows the image to be loaded already in the specified size,
3398 * reducing the memory usage and load time when loading a big image with load
3399 * size set to a smaller size.
3401 * It's equivalent to the elm_bg_load_size_set() function for bg.
3403 * @note this is just a hint, the real size of the pixmap may differ
3404 * depending on the type of image being loaded, being bigger than requested.
3406 * @see elm_image_prescale_get()
3407 * @see elm_bg_load_size_set()
3411 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3413 * Get the prescale size for the image
3415 * @param obj The image object
3416 * @return The prescale size
3418 * @see elm_image_prescale_set()
3422 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3424 * Set the image orientation.
3426 * @param obj The image object
3427 * @param orient The image orientation
3428 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3429 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3430 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3431 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3432 * Default is #ELM_IMAGE_ORIENT_NONE.
3434 * This function allows to rotate or flip the given image.
3436 * @see elm_image_orient_get()
3437 * @see @ref Elm_Image_Orient
3441 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3443 * Get the image orientation.
3445 * @param obj The image object
3446 * @return The image orientation
3447 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3448 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3449 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3450 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3452 * @see elm_image_orient_set()
3453 * @see @ref Elm_Image_Orient
3457 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3459 * Make the image 'editable'.
3461 * @param obj Image object.
3462 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3464 * This means the image is a valid drag target for drag and drop, and can be
3465 * cut or pasted too.
3469 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3471 * Make the image 'editable'.
3473 * @param obj Image object.
3474 * @return Editability.
3476 * This means the image is a valid drag target for drag and drop, and can be
3477 * cut or pasted too.
3481 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3483 * Get the basic Evas_Image object from this object (widget).
3485 * @param obj The image object to get the inlined image from
3486 * @return The inlined image object, or NULL if none exists
3488 * This function allows one to get the underlying @c Evas_Object of type
3489 * Image from this elementary widget. It can be useful to do things like get
3490 * the pixel data, save the image to a file, etc.
3492 * @note Be careful to not manipulate it, as it is under control of
3497 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3499 * Set whether the original aspect ratio of the image should be kept on resize.
3501 * @param obj The image object.
3502 * @param retained @c EINA_TRUE if the image should retain the aspect,
3503 * @c EINA_FALSE otherwise.
3505 * The original aspect ratio (width / height) of the image is usually
3506 * distorted to match the object's size. Enabling this option will retain
3507 * this original aspect, and the way that the image is fit into the object's
3508 * area depends on the option set by elm_image_fill_outside_set().
3510 * @see elm_image_aspect_ratio_retained_get()
3511 * @see elm_image_fill_outside_set()
3515 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3517 * Get if the object retains the original aspect ratio.
3519 * @param obj The image object.
3520 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3525 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3527 /* smart callbacks called:
3528 * "clicked" - the user clicked the image
3536 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3538 typedef enum _Elm_GLView_Mode
3540 ELM_GLVIEW_ALPHA = 1,
3541 ELM_GLVIEW_DEPTH = 2,
3542 ELM_GLVIEW_STENCIL = 4
3546 * Defines a policy for the glview resizing.
3548 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3550 typedef enum _Elm_GLView_Resize_Policy
3552 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3553 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3554 } Elm_GLView_Resize_Policy;
3556 typedef enum _Elm_GLView_Render_Policy
3558 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3559 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3560 } Elm_GLView_Render_Policy;
3563 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3564 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3565 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3566 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3567 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3568 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3569 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3570 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3571 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3572 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3573 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3574 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3580 * @image html img/widget/box/preview-00.png
3581 * @image latex img/widget/box/preview-00.eps width=\textwidth
3583 * @image html img/box.png
3584 * @image latex img/box.eps width=\textwidth
3586 * A box arranges objects in a linear fashion, governed by a layout function
3587 * that defines the details of this arrangement.
3589 * By default, the box will use an internal function to set the layout to
3590 * a single row, either vertical or horizontal. This layout is affected
3591 * by a number of parameters, such as the homogeneous flag set by
3592 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3593 * elm_box_align_set() and the hints set to each object in the box.
3595 * For this default layout, it's possible to change the orientation with
3596 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3597 * placing its elements ordered from top to bottom. When horizontal is set,
3598 * the order will go from left to right. If the box is set to be
3599 * homogeneous, every object in it will be assigned the same space, that
3600 * of the largest object. Padding can be used to set some spacing between
3601 * the cell given to each object. The alignment of the box, set with
3602 * elm_box_align_set(), determines how the bounding box of all the elements
3603 * will be placed within the space given to the box widget itself.
3605 * The size hints of each object also affect how they are placed and sized
3606 * within the box. evas_object_size_hint_min_set() will give the minimum
3607 * size the object can have, and the box will use it as the basis for all
3608 * latter calculations. Elementary widgets set their own minimum size as
3609 * needed, so there's rarely any need to use it manually.
3611 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3612 * used to tell whether the object will be allocated the minimum size it
3613 * needs or if the space given to it should be expanded. It's important
3614 * to realize that expanding the size given to the object is not the same
3615 * thing as resizing the object. It could very well end being a small
3616 * widget floating in a much larger empty space. If not set, the weight
3617 * for objects will normally be 0.0 for both axis, meaning the widget will
3618 * not be expanded. To take as much space possible, set the weight to
3619 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3621 * Besides how much space each object is allocated, it's possible to control
3622 * how the widget will be placed within that space using
3623 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3624 * for both axis, meaning the object will be centered, but any value from
3625 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3626 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3627 * is -1.0, means the object will be resized to fill the entire space it
3630 * In addition, customized functions to define the layout can be set, which
3631 * allow the application developer to organize the objects within the box
3632 * in any number of ways.
3634 * The special elm_box_layout_transition() function can be used
3635 * to switch from one layout to another, animating the motion of the
3636 * children of the box.
3638 * @note Objects should not be added to box objects using _add() calls.
3640 * Some examples on how to use boxes follow:
3641 * @li @ref box_example_01
3642 * @li @ref box_example_02
3647 * @typedef Elm_Box_Transition
3649 * Opaque handler containing the parameters to perform an animated
3650 * transition of the layout the box uses.
3652 * @see elm_box_transition_new()
3653 * @see elm_box_layout_set()
3654 * @see elm_box_layout_transition()
3656 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3659 * Add a new box to the parent
3661 * By default, the box will be in vertical mode and non-homogeneous.
3663 * @param parent The parent object
3664 * @return The new object or NULL if it cannot be created
3666 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3668 * Set the horizontal orientation
3670 * By default, box object arranges their contents vertically from top to
3672 * By calling this function with @p horizontal as EINA_TRUE, the box will
3673 * become horizontal, arranging contents from left to right.
3675 * @note This flag is ignored if a custom layout function is set.
3677 * @param obj The box object
3678 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3679 * EINA_FALSE = vertical)
3681 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3683 * Get the horizontal orientation
3685 * @param obj The box object
3686 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3688 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3690 * Set the box to arrange its children homogeneously
3692 * If enabled, homogeneous layout makes all items the same size, according
3693 * to the size of the largest of its children.
3695 * @note This flag is ignored if a custom layout function is set.
3697 * @param obj The box object
3698 * @param homogeneous The homogeneous flag
3700 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3702 * Get whether the box is using homogeneous mode or not
3704 * @param obj The box object
3705 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3707 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3708 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3709 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3711 * Add an object to the beginning of the pack list
3713 * Pack @p subobj into the box @p obj, placing it first in the list of
3714 * children objects. The actual position the object will get on screen
3715 * depends on the layout used. If no custom layout is set, it will be at
3716 * the top or left, depending if the box is vertical or horizontal,
3719 * @param obj The box object
3720 * @param subobj The object to add to the box
3722 * @see elm_box_pack_end()
3723 * @see elm_box_pack_before()
3724 * @see elm_box_pack_after()
3725 * @see elm_box_unpack()
3726 * @see elm_box_unpack_all()
3727 * @see elm_box_clear()
3729 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3731 * Add an object at the end of the pack list
3733 * Pack @p subobj into the box @p obj, placing it last in the list of
3734 * children objects. The actual position the object will get on screen
3735 * depends on the layout used. If no custom layout is set, it will be at
3736 * the bottom or right, depending if the box is vertical or horizontal,
3739 * @param obj The box object
3740 * @param subobj The object to add to the box
3742 * @see elm_box_pack_start()
3743 * @see elm_box_pack_before()
3744 * @see elm_box_pack_after()
3745 * @see elm_box_unpack()
3746 * @see elm_box_unpack_all()
3747 * @see elm_box_clear()
3749 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3751 * Adds an object to the box before the indicated object
3753 * This will add the @p subobj to the box indicated before the object
3754 * indicated with @p before. If @p before is not already in the box, results
3755 * are undefined. Before means either to the left of the indicated object or
3756 * above it depending on orientation.
3758 * @param obj The box object
3759 * @param subobj The object to add to the box
3760 * @param before The object before which to add it
3762 * @see elm_box_pack_start()
3763 * @see elm_box_pack_end()
3764 * @see elm_box_pack_after()
3765 * @see elm_box_unpack()
3766 * @see elm_box_unpack_all()
3767 * @see elm_box_clear()
3769 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3771 * Adds an object to the box after the indicated object
3773 * This will add the @p subobj to the box indicated after the object
3774 * indicated with @p after. If @p after is not already in the box, results
3775 * are undefined. After means either to the right of the indicated object or
3776 * below it depending on orientation.
3778 * @param obj The box object
3779 * @param subobj The object to add to the box
3780 * @param after The object after which to add it
3782 * @see elm_box_pack_start()
3783 * @see elm_box_pack_end()
3784 * @see elm_box_pack_before()
3785 * @see elm_box_unpack()
3786 * @see elm_box_unpack_all()
3787 * @see elm_box_clear()
3789 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3791 * Clear the box of all children
3793 * Remove all the elements contained by the box, deleting the respective
3796 * @param obj The box object
3798 * @see elm_box_unpack()
3799 * @see elm_box_unpack_all()
3801 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3805 * Remove the object given by @p subobj from the box @p obj without
3808 * @param obj The box object
3810 * @see elm_box_unpack_all()
3811 * @see elm_box_clear()
3813 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3815 * Remove all items from the box, without deleting them
3817 * Clear the box from all children, but don't delete the respective objects.
3818 * If no other references of the box children exist, the objects will never
3819 * be deleted, and thus the application will leak the memory. Make sure
3820 * when using this function that you hold a reference to all the objects
3821 * in the box @p obj.
3823 * @param obj The box object
3825 * @see elm_box_clear()
3826 * @see elm_box_unpack()
3828 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3830 * Retrieve a list of the objects packed into the box
3832 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3833 * The order of the list corresponds to the packing order the box uses.
3835 * You must free this list with eina_list_free() once you are done with it.
3837 * @param obj The box object
3839 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3841 * Set the space (padding) between the box's elements.
3843 * Extra space in pixels that will be added between a box child and its
3844 * neighbors after its containing cell has been calculated. This padding
3845 * is set for all elements in the box, besides any possible padding that
3846 * individual elements may have through their size hints.
3848 * @param obj The box object
3849 * @param horizontal The horizontal space between elements
3850 * @param vertical The vertical space between elements
3852 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3854 * Get the space (padding) between the box's elements.
3856 * @param obj The box object
3857 * @param horizontal The horizontal space between elements
3858 * @param vertical The vertical space between elements
3860 * @see elm_box_padding_set()
3862 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3864 * Set the alignment of the whole bouding box of contents.
3866 * Sets how the bounding box containing all the elements of the box, after
3867 * their sizes and position has been calculated, will be aligned within
3868 * the space given for the whole box widget.
3870 * @param obj The box object
3871 * @param horizontal The horizontal alignment of elements
3872 * @param vertical The vertical alignment of elements
3874 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3876 * Get the alignment of the whole bouding box of contents.
3878 * @param obj The box object
3879 * @param horizontal The horizontal alignment of elements
3880 * @param vertical The vertical alignment of elements
3882 * @see elm_box_align_set()
3884 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3887 * Set the layout defining function to be used by the box
3889 * Whenever anything changes that requires the box in @p obj to recalculate
3890 * the size and position of its elements, the function @p cb will be called
3891 * to determine what the layout of the children will be.
3893 * Once a custom function is set, everything about the children layout
3894 * is defined by it. The flags set by elm_box_horizontal_set() and
3895 * elm_box_homogeneous_set() no longer have any meaning, and the values
3896 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3897 * layout function to decide if they are used and how. These last two
3898 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3899 * passed to @p cb. The @c Evas_Object the function receives is not the
3900 * Elementary widget, but the internal Evas Box it uses, so none of the
3901 * functions described here can be used on it.
3903 * Any of the layout functions in @c Evas can be used here, as well as the
3904 * special elm_box_layout_transition().
3906 * The final @p data argument received by @p cb is the same @p data passed
3907 * here, and the @p free_data function will be called to free it
3908 * whenever the box is destroyed or another layout function is set.
3910 * Setting @p cb to NULL will revert back to the default layout function.
3912 * @param obj The box object
3913 * @param cb The callback function used for layout
3914 * @param data Data that will be passed to layout function
3915 * @param free_data Function called to free @p data
3917 * @see elm_box_layout_transition()
3919 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);
3921 * Special layout function that animates the transition from one layout to another
3923 * Normally, when switching the layout function for a box, this will be
3924 * reflected immediately on screen on the next render, but it's also
3925 * possible to do this through an animated transition.
3927 * This is done by creating an ::Elm_Box_Transition and setting the box
3928 * layout to this function.
3932 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3933 * evas_object_box_layout_vertical, // start
3934 * NULL, // data for initial layout
3935 * NULL, // free function for initial data
3936 * evas_object_box_layout_horizontal, // end
3937 * NULL, // data for final layout
3938 * NULL, // free function for final data
3939 * anim_end, // will be called when animation ends
3940 * NULL); // data for anim_end function\
3941 * elm_box_layout_set(box, elm_box_layout_transition, t,
3942 * elm_box_transition_free);
3945 * @note This function can only be used with elm_box_layout_set(). Calling
3946 * it directly will not have the expected results.
3948 * @see elm_box_transition_new
3949 * @see elm_box_transition_free
3950 * @see elm_box_layout_set
3952 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3954 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3956 * If you want to animate the change from one layout to another, you need
3957 * to set the layout function of the box to elm_box_layout_transition(),
3958 * passing as user data to it an instance of ::Elm_Box_Transition with the
3959 * necessary information to perform this animation. The free function to
3960 * set for the layout is elm_box_transition_free().
3962 * The parameters to create an ::Elm_Box_Transition sum up to how long
3963 * will it be, in seconds, a layout function to describe the initial point,
3964 * another for the final position of the children and one function to be
3965 * called when the whole animation ends. This last function is useful to
3966 * set the definitive layout for the box, usually the same as the end
3967 * layout for the animation, but could be used to start another transition.
3969 * @param start_layout The layout function that will be used to start the animation
3970 * @param start_layout_data The data to be passed the @p start_layout function
3971 * @param start_layout_free_data Function to free @p start_layout_data
3972 * @param end_layout The layout function that will be used to end the animation
3973 * @param end_layout_free_data The data to be passed the @p end_layout function
3974 * @param end_layout_free_data Function to free @p end_layout_data
3975 * @param transition_end_cb Callback function called when animation ends
3976 * @param transition_end_data Data to be passed to @p transition_end_cb
3977 * @return An instance of ::Elm_Box_Transition
3979 * @see elm_box_transition_new
3980 * @see elm_box_layout_transition
3982 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);
3984 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3986 * This function is mostly useful as the @c free_data parameter in
3987 * elm_box_layout_set() when elm_box_layout_transition().
3989 * @param data The Elm_Box_Transition instance to be freed.
3991 * @see elm_box_transition_new
3992 * @see elm_box_layout_transition
3994 EAPI void elm_box_transition_free(void *data);
4001 * @defgroup Button Button
4003 * @image html img/widget/button/preview-00.png
4004 * @image html img/widget/button/preview-01.png
4005 * @image html img/widget/button/preview-02.png
4007 * This is a push-button. Press it and run some function. It can contain
4008 * a simple label and icon object and it also has an autorepeat feature.
4010 * This widgets emits the following signals:
4011 * @li "clicked": the user clicked the button (press/release).
4012 * @li "repeated": the user pressed the button without releasing it.
4013 * @li "pressed": button was pressed.
4014 * @li "unpressed": button was released after being pressed.
4015 * In all three cases, the @c event parameter of the callback will be
4018 * Also, defined in the default theme, the button has the following styles
4020 * @li default: a normal button.
4021 * @li anchor: Like default, but the button fades away when the mouse is not
4022 * over it, leaving only the text or icon.
4023 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4024 * continuous look across its options.
4025 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4027 * Follow through a complete example @ref button_example_01 "here".
4031 * Add a new button to the parent's canvas
4033 * @param parent The parent object
4034 * @return The new object or NULL if it cannot be created
4036 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4038 * Set the label used in the button
4040 * The passed @p label can be NULL to clean any existing text in it and
4041 * leave the button as an icon only object.
4043 * @param obj The button object
4044 * @param label The text will be written on the button
4045 * @deprecated use elm_object_text_set() instead.
4047 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4049 * Get the label set for the button
4051 * The string returned is an internal pointer and should not be freed or
4052 * altered. It will also become invalid when the button is destroyed.
4053 * The string returned, if not NULL, is a stringshare, so if you need to
4054 * keep it around even after the button is destroyed, you can use
4055 * eina_stringshare_ref().
4057 * @param obj The button object
4058 * @return The text set to the label, or NULL if nothing is set
4059 * @deprecated use elm_object_text_set() instead.
4061 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4063 * Set the icon used for the button
4065 * Setting a new icon will delete any other that was previously set, making
4066 * any reference to them invalid. If you need to maintain the previous
4067 * object alive, unset it first with elm_button_icon_unset().
4069 * @param obj The button object
4070 * @param icon The icon object for the button
4072 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4074 * Get the icon used for the button
4076 * Return the icon object which is set for this widget. If the button is
4077 * destroyed or another icon is set, the returned object will be deleted
4078 * and any reference to it will be invalid.
4080 * @param obj The button object
4081 * @return The icon object that is being used
4083 * @see elm_button_icon_unset()
4085 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4087 * Remove the icon set without deleting it and return the object
4089 * This function drops the reference the button holds of the icon object
4090 * and returns this last object. It is used in case you want to remove any
4091 * icon, or set another one, without deleting the actual object. The button
4092 * will be left without an icon set.
4094 * @param obj The button object
4095 * @return The icon object that was being used
4097 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4099 * Turn on/off the autorepeat event generated when the button is kept pressed
4101 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4102 * signal when they are clicked.
4104 * When on, keeping a button pressed will continuously emit a @c repeated
4105 * signal until the button is released. The time it takes until it starts
4106 * emitting the signal is given by
4107 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4108 * new emission by elm_button_autorepeat_gap_timeout_set().
4110 * @param obj The button object
4111 * @param on A bool to turn on/off the event
4113 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4115 * Get whether the autorepeat feature is enabled
4117 * @param obj The button object
4118 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4120 * @see elm_button_autorepeat_set()
4122 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4124 * Set the initial timeout before the autorepeat event is generated
4126 * Sets the timeout, in seconds, since the button is pressed until the
4127 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4128 * won't be any delay and the even will be fired the moment the button is
4131 * @param obj The button object
4132 * @param t Timeout in seconds
4134 * @see elm_button_autorepeat_set()
4135 * @see elm_button_autorepeat_gap_timeout_set()
4137 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4139 * Get the initial timeout before the autorepeat event is generated
4141 * @param obj The button object
4142 * @return Timeout in seconds
4144 * @see elm_button_autorepeat_initial_timeout_set()
4146 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148 * Set the interval between each generated autorepeat event
4150 * After the first @c repeated event is fired, all subsequent ones will
4151 * follow after a delay of @p t seconds for each.
4153 * @param obj The button object
4154 * @param t Interval in seconds
4156 * @see elm_button_autorepeat_initial_timeout_set()
4158 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4160 * Get the interval between each generated autorepeat event
4162 * @param obj The button object
4163 * @return Interval in seconds
4165 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4171 * @defgroup File_Selector_Button File Selector Button
4173 * @image html img/widget/fileselector_button/preview-00.png
4174 * @image html img/widget/fileselector_button/preview-01.png
4175 * @image html img/widget/fileselector_button/preview-02.png
4177 * This is a button that, when clicked, creates an Elementary
4178 * window (or inner window) <b> with a @ref Fileselector "file
4179 * selector widget" within</b>. When a file is chosen, the (inner)
4180 * window is closed and the button emits a signal having the
4181 * selected file as it's @c event_info.
4183 * This widget encapsulates operations on its internal file
4184 * selector on its own API. There is less control over its file
4185 * selector than that one would have instatiating one directly.
4187 * The following styles are available for this button:
4190 * @li @c "hoversel_vertical"
4191 * @li @c "hoversel_vertical_entry"
4193 * Smart callbacks one can register to:
4194 * - @c "file,chosen" - the user has selected a path, whose string
4195 * pointer comes as the @c event_info data (a stringshared
4198 * Here is an example on its usage:
4199 * @li @ref fileselector_button_example
4201 * @see @ref File_Selector_Entry for a similar widget.
4206 * Add a new file selector button widget to the given parent
4207 * Elementary (container) object
4209 * @param parent The parent object
4210 * @return a new file selector button widget handle or @c NULL, on
4213 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4216 * Set the label for a given file selector button widget
4218 * @param obj The file selector button widget
4219 * @param label The text label to be displayed on @p obj
4221 * @deprecated use elm_object_text_set() instead.
4223 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4226 * Get the label set for a given file selector button widget
4228 * @param obj The file selector button widget
4229 * @return The button label
4231 * @deprecated use elm_object_text_set() instead.
4233 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4236 * Set the icon on a given file selector button widget
4238 * @param obj The file selector button widget
4239 * @param icon The icon object for the button
4241 * Once the icon object is set, a previously set one will be
4242 * deleted. If you want to keep the latter, use the
4243 * elm_fileselector_button_icon_unset() function.
4245 * @see elm_fileselector_button_icon_get()
4247 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4250 * Get the icon set for a given file selector button widget
4252 * @param obj The file selector button widget
4253 * @return The icon object currently set on @p obj or @c NULL, if
4256 * @see elm_fileselector_button_icon_set()
4258 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4261 * Unset the icon used in a given file selector button widget
4263 * @param obj The file selector button widget
4264 * @return The icon object that was being used on @p obj or @c
4267 * Unparent and return the icon object which was set for this
4270 * @see elm_fileselector_button_icon_set()
4272 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * Set the title for a given file selector button widget's window
4277 * @param obj The file selector button widget
4278 * @param title The title string
4280 * This will change the window's title, when the file selector pops
4281 * out after a click on the button. Those windows have the default
4282 * (unlocalized) value of @c "Select a file" as titles.
4284 * @note It will only take any effect if the file selector
4285 * button widget is @b not under "inwin mode".
4287 * @see elm_fileselector_button_window_title_get()
4289 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4292 * Get the title set for a given file selector button widget's
4295 * @param obj The file selector button widget
4296 * @return Title of the file selector button's window
4298 * @see elm_fileselector_button_window_title_get() for more details
4300 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4303 * Set the size of a given file selector button widget's window,
4304 * holding the file selector itself.
4306 * @param obj The file selector button widget
4307 * @param width The window's width
4308 * @param height The window's height
4310 * @note it will only take any effect if the file selector button
4311 * widget is @b not under "inwin mode". The default size for the
4312 * window (when applicable) is 400x400 pixels.
4314 * @see elm_fileselector_button_window_size_get()
4316 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4319 * Get the size of a given file selector button widget's window,
4320 * holding the file selector itself.
4322 * @param obj The file selector button widget
4323 * @param width Pointer into which to store the width value
4324 * @param height Pointer into which to store the height value
4326 * @note Use @c NULL pointers on the size values you're not
4327 * interested in: they'll be ignored by the function.
4329 * @see elm_fileselector_button_window_size_set(), for more details
4331 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4334 * Set the initial file system path for a given file selector
4337 * @param obj The file selector button widget
4338 * @param path The path string
4340 * It must be a <b>directory</b> path, which will have the contents
4341 * displayed initially in the file selector's view, when invoked
4342 * from @p obj. The default initial path is the @c "HOME"
4343 * environment variable's value.
4345 * @see elm_fileselector_button_path_get()
4347 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4350 * Get the initial file system path set for a given file selector
4353 * @param obj The file selector button widget
4354 * @return path The path string
4356 * @see elm_fileselector_button_path_set() for more details
4358 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4361 * Enable/disable a tree view in the given file selector button
4362 * widget's internal file selector
4364 * @param obj The file selector button widget
4365 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4368 * This has the same effect as elm_fileselector_expandable_set(),
4369 * but now applied to a file selector button's internal file
4372 * @note There's no way to put a file selector button's internal
4373 * file selector in "grid mode", as one may do with "pure" file
4376 * @see elm_fileselector_expandable_get()
4378 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4381 * Get whether tree view is enabled for the given file selector
4382 * button widget's internal file selector
4384 * @param obj The file selector button widget
4385 * @return @c EINA_TRUE if @p obj widget's internal file selector
4386 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4388 * @see elm_fileselector_expandable_set() for more details
4390 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4393 * Set whether a given file selector button widget's internal file
4394 * selector is to display folders only or the directory contents,
4397 * @param obj The file selector button widget
4398 * @param only @c EINA_TRUE to make @p obj widget's internal file
4399 * selector only display directories, @c EINA_FALSE to make files
4400 * to be displayed in it too
4402 * This has the same effect as elm_fileselector_folder_only_set(),
4403 * but now applied to a file selector button's internal file
4406 * @see elm_fileselector_folder_only_get()
4408 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4411 * Get whether a given file selector button widget's internal file
4412 * selector is displaying folders only or the directory contents,
4415 * @param obj The file selector button widget
4416 * @return @c EINA_TRUE if @p obj widget's internal file
4417 * selector is only displaying directories, @c EINA_FALSE if files
4418 * are being displayed in it too (and on errors)
4420 * @see elm_fileselector_button_folder_only_set() for more details
4422 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4425 * Enable/disable the file name entry box where the user can type
4426 * in a name for a file, in a given file selector button widget's
4427 * internal file selector.
4429 * @param obj The file selector button widget
4430 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4431 * file selector a "saving dialog", @c EINA_FALSE otherwise
4433 * This has the same effect as elm_fileselector_is_save_set(),
4434 * but now applied to a file selector button's internal file
4437 * @see elm_fileselector_is_save_get()
4439 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4442 * Get whether the given file selector button widget's internal
4443 * file selector is in "saving dialog" mode
4445 * @param obj The file selector button widget
4446 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4447 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4450 * @see elm_fileselector_button_is_save_set() for more details
4452 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4455 * Set whether a given file selector button widget's internal file
4456 * selector will raise an Elementary "inner window", instead of a
4457 * dedicated Elementary window. By default, it won't.
4459 * @param obj The file selector button widget
4460 * @param value @c EINA_TRUE to make it use an inner window, @c
4461 * EINA_TRUE to make it use a dedicated window
4463 * @see elm_win_inwin_add() for more information on inner windows
4464 * @see elm_fileselector_button_inwin_mode_get()
4466 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4469 * Get whether a given file selector button widget's internal file
4470 * selector will raise an Elementary "inner window", instead of a
4471 * dedicated Elementary window.
4473 * @param obj The file selector button widget
4474 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4475 * if it will use a dedicated window
4477 * @see elm_fileselector_button_inwin_mode_set() for more details
4479 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4486 * @defgroup File_Selector_Entry File Selector Entry
4488 * @image html img/widget/fileselector_entry/preview-00.png
4489 * @image latex img/widget/fileselector_entry/preview-00.eps
4491 * This is an entry made to be filled with or display a <b>file
4492 * system path string</b>. Besides the entry itself, the widget has
4493 * a @ref File_Selector_Button "file selector button" on its side,
4494 * which will raise an internal @ref Fileselector "file selector widget",
4495 * when clicked, for path selection aided by file system
4498 * This file selector may appear in an Elementary window or in an
4499 * inner window. When a file is chosen from it, the (inner) window
4500 * is closed and the selected file's path string is exposed both as
4501 * an smart event and as the new text on the entry.
4503 * This widget encapsulates operations on its internal file
4504 * selector on its own API. There is less control over its file
4505 * selector than that one would have instatiating one directly.
4507 * Smart callbacks one can register to:
4508 * - @c "changed" - The text within the entry was changed
4509 * - @c "activated" - The entry has had editing finished and
4510 * changes are to be "committed"
4511 * - @c "press" - The entry has been clicked
4512 * - @c "longpressed" - The entry has been clicked (and held) for a
4514 * - @c "clicked" - The entry has been clicked
4515 * - @c "clicked,double" - The entry has been double clicked
4516 * - @c "focused" - The entry has received focus
4517 * - @c "unfocused" - The entry has lost focus
4518 * - @c "selection,paste" - A paste action has occurred on the
4520 * - @c "selection,copy" - A copy action has occurred on the entry
4521 * - @c "selection,cut" - A cut action has occurred on the entry
4522 * - @c "unpressed" - The file selector entry's button was released
4523 * after being pressed.
4524 * - @c "file,chosen" - The user has selected a path via the file
4525 * selector entry's internal file selector, whose string pointer
4526 * comes as the @c event_info data (a stringshared string)
4528 * Here is an example on its usage:
4529 * @li @ref fileselector_entry_example
4531 * @see @ref File_Selector_Button for a similar widget.
4536 * Add a new file selector entry widget to the given parent
4537 * Elementary (container) object
4539 * @param parent The parent object
4540 * @return a new file selector entry widget handle or @c NULL, on
4543 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4546 * Set the label for a given file selector entry widget's button
4548 * @param obj The file selector entry widget
4549 * @param label The text label to be displayed on @p obj widget's
4552 * @deprecated use elm_object_text_set() instead.
4554 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4557 * Get the label set for a given file selector entry widget's button
4559 * @param obj The file selector entry widget
4560 * @return The widget button's label
4562 * @deprecated use elm_object_text_set() instead.
4564 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4567 * Set the icon on a given file selector entry widget's button
4569 * @param obj The file selector entry widget
4570 * @param icon The icon object for the entry's button
4572 * Once the icon object is set, a previously set one will be
4573 * deleted. If you want to keep the latter, use the
4574 * elm_fileselector_entry_button_icon_unset() function.
4576 * @see elm_fileselector_entry_button_icon_get()
4578 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4581 * Get the icon set for a given file selector entry widget's button
4583 * @param obj The file selector entry widget
4584 * @return The icon object currently set on @p obj widget's button
4585 * or @c NULL, if none is
4587 * @see elm_fileselector_entry_button_icon_set()
4589 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4592 * Unset the icon used in a given file selector entry widget's
4595 * @param obj The file selector entry widget
4596 * @return The icon object that was being used on @p obj widget's
4597 * button or @c NULL, on errors
4599 * Unparent and return the icon object which was set for this
4602 * @see elm_fileselector_entry_button_icon_set()
4604 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4607 * Set the title for a given file selector entry widget's window
4609 * @param obj The file selector entry widget
4610 * @param title The title string
4612 * This will change the window's title, when the file selector pops
4613 * out after a click on the entry's button. Those windows have the
4614 * default (unlocalized) value of @c "Select a file" as titles.
4616 * @note It will only take any effect if the file selector
4617 * entry widget is @b not under "inwin mode".
4619 * @see elm_fileselector_entry_window_title_get()
4621 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4624 * Get the title set for a given file selector entry widget's
4627 * @param obj The file selector entry widget
4628 * @return Title of the file selector entry's window
4630 * @see elm_fileselector_entry_window_title_get() for more details
4632 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4635 * Set the size of a given file selector entry widget's window,
4636 * holding the file selector itself.
4638 * @param obj The file selector entry widget
4639 * @param width The window's width
4640 * @param height The window's height
4642 * @note it will only take any effect if the file selector entry
4643 * widget is @b not under "inwin mode". The default size for the
4644 * window (when applicable) is 400x400 pixels.
4646 * @see elm_fileselector_entry_window_size_get()
4648 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4651 * Get the size of a given file selector entry widget's window,
4652 * holding the file selector itself.
4654 * @param obj The file selector entry widget
4655 * @param width Pointer into which to store the width value
4656 * @param height Pointer into which to store the height value
4658 * @note Use @c NULL pointers on the size values you're not
4659 * interested in: they'll be ignored by the function.
4661 * @see elm_fileselector_entry_window_size_set(), for more details
4663 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4666 * Set the initial file system path and the entry's path string for
4667 * a given file selector entry widget
4669 * @param obj The file selector entry widget
4670 * @param path The path string
4672 * It must be a <b>directory</b> path, which will have the contents
4673 * displayed initially in the file selector's view, when invoked
4674 * from @p obj. The default initial path is the @c "HOME"
4675 * environment variable's value.
4677 * @see elm_fileselector_entry_path_get()
4679 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4682 * Get the entry's path string for a given file selector entry
4685 * @param obj The file selector entry widget
4686 * @return path The path string
4688 * @see elm_fileselector_entry_path_set() for more details
4690 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4693 * Enable/disable a tree view in the given file selector entry
4694 * widget's internal file selector
4696 * @param obj The file selector entry widget
4697 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4700 * This has the same effect as elm_fileselector_expandable_set(),
4701 * but now applied to a file selector entry's internal file
4704 * @note There's no way to put a file selector entry's internal
4705 * file selector in "grid mode", as one may do with "pure" file
4708 * @see elm_fileselector_expandable_get()
4710 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4713 * Get whether tree view is enabled for the given file selector
4714 * entry widget's internal file selector
4716 * @param obj The file selector entry widget
4717 * @return @c EINA_TRUE if @p obj widget's internal file selector
4718 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4720 * @see elm_fileselector_expandable_set() for more details
4722 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4725 * Set whether a given file selector entry widget's internal file
4726 * selector is to display folders only or the directory contents,
4729 * @param obj The file selector entry widget
4730 * @param only @c EINA_TRUE to make @p obj widget's internal file
4731 * selector only display directories, @c EINA_FALSE to make files
4732 * to be displayed in it too
4734 * This has the same effect as elm_fileselector_folder_only_set(),
4735 * but now applied to a file selector entry's internal file
4738 * @see elm_fileselector_folder_only_get()
4740 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4743 * Get whether a given file selector entry widget's internal file
4744 * selector is displaying folders only or the directory contents,
4747 * @param obj The file selector entry widget
4748 * @return @c EINA_TRUE if @p obj widget's internal file
4749 * selector is only displaying directories, @c EINA_FALSE if files
4750 * are being displayed in it too (and on errors)
4752 * @see elm_fileselector_entry_folder_only_set() for more details
4754 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4757 * Enable/disable the file name entry box where the user can type
4758 * in a name for a file, in a given file selector entry widget's
4759 * internal file selector.
4761 * @param obj The file selector entry widget
4762 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4763 * file selector a "saving dialog", @c EINA_FALSE otherwise
4765 * This has the same effect as elm_fileselector_is_save_set(),
4766 * but now applied to a file selector entry's internal file
4769 * @see elm_fileselector_is_save_get()
4771 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4774 * Get whether the given file selector entry widget's internal
4775 * file selector is in "saving dialog" mode
4777 * @param obj The file selector entry widget
4778 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4779 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4782 * @see elm_fileselector_entry_is_save_set() for more details
4784 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4787 * Set whether a given file selector entry widget's internal file
4788 * selector will raise an Elementary "inner window", instead of a
4789 * dedicated Elementary window. By default, it won't.
4791 * @param obj The file selector entry widget
4792 * @param value @c EINA_TRUE to make it use an inner window, @c
4793 * EINA_TRUE to make it use a dedicated window
4795 * @see elm_win_inwin_add() for more information on inner windows
4796 * @see elm_fileselector_entry_inwin_mode_get()
4798 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4801 * Get whether a given file selector entry widget's internal file
4802 * selector will raise an Elementary "inner window", instead of a
4803 * dedicated Elementary window.
4805 * @param obj The file selector entry widget
4806 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4807 * if it will use a dedicated window
4809 * @see elm_fileselector_entry_inwin_mode_set() for more details
4811 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4814 * Set the initial file system path for a given file selector entry
4817 * @param obj The file selector entry widget
4818 * @param path The path string
4820 * It must be a <b>directory</b> path, which will have the contents
4821 * displayed initially in the file selector's view, when invoked
4822 * from @p obj. The default initial path is the @c "HOME"
4823 * environment variable's value.
4825 * @see elm_fileselector_entry_path_get()
4827 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4830 * Get the parent directory's path to the latest file selection on
4831 * a given filer selector entry widget
4833 * @param obj The file selector object
4834 * @return The (full) path of the directory of the last selection
4835 * on @p obj widget, a @b stringshared string
4837 * @see elm_fileselector_entry_path_set()
4839 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4846 * @defgroup Scroller Scroller
4848 * A scroller holds a single object and "scrolls it around". This means that
4849 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4850 * region around, allowing to move through a much larger object that is
4851 * contained in the scroller. The scroiller will always have a small minimum
4852 * size by default as it won't be limited by the contents of the scroller.
4854 * Signals that you can add callbacks for are:
4855 * @li "edge,left" - the left edge of the content has been reached
4856 * @li "edge,right" - the right edge of the content has been reached
4857 * @li "edge,top" - the top edge of the content has been reached
4858 * @li "edge,bottom" - the bottom edge of the content has been reached
4859 * @li "scroll" - the content has been scrolled (moved)
4860 * @li "scroll,anim,start" - scrolling animation has started
4861 * @li "scroll,anim,stop" - scrolling animation has stopped
4862 * @li "scroll,drag,start" - dragging the contents around has started
4863 * @li "scroll,drag,stop" - dragging the contents around has stopped
4864 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4867 * @note When Elemementary is in embedded mode the scrollbars will not be
4868 * dragable, they appear merely as indicators of how much has been scrolled.
4869 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4870 * fingerscroll) won't work.
4872 * In @ref tutorial_scroller you'll find an example of how to use most of
4877 * @brief Type that controls when scrollbars should appear.
4879 * @see elm_scroller_policy_set()
4881 typedef enum _Elm_Scroller_Policy
4883 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4884 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4885 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4886 ELM_SCROLLER_POLICY_LAST
4887 } Elm_Scroller_Policy;
4889 * @brief Add a new scroller to the parent
4891 * @param parent The parent object
4892 * @return The new object or NULL if it cannot be created
4894 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4896 * @brief Set the content of the scroller widget (the object to be scrolled around).
4898 * @param obj The scroller object
4899 * @param content The new content object
4901 * Once the content object is set, a previously set one will be deleted.
4902 * If you want to keep that old content object, use the
4903 * elm_scroller_content_unset() function.
4905 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4907 * @brief Get the content of the scroller widget
4909 * @param obj The slider object
4910 * @return The content that is being used
4912 * Return the content object which is set for this widget
4914 * @see elm_scroller_content_set()
4916 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4918 * @brief Unset the content of the scroller widget
4920 * @param obj The slider object
4921 * @return The content that was being used
4923 * Unparent and return the content object which was set for this widget
4925 * @see elm_scroller_content_set()
4927 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4929 * @brief Set custom theme elements for the scroller
4931 * @param obj The scroller object
4932 * @param widget The widget name to use (default is "scroller")
4933 * @param base The base name to use (default is "base")
4935 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4937 * @brief Make the scroller minimum size limited to the minimum size of the content
4939 * @param obj The scroller object
4940 * @param w Enable limiting minimum size horizontally
4941 * @param h Enable limiting minimum size vertically
4943 * By default the scroller will be as small as its design allows,
4944 * irrespective of its content. This will make the scroller minimum size the
4945 * right size horizontally and/or vertically to perfectly fit its content in
4948 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4950 * @brief Show a specific virtual region within the scroller content object
4952 * @param obj The scroller object
4953 * @param x X coordinate of the region
4954 * @param y Y coordinate of the region
4955 * @param w Width of the region
4956 * @param h Height of the region
4958 * This will ensure all (or part if it does not fit) of the designated
4959 * region in the virtual content object (0, 0 starting at the top-left of the
4960 * virtual content object) is shown within the scroller.
4962 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);
4964 * @brief Set the scrollbar visibility policy
4966 * @param obj The scroller object
4967 * @param policy_h Horizontal scrollbar policy
4968 * @param policy_v Vertical scrollbar policy
4970 * This sets the scrollbar visibility policy for the given scroller.
4971 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4972 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4973 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4974 * respectively for the horizontal and vertical scrollbars.
4976 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4978 * @brief Gets scrollbar visibility policy
4980 * @param obj The scroller object
4981 * @param policy_h Horizontal scrollbar policy
4982 * @param policy_v Vertical scrollbar policy
4984 * @see elm_scroller_policy_set()
4986 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4988 * @brief Get the currently visible content region
4990 * @param obj The scroller object
4991 * @param x X coordinate of the region
4992 * @param y Y coordinate of the region
4993 * @param w Width of the region
4994 * @param h Height of the region
4996 * This gets the current region in the content object that is visible through
4997 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4998 * w, @p h values pointed to.
5000 * @note All coordinates are relative to the content.
5002 * @see elm_scroller_region_show()
5004 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);
5006 * @brief Get the size of the content object
5008 * @param obj The scroller object
5009 * @param w Width return
5010 * @param h Height return
5012 * This gets the size of the content object of the scroller.
5014 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5016 * @brief Set bouncing behavior
5018 * @param obj The scroller object
5019 * @param h_bounce Will the scroller bounce horizontally or not
5020 * @param v_bounce Will the scroller bounce vertically or not
5022 * When scrolling, the scroller may "bounce" when reaching an edge of the
5023 * content object. This is a visual way to indicate the end has been reached.
5024 * This is enabled by default for both axis. This will set if it is enabled
5025 * for that axis with the boolean parameters for each axis.
5027 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5029 * @brief Get the bounce mode
5031 * @param obj The Scroller object
5032 * @param h_bounce Allow bounce horizontally
5033 * @param v_bounce Allow bounce vertically
5035 * @see elm_scroller_bounce_set()
5037 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5039 * @brief Set scroll page size relative to viewport size.
5041 * @param obj The scroller object
5042 * @param h_pagerel The horizontal page relative size
5043 * @param v_pagerel The vertical page relative size
5045 * The scroller is capable of limiting scrolling by the user to "pages". That
5046 * is to jump by and only show a "whole page" at a time as if the continuous
5047 * area of the scroller content is split into page sized pieces. This sets
5048 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5049 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5050 * axis. This is mutually exclusive with page size
5051 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5052 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5053 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5056 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5058 * @brief Set scroll page size.
5060 * @param obj The scroller object
5061 * @param h_pagesize The horizontal page size
5062 * @param v_pagesize The vertical page size
5064 * This sets the page size to an absolute fixed value, with 0 turning it off
5067 * @see elm_scroller_page_relative_set()
5069 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5071 * @brief Show a specific virtual region within the scroller content object.
5073 * @param obj The scroller object
5074 * @param x X coordinate of the region
5075 * @param y Y coordinate of the region
5076 * @param w Width of the region
5077 * @param h Height of the region
5079 * This will ensure all (or part if it does not fit) of the designated
5080 * region in the virtual content object (0, 0 starting at the top-left of the
5081 * virtual content object) is shown within the scroller. Unlike
5082 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5083 * to this location (if configuration in general calls for transitions). It
5084 * may not jump immediately to the new location and make take a while and
5085 * show other content along the way.
5087 * @see elm_scroller_region_show()
5089 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);
5091 * @brief Set event propagation on a scroller
5093 * @param obj The scroller object
5094 * @param propagation If propagation is enabled or not
5096 * This enables or disabled event propagation from the scroller content to
5097 * the scroller and its parent. By default event propagation is disabled.
5099 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5101 * @brief Get event propagation for a scroller
5103 * @param obj The scroller object
5104 * @return The propagation state
5106 * This gets the event propagation for a scroller.
5108 * @see elm_scroller_propagate_events_set()
5110 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5116 * @defgroup Label Label
5118 * @image html img/widget/label/preview-00.png
5119 * @image latex img/widget/label/preview-00.eps
5121 * @brief Widget to display text, with simple html-like markup.
5123 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5124 * text doesn't fit the geometry of the label it will be ellipsized or be
5125 * cut. Elementary provides several themes for this widget:
5126 * @li default - No animation
5127 * @li marker - Centers the text in the label and make it bold by default
5128 * @li slide_long - The entire text appears from the right of the screen and
5129 * slides until it disappears in the left of the screen(reappering on the
5131 * @li slide_short - The text appears in the left of the label and slides to
5132 * the right to show the overflow. When all of the text has been shown the
5133 * position is reset.
5134 * @li slide_bounce - The text appears in the left of the label and slides to
5135 * the right to show the overflow. When all of the text has been shown the
5136 * animation reverses, moving the text to the left.
5138 * Custom themes can of course invent new markup tags and style them any way
5141 * See @ref tutorial_label for a demonstration of how to use a label widget.
5145 * @brief Add a new label to the parent
5147 * @param parent The parent object
5148 * @return The new object or NULL if it cannot be created
5150 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5152 * @brief Set the label on the label object
5154 * @param obj The label object
5155 * @param label The label will be used on the label object
5156 * @deprecated See elm_object_text_set()
5158 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 */
5160 * @brief Get the label used on the label object
5162 * @param obj The label object
5163 * @return The string inside the label
5164 * @deprecated See elm_object_text_get()
5166 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5168 * @brief Set the wrapping behavior of the label
5170 * @param obj The label object
5171 * @param wrap To wrap text or not
5173 * By default no wrapping is done. Possible values for @p wrap are:
5174 * @li ELM_WRAP_NONE - No wrapping
5175 * @li ELM_WRAP_CHAR - wrap between characters
5176 * @li ELM_WRAP_WORD - wrap between words
5177 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5179 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5181 * @brief Get the wrapping behavior of the label
5183 * @param obj The label object
5186 * @see elm_label_line_wrap_set()
5188 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5190 * @brief Set wrap width of the label
5192 * @param obj The label object
5193 * @param w The wrap width in pixels at a minimum where words need to wrap
5195 * This function sets the maximum width size hint of the label.
5197 * @warning This is only relevant if the label is inside a container.
5199 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5201 * @brief Get wrap width of the label
5203 * @param obj The label object
5204 * @return The wrap width in pixels at a minimum where words need to wrap
5206 * @see elm_label_wrap_width_set()
5208 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 * @brief Set wrap height of the label
5212 * @param obj The label object
5213 * @param h The wrap height in pixels at a minimum where words need to wrap
5215 * This function sets the maximum height size hint of the label.
5217 * @warning This is only relevant if the label is inside a container.
5219 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5221 * @brief get wrap width of the label
5223 * @param obj The label object
5224 * @return The wrap height in pixels at a minimum where words need to wrap
5226 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5228 * @brief Set the font size on the label object.
5230 * @param obj The label object
5231 * @param size font size
5233 * @warning NEVER use this. It is for hyper-special cases only. use styles
5234 * instead. e.g. "big", "medium", "small" - or better name them by use:
5235 * "title", "footnote", "quote" etc.
5237 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5239 * @brief Set the text color on the label object
5241 * @param obj The label object
5242 * @param r Red property background color of The label object
5243 * @param g Green property background color of The label object
5244 * @param b Blue property background color of The label object
5245 * @param a Alpha property background color of The label object
5247 * @warning NEVER use this. It is for hyper-special cases only. use styles
5248 * instead. e.g. "big", "medium", "small" - or better name them by use:
5249 * "title", "footnote", "quote" etc.
5251 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);
5253 * @brief Set the text align on the label object
5255 * @param obj The label object
5256 * @param align align mode ("left", "center", "right")
5258 * @warning NEVER use this. It is for hyper-special cases only. use styles
5259 * instead. e.g. "big", "medium", "small" - or better name them by use:
5260 * "title", "footnote", "quote" etc.
5262 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5264 * @brief Set background color of the label
5266 * @param obj The label object
5267 * @param r Red property background color of The label object
5268 * @param g Green property background color of The label object
5269 * @param b Blue property background color of The label object
5270 * @param a Alpha property background alpha of The label object
5272 * @warning NEVER use this. It is for hyper-special cases only. use styles
5273 * instead. e.g. "big", "medium", "small" - or better name them by use:
5274 * "title", "footnote", "quote" etc.
5276 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);
5278 * @brief Set the ellipsis behavior of the label
5280 * @param obj The label object
5281 * @param ellipsis To ellipsis text or not
5283 * If set to true and the text doesn't fit in the label an ellipsis("...")
5284 * will be shown at the end of the widget.
5286 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5287 * choosen wrap method was ELM_WRAP_WORD.
5289 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5291 * @brief Set the text slide of the label
5293 * @param obj The label object
5294 * @param slide To start slide or stop
5296 * If set to true the text of the label will slide throught the length of
5299 * @warning This only work with the themes "slide_short", "slide_long" and
5302 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5304 * @brief Get the text slide mode of the label
5306 * @param obj The label object
5307 * @return slide slide mode value
5309 * @see elm_label_slide_set()
5311 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5313 * @brief Set the slide duration(speed) of the label
5315 * @param obj The label object
5316 * @return The duration in seconds in moving text from slide begin position
5317 * to slide end position
5319 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5321 * @brief Get the slide duration(speed) of the label
5323 * @param obj The label object
5324 * @return The duration time in moving text from slide begin position to slide end position
5326 * @see elm_label_slide_duration_set()
5328 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5334 * @defgroup Toggle Toggle
5336 * @image html img/widget/toggle/preview-00.png
5337 * @image latex img/widget/toggle/preview-00.eps
5339 * @brief A toggle is a slider which can be used to toggle between
5340 * two values. It has two states: on and off.
5342 * Signals that you can add callbacks for are:
5343 * @li "changed" - Whenever the toggle value has been changed. Is not called
5344 * until the toggle is released by the cursor (assuming it
5345 * has been triggered by the cursor in the first place).
5347 * @ref tutorial_toggle show how to use a toggle.
5351 * @brief Add a toggle to @p parent.
5353 * @param parent The parent object
5355 * @return The toggle object
5357 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5359 * @brief Sets the label to be displayed with the toggle.
5361 * @param obj The toggle object
5362 * @param label The label to be displayed
5364 * @deprecated use elm_object_text_set() instead.
5366 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5368 * @brief Gets the label of the toggle
5370 * @param obj toggle object
5371 * @return The label of the toggle
5373 * @deprecated use elm_object_text_get() instead.
5375 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5377 * @brief Set the icon used for the toggle
5379 * @param obj The toggle object
5380 * @param icon The icon object for the button
5382 * Once the icon object is set, a previously set one will be deleted
5383 * If you want to keep that old content object, use the
5384 * elm_toggle_icon_unset() function.
5386 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5388 * @brief Get the icon used for the toggle
5390 * @param obj The toggle object
5391 * @return The icon object that is being used
5393 * Return the icon object which is set for this widget.
5395 * @see elm_toggle_icon_set()
5397 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5399 * @brief Unset the icon used for the toggle
5401 * @param obj The toggle object
5402 * @return The icon object that was being used
5404 * Unparent and return the icon object which was set for this widget.
5406 * @see elm_toggle_icon_set()
5408 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5410 * @brief Sets the labels to be associated with the on and off states of the toggle.
5412 * @param obj The toggle object
5413 * @param onlabel The label displayed when the toggle is in the "on" state
5414 * @param offlabel The label displayed when the toggle is in the "off" state
5416 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5418 * @brief Gets the labels associated with the on and off states of the toggle.
5420 * @param obj The toggle object
5421 * @param onlabel A char** to place the onlabel of @p obj into
5422 * @param offlabel A char** to place the offlabel of @p obj into
5424 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5426 * @brief Sets the state of the toggle to @p state.
5428 * @param obj The toggle object
5429 * @param state The state of @p obj
5431 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5433 * @brief Gets the state of the toggle to @p state.
5435 * @param obj The toggle object
5436 * @return The state of @p obj
5438 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5440 * @brief Sets the state pointer of the toggle to @p statep.
5442 * @param obj The toggle object
5443 * @param statep The state pointer of @p obj
5445 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5451 * @defgroup Frame Frame
5453 * @image html img/widget/frame/preview-00.png
5454 * @image latex img/widget/frame/preview-00.eps
5456 * @brief Frame is a widget that holds some content and has a title.
5458 * The default look is a frame with a title, but Frame supports multple
5466 * @li outdent_bottom
5468 * Of all this styles only default shows the title. Frame emits no signals.
5470 * For a detailed example see the @ref tutorial_frame.
5475 * @brief Add a new frame to the parent
5477 * @param parent The parent object
5478 * @return The new object or NULL if it cannot be created
5480 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5482 * @brief Set the frame label
5484 * @param obj The frame object
5485 * @param label The label of this frame object
5487 * @deprecated use elm_object_text_set() instead.
5489 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5491 * @brief Get the frame label
5493 * @param obj The frame object
5495 * @return The label of this frame objet or NULL if unable to get frame
5497 * @deprecated use elm_object_text_get() instead.
5499 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5501 * @brief Set the content of the frame widget
5503 * Once the content object is set, a previously set one will be deleted.
5504 * If you want to keep that old content object, use the
5505 * elm_frame_content_unset() function.
5507 * @param obj The frame object
5508 * @param content The content will be filled in this frame object
5510 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5512 * @brief Get the content of the frame widget
5514 * Return the content object which is set for this widget
5516 * @param obj The frame object
5517 * @return The content that is being used
5519 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 * @brief Unset the content of the frame widget
5523 * Unparent and return the content object which was set for this widget
5525 * @param obj The frame object
5526 * @return The content that was being used
5528 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5534 * @defgroup Table Table
5536 * A container widget to arrange other widgets in a table where items can
5537 * also span multiple columns or rows - even overlap (and then be raised or
5538 * lowered accordingly to adjust stacking if they do overlap).
5540 * The followin are examples of how to use a table:
5541 * @li @ref tutorial_table_01
5542 * @li @ref tutorial_table_02
5547 * @brief Add a new table to the parent
5549 * @param parent The parent object
5550 * @return The new object or NULL if it cannot be created
5552 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5554 * @brief Set the homogeneous layout in the table
5556 * @param obj The layout object
5557 * @param homogeneous A boolean to set if the layout is homogeneous in the
5558 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5560 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5562 * @brief Get the current table homogeneous mode.
5564 * @param obj The table object
5565 * @return A boolean to indicating if the layout is homogeneous in the table
5566 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5568 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5570 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5572 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5574 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5576 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 * @brief Set padding between cells.
5580 * @param obj The layout object.
5581 * @param horizontal set the horizontal padding.
5582 * @param vertical set the vertical padding.
5584 * Default value is 0.
5586 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5588 * @brief Get padding between cells.
5590 * @param obj The layout object.
5591 * @param horizontal set the horizontal padding.
5592 * @param vertical set the vertical padding.
5594 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5596 * @brief Add a subobject on the table with the coordinates passed
5598 * @param obj The table object
5599 * @param subobj The subobject to be added to the table
5600 * @param x Row number
5601 * @param y Column number
5605 * @note All positioning inside the table is relative to rows and columns, so
5606 * a value of 0 for x and y, means the top left cell of the table, and a
5607 * value of 1 for w and h means @p subobj only takes that 1 cell.
5609 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5611 * @brief Remove child from table.
5613 * @param obj The table object
5614 * @param subobj The subobject
5616 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5618 * @brief Faster way to remove all child objects from a table object.
5620 * @param obj The table object
5621 * @param clear If true, will delete children, else just remove from table.
5623 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5625 * @brief Set the packing location of an existing child of the table
5627 * @param subobj The subobject to be modified in the table
5628 * @param x Row number
5629 * @param y Column number
5633 * Modifies the position of an object already in the table.
5635 * @note All positioning inside the table is relative to rows and columns, so
5636 * a value of 0 for x and y, means the top left cell of the table, and a
5637 * value of 1 for w and h means @p subobj only takes that 1 cell.
5639 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5641 * @brief Get the packing location of an existing child of the table
5643 * @param subobj The subobject to be modified in the table
5644 * @param x Row number
5645 * @param y Column number
5649 * @see elm_table_pack_set()
5651 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5657 * @defgroup Gengrid Gengrid (Generic grid)
5659 * This widget aims to position objects in a grid layout while
5660 * actually creating and rendering only the visible ones, using the
5661 * same idea as the @ref Genlist "genlist": the user defines a @b
5662 * class for each item, specifying functions that will be called at
5663 * object creation, deletion, etc. When those items are selected by
5664 * the user, a callback function is issued. Users may interact with
5665 * a gengrid via the mouse (by clicking on items to select them and
5666 * clicking on the grid's viewport and swiping to pan the whole
5667 * view) or via the keyboard, navigating through item with the
5670 * @section Gengrid_Layouts Gengrid layouts
5672 * Gengrids may layout its items in one of two possible layouts:
5676 * When in "horizontal mode", items will be placed in @b columns,
5677 * from top to bottom and, when the space for a column is filled,
5678 * another one is started on the right, thus expanding the grid
5679 * horizontally, making for horizontal scrolling. When in "vertical
5680 * mode" , though, items will be placed in @b rows, from left to
5681 * right and, when the space for a row is filled, another one is
5682 * started below, thus expanding the grid vertically (and making
5683 * for vertical scrolling).
5685 * @section Gengrid_Items Gengrid items
5687 * An item in a gengrid can have 0 or more text labels (they can be
5688 * regular text or textblock Evas objects - that's up to the style
5689 * to determine), 0 or more icons (which are simply objects
5690 * swallowed into the gengrid item's theming Edje object) and 0 or
5691 * more <b>boolean states</b>, which have the behavior left to the
5692 * user to define. The Edje part names for each of these properties
5693 * will be looked up, in the theme file for the gengrid, under the
5694 * Edje (string) data items named @c "labels", @c "icons" and @c
5695 * "states", respectively. For each of those properties, if more
5696 * than one part is provided, they must have names listed separated
5697 * by spaces in the data fields. For the default gengrid item
5698 * theme, we have @b one label part (@c "elm.text"), @b two icon
5699 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5702 * A gengrid item may be at one of several styles. Elementary
5703 * provides one by default - "default", but this can be extended by
5704 * system or application custom themes/overlays/extensions (see
5705 * @ref Theme "themes" for more details).
5707 * @section Gengrid_Item_Class Gengrid item classes
5709 * In order to have the ability to add and delete items on the fly,
5710 * gengrid implements a class (callback) system where the
5711 * application provides a structure with information about that
5712 * type of item (gengrid may contain multiple different items with
5713 * different classes, states and styles). Gengrid will call the
5714 * functions in this struct (methods) when an item is "realized"
5715 * (i.e., created dynamically, while the user is scrolling the
5716 * grid). All objects will simply be deleted when no longer needed
5717 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5718 * contains the following members:
5719 * - @c item_style - This is a constant string and simply defines
5720 * the name of the item style. It @b must be specified and the
5721 * default should be @c "default".
5722 * - @c func.label_get - This function is called when an item
5723 * object is actually created. The @c data parameter will point to
5724 * the same data passed to elm_gengrid_item_append() and related
5725 * item creation functions. The @c obj parameter is the gengrid
5726 * object itself, while the @c part one is the name string of one
5727 * of the existing text parts in the Edje group implementing the
5728 * item's theme. This function @b must return a strdup'()ed string,
5729 * as the caller will free() it when done. See
5730 * #GridItemLabelGetFunc.
5731 * - @c func.icon_get - This function is called when an item object
5732 * is actually created. The @c data parameter will point to the
5733 * same data passed to elm_gengrid_item_append() and related item
5734 * creation functions. The @c obj parameter is the gengrid object
5735 * itself, while the @c part one is the name string of one of the
5736 * existing (icon) swallow parts in the Edje group implementing the
5737 * item's theme. It must return @c NULL, when no icon is desired,
5738 * or a valid object handle, otherwise. The object will be deleted
5739 * by the gengrid on its deletion or when the item is "unrealized".
5740 * See #GridItemIconGetFunc.
5741 * - @c func.state_get - This function is called when an item
5742 * object is actually created. The @c data parameter will point to
5743 * the same data passed to elm_gengrid_item_append() and related
5744 * item creation functions. The @c obj parameter is the gengrid
5745 * object itself, while the @c part one is the name string of one
5746 * of the state parts in the Edje group implementing the item's
5747 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5748 * true/on. Gengrids will emit a signal to its theming Edje object
5749 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5750 * "source" arguments, respectively, when the state is true (the
5751 * default is false), where @c XXX is the name of the (state) part.
5752 * See #GridItemStateGetFunc.
5753 * - @c func.del - This is called when elm_gengrid_item_del() is
5754 * called on an item or elm_gengrid_clear() is called on the
5755 * gengrid. This is intended for use when gengrid items are
5756 * deleted, so any data attached to the item (e.g. its data
5757 * parameter on creation) can be deleted. See #GridItemDelFunc.
5759 * @section Gengrid_Usage_Hints Usage hints
5761 * If the user wants to have multiple items selected at the same
5762 * time, elm_gengrid_multi_select_set() will permit it. If the
5763 * gengrid is single-selection only (the default), then
5764 * elm_gengrid_select_item_get() will return the selected item or
5765 * @c NULL, if none is selected. If the gengrid is under
5766 * multi-selection, then elm_gengrid_selected_items_get() will
5767 * return a list (that is only valid as long as no items are
5768 * modified (added, deleted, selected or unselected) of child items
5771 * If an item changes (internal (boolean) state, label or icon
5772 * changes), then use elm_gengrid_item_update() to have gengrid
5773 * update the item with the new state. A gengrid will re-"realize"
5774 * the item, thus calling the functions in the
5775 * #Elm_Gengrid_Item_Class set for that item.
5777 * To programmatically (un)select an item, use
5778 * elm_gengrid_item_selected_set(). To get its selected state use
5779 * elm_gengrid_item_selected_get(). To make an item disabled
5780 * (unable to be selected and appear differently) use
5781 * elm_gengrid_item_disabled_set() to set this and
5782 * elm_gengrid_item_disabled_get() to get the disabled state.
5784 * Grid cells will only have their selection smart callbacks called
5785 * when firstly getting selected. Any further clicks will do
5786 * nothing, unless you enable the "always select mode", with
5787 * elm_gengrid_always_select_mode_set(), thus making every click to
5788 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5789 * turn off the ability to select items entirely in the widget and
5790 * they will neither appear selected nor call the selection smart
5793 * Remember that you can create new styles and add your own theme
5794 * augmentation per application with elm_theme_extension_add(). If
5795 * you absolutely must have a specific style that overrides any
5796 * theme the user or system sets up you can use
5797 * elm_theme_overlay_add() to add such a file.
5799 * @section Gengrid_Smart_Events Gengrid smart events
5801 * Smart events that you can add callbacks for are:
5802 * - @c "activated" - The user has double-clicked or pressed
5803 * (enter|return|spacebar) on an item. The @c event_info parameter
5804 * is the gengrid item that was activated.
5805 * - @c "clicked,double" - The user has double-clicked an item.
5806 * The @c event_info parameter is the gengrid item that was double-clicked.
5807 * - @c "selected" - The user has made an item selected. The
5808 * @c event_info parameter is the gengrid item that was selected.
5809 * - @c "unselected" - The user has made an item unselected. The
5810 * @c event_info parameter is the gengrid item that was unselected.
5811 * - @c "realized" - This is called when the item in the gengrid
5812 * has its implementing Evas object instantiated, de facto. @c
5813 * event_info is the gengrid item that was created. The object
5814 * may be deleted at any time, so it is highly advised to the
5815 * caller @b not to use the object pointer returned from
5816 * elm_gengrid_item_object_get(), because it may point to freed
5818 * - @c "unrealized" - This is called when the implementing Evas
5819 * object for this item is deleted. @c event_info is the gengrid
5820 * item that was deleted.
5821 * - @c "changed" - Called when an item is added, removed, resized
5822 * or moved and when the gengrid is resized or gets "horizontal"
5824 * - @c "drag,start,up" - Called when the item in the gengrid has
5825 * been dragged (not scrolled) up.
5826 * - @c "drag,start,down" - Called when the item in the gengrid has
5827 * been dragged (not scrolled) down.
5828 * - @c "drag,start,left" - Called when the item in the gengrid has
5829 * been dragged (not scrolled) left.
5830 * - @c "drag,start,right" - Called when the item in the gengrid has
5831 * been dragged (not scrolled) right.
5832 * - @c "drag,stop" - Called when the item in the gengrid has
5833 * stopped being dragged.
5834 * - @c "drag" - Called when the item in the gengrid is being
5836 * - @c "scroll" - called when the content has been scrolled
5838 * - @c "scroll,drag,start" - called when dragging the content has
5840 * - @c "scroll,drag,stop" - called when dragging the content has
5843 * List of gendrid examples:
5844 * @li @ref gengrid_example
5848 * @addtogroup Gengrid
5852 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5853 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5854 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5855 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5856 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5857 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5858 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5861 * @struct _Elm_Gengrid_Item_Class
5863 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5866 struct _Elm_Gengrid_Item_Class
5868 const char *item_style;
5869 struct _Elm_Gengrid_Item_Class_Func
5871 GridItemLabelGetFunc label_get;
5872 GridItemIconGetFunc icon_get;
5873 GridItemStateGetFunc state_get;
5874 GridItemDelFunc del;
5876 }; /**< #Elm_Gengrid_Item_Class member definitions */
5879 * Add a new gengrid widget to the given parent Elementary
5880 * (container) object
5882 * @param parent The parent object
5883 * @return a new gengrid widget handle or @c NULL, on errors
5885 * This function inserts a new gengrid widget on the canvas.
5887 * @see elm_gengrid_item_size_set()
5888 * @see elm_gengrid_horizontal_set()
5889 * @see elm_gengrid_item_append()
5890 * @see elm_gengrid_item_del()
5891 * @see elm_gengrid_clear()
5895 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5898 * Set the size for the items of a given gengrid widget
5900 * @param obj The gengrid object.
5901 * @param w The items' width.
5902 * @param h The items' height;
5904 * A gengrid, after creation, has still no information on the size
5905 * to give to each of its cells. So, you most probably will end up
5906 * with squares one @ref Fingers "finger" wide, the default
5907 * size. Use this function to force a custom size for you items,
5908 * making them as big as you wish.
5910 * @see elm_gengrid_item_size_get()
5914 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5917 * Get the size set for the items of a given gengrid widget
5919 * @param obj The gengrid object.
5920 * @param w Pointer to a variable where to store the items' width.
5921 * @param h Pointer to a variable where to store the items' height.
5923 * @note Use @c NULL pointers on the size values you're not
5924 * interested in: they'll be ignored by the function.
5926 * @see elm_gengrid_item_size_get() for more details
5930 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5933 * Set the items grid's alignment within a given gengrid widget
5935 * @param obj The gengrid object.
5936 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5937 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5939 * This sets the alignment of the whole grid of items of a gengrid
5940 * within its given viewport. By default, those values are both
5941 * 0.5, meaning that the gengrid will have its items grid placed
5942 * exactly in the middle of its viewport.
5944 * @note If given alignment values are out of the cited ranges,
5945 * they'll be changed to the nearest boundary values on the valid
5948 * @see elm_gengrid_align_get()
5952 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5955 * Get the items grid's alignment values within a given gengrid
5958 * @param obj The gengrid object.
5959 * @param align_x Pointer to a variable where to store the
5960 * horizontal alignment.
5961 * @param align_y Pointer to a variable where to store the vertical
5964 * @note Use @c NULL pointers on the alignment values you're not
5965 * interested in: they'll be ignored by the function.
5967 * @see elm_gengrid_align_set() for more details
5971 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5974 * Set whether a given gengrid widget is or not able have items
5977 * @param obj The gengrid object
5978 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5979 * @c EINA_FALSE to turn it off
5981 * If a gengrid is set to allow reordering, a click held for more
5982 * than 0.5 over a given item will highlight it specially,
5983 * signalling the gengrid has entered the reordering state. From
5984 * that time on, the user will be able to, while still holding the
5985 * mouse button down, move the item freely in the gengrid's
5986 * viewport, replacing to said item to the locations it goes to.
5987 * The replacements will be animated and, whenever the user
5988 * releases the mouse button, the item being replaced gets a new
5989 * definitive place in the grid.
5991 * @see elm_gengrid_reorder_mode_get()
5995 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5998 * Get whether a given gengrid widget is or not able have items
6001 * @param obj The gengrid object
6002 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6005 * @see elm_gengrid_reorder_mode_set() for more details
6009 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6012 * Append a new item in a given gengrid widget.
6014 * @param obj The gengrid object.
6015 * @param gic The item class for the item.
6016 * @param data The item data.
6017 * @param func Convenience function called when the item is
6019 * @param func_data Data to be passed to @p func.
6020 * @return A handle to the item added or @c NULL, on errors.
6022 * This adds an item to the beginning of the gengrid.
6024 * @see elm_gengrid_item_prepend()
6025 * @see elm_gengrid_item_insert_before()
6026 * @see elm_gengrid_item_insert_after()
6027 * @see elm_gengrid_item_del()
6031 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);
6034 * Prepend a new item in a given gengrid widget.
6036 * @param obj The gengrid object.
6037 * @param gic The item class for the item.
6038 * @param data The item data.
6039 * @param func Convenience function called when the item is
6041 * @param func_data Data to be passed to @p func.
6042 * @return A handle to the item added or @c NULL, on errors.
6044 * This adds an item to the end of the gengrid.
6046 * @see elm_gengrid_item_append()
6047 * @see elm_gengrid_item_insert_before()
6048 * @see elm_gengrid_item_insert_after()
6049 * @see elm_gengrid_item_del()
6053 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);
6056 * Insert an item before another in a gengrid widget
6058 * @param obj The gengrid object.
6059 * @param gic The item class for the item.
6060 * @param data The item data.
6061 * @param relative The item to place this new one before.
6062 * @param func Convenience function called when the item is
6064 * @param func_data Data to be passed to @p func.
6065 * @return A handle to the item added or @c NULL, on errors.
6067 * This inserts an item before another in the gengrid.
6069 * @see elm_gengrid_item_append()
6070 * @see elm_gengrid_item_prepend()
6071 * @see elm_gengrid_item_insert_after()
6072 * @see elm_gengrid_item_del()
6076 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);
6079 * Insert an item after another in a gengrid widget
6081 * @param obj The gengrid object.
6082 * @param gic The item class for the item.
6083 * @param data The item data.
6084 * @param relative The item to place this new one after.
6085 * @param func Convenience function called when the item is
6087 * @param func_data Data to be passed to @p func.
6088 * @return A handle to the item added or @c NULL, on errors.
6090 * This inserts an item after another in the gengrid.
6092 * @see elm_gengrid_item_append()
6093 * @see elm_gengrid_item_prepend()
6094 * @see elm_gengrid_item_insert_after()
6095 * @see elm_gengrid_item_del()
6099 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);
6101 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);
6103 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);
6106 * Set whether items on a given gengrid widget are to get their
6107 * selection callbacks issued for @b every subsequent selection
6108 * click on them or just for the first click.
6110 * @param obj The gengrid object
6111 * @param always_select @c EINA_TRUE to make items "always
6112 * selected", @c EINA_FALSE, otherwise
6114 * By default, grid items will only call their selection callback
6115 * function when firstly getting selected, any subsequent further
6116 * clicks will do nothing. With this call, you make those
6117 * subsequent clicks also to issue the selection callbacks.
6119 * @note <b>Double clicks</b> will @b always be reported on items.
6121 * @see elm_gengrid_always_select_mode_get()
6125 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6128 * Get whether items on a given gengrid widget have their selection
6129 * callbacks issued for @b every subsequent selection click on them
6130 * or just for the first click.
6132 * @param obj The gengrid object.
6133 * @return @c EINA_TRUE if the gengrid items are "always selected",
6134 * @c EINA_FALSE, otherwise
6136 * @see elm_gengrid_always_select_mode_set() for more details
6140 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6143 * Set whether items on a given gengrid widget can be selected or not.
6145 * @param obj The gengrid object
6146 * @param no_select @c EINA_TRUE to make items selectable,
6147 * @c EINA_FALSE otherwise
6149 * This will make items in @p obj selectable or not. In the latter
6150 * case, any user interacion on the gendrid items will neither make
6151 * them appear selected nor them call their selection callback
6154 * @see elm_gengrid_no_select_mode_get()
6158 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6161 * Get whether items on a given gengrid widget can be selected or
6164 * @param obj The gengrid object
6165 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6168 * @see elm_gengrid_no_select_mode_set() for more details
6172 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6175 * Enable or disable multi-selection in a given gengrid widget
6177 * @param obj The gengrid object.
6178 * @param multi @c EINA_TRUE, to enable multi-selection,
6179 * @c EINA_FALSE to disable it.
6181 * Multi-selection is the ability for one to have @b more than one
6182 * item selected, on a given gengrid, simultaneously. When it is
6183 * enabled, a sequence of clicks on different items will make them
6184 * all selected, progressively. A click on an already selected item
6185 * will unselect it. If interecting via the keyboard,
6186 * multi-selection is enabled while holding the "Shift" key.
6188 * @note By default, multi-selection is @b disabled on gengrids
6190 * @see elm_gengrid_multi_select_get()
6194 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6197 * Get whether multi-selection is enabled or disabled for a given
6200 * @param obj The gengrid object.
6201 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6202 * EINA_FALSE otherwise
6204 * @see elm_gengrid_multi_select_set() for more details
6208 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6211 * Enable or disable bouncing effect for a given gengrid widget
6213 * @param obj The gengrid object
6214 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6215 * @c EINA_FALSE to disable it
6216 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6217 * @c EINA_FALSE to disable it
6219 * The bouncing effect occurs whenever one reaches the gengrid's
6220 * edge's while panning it -- it will scroll past its limits a
6221 * little bit and return to the edge again, in a animated for,
6224 * @note By default, gengrids have bouncing enabled on both axis
6226 * @see elm_gengrid_bounce_get()
6230 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6233 * Get whether bouncing effects are enabled or disabled, for a
6234 * given gengrid widget, on each axis
6236 * @param obj The gengrid object
6237 * @param h_bounce Pointer to a variable where to store the
6238 * horizontal bouncing flag.
6239 * @param v_bounce Pointer to a variable where to store the
6240 * vertical bouncing flag.
6242 * @see elm_gengrid_bounce_set() for more details
6246 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6249 * Set a given gengrid widget's scrolling page size, relative to
6250 * its viewport size.
6252 * @param obj The gengrid object
6253 * @param h_pagerel The horizontal page (relative) size
6254 * @param v_pagerel The vertical page (relative) size
6256 * The gengrid's scroller is capable of binding scrolling by the
6257 * user to "pages". It means that, while scrolling and, specially
6258 * after releasing the mouse button, the grid will @b snap to the
6259 * nearest displaying page's area. When page sizes are set, the
6260 * grid's continuous content area is split into (equal) page sized
6263 * This function sets the size of a page <b>relatively to the
6264 * viewport dimensions</b> of the gengrid, for each axis. A value
6265 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6266 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6267 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6268 * 1.0. Values beyond those will make it behave behave
6269 * inconsistently. If you only want one axis to snap to pages, use
6270 * the value @c 0.0 for the other one.
6272 * There is a function setting page size values in @b absolute
6273 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6274 * is mutually exclusive to this one.
6276 * @see elm_gengrid_page_relative_get()
6280 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6283 * Get a given gengrid widget's scrolling page size, relative to
6284 * its viewport size.
6286 * @param obj The gengrid object
6287 * @param h_pagerel Pointer to a variable where to store the
6288 * horizontal page (relative) size
6289 * @param v_pagerel Pointer to a variable where to store the
6290 * vertical page (relative) size
6292 * @see elm_gengrid_page_relative_set() for more details
6296 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6299 * Set a given gengrid widget's scrolling page size
6301 * @param obj The gengrid object
6302 * @param h_pagerel The horizontal page size, in pixels
6303 * @param v_pagerel The vertical page size, in pixels
6305 * The gengrid's scroller is capable of binding scrolling by the
6306 * user to "pages". It means that, while scrolling and, specially
6307 * after releasing the mouse button, the grid will @b snap to the
6308 * nearest displaying page's area. When page sizes are set, the
6309 * grid's continuous content area is split into (equal) page sized
6312 * This function sets the size of a page of the gengrid, in pixels,
6313 * for each axis. Sane usable values are, between @c 0 and the
6314 * dimensions of @p obj, for each axis. Values beyond those will
6315 * make it behave behave inconsistently. If you only want one axis
6316 * to snap to pages, use the value @c 0 for the other one.
6318 * There is a function setting page size values in @b relative
6319 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6320 * use is mutually exclusive to this one.
6324 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6327 * Set for what direction a given gengrid widget will expand while
6328 * placing its items.
6330 * @param obj The gengrid object.
6331 * @param setting @c EINA_TRUE to make the gengrid expand
6332 * horizontally, @c EINA_FALSE to expand vertically.
6334 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6335 * in @b columns, from top to bottom and, when the space for a
6336 * column is filled, another one is started on the right, thus
6337 * expanding the grid horizontally. When in "vertical mode"
6338 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6339 * to right and, when the space for a row is filled, another one is
6340 * started below, thus expanding the grid vertically.
6342 * @see elm_gengrid_horizontal_get()
6346 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6349 * Get for what direction a given gengrid widget will expand while
6350 * placing its items.
6352 * @param obj The gengrid object.
6353 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6354 * @c EINA_FALSE if it's set to expand vertically.
6356 * @see elm_gengrid_horizontal_set() for more detais
6360 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6363 * Get the first item in a given gengrid widget
6365 * @param obj The gengrid object
6366 * @return The first item's handle or @c NULL, if there are no
6367 * items in @p obj (and on errors)
6369 * This returns the first item in the @p obj's internal list of
6372 * @see elm_gengrid_last_item_get()
6376 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6379 * Get the last item in a given gengrid widget
6381 * @param obj The gengrid object
6382 * @return The last item's handle or @c NULL, if there are no
6383 * items in @p obj (and on errors)
6385 * This returns the last item in the @p obj's internal list of
6388 * @see elm_gengrid_first_item_get()
6392 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6395 * Get the @b next item in a gengrid widget's internal list of items,
6396 * given a handle to one of those items.
6398 * @param item The gengrid item to fetch next from
6399 * @return The item after @p item, or @c NULL if there's none (and
6402 * This returns the item placed after the @p item, on the container
6405 * @see elm_gengrid_item_prev_get()
6409 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6412 * Get the @b previous item in a gengrid widget's internal list of items,
6413 * given a handle to one of those items.
6415 * @param item The gengrid item to fetch previous from
6416 * @return The item before @p item, or @c NULL if there's none (and
6419 * This returns the item placed before the @p item, on the container
6422 * @see elm_gengrid_item_next_get()
6426 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6429 * Get the gengrid object's handle which contains a given gengrid
6432 * @param item The item to fetch the container from
6433 * @return The gengrid (parent) object
6435 * This returns the gengrid object itself that an item belongs to.
6439 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6442 * Remove a gengrid item from the its parent, deleting it.
6444 * @param item The item to be removed.
6445 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6447 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6452 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6455 * Update the contents of a given gengrid item
6457 * @param item The gengrid item
6459 * This updates an item by calling all the item class functions
6460 * again to get the icons, labels and states. Use this when the
6461 * original item data has changed and you want thta changes to be
6466 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6467 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6468 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6471 * Return the data associated to a given gengrid item
6473 * @param item The gengrid item.
6474 * @return the data associated to this item.
6476 * This returns the @c data value passed on the
6477 * elm_gengrid_item_append() and related item addition calls.
6479 * @see elm_gengrid_item_append()
6480 * @see elm_gengrid_item_data_set()
6484 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6487 * Set the data associated to a given gengrid item
6489 * @param item The gengrid item
6490 * @param data The new data pointer to set on it
6492 * This @b overrides the @c data value passed on the
6493 * elm_gengrid_item_append() and related item addition calls. This
6494 * function @b won't call elm_gengrid_item_update() automatically,
6495 * so you'd issue it afterwards if you want to hove the item
6496 * updated to reflect the that new data.
6498 * @see elm_gengrid_item_data_get()
6502 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6505 * Get a given gengrid item's position, relative to the whole
6506 * gengrid's grid area.
6508 * @param item The Gengrid item.
6509 * @param x Pointer to variable where to store the item's <b>row
6511 * @param y Pointer to variable where to store the item's <b>column
6514 * This returns the "logical" position of the item whithin the
6515 * gengrid. For example, @c (0, 1) would stand for first row,
6520 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6523 * Set whether a given gengrid item is selected or not
6525 * @param item The gengrid item
6526 * @param selected Use @c EINA_TRUE, to make it selected, @c
6527 * EINA_FALSE to make it unselected
6529 * This sets the selected state of an item. If multi selection is
6530 * not enabled on the containing gengrid and @p selected is @c
6531 * EINA_TRUE, any other previously selected items will get
6532 * unselected in favor of this new one.
6534 * @see elm_gengrid_item_selected_get()
6538 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6541 * Get whether a given gengrid item is selected or not
6543 * @param item The gengrid item
6544 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6546 * @see elm_gengrid_item_selected_set() for more details
6550 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6553 * Get the real Evas object created to implement the view of a
6554 * given gengrid item
6556 * @param item The gengrid item.
6557 * @return the Evas object implementing this item's view.
6559 * This returns the actual Evas object used to implement the
6560 * specified gengrid item's view. This may be @c NULL, as it may
6561 * not have been created or may have been deleted, at any time, by
6562 * the gengrid. <b>Do not modify this object</b> (move, resize,
6563 * show, hide, etc.), as the gengrid is controlling it. This
6564 * function is for querying, emitting custom signals or hooking
6565 * lower level callbacks for events on that object. Do not delete
6566 * this object under any circumstances.
6568 * @see elm_gengrid_item_data_get()
6572 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6575 * Show the portion of a gengrid's internal grid containing a given
6576 * item, @b immediately.
6578 * @param item The item to display
6580 * This causes gengrid to @b redraw its viewport's contents to the
6581 * region contining the given @p item item, if it is not fully
6584 * @see elm_gengrid_item_bring_in()
6588 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6591 * Animatedly bring in, to the visible are of a gengrid, a given
6594 * @param item The gengrid item to display
6596 * This causes gengrig to jump to the given @p item item and show
6597 * it (by scrolling), if it is not fully visible. This will use
6598 * animation to do so and take a period of time to complete.
6600 * @see elm_gengrid_item_show()
6604 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6607 * Set whether a given gengrid item is disabled or not.
6609 * @param item The gengrid item
6610 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6611 * to enable it back.
6613 * A disabled item cannot be selected or unselected. It will also
6614 * change its appearance, to signal the user it's disabled.
6616 * @see elm_gengrid_item_disabled_get()
6620 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6623 * Get whether a given gengrid item is disabled or not.
6625 * @param item The gengrid item
6626 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6629 * @see elm_gengrid_item_disabled_set() for more details
6633 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6636 * Set the text to be shown in a given gengrid item's tooltips.
6638 * @param item The gengrid item
6639 * @param text The text to set in the content
6641 * This call will setup the text to be used as tooltip to that item
6642 * (analogous to elm_object_tooltip_text_set(), but being item
6643 * tooltips with higher precedence than object tooltips). It can
6644 * have only one tooltip at a time, so any previous tooltip data
6649 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6652 * Set the content to be shown in a given gengrid item's tooltips
6654 * @param item The gengrid item.
6655 * @param func The function returning the tooltip contents.
6656 * @param data What to provide to @a func as callback data/context.
6657 * @param del_cb Called when data is not needed anymore, either when
6658 * another callback replaces @p func, the tooltip is unset with
6659 * elm_gengrid_item_tooltip_unset() or the owner @p item
6660 * dies. This callback receives as its first parameter the
6661 * given @p data, being @c event_info the item handle.
6663 * This call will setup the tooltip's contents to @p item
6664 * (analogous to elm_object_tooltip_content_cb_set(), but being
6665 * item tooltips with higher precedence than object tooltips). It
6666 * can have only one tooltip at a time, so any previous tooltip
6667 * content will get removed. @p func (with @p data) will be called
6668 * every time Elementary needs to show the tooltip and it should
6669 * return a valid Evas object, which will be fully managed by the
6670 * tooltip system, getting deleted when the tooltip is gone.
6674 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);
6677 * Unset a tooltip from a given gengrid item
6679 * @param item gengrid item to remove a previously set tooltip from.
6681 * This call removes any tooltip set on @p item. The callback
6682 * provided as @c del_cb to
6683 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6684 * notify it is not used anymore (and have resources cleaned, if
6687 * @see elm_gengrid_item_tooltip_content_cb_set()
6691 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6694 * Set a different @b style for a given gengrid item's tooltip.
6696 * @param item gengrid item with tooltip set
6697 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6698 * "default", @c "transparent", etc)
6700 * Tooltips can have <b>alternate styles</b> to be displayed on,
6701 * which are defined by the theme set on Elementary. This function
6702 * works analogously as elm_object_tooltip_style_set(), but here
6703 * applied only to gengrid item objects. The default style for
6704 * tooltips is @c "default".
6706 * @note before you set a style you should define a tooltip with
6707 * elm_gengrid_item_tooltip_content_cb_set() or
6708 * elm_gengrid_item_tooltip_text_set()
6710 * @see elm_gengrid_item_tooltip_style_get()
6714 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6717 * Get the style set a given gengrid item's tooltip.
6719 * @param item gengrid item with tooltip already set on.
6720 * @return style the theme style in use, which defaults to
6721 * "default". If the object does not have a tooltip set,
6722 * then @c NULL is returned.
6724 * @see elm_gengrid_item_tooltip_style_set() for more details
6728 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6730 * @brief Disable size restrictions on an object's tooltip
6731 * @param item The tooltip's anchor object
6732 * @param disable If EINA_TRUE, size restrictions are disabled
6733 * @return EINA_FALSE on failure, EINA_TRUE on success
6735 * This function allows a tooltip to expand beyond its parant window's canvas.
6736 * It will instead be limited only by the size of the display.
6738 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6740 * @brief Retrieve size restriction state of an object's tooltip
6741 * @param item The tooltip's anchor object
6742 * @return If EINA_TRUE, size restrictions are disabled
6744 * This function returns whether a tooltip is allowed to expand beyond
6745 * its parant window's canvas.
6746 * It will instead be limited only by the size of the display.
6748 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6750 * Set the type of mouse pointer/cursor decoration to be shown,
6751 * when the mouse pointer is over the given gengrid widget item
6753 * @param item gengrid item to customize cursor on
6754 * @param cursor the cursor type's name
6756 * This function works analogously as elm_object_cursor_set(), but
6757 * here the cursor's changing area is restricted to the item's
6758 * area, and not the whole widget's. Note that that item cursors
6759 * have precedence over widget cursors, so that a mouse over @p
6760 * item will always show cursor @p type.
6762 * If this function is called twice for an object, a previously set
6763 * cursor will be unset on the second call.
6765 * @see elm_object_cursor_set()
6766 * @see elm_gengrid_item_cursor_get()
6767 * @see elm_gengrid_item_cursor_unset()
6771 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6774 * Get the type of mouse pointer/cursor decoration set to be shown,
6775 * when the mouse pointer is over the given gengrid widget item
6777 * @param item gengrid item with custom cursor set
6778 * @return the cursor type's name or @c NULL, if no custom cursors
6779 * were set to @p item (and on errors)
6781 * @see elm_object_cursor_get()
6782 * @see elm_gengrid_item_cursor_set() for more details
6783 * @see elm_gengrid_item_cursor_unset()
6787 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6790 * Unset any custom mouse pointer/cursor decoration set to be
6791 * shown, when the mouse pointer is over the given gengrid widget
6792 * item, thus making it show the @b default cursor again.
6794 * @param item a gengrid item
6796 * Use this call to undo any custom settings on this item's cursor
6797 * decoration, bringing it back to defaults (no custom style set).
6799 * @see elm_object_cursor_unset()
6800 * @see elm_gengrid_item_cursor_set() for more details
6804 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6807 * Set a different @b style for a given custom cursor set for a
6810 * @param item gengrid item with custom cursor set
6811 * @param style the <b>theme style</b> to use (e.g. @c "default",
6812 * @c "transparent", etc)
6814 * This function only makes sense when one is using custom mouse
6815 * cursor decorations <b>defined in a theme file</b> , which can
6816 * have, given a cursor name/type, <b>alternate styles</b> on
6817 * it. It works analogously as elm_object_cursor_style_set(), but
6818 * here applied only to gengrid item objects.
6820 * @warning Before you set a cursor style you should have defined a
6821 * custom cursor previously on the item, with
6822 * elm_gengrid_item_cursor_set()
6824 * @see elm_gengrid_item_cursor_engine_only_set()
6825 * @see elm_gengrid_item_cursor_style_get()
6829 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6832 * Get the current @b style set for a given gengrid item's custom
6835 * @param item gengrid item with custom cursor set.
6836 * @return style the cursor style in use. If the object does not
6837 * have a cursor set, then @c NULL is returned.
6839 * @see elm_gengrid_item_cursor_style_set() for more details
6843 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6846 * Set if the (custom) cursor for a given gengrid item should be
6847 * searched in its theme, also, or should only rely on the
6850 * @param item item with custom (custom) cursor already set on
6851 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6852 * only on those provided by the rendering engine, @c EINA_FALSE to
6853 * have them searched on the widget's theme, as well.
6855 * @note This call is of use only if you've set a custom cursor
6856 * for gengrid items, with elm_gengrid_item_cursor_set().
6858 * @note By default, cursors will only be looked for between those
6859 * provided by the rendering engine.
6863 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6866 * Get if the (custom) cursor for a given gengrid item is being
6867 * searched in its theme, also, or is only relying on the rendering
6870 * @param item a gengrid item
6871 * @return @c EINA_TRUE, if cursors are being looked for only on
6872 * those provided by the rendering engine, @c EINA_FALSE if they
6873 * are being searched on the widget's theme, as well.
6875 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6879 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6882 * Remove all items from a given gengrid widget
6884 * @param obj The gengrid object.
6886 * This removes (and deletes) all items in @p obj, leaving it
6889 * @see elm_gengrid_item_del(), to remove just one item.
6893 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6896 * Get the selected item in a given gengrid widget
6898 * @param obj The gengrid object.
6899 * @return The selected item's handleor @c NULL, if none is
6900 * selected at the moment (and on errors)
6902 * This returns the selected item in @p obj. If multi selection is
6903 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6904 * the first item in the list is selected, which might not be very
6905 * useful. For that case, see elm_gengrid_selected_items_get().
6909 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6912 * Get <b>a list</b> of selected items in a given gengrid
6914 * @param obj The gengrid object.
6915 * @return The list of selected items or @c NULL, if none is
6916 * selected at the moment (and on errors)
6918 * This returns a list of the selected items, in the order that
6919 * they appear in the grid. This list is only valid as long as no
6920 * more items are selected or unselected (or unselected implictly
6921 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6924 * @see elm_gengrid_selected_item_get()
6928 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935 * @defgroup Clock Clock
6937 * @image html img/widget/clock/preview-00.png
6938 * @image latex img/widget/clock/preview-00.eps
6940 * This is a @b digital clock widget. In its default theme, it has a
6941 * vintage "flipping numbers clock" appearance, which will animate
6942 * sheets of individual algarisms individually as time goes by.
6944 * A newly created clock will fetch system's time (already
6945 * considering local time adjustments) to start with, and will tick
6946 * accondingly. It may or may not show seconds.
6948 * Clocks have an @b edition mode. When in it, the sheets will
6949 * display extra arrow indications on the top and bottom and the
6950 * user may click on them to raise or lower the time values. After
6951 * it's told to exit edition mode, it will keep ticking with that
6952 * new time set (it keeps the difference from local time).
6954 * Also, when under edition mode, user clicks on the cited arrows
6955 * which are @b held for some time will make the clock to flip the
6956 * sheet, thus editing the time, continuosly and automatically for
6957 * the user. The interval between sheet flips will keep growing in
6958 * time, so that it helps the user to reach a time which is distant
6961 * The time display is, by default, in military mode (24h), but an
6962 * am/pm indicator may be optionally shown, too, when it will
6965 * Smart callbacks one can register to:
6966 * - "changed" - the clock's user changed the time
6968 * Here is an example on its usage:
6969 * @li @ref clock_example
6978 * Identifiers for which clock digits should be editable, when a
6979 * clock widget is in edition mode. Values may be ORed together to
6980 * make a mask, naturally.
6982 * @see elm_clock_edit_set()
6983 * @see elm_clock_digit_edit_set()
6985 typedef enum _Elm_Clock_Digedit
6987 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6988 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6989 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6990 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6991 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6992 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6993 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
6994 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
6995 } Elm_Clock_Digedit;
6998 * Add a new clock widget to the given parent Elementary
6999 * (container) object
7001 * @param parent The parent object
7002 * @return a new clock widget handle or @c NULL, on errors
7004 * This function inserts a new clock widget on the canvas.
7008 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7011 * Set a clock widget's time, programmatically
7013 * @param obj The clock widget object
7014 * @param hrs The hours to set
7015 * @param min The minutes to set
7016 * @param sec The secondes to set
7018 * This function updates the time that is showed by the clock
7021 * Values @b must be set within the following ranges:
7022 * - 0 - 23, for hours
7023 * - 0 - 59, for minutes
7024 * - 0 - 59, for seconds,
7026 * even if the clock is not in "military" mode.
7028 * @warning The behavior for values set out of those ranges is @b
7033 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7036 * Get a clock widget's time values
7038 * @param obj The clock object
7039 * @param[out] hrs Pointer to the variable to get the hours value
7040 * @param[out] min Pointer to the variable to get the minutes value
7041 * @param[out] sec Pointer to the variable to get the seconds value
7043 * This function gets the time set for @p obj, returning
7044 * it on the variables passed as the arguments to function
7046 * @note Use @c NULL pointers on the time values you're not
7047 * interested in: they'll be ignored by the function.
7051 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7054 * Set whether a given clock widget is under <b>edition mode</b> or
7055 * under (default) displaying-only mode.
7057 * @param obj The clock object
7058 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7059 * put it back to "displaying only" mode
7061 * This function makes a clock's time to be editable or not <b>by
7062 * user interaction</b>. When in edition mode, clocks @b stop
7063 * ticking, until one brings them back to canonical mode. The
7064 * elm_clock_digit_edit_set() function will influence which digits
7065 * of the clock will be editable. By default, all of them will be
7066 * (#ELM_CLOCK_NONE).
7068 * @note am/pm sheets, if being shown, will @b always be editable
7069 * under edition mode.
7071 * @see elm_clock_edit_get()
7075 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7078 * Retrieve whether a given clock widget is under <b>edition
7079 * mode</b> or under (default) displaying-only mode.
7081 * @param obj The clock object
7082 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7085 * This function retrieves whether the clock's time can be edited
7086 * or not by user interaction.
7088 * @see elm_clock_edit_set() for more details
7092 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7095 * Set what digits of the given clock widget should be editable
7096 * when in edition mode.
7098 * @param obj The clock object
7099 * @param digedit Bit mask indicating the digits to be editable
7100 * (values in #Elm_Clock_Digedit).
7102 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7103 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7106 * @see elm_clock_digit_edit_get()
7110 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7113 * Retrieve what digits of the given clock widget should be
7114 * editable when in edition mode.
7116 * @param obj The clock object
7117 * @return Bit mask indicating the digits to be editable
7118 * (values in #Elm_Clock_Digedit).
7120 * @see elm_clock_digit_edit_set() for more details
7124 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7127 * Set if the given clock widget must show hours in military or
7130 * @param obj The clock object
7131 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7134 * This function sets if the clock must show hours in military or
7135 * am/pm mode. In some countries like Brazil the military mode
7136 * (00-24h-format) is used, in opposition to the USA, where the
7137 * am/pm mode is more commonly used.
7139 * @see elm_clock_show_am_pm_get()
7143 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7146 * Get if the given clock widget shows hours in military or am/pm
7149 * @param obj The clock object
7150 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7153 * This function gets if the clock shows hours in military or am/pm
7156 * @see elm_clock_show_am_pm_set() for more details
7160 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7163 * Set if the given clock widget must show time with seconds or not
7165 * @param obj The clock object
7166 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7168 * This function sets if the given clock must show or not elapsed
7169 * seconds. By default, they are @b not shown.
7171 * @see elm_clock_show_seconds_get()
7175 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7178 * Get whether the given clock widget is showing time with seconds
7181 * @param obj The clock object
7182 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7184 * This function gets whether @p obj is showing or not the elapsed
7187 * @see elm_clock_show_seconds_set()
7191 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7194 * Set the interval on time updates for an user mouse button hold
7195 * on clock widgets' time edition.
7197 * @param obj The clock object
7198 * @param interval The (first) interval value in seconds
7200 * This interval value is @b decreased while the user holds the
7201 * mouse pointer either incrementing or decrementing a given the
7202 * clock digit's value.
7204 * This helps the user to get to a given time distant from the
7205 * current one easier/faster, as it will start to flip quicker and
7206 * quicker on mouse button holds.
7208 * The calculation for the next flip interval value, starting from
7209 * the one set with this call, is the previous interval divided by
7210 * 1.05, so it decreases a little bit.
7212 * The default starting interval value for automatic flips is
7215 * @see elm_clock_interval_get()
7219 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7222 * Get the interval on time updates for an user mouse button hold
7223 * on clock widgets' time edition.
7225 * @param obj The clock object
7226 * @return The (first) interval value, in seconds, set on it
7228 * @see elm_clock_interval_set() for more details
7232 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7239 * @defgroup Layout Layout
7241 * @image html img/widget/layout/preview-00.png
7242 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7244 * @image html img/layout-predefined.png
7245 * @image latex img/layout-predefined.eps width=\textwidth
7247 * This is a container widget that takes a standard Edje design file and
7248 * wraps it very thinly in a widget.
7250 * An Edje design (theme) file has a very wide range of possibilities to
7251 * describe the behavior of elements added to the Layout. Check out the Edje
7252 * documentation and the EDC reference to get more information about what can
7253 * be done with Edje.
7255 * Just like @ref List, @ref Box, and other container widgets, any
7256 * object added to the Layout will become its child, meaning that it will be
7257 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7259 * The Layout widget can contain as many Contents, Boxes or Tables as
7260 * described in its theme file. For instance, objects can be added to
7261 * different Tables by specifying the respective Table part names. The same
7262 * is valid for Content and Box.
7264 * The objects added as child of the Layout will behave as described in the
7265 * part description where they were added. There are 3 possible types of
7266 * parts where a child can be added:
7268 * @section secContent Content (SWALLOW part)
7270 * Only one object can be added to the @c SWALLOW part (but you still can
7271 * have many @c SWALLOW parts and one object on each of them). Use the @c
7272 * elm_layout_content_* set of functions to set, retrieve and unset objects
7273 * as content of the @c SWALLOW. After being set to this part, the object
7274 * size, position, visibility, clipping and other description properties
7275 * will be totally controled by the description of the given part (inside
7276 * the Edje theme file).
7278 * One can use @c evas_object_size_hint_* functions on the child to have some
7279 * kind of control over its behavior, but the resulting behavior will still
7280 * depend heavily on the @c SWALLOW part description.
7282 * The Edje theme also can change the part description, based on signals or
7283 * scripts running inside the theme. This change can also be animated. All of
7284 * this will affect the child object set as content accordingly. The object
7285 * size will be changed if the part size is changed, it will animate move if
7286 * the part is moving, and so on.
7288 * The following picture demonstrates a Layout widget with a child object
7289 * added to its @c SWALLOW:
7291 * @image html layout_swallow.png
7292 * @image latex layout_swallow.eps width=\textwidth
7294 * @section secBox Box (BOX part)
7296 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7297 * allows one to add objects to the box and have them distributed along its
7298 * area, accordingly to the specified @a layout property (now by @a layout we
7299 * mean the chosen layouting design of the Box, not the Layout widget
7302 * A similar effect for having a box with its position, size and other things
7303 * controled by the Layout theme would be to create an Elementary @ref Box
7304 * widget and add it as a Content in the @c SWALLOW part.
7306 * The main difference of using the Layout Box is that its behavior, the box
7307 * properties like layouting format, padding, align, etc. will be all
7308 * controled by the theme. This means, for example, that a signal could be
7309 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7310 * handled the signal by changing the box padding, or align, or both. Using
7311 * the Elementary @ref Box widget is not necessarily harder or easier, it
7312 * just depends on the circunstances and requirements.
7314 * The Layout Box can be used through the @c elm_layout_box_* set of
7317 * The following picture demonstrates a Layout widget with many child objects
7318 * added to its @c BOX part:
7320 * @image html layout_box.png
7321 * @image latex layout_box.eps width=\textwidth
7323 * @section secTable Table (TABLE part)
7325 * Just like the @ref secBox, the Layout Table is very similar to the
7326 * Elementary @ref Table widget. It allows one to add objects to the Table
7327 * specifying the row and column where the object should be added, and any
7328 * column or row span if necessary.
7330 * Again, we could have this design by adding a @ref Table widget to the @c
7331 * SWALLOW part using elm_layout_content_set(). The same difference happens
7332 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7333 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7335 * The Layout Table can be used through the @c elm_layout_table_* set of
7338 * The following picture demonstrates a Layout widget with many child objects
7339 * added to its @c TABLE part:
7341 * @image html layout_table.png
7342 * @image latex layout_table.eps width=\textwidth
7344 * @section secPredef Predefined Layouts
7346 * Another interesting thing about the Layout widget is that it offers some
7347 * predefined themes that come with the default Elementary theme. These
7348 * themes can be set by the call elm_layout_theme_set(), and provide some
7349 * basic functionality depending on the theme used.
7351 * Most of them already send some signals, some already provide a toolbar or
7352 * back and next buttons.
7354 * These are available predefined theme layouts. All of them have class = @c
7355 * layout, group = @c application, and style = one of the following options:
7357 * @li @c toolbar-content - application with toolbar and main content area
7358 * @li @c toolbar-content-back - application with toolbar and main content
7359 * area with a back button and title area
7360 * @li @c toolbar-content-back-next - application with toolbar and main
7361 * content area with a back and next buttons and title area
7362 * @li @c content-back - application with a main content area with a back
7363 * button and title area
7364 * @li @c content-back-next - application with a main content area with a
7365 * back and next buttons and title area
7366 * @li @c toolbar-vbox - application with toolbar and main content area as a
7368 * @li @c toolbar-table - application with toolbar and main content area as a
7371 * @section secExamples Examples
7373 * Some examples of the Layout widget can be found here:
7374 * @li @ref layout_example_01
7375 * @li @ref layout_example_02
7376 * @li @ref layout_example_03
7377 * @li @ref layout_example_edc
7382 * Add a new layout to the parent
7384 * @param parent The parent object
7385 * @return The new object or NULL if it cannot be created
7387 * @see elm_layout_file_set()
7388 * @see elm_layout_theme_set()
7392 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7394 * Set the file that will be used as layout
7396 * @param obj The layout object
7397 * @param file The path to file (edj) that will be used as layout
7398 * @param group The group that the layout belongs in edje file
7400 * @return (1 = success, 0 = error)
7404 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7406 * Set the edje group from the elementary theme that will be used as layout
7408 * @param obj The layout object
7409 * @param clas the clas of the group
7410 * @param group the group
7411 * @param style the style to used
7413 * @return (1 = success, 0 = error)
7417 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7419 * Set the layout content.
7421 * @param obj The layout object
7422 * @param swallow The swallow part name in the edje file
7423 * @param content The child that will be added in this layout object
7425 * Once the content object is set, a previously set one will be deleted.
7426 * If you want to keep that old content object, use the
7427 * elm_layout_content_unset() function.
7429 * @note In an Edje theme, the part used as a content container is called @c
7430 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7431 * expected to be a part name just like the second parameter of
7432 * elm_layout_box_append().
7434 * @see elm_layout_box_append()
7435 * @see elm_layout_content_get()
7436 * @see elm_layout_content_unset()
7441 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7443 * Get the child object in the given content part.
7445 * @param obj The layout object
7446 * @param swallow The SWALLOW part to get its content
7448 * @return The swallowed object or NULL if none or an error occurred
7450 * @see elm_layout_content_set()
7454 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7456 * Unset the layout content.
7458 * @param obj The layout object
7459 * @param swallow The swallow part name in the edje file
7460 * @return The content that was being used
7462 * Unparent and return the content object which was set for this part.
7464 * @see elm_layout_content_set()
7468 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7470 * Set the text of the given part
7472 * @param obj The layout object
7473 * @param part The TEXT part where to set the text
7474 * @param text The text to set
7477 * @deprecated use elm_object_text_* instead.
7479 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7481 * Get the text set in the given part
7483 * @param obj The layout object
7484 * @param part The TEXT part to retrieve the text off
7486 * @return The text set in @p part
7489 * @deprecated use elm_object_text_* instead.
7491 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7493 * Append child to layout box part.
7495 * @param obj the layout object
7496 * @param part the box part to which the object will be appended.
7497 * @param child the child object to append to box.
7499 * Once the object is appended, it will become child of the layout. Its
7500 * lifetime will be bound to the layout, whenever the layout dies the child
7501 * will be deleted automatically. One should use elm_layout_box_remove() to
7502 * make this layout forget about the object.
7504 * @see elm_layout_box_prepend()
7505 * @see elm_layout_box_insert_before()
7506 * @see elm_layout_box_insert_at()
7507 * @see elm_layout_box_remove()
7511 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7513 * Prepend child to layout box part.
7515 * @param obj the layout object
7516 * @param part the box part to prepend.
7517 * @param child the child object to prepend to box.
7519 * Once the object is prepended, it will become child of the layout. Its
7520 * lifetime will be bound to the layout, whenever the layout dies the child
7521 * will be deleted automatically. One should use elm_layout_box_remove() to
7522 * make this layout forget about the object.
7524 * @see elm_layout_box_append()
7525 * @see elm_layout_box_insert_before()
7526 * @see elm_layout_box_insert_at()
7527 * @see elm_layout_box_remove()
7531 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7533 * Insert child to layout box part before a reference object.
7535 * @param obj the layout object
7536 * @param part the box part to insert.
7537 * @param child the child object to insert into box.
7538 * @param reference another reference object to insert before in box.
7540 * Once the object is inserted, it will become child of the layout. Its
7541 * lifetime will be bound to the layout, whenever the layout dies the child
7542 * will be deleted automatically. One should use elm_layout_box_remove() to
7543 * make this layout forget about the object.
7545 * @see elm_layout_box_append()
7546 * @see elm_layout_box_prepend()
7547 * @see elm_layout_box_insert_before()
7548 * @see elm_layout_box_remove()
7552 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7554 * Insert child to layout box part at a given position.
7556 * @param obj the layout object
7557 * @param part the box part to insert.
7558 * @param child the child object to insert into box.
7559 * @param pos the numeric position >=0 to insert the child.
7561 * Once the object is inserted, it will become child of the layout. Its
7562 * lifetime will be bound to the layout, whenever the layout dies the child
7563 * will be deleted automatically. One should use elm_layout_box_remove() to
7564 * make this layout forget about the object.
7566 * @see elm_layout_box_append()
7567 * @see elm_layout_box_prepend()
7568 * @see elm_layout_box_insert_before()
7569 * @see elm_layout_box_remove()
7573 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7575 * Remove a child of the given part box.
7577 * @param obj The layout object
7578 * @param part The box part name to remove child.
7579 * @param child The object to remove from box.
7580 * @return The object that was being used, or NULL if not found.
7582 * The object will be removed from the box part and its lifetime will
7583 * not be handled by the layout anymore. This is equivalent to
7584 * elm_layout_content_unset() for box.
7586 * @see elm_layout_box_append()
7587 * @see elm_layout_box_remove_all()
7591 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7593 * Remove all child of the given part box.
7595 * @param obj The layout object
7596 * @param part The box part name to remove child.
7597 * @param clear If EINA_TRUE, then all objects will be deleted as
7598 * well, otherwise they will just be removed and will be
7599 * dangling on the canvas.
7601 * The objects will be removed from the box part and their lifetime will
7602 * not be handled by the layout anymore. This is equivalent to
7603 * elm_layout_box_remove() for all box children.
7605 * @see elm_layout_box_append()
7606 * @see elm_layout_box_remove()
7610 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7612 * Insert child to layout table part.
7614 * @param obj the layout object
7615 * @param part the box part to pack child.
7616 * @param child_obj the child object to pack into table.
7617 * @param col the column to which the child should be added. (>= 0)
7618 * @param row the row to which the child should be added. (>= 0)
7619 * @param colspan how many columns should be used to store this object. (>=
7621 * @param rowspan how many rows should be used to store this object. (>= 1)
7623 * Once the object is inserted, it will become child of the table. Its
7624 * lifetime will be bound to the layout, and whenever the layout dies the
7625 * child will be deleted automatically. One should use
7626 * elm_layout_table_remove() to make this layout forget about the object.
7628 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7629 * more space than a single cell. For instance, the following code:
7631 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7634 * Would result in an object being added like the following picture:
7636 * @image html layout_colspan.png
7637 * @image latex layout_colspan.eps width=\textwidth
7639 * @see elm_layout_table_unpack()
7640 * @see elm_layout_table_clear()
7644 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);
7646 * Unpack (remove) a child of the given part table.
7648 * @param obj The layout object
7649 * @param part The table part name to remove child.
7650 * @param child_obj The object to remove from table.
7651 * @return The object that was being used, or NULL if not found.
7653 * The object will be unpacked from the table part and its lifetime
7654 * will not be handled by the layout anymore. This is equivalent to
7655 * elm_layout_content_unset() for table.
7657 * @see elm_layout_table_pack()
7658 * @see elm_layout_table_clear()
7662 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7664 * Remove all child of the given part table.
7666 * @param obj The layout object
7667 * @param part The table part name to remove child.
7668 * @param clear If EINA_TRUE, then all objects will be deleted as
7669 * well, otherwise they will just be removed and will be
7670 * dangling on the canvas.
7672 * The objects will be removed from the table part and their lifetime will
7673 * not be handled by the layout anymore. This is equivalent to
7674 * elm_layout_table_unpack() for all table children.
7676 * @see elm_layout_table_pack()
7677 * @see elm_layout_table_unpack()
7681 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7683 * Get the edje layout
7685 * @param obj The layout object
7687 * @return A Evas_Object with the edje layout settings loaded
7688 * with function elm_layout_file_set
7690 * This returns the edje object. It is not expected to be used to then
7691 * swallow objects via edje_object_part_swallow() for example. Use
7692 * elm_layout_content_set() instead so child object handling and sizing is
7695 * @note This function should only be used if you really need to call some
7696 * low level Edje function on this edje object. All the common stuff (setting
7697 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7698 * with proper elementary functions.
7700 * @see elm_object_signal_callback_add()
7701 * @see elm_object_signal_emit()
7702 * @see elm_object_text_part_set()
7703 * @see elm_layout_content_set()
7704 * @see elm_layout_box_append()
7705 * @see elm_layout_table_pack()
7706 * @see elm_layout_data_get()
7710 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7712 * Get the edje data from the given layout
7714 * @param obj The layout object
7715 * @param key The data key
7717 * @return The edje data string
7719 * This function fetches data specified inside the edje theme of this layout.
7720 * This function return NULL if data is not found.
7722 * In EDC this comes from a data block within the group block that @p
7723 * obj was loaded from. E.g.
7730 * item: "key1" "value1";
7731 * item: "key2" "value2";
7739 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7743 * @param obj The layout object
7745 * Manually forces a sizing re-evaluation. This is useful when the minimum
7746 * size required by the edje theme of this layout has changed. The change on
7747 * the minimum size required by the edje theme is not immediately reported to
7748 * the elementary layout, so one needs to call this function in order to tell
7749 * the widget (layout) that it needs to reevaluate its own size.
7751 * The minimum size of the theme is calculated based on minimum size of
7752 * parts, the size of elements inside containers like box and table, etc. All
7753 * of this can change due to state changes, and that's when this function
7756 * Also note that a standard signal of "size,eval" "elm" emitted from the
7757 * edje object will cause this to happen too.
7761 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7762 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7763 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7764 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7765 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7766 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7767 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);
7768 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7770 * @def elm_layout_icon_set
7771 * Convienience macro to set the icon object in a layout that follows the
7772 * Elementary naming convention for its parts.
7776 #define elm_layout_icon_set(_ly, _obj) \
7779 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7780 if ((_obj)) sig = "elm,state,icon,visible"; \
7781 else sig = "elm,state,icon,hidden"; \
7782 elm_object_signal_emit((_ly), sig, "elm"); \
7786 * @def elm_layout_icon_get
7787 * Convienience macro to get the icon object from a layout that follows the
7788 * Elementary naming convention for its parts.
7792 #define elm_layout_icon_get(_ly) \
7793 elm_layout_content_get((_ly), "elm.swallow.icon")
7796 * @def elm_layout_end_set
7797 * Convienience macro to set the end object in a layout that follows the
7798 * Elementary naming convention for its parts.
7802 #define elm_layout_end_set(_ly, _obj) \
7805 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7806 if ((_obj)) sig = "elm,state,end,visible"; \
7807 else sig = "elm,state,end,hidden"; \
7808 elm_object_signal_emit((_ly), sig, "elm"); \
7812 * @def elm_layout_end_get
7813 * Convienience macro to get the end object in a layout that follows the
7814 * Elementary naming convention for its parts.
7818 #define elm_layout_end_get(_ly) \
7819 elm_layout_content_get((_ly), "elm.swallow.end")
7822 * @def elm_layout_label_set
7823 * Convienience macro to set the label in a layout that follows the
7824 * Elementary naming convention for its parts.
7827 * @deprecated use elm_object_text_* instead.
7829 #define elm_layout_label_set(_ly, _txt) \
7830 elm_layout_text_set((_ly), "elm.text", (_txt))
7833 * @def elm_layout_label_get
7834 * Convienience macro to get the label in a layout that follows the
7835 * Elementary naming convention for its parts.
7838 * @deprecated use elm_object_text_* instead.
7840 #define elm_layout_label_get(_ly) \
7841 elm_layout_text_get((_ly), "elm.text")
7843 /* smart callbacks called:
7844 * "theme,changed" - when elm theme is changed.
7848 * @defgroup Notify Notify
7850 * @image html img/widget/notify/preview-00.png
7851 * @image latex img/widget/notify/preview-00.eps
7853 * Display a container in a particular region of the parent(top, bottom,
7854 * etc. A timeout can be set to automatically hide the notify. This is so
7855 * that, after an evas_object_show() on a notify object, if a timeout was set
7856 * on it, it will @b automatically get hidden after that time.
7858 * Signals that you can add callbacks for are:
7859 * @li "timeout" - when timeout happens on notify and it's hidden
7860 * @li "block,clicked" - when a click outside of the notify happens
7862 * @ref tutorial_notify show usage of the API.
7867 * @brief Possible orient values for notify.
7869 * This values should be used in conjunction to elm_notify_orient_set() to
7870 * set the position in which the notify should appear(relative to its parent)
7871 * and in conjunction with elm_notify_orient_get() to know where the notify
7874 typedef enum _Elm_Notify_Orient
7876 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7877 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7878 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7879 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7880 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7881 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7882 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7883 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7884 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7885 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7886 } Elm_Notify_Orient;
7888 * @brief Add a new notify to the parent
7890 * @param parent The parent object
7891 * @return The new object or NULL if it cannot be created
7893 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7895 * @brief Set the content of the notify widget
7897 * @param obj The notify object
7898 * @param content The content will be filled in this notify object
7900 * Once the content object is set, a previously set one will be deleted. If
7901 * you want to keep that old content object, use the
7902 * elm_notify_content_unset() function.
7904 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7906 * @brief Unset the content of the notify widget
7908 * @param obj The notify object
7909 * @return The content that was being used
7911 * Unparent and return the content object which was set for this widget
7913 * @see elm_notify_content_set()
7915 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7917 * @brief Return the content of the notify widget
7919 * @param obj The notify object
7920 * @return The content that is being used
7922 * @see elm_notify_content_set()
7924 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7926 * @brief Set the notify parent
7928 * @param obj The notify object
7929 * @param content The new parent
7931 * Once the parent object is set, a previously set one will be disconnected
7934 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7936 * @brief Get the notify parent
7938 * @param obj The notify object
7939 * @return The parent
7941 * @see elm_notify_parent_set()
7943 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7945 * @brief Set the orientation
7947 * @param obj The notify object
7948 * @param orient The new orientation
7950 * Sets the position in which the notify will appear in its parent.
7952 * @see @ref Elm_Notify_Orient for possible values.
7954 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7956 * @brief Return the orientation
7957 * @param obj The notify object
7958 * @return The orientation of the notification
7960 * @see elm_notify_orient_set()
7961 * @see Elm_Notify_Orient
7963 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7965 * @brief Set the time interval after which the notify window is going to be
7968 * @param obj The notify object
7969 * @param time The timeout in seconds
7971 * This function sets a timeout and starts the timer controlling when the
7972 * notify is hidden. Since calling evas_object_show() on a notify restarts
7973 * the timer controlling when the notify is hidden, setting this before the
7974 * notify is shown will in effect mean starting the timer when the notify is
7977 * @note Set a value <= 0.0 to disable a running timer.
7979 * @note If the value > 0.0 and the notify is previously visible, the
7980 * timer will be started with this value, canceling any running timer.
7982 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7984 * @brief Return the timeout value (in seconds)
7985 * @param obj the notify object
7987 * @see elm_notify_timeout_set()
7989 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7991 * @brief Sets whether events should be passed to by a click outside
7994 * @param obj The notify object
7995 * @param repeats EINA_TRUE Events are repeats, else no
7997 * When true if the user clicks outside the window the events will be caught
7998 * by the others widgets, else the events are blocked.
8000 * @note The default value is EINA_TRUE.
8002 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8004 * @brief Return true if events are repeat below the notify object
8005 * @param obj the notify object
8007 * @see elm_notify_repeat_events_set()
8009 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8015 * @defgroup Hover Hover
8017 * @image html img/widget/hover/preview-00.png
8018 * @image latex img/widget/hover/preview-00.eps
8020 * A Hover object will hover over its @p parent object at the @p target
8021 * location. Anything in the background will be given a darker coloring to
8022 * indicate that the hover object is on top (at the default theme). When the
8023 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8024 * clicked that @b doesn't cause the hover to be dismissed.
8026 * @note The hover object will take up the entire space of @p target
8029 * Elementary has the following styles for the hover widget:
8033 * @li hoversel_vertical
8035 * The following are the available position for content:
8047 * Signals that you can add callbacks for are:
8048 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8049 * @li "smart,changed" - a content object placed under the "smart"
8050 * policy was replaced to a new slot direction.
8052 * See @ref tutorial_hover for more information.
8056 typedef enum _Elm_Hover_Axis
8058 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8059 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8060 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8061 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8064 * @brief Adds a hover object to @p parent
8066 * @param parent The parent object
8067 * @return The hover object or NULL if one could not be created
8069 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8071 * @brief Sets the target object for the hover.
8073 * @param obj The hover object
8074 * @param target The object to center the hover onto. The hover
8076 * This function will cause the hover to be centered on the target object.
8078 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8080 * @brief Gets the target object for the hover.
8082 * @param obj The hover object
8083 * @param parent The object to locate the hover over.
8085 * @see elm_hover_target_set()
8087 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8089 * @brief Sets the parent object for the hover.
8091 * @param obj The hover object
8092 * @param parent The object to locate the hover over.
8094 * This function will cause the hover to take up the entire space that the
8095 * parent object fills.
8097 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8099 * @brief Gets the parent object for the hover.
8101 * @param obj The hover object
8102 * @return The parent object to locate the hover over.
8104 * @see elm_hover_parent_set()
8106 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8108 * @brief Sets the content of the hover object and the direction in which it
8111 * @param obj The hover object
8112 * @param swallow The direction that the object will be displayed
8113 * at. Accepted values are "left", "top-left", "top", "top-right",
8114 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8116 * @param content The content to place at @p swallow
8118 * Once the content object is set for a given direction, a previously
8119 * set one (on the same direction) will be deleted. If you want to
8120 * keep that old content object, use the elm_hover_content_unset()
8123 * All directions may have contents at the same time, except for
8124 * "smart". This is a special placement hint and its use case
8125 * independs of the calculations coming from
8126 * elm_hover_best_content_location_get(). Its use is for cases when
8127 * one desires only one hover content, but with a dinamic special
8128 * placement within the hover area. The content's geometry, whenever
8129 * it changes, will be used to decide on a best location not
8130 * extrapolating the hover's parent object view to show it in (still
8131 * being the hover's target determinant of its medium part -- move and
8132 * resize it to simulate finger sizes, for example). If one of the
8133 * directions other than "smart" are used, a previously content set
8134 * using it will be deleted, and vice-versa.
8136 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8138 * @brief Get the content of the hover object, in a given direction.
8140 * Return the content object which was set for this widget in the
8141 * @p swallow direction.
8143 * @param obj The hover object
8144 * @param swallow The direction that the object was display at.
8145 * @return The content that was being used
8147 * @see elm_hover_content_set()
8149 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8151 * @brief Unset the content of the hover object, in a given direction.
8153 * Unparent and return the content object set at @p swallow direction.
8155 * @param obj The hover object
8156 * @param swallow The direction that the object was display at.
8157 * @return The content that was being used.
8159 * @see elm_hover_content_set()
8161 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8163 * @brief Returns the best swallow location for content in the hover.
8165 * @param obj The hover object
8166 * @param pref_axis The preferred orientation axis for the hover object to use
8167 * @return The edje location to place content into the hover or @c
8170 * Best is defined here as the location at which there is the most available
8173 * @p pref_axis may be one of
8174 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8175 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8176 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8177 * - @c ELM_HOVER_AXIS_BOTH -- both
8179 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8180 * nescessarily be along the horizontal axis("left" or "right"). If
8181 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8182 * be along the vertical axis("top" or "bottom"). Chossing
8183 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8184 * returned position may be in either axis.
8186 * @see elm_hover_content_set()
8188 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8195 * @defgroup Entry Entry
8197 * @image html img/widget/entry/preview-00.png
8198 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8199 * @image html img/widget/entry/preview-01.png
8200 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8201 * @image html img/widget/entry/preview-02.png
8202 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8203 * @image html img/widget/entry/preview-03.png
8204 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8206 * An entry is a convenience widget which shows a box that the user can
8207 * enter text into. Entries by default don't scroll, so they grow to
8208 * accomodate the entire text, resizing the parent window as needed. This
8209 * can be changed with the elm_entry_scrollable_set() function.
8211 * They can also be single line or multi line (the default) and when set
8212 * to multi line mode they support text wrapping in any of the modes
8213 * indicated by #Elm_Wrap_Type.
8215 * Other features include password mode, filtering of inserted text with
8216 * elm_entry_text_filter_append() and related functions, inline "items" and
8217 * formatted markup text.
8219 * @section entry-markup Formatted text
8221 * The markup tags supported by the Entry are defined by the theme, but
8222 * even when writing new themes or extensions it's a good idea to stick to
8223 * a sane default, to maintain coherency and avoid application breakages.
8224 * Currently defined by the default theme are the following tags:
8225 * @li \<br\>: Inserts a line break.
8226 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8228 * @li \<tab\>: Inserts a tab.
8229 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8231 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8232 * @li \<link\>...\</link\>: Underlines the enclosed text.
8233 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8235 * @section entry-special Special markups
8237 * Besides those used to format text, entries support two special markup
8238 * tags used to insert clickable portions of text or items inlined within
8241 * @subsection entry-anchors Anchors
8243 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8244 * \</a\> tags and an event will be generated when this text is clicked,
8248 * This text is outside <a href=anc-01>but this one is an anchor</a>
8251 * The @c href attribute in the opening tag gives the name that will be
8252 * used to identify the anchor and it can be any valid utf8 string.
8254 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8255 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8256 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8257 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8260 * @subsection entry-items Items
8262 * Inlined in the text, any other @c Evas_Object can be inserted by using
8263 * \<item\> tags this way:
8266 * <item size=16x16 vsize=full href=emoticon/haha></item>
8269 * Just like with anchors, the @c href identifies each item, but these need,
8270 * in addition, to indicate their size, which is done using any one of
8271 * @c size, @c absize or @c relsize attributes. These attributes take their
8272 * value in the WxH format, where W is the width and H the height of the
8275 * @li absize: Absolute pixel size for the item. Whatever value is set will
8276 * be the item's size regardless of any scale value the object may have
8277 * been set to. The final line height will be adjusted to fit larger items.
8278 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8280 * @li relsize: Size is adjusted for the item to fit within the current
8283 * Besides their size, items are specificed a @c vsize value that affects
8284 * how their final size and position are calculated. The possible values
8286 * @li ascent: Item will be placed within the line's baseline and its
8287 * ascent. That is, the height between the line where all characters are
8288 * positioned and the highest point in the line. For @c size and @c absize
8289 * items, the descent value will be added to the total line height to make
8290 * them fit. @c relsize items will be adjusted to fit within this space.
8291 * @li full: Items will be placed between the descent and ascent, or the
8292 * lowest point in the line and its highest.
8294 * The next image shows different configurations of items and how they
8295 * are the previously mentioned options affect their sizes. In all cases,
8296 * the green line indicates the ascent, blue for the baseline and red for
8299 * @image html entry_item.png
8300 * @image latex entry_item.eps width=\textwidth
8302 * And another one to show how size differs from absize. In the first one,
8303 * the scale value is set to 1.0, while the second one is using one of 2.0.
8305 * @image html entry_item_scale.png
8306 * @image latex entry_item_scale.eps width=\textwidth
8308 * After the size for an item is calculated, the entry will request an
8309 * object to place in its space. For this, the functions set with
8310 * elm_entry_item_provider_append() and related functions will be called
8311 * in order until one of them returns a @c non-NULL value. If no providers
8312 * are available, or all of them return @c NULL, then the entry falls back
8313 * to one of the internal defaults, provided the name matches with one of
8316 * All of the following are currently supported:
8319 * - emoticon/angry-shout
8320 * - emoticon/crazy-laugh
8321 * - emoticon/evil-laugh
8323 * - emoticon/goggle-smile
8325 * - emoticon/grumpy-smile
8327 * - emoticon/guilty-smile
8329 * - emoticon/half-smile
8330 * - emoticon/happy-panting
8332 * - emoticon/indifferent
8334 * - emoticon/knowing-grin
8336 * - emoticon/little-bit-sorry
8337 * - emoticon/love-lots
8339 * - emoticon/minimal-smile
8340 * - emoticon/not-happy
8341 * - emoticon/not-impressed
8343 * - emoticon/opensmile
8346 * - emoticon/squint-laugh
8347 * - emoticon/surprised
8348 * - emoticon/suspicious
8349 * - emoticon/tongue-dangling
8350 * - emoticon/tongue-poke
8352 * - emoticon/unhappy
8353 * - emoticon/very-sorry
8356 * - emoticon/worried
8359 * Alternatively, an item may reference an image by its path, using
8360 * the URI form @c file:///path/to/an/image.png and the entry will then
8361 * use that image for the item.
8363 * @section entry-files Loading and saving files
8365 * Entries have convinience functions to load text from a file and save
8366 * changes back to it after a short delay. The automatic saving is enabled
8367 * by default, but can be disabled with elm_entry_autosave_set() and files
8368 * can be loaded directly as plain text or have any markup in them
8369 * recognized. See elm_entry_file_set() for more details.
8371 * @section entry-signals Emitted signals
8373 * This widget emits the following signals:
8375 * @li "changed": The text within the entry was changed.
8376 * @li "changed,user": The text within the entry was changed because of user interaction.
8377 * @li "activated": The enter key was pressed on a single line entry.
8378 * @li "press": A mouse button has been pressed on the entry.
8379 * @li "longpressed": A mouse button has been pressed and held for a couple
8381 * @li "clicked": The entry has been clicked (mouse press and release).
8382 * @li "clicked,double": The entry has been double clicked.
8383 * @li "clicked,triple": The entry has been triple clicked.
8384 * @li "focused": The entry has received focus.
8385 * @li "unfocused": The entry has lost focus.
8386 * @li "selection,paste": A paste of the clipboard contents was requested.
8387 * @li "selection,copy": A copy of the selected text into the clipboard was
8389 * @li "selection,cut": A cut of the selected text into the clipboard was
8391 * @li "selection,start": A selection has begun and no previous selection
8393 * @li "selection,changed": The current selection has changed.
8394 * @li "selection,cleared": The current selection has been cleared.
8395 * @li "cursor,changed": The cursor has changed position.
8396 * @li "anchor,clicked": An anchor has been clicked. The event_info
8397 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8398 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8399 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8400 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8401 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8402 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8403 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8404 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8405 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8406 * @li "preedit,changed": The preedit string has changed.
8408 * @section entry-examples
8410 * An overview of the Entry API can be seen in @ref entry_example_01
8415 * @typedef Elm_Entry_Anchor_Info
8417 * The info sent in the callback for the "anchor,clicked" signals emitted
8420 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8422 * @struct _Elm_Entry_Anchor_Info
8424 * The info sent in the callback for the "anchor,clicked" signals emitted
8427 struct _Elm_Entry_Anchor_Info
8429 const char *name; /**< The name of the anchor, as stated in its href */
8430 int button; /**< The mouse button used to click on it */
8431 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8432 y, /**< Anchor geometry, relative to canvas */
8433 w, /**< Anchor geometry, relative to canvas */
8434 h; /**< Anchor geometry, relative to canvas */
8437 * @typedef Elm_Entry_Filter_Cb
8438 * This callback type is used by entry filters to modify text.
8439 * @param data The data specified as the last param when adding the filter
8440 * @param entry The entry object
8441 * @param text A pointer to the location of the text being filtered. This data can be modified,
8442 * but any additional allocations must be managed by the user.
8443 * @see elm_entry_text_filter_append
8444 * @see elm_entry_text_filter_prepend
8446 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8449 * This adds an entry to @p parent object.
8451 * By default, entries are:
8455 * @li autosave is enabled
8457 * @param parent The parent object
8458 * @return The new object or NULL if it cannot be created
8460 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8462 * Sets the entry to single line mode.
8464 * In single line mode, entries don't ever wrap when the text reaches the
8465 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8466 * key will generate an @c "activate" event instead of adding a new line.
8468 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8469 * and pressing enter will break the text into a different line
8470 * without generating any events.
8472 * @param obj The entry object
8473 * @param single_line If true, the text in the entry
8474 * will be on a single line.
8476 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8478 * Gets whether the entry is set to be single line.
8480 * @param obj The entry object
8481 * @return single_line If true, the text in the entry is set to display
8484 * @see elm_entry_single_line_set()
8486 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8488 * Sets the entry to password mode.
8490 * In password mode, entries are implicitly single line and the display of
8491 * any text in them is replaced with asterisks (*).
8493 * @param obj The entry object
8494 * @param password If true, password mode is enabled.
8496 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8498 * Gets whether the entry is set to password mode.
8500 * @param obj The entry object
8501 * @return If true, the entry is set to display all characters
8504 * @see elm_entry_password_set()
8506 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8508 * This sets the text displayed within the entry to @p entry.
8510 * @param obj The entry object
8511 * @param entry The text to be displayed
8513 * @deprecated Use elm_object_text_set() instead.
8515 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8517 * This returns the text currently shown in object @p entry.
8518 * See also elm_entry_entry_set().
8520 * @param obj The entry object
8521 * @return The currently displayed text or NULL on failure
8523 * @deprecated Use elm_object_text_get() instead.
8525 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8527 * Appends @p entry to the text of the entry.
8529 * Adds the text in @p entry to the end of any text already present in the
8532 * The appended text is subject to any filters set for the widget.
8534 * @param obj The entry object
8535 * @param entry The text to be displayed
8537 * @see elm_entry_text_filter_append()
8539 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8541 * Gets whether the entry is empty.
8543 * Empty means no text at all. If there are any markup tags, like an item
8544 * tag for which no provider finds anything, and no text is displayed, this
8545 * function still returns EINA_FALSE.
8547 * @param obj The entry object
8548 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8550 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8552 * Gets any selected text within the entry.
8554 * If there's any selected text in the entry, this function returns it as
8555 * a string in markup format. NULL is returned if no selection exists or
8556 * if an error occurred.
8558 * The returned value points to an internal string and should not be freed
8559 * or modified in any way. If the @p entry object is deleted or its
8560 * contents are changed, the returned pointer should be considered invalid.
8562 * @param obj The entry object
8563 * @return The selected text within the entry or NULL on failure
8565 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8567 * Inserts the given text into the entry at the current cursor position.
8569 * This inserts text at the cursor position as if it was typed
8570 * by the user (note that this also allows markup which a user
8571 * can't just "type" as it would be converted to escaped text, so this
8572 * call can be used to insert things like emoticon items or bold push/pop
8573 * tags, other font and color change tags etc.)
8575 * If any selection exists, it will be replaced by the inserted text.
8577 * The inserted text is subject to any filters set for the widget.
8579 * @param obj The entry object
8580 * @param entry The text to insert
8582 * @see elm_entry_text_filter_append()
8584 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8586 * Set the line wrap type to use on multi-line entries.
8588 * Sets the wrap type used by the entry to any of the specified in
8589 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8590 * line (without inserting a line break or paragraph separator) when it
8591 * reaches the far edge of the widget.
8593 * Note that this only makes sense for multi-line entries. A widget set
8594 * to be single line will never wrap.
8596 * @param obj The entry object
8597 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8599 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8601 * Gets the wrap mode the entry was set to use.
8603 * @param obj The entry object
8606 * @see also elm_entry_line_wrap_set()
8608 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8610 * Sets if the entry is to be editable or not.
8612 * By default, entries are editable and when focused, any text input by the
8613 * user will be inserted at the current cursor position. But calling this
8614 * function with @p editable as EINA_FALSE will prevent the user from
8615 * inputting text into the entry.
8617 * The only way to change the text of a non-editable entry is to use
8618 * elm_object_text_set(), elm_entry_entry_insert() and other related
8621 * @param obj The entry object
8622 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8623 * if not, the entry is read-only and no user input is allowed.
8625 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8627 * Gets whether the entry is editable or not.
8629 * @param obj The entry object
8630 * @return If true, the entry is editable by the user.
8631 * If false, it is not editable by the user
8633 * @see elm_entry_editable_set()
8635 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8637 * This drops any existing text selection within the entry.
8639 * @param obj The entry object
8641 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8643 * This selects all text within the entry.
8645 * @param obj The entry object
8647 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8649 * This moves the cursor one place to the right within the entry.
8651 * @param obj The entry object
8652 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8654 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8656 * This moves the cursor one place to the left within the entry.
8658 * @param obj The entry object
8659 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8661 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8663 * This moves the cursor one line up within the entry.
8665 * @param obj The entry object
8666 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8668 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8670 * This moves the cursor one line down within the entry.
8672 * @param obj The entry object
8673 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8675 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8677 * This moves the cursor to the beginning of the entry.
8679 * @param obj The entry object
8681 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8683 * This moves the cursor to the end of the entry.
8685 * @param obj The entry object
8687 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8689 * This moves the cursor to the beginning of the current line.
8691 * @param obj The entry object
8693 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8695 * This moves the cursor to the end of the current line.
8697 * @param obj The entry object
8699 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8701 * This begins a selection within the entry as though
8702 * the user were holding down the mouse button to make a selection.
8704 * @param obj The entry object
8706 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8708 * This ends a selection within the entry as though
8709 * the user had just released the mouse button while making a selection.
8711 * @param obj The entry object
8713 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8715 * Gets whether a format node exists at the current cursor position.
8717 * A format node is anything that defines how the text is rendered. It can
8718 * be a visible format node, such as a line break or a paragraph separator,
8719 * or an invisible one, such as bold begin or end tag.
8720 * This function returns whether any format node exists at the current
8723 * @param obj The entry object
8724 * @return EINA_TRUE if the current cursor position contains a format node,
8725 * EINA_FALSE otherwise.
8727 * @see elm_entry_cursor_is_visible_format_get()
8729 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8731 * Gets if the current cursor position holds a visible format node.
8733 * @param obj The entry object
8734 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8735 * if it's an invisible one or no format exists.
8737 * @see elm_entry_cursor_is_format_get()
8739 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8741 * Gets the character pointed by the cursor at its current position.
8743 * This function returns a string with the utf8 character stored at the
8744 * current cursor position.
8745 * Only the text is returned, any format that may exist will not be part
8746 * of the return value.
8748 * @param obj The entry object
8749 * @return The text pointed by the cursors.
8751 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8753 * This function returns the geometry of the cursor.
8755 * It's useful if you want to draw something on the cursor (or where it is),
8756 * or for example in the case of scrolled entry where you want to show the
8759 * @param obj The entry object
8760 * @param x returned geometry
8761 * @param y returned geometry
8762 * @param w returned geometry
8763 * @param h returned geometry
8764 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8766 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);
8768 * Sets the cursor position in the entry to the given value
8770 * The value in @p pos is the index of the character position within the
8771 * contents of the string as returned by elm_entry_cursor_pos_get().
8773 * @param obj The entry object
8774 * @param pos The position of the cursor
8776 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8778 * Retrieves the current position of the cursor in the entry
8780 * @param obj The entry object
8781 * @return The cursor position
8783 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8785 * This executes a "cut" action on the selected text in the entry.
8787 * @param obj The entry object
8789 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8791 * This executes a "copy" action on the selected text in the entry.
8793 * @param obj The entry object
8795 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8797 * This executes a "paste" action in the entry.
8799 * @param obj The entry object
8801 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8803 * This clears and frees the items in a entry's contextual (longpress)
8806 * @param obj The entry object
8808 * @see elm_entry_context_menu_item_add()
8810 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8812 * This adds an item to the entry's contextual menu.
8814 * A longpress on an entry will make the contextual menu show up, if this
8815 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8816 * By default, this menu provides a few options like enabling selection mode,
8817 * which is useful on embedded devices that need to be explicit about it,
8818 * and when a selection exists it also shows the copy and cut actions.
8820 * With this function, developers can add other options to this menu to
8821 * perform any action they deem necessary.
8823 * @param obj The entry object
8824 * @param label The item's text label
8825 * @param icon_file The item's icon file
8826 * @param icon_type The item's icon type
8827 * @param func The callback to execute when the item is clicked
8828 * @param data The data to associate with the item for related functions
8830 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);
8832 * This disables the entry's contextual (longpress) menu.
8834 * @param obj The entry object
8835 * @param disabled If true, the menu is disabled
8837 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8839 * This returns whether the entry's contextual (longpress) menu is
8842 * @param obj The entry object
8843 * @return If true, the menu is disabled
8845 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8847 * This appends a custom item provider to the list for that entry
8849 * This appends the given callback. The list is walked from beginning to end
8850 * with each function called given the item href string in the text. If the
8851 * function returns an object handle other than NULL (it should create an
8852 * object to do this), then this object is used to replace that item. If
8853 * not the next provider is called until one provides an item object, or the
8854 * default provider in entry does.
8856 * @param obj The entry object
8857 * @param func The function called to provide the item object
8858 * @param data The data passed to @p func
8860 * @see @ref entry-items
8862 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);
8864 * This prepends a custom item provider to the list for that entry
8866 * This prepends the given callback. See elm_entry_item_provider_append() for
8869 * @param obj The entry object
8870 * @param func The function called to provide the item object
8871 * @param data The data passed to @p func
8873 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);
8875 * This removes a custom item provider to the list for that entry
8877 * This removes the given callback. See elm_entry_item_provider_append() for
8880 * @param obj The entry object
8881 * @param func The function called to provide the item object
8882 * @param data The data passed to @p func
8884 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);
8886 * Append a filter function for text inserted in the entry
8888 * Append the given callback to the list. This functions will be called
8889 * whenever any text is inserted into the entry, with the text to be inserted
8890 * as a parameter. The callback function is free to alter the text in any way
8891 * it wants, but it must remember to free the given pointer and update it.
8892 * If the new text is to be discarded, the function can free it and set its
8893 * text parameter to NULL. This will also prevent any following filters from
8896 * @param obj The entry object
8897 * @param func The function to use as text filter
8898 * @param data User data to pass to @p func
8900 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8902 * Prepend a filter function for text insdrted in the entry
8904 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8905 * for more information
8907 * @param obj The entry object
8908 * @param func The function to use as text filter
8909 * @param data User data to pass to @p func
8911 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8913 * Remove a filter from the list
8915 * Removes the given callback from the filter list. See
8916 * elm_entry_text_filter_append() for more information.
8918 * @param obj The entry object
8919 * @param func The filter function to remove
8920 * @param data The user data passed when adding the function
8922 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8924 * This converts a markup (HTML-like) string into UTF-8.
8926 * The returned string is a malloc'ed buffer and it should be freed when
8927 * not needed anymore.
8929 * @param s The string (in markup) to be converted
8930 * @return The converted string (in UTF-8). It should be freed.
8932 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8934 * This converts a UTF-8 string into markup (HTML-like).
8936 * The returned string is a malloc'ed buffer and it should be freed when
8937 * not needed anymore.
8939 * @param s The string (in UTF-8) to be converted
8940 * @return The converted string (in markup). It should be freed.
8942 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8944 * This sets the file (and implicitly loads it) for the text to display and
8945 * then edit. All changes are written back to the file after a short delay if
8946 * the entry object is set to autosave (which is the default).
8948 * If the entry had any other file set previously, any changes made to it
8949 * will be saved if the autosave feature is enabled, otherwise, the file
8950 * will be silently discarded and any non-saved changes will be lost.
8952 * @param obj The entry object
8953 * @param file The path to the file to load and save
8954 * @param format The file format
8956 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8958 * Gets the file being edited by the entry.
8960 * This function can be used to retrieve any file set on the entry for
8961 * edition, along with the format used to load and save it.
8963 * @param obj The entry object
8964 * @param file The path to the file to load and save
8965 * @param format The file format
8967 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8969 * This function writes any changes made to the file set with
8970 * elm_entry_file_set()
8972 * @param obj The entry object
8974 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8976 * This sets the entry object to 'autosave' the loaded text file or not.
8978 * @param obj The entry object
8979 * @param autosave Autosave the loaded file or not
8981 * @see elm_entry_file_set()
8983 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8985 * This gets the entry object's 'autosave' status.
8987 * @param obj The entry object
8988 * @return Autosave the loaded file or not
8990 * @see elm_entry_file_set()
8992 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8994 * Control pasting of text and images for the widget.
8996 * Normally the entry allows both text and images to be pasted. By setting
8997 * textonly to be true, this prevents images from being pasted.
8999 * Note this only changes the behaviour of text.
9001 * @param obj The entry object
9002 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9005 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9007 * Getting elm_entry text paste/drop mode.
9009 * In textonly mode, only text may be pasted or dropped into the widget.
9011 * @param obj The entry object
9012 * @return If the widget only accepts text from pastes.
9014 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9016 * Enable or disable scrolling in entry
9018 * Normally the entry is not scrollable unless you enable it with this call.
9020 * @param obj The entry object
9021 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9023 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9025 * Get the scrollable state of the entry
9027 * Normally the entry is not scrollable. This gets the scrollable state
9028 * of the entry. See elm_entry_scrollable_set() for more information.
9030 * @param obj The entry object
9031 * @return The scrollable state
9033 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9035 * This sets a widget to be displayed to the left of a scrolled entry.
9037 * @param obj The scrolled entry object
9038 * @param icon The widget to display on the left side of the scrolled
9041 * @note A previously set widget will be destroyed.
9042 * @note If the object being set does not have minimum size hints set,
9043 * it won't get properly displayed.
9045 * @see elm_entry_end_set()
9047 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9049 * Gets the leftmost widget of the scrolled entry. This object is
9050 * owned by the scrolled entry and should not be modified.
9052 * @param obj The scrolled entry object
9053 * @return the left widget inside the scroller
9055 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9057 * Unset the leftmost widget of the scrolled entry, unparenting and
9060 * @param obj The scrolled entry object
9061 * @return the previously set icon sub-object of this entry, on
9064 * @see elm_entry_icon_set()
9066 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9068 * Sets the visibility of the left-side widget of the scrolled entry,
9069 * set by elm_entry_icon_set().
9071 * @param obj The scrolled entry object
9072 * @param setting EINA_TRUE if the object should be displayed,
9073 * EINA_FALSE if not.
9075 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9077 * This sets a widget to be displayed to the end of a scrolled entry.
9079 * @param obj The scrolled entry object
9080 * @param end The widget to display on the right side of the scrolled
9083 * @note A previously set widget will be destroyed.
9084 * @note If the object being set does not have minimum size hints set,
9085 * it won't get properly displayed.
9087 * @see elm_entry_icon_set
9089 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9091 * Gets the endmost widget of the scrolled entry. This object is owned
9092 * by the scrolled entry and should not be modified.
9094 * @param obj The scrolled entry object
9095 * @return the right widget inside the scroller
9097 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9099 * Unset the endmost widget of the scrolled entry, unparenting and
9102 * @param obj The scrolled entry object
9103 * @return the previously set icon sub-object of this entry, on
9106 * @see elm_entry_icon_set()
9108 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9110 * Sets the visibility of the end widget of the scrolled entry, set by
9111 * elm_entry_end_set().
9113 * @param obj The scrolled entry object
9114 * @param setting EINA_TRUE if the object should be displayed,
9115 * EINA_FALSE if not.
9117 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9119 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9122 * Setting an entry to single-line mode with elm_entry_single_line_set()
9123 * will automatically disable the display of scrollbars when the entry
9124 * moves inside its scroller.
9126 * @param obj The scrolled entry object
9127 * @param h The horizontal scrollbar policy to apply
9128 * @param v The vertical scrollbar policy to apply
9130 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9132 * This enables/disables bouncing within the entry.
9134 * This function sets whether the entry will bounce when scrolling reaches
9135 * the end of the contained entry.
9137 * @param obj The scrolled entry object
9138 * @param h The horizontal bounce state
9139 * @param v The vertical bounce state
9141 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9143 * Get the bounce mode
9145 * @param obj The Entry object
9146 * @param h_bounce Allow bounce horizontally
9147 * @param v_bounce Allow bounce vertically
9149 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9151 /* pre-made filters for entries */
9153 * @typedef Elm_Entry_Filter_Limit_Size
9155 * Data for the elm_entry_filter_limit_size() entry filter.
9157 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9159 * @struct _Elm_Entry_Filter_Limit_Size
9161 * Data for the elm_entry_filter_limit_size() entry filter.
9163 struct _Elm_Entry_Filter_Limit_Size
9165 int max_char_count; /**< The maximum number of characters allowed. */
9166 int max_byte_count; /**< The maximum number of bytes allowed*/
9169 * Filter inserted text based on user defined character and byte limits
9171 * Add this filter to an entry to limit the characters that it will accept
9172 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9173 * The funtion works on the UTF-8 representation of the string, converting
9174 * it from the set markup, thus not accounting for any format in it.
9176 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9177 * it as data when setting the filter. In it, it's possible to set limits
9178 * by character count or bytes (any of them is disabled if 0), and both can
9179 * be set at the same time. In that case, it first checks for characters,
9182 * The function will cut the inserted text in order to allow only the first
9183 * number of characters that are still allowed. The cut is made in
9184 * characters, even when limiting by bytes, in order to always contain
9185 * valid ones and avoid half unicode characters making it in.
9187 * This filter, like any others, does not apply when setting the entry text
9188 * directly with elm_object_text_set() (or the deprecated
9189 * elm_entry_entry_set()).
9191 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9193 * @typedef Elm_Entry_Filter_Accept_Set
9195 * Data for the elm_entry_filter_accept_set() entry filter.
9197 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9199 * @struct _Elm_Entry_Filter_Accept_Set
9201 * Data for the elm_entry_filter_accept_set() entry filter.
9203 struct _Elm_Entry_Filter_Accept_Set
9205 const char *accepted; /**< Set of characters accepted in the entry. */
9206 const char *rejected; /**< Set of characters rejected from the entry. */
9209 * Filter inserted text based on accepted or rejected sets of characters
9211 * Add this filter to an entry to restrict the set of accepted characters
9212 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9213 * This structure contains both accepted and rejected sets, but they are
9214 * mutually exclusive.
9216 * The @c accepted set takes preference, so if it is set, the filter will
9217 * only work based on the accepted characters, ignoring anything in the
9218 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9220 * In both cases, the function filters by matching utf8 characters to the
9221 * raw markup text, so it can be used to remove formatting tags.
9223 * This filter, like any others, does not apply when setting the entry text
9224 * directly with elm_object_text_set() (or the deprecated
9225 * elm_entry_entry_set()).
9227 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9232 /* composite widgets - these basically put together basic widgets above
9233 * in convenient packages that do more than basic stuff */
9237 * @defgroup Anchorview Anchorview
9239 * @image html img/widget/anchorview/preview-00.png
9240 * @image latex img/widget/anchorview/preview-00.eps
9242 * Anchorview is for displaying text that contains markup with anchors
9243 * like <c>\<a href=1234\>something\</\></c> in it.
9245 * Besides being styled differently, the anchorview widget provides the
9246 * necessary functionality so that clicking on these anchors brings up a
9247 * popup with user defined content such as "call", "add to contacts" or
9248 * "open web page". This popup is provided using the @ref Hover widget.
9250 * This widget is very similar to @ref Anchorblock, so refer to that
9251 * widget for an example. The only difference Anchorview has is that the
9252 * widget is already provided with scrolling functionality, so if the
9253 * text set to it is too large to fit in the given space, it will scroll,
9254 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9255 * text can be displayed.
9257 * This widget emits the following signals:
9258 * @li "anchor,clicked": will be called when an anchor is clicked. The
9259 * @p event_info parameter on the callback will be a pointer of type
9260 * ::Elm_Entry_Anchorview_Info.
9262 * See @ref Anchorblock for an example on how to use both of them.
9271 * @typedef Elm_Entry_Anchorview_Info
9273 * The info sent in the callback for "anchor,clicked" signals emitted by
9274 * the Anchorview widget.
9276 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9278 * @struct _Elm_Entry_Anchorview_Info
9280 * The info sent in the callback for "anchor,clicked" signals emitted by
9281 * the Anchorview widget.
9283 struct _Elm_Entry_Anchorview_Info
9285 const char *name; /**< Name of the anchor, as indicated in its href
9287 int button; /**< The mouse button used to click on it */
9288 Evas_Object *hover; /**< The hover object to use for the popup */
9290 Evas_Coord x, y, w, h;
9291 } anchor, /**< Geometry selection of text used as anchor */
9292 hover_parent; /**< Geometry of the object used as parent by the
9294 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9295 for content on the left side of
9296 the hover. Before calling the
9297 callback, the widget will make the
9298 necessary calculations to check
9299 which sides are fit to be set with
9300 content, based on the position the
9301 hover is activated and its distance
9302 to the edges of its parent object
9304 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9305 the right side of the hover.
9306 See @ref hover_left */
9307 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9308 of the hover. See @ref hover_left */
9309 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9310 below the hover. See @ref
9314 * Add a new Anchorview object
9316 * @param parent The parent object
9317 * @return The new object or NULL if it cannot be created
9319 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9321 * Set the text to show in the anchorview
9323 * Sets the text of the anchorview to @p text. This text can include markup
9324 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9325 * text that will be specially styled and react to click events, ended with
9326 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9327 * "anchor,clicked" signal that you can attach a callback to with
9328 * evas_object_smart_callback_add(). The name of the anchor given in the
9329 * event info struct will be the one set in the href attribute, in this
9332 * Other markup can be used to style the text in different ways, but it's
9333 * up to the style defined in the theme which tags do what.
9334 * @deprecated use elm_object_text_set() instead.
9336 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9338 * Get the markup text set for the anchorview
9340 * Retrieves the text set on the anchorview, with markup tags included.
9342 * @param obj The anchorview object
9343 * @return The markup text set or @c NULL if nothing was set or an error
9345 * @deprecated use elm_object_text_set() instead.
9347 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9349 * Set the parent of the hover popup
9351 * Sets the parent object to use by the hover created by the anchorview
9352 * when an anchor is clicked. See @ref Hover for more details on this.
9353 * If no parent is set, the same anchorview object will be used.
9355 * @param obj The anchorview object
9356 * @param parent The object to use as parent for the hover
9358 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9360 * Get the parent of the hover popup
9362 * Get the object used as parent for the hover created by the anchorview
9363 * widget. See @ref Hover for more details on this.
9365 * @param obj The anchorview object
9366 * @return The object used as parent for the hover, NULL if none is set.
9368 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9370 * Set the style that the hover should use
9372 * When creating the popup hover, anchorview will request that it's
9373 * themed according to @p style.
9375 * @param obj The anchorview object
9376 * @param style The style to use for the underlying hover
9378 * @see elm_object_style_set()
9380 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9382 * Get the style that the hover should use
9384 * Get the style the hover created by anchorview will use.
9386 * @param obj The anchorview object
9387 * @return The style to use by the hover. NULL means the default is used.
9389 * @see elm_object_style_set()
9391 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9393 * Ends the hover popup in the anchorview
9395 * When an anchor is clicked, the anchorview widget will create a hover
9396 * object to use as a popup with user provided content. This function
9397 * terminates this popup, returning the anchorview to its normal state.
9399 * @param obj The anchorview object
9401 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9403 * Set bouncing behaviour when the scrolled content reaches an edge
9405 * Tell the internal scroller object whether it should bounce or not
9406 * when it reaches the respective edges for each axis.
9408 * @param obj The anchorview object
9409 * @param h_bounce Whether to bounce or not in the horizontal axis
9410 * @param v_bounce Whether to bounce or not in the vertical axis
9412 * @see elm_scroller_bounce_set()
9414 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9416 * Get the set bouncing behaviour of the internal scroller
9418 * Get whether the internal scroller should bounce when the edge of each
9419 * axis is reached scrolling.
9421 * @param obj The anchorview object
9422 * @param h_bounce Pointer where to store the bounce state of the horizontal
9424 * @param v_bounce Pointer where to store the bounce state of the vertical
9427 * @see elm_scroller_bounce_get()
9429 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9431 * Appends a custom item provider to the given anchorview
9433 * Appends the given function to the list of items providers. This list is
9434 * called, one function at a time, with the given @p data pointer, the
9435 * anchorview object and, in the @p item parameter, the item name as
9436 * referenced in its href string. Following functions in the list will be
9437 * called in order until one of them returns something different to NULL,
9438 * which should be an Evas_Object which will be used in place of the item
9441 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9442 * href=item/name\>\</item\>
9444 * @param obj The anchorview object
9445 * @param func The function to add to the list of providers
9446 * @param data User data that will be passed to the callback function
9448 * @see elm_entry_item_provider_append()
9450 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);
9452 * Prepend a custom item provider to the given anchorview
9454 * Like elm_anchorview_item_provider_append(), but it adds the function
9455 * @p func to the beginning of the list, instead of the end.
9457 * @param obj The anchorview object
9458 * @param func The function to add to the list of providers
9459 * @param data User data that will be passed to the callback function
9461 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);
9463 * Remove a custom item provider from the list of the given anchorview
9465 * Removes the function and data pairing that matches @p func and @p data.
9466 * That is, unless the same function and same user data are given, the
9467 * function will not be removed from the list. This allows us to add the
9468 * same callback several times, with different @p data pointers and be
9469 * able to remove them later without conflicts.
9471 * @param obj The anchorview object
9472 * @param func The function to remove from the list
9473 * @param data The data matching the function to remove from the list
9475 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);
9482 * @defgroup Anchorblock Anchorblock
9484 * @image html img/widget/anchorblock/preview-00.png
9485 * @image latex img/widget/anchorblock/preview-00.eps
9487 * Anchorblock is for displaying text that contains markup with anchors
9488 * like <c>\<a href=1234\>something\</\></c> in it.
9490 * Besides being styled differently, the anchorblock widget provides the
9491 * necessary functionality so that clicking on these anchors brings up a
9492 * popup with user defined content such as "call", "add to contacts" or
9493 * "open web page". This popup is provided using the @ref Hover widget.
9495 * This widget emits the following signals:
9496 * @li "anchor,clicked": will be called when an anchor is clicked. The
9497 * @p event_info parameter on the callback will be a pointer of type
9498 * ::Elm_Entry_Anchorblock_Info.
9504 * Since examples are usually better than plain words, we might as well
9505 * try @ref tutorial_anchorblock_example "one".
9508 * @addtogroup Anchorblock
9512 * @typedef Elm_Entry_Anchorblock_Info
9514 * The info sent in the callback for "anchor,clicked" signals emitted by
9515 * the Anchorblock widget.
9517 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9519 * @struct _Elm_Entry_Anchorblock_Info
9521 * The info sent in the callback for "anchor,clicked" signals emitted by
9522 * the Anchorblock widget.
9524 struct _Elm_Entry_Anchorblock_Info
9526 const char *name; /**< Name of the anchor, as indicated in its href
9528 int button; /**< The mouse button used to click on it */
9529 Evas_Object *hover; /**< The hover object to use for the popup */
9531 Evas_Coord x, y, w, h;
9532 } anchor, /**< Geometry selection of text used as anchor */
9533 hover_parent; /**< Geometry of the object used as parent by the
9535 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9536 for content on the left side of
9537 the hover. Before calling the
9538 callback, the widget will make the
9539 necessary calculations to check
9540 which sides are fit to be set with
9541 content, based on the position the
9542 hover is activated and its distance
9543 to the edges of its parent object
9545 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9546 the right side of the hover.
9547 See @ref hover_left */
9548 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9549 of the hover. See @ref hover_left */
9550 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9551 below the hover. See @ref
9555 * Add a new Anchorblock object
9557 * @param parent The parent object
9558 * @return The new object or NULL if it cannot be created
9560 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9562 * Set the text to show in the anchorblock
9564 * Sets the text of the anchorblock to @p text. This text can include markup
9565 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9566 * of text that will be specially styled and react to click events, ended
9567 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9568 * "anchor,clicked" signal that you can attach a callback to with
9569 * evas_object_smart_callback_add(). The name of the anchor given in the
9570 * event info struct will be the one set in the href attribute, in this
9573 * Other markup can be used to style the text in different ways, but it's
9574 * up to the style defined in the theme which tags do what.
9575 * @deprecated use elm_object_text_set() instead.
9577 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9579 * Get the markup text set for the anchorblock
9581 * Retrieves the text set on the anchorblock, with markup tags included.
9583 * @param obj The anchorblock object
9584 * @return The markup text set or @c NULL if nothing was set or an error
9586 * @deprecated use elm_object_text_set() instead.
9588 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9590 * Set the parent of the hover popup
9592 * Sets the parent object to use by the hover created by the anchorblock
9593 * when an anchor is clicked. See @ref Hover for more details on this.
9595 * @param obj The anchorblock object
9596 * @param parent The object to use as parent for the hover
9598 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9600 * Get the parent of the hover popup
9602 * Get the object used as parent for the hover created by the anchorblock
9603 * widget. See @ref Hover for more details on this.
9604 * If no parent is set, the same anchorblock object will be used.
9606 * @param obj The anchorblock object
9607 * @return The object used as parent for the hover, NULL if none is set.
9609 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9611 * Set the style that the hover should use
9613 * When creating the popup hover, anchorblock will request that it's
9614 * themed according to @p style.
9616 * @param obj The anchorblock object
9617 * @param style The style to use for the underlying hover
9619 * @see elm_object_style_set()
9621 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9623 * Get the style that the hover should use
9625 * Get the style the hover created by anchorblock will use.
9627 * @param obj The anchorblock object
9628 * @return The style to use by the hover. NULL means the default is used.
9630 * @see elm_object_style_set()
9632 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9634 * Ends the hover popup in the anchorblock
9636 * When an anchor is clicked, the anchorblock widget will create a hover
9637 * object to use as a popup with user provided content. This function
9638 * terminates this popup, returning the anchorblock to its normal state.
9640 * @param obj The anchorblock object
9642 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9644 * Appends a custom item provider to the given anchorblock
9646 * Appends the given function to the list of items providers. This list is
9647 * called, one function at a time, with the given @p data pointer, the
9648 * anchorblock object and, in the @p item parameter, the item name as
9649 * referenced in its href string. Following functions in the list will be
9650 * called in order until one of them returns something different to NULL,
9651 * which should be an Evas_Object which will be used in place of the item
9654 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9655 * href=item/name\>\</item\>
9657 * @param obj The anchorblock object
9658 * @param func The function to add to the list of providers
9659 * @param data User data that will be passed to the callback function
9661 * @see elm_entry_item_provider_append()
9663 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);
9665 * Prepend a custom item provider to the given anchorblock
9667 * Like elm_anchorblock_item_provider_append(), but it adds the function
9668 * @p func to the beginning of the list, instead of the end.
9670 * @param obj The anchorblock object
9671 * @param func The function to add to the list of providers
9672 * @param data User data that will be passed to the callback function
9674 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);
9676 * Remove a custom item provider from the list of the given anchorblock
9678 * Removes the function and data pairing that matches @p func and @p data.
9679 * That is, unless the same function and same user data are given, the
9680 * function will not be removed from the list. This allows us to add the
9681 * same callback several times, with different @p data pointers and be
9682 * able to remove them later without conflicts.
9684 * @param obj The anchorblock object
9685 * @param func The function to remove from the list
9686 * @param data The data matching the function to remove from the list
9688 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);
9694 * @defgroup Bubble Bubble
9696 * @image html img/widget/bubble/preview-00.png
9697 * @image html img/widget/bubble/preview-01.png
9698 * @image html img/widget/bubble/preview-02.png
9700 * @brief The Bubble is a widget to show text similarly to how speech is
9701 * represented in comics.
9703 * The bubble widget contains 5 important visual elements:
9704 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9705 * @li The @p icon is an image to which the frame's arrow points to.
9706 * @li The @p label is a text which appears to the right of the icon if the
9707 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9709 * @li The @p info is a text which appears to the right of the label. Info's
9710 * font is of a ligther color than label.
9711 * @li The @p content is an evas object that is shown inside the frame.
9713 * The position of the arrow, icon, label and info depends on which corner is
9714 * selected. The four available corners are:
9715 * @li "top_left" - Default
9718 * @li "bottom_right"
9720 * Signals that you can add callbacks for are:
9721 * @li "clicked" - This is called when a user has clicked the bubble.
9723 * For an example of using a buble see @ref bubble_01_example_page "this".
9728 * Add a new bubble to the parent
9730 * @param parent The parent object
9731 * @return The new object or NULL if it cannot be created
9733 * This function adds a text bubble to the given parent evas object.
9735 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9737 * Set the label of the bubble
9739 * @param obj The bubble object
9740 * @param label The string to set in the label
9742 * This function sets the title of the bubble. Where this appears depends on
9743 * the selected corner.
9744 * @deprecated use elm_object_text_set() instead.
9746 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9748 * Get the label of the bubble
9750 * @param obj The bubble object
9751 * @return The string of set in the label
9753 * This function gets the title of the bubble.
9754 * @deprecated use elm_object_text_set() instead.
9756 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9758 * Set the info of the bubble
9760 * @param obj The bubble object
9761 * @param info The given info about the bubble
9763 * This function sets the info of the bubble. Where this appears depends on
9764 * the selected corner.
9765 * @deprecated use elm_object_text_set() instead.
9767 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9769 * Get the info of the bubble
9771 * @param obj The bubble object
9773 * @return The "info" string of the bubble
9775 * This function gets the info text.
9776 * @deprecated use elm_object_text_set() instead.
9778 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9780 * Set the content to be shown in the bubble
9782 * Once the content object is set, a previously set one will be deleted.
9783 * If you want to keep the old content object, use the
9784 * elm_bubble_content_unset() function.
9786 * @param obj The bubble object
9787 * @param content The given content of the bubble
9789 * This function sets the content shown on the middle of the bubble.
9791 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9793 * Get the content shown in the bubble
9795 * Return the content object which is set for this widget.
9797 * @param obj The bubble object
9798 * @return The content that is being used
9800 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9802 * Unset the content shown in the bubble
9804 * Unparent and return the content object which was set for this widget.
9806 * @param obj The bubble object
9807 * @return The content that was being used
9809 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9811 * Set the icon of the bubble
9813 * Once the icon object is set, a previously set one will be deleted.
9814 * If you want to keep the old content object, use the
9815 * elm_icon_content_unset() function.
9817 * @param obj The bubble object
9818 * @param icon The given icon for the bubble
9820 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9822 * Get the icon of the bubble
9824 * @param obj The bubble object
9825 * @return The icon for the bubble
9827 * This function gets the icon shown on the top left of bubble.
9829 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9831 * Unset the icon of the bubble
9833 * Unparent and return the icon object which was set for this widget.
9835 * @param obj The bubble object
9836 * @return The icon that was being used
9838 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9840 * Set the corner of the bubble
9842 * @param obj The bubble object.
9843 * @param corner The given corner for the bubble.
9845 * This function sets the corner of the bubble. The corner will be used to
9846 * determine where the arrow in the frame points to and where label, icon and
9849 * Possible values for corner are:
9850 * @li "top_left" - Default
9853 * @li "bottom_right"
9855 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9857 * Get the corner of the bubble
9859 * @param obj The bubble object.
9860 * @return The given corner for the bubble.
9862 * This function gets the selected corner of the bubble.
9864 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9870 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9871 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9872 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9873 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9874 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9875 /* smart callbacks called:
9876 * "clicked" - the user clicked the icon
9877 * "drag,start" - Someone started dragging the image out of the object
9878 * "drag,end" - Dragged item was dropped (somewhere)
9883 * @defgroup Elm_Gesture_Layer Gesture Layer
9884 * Gesture Layer Usage:
9886 * Use Gesture Layer to detect gestures.
9887 * The advantage is that you don't have to implement
9888 * gesture detection, just set callbacks of gesture state.
9889 * By using gesture layer we make standard interface.
9891 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9892 * with a parent object parameter.
9893 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9894 * call. Usually with same object as target (2nd parameter).
9896 * Now you need to tell gesture layer what gestures you follow.
9897 * This is done with @ref elm_gesture_layer_cb_set call.
9898 * By setting the callback you actually saying to gesture layer:
9899 * I would like to know when the gesture @ref Elm_Gesture_Types
9900 * switches to state @ref Elm_Gesture_State.
9902 * Next, you need to implement the actual action that follows the input
9905 * Note that if you like to stop being reported about a gesture, just set
9906 * all callbacks referring this gesture to NULL.
9907 * (again with @ref elm_gesture_layer_cb_set)
9909 * The information reported by gesture layer to your callback is depending
9910 * on @ref Elm_Gesture_Types:
9911 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9912 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9913 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9915 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9916 * @ref ELM_GESTURE_MOMENTUM.
9918 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9919 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9920 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9921 * Note that we consider a flick as a line-gesture that should be completed
9922 * in flick-time-limit as defined in @ref Config.
9924 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9926 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9930 * @enum _Elm_Gesture_Types
9931 * Enum of supported gesture types.
9932 * @ingroup Elm_Gesture_Layer
9934 enum _Elm_Gesture_Types
9936 ELM_GESTURE_FIRST = 0,
9938 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9939 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9940 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9941 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9943 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9945 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9946 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9948 ELM_GESTURE_ZOOM, /**< Zoom */
9949 ELM_GESTURE_ROTATE, /**< Rotate */
9955 * @typedef Elm_Gesture_Types
9956 * gesture types enum
9957 * @ingroup Elm_Gesture_Layer
9959 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9962 * @enum _Elm_Gesture_State
9963 * Enum of gesture states.
9964 * @ingroup Elm_Gesture_Layer
9966 enum _Elm_Gesture_State
9968 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9969 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9970 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9971 ELM_GESTURE_STATE_END, /**< Gesture completed */
9972 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9976 * @typedef Elm_Gesture_State
9977 * gesture states enum
9978 * @ingroup Elm_Gesture_Layer
9980 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9983 * @struct _Elm_Gesture_Taps_Info
9984 * Struct holds taps info for user
9985 * @ingroup Elm_Gesture_Layer
9987 struct _Elm_Gesture_Taps_Info
9989 Evas_Coord x, y; /**< Holds center point between fingers */
9990 unsigned int n; /**< Number of fingers tapped */
9991 unsigned int timestamp; /**< event timestamp */
9995 * @typedef Elm_Gesture_Taps_Info
9996 * holds taps info for user
9997 * @ingroup Elm_Gesture_Layer
9999 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10002 * @struct _Elm_Gesture_Momentum_Info
10003 * Struct holds momentum info for user
10004 * x1 and y1 are not necessarily in sync
10005 * x1 holds x value of x direction starting point
10006 * and same holds for y1.
10007 * This is noticeable when doing V-shape movement
10008 * @ingroup Elm_Gesture_Layer
10010 struct _Elm_Gesture_Momentum_Info
10011 { /* Report line ends, timestamps, and momentum computed */
10012 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10013 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10014 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10015 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10017 unsigned int tx; /**< Timestamp of start of final x-swipe */
10018 unsigned int ty; /**< Timestamp of start of final y-swipe */
10020 Evas_Coord mx; /**< Momentum on X */
10021 Evas_Coord my; /**< Momentum on Y */
10025 * @typedef Elm_Gesture_Momentum_Info
10026 * holds momentum info for user
10027 * @ingroup Elm_Gesture_Layer
10029 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10032 * @struct _Elm_Gesture_Line_Info
10033 * Struct holds line info for user
10034 * @ingroup Elm_Gesture_Layer
10036 struct _Elm_Gesture_Line_Info
10037 { /* Report line ends, timestamps, and momentum computed */
10038 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10039 unsigned int n; /**< Number of fingers (lines) */
10040 /* FIXME should be radians, bot degrees */
10041 double angle; /**< Angle (direction) of lines */
10045 * @typedef Elm_Gesture_Line_Info
10046 * Holds line info for user
10047 * @ingroup Elm_Gesture_Layer
10049 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10052 * @struct _Elm_Gesture_Zoom_Info
10053 * Struct holds zoom info for user
10054 * @ingroup Elm_Gesture_Layer
10056 struct _Elm_Gesture_Zoom_Info
10058 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10059 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10060 double zoom; /**< Zoom value: 1.0 means no zoom */
10061 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10065 * @typedef Elm_Gesture_Zoom_Info
10066 * Holds zoom info for user
10067 * @ingroup Elm_Gesture_Layer
10069 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10072 * @struct _Elm_Gesture_Rotate_Info
10073 * Struct holds rotation info for user
10074 * @ingroup Elm_Gesture_Layer
10076 struct _Elm_Gesture_Rotate_Info
10078 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10079 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10080 double base_angle; /**< Holds start-angle */
10081 double angle; /**< Rotation value: 0.0 means no rotation */
10082 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10086 * @typedef Elm_Gesture_Rotate_Info
10087 * Holds rotation info for user
10088 * @ingroup Elm_Gesture_Layer
10090 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10093 * @typedef Elm_Gesture_Event_Cb
10094 * User callback used to stream gesture info from gesture layer
10095 * @param data user data
10096 * @param event_info gesture report info
10097 * Returns a flag field to be applied on the causing event.
10098 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10099 * upon the event, in an irreversible way.
10101 * @ingroup Elm_Gesture_Layer
10103 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10106 * Use function to set callbacks to be notified about
10107 * change of state of gesture.
10108 * When a user registers a callback with this function
10109 * this means this gesture has to be tested.
10111 * When ALL callbacks for a gesture are set to NULL
10112 * it means user isn't interested in gesture-state
10113 * and it will not be tested.
10115 * @param obj Pointer to gesture-layer.
10116 * @param idx The gesture you would like to track its state.
10117 * @param cb callback function pointer.
10118 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10119 * @param data user info to be sent to callback (usually, Smart Data)
10121 * @ingroup Elm_Gesture_Layer
10123 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);
10126 * Call this function to get repeat-events settings.
10128 * @param obj Pointer to gesture-layer.
10130 * @return repeat events settings.
10131 * @see elm_gesture_layer_hold_events_set()
10132 * @ingroup Elm_Gesture_Layer
10134 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10137 * This function called in order to make gesture-layer repeat events.
10138 * Set this of you like to get the raw events only if gestures were not detected.
10139 * Clear this if you like gesture layer to fwd events as testing gestures.
10141 * @param obj Pointer to gesture-layer.
10142 * @param r Repeat: TRUE/FALSE
10144 * @ingroup Elm_Gesture_Layer
10146 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10149 * This function sets step-value for zoom action.
10150 * Set step to any positive value.
10151 * Cancel step setting by setting to 0.0
10153 * @param obj Pointer to gesture-layer.
10154 * @param s new zoom step value.
10156 * @ingroup Elm_Gesture_Layer
10158 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10161 * This function sets step-value for rotate action.
10162 * Set step to any positive value.
10163 * Cancel step setting by setting to 0.0
10165 * @param obj Pointer to gesture-layer.
10166 * @param s new roatate step value.
10168 * @ingroup Elm_Gesture_Layer
10170 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10173 * This function called to attach gesture-layer to an Evas_Object.
10174 * @param obj Pointer to gesture-layer.
10175 * @param t Pointer to underlying object (AKA Target)
10177 * @return TRUE, FALSE on success, failure.
10179 * @ingroup Elm_Gesture_Layer
10181 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10184 * Call this function to construct a new gesture-layer object.
10185 * This does not activate the gesture layer. You have to
10186 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10188 * @param parent the parent object.
10190 * @return Pointer to new gesture-layer object.
10192 * @ingroup Elm_Gesture_Layer
10194 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10197 * @defgroup Thumb Thumb
10199 * @image html img/widget/thumb/preview-00.png
10200 * @image latex img/widget/thumb/preview-00.eps
10202 * A thumb object is used for displaying the thumbnail of an image or video.
10203 * You must have compiled Elementary with Ethumb_Client support and the DBus
10204 * service must be present and auto-activated in order to have thumbnails to
10207 * Once the thumbnail object becomes visible, it will check if there is a
10208 * previously generated thumbnail image for the file set on it. If not, it
10209 * will start generating this thumbnail.
10211 * Different config settings will cause different thumbnails to be generated
10212 * even on the same file.
10214 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10215 * Ethumb documentation to change this path, and to see other configuration
10218 * Signals that you can add callbacks for are:
10220 * - "clicked" - This is called when a user has clicked the thumb without dragging
10222 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10223 * - "press" - This is called when a user has pressed down the thumb.
10224 * - "generate,start" - The thumbnail generation started.
10225 * - "generate,stop" - The generation process stopped.
10226 * - "generate,error" - The generation failed.
10227 * - "load,error" - The thumbnail image loading failed.
10229 * available styles:
10233 * An example of use of thumbnail:
10235 * - @ref thumb_example_01
10239 * @addtogroup Thumb
10244 * @enum _Elm_Thumb_Animation_Setting
10245 * @typedef Elm_Thumb_Animation_Setting
10247 * Used to set if a video thumbnail is animating or not.
10251 typedef enum _Elm_Thumb_Animation_Setting
10253 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10254 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10255 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10256 ELM_THUMB_ANIMATION_LAST
10257 } Elm_Thumb_Animation_Setting;
10260 * Add a new thumb object to the parent.
10262 * @param parent The parent object.
10263 * @return The new object or NULL if it cannot be created.
10265 * @see elm_thumb_file_set()
10266 * @see elm_thumb_ethumb_client_get()
10270 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10272 * Reload thumbnail if it was generated before.
10274 * @param obj The thumb object to reload
10276 * This is useful if the ethumb client configuration changed, like its
10277 * size, aspect or any other property one set in the handle returned
10278 * by elm_thumb_ethumb_client_get().
10280 * If the options didn't change, the thumbnail won't be generated again, but
10281 * the old one will still be used.
10283 * @see elm_thumb_file_set()
10287 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10289 * Set the file that will be used as thumbnail.
10291 * @param obj The thumb object.
10292 * @param file The path to file that will be used as thumb.
10293 * @param key The key used in case of an EET file.
10295 * The file can be an image or a video (in that case, acceptable extensions are:
10296 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10297 * function elm_thumb_animate().
10299 * @see elm_thumb_file_get()
10300 * @see elm_thumb_reload()
10301 * @see elm_thumb_animate()
10305 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10307 * Get the image or video path and key used to generate the thumbnail.
10309 * @param obj The thumb object.
10310 * @param file Pointer to filename.
10311 * @param key Pointer to key.
10313 * @see elm_thumb_file_set()
10314 * @see elm_thumb_path_get()
10318 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10320 * Get the path and key to the image or video generated by ethumb.
10322 * One just need to make sure that the thumbnail was generated before getting
10323 * its path; otherwise, the path will be NULL. One way to do that is by asking
10324 * for the path when/after the "generate,stop" smart callback is called.
10326 * @param obj The thumb object.
10327 * @param file Pointer to thumb path.
10328 * @param key Pointer to thumb key.
10330 * @see elm_thumb_file_get()
10334 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10336 * Set the animation state for the thumb object. If its content is an animated
10337 * video, you may start/stop the animation or tell it to play continuously and
10340 * @param obj The thumb object.
10341 * @param setting The animation setting.
10343 * @see elm_thumb_file_set()
10347 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10349 * Get the animation state for the thumb object.
10351 * @param obj The thumb object.
10352 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10355 * @see elm_thumb_animate_set()
10359 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10361 * Get the ethumb_client handle so custom configuration can be made.
10363 * @return Ethumb_Client instance or NULL.
10365 * This must be called before the objects are created to be sure no object is
10366 * visible and no generation started.
10368 * Example of usage:
10371 * #include <Elementary.h>
10372 * #ifndef ELM_LIB_QUICKLAUNCH
10374 * elm_main(int argc, char **argv)
10376 * Ethumb_Client *client;
10378 * elm_need_ethumb();
10382 * client = elm_thumb_ethumb_client_get();
10385 * ERR("could not get ethumb_client");
10388 * ethumb_client_size_set(client, 100, 100);
10389 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10392 * // Create elm_thumb objects here
10402 * @note There's only one client handle for Ethumb, so once a configuration
10403 * change is done to it, any other request for thumbnails (for any thumbnail
10404 * object) will use that configuration. Thus, this configuration is global.
10408 EAPI void *elm_thumb_ethumb_client_get(void);
10410 * Get the ethumb_client connection state.
10412 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10415 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10417 * Make the thumbnail 'editable'.
10419 * @param obj Thumb object.
10420 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10422 * This means the thumbnail is a valid drag target for drag and drop, and can be
10423 * cut or pasted too.
10425 * @see elm_thumb_editable_get()
10429 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10431 * Make the thumbnail 'editable'.
10433 * @param obj Thumb object.
10434 * @return Editability.
10436 * This means the thumbnail is a valid drag target for drag and drop, and can be
10437 * cut or pasted too.
10439 * @see elm_thumb_editable_set()
10443 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10450 * @defgroup Hoversel Hoversel
10452 * @image html img/widget/hoversel/preview-00.png
10453 * @image latex img/widget/hoversel/preview-00.eps
10455 * A hoversel is a button that pops up a list of items (automatically
10456 * choosing the direction to display) that have a label and, optionally, an
10457 * icon to select from. It is a convenience widget to avoid the need to do
10458 * all the piecing together yourself. It is intended for a small number of
10459 * items in the hoversel menu (no more than 8), though is capable of many
10462 * Signals that you can add callbacks for are:
10463 * "clicked" - the user clicked the hoversel button and popped up the sel
10464 * "selected" - an item in the hoversel list is selected. event_info is the item
10465 * "dismissed" - the hover is dismissed
10467 * See @ref tutorial_hoversel for an example.
10470 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10472 * @brief Add a new Hoversel object
10474 * @param parent The parent object
10475 * @return The new object or NULL if it cannot be created
10477 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10479 * @brief This sets the hoversel to expand horizontally.
10481 * @param obj The hoversel object
10482 * @param horizontal If true, the hover will expand horizontally to the
10485 * @note The initial button will display horizontally regardless of this
10488 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10490 * @brief This returns whether the hoversel is set to expand horizontally.
10492 * @param obj The hoversel object
10493 * @return If true, the hover will expand horizontally to the right.
10495 * @see elm_hoversel_horizontal_set()
10497 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10499 * @brief Set the Hover parent
10501 * @param obj The hoversel object
10502 * @param parent The parent to use
10504 * Sets the hover parent object, the area that will be darkened when the
10505 * hoversel is clicked. Should probably be the window that the hoversel is
10506 * in. See @ref Hover objects for more information.
10508 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10510 * @brief Get the Hover parent
10512 * @param obj The hoversel object
10513 * @return The used parent
10515 * Gets the hover parent object.
10517 * @see elm_hoversel_hover_parent_set()
10519 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10521 * @brief Set the hoversel button label
10523 * @param obj The hoversel object
10524 * @param label The label text.
10526 * This sets the label of the button that is always visible (before it is
10527 * clicked and expanded).
10529 * @deprecated elm_object_text_set()
10531 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10533 * @brief Get the hoversel button label
10535 * @param obj The hoversel object
10536 * @return The label text.
10538 * @deprecated elm_object_text_get()
10540 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10542 * @brief Set the icon of the hoversel button
10544 * @param obj The hoversel object
10545 * @param icon The icon object
10547 * Sets the icon of the button that is always visible (before it is clicked
10548 * and expanded). Once the icon object is set, a previously set one will be
10549 * deleted, if you want to keep that old content object, use the
10550 * elm_hoversel_icon_unset() function.
10552 * @see elm_button_icon_set()
10554 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10556 * @brief Get the icon of the hoversel button
10558 * @param obj The hoversel object
10559 * @return The icon object
10561 * Get the icon of the button that is always visible (before it is clicked
10562 * and expanded). Also see elm_button_icon_get().
10564 * @see elm_hoversel_icon_set()
10566 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10568 * @brief Get and unparent the icon of the hoversel button
10570 * @param obj The hoversel object
10571 * @return The icon object that was being used
10573 * Unparent and return the icon of the button that is always visible
10574 * (before it is clicked and expanded).
10576 * @see elm_hoversel_icon_set()
10577 * @see elm_button_icon_unset()
10579 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10581 * @brief This triggers the hoversel popup from code, the same as if the user
10582 * had clicked the button.
10584 * @param obj The hoversel object
10586 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10588 * @brief This dismisses the hoversel popup as if the user had clicked
10589 * outside the hover.
10591 * @param obj The hoversel object
10593 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10595 * @brief Returns whether the hoversel is expanded.
10597 * @param obj The hoversel object
10598 * @return This will return EINA_TRUE if the hoversel is expanded or
10599 * EINA_FALSE if it is not expanded.
10601 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10603 * @brief This will remove all the children items from the hoversel.
10605 * @param obj The hoversel object
10607 * @warning Should @b not be called while the hoversel is active; use
10608 * elm_hoversel_expanded_get() to check first.
10610 * @see elm_hoversel_item_del_cb_set()
10611 * @see elm_hoversel_item_del()
10613 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10615 * @brief Get the list of items within the given hoversel.
10617 * @param obj The hoversel object
10618 * @return Returns a list of Elm_Hoversel_Item*
10620 * @see elm_hoversel_item_add()
10622 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10624 * @brief Add an item to the hoversel button
10626 * @param obj The hoversel object
10627 * @param label The text label to use for the item (NULL if not desired)
10628 * @param icon_file An image file path on disk to use for the icon or standard
10629 * icon name (NULL if not desired)
10630 * @param icon_type The icon type if relevant
10631 * @param func Convenience function to call when this item is selected
10632 * @param data Data to pass to item-related functions
10633 * @return A handle to the item added.
10635 * This adds an item to the hoversel to show when it is clicked. Note: if you
10636 * need to use an icon from an edje file then use
10637 * elm_hoversel_item_icon_set() right after the this function, and set
10638 * icon_file to NULL here.
10640 * For more information on what @p icon_file and @p icon_type are see the
10641 * @ref Icon "icon documentation".
10643 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);
10645 * @brief Delete an item from the hoversel
10647 * @param item The item to delete
10649 * This deletes the item from the hoversel (should not be called while the
10650 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10652 * @see elm_hoversel_item_add()
10653 * @see elm_hoversel_item_del_cb_set()
10655 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10657 * @brief Set the function to be called when an item from the hoversel is
10660 * @param item The item to set the callback on
10661 * @param func The function called
10663 * That function will receive these parameters:
10664 * @li void *item_data
10665 * @li Evas_Object *the_item_object
10666 * @li Elm_Hoversel_Item *the_object_struct
10668 * @see elm_hoversel_item_add()
10670 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10672 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10673 * that will be passed to associated function callbacks.
10675 * @param item The item to get the data from
10676 * @return The data pointer set with elm_hoversel_item_add()
10678 * @see elm_hoversel_item_add()
10680 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10682 * @brief This returns the label text of the given hoversel item.
10684 * @param item The item to get the label
10685 * @return The label text of the hoversel item
10687 * @see elm_hoversel_item_add()
10689 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10691 * @brief This sets the icon for the given hoversel item.
10693 * @param item The item to set the icon
10694 * @param icon_file An image file path on disk to use for the icon or standard
10696 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10697 * to NULL if the icon is not an edje file
10698 * @param icon_type The icon type
10700 * The icon can be loaded from the standard set, from an image file, or from
10703 * @see elm_hoversel_item_add()
10705 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);
10707 * @brief Get the icon object of the hoversel item
10709 * @param item The item to get the icon from
10710 * @param icon_file The image file path on disk used for the icon or standard
10712 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10713 * if the icon is not an edje file
10714 * @param icon_type The icon type
10716 * @see elm_hoversel_item_icon_set()
10717 * @see elm_hoversel_item_add()
10719 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);
10725 * @defgroup Toolbar Toolbar
10726 * @ingroup Elementary
10728 * @image html img/widget/toolbar/preview-00.png
10729 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10731 * @image html img/toolbar.png
10732 * @image latex img/toolbar.eps width=\textwidth
10734 * A toolbar is a widget that displays a list of items inside
10735 * a box. It can be scrollable, show a menu with items that don't fit
10736 * to toolbar size or even crop them.
10738 * Only one item can be selected at a time.
10740 * Items can have multiple states, or show menus when selected by the user.
10742 * Smart callbacks one can listen to:
10743 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10745 * Available styles for it:
10747 * - @c "transparent" - no background or shadow, just show the content
10749 * List of examples:
10750 * @li @ref toolbar_example_01
10751 * @li @ref toolbar_example_02
10752 * @li @ref toolbar_example_03
10756 * @addtogroup Toolbar
10761 * @enum _Elm_Toolbar_Shrink_Mode
10762 * @typedef Elm_Toolbar_Shrink_Mode
10764 * Set toolbar's items display behavior, it can be scrollabel,
10765 * show a menu with exceeding items, or simply hide them.
10767 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10770 * Values <b> don't </b> work as bitmask, only one can be choosen.
10772 * @see elm_toolbar_mode_shrink_set()
10773 * @see elm_toolbar_mode_shrink_get()
10777 typedef enum _Elm_Toolbar_Shrink_Mode
10779 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10780 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10781 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10782 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10783 } Elm_Toolbar_Shrink_Mode;
10785 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(). */
10787 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(). */
10790 * Add a new toolbar widget to the given parent Elementary
10791 * (container) object.
10793 * @param parent The parent object.
10794 * @return a new toolbar widget handle or @c NULL, on errors.
10796 * This function inserts a new toolbar widget on the canvas.
10800 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10803 * Set the icon size, in pixels, to be used by toolbar items.
10805 * @param obj The toolbar object
10806 * @param icon_size The icon size in pixels
10808 * @note Default value is @c 32. It reads value from elm config.
10810 * @see elm_toolbar_icon_size_get()
10814 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10817 * Get the icon size, in pixels, to be used by toolbar items.
10819 * @param obj The toolbar object.
10820 * @return The icon size in pixels.
10822 * @see elm_toolbar_icon_size_set() for details.
10826 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10829 * Sets icon lookup order, for toolbar items' icons.
10831 * @param obj The toolbar object.
10832 * @param order The icon lookup order.
10834 * Icons added before calling this function will not be affected.
10835 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10837 * @see elm_toolbar_icon_order_lookup_get()
10841 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10844 * Gets the icon lookup order.
10846 * @param obj The toolbar object.
10847 * @return The icon lookup order.
10849 * @see elm_toolbar_icon_order_lookup_set() for details.
10853 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10856 * Set whether the toolbar items' should be selected by the user or not.
10858 * @param obj The toolbar object.
10859 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10862 * This will turn off the ability to select items entirely and they will
10863 * neither appear selected nor emit selected signals. The clicked
10864 * callback function will still be called.
10866 * Selection is enabled by default.
10868 * @see elm_toolbar_no_select_mode_get().
10872 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10875 * Set whether the toolbar items' should be selected by the user or not.
10877 * @param obj The toolbar object.
10878 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10879 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10881 * @see elm_toolbar_no_select_mode_set() for details.
10885 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10888 * Append item to the toolbar.
10890 * @param obj The toolbar object.
10891 * @param icon A string with icon name or the absolute path of an image file.
10892 * @param label The label of the item.
10893 * @param func The function to call when the item is clicked.
10894 * @param data The data to associate with the item for related callbacks.
10895 * @return The created item or @c NULL upon failure.
10897 * A new item will be created and appended to the toolbar, i.e., will
10898 * be set as @b last item.
10900 * Items created with this method can be deleted with
10901 * elm_toolbar_item_del().
10903 * Associated @p data can be properly freed when item is deleted if a
10904 * callback function is set with elm_toolbar_item_del_cb_set().
10906 * If a function is passed as argument, it will be called everytime this item
10907 * is selected, i.e., the user clicks over an unselected item.
10908 * If such function isn't needed, just passing
10909 * @c NULL as @p func is enough. The same should be done for @p data.
10911 * Toolbar will load icon image from fdo or current theme.
10912 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10913 * If an absolute path is provided it will load it direct from a file.
10915 * @see elm_toolbar_item_icon_set()
10916 * @see elm_toolbar_item_del()
10917 * @see elm_toolbar_item_del_cb_set()
10921 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);
10924 * Prepend item to the toolbar.
10926 * @param obj The toolbar object.
10927 * @param icon A string with icon name or the absolute path of an image file.
10928 * @param label The label of the item.
10929 * @param func The function to call when the item is clicked.
10930 * @param data The data to associate with the item for related callbacks.
10931 * @return The created item or @c NULL upon failure.
10933 * A new item will be created and prepended to the toolbar, i.e., will
10934 * be set as @b first item.
10936 * Items created with this method can be deleted with
10937 * elm_toolbar_item_del().
10939 * Associated @p data can be properly freed when item is deleted if a
10940 * callback function is set with elm_toolbar_item_del_cb_set().
10942 * If a function is passed as argument, it will be called everytime this item
10943 * is selected, i.e., the user clicks over an unselected item.
10944 * If such function isn't needed, just passing
10945 * @c NULL as @p func is enough. The same should be done for @p data.
10947 * Toolbar will load icon image from fdo or current theme.
10948 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10949 * If an absolute path is provided it will load it direct from a file.
10951 * @see elm_toolbar_item_icon_set()
10952 * @see elm_toolbar_item_del()
10953 * @see elm_toolbar_item_del_cb_set()
10957 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);
10960 * Insert a new item into the toolbar object before item @p before.
10962 * @param obj The toolbar object.
10963 * @param before The toolbar item to insert before.
10964 * @param icon A string with icon name or the absolute path of an image file.
10965 * @param label The label of the item.
10966 * @param func The function to call when the item is clicked.
10967 * @param data The data to associate with the item for related callbacks.
10968 * @return The created item or @c NULL upon failure.
10970 * A new item will be created and added to the toolbar. Its position in
10971 * this toolbar will be just before item @p before.
10973 * Items created with this method can be deleted with
10974 * elm_toolbar_item_del().
10976 * Associated @p data can be properly freed when item is deleted if a
10977 * callback function is set with elm_toolbar_item_del_cb_set().
10979 * If a function is passed as argument, it will be called everytime this item
10980 * is selected, i.e., the user clicks over an unselected item.
10981 * If such function isn't needed, just passing
10982 * @c NULL as @p func is enough. The same should be done for @p data.
10984 * Toolbar will load icon image from fdo or current theme.
10985 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10986 * If an absolute path is provided it will load it direct from a file.
10988 * @see elm_toolbar_item_icon_set()
10989 * @see elm_toolbar_item_del()
10990 * @see elm_toolbar_item_del_cb_set()
10994 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);
10997 * Insert a new item into the toolbar object after item @p after.
10999 * @param obj The toolbar object.
11000 * @param before The toolbar item to insert before.
11001 * @param icon A string with icon name or the absolute path of an image file.
11002 * @param label The label of the item.
11003 * @param func The function to call when the item is clicked.
11004 * @param data The data to associate with the item for related callbacks.
11005 * @return The created item or @c NULL upon failure.
11007 * A new item will be created and added to the toolbar. Its position in
11008 * this toolbar will be just after item @p after.
11010 * Items created with this method can be deleted with
11011 * elm_toolbar_item_del().
11013 * Associated @p data can be properly freed when item is deleted if a
11014 * callback function is set with elm_toolbar_item_del_cb_set().
11016 * If a function is passed as argument, it will be called everytime this item
11017 * is selected, i.e., the user clicks over an unselected item.
11018 * If such function isn't needed, just passing
11019 * @c NULL as @p func is enough. The same should be done for @p data.
11021 * Toolbar will load icon image from fdo or current theme.
11022 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11023 * If an absolute path is provided it will load it direct from a file.
11025 * @see elm_toolbar_item_icon_set()
11026 * @see elm_toolbar_item_del()
11027 * @see elm_toolbar_item_del_cb_set()
11031 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);
11034 * Get the first item in the given toolbar widget's list of
11037 * @param obj The toolbar object
11038 * @return The first item or @c NULL, if it has no items (and on
11041 * @see elm_toolbar_item_append()
11042 * @see elm_toolbar_last_item_get()
11046 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11049 * Get the last item in the given toolbar widget's list of
11052 * @param obj The toolbar object
11053 * @return The last item or @c NULL, if it has no items (and on
11056 * @see elm_toolbar_item_prepend()
11057 * @see elm_toolbar_first_item_get()
11061 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11064 * Get the item after @p item in toolbar.
11066 * @param item The toolbar item.
11067 * @return The item after @p item, or @c NULL if none or on failure.
11069 * @note If it is the last item, @c NULL will be returned.
11071 * @see elm_toolbar_item_append()
11075 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11078 * Get the item before @p item in toolbar.
11080 * @param item The toolbar item.
11081 * @return The item before @p item, or @c NULL if none or on failure.
11083 * @note If it is the first item, @c NULL will be returned.
11085 * @see elm_toolbar_item_prepend()
11089 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11092 * Get the toolbar object from an item.
11094 * @param item The item.
11095 * @return The toolbar object.
11097 * This returns the toolbar object itself that an item belongs to.
11101 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11104 * Set the priority of a toolbar item.
11106 * @param item The toolbar item.
11107 * @param priority The item priority. The default is zero.
11109 * This is used only when the toolbar shrink mode is set to
11110 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11111 * When space is less than required, items with low priority
11112 * will be removed from the toolbar and added to a dynamically-created menu,
11113 * while items with higher priority will remain on the toolbar,
11114 * with the same order they were added.
11116 * @see elm_toolbar_item_priority_get()
11120 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11123 * Get the priority of a toolbar item.
11125 * @param item The toolbar item.
11126 * @return The @p item priority, or @c 0 on failure.
11128 * @see elm_toolbar_item_priority_set() for details.
11132 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11135 * Get the label of item.
11137 * @param item The item of toolbar.
11138 * @return The label of item.
11140 * The return value is a pointer to the label associated to @p item when
11141 * it was created, with function elm_toolbar_item_append() or similar,
11143 * with function elm_toolbar_item_label_set. If no label
11144 * was passed as argument, it will return @c NULL.
11146 * @see elm_toolbar_item_label_set() for more details.
11147 * @see elm_toolbar_item_append()
11151 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11154 * Set the label of item.
11156 * @param item The item of toolbar.
11157 * @param text The label of item.
11159 * The label to be displayed by the item.
11160 * Label will be placed at icons bottom (if set).
11162 * If a label was passed as argument on item creation, with function
11163 * elm_toolbar_item_append() or similar, it will be already
11164 * displayed by the item.
11166 * @see elm_toolbar_item_label_get()
11167 * @see elm_toolbar_item_append()
11171 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11174 * Return the data associated with a given toolbar widget item.
11176 * @param item The toolbar widget item handle.
11177 * @return The data associated with @p item.
11179 * @see elm_toolbar_item_data_set()
11183 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11186 * Set the data associated with a given toolbar widget item.
11188 * @param item The toolbar widget item handle.
11189 * @param data The new data pointer to set to @p item.
11191 * This sets new item data on @p item.
11193 * @warning The old data pointer won't be touched by this function, so
11194 * the user had better to free that old data himself/herself.
11198 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11201 * Returns a pointer to a toolbar item by its label.
11203 * @param obj The toolbar object.
11204 * @param label The label of the item to find.
11206 * @return The pointer to the toolbar item matching @p label or @c NULL
11211 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11214 * Get whether the @p item is selected or not.
11216 * @param item The toolbar item.
11217 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11218 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11220 * @see elm_toolbar_selected_item_set() for details.
11221 * @see elm_toolbar_item_selected_get()
11225 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11228 * Set the selected state of an item.
11230 * @param item The toolbar item
11231 * @param selected The selected state
11233 * This sets the selected state of the given item @p it.
11234 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11236 * If a new item is selected the previosly selected will be unselected.
11237 * Previoulsy selected item can be get with function
11238 * elm_toolbar_selected_item_get().
11240 * Selected items will be highlighted.
11242 * @see elm_toolbar_item_selected_get()
11243 * @see elm_toolbar_selected_item_get()
11247 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11250 * Get the selected item.
11252 * @param obj The toolbar object.
11253 * @return The selected toolbar item.
11255 * The selected item can be unselected with function
11256 * elm_toolbar_item_selected_set().
11258 * The selected item always will be highlighted on toolbar.
11260 * @see elm_toolbar_selected_items_get()
11264 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11267 * Set the icon associated with @p item.
11269 * @param obj The parent of this item.
11270 * @param item The toolbar item.
11271 * @param icon A string with icon name or the absolute path of an image file.
11273 * Toolbar will load icon image from fdo or current theme.
11274 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11275 * If an absolute path is provided it will load it direct from a file.
11277 * @see elm_toolbar_icon_order_lookup_set()
11278 * @see elm_toolbar_icon_order_lookup_get()
11282 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11285 * Get the string used to set the icon of @p item.
11287 * @param item The toolbar item.
11288 * @return The string associated with the icon object.
11290 * @see elm_toolbar_item_icon_set() for details.
11294 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11297 * Delete them item from the toolbar.
11299 * @param item The item of toolbar to be deleted.
11301 * @see elm_toolbar_item_append()
11302 * @see elm_toolbar_item_del_cb_set()
11306 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11309 * Set the function called when a toolbar item is freed.
11311 * @param item The item to set the callback on.
11312 * @param func The function called.
11314 * If there is a @p func, then it will be called prior item's memory release.
11315 * That will be called with the following arguments:
11317 * @li item's Evas object;
11320 * This way, a data associated to a toolbar item could be properly freed.
11324 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11327 * Get a value whether toolbar item is disabled or not.
11329 * @param item The item.
11330 * @return The disabled state.
11332 * @see elm_toolbar_item_disabled_set() for more details.
11336 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11339 * Sets the disabled/enabled state of a toolbar item.
11341 * @param item The item.
11342 * @param disabled The disabled state.
11344 * A disabled item cannot be selected or unselected. It will also
11345 * change its appearance (generally greyed out). This sets the
11346 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11351 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11354 * Set or unset item as a separator.
11356 * @param item The toolbar item.
11357 * @param setting @c EINA_TRUE to set item @p item as separator or
11358 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11360 * Items aren't set as separator by default.
11362 * If set as separator it will display separator theme, so won't display
11365 * @see elm_toolbar_item_separator_get()
11369 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11372 * Get a value whether item is a separator or not.
11374 * @param item The toolbar item.
11375 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11376 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11378 * @see elm_toolbar_item_separator_set() for details.
11382 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11385 * Set the shrink state of toolbar @p obj.
11387 * @param obj The toolbar object.
11388 * @param shrink_mode Toolbar's items display behavior.
11390 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11391 * but will enforce a minimun size so all the items will fit, won't scroll
11392 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11393 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11394 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11398 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11401 * Get the shrink mode of toolbar @p obj.
11403 * @param obj The toolbar object.
11404 * @return Toolbar's items display behavior.
11406 * @see elm_toolbar_mode_shrink_set() for details.
11410 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11413 * Enable/disable homogenous mode.
11415 * @param obj The toolbar object
11416 * @param homogeneous Assume the items within the toolbar are of the
11417 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11419 * This will enable the homogeneous mode where items are of the same size.
11420 * @see elm_toolbar_homogeneous_get()
11424 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11427 * Get whether the homogenous mode is enabled.
11429 * @param obj The toolbar object.
11430 * @return Assume the items within the toolbar are of the same height
11431 * and width (EINA_TRUE = on, EINA_FALSE = off).
11433 * @see elm_toolbar_homogeneous_set()
11437 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11440 * Enable/disable homogenous mode.
11442 * @param obj The toolbar object
11443 * @param homogeneous Assume the items within the toolbar are of the
11444 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11446 * This will enable the homogeneous mode where items are of the same size.
11447 * @see elm_toolbar_homogeneous_get()
11449 * @deprecated use elm_toolbar_homogeneous_set() instead.
11453 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11456 * Get whether the homogenous mode is enabled.
11458 * @param obj The toolbar object.
11459 * @return Assume the items within the toolbar are of the same height
11460 * and width (EINA_TRUE = on, EINA_FALSE = off).
11462 * @see elm_toolbar_homogeneous_set()
11463 * @deprecated use elm_toolbar_homogeneous_get() instead.
11467 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11470 * Set the parent object of the toolbar items' menus.
11472 * @param obj The toolbar object.
11473 * @param parent The parent of the menu objects.
11475 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11477 * For more details about setting the parent for toolbar menus, see
11478 * elm_menu_parent_set().
11480 * @see elm_menu_parent_set() for details.
11481 * @see elm_toolbar_item_menu_set() for details.
11485 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11488 * Get the parent object of the toolbar items' menus.
11490 * @param obj The toolbar object.
11491 * @return The parent of the menu objects.
11493 * @see elm_toolbar_menu_parent_set() for details.
11497 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11500 * Set the alignment of the items.
11502 * @param obj The toolbar object.
11503 * @param align The new alignment, a float between <tt> 0.0 </tt>
11504 * and <tt> 1.0 </tt>.
11506 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11507 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11510 * Centered items by default.
11512 * @see elm_toolbar_align_get()
11516 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11519 * Get the alignment of the items.
11521 * @param obj The toolbar object.
11522 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11525 * @see elm_toolbar_align_set() for details.
11529 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11532 * Set whether the toolbar item opens a menu.
11534 * @param item The toolbar item.
11535 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11537 * A toolbar item can be set to be a menu, using this function.
11539 * Once it is set to be a menu, it can be manipulated through the
11540 * menu-like function elm_toolbar_menu_parent_set() and the other
11541 * elm_menu functions, using the Evas_Object @c menu returned by
11542 * elm_toolbar_item_menu_get().
11544 * So, items to be displayed in this item's menu should be added with
11545 * elm_menu_item_add().
11547 * The following code exemplifies the most basic usage:
11549 * tb = elm_toolbar_add(win)
11550 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11551 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11552 * elm_toolbar_menu_parent_set(tb, win);
11553 * menu = elm_toolbar_item_menu_get(item);
11554 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11555 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11559 * @see elm_toolbar_item_menu_get()
11563 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11566 * Get toolbar item's menu.
11568 * @param item The toolbar item.
11569 * @return Item's menu object or @c NULL on failure.
11571 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11572 * this function will set it.
11574 * @see elm_toolbar_item_menu_set() for details.
11578 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11581 * Add a new state to @p item.
11583 * @param item The item.
11584 * @param icon A string with icon name or the absolute path of an image file.
11585 * @param label The label of the new state.
11586 * @param func The function to call when the item is clicked when this
11587 * state is selected.
11588 * @param data The data to associate with the state.
11589 * @return The toolbar item state, or @c NULL upon failure.
11591 * Toolbar will load icon image from fdo or current theme.
11592 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11593 * If an absolute path is provided it will load it direct from a file.
11595 * States created with this function can be removed with
11596 * elm_toolbar_item_state_del().
11598 * @see elm_toolbar_item_state_del()
11599 * @see elm_toolbar_item_state_sel()
11600 * @see elm_toolbar_item_state_get()
11604 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);
11607 * Delete a previoulsy added state to @p item.
11609 * @param item The toolbar item.
11610 * @param state The state to be deleted.
11611 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11613 * @see elm_toolbar_item_state_add()
11615 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11618 * Set @p state as the current state of @p it.
11620 * @param it The item.
11621 * @param state The state to use.
11622 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11624 * If @p state is @c NULL, it won't select any state and the default item's
11625 * icon and label will be used. It's the same behaviour than
11626 * elm_toolbar_item_state_unser().
11628 * @see elm_toolbar_item_state_unset()
11632 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11635 * Unset the state of @p it.
11637 * @param it The item.
11639 * The default icon and label from this item will be displayed.
11641 * @see elm_toolbar_item_state_set() for more details.
11645 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11648 * Get the current state of @p it.
11650 * @param item The item.
11651 * @return The selected state or @c NULL if none is selected or on failure.
11653 * @see elm_toolbar_item_state_set() for details.
11654 * @see elm_toolbar_item_state_unset()
11655 * @see elm_toolbar_item_state_add()
11659 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11662 * Get the state after selected state in toolbar's @p item.
11664 * @param it The toolbar item to change state.
11665 * @return The state after current state, or @c NULL on failure.
11667 * If last state is selected, this function will return first state.
11669 * @see elm_toolbar_item_state_set()
11670 * @see elm_toolbar_item_state_add()
11674 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11677 * Get the state before selected state in toolbar's @p item.
11679 * @param it The toolbar item to change state.
11680 * @return The state before current state, or @c NULL on failure.
11682 * If first state is selected, this function will return last state.
11684 * @see elm_toolbar_item_state_set()
11685 * @see elm_toolbar_item_state_add()
11689 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11692 * Set the text to be shown in a given toolbar item's tooltips.
11694 * @param item Target item.
11695 * @param text The text to set in the content.
11697 * Setup the text as tooltip to object. The item can have only one tooltip,
11698 * so any previous tooltip data - set with this function or
11699 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11701 * @see elm_object_tooltip_text_set() for more details.
11705 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11708 * Set the content to be shown in the tooltip item.
11710 * Setup the tooltip to item. The item can have only one tooltip,
11711 * so any previous tooltip data is removed. @p func(with @p data) will
11712 * be called every time that need show the tooltip and it should
11713 * return a valid Evas_Object. This object is then managed fully by
11714 * tooltip system and is deleted when the tooltip is gone.
11716 * @param item the toolbar item being attached a tooltip.
11717 * @param func the function used to create the tooltip contents.
11718 * @param data what to provide to @a func as callback data/context.
11719 * @param del_cb called when data is not needed anymore, either when
11720 * another callback replaces @a func, the tooltip is unset with
11721 * elm_toolbar_item_tooltip_unset() or the owner @a item
11722 * dies. This callback receives as the first parameter the
11723 * given @a data, and @c event_info is the item.
11725 * @see elm_object_tooltip_content_cb_set() for more details.
11729 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);
11732 * Unset tooltip from item.
11734 * @param item toolbar item to remove previously set tooltip.
11736 * Remove tooltip from item. The callback provided as del_cb to
11737 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11738 * it is not used anymore.
11740 * @see elm_object_tooltip_unset() for more details.
11741 * @see elm_toolbar_item_tooltip_content_cb_set()
11745 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11748 * Sets a different style for this item tooltip.
11750 * @note before you set a style you should define a tooltip with
11751 * elm_toolbar_item_tooltip_content_cb_set() or
11752 * elm_toolbar_item_tooltip_text_set()
11754 * @param item toolbar item with tooltip already set.
11755 * @param style the theme style to use (default, transparent, ...)
11757 * @see elm_object_tooltip_style_set() for more details.
11761 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11764 * Get the style for this item tooltip.
11766 * @param item toolbar item with tooltip already set.
11767 * @return style the theme style in use, defaults to "default". If the
11768 * object does not have a tooltip set, then NULL is returned.
11770 * @see elm_object_tooltip_style_get() for more details.
11771 * @see elm_toolbar_item_tooltip_style_set()
11775 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11778 * Set the type of mouse pointer/cursor decoration to be shown,
11779 * when the mouse pointer is over the given toolbar widget item
11781 * @param item toolbar item to customize cursor on
11782 * @param cursor the cursor type's name
11784 * This function works analogously as elm_object_cursor_set(), but
11785 * here the cursor's changing area is restricted to the item's
11786 * area, and not the whole widget's. Note that that item cursors
11787 * have precedence over widget cursors, so that a mouse over an
11788 * item with custom cursor set will always show @b that cursor.
11790 * If this function is called twice for an object, a previously set
11791 * cursor will be unset on the second call.
11793 * @see elm_object_cursor_set()
11794 * @see elm_toolbar_item_cursor_get()
11795 * @see elm_toolbar_item_cursor_unset()
11799 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11802 * Get the type of mouse pointer/cursor decoration set to be shown,
11803 * when the mouse pointer is over the given toolbar widget item
11805 * @param item toolbar item with custom cursor set
11806 * @return the cursor type's name or @c NULL, if no custom cursors
11807 * were set to @p item (and on errors)
11809 * @see elm_object_cursor_get()
11810 * @see elm_toolbar_item_cursor_set()
11811 * @see elm_toolbar_item_cursor_unset()
11815 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11818 * Unset any custom mouse pointer/cursor decoration set to be
11819 * shown, when the mouse pointer is over the given toolbar widget
11820 * item, thus making it show the @b default cursor again.
11822 * @param item a toolbar item
11824 * Use this call to undo any custom settings on this item's cursor
11825 * decoration, bringing it back to defaults (no custom style set).
11827 * @see elm_object_cursor_unset()
11828 * @see elm_toolbar_item_cursor_set()
11832 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11835 * Set a different @b style for a given custom cursor set for a
11838 * @param item toolbar item with custom cursor set
11839 * @param style the <b>theme style</b> to use (e.g. @c "default",
11840 * @c "transparent", etc)
11842 * This function only makes sense when one is using custom mouse
11843 * cursor decorations <b>defined in a theme file</b>, which can have,
11844 * given a cursor name/type, <b>alternate styles</b> on it. It
11845 * works analogously as elm_object_cursor_style_set(), but here
11846 * applyed only to toolbar item objects.
11848 * @warning Before you set a cursor style you should have definen a
11849 * custom cursor previously on the item, with
11850 * elm_toolbar_item_cursor_set()
11852 * @see elm_toolbar_item_cursor_engine_only_set()
11853 * @see elm_toolbar_item_cursor_style_get()
11857 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11860 * Get the current @b style set for a given toolbar item's custom
11863 * @param item toolbar item with custom cursor set.
11864 * @return style the cursor style in use. If the object does not
11865 * have a cursor set, then @c NULL is returned.
11867 * @see elm_toolbar_item_cursor_style_set() for more details
11871 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11874 * Set if the (custom)cursor for a given toolbar item should be
11875 * searched in its theme, also, or should only rely on the
11876 * rendering engine.
11878 * @param item item with custom (custom) cursor already set on
11879 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11880 * only on those provided by the rendering engine, @c EINA_FALSE to
11881 * have them searched on the widget's theme, as well.
11883 * @note This call is of use only if you've set a custom cursor
11884 * for toolbar items, with elm_toolbar_item_cursor_set().
11886 * @note By default, cursors will only be looked for between those
11887 * provided by the rendering engine.
11891 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11894 * Get if the (custom) cursor for a given toolbar item is being
11895 * searched in its theme, also, or is only relying on the rendering
11898 * @param item a toolbar item
11899 * @return @c EINA_TRUE, if cursors are being looked for only on
11900 * those provided by the rendering engine, @c EINA_FALSE if they
11901 * are being searched on the widget's theme, as well.
11903 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11907 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11914 EAPI double elm_tooltip_delay_get(void);
11915 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11916 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11917 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11918 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11919 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);
11920 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11921 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11922 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11923 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11924 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11925 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11926 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11927 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11928 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11929 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11930 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11931 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11934 EAPI int elm_cursor_engine_only_get(void);
11935 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11938 * @defgroup Menu Menu
11940 * @image html img/widget/menu/preview-00.png
11941 * @image latex img/widget/menu/preview-00.eps
11943 * A menu is a list of items displayed above its parent. When the menu is
11944 * showing its parent is darkened. Each item can have a sub-menu. The menu
11945 * object can be used to display a menu on a right click event, in a toolbar,
11948 * Signals that you can add callbacks for are:
11949 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11950 * event_info is NULL.
11952 * @see @ref tutorial_menu
11955 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11957 * @brief Add a new menu to the parent
11959 * @param parent The parent object.
11960 * @return The new object or NULL if it cannot be created.
11962 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11964 * @brief Set the parent for the given menu widget
11966 * @param obj The menu object.
11967 * @param parent The new parent.
11969 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11971 * @brief Get the parent for the given menu widget
11973 * @param obj The menu object.
11974 * @return The parent.
11976 * @see elm_menu_parent_set()
11978 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11980 * @brief Move the menu to a new position
11982 * @param obj The menu object.
11983 * @param x The new position.
11984 * @param y The new position.
11986 * Sets the top-left position of the menu to (@p x,@p y).
11988 * @note @p x and @p y coordinates are relative to parent.
11990 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
11992 * @brief Close a opened menu
11994 * @param obj the menu object
11997 * Hides the menu and all it's sub-menus.
11999 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12001 * @brief Returns a list of @p item's items.
12003 * @param obj The menu object
12004 * @return An Eina_List* of @p item's items
12006 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12008 * @brief Get the Evas_Object of an Elm_Menu_Item
12010 * @param item The menu item object.
12011 * @return The edje object containing the swallowed content
12013 * @warning Don't manipulate this object!
12015 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12017 * @brief Add an item at the end of the given menu widget
12019 * @param obj The menu object.
12020 * @param parent The parent menu item (optional)
12021 * @param icon A icon display on the item. The icon will be destryed by the menu.
12022 * @param label The label of the item.
12023 * @param func Function called when the user select the item.
12024 * @param data Data sent by the callback.
12025 * @return Returns the new item.
12027 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);
12029 * @brief Add an object swallowed in an item at the end of the given menu
12032 * @param obj The menu object.
12033 * @param parent The parent menu item (optional)
12034 * @param subobj The object to swallow
12035 * @param func Function called when the user select the item.
12036 * @param data Data sent by the callback.
12037 * @return Returns the new item.
12039 * Add an evas object as an item to the menu.
12041 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);
12043 * @brief Set the label of a menu item
12045 * @param item The menu item object.
12046 * @param label The label to set for @p item
12048 * @warning Don't use this funcion on items created with
12049 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12051 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12053 * @brief Get the label of a menu item
12055 * @param item The menu item object.
12056 * @return The label of @p item
12058 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12060 * @brief Set the icon of a menu item to the standard icon with name @p icon
12062 * @param item The menu item object.
12063 * @param icon The icon object to set for the content of @p item
12065 * Once this icon is set, any previously set icon will be deleted.
12067 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12069 * @brief Get the string representation from the icon of a menu item
12071 * @param item The menu item object.
12072 * @return The string representation of @p item's icon or NULL
12074 * @see elm_menu_item_object_icon_name_set()
12076 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12078 * @deprecated Use elm_menu_item_object_icon_name_set()
12080 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12082 * @deprecated Use elm_menu_item_object_icon_name_get()
12084 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12086 * @brief Set the content object of a menu item
12088 * @param item The menu item object
12089 * @param The content object or NULL
12090 * @return EINA_TRUE on success, else EINA_FALSE
12092 * Use this function to change the object swallowed by a menu item, deleting
12093 * any previously swallowed object.
12095 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12097 * @brief Get the content object of a menu item
12099 * @param item The menu item object
12100 * @return The content object or NULL
12101 * @note If @p item was added with elm_menu_item_add_object, this
12102 * function will return the object passed, else it will return the
12105 * @see elm_menu_item_object_content_set()
12107 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12109 * @deprecated Use elm_menu_item_object_content_get() instead.
12111 EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12113 * @brief Set the selected state of @p item.
12115 * @param item The menu item object.
12116 * @param selected The selected/unselected state of the item
12118 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12120 * @brief Get the selected state of @p item.
12122 * @param item The menu item object.
12123 * @return The selected/unselected state of the item
12125 * @see elm_menu_item_selected_set()
12127 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12129 * @brief Set the disabled state of @p item.
12131 * @param item The menu item object.
12132 * @param disabled The enabled/disabled state of the item
12134 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12136 * @brief Get the disabled state of @p item.
12138 * @param item The menu item object.
12139 * @return The enabled/disabled state of the item
12141 * @see elm_menu_item_disabled_set()
12143 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12145 * @brief Add a separator item to menu @p obj under @p parent.
12147 * @param obj The menu object
12148 * @param parent The item to add the separator under
12149 * @return The created item or NULL on failure
12151 * This is item is a @ref Separator.
12153 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12155 * @brief Returns whether @p item is a separator.
12157 * @param item The item to check
12158 * @return If true, @p item is a separator
12160 * @see elm_menu_item_separator_add()
12162 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12164 * @brief Deletes an item from the menu.
12166 * @param item The item to delete.
12168 * @see elm_menu_item_add()
12170 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12172 * @brief Set the function called when a menu item is deleted.
12174 * @param item The item to set the callback on
12175 * @param func The function called
12177 * @see elm_menu_item_add()
12178 * @see elm_menu_item_del()
12180 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12182 * @brief Returns the data associated with menu item @p item.
12184 * @param item The item
12185 * @return The data associated with @p item or NULL if none was set.
12187 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12189 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12191 * @brief Sets the data to be associated with menu item @p item.
12193 * @param item The item
12194 * @param data The data to be associated with @p item
12196 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12198 * @brief Returns a list of @p item's subitems.
12200 * @param item The item
12201 * @return An Eina_List* of @p item's subitems
12203 * @see elm_menu_add()
12205 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12207 * @brief Get the position of a menu item
12209 * @param item The menu item
12210 * @return The item's index
12212 * This function returns the index position of a menu item in a menu.
12213 * For a sub-menu, this number is relative to the first item in the sub-menu.
12215 * @note Index values begin with 0
12217 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12219 * @brief @brief Return a menu item's owner menu
12221 * @param item The menu item
12222 * @return The menu object owning @p item, or NULL on failure
12224 * Use this function to get the menu object owning an item.
12226 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12228 * @brief Get the selected item in the menu
12230 * @param obj The menu object
12231 * @return The selected item, or NULL if none
12233 * @see elm_menu_item_selected_get()
12234 * @see elm_menu_item_selected_set()
12236 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12238 * @brief Get the last item in the menu
12240 * @param obj The menu object
12241 * @return The last item, or NULL if none
12243 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12245 * @brief Get the first item in the menu
12247 * @param obj The menu object
12248 * @return The first item, or NULL if none
12250 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12252 * @brief Get the next item in the menu.
12254 * @param item The menu item object.
12255 * @return The item after it, or NULL if none
12257 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12259 * @brief Get the previous item in the menu.
12261 * @param item The menu item object.
12262 * @return The item before it, or NULL if none
12264 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12270 * @defgroup List List
12271 * @ingroup Elementary
12273 * @image html img/widget/list/preview-00.png
12274 * @image latex img/widget/list/preview-00.eps width=\textwidth
12276 * @image html img/list.png
12277 * @image latex img/list.eps width=\textwidth
12279 * A list widget is a container whose children are displayed vertically or
12280 * horizontally, in order, and can be selected.
12281 * The list can accept only one or multiple items selection. Also has many
12282 * modes of items displaying.
12284 * A list is a very simple type of list widget. For more robust
12285 * lists, @ref Genlist should probably be used.
12287 * Smart callbacks one can listen to:
12288 * - @c "activated" - The user has double-clicked or pressed
12289 * (enter|return|spacebar) on an item. The @c event_info parameter
12290 * is the item that was activated.
12291 * - @c "clicked,double" - The user has double-clicked an item.
12292 * The @c event_info parameter is the item that was double-clicked.
12293 * - "selected" - when the user selected an item
12294 * - "unselected" - when the user unselected an item
12295 * - "longpressed" - an item in the list is long-pressed
12296 * - "scroll,edge,top" - the list is scrolled until the top edge
12297 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12298 * - "scroll,edge,left" - the list is scrolled until the left edge
12299 * - "scroll,edge,right" - the list is scrolled until the right edge
12301 * Available styles for it:
12304 * List of examples:
12305 * @li @ref list_example_01
12306 * @li @ref list_example_02
12307 * @li @ref list_example_03
12316 * @enum _Elm_List_Mode
12317 * @typedef Elm_List_Mode
12319 * Set list's resize behavior, transverse axis scroll and
12320 * items cropping. See each mode's description for more details.
12322 * @note Default value is #ELM_LIST_SCROLL.
12324 * Values <b> don't </b> work as bitmask, only one can be choosen.
12326 * @see elm_list_mode_set()
12327 * @see elm_list_mode_get()
12331 typedef enum _Elm_List_Mode
12333 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. */
12334 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). */
12335 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. */
12336 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. */
12337 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12340 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(). */
12343 * Add a new list widget to the given parent Elementary
12344 * (container) object.
12346 * @param parent The parent object.
12347 * @return a new list widget handle or @c NULL, on errors.
12349 * This function inserts a new list widget on the canvas.
12353 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12358 * @param obj The list object
12360 * @note Call before running show() on the list object.
12361 * @warning If not called, it won't display the list properly.
12364 * li = elm_list_add(win);
12365 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12366 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12368 * evas_object_show(li);
12373 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12376 * Enable or disable multiple items selection on the list object.
12378 * @param obj The list object
12379 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12382 * Disabled by default. If disabled, the user can select a single item of
12383 * the list each time. Selected items are highlighted on list.
12384 * If enabled, many items can be selected.
12386 * If a selected item is selected again, it will be unselected.
12388 * @see elm_list_multi_select_get()
12392 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12395 * Get a value whether multiple items selection is enabled or not.
12397 * @see elm_list_multi_select_set() for details.
12399 * @param obj The list object.
12400 * @return @c EINA_TRUE means multiple items selection is enabled.
12401 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12402 * @c EINA_FALSE is returned.
12406 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12409 * Set which mode to use for the list object.
12411 * @param obj The list object
12412 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12413 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12415 * Set list's resize behavior, transverse axis scroll and
12416 * items cropping. See each mode's description for more details.
12418 * @note Default value is #ELM_LIST_SCROLL.
12420 * Only one can be set, if a previous one was set, it will be changed
12421 * by the new mode set. Bitmask won't work as well.
12423 * @see elm_list_mode_get()
12427 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12430 * Get the mode the list is at.
12432 * @param obj The list object
12433 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12434 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12436 * @note see elm_list_mode_set() for more information.
12440 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12443 * Enable or disable horizontal mode on the list object.
12445 * @param obj The list object.
12446 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12447 * disable it, i.e., to enable vertical mode.
12449 * @note Vertical mode is set by default.
12451 * On horizontal mode items are displayed on list from left to right,
12452 * instead of from top to bottom. Also, the list will scroll horizontally.
12453 * Each item will presents left icon on top and right icon, or end, at
12456 * @see elm_list_horizontal_get()
12460 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12463 * Get a value whether horizontal mode is enabled or not.
12465 * @param obj The list object.
12466 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12467 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12468 * @c EINA_FALSE is returned.
12470 * @see elm_list_horizontal_set() for details.
12474 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12477 * Enable or disable always select mode on the list object.
12479 * @param obj The list object
12480 * @param always_select @c EINA_TRUE to enable always select mode or
12481 * @c EINA_FALSE to disable it.
12483 * @note Always select mode is disabled by default.
12485 * Default behavior of list items is to only call its callback function
12486 * the first time it's pressed, i.e., when it is selected. If a selected
12487 * item is pressed again, and multi-select is disabled, it won't call
12488 * this function (if multi-select is enabled it will unselect the item).
12490 * If always select is enabled, it will call the callback function
12491 * everytime a item is pressed, so it will call when the item is selected,
12492 * and again when a selected item is pressed.
12494 * @see elm_list_always_select_mode_get()
12495 * @see elm_list_multi_select_set()
12499 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12502 * Get a value whether always select mode is enabled or not, meaning that
12503 * an item will always call its callback function, even if already selected.
12505 * @param obj The list object
12506 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12507 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12508 * @c EINA_FALSE is returned.
12510 * @see elm_list_always_select_mode_set() for details.
12514 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12517 * Set bouncing behaviour when the scrolled content reaches an edge.
12519 * Tell the internal scroller object whether it should bounce or not
12520 * when it reaches the respective edges for each axis.
12522 * @param obj The list object
12523 * @param h_bounce Whether to bounce or not in the horizontal axis.
12524 * @param v_bounce Whether to bounce or not in the vertical axis.
12526 * @see elm_scroller_bounce_set()
12530 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12533 * Get the bouncing behaviour of the internal scroller.
12535 * Get whether the internal scroller should bounce when the edge of each
12536 * axis is reached scrolling.
12538 * @param obj The list object.
12539 * @param h_bounce Pointer where to store the bounce state of the horizontal
12541 * @param v_bounce Pointer where to store the bounce state of the vertical
12544 * @see elm_scroller_bounce_get()
12545 * @see elm_list_bounce_set()
12549 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12552 * Set the scrollbar policy.
12554 * @param obj The list object
12555 * @param policy_h Horizontal scrollbar policy.
12556 * @param policy_v Vertical scrollbar policy.
12558 * This sets the scrollbar visibility policy for the given scroller.
12559 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12560 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12561 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12562 * This applies respectively for the horizontal and vertical scrollbars.
12564 * The both are disabled by default, i.e., are set to
12565 * #ELM_SCROLLER_POLICY_OFF.
12569 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12572 * Get the scrollbar policy.
12574 * @see elm_list_scroller_policy_get() for details.
12576 * @param obj The list object.
12577 * @param policy_h Pointer where to store horizontal scrollbar policy.
12578 * @param policy_v Pointer where to store vertical scrollbar policy.
12582 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);
12585 * Append a new item to the list object.
12587 * @param obj The list object.
12588 * @param label The label of the list item.
12589 * @param icon The icon object to use for the left side of the item. An
12590 * icon can be any Evas object, but usually it is an icon created
12591 * with elm_icon_add().
12592 * @param end The icon object to use for the right side of the item. An
12593 * icon can be any Evas object.
12594 * @param func The function to call when the item is clicked.
12595 * @param data The data to associate with the item for related callbacks.
12597 * @return The created item or @c NULL upon failure.
12599 * A new item will be created and appended to the list, i.e., will
12600 * be set as @b last item.
12602 * Items created with this method can be deleted with
12603 * elm_list_item_del().
12605 * Associated @p data can be properly freed when item is deleted if a
12606 * callback function is set with elm_list_item_del_cb_set().
12608 * If a function is passed as argument, it will be called everytime this item
12609 * is selected, i.e., the user clicks over an unselected item.
12610 * If always select is enabled it will call this function every time
12611 * user clicks over an item (already selected or not).
12612 * If such function isn't needed, just passing
12613 * @c NULL as @p func is enough. The same should be done for @p data.
12615 * Simple example (with no function callback or data associated):
12617 * li = elm_list_add(win);
12618 * ic = elm_icon_add(win);
12619 * elm_icon_file_set(ic, "path/to/image", NULL);
12620 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12621 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12623 * evas_object_show(li);
12626 * @see elm_list_always_select_mode_set()
12627 * @see elm_list_item_del()
12628 * @see elm_list_item_del_cb_set()
12629 * @see elm_list_clear()
12630 * @see elm_icon_add()
12634 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);
12637 * Prepend a new item to the list object.
12639 * @param obj The list object.
12640 * @param label The label of the list item.
12641 * @param icon The icon object to use for the left side of the item. An
12642 * icon can be any Evas object, but usually it is an icon created
12643 * with elm_icon_add().
12644 * @param end The icon object to use for the right side of the item. An
12645 * icon can be any Evas object.
12646 * @param func The function to call when the item is clicked.
12647 * @param data The data to associate with the item for related callbacks.
12649 * @return The created item or @c NULL upon failure.
12651 * A new item will be created and prepended to the list, i.e., will
12652 * be set as @b first item.
12654 * Items created with this method can be deleted with
12655 * elm_list_item_del().
12657 * Associated @p data can be properly freed when item is deleted if a
12658 * callback function is set with elm_list_item_del_cb_set().
12660 * If a function is passed as argument, it will be called everytime this item
12661 * is selected, i.e., the user clicks over an unselected item.
12662 * If always select is enabled it will call this function every time
12663 * user clicks over an item (already selected or not).
12664 * If such function isn't needed, just passing
12665 * @c NULL as @p func is enough. The same should be done for @p data.
12667 * @see elm_list_item_append() for a simple code example.
12668 * @see elm_list_always_select_mode_set()
12669 * @see elm_list_item_del()
12670 * @see elm_list_item_del_cb_set()
12671 * @see elm_list_clear()
12672 * @see elm_icon_add()
12676 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);
12679 * Insert a new item into the list object before item @p before.
12681 * @param obj The list object.
12682 * @param before The list item to insert before.
12683 * @param label The label of the list item.
12684 * @param icon The icon object to use for the left side of the item. An
12685 * icon can be any Evas object, but usually it is an icon created
12686 * with elm_icon_add().
12687 * @param end The icon object to use for the right side of the item. An
12688 * icon can be any Evas object.
12689 * @param func The function to call when the item is clicked.
12690 * @param data The data to associate with the item for related callbacks.
12692 * @return The created item or @c NULL upon failure.
12694 * A new item will be created and added to the list. Its position in
12695 * this list will be just before item @p before.
12697 * Items created with this method can be deleted with
12698 * elm_list_item_del().
12700 * Associated @p data can be properly freed when item is deleted if a
12701 * callback function is set with elm_list_item_del_cb_set().
12703 * If a function is passed as argument, it will be called everytime this item
12704 * is selected, i.e., the user clicks over an unselected item.
12705 * If always select is enabled it will call this function every time
12706 * user clicks over an item (already selected or not).
12707 * If such function isn't needed, just passing
12708 * @c NULL as @p func is enough. The same should be done for @p data.
12710 * @see elm_list_item_append() for a simple code example.
12711 * @see elm_list_always_select_mode_set()
12712 * @see elm_list_item_del()
12713 * @see elm_list_item_del_cb_set()
12714 * @see elm_list_clear()
12715 * @see elm_icon_add()
12719 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);
12722 * Insert a new item into the list object after item @p after.
12724 * @param obj The list object.
12725 * @param after The list item to insert after.
12726 * @param label The label of the list item.
12727 * @param icon The icon object to use for the left side of the item. An
12728 * icon can be any Evas object, but usually it is an icon created
12729 * with elm_icon_add().
12730 * @param end The icon object to use for the right side of the item. An
12731 * icon can be any Evas object.
12732 * @param func The function to call when the item is clicked.
12733 * @param data The data to associate with the item for related callbacks.
12735 * @return The created item or @c NULL upon failure.
12737 * A new item will be created and added to the list. Its position in
12738 * this list will be just after item @p after.
12740 * Items created with this method can be deleted with
12741 * elm_list_item_del().
12743 * Associated @p data can be properly freed when item is deleted if a
12744 * callback function is set with elm_list_item_del_cb_set().
12746 * If a function is passed as argument, it will be called everytime this item
12747 * is selected, i.e., the user clicks over an unselected item.
12748 * If always select is enabled it will call this function every time
12749 * user clicks over an item (already selected or not).
12750 * If such function isn't needed, just passing
12751 * @c NULL as @p func is enough. The same should be done for @p data.
12753 * @see elm_list_item_append() for a simple code example.
12754 * @see elm_list_always_select_mode_set()
12755 * @see elm_list_item_del()
12756 * @see elm_list_item_del_cb_set()
12757 * @see elm_list_clear()
12758 * @see elm_icon_add()
12762 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);
12765 * Insert a new item into the sorted list object.
12767 * @param obj The list object.
12768 * @param label The label of the list item.
12769 * @param icon The icon object to use for the left side of the item. An
12770 * icon can be any Evas object, but usually it is an icon created
12771 * with elm_icon_add().
12772 * @param end The icon object to use for the right side of the item. An
12773 * icon can be any Evas object.
12774 * @param func The function to call when the item is clicked.
12775 * @param data The data to associate with the item for related callbacks.
12776 * @param cmp_func The comparing function to be used to sort list
12777 * items <b>by #Elm_List_Item item handles</b>. This function will
12778 * receive two items and compare them, returning a non-negative integer
12779 * if the second item should be place after the first, or negative value
12780 * if should be placed before.
12782 * @return The created item or @c NULL upon failure.
12784 * @note This function inserts values into a list object assuming it was
12785 * sorted and the result will be sorted.
12787 * A new item will be created and added to the list. Its position in
12788 * this list will be found comparing the new item with previously inserted
12789 * items using function @p cmp_func.
12791 * Items created with this method can be deleted with
12792 * elm_list_item_del().
12794 * Associated @p data can be properly freed when item is deleted if a
12795 * callback function is set with elm_list_item_del_cb_set().
12797 * If a function is passed as argument, it will be called everytime this item
12798 * is selected, i.e., the user clicks over an unselected item.
12799 * If always select is enabled it will call this function every time
12800 * user clicks over an item (already selected or not).
12801 * If such function isn't needed, just passing
12802 * @c NULL as @p func is enough. The same should be done for @p data.
12804 * @see elm_list_item_append() for a simple code example.
12805 * @see elm_list_always_select_mode_set()
12806 * @see elm_list_item_del()
12807 * @see elm_list_item_del_cb_set()
12808 * @see elm_list_clear()
12809 * @see elm_icon_add()
12813 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);
12816 * Remove all list's items.
12818 * @param obj The list object
12820 * @see elm_list_item_del()
12821 * @see elm_list_item_append()
12825 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12828 * Get a list of all the list items.
12830 * @param obj The list object
12831 * @return An @c Eina_List of list items, #Elm_List_Item,
12832 * or @c NULL on failure.
12834 * @see elm_list_item_append()
12835 * @see elm_list_item_del()
12836 * @see elm_list_clear()
12840 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12843 * Get the selected item.
12845 * @param obj The list object.
12846 * @return The selected list item.
12848 * The selected item can be unselected with function
12849 * elm_list_item_selected_set().
12851 * The selected item always will be highlighted on list.
12853 * @see elm_list_selected_items_get()
12857 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12860 * Return a list of the currently selected list items.
12862 * @param obj The list object.
12863 * @return An @c Eina_List of list items, #Elm_List_Item,
12864 * or @c NULL on failure.
12866 * Multiple items can be selected if multi select is enabled. It can be
12867 * done with elm_list_multi_select_set().
12869 * @see elm_list_selected_item_get()
12870 * @see elm_list_multi_select_set()
12874 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12877 * Set the selected state of an item.
12879 * @param item The list item
12880 * @param selected The selected state
12882 * This sets the selected state of the given item @p it.
12883 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12885 * If a new item is selected the previosly selected will be unselected,
12886 * unless multiple selection is enabled with elm_list_multi_select_set().
12887 * Previoulsy selected item can be get with function
12888 * elm_list_selected_item_get().
12890 * Selected items will be highlighted.
12892 * @see elm_list_item_selected_get()
12893 * @see elm_list_selected_item_get()
12894 * @see elm_list_multi_select_set()
12898 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12901 * Get whether the @p item is selected or not.
12903 * @param item The list item.
12904 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12905 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12907 * @see elm_list_selected_item_set() for details.
12908 * @see elm_list_item_selected_get()
12912 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12915 * Set or unset item as a separator.
12917 * @param it The list item.
12918 * @param setting @c EINA_TRUE to set item @p it as separator or
12919 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12921 * Items aren't set as separator by default.
12923 * If set as separator it will display separator theme, so won't display
12926 * @see elm_list_item_separator_get()
12930 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12933 * Get a value whether item is a separator or not.
12935 * @see elm_list_item_separator_set() for details.
12937 * @param it The list item.
12938 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12939 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12943 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12946 * Show @p item in the list view.
12948 * @param item The list item to be shown.
12950 * It won't animate list until item is visible. If such behavior is wanted,
12951 * use elm_list_bring_in() intead.
12955 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12958 * Bring in the given item to list view.
12960 * @param item The item.
12962 * This causes list to jump to the given item @p item and show it
12963 * (by scrolling), if it is not fully visible.
12965 * This may use animation to do so and take a period of time.
12967 * If animation isn't wanted, elm_list_item_show() can be used.
12971 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12974 * Delete them item from the list.
12976 * @param item The item of list to be deleted.
12978 * If deleting all list items is required, elm_list_clear()
12979 * should be used instead of getting items list and deleting each one.
12981 * @see elm_list_clear()
12982 * @see elm_list_item_append()
12983 * @see elm_list_item_del_cb_set()
12987 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12990 * Set the function called when a list item is freed.
12992 * @param item The item to set the callback on
12993 * @param func The function called
12995 * If there is a @p func, then it will be called prior item's memory release.
12996 * That will be called with the following arguments:
12998 * @li item's Evas object;
13001 * This way, a data associated to a list item could be properly freed.
13005 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13008 * Get the data associated to the item.
13010 * @param item The list item
13011 * @return The data associated to @p item
13013 * The return value is a pointer to data associated to @p item when it was
13014 * created, with function elm_list_item_append() or similar. If no data
13015 * was passed as argument, it will return @c NULL.
13017 * @see elm_list_item_append()
13021 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13024 * Get the left side icon associated to the item.
13026 * @param item The list item
13027 * @return The left side icon associated to @p item
13029 * The return value is a pointer to the icon associated to @p item when
13031 * created, with function elm_list_item_append() or similar, or later
13032 * with function elm_list_item_icon_set(). If no icon
13033 * was passed as argument, it will return @c NULL.
13035 * @see elm_list_item_append()
13036 * @see elm_list_item_icon_set()
13040 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13043 * Set the left side icon associated to the item.
13045 * @param item The list item
13046 * @param icon The left side icon object to associate with @p item
13048 * The icon object to use at left side of the item. An
13049 * icon can be any Evas object, but usually it is an icon created
13050 * with elm_icon_add().
13052 * Once the icon object is set, a previously set one will be deleted.
13053 * @warning Setting the same icon for two items will cause the icon to
13054 * dissapear from the first item.
13056 * If an icon was passed as argument on item creation, with function
13057 * elm_list_item_append() or similar, it will be already
13058 * associated to the item.
13060 * @see elm_list_item_append()
13061 * @see elm_list_item_icon_get()
13065 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13068 * Get the right side icon associated to the item.
13070 * @param item The list item
13071 * @return The right side icon associated to @p item
13073 * The return value is a pointer to the icon associated to @p item when
13075 * created, with function elm_list_item_append() or similar, or later
13076 * with function elm_list_item_icon_set(). If no icon
13077 * was passed as argument, it will return @c NULL.
13079 * @see elm_list_item_append()
13080 * @see elm_list_item_icon_set()
13084 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13087 * Set the right side icon associated to the item.
13089 * @param item The list item
13090 * @param end The right side icon object to associate with @p item
13092 * The icon object to use at right side of the item. An
13093 * icon can be any Evas object, but usually it is an icon created
13094 * with elm_icon_add().
13096 * Once the icon object is set, a previously set one will be deleted.
13097 * @warning Setting the same icon for two items will cause the icon to
13098 * dissapear from the first item.
13100 * If an icon was passed as argument on item creation, with function
13101 * elm_list_item_append() or similar, it will be already
13102 * associated to the item.
13104 * @see elm_list_item_append()
13105 * @see elm_list_item_end_get()
13109 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13112 * Gets the base object of the item.
13114 * @param item The list item
13115 * @return The base object associated with @p item
13117 * Base object is the @c Evas_Object that represents that item.
13121 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13124 * Get the label of item.
13126 * @param item The item of list.
13127 * @return The label of item.
13129 * The return value is a pointer to the label associated to @p item when
13130 * it was created, with function elm_list_item_append(), or later
13131 * with function elm_list_item_label_set. If no label
13132 * was passed as argument, it will return @c NULL.
13134 * @see elm_list_item_label_set() for more details.
13135 * @see elm_list_item_append()
13139 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13142 * Set the label of item.
13144 * @param item The item of list.
13145 * @param text The label of item.
13147 * The label to be displayed by the item.
13148 * Label will be placed between left and right side icons (if set).
13150 * If a label was passed as argument on item creation, with function
13151 * elm_list_item_append() or similar, it will be already
13152 * displayed by the item.
13154 * @see elm_list_item_label_get()
13155 * @see elm_list_item_append()
13159 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13163 * Get the item before @p it in list.
13165 * @param it The list item.
13166 * @return The item before @p it, or @c NULL if none or on failure.
13168 * @note If it is the first item, @c NULL will be returned.
13170 * @see elm_list_item_append()
13171 * @see elm_list_items_get()
13175 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13178 * Get the item after @p it in list.
13180 * @param it The list item.
13181 * @return The item after @p it, or @c NULL if none or on failure.
13183 * @note If it is the last item, @c NULL will be returned.
13185 * @see elm_list_item_append()
13186 * @see elm_list_items_get()
13190 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13193 * Sets the disabled/enabled state of a list item.
13195 * @param it The item.
13196 * @param disabled The disabled state.
13198 * A disabled item cannot be selected or unselected. It will also
13199 * change its appearance (generally greyed out). This sets the
13200 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13205 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13208 * Get a value whether list item is disabled or not.
13210 * @param it The item.
13211 * @return The disabled state.
13213 * @see elm_list_item_disabled_set() for more details.
13217 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13220 * Set the text to be shown in a given list item's tooltips.
13222 * @param item Target item.
13223 * @param text The text to set in the content.
13225 * Setup the text as tooltip to object. The item can have only one tooltip,
13226 * so any previous tooltip data - set with this function or
13227 * elm_list_item_tooltip_content_cb_set() - is removed.
13229 * @see elm_object_tooltip_text_set() for more details.
13233 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13237 * @brief Disable size restrictions on an object's tooltip
13238 * @param item The tooltip's anchor object
13239 * @param disable If EINA_TRUE, size restrictions are disabled
13240 * @return EINA_FALSE on failure, EINA_TRUE on success
13242 * This function allows a tooltip to expand beyond its parant window's canvas.
13243 * It will instead be limited only by the size of the display.
13245 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13247 * @brief Retrieve size restriction state of an object's tooltip
13248 * @param obj The tooltip's anchor object
13249 * @return If EINA_TRUE, size restrictions are disabled
13251 * This function returns whether a tooltip is allowed to expand beyond
13252 * its parant window's canvas.
13253 * It will instead be limited only by the size of the display.
13255 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13258 * Set the content to be shown in the tooltip item.
13260 * Setup the tooltip to item. The item can have only one tooltip,
13261 * so any previous tooltip data is removed. @p func(with @p data) will
13262 * be called every time that need show the tooltip and it should
13263 * return a valid Evas_Object. This object is then managed fully by
13264 * tooltip system and is deleted when the tooltip is gone.
13266 * @param item the list item being attached a tooltip.
13267 * @param func the function used to create the tooltip contents.
13268 * @param data what to provide to @a func as callback data/context.
13269 * @param del_cb called when data is not needed anymore, either when
13270 * another callback replaces @a func, the tooltip is unset with
13271 * elm_list_item_tooltip_unset() or the owner @a item
13272 * dies. This callback receives as the first parameter the
13273 * given @a data, and @c event_info is the item.
13275 * @see elm_object_tooltip_content_cb_set() for more details.
13279 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);
13282 * Unset tooltip from item.
13284 * @param item list item to remove previously set tooltip.
13286 * Remove tooltip from item. The callback provided as del_cb to
13287 * elm_list_item_tooltip_content_cb_set() will be called to notify
13288 * it is not used anymore.
13290 * @see elm_object_tooltip_unset() for more details.
13291 * @see elm_list_item_tooltip_content_cb_set()
13295 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13298 * Sets a different style for this item tooltip.
13300 * @note before you set a style you should define a tooltip with
13301 * elm_list_item_tooltip_content_cb_set() or
13302 * elm_list_item_tooltip_text_set()
13304 * @param item list item with tooltip already set.
13305 * @param style the theme style to use (default, transparent, ...)
13307 * @see elm_object_tooltip_style_set() for more details.
13311 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13314 * Get the style for this item tooltip.
13316 * @param item list item with tooltip already set.
13317 * @return style the theme style in use, defaults to "default". If the
13318 * object does not have a tooltip set, then NULL is returned.
13320 * @see elm_object_tooltip_style_get() for more details.
13321 * @see elm_list_item_tooltip_style_set()
13325 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13328 * Set the type of mouse pointer/cursor decoration to be shown,
13329 * when the mouse pointer is over the given list widget item
13331 * @param item list item to customize cursor on
13332 * @param cursor the cursor type's name
13334 * This function works analogously as elm_object_cursor_set(), but
13335 * here the cursor's changing area is restricted to the item's
13336 * area, and not the whole widget's. Note that that item cursors
13337 * have precedence over widget cursors, so that a mouse over an
13338 * item with custom cursor set will always show @b that cursor.
13340 * If this function is called twice for an object, a previously set
13341 * cursor will be unset on the second call.
13343 * @see elm_object_cursor_set()
13344 * @see elm_list_item_cursor_get()
13345 * @see elm_list_item_cursor_unset()
13349 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13352 * Get the type of mouse pointer/cursor decoration set to be shown,
13353 * when the mouse pointer is over the given list widget item
13355 * @param item list item with custom cursor set
13356 * @return the cursor type's name or @c NULL, if no custom cursors
13357 * were set to @p item (and on errors)
13359 * @see elm_object_cursor_get()
13360 * @see elm_list_item_cursor_set()
13361 * @see elm_list_item_cursor_unset()
13365 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13368 * Unset any custom mouse pointer/cursor decoration set to be
13369 * shown, when the mouse pointer is over the given list widget
13370 * item, thus making it show the @b default cursor again.
13372 * @param item a list item
13374 * Use this call to undo any custom settings on this item's cursor
13375 * decoration, bringing it back to defaults (no custom style set).
13377 * @see elm_object_cursor_unset()
13378 * @see elm_list_item_cursor_set()
13382 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13385 * Set a different @b style for a given custom cursor set for a
13388 * @param item list item with custom cursor set
13389 * @param style the <b>theme style</b> to use (e.g. @c "default",
13390 * @c "transparent", etc)
13392 * This function only makes sense when one is using custom mouse
13393 * cursor decorations <b>defined in a theme file</b>, which can have,
13394 * given a cursor name/type, <b>alternate styles</b> on it. It
13395 * works analogously as elm_object_cursor_style_set(), but here
13396 * applyed only to list item objects.
13398 * @warning Before you set a cursor style you should have definen a
13399 * custom cursor previously on the item, with
13400 * elm_list_item_cursor_set()
13402 * @see elm_list_item_cursor_engine_only_set()
13403 * @see elm_list_item_cursor_style_get()
13407 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13410 * Get the current @b style set for a given list item's custom
13413 * @param item list item with custom cursor set.
13414 * @return style the cursor style in use. If the object does not
13415 * have a cursor set, then @c NULL is returned.
13417 * @see elm_list_item_cursor_style_set() for more details
13421 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13424 * Set if the (custom)cursor for a given list item should be
13425 * searched in its theme, also, or should only rely on the
13426 * rendering engine.
13428 * @param item item with custom (custom) cursor already set on
13429 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13430 * only on those provided by the rendering engine, @c EINA_FALSE to
13431 * have them searched on the widget's theme, as well.
13433 * @note This call is of use only if you've set a custom cursor
13434 * for list items, with elm_list_item_cursor_set().
13436 * @note By default, cursors will only be looked for between those
13437 * provided by the rendering engine.
13441 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13444 * Get if the (custom) cursor for a given list item is being
13445 * searched in its theme, also, or is only relying on the rendering
13448 * @param item a list item
13449 * @return @c EINA_TRUE, if cursors are being looked for only on
13450 * those provided by the rendering engine, @c EINA_FALSE if they
13451 * are being searched on the widget's theme, as well.
13453 * @see elm_list_item_cursor_engine_only_set(), for more details
13457 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13464 * @defgroup Slider Slider
13465 * @ingroup Elementary
13467 * @image html img/widget/slider/preview-00.png
13468 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13470 * The slider adds a dragable “slider” widget for selecting the value of
13471 * something within a range.
13473 * A slider can be horizontal or vertical. It can contain an Icon and has a
13474 * primary label as well as a units label (that is formatted with floating
13475 * point values and thus accepts a printf-style format string, like
13476 * “%1.2f units”. There is also an indicator string that may be somewhere
13477 * else (like on the slider itself) that also accepts a format string like
13478 * units. Label, Icon Unit and Indicator strings/objects are optional.
13480 * A slider may be inverted which means values invert, with high vales being
13481 * on the left or top and low values on the right or bottom (as opposed to
13482 * normally being low on the left or top and high on the bottom and right).
13484 * The slider should have its minimum and maximum values set by the
13485 * application with elm_slider_min_max_set() and value should also be set by
13486 * the application before use with elm_slider_value_set(). The span of the
13487 * slider is its length (horizontally or vertically). This will be scaled by
13488 * the object or applications scaling factor. At any point code can query the
13489 * slider for its value with elm_slider_value_get().
13491 * Smart callbacks one can listen to:
13492 * - "changed" - Whenever the slider value is changed by the user.
13493 * - "slider,drag,start" - dragging the slider indicator around has started.
13494 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13495 * - "delay,changed" - A short time after the value is changed by the user.
13496 * This will be called only when the user stops dragging for
13497 * a very short period or when they release their
13498 * finger/mouse, so it avoids possibly expensive reactions to
13499 * the value change.
13501 * Available styles for it:
13504 * Here is an example on its usage:
13505 * @li @ref slider_example
13509 * @addtogroup Slider
13514 * Add a new slider widget to the given parent Elementary
13515 * (container) object.
13517 * @param parent The parent object.
13518 * @return a new slider widget handle or @c NULL, on errors.
13520 * This function inserts a new slider widget on the canvas.
13524 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13527 * Set the label of a given slider widget
13529 * @param obj The progress bar object
13530 * @param label The text label string, in UTF-8
13533 * @deprecated use elm_object_text_set() instead.
13535 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13538 * Get the label of a given slider widget
13540 * @param obj The progressbar object
13541 * @return The text label string, in UTF-8
13544 * @deprecated use elm_object_text_get() instead.
13546 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13549 * Set the icon object of the slider object.
13551 * @param obj The slider object.
13552 * @param icon The icon object.
13554 * On horizontal mode, icon is placed at left, and on vertical mode,
13557 * @note Once the icon object is set, a previously set one will be deleted.
13558 * If you want to keep that old content object, use the
13559 * elm_slider_icon_unset() function.
13561 * @warning If the object being set does not have minimum size hints set,
13562 * it won't get properly displayed.
13566 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13569 * Unset an icon set on a given slider widget.
13571 * @param obj The slider object.
13572 * @return The icon object that was being used, if any was set, or
13573 * @c NULL, otherwise (and on errors).
13575 * On horizontal mode, icon is placed at left, and on vertical mode,
13578 * This call will unparent and return the icon object which was set
13579 * for this widget, previously, on success.
13581 * @see elm_slider_icon_set() for more details
13582 * @see elm_slider_icon_get()
13586 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13589 * Retrieve the icon object set for a given slider widget.
13591 * @param obj The slider object.
13592 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13593 * otherwise (and on errors).
13595 * On horizontal mode, icon is placed at left, and on vertical mode,
13598 * @see elm_slider_icon_set() for more details
13599 * @see elm_slider_icon_unset()
13603 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13606 * Set the end object of the slider object.
13608 * @param obj The slider object.
13609 * @param end The end object.
13611 * On horizontal mode, end is placed at left, and on vertical mode,
13612 * placed at bottom.
13614 * @note Once the icon object is set, a previously set one will be deleted.
13615 * If you want to keep that old content object, use the
13616 * elm_slider_end_unset() function.
13618 * @warning If the object being set does not have minimum size hints set,
13619 * it won't get properly displayed.
13623 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13626 * Unset an end object set on a given slider widget.
13628 * @param obj The slider object.
13629 * @return The end object that was being used, if any was set, or
13630 * @c NULL, otherwise (and on errors).
13632 * On horizontal mode, end is placed at left, and on vertical mode,
13633 * placed at bottom.
13635 * This call will unparent and return the icon object which was set
13636 * for this widget, previously, on success.
13638 * @see elm_slider_end_set() for more details.
13639 * @see elm_slider_end_get()
13643 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13646 * Retrieve the end object set for a given slider widget.
13648 * @param obj The slider object.
13649 * @return The end object's handle, if @p obj had one set, or @c NULL,
13650 * otherwise (and on errors).
13652 * On horizontal mode, icon is placed at right, and on vertical mode,
13653 * placed at bottom.
13655 * @see elm_slider_end_set() for more details.
13656 * @see elm_slider_end_unset()
13660 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13663 * Set the (exact) length of the bar region of a given slider widget.
13665 * @param obj The slider object.
13666 * @param size The length of the slider's bar region.
13668 * This sets the minimum width (when in horizontal mode) or height
13669 * (when in vertical mode) of the actual bar area of the slider
13670 * @p obj. This in turn affects the object's minimum size. Use
13671 * this when you're not setting other size hints expanding on the
13672 * given direction (like weight and alignment hints) and you would
13673 * like it to have a specific size.
13675 * @note Icon, end, label, indicator and unit text around @p obj
13676 * will require their
13677 * own space, which will make @p obj to require more the @p size,
13680 * @see elm_slider_span_size_get()
13684 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13687 * Get the length set for the bar region of a given slider widget
13689 * @param obj The slider object.
13690 * @return The length of the slider's bar region.
13692 * If that size was not set previously, with
13693 * elm_slider_span_size_set(), this call will return @c 0.
13697 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13700 * Set the format string for the unit label.
13702 * @param obj The slider object.
13703 * @param format The format string for the unit display.
13705 * Unit label is displayed all the time, if set, after slider's bar.
13706 * In horizontal mode, at right and in vertical mode, at bottom.
13708 * If @c NULL, unit label won't be visible. If not it sets the format
13709 * string for the label text. To the label text is provided a floating point
13710 * value, so the label text can display up to 1 floating point value.
13711 * Note that this is optional.
13713 * Use a format string such as "%1.2f meters" for example, and it will
13714 * display values like: "3.14 meters" for a value equal to 3.14159.
13716 * Default is unit label disabled.
13718 * @see elm_slider_indicator_format_get()
13722 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13725 * Get the unit label format of the slider.
13727 * @param obj The slider object.
13728 * @return The unit label format string in UTF-8.
13730 * Unit label is displayed all the time, if set, after slider's bar.
13731 * In horizontal mode, at right and in vertical mode, at bottom.
13733 * @see elm_slider_unit_format_set() for more
13734 * information on how this works.
13738 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13741 * Set the format string for the indicator label.
13743 * @param obj The slider object.
13744 * @param indicator The format string for the indicator display.
13746 * The slider may display its value somewhere else then unit label,
13747 * for example, above the slider knob that is dragged around. This function
13748 * sets the format string used for this.
13750 * If @c NULL, indicator label won't be visible. If not it sets the format
13751 * string for the label text. To the label text is provided a floating point
13752 * value, so the label text can display up to 1 floating point value.
13753 * Note that this is optional.
13755 * Use a format string such as "%1.2f meters" for example, and it will
13756 * display values like: "3.14 meters" for a value equal to 3.14159.
13758 * Default is indicator label disabled.
13760 * @see elm_slider_indicator_format_get()
13764 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13767 * Get the indicator label format of the slider.
13769 * @param obj The slider object.
13770 * @return The indicator label format string in UTF-8.
13772 * The slider may display its value somewhere else then unit label,
13773 * for example, above the slider knob that is dragged around. This function
13774 * gets the format string used for this.
13776 * @see elm_slider_indicator_format_set() for more
13777 * information on how this works.
13781 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13784 * Set the format function pointer for the indicator label
13786 * @param obj The slider object.
13787 * @param func The indicator format function.
13788 * @param free_func The freeing function for the format string.
13790 * Set the callback function to format the indicator string.
13792 * @see elm_slider_indicator_format_set() for more info on how this works.
13796 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);
13799 * Set the format function pointer for the units label
13801 * @param obj The slider object.
13802 * @param func The units format function.
13803 * @param free_func The freeing function for the format string.
13805 * Set the callback function to format the indicator string.
13807 * @see elm_slider_units_format_set() for more info on how this works.
13811 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);
13814 * Set the orientation of a given slider widget.
13816 * @param obj The slider object.
13817 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13818 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13820 * Use this function to change how your slider is to be
13821 * disposed: vertically or horizontally.
13823 * By default it's displayed horizontally.
13825 * @see elm_slider_horizontal_get()
13829 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13832 * Retrieve the orientation of a given slider widget
13834 * @param obj The slider object.
13835 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13836 * @c EINA_FALSE if it's @b vertical (and on errors).
13838 * @see elm_slider_horizontal_set() for more details.
13842 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13845 * Set the minimum and maximum values for the slider.
13847 * @param obj The slider object.
13848 * @param min The minimum value.
13849 * @param max The maximum value.
13851 * Define the allowed range of values to be selected by the user.
13853 * If actual value is less than @p min, it will be updated to @p min. If it
13854 * is bigger then @p max, will be updated to @p max. Actual value can be
13855 * get with elm_slider_value_get().
13857 * By default, min is equal to 0.0, and max is equal to 1.0.
13859 * @warning Maximum must be greater than minimum, otherwise behavior
13862 * @see elm_slider_min_max_get()
13866 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13869 * Get the minimum and maximum values of the slider.
13871 * @param obj The slider object.
13872 * @param min Pointer where to store the minimum value.
13873 * @param max Pointer where to store the maximum value.
13875 * @note If only one value is needed, the other pointer can be passed
13878 * @see elm_slider_min_max_set() for details.
13882 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13885 * Set the value the slider displays.
13887 * @param obj The slider object.
13888 * @param val The value to be displayed.
13890 * Value will be presented on the unit label following format specified with
13891 * elm_slider_unit_format_set() and on indicator with
13892 * elm_slider_indicator_format_set().
13894 * @warning The value must to be between min and max values. This values
13895 * are set by elm_slider_min_max_set().
13897 * @see elm_slider_value_get()
13898 * @see elm_slider_unit_format_set()
13899 * @see elm_slider_indicator_format_set()
13900 * @see elm_slider_min_max_set()
13904 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13907 * Get the value displayed by the spinner.
13909 * @param obj The spinner object.
13910 * @return The value displayed.
13912 * @see elm_spinner_value_set() for details.
13916 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13919 * Invert a given slider widget's displaying values order
13921 * @param obj The slider object.
13922 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13923 * @c EINA_FALSE to bring it back to default, non-inverted values.
13925 * A slider may be @b inverted, in which state it gets its
13926 * values inverted, with high vales being on the left or top and
13927 * low values on the right or bottom, as opposed to normally have
13928 * the low values on the former and high values on the latter,
13929 * respectively, for horizontal and vertical modes.
13931 * @see elm_slider_inverted_get()
13935 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13938 * Get whether a given slider widget's displaying values are
13941 * @param obj The slider object.
13942 * @return @c EINA_TRUE, if @p obj has inverted values,
13943 * @c EINA_FALSE otherwise (and on errors).
13945 * @see elm_slider_inverted_set() for more details.
13949 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13952 * Set whether to enlarge slider indicator (augmented knob) or not.
13954 * @param obj The slider object.
13955 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13956 * let the knob always at default size.
13958 * By default, indicator will be bigger while dragged by the user.
13960 * @warning It won't display values set with
13961 * elm_slider_indicator_format_set() if you disable indicator.
13965 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13968 * Get whether a given slider widget's enlarging indicator or not.
13970 * @param obj The slider object.
13971 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13972 * @c EINA_FALSE otherwise (and on errors).
13974 * @see elm_slider_indicator_show_set() for details.
13978 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13985 * @addtogroup Actionslider Actionslider
13987 * @image html img/widget/actionslider/preview-00.png
13988 * @image latex img/widget/actionslider/preview-00.eps
13990 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13991 * properties. The indicator is the element the user drags to choose a label.
13992 * When the position is set with magnet, when released the indicator will be
13993 * moved to it if it's nearest the magnetized position.
13995 * @note By default all positions are set as enabled.
13997 * Signals that you can add callbacks for are:
13999 * "selected" - when user selects an enabled position (the label is passed
14002 * "pos_changed" - when the indicator reaches any of the positions("left",
14003 * "right" or "center").
14005 * See an example of actionslider usage @ref actionslider_example_page "here"
14008 typedef enum _Elm_Actionslider_Pos
14010 ELM_ACTIONSLIDER_NONE = 0,
14011 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14012 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14013 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14014 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14015 } Elm_Actionslider_Pos;
14018 * Add a new actionslider to the parent.
14020 * @param parent The parent object
14021 * @return The new actionslider object or NULL if it cannot be created
14023 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14025 * Set actionslider labels.
14027 * @param obj The actionslider object
14028 * @param left_label The label to be set on the left.
14029 * @param center_label The label to be set on the center.
14030 * @param right_label The label to be set on the right.
14031 * @deprecated use elm_object_text_set() instead.
14033 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);
14035 * Get actionslider labels.
14037 * @param obj The actionslider object
14038 * @param left_label A char** to place the left_label of @p obj into.
14039 * @param center_label A char** to place the center_label of @p obj into.
14040 * @param right_label A char** to place the right_label of @p obj into.
14041 * @deprecated use elm_object_text_set() instead.
14043 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);
14045 * Get actionslider selected label.
14047 * @param obj The actionslider object
14048 * @return The selected label
14050 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14052 * Set actionslider indicator position.
14054 * @param obj The actionslider object.
14055 * @param pos The position of the indicator.
14057 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14059 * Get actionslider indicator position.
14061 * @param obj The actionslider object.
14062 * @return The position of the indicator.
14064 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14066 * Set actionslider magnet position. To make multiple positions magnets @c or
14067 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14069 * @param obj The actionslider object.
14070 * @param pos Bit mask indicating the magnet positions.
14072 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14074 * Get actionslider magnet position.
14076 * @param obj The actionslider object.
14077 * @return The positions with magnet property.
14079 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14081 * Set actionslider enabled position. To set multiple positions as enabled @c or
14082 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14084 * @note All the positions are enabled by default.
14086 * @param obj The actionslider object.
14087 * @param pos Bit mask indicating the enabled positions.
14089 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14091 * Get actionslider enabled position.
14093 * @param obj The actionslider object.
14094 * @return The enabled positions.
14096 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14098 * Set the label used on the indicator.
14100 * @param obj The actionslider object
14101 * @param label The label to be set on the indicator.
14102 * @deprecated use elm_object_text_set() instead.
14104 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14106 * Get the label used on the indicator object.
14108 * @param obj The actionslider object
14109 * @return The indicator label
14110 * @deprecated use elm_object_text_get() instead.
14112 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14118 * @defgroup Genlist Genlist
14120 * @image html img/widget/genlist/preview-00.png
14121 * @image latex img/widget/genlist/preview-00.eps
14122 * @image html img/genlist.png
14123 * @image latex img/genlist.eps
14125 * This widget aims to have more expansive list than the simple list in
14126 * Elementary that could have more flexible items and allow many more entries
14127 * while still being fast and low on memory usage. At the same time it was
14128 * also made to be able to do tree structures. But the price to pay is more
14129 * complexity when it comes to usage. If all you want is a simple list with
14130 * icons and a single label, use the normal @ref List object.
14132 * Genlist has a fairly large API, mostly because it's relatively complex,
14133 * trying to be both expansive, powerful and efficient. First we will begin
14134 * an overview on the theory behind genlist.
14136 * @section Genlist_Item_Class Genlist item classes - creating items
14138 * In order to have the ability to add and delete items on the fly, genlist
14139 * implements a class (callback) system where the application provides a
14140 * structure with information about that type of item (genlist may contain
14141 * multiple different items with different classes, states and styles).
14142 * Genlist will call the functions in this struct (methods) when an item is
14143 * "realized" (i.e., created dynamically, while the user is scrolling the
14144 * grid). All objects will simply be deleted when no longer needed with
14145 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14146 * following members:
14147 * - @c item_style - This is a constant string and simply defines the name
14148 * of the item style. It @b must be specified and the default should be @c
14150 * - @c mode_item_style - This is a constant string and simply defines the
14151 * name of the style that will be used for mode animations. It can be left
14152 * as @c NULL if you don't plan to use Genlist mode. See
14153 * elm_genlist_item_mode_set() for more info.
14155 * - @c func - A struct with pointers to functions that will be called when
14156 * an item is going to be actually created. All of them receive a @c data
14157 * parameter that will point to the same data passed to
14158 * elm_genlist_item_append() and related item creation functions, and a @c
14159 * obj parameter that points to the genlist object itself.
14161 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14162 * state_get and @c del. The 3 first functions also receive a @c part
14163 * parameter described below. A brief description of these functions follows:
14165 * - @c label_get - The @c part parameter is the name string of one of the
14166 * existing text parts in the Edje group implementing the item's theme.
14167 * This function @b must return a strdup'()ed string, as the caller will
14168 * free() it when done. See #GenlistItemLabelGetFunc.
14169 * - @c icon_get - The @c part parameter is the name string of one of the
14170 * existing (icon) swallow parts in the Edje group implementing the item's
14171 * theme. It must return @c NULL, when no icon is desired, or a valid
14172 * object handle, otherwise. The object will be deleted by the genlist on
14173 * its deletion or when the item is "unrealized". See
14174 * #GenlistItemIconGetFunc.
14175 * - @c func.state_get - The @c part parameter is the name string of one of
14176 * the state parts in the Edje group implementing the item's theme. Return
14177 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14178 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14179 * and @c "elm" as "emission" and "source" arguments, respectively, when
14180 * the state is true (the default is false), where @c XXX is the name of
14181 * the (state) part. See #GenlistItemStateGetFunc.
14182 * - @c func.del - This is intended for use when genlist items are deleted,
14183 * so any data attached to the item (e.g. its data parameter on creation)
14184 * can be deleted. See #GenlistItemDelFunc.
14186 * available item styles:
14188 * - default_style - The text part is a textblock
14190 * @image html img/widget/genlist/preview-04.png
14191 * @image latex img/widget/genlist/preview-04.eps
14195 * @image html img/widget/genlist/preview-01.png
14196 * @image latex img/widget/genlist/preview-01.eps
14198 * - icon_top_text_bottom
14200 * @image html img/widget/genlist/preview-02.png
14201 * @image latex img/widget/genlist/preview-02.eps
14205 * @image html img/widget/genlist/preview-03.png
14206 * @image latex img/widget/genlist/preview-03.eps
14208 * @section Genlist_Items Structure of items
14210 * An item in a genlist can have 0 or more text labels (they can be regular
14211 * text or textblock Evas objects - that's up to the style to determine), 0
14212 * or more icons (which are simply objects swallowed into the genlist item's
14213 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14214 * behavior left to the user to define. The Edje part names for each of
14215 * these properties will be looked up, in the theme file for the genlist,
14216 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14217 * "states", respectively. For each of those properties, if more than one
14218 * part is provided, they must have names listed separated by spaces in the
14219 * data fields. For the default genlist item theme, we have @b one label
14220 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14221 * "elm.swallow.end") and @b no state parts.
14223 * A genlist item may be at one of several styles. Elementary provides one
14224 * by default - "default", but this can be extended by system or application
14225 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14228 * @section Genlist_Manipulation Editing and Navigating
14230 * Items can be added by several calls. All of them return a @ref
14231 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14232 * They all take a data parameter that is meant to be used for a handle to
14233 * the applications internal data (eg the struct with the original item
14234 * data). The parent parameter is the parent genlist item this belongs to if
14235 * it is a tree or an indexed group, and NULL if there is no parent. The
14236 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14237 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14238 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14239 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14240 * is set then this item is group index item that is displayed at the top
14241 * until the next group comes. The func parameter is a convenience callback
14242 * that is called when the item is selected and the data parameter will be
14243 * the func_data parameter, obj be the genlist object and event_info will be
14244 * the genlist item.
14246 * elm_genlist_item_append() adds an item to the end of the list, or if
14247 * there is a parent, to the end of all the child items of the parent.
14248 * elm_genlist_item_prepend() is the same but adds to the beginning of
14249 * the list or children list. elm_genlist_item_insert_before() inserts at
14250 * item before another item and elm_genlist_item_insert_after() inserts after
14251 * the indicated item.
14253 * The application can clear the list with elm_genlist_clear() which deletes
14254 * all the items in the list and elm_genlist_item_del() will delete a specific
14255 * item. elm_genlist_item_subitems_clear() will clear all items that are
14256 * children of the indicated parent item.
14258 * To help inspect list items you can jump to the item at the top of the list
14259 * with elm_genlist_first_item_get() which will return the item pointer, and
14260 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14261 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14262 * and previous items respectively relative to the indicated item. Using
14263 * these calls you can walk the entire item list/tree. Note that as a tree
14264 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14265 * let you know which item is the parent (and thus know how to skip them if
14268 * @section Genlist_Muti_Selection Multi-selection
14270 * If the application wants multiple items to be able to be selected,
14271 * elm_genlist_multi_select_set() can enable this. If the list is
14272 * single-selection only (the default), then elm_genlist_selected_item_get()
14273 * will return the selected item, if any, or NULL I none is selected. If the
14274 * list is multi-select then elm_genlist_selected_items_get() will return a
14275 * list (that is only valid as long as no items are modified (added, deleted,
14276 * selected or unselected)).
14278 * @section Genlist_Usage_Hints Usage hints
14280 * There are also convenience functions. elm_genlist_item_genlist_get() will
14281 * return the genlist object the item belongs to. elm_genlist_item_show()
14282 * will make the scroller scroll to show that specific item so its visible.
14283 * elm_genlist_item_data_get() returns the data pointer set by the item
14284 * creation functions.
14286 * If an item changes (state of boolean changes, label or icons change),
14287 * then use elm_genlist_item_update() to have genlist update the item with
14288 * the new state. Genlist will re-realize the item thus call the functions
14289 * in the _Elm_Genlist_Item_Class for that item.
14291 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14292 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14293 * to expand/contract an item and get its expanded state, use
14294 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14295 * again to make an item disabled (unable to be selected and appear
14296 * differently) use elm_genlist_item_disabled_set() to set this and
14297 * elm_genlist_item_disabled_get() to get the disabled state.
14299 * In general to indicate how the genlist should expand items horizontally to
14300 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14301 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14302 * mode means that if items are too wide to fit, the scroller will scroll
14303 * horizontally. Otherwise items are expanded to fill the width of the
14304 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14305 * to the viewport width and limited to that size. This can be combined with
14306 * a different style that uses edjes' ellipsis feature (cutting text off like
14309 * Items will only call their selection func and callback when first becoming
14310 * selected. Any further clicks will do nothing, unless you enable always
14311 * select with elm_genlist_always_select_mode_set(). This means even if
14312 * selected, every click will make the selected callbacks be called.
14313 * elm_genlist_no_select_mode_set() will turn off the ability to select
14314 * items entirely and they will neither appear selected nor call selected
14315 * callback functions.
14317 * Remember that you can create new styles and add your own theme augmentation
14318 * per application with elm_theme_extension_add(). If you absolutely must
14319 * have a specific style that overrides any theme the user or system sets up
14320 * you can use elm_theme_overlay_add() to add such a file.
14322 * @section Genlist_Implementation Implementation
14324 * Evas tracks every object you create. Every time it processes an event
14325 * (mouse move, down, up etc.) it needs to walk through objects and find out
14326 * what event that affects. Even worse every time it renders display updates,
14327 * in order to just calculate what to re-draw, it needs to walk through many
14328 * many many objects. Thus, the more objects you keep active, the more
14329 * overhead Evas has in just doing its work. It is advisable to keep your
14330 * active objects to the minimum working set you need. Also remember that
14331 * object creation and deletion carries an overhead, so there is a
14332 * middle-ground, which is not easily determined. But don't keep massive lists
14333 * of objects you can't see or use. Genlist does this with list objects. It
14334 * creates and destroys them dynamically as you scroll around. It groups them
14335 * into blocks so it can determine the visibility etc. of a whole block at
14336 * once as opposed to having to walk the whole list. This 2-level list allows
14337 * for very large numbers of items to be in the list (tests have used up to
14338 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14339 * may be different sizes, every item added needs to be calculated as to its
14340 * size and thus this presents a lot of overhead on populating the list, this
14341 * genlist employs a queue. Any item added is queued and spooled off over
14342 * time, actually appearing some time later, so if your list has many members
14343 * you may find it takes a while for them to all appear, with your process
14344 * consuming a lot of CPU while it is busy spooling.
14346 * Genlist also implements a tree structure, but it does so with callbacks to
14347 * the application, with the application filling in tree structures when
14348 * requested (allowing for efficient building of a very deep tree that could
14349 * even be used for file-management). See the above smart signal callbacks for
14352 * @section Genlist_Smart_Events Genlist smart events
14354 * Signals that you can add callbacks for are:
14355 * - @c "activated" - The user has double-clicked or pressed
14356 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14357 * item that was activated.
14358 * - @c "clicked,double" - The user has double-clicked an item. The @c
14359 * event_info parameter is the item that was double-clicked.
14360 * - @c "selected" - This is called when a user has made an item selected.
14361 * The event_info parameter is the genlist item that was selected.
14362 * - @c "unselected" - This is called when a user has made an item
14363 * unselected. The event_info parameter is the genlist item that was
14365 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14366 * called and the item is now meant to be expanded. The event_info
14367 * parameter is the genlist item that was indicated to expand. It is the
14368 * job of this callback to then fill in the child items.
14369 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14370 * called and the item is now meant to be contracted. The event_info
14371 * parameter is the genlist item that was indicated to contract. It is the
14372 * job of this callback to then delete the child items.
14373 * - @c "expand,request" - This is called when a user has indicated they want
14374 * to expand a tree branch item. The callback should decide if the item can
14375 * expand (has any children) and then call elm_genlist_item_expanded_set()
14376 * appropriately to set the state. The event_info parameter is the genlist
14377 * item that was indicated to expand.
14378 * - @c "contract,request" - This is called when a user has indicated they
14379 * want to contract a tree branch item. The callback should decide if the
14380 * item can contract (has any children) and then call
14381 * elm_genlist_item_expanded_set() appropriately to set the state. The
14382 * event_info parameter is the genlist item that was indicated to contract.
14383 * - @c "realized" - This is called when the item in the list is created as a
14384 * real evas object. event_info parameter is the genlist item that was
14385 * created. The object may be deleted at any time, so it is up to the
14386 * caller to not use the object pointer from elm_genlist_item_object_get()
14387 * in a way where it may point to freed objects.
14388 * - @c "unrealized" - This is called just before an item is unrealized.
14389 * After this call icon objects provided will be deleted and the item
14390 * object itself delete or be put into a floating cache.
14391 * - @c "drag,start,up" - This is called when the item in the list has been
14392 * dragged (not scrolled) up.
14393 * - @c "drag,start,down" - This is called when the item in the list has been
14394 * dragged (not scrolled) down.
14395 * - @c "drag,start,left" - This is called when the item in the list has been
14396 * dragged (not scrolled) left.
14397 * - @c "drag,start,right" - This is called when the item in the list has
14398 * been dragged (not scrolled) right.
14399 * - @c "drag,stop" - This is called when the item in the list has stopped
14401 * - @c "drag" - This is called when the item in the list is being dragged.
14402 * - @c "longpressed" - This is called when the item is pressed for a certain
14403 * amount of time. By default it's 1 second.
14404 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14406 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14407 * until the bottom edge.
14408 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14409 * until the left edge.
14410 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14411 * until the right edge.
14412 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14414 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14416 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14418 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14420 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14421 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14422 * multi-touch pinched in.
14423 * - @c "swipe" - This is called when the genlist is swiped.
14425 * @section Genlist_Examples Examples
14427 * Here is a list of examples that use the genlist, trying to show some of
14428 * its capabilities:
14429 * - @ref genlist_example_01
14430 * - @ref genlist_example_02
14431 * - @ref genlist_example_03
14432 * - @ref genlist_example_04
14433 * - @ref genlist_example_05
14437 * @addtogroup Genlist
14442 * @enum _Elm_Genlist_Item_Flags
14443 * @typedef Elm_Genlist_Item_Flags
14445 * Defines if the item is of any special type (has subitems or it's the
14446 * index of a group), or is just a simple item.
14450 typedef enum _Elm_Genlist_Item_Flags
14452 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14453 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14454 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14455 } Elm_Genlist_Item_Flags;
14456 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14457 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14458 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14459 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14460 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14461 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14462 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14463 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14466 * @struct _Elm_Genlist_Item_Class
14468 * Genlist item class definition structs.
14470 * This struct contains the style and fetching functions that will define the
14471 * contents of each item.
14473 * @see @ref Genlist_Item_Class
14475 struct _Elm_Genlist_Item_Class
14477 const char *item_style; /**< style of this class. */
14480 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14481 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14482 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14483 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14484 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14486 const char *mode_item_style;
14490 * Add a new genlist widget to the given parent Elementary
14491 * (container) object
14493 * @param parent The parent object
14494 * @return a new genlist widget handle or @c NULL, on errors
14496 * This function inserts a new genlist widget on the canvas.
14498 * @see elm_genlist_item_append()
14499 * @see elm_genlist_item_del()
14500 * @see elm_genlist_clear()
14504 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14506 * Remove all items from a given genlist widget.
14508 * @param obj The genlist object
14510 * This removes (and deletes) all items in @p obj, leaving it empty.
14512 * @see elm_genlist_item_del(), to remove just one item.
14516 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14518 * Enable or disable multi-selection in the genlist
14520 * @param obj The genlist object
14521 * @param multi Multi-select enable/disable. Default is disabled.
14523 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14524 * the list. This allows more than 1 item to be selected. To retrieve the list
14525 * of selected items, use elm_genlist_selected_items_get().
14527 * @see elm_genlist_selected_items_get()
14528 * @see elm_genlist_multi_select_get()
14532 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14534 * Gets if multi-selection in genlist is enabled or disabled.
14536 * @param obj The genlist object
14537 * @return Multi-select enabled/disabled
14538 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14540 * @see elm_genlist_multi_select_set()
14544 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14546 * This sets the horizontal stretching mode.
14548 * @param obj The genlist object
14549 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14551 * This sets the mode used for sizing items horizontally. Valid modes
14552 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14553 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14554 * the scroller will scroll horizontally. Otherwise items are expanded
14555 * to fill the width of the viewport of the scroller. If it is
14556 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14557 * limited to that size.
14559 * @see elm_genlist_horizontal_get()
14563 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14564 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14566 * Gets the horizontal stretching mode.
14568 * @param obj The genlist object
14569 * @return The mode to use
14570 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14572 * @see elm_genlist_horizontal_set()
14576 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14577 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14579 * Set the always select mode.
14581 * @param obj The genlist object
14582 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14583 * EINA_FALSE = off). Default is @c EINA_FALSE.
14585 * Items will only call their selection func and callback when first
14586 * becoming selected. Any further clicks will do nothing, unless you
14587 * enable always select with elm_genlist_always_select_mode_set().
14588 * This means that, even if selected, every click will make the selected
14589 * callbacks be called.
14591 * @see elm_genlist_always_select_mode_get()
14595 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14597 * Get the always select mode.
14599 * @param obj The genlist object
14600 * @return The always select mode
14601 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14603 * @see elm_genlist_always_select_mode_set()
14607 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14609 * Enable/disable the no select mode.
14611 * @param obj The genlist object
14612 * @param no_select The no select mode
14613 * (EINA_TRUE = on, EINA_FALSE = off)
14615 * This will turn off the ability to select items entirely and they
14616 * will neither appear selected nor call selected callback functions.
14618 * @see elm_genlist_no_select_mode_get()
14622 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14624 * Gets whether the no select mode is enabled.
14626 * @param obj The genlist object
14627 * @return The no select mode
14628 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14630 * @see elm_genlist_no_select_mode_set()
14634 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14636 * Enable/disable compress mode.
14638 * @param obj The genlist object
14639 * @param compress The compress mode
14640 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14642 * This will enable the compress mode where items are "compressed"
14643 * horizontally to fit the genlist scrollable viewport width. This is
14644 * special for genlist. Do not rely on
14645 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14646 * work as genlist needs to handle it specially.
14648 * @see elm_genlist_compress_mode_get()
14652 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14654 * Get whether the compress mode is enabled.
14656 * @param obj The genlist object
14657 * @return The compress mode
14658 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14660 * @see elm_genlist_compress_mode_set()
14664 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14666 * Enable/disable height-for-width mode.
14668 * @param obj The genlist object
14669 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14670 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14672 * With height-for-width mode the item width will be fixed (restricted
14673 * to a minimum of) to the list width when calculating its size in
14674 * order to allow the height to be calculated based on it. This allows,
14675 * for instance, text block to wrap lines if the Edje part is
14676 * configured with "text.min: 0 1".
14678 * @note This mode will make list resize slower as it will have to
14679 * recalculate every item height again whenever the list width
14682 * @note When height-for-width mode is enabled, it also enables
14683 * compress mode (see elm_genlist_compress_mode_set()) and
14684 * disables homogeneous (see elm_genlist_homogeneous_set()).
14688 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14690 * Get whether the height-for-width mode is enabled.
14692 * @param obj The genlist object
14693 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14698 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14700 * Enable/disable horizontal and vertical bouncing effect.
14702 * @param obj The genlist object
14703 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14704 * EINA_FALSE = off). Default is @c EINA_FALSE.
14705 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14706 * EINA_FALSE = off). Default is @c EINA_TRUE.
14708 * This will enable or disable the scroller bouncing effect for the
14709 * genlist. See elm_scroller_bounce_set() for details.
14711 * @see elm_scroller_bounce_set()
14712 * @see elm_genlist_bounce_get()
14716 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14718 * Get whether the horizontal and vertical bouncing effect is enabled.
14720 * @param obj The genlist object
14721 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14723 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14726 * @see elm_genlist_bounce_set()
14730 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14732 * Enable/disable homogenous mode.
14734 * @param obj The genlist object
14735 * @param homogeneous Assume the items within the genlist are of the
14736 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14739 * This will enable the homogeneous mode where items are of the same
14740 * height and width so that genlist may do the lazy-loading at its
14741 * maximum (which increases the performance for scrolling the list). This
14742 * implies 'compressed' mode.
14744 * @see elm_genlist_compress_mode_set()
14745 * @see elm_genlist_homogeneous_get()
14749 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14751 * Get whether the homogenous mode is enabled.
14753 * @param obj The genlist object
14754 * @return Assume the items within the genlist are of the same height
14755 * and width (EINA_TRUE = on, EINA_FALSE = off)
14757 * @see elm_genlist_homogeneous_set()
14761 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14763 * Set the maximum number of items within an item block
14765 * @param obj The genlist object
14766 * @param n Maximum number of items within an item block. Default is 32.
14768 * This will configure the block count to tune to the target with
14769 * particular performance matrix.
14771 * A block of objects will be used to reduce the number of operations due to
14772 * many objects in the screen. It can determine the visibility, or if the
14773 * object has changed, it theme needs to be updated, etc. doing this kind of
14774 * calculation to the entire block, instead of per object.
14776 * The default value for the block count is enough for most lists, so unless
14777 * you know you will have a lot of objects visible in the screen at the same
14778 * time, don't try to change this.
14780 * @see elm_genlist_block_count_get()
14781 * @see @ref Genlist_Implementation
14785 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14787 * Get the maximum number of items within an item block
14789 * @param obj The genlist object
14790 * @return Maximum number of items within an item block
14792 * @see elm_genlist_block_count_set()
14796 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14798 * Set the timeout in seconds for the longpress event.
14800 * @param obj The genlist object
14801 * @param timeout timeout in seconds. Default is 1.
14803 * This option will change how long it takes to send an event "longpressed"
14804 * after the mouse down signal is sent to the list. If this event occurs, no
14805 * "clicked" event will be sent.
14807 * @see elm_genlist_longpress_timeout_set()
14811 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14813 * Get the timeout in seconds for the longpress event.
14815 * @param obj The genlist object
14816 * @return timeout in seconds
14818 * @see elm_genlist_longpress_timeout_get()
14822 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14824 * Append a new item in a given genlist widget.
14826 * @param obj The genlist object
14827 * @param itc The item class for the item
14828 * @param data The item data
14829 * @param parent The parent item, or NULL if none
14830 * @param flags Item flags
14831 * @param func Convenience function called when the item is selected
14832 * @param func_data Data passed to @p func above.
14833 * @return A handle to the item added or @c NULL if not possible
14835 * This adds the given item to the end of the list or the end of
14836 * the children list if the @p parent is given.
14838 * @see elm_genlist_item_prepend()
14839 * @see elm_genlist_item_insert_before()
14840 * @see elm_genlist_item_insert_after()
14841 * @see elm_genlist_item_del()
14845 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);
14847 * Prepend a new item in a given genlist widget.
14849 * @param obj The genlist object
14850 * @param itc The item class for the item
14851 * @param data The item data
14852 * @param parent The parent item, or NULL if none
14853 * @param flags Item flags
14854 * @param func Convenience function called when the item is selected
14855 * @param func_data Data passed to @p func above.
14856 * @return A handle to the item added or NULL if not possible
14858 * This adds an item to the beginning of the list or beginning of the
14859 * children of the parent if given.
14861 * @see elm_genlist_item_append()
14862 * @see elm_genlist_item_insert_before()
14863 * @see elm_genlist_item_insert_after()
14864 * @see elm_genlist_item_del()
14868 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);
14870 * Insert an item before another in a genlist widget
14872 * @param obj The genlist object
14873 * @param itc The item class for the item
14874 * @param data The item data
14875 * @param before The item to place this new one before.
14876 * @param flags Item flags
14877 * @param func Convenience function called when the item is selected
14878 * @param func_data Data passed to @p func above.
14879 * @return A handle to the item added or @c NULL if not possible
14881 * This inserts an item before another in the list. It will be in the
14882 * same tree level or group as the item it is inserted before.
14884 * @see elm_genlist_item_append()
14885 * @see elm_genlist_item_prepend()
14886 * @see elm_genlist_item_insert_after()
14887 * @see elm_genlist_item_del()
14891 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);
14893 * Insert an item after another in a genlist widget
14895 * @param obj The genlist object
14896 * @param itc The item class for the item
14897 * @param data The item data
14898 * @param after The item to place this new one after.
14899 * @param flags Item flags
14900 * @param func Convenience function called when the item is selected
14901 * @param func_data Data passed to @p func above.
14902 * @return A handle to the item added or @c NULL if not possible
14904 * This inserts an item after another in the list. It will be in the
14905 * same tree level or group as the item it is inserted after.
14907 * @see elm_genlist_item_append()
14908 * @see elm_genlist_item_prepend()
14909 * @see elm_genlist_item_insert_before()
14910 * @see elm_genlist_item_del()
14914 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);
14916 * Insert a new item into the sorted genlist object
14918 * @param obj The genlist object
14919 * @param itc The item class for the item
14920 * @param data The item data
14921 * @param parent The parent item, or NULL if none
14922 * @param flags Item flags
14923 * @param comp The function called for the sort
14924 * @param func Convenience function called when item selected
14925 * @param func_data Data passed to @p func above.
14926 * @return A handle to the item added or NULL if not possible
14930 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);
14931 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);
14932 /* operations to retrieve existing items */
14934 * Get the selectd item in the genlist.
14936 * @param obj The genlist object
14937 * @return The selected item, or NULL if none is selected.
14939 * This gets the selected item in the list (if multi-selection is enabled, only
14940 * the item that was first selected in the list is returned - which is not very
14941 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14944 * If no item is selected, NULL is returned.
14946 * @see elm_genlist_selected_items_get()
14950 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14952 * Get a list of selected items in the genlist.
14954 * @param obj The genlist object
14955 * @return The list of selected items, or NULL if none are selected.
14957 * It returns a list of the selected items. This list pointer is only valid so
14958 * long as the selection doesn't change (no items are selected or unselected, or
14959 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14960 * pointers. The order of the items in this list is the order which they were
14961 * selected, i.e. the first item in this list is the first item that was
14962 * selected, and so on.
14964 * @note If not in multi-select mode, consider using function
14965 * elm_genlist_selected_item_get() instead.
14967 * @see elm_genlist_multi_select_set()
14968 * @see elm_genlist_selected_item_get()
14972 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14974 * Get a list of realized items in genlist
14976 * @param obj The genlist object
14977 * @return The list of realized items, nor NULL if none are realized.
14979 * This returns a list of the realized items in the genlist. The list
14980 * contains Elm_Genlist_Item pointers. The list must be freed by the
14981 * caller when done with eina_list_free(). The item pointers in the
14982 * list are only valid so long as those items are not deleted or the
14983 * genlist is not deleted.
14985 * @see elm_genlist_realized_items_update()
14989 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14991 * Get the item that is at the x, y canvas coords.
14993 * @param obj The gelinst object.
14994 * @param x The input x coordinate
14995 * @param y The input y coordinate
14996 * @param posret The position relative to the item returned here
14997 * @return The item at the coordinates or NULL if none
14999 * This returns the item at the given coordinates (which are canvas
15000 * relative, not object-relative). If an item is at that coordinate,
15001 * that item handle is returned, and if @p posret is not NULL, the
15002 * integer pointed to is set to a value of -1, 0 or 1, depending if
15003 * the coordinate is on the upper portion of that item (-1), on the
15004 * middle section (0) or on the lower part (1). If NULL is returned as
15005 * an item (no item found there), then posret may indicate -1 or 1
15006 * based if the coordinate is above or below all items respectively in
15011 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);
15013 * Get the first item in the genlist
15015 * This returns the first item in the list.
15017 * @param obj The genlist object
15018 * @return The first item, or NULL if none
15022 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15024 * Get the last item in the genlist
15026 * This returns the last item in the list.
15028 * @return The last item, or NULL if none
15032 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15034 * Set the scrollbar policy
15036 * @param obj The genlist object
15037 * @param policy_h Horizontal scrollbar policy.
15038 * @param policy_v Vertical scrollbar policy.
15040 * This sets the scrollbar visibility policy for the given genlist
15041 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15042 * made visible if it is needed, and otherwise kept hidden.
15043 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15044 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15045 * respectively for the horizontal and vertical scrollbars. Default is
15046 * #ELM_SMART_SCROLLER_POLICY_AUTO
15048 * @see elm_genlist_scroller_policy_get()
15052 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15054 * Get the scrollbar policy
15056 * @param obj The genlist object
15057 * @param policy_h Pointer to store the horizontal scrollbar policy.
15058 * @param policy_v Pointer to store the vertical scrollbar policy.
15060 * @see elm_genlist_scroller_policy_set()
15064 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);
15066 * Get the @b next item in a genlist widget's internal list of items,
15067 * given a handle to one of those items.
15069 * @param item The genlist item to fetch next from
15070 * @return The item after @p item, or @c NULL if there's none (and
15073 * This returns the item placed after the @p item, on the container
15076 * @see elm_genlist_item_prev_get()
15080 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15082 * Get the @b previous item in a genlist widget's internal list of items,
15083 * given a handle to one of those items.
15085 * @param item The genlist item to fetch previous from
15086 * @return The item before @p item, or @c NULL if there's none (and
15089 * This returns the item placed before the @p item, on the container
15092 * @see elm_genlist_item_next_get()
15096 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15098 * Get the genlist object's handle which contains a given genlist
15101 * @param item The item to fetch the container from
15102 * @return The genlist (parent) object
15104 * This returns the genlist object itself that an item belongs to.
15108 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15110 * Get the parent item of the given item
15112 * @param it The item
15113 * @return The parent of the item or @c NULL if it has no parent.
15115 * This returns the item that was specified as parent of the item @p it on
15116 * elm_genlist_item_append() and insertion related functions.
15120 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15122 * Remove all sub-items (children) of the given item
15124 * @param it The item
15126 * This removes all items that are children (and their descendants) of the
15127 * given item @p it.
15129 * @see elm_genlist_clear()
15130 * @see elm_genlist_item_del()
15134 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15136 * Set whether a given genlist item is selected or not
15138 * @param it The item
15139 * @param selected Use @c EINA_TRUE, to make it selected, @c
15140 * EINA_FALSE to make it unselected
15142 * This sets the selected state of an item. If multi selection is
15143 * not enabled on the containing genlist and @p selected is @c
15144 * EINA_TRUE, any other previously selected items will get
15145 * unselected in favor of this new one.
15147 * @see elm_genlist_item_selected_get()
15151 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15153 * Get whether a given genlist item is selected or not
15155 * @param it The item
15156 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15158 * @see elm_genlist_item_selected_set() for more details
15162 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15164 * Sets the expanded state of an item.
15166 * @param it The item
15167 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15169 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15172 * The theme will respond to this change visually, and a signal "expanded" or
15173 * "contracted" will be sent from the genlist with a pointer to the item that
15174 * has been expanded/contracted.
15176 * Calling this function won't show or hide any child of this item (if it is
15177 * a parent). You must manually delete and create them on the callbacks fo
15178 * the "expanded" or "contracted" signals.
15180 * @see elm_genlist_item_expanded_get()
15184 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15186 * Get the expanded state of an item
15188 * @param it The item
15189 * @return The expanded state
15191 * This gets the expanded state of an item.
15193 * @see elm_genlist_item_expanded_set()
15197 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15199 * Get the depth of expanded item
15201 * @param it The genlist item object
15202 * @return The depth of expanded item
15206 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15208 * Set whether a given genlist item is disabled or not.
15210 * @param it The item
15211 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15212 * to enable it back.
15214 * A disabled item cannot be selected or unselected. It will also
15215 * change its appearance, to signal the user it's disabled.
15217 * @see elm_genlist_item_disabled_get()
15221 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15223 * Get whether a given genlist item is disabled or not.
15225 * @param it The item
15226 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15229 * @see elm_genlist_item_disabled_set() for more details
15233 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15235 * Sets the display only state of an item.
15237 * @param it The item
15238 * @param display_only @c EINA_TRUE if the item is display only, @c
15239 * EINA_FALSE otherwise.
15241 * A display only item cannot be selected or unselected. It is for
15242 * display only and not selecting or otherwise clicking, dragging
15243 * etc. by the user, thus finger size rules will not be applied to
15246 * It's good to set group index items to display only state.
15248 * @see elm_genlist_item_display_only_get()
15252 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15254 * Get the display only state of an item
15256 * @param it The item
15257 * @return @c EINA_TRUE if the item is display only, @c
15258 * EINA_FALSE otherwise.
15260 * @see elm_genlist_item_display_only_set()
15264 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15266 * Show the portion of a genlist's internal list containing a given
15267 * item, immediately.
15269 * @param it The item to display
15271 * This causes genlist to jump to the given item @p it and show it (by
15272 * immediately scrolling to that position), if it is not fully visible.
15274 * @see elm_genlist_item_bring_in()
15275 * @see elm_genlist_item_top_show()
15276 * @see elm_genlist_item_middle_show()
15280 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15282 * Animatedly bring in, to the visible are of a genlist, a given
15285 * @param it The item to display
15287 * This causes genlist to jump to the given item @p it and show it (by
15288 * animatedly scrolling), if it is not fully visible. This may use animation
15289 * to do so and take a period of time
15291 * @see elm_genlist_item_show()
15292 * @see elm_genlist_item_top_bring_in()
15293 * @see elm_genlist_item_middle_bring_in()
15297 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15299 * Show the portion of a genlist's internal list containing a given
15300 * item, immediately.
15302 * @param it The item to display
15304 * This causes genlist to jump to the given item @p it and show it (by
15305 * immediately scrolling to that position), if it is not fully visible.
15307 * The item will be positioned at the top of the genlist viewport.
15309 * @see elm_genlist_item_show()
15310 * @see elm_genlist_item_top_bring_in()
15314 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15316 * Animatedly bring in, to the visible are of a genlist, a given
15319 * @param it The item
15321 * This causes genlist to jump to the given item @p it and show it (by
15322 * animatedly scrolling), if it is not fully visible. This may use animation
15323 * to do so and take a period of time
15325 * The item will be positioned at the top of the genlist viewport.
15327 * @see elm_genlist_item_bring_in()
15328 * @see elm_genlist_item_top_show()
15332 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15334 * Show the portion of a genlist's internal list containing a given
15335 * item, immediately.
15337 * @param it The item to display
15339 * This causes genlist to jump to the given item @p it and show it (by
15340 * immediately scrolling to that position), if it is not fully visible.
15342 * The item will be positioned at the middle of the genlist viewport.
15344 * @see elm_genlist_item_show()
15345 * @see elm_genlist_item_middle_bring_in()
15349 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15351 * Animatedly bring in, to the visible are of a genlist, a given
15354 * @param it The item
15356 * This causes genlist to jump to the given item @p it and show it (by
15357 * animatedly scrolling), if it is not fully visible. This may use animation
15358 * to do so and take a period of time
15360 * The item will be positioned at the middle of the genlist viewport.
15362 * @see elm_genlist_item_bring_in()
15363 * @see elm_genlist_item_middle_show()
15367 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15369 * Remove a genlist item from the its parent, deleting it.
15371 * @param item The item to be removed.
15372 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15374 * @see elm_genlist_clear(), to remove all items in a genlist at
15379 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15381 * Return the data associated to a given genlist item
15383 * @param item The genlist item.
15384 * @return the data associated to this item.
15386 * This returns the @c data value passed on the
15387 * elm_genlist_item_append() and related item addition calls.
15389 * @see elm_genlist_item_append()
15390 * @see elm_genlist_item_data_set()
15394 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15396 * Set the data associated to a given genlist item
15398 * @param item The genlist item
15399 * @param data The new data pointer to set on it
15401 * This @b overrides the @c data value passed on the
15402 * elm_genlist_item_append() and related item addition calls. This
15403 * function @b won't call elm_genlist_item_update() automatically,
15404 * so you'd issue it afterwards if you want to hove the item
15405 * updated to reflect the that new data.
15407 * @see elm_genlist_item_data_get()
15411 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15413 * Tells genlist to "orphan" icons fetchs by the item class
15415 * @param it The item
15417 * This instructs genlist to release references to icons in the item,
15418 * meaning that they will no longer be managed by genlist and are
15419 * floating "orphans" that can be re-used elsewhere if the user wants
15424 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15426 * Get the real Evas object created to implement the view of a
15427 * given genlist item
15429 * @param item The genlist item.
15430 * @return the Evas object implementing this item's view.
15432 * This returns the actual Evas object used to implement the
15433 * specified genlist item's view. This may be @c NULL, as it may
15434 * not have been created or may have been deleted, at any time, by
15435 * the genlist. <b>Do not modify this object</b> (move, resize,
15436 * show, hide, etc.), as the genlist is controlling it. This
15437 * function is for querying, emitting custom signals or hooking
15438 * lower level callbacks for events on that object. Do not delete
15439 * this object under any circumstances.
15441 * @see elm_genlist_item_data_get()
15445 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15447 * Update the contents of an item
15449 * @param it The item
15451 * This updates an item by calling all the item class functions again
15452 * to get the icons, labels and states. Use this when the original
15453 * item data has changed and the changes are desired to be reflected.
15455 * Use elm_genlist_realized_items_update() to update all already realized
15458 * @see elm_genlist_realized_items_update()
15462 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15464 * Update the item class of an item
15466 * @param it The item
15467 * @param itc The item class for the item
15469 * This sets another class fo the item, changing the way that it is
15470 * displayed. After changing the item class, elm_genlist_item_update() is
15471 * called on the item @p it.
15475 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15476 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15478 * Set the text to be shown in a given genlist item's tooltips.
15480 * @param item The genlist item
15481 * @param text The text to set in the content
15483 * This call will setup the text to be used as tooltip to that item
15484 * (analogous to elm_object_tooltip_text_set(), but being item
15485 * tooltips with higher precedence than object tooltips). It can
15486 * have only one tooltip at a time, so any previous tooltip data
15487 * will get removed.
15489 * In order to set an icon or something else as a tooltip, look at
15490 * elm_genlist_item_tooltip_content_cb_set().
15494 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15496 * Set the content to be shown in a given genlist item's tooltips
15498 * @param item The genlist item.
15499 * @param func The function returning the tooltip contents.
15500 * @param data What to provide to @a func as callback data/context.
15501 * @param del_cb Called when data is not needed anymore, either when
15502 * another callback replaces @p func, the tooltip is unset with
15503 * elm_genlist_item_tooltip_unset() or the owner @p item
15504 * dies. This callback receives as its first parameter the
15505 * given @p data, being @c event_info the item handle.
15507 * This call will setup the tooltip's contents to @p item
15508 * (analogous to elm_object_tooltip_content_cb_set(), but being
15509 * item tooltips with higher precedence than object tooltips). It
15510 * can have only one tooltip at a time, so any previous tooltip
15511 * content will get removed. @p func (with @p data) will be called
15512 * every time Elementary needs to show the tooltip and it should
15513 * return a valid Evas object, which will be fully managed by the
15514 * tooltip system, getting deleted when the tooltip is gone.
15516 * In order to set just a text as a tooltip, look at
15517 * elm_genlist_item_tooltip_text_set().
15521 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);
15523 * Unset a tooltip from a given genlist item
15525 * @param item genlist item to remove a previously set tooltip from.
15527 * This call removes any tooltip set on @p item. The callback
15528 * provided as @c del_cb to
15529 * elm_genlist_item_tooltip_content_cb_set() will be called to
15530 * notify it is not used anymore (and have resources cleaned, if
15533 * @see elm_genlist_item_tooltip_content_cb_set()
15537 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15539 * Set a different @b style for a given genlist item's tooltip.
15541 * @param item genlist item with tooltip set
15542 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15543 * "default", @c "transparent", etc)
15545 * Tooltips can have <b>alternate styles</b> to be displayed on,
15546 * which are defined by the theme set on Elementary. This function
15547 * works analogously as elm_object_tooltip_style_set(), but here
15548 * applied only to genlist item objects. The default style for
15549 * tooltips is @c "default".
15551 * @note before you set a style you should define a tooltip with
15552 * elm_genlist_item_tooltip_content_cb_set() or
15553 * elm_genlist_item_tooltip_text_set()
15555 * @see elm_genlist_item_tooltip_style_get()
15559 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15561 * Get the style set a given genlist item's tooltip.
15563 * @param item genlist item with tooltip already set on.
15564 * @return style the theme style in use, which defaults to
15565 * "default". If the object does not have a tooltip set,
15566 * then @c NULL is returned.
15568 * @see elm_genlist_item_tooltip_style_set() for more details
15572 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15574 * @brief Disable size restrictions on an object's tooltip
15575 * @param item The tooltip's anchor object
15576 * @param disable If EINA_TRUE, size restrictions are disabled
15577 * @return EINA_FALSE on failure, EINA_TRUE on success
15579 * This function allows a tooltip to expand beyond 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_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15584 * @brief Retrieve size restriction state of an object's tooltip
15585 * @param item The tooltip's anchor object
15586 * @return If EINA_TRUE, size restrictions are disabled
15588 * This function returns whether a tooltip is allowed to expand beyond
15589 * its parant window's canvas.
15590 * It will instead be limited only by the size of the display.
15592 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15594 * Set the type of mouse pointer/cursor decoration to be shown,
15595 * when the mouse pointer is over the given genlist widget item
15597 * @param item genlist item to customize cursor on
15598 * @param cursor the cursor type's name
15600 * This function works analogously as elm_object_cursor_set(), but
15601 * here the cursor's changing area is restricted to the item's
15602 * area, and not the whole widget's. Note that that item cursors
15603 * have precedence over widget cursors, so that a mouse over @p
15604 * item will always show cursor @p type.
15606 * If this function is called twice for an object, a previously set
15607 * cursor will be unset on the second call.
15609 * @see elm_object_cursor_set()
15610 * @see elm_genlist_item_cursor_get()
15611 * @see elm_genlist_item_cursor_unset()
15615 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15617 * Get the type of mouse pointer/cursor decoration set to be shown,
15618 * when the mouse pointer is over the given genlist widget item
15620 * @param item genlist item with custom cursor set
15621 * @return the cursor type's name or @c NULL, if no custom cursors
15622 * were set to @p item (and on errors)
15624 * @see elm_object_cursor_get()
15625 * @see elm_genlist_item_cursor_set() for more details
15626 * @see elm_genlist_item_cursor_unset()
15630 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15632 * Unset any custom mouse pointer/cursor decoration set to be
15633 * shown, when the mouse pointer is over the given genlist widget
15634 * item, thus making it show the @b default cursor again.
15636 * @param item a genlist item
15638 * Use this call to undo any custom settings on this item's cursor
15639 * decoration, bringing it back to defaults (no custom style set).
15641 * @see elm_object_cursor_unset()
15642 * @see elm_genlist_item_cursor_set() for more details
15646 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15648 * Set a different @b style for a given custom cursor set for a
15651 * @param item genlist item with custom cursor set
15652 * @param style the <b>theme style</b> to use (e.g. @c "default",
15653 * @c "transparent", etc)
15655 * This function only makes sense when one is using custom mouse
15656 * cursor decorations <b>defined in a theme file</b> , which can
15657 * have, given a cursor name/type, <b>alternate styles</b> on
15658 * it. It works analogously as elm_object_cursor_style_set(), but
15659 * here applied only to genlist item objects.
15661 * @warning Before you set a cursor style you should have defined a
15662 * custom cursor previously on the item, with
15663 * elm_genlist_item_cursor_set()
15665 * @see elm_genlist_item_cursor_engine_only_set()
15666 * @see elm_genlist_item_cursor_style_get()
15670 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15672 * Get the current @b style set for a given genlist item's custom
15675 * @param item genlist item with custom cursor set.
15676 * @return style the cursor style in use. If the object does not
15677 * have a cursor set, then @c NULL is returned.
15679 * @see elm_genlist_item_cursor_style_set() for more details
15683 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15685 * Set if the (custom) cursor for a given genlist item should be
15686 * searched in its theme, also, or should only rely on the
15687 * rendering engine.
15689 * @param item item with custom (custom) cursor already set on
15690 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15691 * only on those provided by the rendering engine, @c EINA_FALSE to
15692 * have them searched on the widget's theme, as well.
15694 * @note This call is of use only if you've set a custom cursor
15695 * for genlist items, with elm_genlist_item_cursor_set().
15697 * @note By default, cursors will only be looked for between those
15698 * provided by the rendering engine.
15702 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15704 * Get if the (custom) cursor for a given genlist item is being
15705 * searched in its theme, also, or is only relying on the rendering
15708 * @param item a genlist item
15709 * @return @c EINA_TRUE, if cursors are being looked for only on
15710 * those provided by the rendering engine, @c EINA_FALSE if they
15711 * are being searched on the widget's theme, as well.
15713 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15717 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15719 * Update the contents of all realized items.
15721 * @param obj The genlist object.
15723 * This updates all realized items by calling all the item class functions again
15724 * to get the icons, labels and states. Use this when the original
15725 * item data has changed and the changes are desired to be reflected.
15727 * To update just one item, use elm_genlist_item_update().
15729 * @see elm_genlist_realized_items_get()
15730 * @see elm_genlist_item_update()
15734 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15736 * Activate a genlist mode on an item
15738 * @param item The genlist item
15739 * @param mode Mode name
15740 * @param mode_set Boolean to define set or unset mode.
15742 * A genlist mode is a different way of selecting an item. Once a mode is
15743 * activated on an item, any other selected item is immediately unselected.
15744 * This feature provides an easy way of implementing a new kind of animation
15745 * for selecting an item, without having to entirely rewrite the item style
15746 * theme. However, the elm_genlist_selected_* API can't be used to get what
15747 * item is activate for a mode.
15749 * The current item style will still be used, but applying a genlist mode to
15750 * an item will select it using a different kind of animation.
15752 * The current active item for a mode can be found by
15753 * elm_genlist_mode_item_get().
15755 * The characteristics of genlist mode are:
15756 * - Only one mode can be active at any time, and for only one item.
15757 * - Genlist handles deactivating other items when one item is activated.
15758 * - A mode is defined in the genlist theme (edc), and more modes can easily
15760 * - A mode style and the genlist item style are different things. They
15761 * can be combined to provide a default style to the item, with some kind
15762 * of animation for that item when the mode is activated.
15764 * When a mode is activated on an item, a new view for that item is created.
15765 * The theme of this mode defines the animation that will be used to transit
15766 * the item from the old view to the new view. This second (new) view will be
15767 * active for that item while the mode is active on the item, and will be
15768 * destroyed after the mode is totally deactivated from that item.
15770 * @see elm_genlist_mode_get()
15771 * @see elm_genlist_mode_item_get()
15775 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15777 * Get the last (or current) genlist mode used.
15779 * @param obj The genlist object
15781 * This function just returns the name of the last used genlist mode. It will
15782 * be the current mode if it's still active.
15784 * @see elm_genlist_item_mode_set()
15785 * @see elm_genlist_mode_item_get()
15789 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15791 * Get active genlist mode item
15793 * @param obj The genlist object
15794 * @return The active item for that current mode. Or @c NULL if no item is
15795 * activated with any mode.
15797 * This function returns the item that was activated with a mode, by the
15798 * function elm_genlist_item_mode_set().
15800 * @see elm_genlist_item_mode_set()
15801 * @see elm_genlist_mode_get()
15805 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15806 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15807 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15814 * @defgroup Check Check
15816 * @image html img/widget/check/preview-00.png
15817 * @image latex img/widget/check/preview-00.eps
15818 * @image html img/widget/check/preview-01.png
15819 * @image latex img/widget/check/preview-01.eps
15820 * @image html img/widget/check/preview-02.png
15821 * @image latex img/widget/check/preview-02.eps
15823 * @brief The check widget allows for toggling a value between true and
15826 * Check objects are a lot like radio objects in layout and functionality
15827 * except they do not work as a group, but independently and only toggle the
15828 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15829 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15830 * returns the current state. For convenience, like the radio objects, you
15831 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15832 * for it to modify.
15834 * Signals that you can add callbacks for are:
15835 * "changed" - This is called whenever the user changes the state of one of
15836 * the check object(event_info is NULL).
15838 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15842 * @brief Add a new Check object
15844 * @param parent The parent object
15845 * @return The new object or NULL if it cannot be created
15847 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15849 * @brief Set the text label of the check object
15851 * @param obj The check object
15852 * @param label The text label string in UTF-8
15854 * @deprecated use elm_object_text_set() instead.
15856 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15858 * @brief Get the text label of the check object
15860 * @param obj The check object
15861 * @return The text label string in UTF-8
15863 * @deprecated use elm_object_text_get() instead.
15865 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15867 * @brief Set the icon object of the check object
15869 * @param obj The check object
15870 * @param icon The icon object
15872 * Once the icon object is set, a previously set one will be deleted.
15873 * If you want to keep that old content object, use the
15874 * elm_check_icon_unset() function.
15876 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15878 * @brief Get the icon object of the check object
15880 * @param obj The check object
15881 * @return The icon object
15883 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15885 * @brief Unset the icon used for the check object
15887 * @param obj The check object
15888 * @return The icon object that was being used
15890 * Unparent and return the icon object which was set for this widget.
15892 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15894 * @brief Set the on/off state of the check object
15896 * @param obj The check object
15897 * @param state The state to use (1 == on, 0 == off)
15899 * This sets the state of the check. If set
15900 * with elm_check_state_pointer_set() the state of that variable is also
15901 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15903 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15905 * @brief Get the state of the check object
15907 * @param obj The check object
15908 * @return The boolean state
15910 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15912 * @brief Set a convenience pointer to a boolean to change
15914 * @param obj The check object
15915 * @param statep Pointer to the boolean to modify
15917 * This sets a pointer to a boolean, that, in addition to the check objects
15918 * state will also be modified directly. To stop setting the object pointed
15919 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15920 * then when this is called, the check objects state will also be modified to
15921 * reflect the value of the boolean @p statep points to, just like calling
15922 * elm_check_state_set().
15924 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15930 * @defgroup Radio Radio
15932 * @image html img/widget/radio/preview-00.png
15933 * @image latex img/widget/radio/preview-00.eps
15935 * @brief Radio is a widget that allows for 1 or more options to be displayed
15936 * and have the user choose only 1 of them.
15938 * A radio object contains an indicator, an optional Label and an optional
15939 * icon object. While it's possible to have a group of only one radio they,
15940 * are normally used in groups of 2 or more. To add a radio to a group use
15941 * elm_radio_group_add(). The radio object(s) will select from one of a set
15942 * of integer values, so any value they are configuring needs to be mapped to
15943 * a set of integers. To configure what value that radio object represents,
15944 * use elm_radio_state_value_set() to set the integer it represents. To set
15945 * the value the whole group(which one is currently selected) is to indicate
15946 * use elm_radio_value_set() on any group member, and to get the groups value
15947 * use elm_radio_value_get(). For convenience the radio objects are also able
15948 * to directly set an integer(int) to the value that is selected. To specify
15949 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15950 * The radio objects will modify this directly. That implies the pointer must
15951 * point to valid memory for as long as the radio objects exist.
15953 * Signals that you can add callbacks for are:
15954 * @li changed - This is called whenever the user changes the state of one of
15955 * the radio objects within the group of radio objects that work together.
15957 * @ref tutorial_radio show most of this API in action.
15961 * @brief Add a new radio to the parent
15963 * @param parent The parent object
15964 * @return The new object or NULL if it cannot be created
15966 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15968 * @brief Set the text label of the radio object
15970 * @param obj The radio object
15971 * @param label The text label string in UTF-8
15973 * @deprecated use elm_object_text_set() instead.
15975 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15977 * @brief Get the text label of the radio object
15979 * @param obj The radio object
15980 * @return The text label string in UTF-8
15982 * @deprecated use elm_object_text_set() instead.
15984 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15986 * @brief Set the icon object of the radio object
15988 * @param obj The radio object
15989 * @param icon The icon object
15991 * Once the icon object is set, a previously set one will be deleted. If you
15992 * want to keep that old content object, use the elm_radio_icon_unset()
15995 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15997 * @brief Get the icon object of the radio object
15999 * @param obj The radio object
16000 * @return The icon object
16002 * @see elm_radio_icon_set()
16004 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16006 * @brief Unset the icon used for the radio object
16008 * @param obj The radio object
16009 * @return The icon object that was being used
16011 * Unparent and return the icon object which was set for this widget.
16013 * @see elm_radio_icon_set()
16015 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16017 * @brief Add this radio to a group of other radio objects
16019 * @param obj The radio object
16020 * @param group Any object whose group the @p obj is to join.
16022 * Radio objects work in groups. Each member should have a different integer
16023 * value assigned. In order to have them work as a group, they need to know
16024 * about each other. This adds the given radio object to the group of which
16025 * the group object indicated is a member.
16027 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16029 * @brief Set the integer value that this radio object represents
16031 * @param obj The radio object
16032 * @param value The value to use if this radio object is selected
16034 * This sets the value of the radio.
16036 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16038 * @brief Get the integer value that this radio object represents
16040 * @param obj The radio object
16041 * @return The value used if this radio object is selected
16043 * This gets the value of the radio.
16045 * @see elm_radio_value_set()
16047 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16049 * @brief Set the value of the radio.
16051 * @param obj The radio object
16052 * @param value The value to use for the group
16054 * This sets the value of the radio group and will also set the value if
16055 * pointed to, to the value supplied, but will not call any callbacks.
16057 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16059 * @brief Get the state of the radio object
16061 * @param obj The radio object
16062 * @return The integer state
16064 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16066 * @brief Set a convenience pointer to a integer to change
16068 * @param obj The radio object
16069 * @param valuep Pointer to the integer to modify
16071 * This sets a pointer to a integer, that, in addition to the radio objects
16072 * state will also be modified directly. To stop setting the object pointed
16073 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16074 * when this is called, the radio objects state will also be modified to
16075 * reflect the value of the integer valuep points to, just like calling
16076 * elm_radio_value_set().
16078 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16084 * @defgroup Pager Pager
16086 * @image html img/widget/pager/preview-00.png
16087 * @image latex img/widget/pager/preview-00.eps
16089 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16091 * The flipping between “pages” of objects is animated. All content in pager
16092 * is kept in a stack, the last content to be added will be on the top of the
16093 * stack(be visible).
16095 * Objects can be pushed or popped from the stack or deleted as normal.
16096 * Pushes and pops will animate (and a pop will delete the object once the
16097 * animation is finished). Any object already in the pager can be promoted to
16098 * the top(from its current stacking position) through the use of
16099 * elm_pager_content_promote(). Objects are pushed to the top with
16100 * elm_pager_content_push() and when the top item is no longer wanted, simply
16101 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16102 * object is no longer needed and is not the top item, just delete it as
16103 * normal. You can query which objects are the top and bottom with
16104 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16106 * Signals that you can add callbacks for are:
16107 * "hide,finished" - when the previous page is hided
16109 * This widget has the following styles available:
16112 * @li fade_translucide
16113 * @li fade_invisible
16114 * @note This styles affect only the flipping animations, the appearance when
16115 * not animating is unaffected by styles.
16117 * @ref tutorial_pager gives a good overview of the usage of the API.
16121 * Add a new pager to the parent
16123 * @param parent The parent object
16124 * @return The new object or NULL if it cannot be created
16128 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16130 * @brief Push an object to the top of the pager stack (and show it).
16132 * @param obj The pager object
16133 * @param content The object to push
16135 * The object pushed becomes a child of the pager, it will be controlled and
16136 * deleted when the pager is deleted.
16138 * @note If the content is already in the stack use
16139 * elm_pager_content_promote().
16140 * @warning Using this function on @p content already in the stack results in
16141 * undefined behavior.
16143 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16145 * @brief Pop the object that is on top of the stack
16147 * @param obj The pager object
16149 * This pops the object that is on the top(visible) of the pager, makes it
16150 * disappear, then deletes the object. The object that was underneath it on
16151 * the stack will become visible.
16153 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16155 * @brief Moves an object already in the pager stack to the top of the stack.
16157 * @param obj The pager object
16158 * @param content The object to promote
16160 * This will take the @p content and move it to the top of the stack as
16161 * if it had been pushed there.
16163 * @note If the content isn't already in the stack use
16164 * elm_pager_content_push().
16165 * @warning Using this function on @p content not already in the stack
16166 * results in undefined behavior.
16168 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16170 * @brief Return the object at the bottom of the pager stack
16172 * @param obj The pager object
16173 * @return The bottom object or NULL if none
16175 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16177 * @brief Return the object at the top of the pager stack
16179 * @param obj The pager object
16180 * @return The top object or NULL if none
16182 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16188 * @defgroup Slideshow Slideshow
16190 * @image html img/widget/slideshow/preview-00.png
16191 * @image latex img/widget/slideshow/preview-00.eps
16193 * This widget, as the name indicates, is a pre-made image
16194 * slideshow panel, with API functions acting on (child) image
16195 * items presentation. Between those actions, are:
16196 * - advance to next/previous image
16197 * - select the style of image transition animation
16198 * - set the exhibition time for each image
16199 * - start/stop the slideshow
16201 * The transition animations are defined in the widget's theme,
16202 * consequently new animations can be added without having to
16203 * update the widget's code.
16205 * @section Slideshow_Items Slideshow items
16207 * For slideshow items, just like for @ref Genlist "genlist" ones,
16208 * the user defines a @b classes, specifying functions that will be
16209 * called on the item's creation and deletion times.
16211 * The #Elm_Slideshow_Item_Class structure contains the following
16214 * - @c func.get - When an item is displayed, this function is
16215 * called, and it's where one should create the item object, de
16216 * facto. For example, the object can be a pure Evas image object
16217 * or an Elementary @ref Photocam "photocam" widget. See
16218 * #SlideshowItemGetFunc.
16219 * - @c func.del - When an item is no more displayed, this function
16220 * is called, where the user must delete any data associated to
16221 * the item. See #SlideshowItemDelFunc.
16223 * @section Slideshow_Caching Slideshow caching
16225 * The slideshow provides facilities to have items adjacent to the
16226 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16227 * you, so that the system does not have to decode image data
16228 * anymore at the time it has to actually switch images on its
16229 * viewport. The user is able to set the numbers of items to be
16230 * cached @b before and @b after the current item, in the widget's
16233 * Smart events one can add callbacks for are:
16235 * - @c "changed" - when the slideshow switches its view to a new
16238 * List of examples for the slideshow widget:
16239 * @li @ref slideshow_example
16243 * @addtogroup Slideshow
16247 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16248 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16249 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16250 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16251 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16254 * @struct _Elm_Slideshow_Item_Class
16256 * Slideshow item class definition. See @ref Slideshow_Items for
16259 struct _Elm_Slideshow_Item_Class
16261 struct _Elm_Slideshow_Item_Class_Func
16263 SlideshowItemGetFunc get;
16264 SlideshowItemDelFunc del;
16266 }; /**< #Elm_Slideshow_Item_Class member definitions */
16269 * Add a new slideshow widget to the given parent Elementary
16270 * (container) object
16272 * @param parent The parent object
16273 * @return A new slideshow widget handle or @c NULL, on errors
16275 * This function inserts a new slideshow widget on the canvas.
16277 * @ingroup Slideshow
16279 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16282 * Add (append) a new item in a given slideshow widget.
16284 * @param obj The slideshow object
16285 * @param itc The item class for the item
16286 * @param data The item's data
16287 * @return A handle to the item added or @c NULL, on errors
16289 * Add a new item to @p obj's internal list of items, appending it.
16290 * The item's class must contain the function really fetching the
16291 * image object to show for this item, which could be an Evas image
16292 * object or an Elementary photo, for example. The @p data
16293 * parameter is going to be passed to both class functions of the
16296 * @see #Elm_Slideshow_Item_Class
16297 * @see elm_slideshow_item_sorted_insert()
16299 * @ingroup Slideshow
16301 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16304 * Insert a new item into the given slideshow widget, using the @p func
16305 * function to sort items (by item handles).
16307 * @param obj The slideshow object
16308 * @param itc The item class for the item
16309 * @param data The item's data
16310 * @param func The comparing function to be used to sort slideshow
16311 * items <b>by #Elm_Slideshow_Item item handles</b>
16312 * @return Returns The slideshow item handle, on success, or
16313 * @c NULL, on errors
16315 * Add a new item to @p obj's internal list of items, in a position
16316 * determined by the @p func comparing function. The item's class
16317 * must contain the function really fetching the image object to
16318 * show for this item, which could be an Evas image object or an
16319 * Elementary photo, for example. The @p data parameter is going to
16320 * be passed to both class functions of the item.
16322 * @see #Elm_Slideshow_Item_Class
16323 * @see elm_slideshow_item_add()
16325 * @ingroup Slideshow
16327 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);
16330 * Display a given slideshow widget's item, programmatically.
16332 * @param obj The slideshow object
16333 * @param item The item to display on @p obj's viewport
16335 * The change between the current item and @p item will use the
16336 * transition @p obj is set to use (@see
16337 * elm_slideshow_transition_set()).
16339 * @ingroup Slideshow
16341 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16344 * Slide to the @b next item, in a given slideshow widget
16346 * @param obj The slideshow object
16348 * The sliding animation @p obj is set to use will be the
16349 * transition effect used, after this call is issued.
16351 * @note If the end of the slideshow's internal list of items is
16352 * reached, it'll wrap around to the list's beginning, again.
16354 * @ingroup Slideshow
16356 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16359 * Slide to the @b previous item, in a given slideshow widget
16361 * @param obj The slideshow object
16363 * The sliding animation @p obj is set to use will be the
16364 * transition effect used, after this call is issued.
16366 * @note If the beginning of the slideshow's internal list of items
16367 * is reached, it'll wrap around to the list's end, again.
16369 * @ingroup Slideshow
16371 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16374 * Returns the list of sliding transition/effect names available, for a
16375 * given slideshow widget.
16377 * @param obj The slideshow object
16378 * @return The list of transitions (list of @b stringshared strings
16381 * The transitions, which come from @p obj's theme, must be an EDC
16382 * data item named @c "transitions" on the theme file, with (prefix)
16383 * names of EDC programs actually implementing them.
16385 * The available transitions for slideshows on the default theme are:
16386 * - @c "fade" - the current item fades out, while the new one
16387 * fades in to the slideshow's viewport.
16388 * - @c "black_fade" - the current item fades to black, and just
16389 * then, the new item will fade in.
16390 * - @c "horizontal" - the current item slides horizontally, until
16391 * it gets out of the slideshow's viewport, while the new item
16392 * comes from the left to take its place.
16393 * - @c "vertical" - the current item slides vertically, until it
16394 * gets out of the slideshow's viewport, while the new item comes
16395 * from the bottom to take its place.
16396 * - @c "square" - the new item starts to appear from the middle of
16397 * the current one, but with a tiny size, growing until its
16398 * target (full) size and covering the old one.
16400 * @warning The stringshared strings get no new references
16401 * exclusive to the user grabbing the list, here, so if you'd like
16402 * to use them out of this call's context, you'd better @c
16403 * eina_stringshare_ref() them.
16405 * @see elm_slideshow_transition_set()
16407 * @ingroup Slideshow
16409 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16412 * Set the current slide transition/effect in use for a given
16415 * @param obj The slideshow object
16416 * @param transition The new transition's name string
16418 * If @p transition is implemented in @p obj's theme (i.e., is
16419 * contained in the list returned by
16420 * elm_slideshow_transitions_get()), this new sliding effect will
16421 * be used on the widget.
16423 * @see elm_slideshow_transitions_get() for more details
16425 * @ingroup Slideshow
16427 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16430 * Get the current slide transition/effect in use for a given
16433 * @param obj The slideshow object
16434 * @return The current transition's name
16436 * @see elm_slideshow_transition_set() for more details
16438 * @ingroup Slideshow
16440 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16443 * Set the interval between each image transition on a given
16444 * slideshow widget, <b>and start the slideshow, itself</b>
16446 * @param obj The slideshow object
16447 * @param timeout The new displaying timeout for images
16449 * After this call, the slideshow widget will start cycling its
16450 * view, sequentially and automatically, with the images of the
16451 * items it has. The time between each new image displayed is going
16452 * to be @p timeout, in @b seconds. If a different timeout was set
16453 * previously and an slideshow was in progress, it will continue
16454 * with the new time between transitions, after this call.
16456 * @note A value less than or equal to 0 on @p timeout will disable
16457 * the widget's internal timer, thus halting any slideshow which
16458 * could be happening on @p obj.
16460 * @see elm_slideshow_timeout_get()
16462 * @ingroup Slideshow
16464 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16467 * Get the interval set for image transitions on a given slideshow
16470 * @param obj The slideshow object
16471 * @return Returns the timeout set on it
16473 * @see elm_slideshow_timeout_set() for more details
16475 * @ingroup Slideshow
16477 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16480 * Set if, after a slideshow is started, for a given slideshow
16481 * widget, its items should be displayed cyclically or not.
16483 * @param obj The slideshow object
16484 * @param loop Use @c EINA_TRUE to make it cycle through items or
16485 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16488 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16489 * ignore what is set by this functions, i.e., they'll @b always
16490 * cycle through items. This affects only the "automatic"
16491 * slideshow, as set by elm_slideshow_timeout_set().
16493 * @see elm_slideshow_loop_get()
16495 * @ingroup Slideshow
16497 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16500 * Get if, after a slideshow is started, for a given slideshow
16501 * widget, its items are to be displayed cyclically or not.
16503 * @param obj The slideshow object
16504 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16505 * through or @c EINA_FALSE, otherwise
16507 * @see elm_slideshow_loop_set() for more details
16509 * @ingroup Slideshow
16511 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16514 * Remove all items from a given slideshow widget
16516 * @param obj The slideshow object
16518 * This removes (and deletes) all items in @p obj, leaving it
16521 * @see elm_slideshow_item_del(), to remove just one item.
16523 * @ingroup Slideshow
16525 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16528 * Get the internal list of items in a given slideshow widget.
16530 * @param obj The slideshow object
16531 * @return The list of items (#Elm_Slideshow_Item as data) or
16532 * @c NULL on errors.
16534 * This list is @b not to be modified in any way and must not be
16535 * freed. Use the list members with functions like
16536 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16538 * @warning This list is only valid until @p obj object's internal
16539 * items list is changed. It should be fetched again with another
16540 * call to this function when changes happen.
16542 * @ingroup Slideshow
16544 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16547 * Delete a given item from a slideshow widget.
16549 * @param item The slideshow item
16551 * @ingroup Slideshow
16553 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16556 * Return the data associated with a given slideshow item
16558 * @param item The slideshow item
16559 * @return Returns the data associated to this item
16561 * @ingroup Slideshow
16563 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16566 * Returns the currently displayed item, in a given slideshow widget
16568 * @param obj The slideshow object
16569 * @return A handle to the item being displayed in @p obj or
16570 * @c NULL, if none is (and on errors)
16572 * @ingroup Slideshow
16574 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16577 * Get the real Evas object created to implement the view of a
16578 * given slideshow item
16580 * @param item The slideshow item.
16581 * @return the Evas object implementing this item's view.
16583 * This returns the actual Evas object used to implement the
16584 * specified slideshow item's view. This may be @c NULL, as it may
16585 * not have been created or may have been deleted, at any time, by
16586 * the slideshow. <b>Do not modify this object</b> (move, resize,
16587 * show, hide, etc.), as the slideshow is controlling it. This
16588 * function is for querying, emitting custom signals or hooking
16589 * lower level callbacks for events on that object. Do not delete
16590 * this object under any circumstances.
16592 * @see elm_slideshow_item_data_get()
16594 * @ingroup Slideshow
16596 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16599 * Get the the item, in a given slideshow widget, placed at
16600 * position @p nth, in its internal items list
16602 * @param obj The slideshow object
16603 * @param nth The number of the item to grab a handle to (0 being
16605 * @return The item stored in @p obj at position @p nth or @c NULL,
16606 * if there's no item with that index (and on errors)
16608 * @ingroup Slideshow
16610 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16613 * Set the current slide layout in use for a given slideshow widget
16615 * @param obj The slideshow object
16616 * @param layout The new layout's name string
16618 * If @p layout is implemented in @p obj's theme (i.e., is contained
16619 * in the list returned by elm_slideshow_layouts_get()), this new
16620 * images layout will be used on the widget.
16622 * @see elm_slideshow_layouts_get() for more details
16624 * @ingroup Slideshow
16626 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16629 * Get the current slide layout in use for a given slideshow widget
16631 * @param obj The slideshow object
16632 * @return The current layout's name
16634 * @see elm_slideshow_layout_set() for more details
16636 * @ingroup Slideshow
16638 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16641 * Returns the list of @b layout names available, for a given
16642 * slideshow widget.
16644 * @param obj The slideshow object
16645 * @return The list of layouts (list of @b stringshared strings
16648 * Slideshow layouts will change how the widget is to dispose each
16649 * image item in its viewport, with regard to cropping, scaling,
16652 * The layouts, which come from @p obj's theme, must be an EDC
16653 * data item name @c "layouts" on the theme file, with (prefix)
16654 * names of EDC programs actually implementing them.
16656 * The available layouts for slideshows on the default theme are:
16657 * - @c "fullscreen" - item images with original aspect, scaled to
16658 * touch top and down slideshow borders or, if the image's heigh
16659 * is not enough, left and right slideshow borders.
16660 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16661 * one, but always leaving 10% of the slideshow's dimensions of
16662 * distance between the item image's borders and the slideshow
16663 * borders, for each axis.
16665 * @warning The stringshared strings get no new references
16666 * exclusive to the user grabbing the list, here, so if you'd like
16667 * to use them out of this call's context, you'd better @c
16668 * eina_stringshare_ref() them.
16670 * @see elm_slideshow_layout_set()
16672 * @ingroup Slideshow
16674 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16677 * Set the number of items to cache, on a given slideshow widget,
16678 * <b>before the current item</b>
16680 * @param obj The slideshow object
16681 * @param count Number of items to cache before the current one
16683 * The default value for this property is @c 2. See
16684 * @ref Slideshow_Caching "slideshow caching" for more details.
16686 * @see elm_slideshow_cache_before_get()
16688 * @ingroup Slideshow
16690 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16693 * Retrieve the number of items to cache, on a given slideshow widget,
16694 * <b>before the current item</b>
16696 * @param obj The slideshow object
16697 * @return The number of items set to be cached before the current one
16699 * @see elm_slideshow_cache_before_set() for more details
16701 * @ingroup Slideshow
16703 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16706 * Set the number of items to cache, on a given slideshow widget,
16707 * <b>after the current item</b>
16709 * @param obj The slideshow object
16710 * @param count Number of items to cache after the current one
16712 * The default value for this property is @c 2. See
16713 * @ref Slideshow_Caching "slideshow caching" for more details.
16715 * @see elm_slideshow_cache_after_get()
16717 * @ingroup Slideshow
16719 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16722 * Retrieve the number of items to cache, on a given slideshow widget,
16723 * <b>after the current item</b>
16725 * @param obj The slideshow object
16726 * @return The number of items set to be cached after the current one
16728 * @see elm_slideshow_cache_after_set() for more details
16730 * @ingroup Slideshow
16732 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16735 * Get the number of items stored in a given slideshow widget
16737 * @param obj The slideshow object
16738 * @return The number of items on @p obj, at the moment of this call
16740 * @ingroup Slideshow
16742 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16749 * @defgroup Fileselector File Selector
16751 * @image html img/widget/fileselector/preview-00.png
16752 * @image latex img/widget/fileselector/preview-00.eps
16754 * A file selector is a widget that allows a user to navigate
16755 * through a file system, reporting file selections back via its
16758 * It contains shortcut buttons for home directory (@c ~) and to
16759 * jump one directory upwards (..), as well as cancel/ok buttons to
16760 * confirm/cancel a given selection. After either one of those two
16761 * former actions, the file selector will issue its @c "done" smart
16764 * There's a text entry on it, too, showing the name of the current
16765 * selection. There's the possibility of making it editable, so it
16766 * is useful on file saving dialogs on applications, where one
16767 * gives a file name to save contents to, in a given directory in
16768 * the system. This custom file name will be reported on the @c
16769 * "done" smart callback (explained in sequence).
16771 * Finally, it has a view to display file system items into in two
16776 * If Elementary is built with support of the Ethumb thumbnailing
16777 * library, the second form of view will display preview thumbnails
16778 * of files which it supports.
16780 * Smart callbacks one can register to:
16782 * - @c "selected" - the user has clicked on a file (when not in
16783 * folders-only mode) or directory (when in folders-only mode)
16784 * - @c "directory,open" - the list has been populated with new
16785 * content (@c event_info is a pointer to the directory's
16786 * path, a @b stringshared string)
16787 * - @c "done" - the user has clicked on the "ok" or "cancel"
16788 * buttons (@c event_info is a pointer to the selection's
16789 * path, a @b stringshared string)
16791 * Here is an example on its usage:
16792 * @li @ref fileselector_example
16796 * @addtogroup Fileselector
16801 * Defines how a file selector widget is to layout its contents
16802 * (file system entries).
16804 typedef enum _Elm_Fileselector_Mode
16806 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16807 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16808 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16809 } Elm_Fileselector_Mode;
16812 * Add a new file selector widget to the given parent Elementary
16813 * (container) object
16815 * @param parent The parent object
16816 * @return a new file selector widget handle or @c NULL, on errors
16818 * This function inserts a new file selector widget on the canvas.
16820 * @ingroup Fileselector
16822 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16825 * Enable/disable the file name entry box where the user can type
16826 * in a name for a file, in a given file selector widget
16828 * @param obj The file selector object
16829 * @param is_save @c EINA_TRUE to make the file selector a "saving
16830 * dialog", @c EINA_FALSE otherwise
16832 * Having the entry editable is useful on file saving dialogs on
16833 * applications, where one gives a file name to save contents to,
16834 * in a given directory in the system. This custom file name will
16835 * be reported on the @c "done" smart callback.
16837 * @see elm_fileselector_is_save_get()
16839 * @ingroup Fileselector
16841 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16844 * Get whether the given file selector is in "saving dialog" mode
16846 * @param obj The file selector object
16847 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16848 * mode, @c EINA_FALSE otherwise (and on errors)
16850 * @see elm_fileselector_is_save_set() for more details
16852 * @ingroup Fileselector
16854 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16857 * Enable/disable folder-only view for a given file selector widget
16859 * @param obj The file selector object
16860 * @param only @c EINA_TRUE to make @p obj only display
16861 * directories, @c EINA_FALSE to make files to be displayed in it
16864 * If enabled, the widget's view will only display folder items,
16867 * @see elm_fileselector_folder_only_get()
16869 * @ingroup Fileselector
16871 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16874 * Get whether folder-only view is set for a given file selector
16877 * @param obj The file selector object
16878 * @return only @c EINA_TRUE if @p obj is only displaying
16879 * directories, @c EINA_FALSE if files are being displayed in it
16880 * too (and on errors)
16882 * @see elm_fileselector_folder_only_get()
16884 * @ingroup Fileselector
16886 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16889 * Enable/disable the "ok" and "cancel" buttons on a given file
16892 * @param obj The file selector object
16893 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16895 * @note A file selector without those buttons will never emit the
16896 * @c "done" smart event, and is only usable if one is just hooking
16897 * to the other two events.
16899 * @see elm_fileselector_buttons_ok_cancel_get()
16901 * @ingroup Fileselector
16903 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16906 * Get whether the "ok" and "cancel" buttons on a given file
16907 * selector widget are being shown.
16909 * @param obj The file selector object
16910 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16911 * otherwise (and on errors)
16913 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16915 * @ingroup Fileselector
16917 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16920 * Enable/disable a tree view in the given file selector widget,
16921 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16923 * @param obj The file selector object
16924 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16927 * In a tree view, arrows are created on the sides of directories,
16928 * allowing them to expand in place.
16930 * @note If it's in other mode, the changes made by this function
16931 * will only be visible when one switches back to "list" mode.
16933 * @see elm_fileselector_expandable_get()
16935 * @ingroup Fileselector
16937 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16940 * Get whether tree view is enabled for the given file selector
16943 * @param obj The file selector object
16944 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16945 * otherwise (and or errors)
16947 * @see elm_fileselector_expandable_set() for more details
16949 * @ingroup Fileselector
16951 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16954 * Set, programmatically, the @b directory that a given file
16955 * selector widget will display contents from
16957 * @param obj The file selector object
16958 * @param path The path to display in @p obj
16960 * This will change the @b directory that @p obj is displaying. It
16961 * will also clear the text entry area on the @p obj object, which
16962 * displays select files' names.
16964 * @see elm_fileselector_path_get()
16966 * @ingroup Fileselector
16968 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16971 * Get the parent directory's path that a given file selector
16972 * widget is displaying
16974 * @param obj The file selector object
16975 * @return The (full) path of the directory the file selector is
16976 * displaying, a @b stringshared string
16978 * @see elm_fileselector_path_set()
16980 * @ingroup Fileselector
16982 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16985 * Set, programmatically, the currently selected file/directory in
16986 * the given file selector widget
16988 * @param obj The file selector object
16989 * @param path The (full) path to a file or directory
16990 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16991 * latter case occurs if the directory or file pointed to do not
16994 * @see elm_fileselector_selected_get()
16996 * @ingroup Fileselector
16998 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17001 * Get the currently selected item's (full) path, in the given file
17004 * @param obj The file selector object
17005 * @return The absolute path of the selected item, a @b
17006 * stringshared string
17008 * @note Custom editions on @p obj object's text entry, if made,
17009 * will appear on the return string of this function, naturally.
17011 * @see elm_fileselector_selected_set() for more details
17013 * @ingroup Fileselector
17015 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17018 * Set the mode in which a given file selector widget will display
17019 * (layout) file system entries in its view
17021 * @param obj The file selector object
17022 * @param mode The mode of the fileselector, being it one of
17023 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17024 * first one, naturally, will display the files in a list. The
17025 * latter will make the widget to display its entries in a grid
17028 * @note By using elm_fileselector_expandable_set(), the user may
17029 * trigger a tree view for that list.
17031 * @note If Elementary is built with support of the Ethumb
17032 * thumbnailing library, the second form of view will display
17033 * preview thumbnails of files which it supports. You must have
17034 * elm_need_ethumb() called in your Elementary for thumbnailing to
17037 * @see elm_fileselector_expandable_set().
17038 * @see elm_fileselector_mode_get().
17040 * @ingroup Fileselector
17042 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17045 * Get the mode in which a given file selector widget is displaying
17046 * (layouting) file system entries in its view
17048 * @param obj The fileselector object
17049 * @return The mode in which the fileselector is at
17051 * @see elm_fileselector_mode_set() for more details
17053 * @ingroup Fileselector
17055 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17062 * @defgroup Progressbar Progress bar
17064 * The progress bar is a widget for visually representing the
17065 * progress status of a given job/task.
17067 * A progress bar may be horizontal or vertical. It may display an
17068 * icon besides it, as well as primary and @b units labels. The
17069 * former is meant to label the widget as a whole, while the
17070 * latter, which is formatted with floating point values (and thus
17071 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17072 * units"</c>), is meant to label the widget's <b>progress
17073 * value</b>. Label, icon and unit strings/objects are @b optional
17074 * for progress bars.
17076 * A progress bar may be @b inverted, in which state it gets its
17077 * values inverted, with high values being on the left or top and
17078 * low values on the right or bottom, as opposed to normally have
17079 * the low values on the former and high values on the latter,
17080 * respectively, for horizontal and vertical modes.
17082 * The @b span of the progress, as set by
17083 * elm_progressbar_span_size_set(), is its length (horizontally or
17084 * vertically), unless one puts size hints on the widget to expand
17085 * on desired directions, by any container. That length will be
17086 * scaled by the object or applications scaling factor. At any
17087 * point code can query the progress bar for its value with
17088 * elm_progressbar_value_get().
17090 * Available widget styles for progress bars:
17092 * - @c "wheel" (simple style, no text, no progression, only
17093 * "pulse" effect is available)
17095 * Here is an example on its usage:
17096 * @li @ref progressbar_example
17100 * Add a new progress bar widget to the given parent Elementary
17101 * (container) object
17103 * @param parent The parent object
17104 * @return a new progress bar widget handle or @c NULL, on errors
17106 * This function inserts a new progress bar widget on the canvas.
17108 * @ingroup Progressbar
17110 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17113 * Set whether a given progress bar widget is at "pulsing mode" or
17116 * @param obj The progress bar object
17117 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17118 * @c EINA_FALSE to put it back to its default one
17120 * By default, progress bars will display values from the low to
17121 * high value boundaries. There are, though, contexts in which the
17122 * state of progression of a given task is @b unknown. For those,
17123 * one can set a progress bar widget to a "pulsing state", to give
17124 * the user an idea that some computation is being held, but
17125 * without exact progress values. In the default theme it will
17126 * animate its bar with the contents filling in constantly and back
17127 * to non-filled, in a loop. To start and stop this pulsing
17128 * animation, one has to explicitly call elm_progressbar_pulse().
17130 * @see elm_progressbar_pulse_get()
17131 * @see elm_progressbar_pulse()
17133 * @ingroup Progressbar
17135 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17138 * Get whether a given progress bar widget is at "pulsing mode" or
17141 * @param obj The progress bar object
17142 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17143 * if it's in the default one (and on errors)
17145 * @ingroup Progressbar
17147 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17150 * Start/stop a given progress bar "pulsing" animation, if its
17153 * @param obj The progress bar object
17154 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17155 * @c EINA_FALSE to @b stop it
17157 * @note This call won't do anything if @p obj is not under "pulsing mode".
17159 * @see elm_progressbar_pulse_set() for more details.
17161 * @ingroup Progressbar
17163 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17166 * Set the progress value (in percentage) on a given progress bar
17169 * @param obj The progress bar object
17170 * @param val The progress value (@b must be between @c 0.0 and @c
17173 * Use this call to set progress bar levels.
17175 * @note If you passes a value out of the specified range for @p
17176 * val, it will be interpreted as the @b closest of the @b boundary
17177 * values in the range.
17179 * @ingroup Progressbar
17181 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17184 * Get the progress value (in percentage) on a given progress bar
17187 * @param obj The progress bar object
17188 * @return The value of the progressbar
17190 * @see elm_progressbar_value_set() for more details
17192 * @ingroup Progressbar
17194 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17197 * Set the label of a given progress bar widget
17199 * @param obj The progress bar object
17200 * @param label The text label string, in UTF-8
17202 * @ingroup Progressbar
17203 * @deprecated use elm_object_text_set() instead.
17205 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17208 * Get the label of a given progress bar widget
17210 * @param obj The progressbar object
17211 * @return The text label string, in UTF-8
17213 * @ingroup Progressbar
17214 * @deprecated use elm_object_text_set() instead.
17216 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17219 * Set the icon object of a given progress bar widget
17221 * @param obj The progress bar object
17222 * @param icon The icon object
17224 * Use this call to decorate @p obj with an icon next to it.
17226 * @note Once the icon object is set, a previously set one will be
17227 * deleted. If you want to keep that old content object, use the
17228 * elm_progressbar_icon_unset() function.
17230 * @see elm_progressbar_icon_get()
17232 * @ingroup Progressbar
17234 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17237 * Retrieve the icon object set for a given progress bar widget
17239 * @param obj The progress bar object
17240 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17241 * otherwise (and on errors)
17243 * @see elm_progressbar_icon_set() for more details
17245 * @ingroup Progressbar
17247 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17250 * Unset an icon set on a given progress bar widget
17252 * @param obj The progress bar object
17253 * @return The icon object that was being used, if any was set, or
17254 * @c NULL, otherwise (and on errors)
17256 * This call will unparent and return the icon object which was set
17257 * for this widget, previously, on success.
17259 * @see elm_progressbar_icon_set() for more details
17261 * @ingroup Progressbar
17263 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17266 * Set the (exact) length of the bar region of a given progress bar
17269 * @param obj The progress bar object
17270 * @param size The length of the progress bar's bar region
17272 * This sets the minimum width (when in horizontal mode) or height
17273 * (when in vertical mode) of the actual bar area of the progress
17274 * bar @p obj. This in turn affects the object's minimum size. Use
17275 * this when you're not setting other size hints expanding on the
17276 * given direction (like weight and alignment hints) and you would
17277 * like it to have a specific size.
17279 * @note Icon, label and unit text around @p obj will require their
17280 * own space, which will make @p obj to require more the @p size,
17283 * @see elm_progressbar_span_size_get()
17285 * @ingroup Progressbar
17287 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17290 * Get the length set for the bar region of a given progress bar
17293 * @param obj The progress bar object
17294 * @return The length of the progress bar's bar region
17296 * If that size was not set previously, with
17297 * elm_progressbar_span_size_set(), this call will return @c 0.
17299 * @ingroup Progressbar
17301 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17304 * Set the format string for a given progress bar widget's units
17307 * @param obj The progress bar object
17308 * @param format The format string for @p obj's units label
17310 * If @c NULL is passed on @p format, it will make @p obj's units
17311 * area to be hidden completely. If not, it'll set the <b>format
17312 * string</b> for the units label's @b text. The units label is
17313 * provided a floating point value, so the units text is up display
17314 * at most one floating point falue. Note that the units label is
17315 * optional. Use a format string such as "%1.2f meters" for
17318 * @note The default format string for a progress bar is an integer
17319 * percentage, as in @c "%.0f %%".
17321 * @see elm_progressbar_unit_format_get()
17323 * @ingroup Progressbar
17325 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17328 * Retrieve the format string set for a given progress bar widget's
17331 * @param obj The progress bar object
17332 * @return The format set string for @p obj's units label or
17333 * @c NULL, if none was set (and on errors)
17335 * @see elm_progressbar_unit_format_set() for more details
17337 * @ingroup Progressbar
17339 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17342 * Set the orientation of a given progress bar widget
17344 * @param obj The progress bar object
17345 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17346 * @b horizontal, @c EINA_FALSE to make it @b vertical
17348 * Use this function to change how your progress bar is to be
17349 * disposed: vertically or horizontally.
17351 * @see elm_progressbar_horizontal_get()
17353 * @ingroup Progressbar
17355 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17358 * Retrieve the orientation of a given progress bar widget
17360 * @param obj The progress bar object
17361 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17362 * @c EINA_FALSE if it's @b vertical (and on errors)
17364 * @see elm_progressbar_horizontal_set() for more details
17366 * @ingroup Progressbar
17368 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17371 * Invert a given progress bar widget's displaying values order
17373 * @param obj The progress bar object
17374 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17375 * @c EINA_FALSE to bring it back to default, non-inverted values.
17377 * A progress bar may be @b inverted, in which state it gets its
17378 * values inverted, with high values being on the left or top and
17379 * low values on the right or bottom, as opposed to normally have
17380 * the low values on the former and high values on the latter,
17381 * respectively, for horizontal and vertical modes.
17383 * @see elm_progressbar_inverted_get()
17385 * @ingroup Progressbar
17387 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17390 * Get whether a given progress bar widget's displaying values are
17393 * @param obj The progress bar object
17394 * @return @c EINA_TRUE, if @p obj has inverted values,
17395 * @c EINA_FALSE otherwise (and on errors)
17397 * @see elm_progressbar_inverted_set() for more details
17399 * @ingroup Progressbar
17401 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17404 * @defgroup Separator Separator
17406 * @brief Separator is a very thin object used to separate other objects.
17408 * A separator can be vertical or horizontal.
17410 * @ref tutorial_separator is a good example of how to use a separator.
17414 * @brief Add a separator object to @p parent
17416 * @param parent The parent object
17418 * @return The separator object, or NULL upon failure
17420 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17422 * @brief Set the horizontal mode of a separator object
17424 * @param obj The separator object
17425 * @param horizontal If true, the separator is horizontal
17427 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17429 * @brief Get the horizontal mode of a separator object
17431 * @param obj The separator object
17432 * @return If true, the separator is horizontal
17434 * @see elm_separator_horizontal_set()
17436 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17442 * @defgroup Spinner Spinner
17443 * @ingroup Elementary
17445 * @image html img/widget/spinner/preview-00.png
17446 * @image latex img/widget/spinner/preview-00.eps
17448 * A spinner is a widget which allows the user to increase or decrease
17449 * numeric values using arrow buttons, or edit values directly, clicking
17450 * over it and typing the new value.
17452 * By default the spinner will not wrap and has a label
17453 * of "%.0f" (just showing the integer value of the double).
17455 * A spinner has a label that is formatted with floating
17456 * point values and thus accepts a printf-style format string, like
17459 * It also allows specific values to be replaced by pre-defined labels.
17461 * Smart callbacks one can register to:
17463 * - "changed" - Whenever the spinner value is changed.
17464 * - "delay,changed" - A short time after the value is changed by the user.
17465 * This will be called only when the user stops dragging for a very short
17466 * period or when they release their finger/mouse, so it avoids possibly
17467 * expensive reactions to the value change.
17469 * Available styles for it:
17471 * - @c "vertical": up/down buttons at the right side and text left aligned.
17473 * Here is an example on its usage:
17474 * @ref spinner_example
17478 * @addtogroup Spinner
17483 * Add a new spinner widget to the given parent Elementary
17484 * (container) object.
17486 * @param parent The parent object.
17487 * @return a new spinner widget handle or @c NULL, on errors.
17489 * This function inserts a new spinner widget on the canvas.
17494 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17497 * Set the format string of the displayed label.
17499 * @param obj The spinner object.
17500 * @param fmt The format string for the label display.
17502 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17503 * string for the label text. The label text is provided a floating point
17504 * value, so the label text can display up to 1 floating point value.
17505 * Note that this is optional.
17507 * Use a format string such as "%1.2f meters" for example, and it will
17508 * display values like: "3.14 meters" for a value equal to 3.14159.
17510 * Default is "%0.f".
17512 * @see elm_spinner_label_format_get()
17516 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17519 * Get the label format of the spinner.
17521 * @param obj The spinner object.
17522 * @return The text label format string in UTF-8.
17524 * @see elm_spinner_label_format_set() for details.
17528 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17531 * Set the minimum and maximum values for the spinner.
17533 * @param obj The spinner object.
17534 * @param min The minimum value.
17535 * @param max The maximum value.
17537 * Define the allowed range of values to be selected by the user.
17539 * If actual value is less than @p min, it will be updated to @p min. If it
17540 * is bigger then @p max, will be updated to @p max. Actual value can be
17541 * get with elm_spinner_value_get().
17543 * By default, min is equal to 0, and max is equal to 100.
17545 * @warning Maximum must be greater than minimum.
17547 * @see elm_spinner_min_max_get()
17551 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17554 * Get the minimum and maximum values of the spinner.
17556 * @param obj The spinner object.
17557 * @param min Pointer where to store the minimum value.
17558 * @param max Pointer where to store the maximum value.
17560 * @note If only one value is needed, the other pointer can be passed
17563 * @see elm_spinner_min_max_set() for details.
17567 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17570 * Set the step used to increment or decrement the spinner value.
17572 * @param obj The spinner object.
17573 * @param step The step value.
17575 * This value will be incremented or decremented to the displayed value.
17576 * It will be incremented while the user keep right or top arrow pressed,
17577 * and will be decremented while the user keep left or bottom arrow pressed.
17579 * The interval to increment / decrement can be set with
17580 * elm_spinner_interval_set().
17582 * By default step value is equal to 1.
17584 * @see elm_spinner_step_get()
17588 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17591 * Get the step used to increment or decrement the spinner value.
17593 * @param obj The spinner object.
17594 * @return The step value.
17596 * @see elm_spinner_step_get() for more details.
17600 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17603 * Set the value the spinner displays.
17605 * @param obj The spinner object.
17606 * @param val The value to be displayed.
17608 * Value will be presented on the label following format specified with
17609 * elm_spinner_format_set().
17611 * @warning The value must to be between min and max values. This values
17612 * are set by elm_spinner_min_max_set().
17614 * @see elm_spinner_value_get().
17615 * @see elm_spinner_format_set().
17616 * @see elm_spinner_min_max_set().
17620 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17623 * Get the value displayed by the spinner.
17625 * @param obj The spinner object.
17626 * @return The value displayed.
17628 * @see elm_spinner_value_set() for details.
17632 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17635 * Set whether the spinner should wrap when it reaches its
17636 * minimum or maximum value.
17638 * @param obj The spinner object.
17639 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17642 * Disabled by default. If disabled, when the user tries to increment the
17644 * but displayed value plus step value is bigger than maximum value,
17646 * won't allow it. The same happens when the user tries to decrement it,
17647 * but the value less step is less than minimum value.
17649 * When wrap is enabled, in such situations it will allow these changes,
17650 * but will get the value that would be less than minimum and subtracts
17651 * from maximum. Or add the value that would be more than maximum to
17655 * @li min value = 10
17656 * @li max value = 50
17657 * @li step value = 20
17658 * @li displayed value = 20
17660 * When the user decrement value (using left or bottom arrow), it will
17661 * displays @c 40, because max - (min - (displayed - step)) is
17662 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17664 * @see elm_spinner_wrap_get().
17668 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17671 * Get whether the spinner should wrap when it reaches its
17672 * minimum or maximum value.
17674 * @param obj The spinner object
17675 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17676 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17678 * @see elm_spinner_wrap_set() for details.
17682 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17685 * Set whether the spinner can be directly edited by the user or not.
17687 * @param obj The spinner object.
17688 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17689 * don't allow users to edit it directly.
17691 * Spinner objects can have edition @b disabled, in which state they will
17692 * be changed only by arrows.
17693 * Useful for contexts
17694 * where you don't want your users to interact with it writting the value.
17696 * when using special values, the user can see real value instead
17697 * of special label on edition.
17699 * It's enabled by default.
17701 * @see elm_spinner_editable_get()
17705 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17708 * Get whether the spinner can be directly edited by the user or not.
17710 * @param obj The spinner object.
17711 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17712 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17714 * @see elm_spinner_editable_set() for details.
17718 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17721 * Set a special string to display in the place of the numerical value.
17723 * @param obj The spinner object.
17724 * @param value The value to be replaced.
17725 * @param label The label to be used.
17727 * It's useful for cases when a user should select an item that is
17728 * better indicated by a label than a value. For example, weekdays or months.
17732 * sp = elm_spinner_add(win);
17733 * elm_spinner_min_max_set(sp, 1, 3);
17734 * elm_spinner_special_value_add(sp, 1, "January");
17735 * elm_spinner_special_value_add(sp, 2, "February");
17736 * elm_spinner_special_value_add(sp, 3, "March");
17737 * evas_object_show(sp);
17742 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17745 * Set the interval on time updates for an user mouse button hold
17746 * on spinner widgets' arrows.
17748 * @param obj The spinner object.
17749 * @param interval The (first) interval value in seconds.
17751 * This interval value is @b decreased while the user holds the
17752 * mouse pointer either incrementing or decrementing spinner's value.
17754 * This helps the user to get to a given value distant from the
17755 * current one easier/faster, as it will start to change quicker and
17756 * quicker on mouse button holds.
17758 * The calculation for the next change interval value, starting from
17759 * the one set with this call, is the previous interval divided by
17760 * @c 1.05, so it decreases a little bit.
17762 * The default starting interval value for automatic changes is
17765 * @see elm_spinner_interval_get()
17769 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17772 * Get the interval on time updates for an user mouse button hold
17773 * on spinner widgets' arrows.
17775 * @param obj The spinner object.
17776 * @return The (first) interval value, in seconds, set on it.
17778 * @see elm_spinner_interval_set() for more details.
17782 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17789 * @defgroup Index Index
17791 * @image html img/widget/index/preview-00.png
17793 * An index widget gives you an index for fast access to whichever
17794 * group of other UI items one might have. It's a list of text
17795 * items (usually letters, for alphabetically ordered access).
17797 * Index widgets are by default hidden and just appear when the
17798 * user clicks over it's reserved area in the canvas. In its
17799 * default theme, it's an area one @ref Fingers "finger" wide on
17800 * the right side of the index widget's container.
17802 * When items on the index are selected, smart callbacks get
17803 * called, so that its user can make other container objects to
17804 * show a given area or child object depending on the index item
17805 * selected. You'd probably be using an index together with @ref
17806 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17809 * Smart events one can add callbacks for are:
17810 * - @c "changed" - When the selected index item changes. @c
17811 * event_info is the selected item's data pointer.
17812 * - @c "delay,changed" - When the selected index item changes, but
17813 * after a small idling period. @c event_info is the selected
17814 * item's data pointer.
17815 * - @c "selected" - When the user releases a mouse button and
17816 * selects an item. @c event_info is the selected item's data
17818 * - @c "level,up" - when the user moves a finger from the first
17819 * level to the second level
17820 * - @c "level,down" - when the user moves a finger from the second
17821 * level to the first level
17823 * The @c "delay,changed" event is so that it'll wait a small time
17824 * before actually reporting those events and, moreover, just the
17825 * last event happening on those time frames will actually be
17828 * Here are some examples on its usage:
17829 * @li @ref index_example_01
17830 * @li @ref index_example_02
17834 * @addtogroup Index
17838 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17841 * Add a new index widget to the given parent Elementary
17842 * (container) object
17844 * @param parent The parent object
17845 * @return a new index widget handle or @c NULL, on errors
17847 * This function inserts a new index widget on the canvas.
17851 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17854 * Set whether a given index widget is or not visible,
17857 * @param obj The index object
17858 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17860 * Not to be confused with visible as in @c evas_object_show() --
17861 * visible with regard to the widget's auto hiding feature.
17863 * @see elm_index_active_get()
17867 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17870 * Get whether a given index widget is currently visible or not.
17872 * @param obj The index object
17873 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17875 * @see elm_index_active_set() for more details
17879 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17882 * Set the items level for a given index widget.
17884 * @param obj The index object.
17885 * @param level @c 0 or @c 1, the currently implemented levels.
17887 * @see elm_index_item_level_get()
17891 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17894 * Get the items level set for a given index widget.
17896 * @param obj The index object.
17897 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17899 * @see elm_index_item_level_set() for more information
17903 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17906 * Returns the last selected item's data, for a given index widget.
17908 * @param obj The index object.
17909 * @return The item @b data associated to the last selected item on
17910 * @p obj (or @c NULL, on errors).
17912 * @warning The returned value is @b not an #Elm_Index_Item item
17913 * handle, but the data associated to it (see the @c item parameter
17914 * in elm_index_item_append(), as an example).
17918 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17921 * Append a new item on a given index widget.
17923 * @param obj The index object.
17924 * @param letter Letter under which the item should be indexed
17925 * @param item The item data to set for the index's item
17927 * Despite the most common usage of the @p letter argument is for
17928 * single char strings, one could use arbitrary strings as index
17931 * @c item will be the pointer returned back on @c "changed", @c
17932 * "delay,changed" and @c "selected" smart events.
17936 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17939 * Prepend a new item on a given index widget.
17941 * @param obj The index object.
17942 * @param letter Letter under which the item should be indexed
17943 * @param item The item data to set for the index's item
17945 * Despite the most common usage of the @p letter argument is for
17946 * single char strings, one could use arbitrary strings as index
17949 * @c item will be the pointer returned back on @c "changed", @c
17950 * "delay,changed" and @c "selected" smart events.
17954 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17957 * Append a new item, on a given index widget, <b>after the item
17958 * having @p relative as data</b>.
17960 * @param obj The index object.
17961 * @param letter Letter under which the item should be indexed
17962 * @param item The item data to set for the index's item
17963 * @param relative The item data of the index item to be the
17964 * predecessor of this new one
17966 * Despite the most common usage of the @p letter argument is for
17967 * single char strings, one could use arbitrary strings as index
17970 * @c item will be the pointer returned back on @c "changed", @c
17971 * "delay,changed" and @c "selected" smart events.
17973 * @note If @p relative is @c NULL or if it's not found to be data
17974 * set on any previous item on @p obj, this function will behave as
17975 * elm_index_item_append().
17979 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17982 * Prepend a new item, on a given index widget, <b>after the item
17983 * having @p relative as data</b>.
17985 * @param obj The index object.
17986 * @param letter Letter under which the item should be indexed
17987 * @param item The item data to set for the index's item
17988 * @param relative The item data of the index item to be the
17989 * successor of this new one
17991 * Despite the most common usage of the @p letter argument is for
17992 * single char strings, one could use arbitrary strings as index
17995 * @c item will be the pointer returned back on @c "changed", @c
17996 * "delay,changed" and @c "selected" smart events.
17998 * @note If @p relative is @c NULL or if it's not found to be data
17999 * set on any previous item on @p obj, this function will behave as
18000 * elm_index_item_prepend().
18004 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18007 * Insert a new item into the given index widget, using @p cmp_func
18008 * function to sort items (by item handles).
18010 * @param obj The index object.
18011 * @param letter Letter under which the item should be indexed
18012 * @param item The item data to set for the index's item
18013 * @param cmp_func The comparing function to be used to sort index
18014 * items <b>by #Elm_Index_Item item handles</b>
18015 * @param cmp_data_func A @b fallback function to be called for the
18016 * sorting of index items <b>by item data</b>). It will be used
18017 * when @p cmp_func returns @c 0 (equality), which means an index
18018 * item with provided item data already exists. To decide which
18019 * data item should be pointed to by the index item in question, @p
18020 * cmp_data_func will be used. If @p cmp_data_func returns a
18021 * non-negative value, the previous index item data will be
18022 * replaced by the given @p item pointer. If the previous data need
18023 * to be freed, it should be done by the @p cmp_data_func function,
18024 * because all references to it will be lost. If this function is
18025 * not provided (@c NULL is given), index items will be @b
18026 * duplicated, if @p cmp_func returns @c 0.
18028 * Despite the most common usage of the @p letter argument is for
18029 * single char strings, one could use arbitrary strings as index
18032 * @c item will be the pointer returned back on @c "changed", @c
18033 * "delay,changed" and @c "selected" smart events.
18037 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);
18040 * Remove an item from a given index widget, <b>to be referenced by
18041 * it's data value</b>.
18043 * @param obj The index object
18044 * @param item The item's data pointer for the item to be removed
18047 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18048 * that callback function will be called by this one.
18050 * @warning The item to be removed from @p obj will be found via
18051 * its item data pointer, and not by an #Elm_Index_Item handle.
18055 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18058 * Find a given index widget's item, <b>using item data</b>.
18060 * @param obj The index object
18061 * @param item The item data pointed to by the desired index item
18062 * @return The index item handle, if found, or @c NULL otherwise
18066 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18069 * Removes @b all items from a given index widget.
18071 * @param obj The index object.
18073 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18074 * that callback function will be called for each item in @p obj.
18078 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18081 * Go to a given items level on a index widget
18083 * @param obj The index object
18084 * @param level The index level (one of @c 0 or @c 1)
18088 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18091 * Return the data associated with a given index widget item
18093 * @param it The index widget item handle
18094 * @return The data associated with @p it
18096 * @see elm_index_item_data_set()
18100 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18103 * Set the data associated with a given index widget item
18105 * @param it The index widget item handle
18106 * @param data The new data pointer to set to @p it
18108 * This sets new item data on @p it.
18110 * @warning The old data pointer won't be touched by this function, so
18111 * the user had better to free that old data himself/herself.
18115 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18118 * Set the function to be called when a given index widget item is freed.
18120 * @param it The item to set the callback on
18121 * @param func The function to call on the item's deletion
18123 * When called, @p func will have both @c data and @c event_info
18124 * arguments with the @p it item's data value and, naturally, the
18125 * @c obj argument with a handle to the parent index widget.
18129 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18132 * Get the letter (string) set on a given index widget item.
18134 * @param it The index item handle
18135 * @return The letter string set on @p it
18139 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18146 * @defgroup Photocam Photocam
18148 * @image html img/widget/photocam/preview-00.png
18149 * @image latex img/widget/photocam/preview-00.eps
18151 * This is a widget specifically for displaying high-resolution digital
18152 * camera photos giving speedy feedback (fast load), low memory footprint
18153 * and zooming and panning as well as fitting logic. It is entirely focused
18154 * on jpeg images, and takes advantage of properties of the jpeg format (via
18155 * evas loader features in the jpeg loader).
18157 * Signals that you can add callbacks for are:
18158 * @li "clicked" - This is called when a user has clicked the photo without
18160 * @li "press" - This is called when a user has pressed down on the photo.
18161 * @li "longpressed" - This is called when a user has pressed down on the
18162 * photo for a long time without dragging around.
18163 * @li "clicked,double" - This is called when a user has double-clicked the
18165 * @li "load" - Photo load begins.
18166 * @li "loaded" - This is called when the image file load is complete for the
18167 * first view (low resolution blurry version).
18168 * @li "load,detail" - Photo detailed data load begins.
18169 * @li "loaded,detail" - This is called when the image file load is complete
18170 * for the detailed image data (full resolution needed).
18171 * @li "zoom,start" - Zoom animation started.
18172 * @li "zoom,stop" - Zoom animation stopped.
18173 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18174 * @li "scroll" - the content has been scrolled (moved)
18175 * @li "scroll,anim,start" - scrolling animation has started
18176 * @li "scroll,anim,stop" - scrolling animation has stopped
18177 * @li "scroll,drag,start" - dragging the contents around has started
18178 * @li "scroll,drag,stop" - dragging the contents around has stopped
18180 * @ref tutorial_photocam shows the API in action.
18184 * @brief Types of zoom available.
18186 typedef enum _Elm_Photocam_Zoom_Mode
18188 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18189 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18190 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18191 ELM_PHOTOCAM_ZOOM_MODE_LAST
18192 } Elm_Photocam_Zoom_Mode;
18194 * @brief Add a new Photocam object
18196 * @param parent The parent object
18197 * @return The new object or NULL if it cannot be created
18199 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18201 * @brief Set the photo file to be shown
18203 * @param obj The photocam object
18204 * @param file The photo file
18205 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18207 * This sets (and shows) the specified file (with a relative or absolute
18208 * path) and will return a load error (same error that
18209 * evas_object_image_load_error_get() will return). The image will change and
18210 * adjust its size at this point and begin a background load process for this
18211 * photo that at some time in the future will be displayed at the full
18214 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18216 * @brief Returns the path of the current image file
18218 * @param obj The photocam object
18219 * @return Returns the path
18221 * @see elm_photocam_file_set()
18223 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18225 * @brief Set the zoom level of the photo
18227 * @param obj The photocam object
18228 * @param zoom The zoom level to set
18230 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18231 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18232 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18233 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18236 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18238 * @brief Get the zoom level of the photo
18240 * @param obj The photocam object
18241 * @return The current zoom level
18243 * This returns the current zoom level of the photocam object. Note that if
18244 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18245 * (which is the default), the zoom level may be changed at any time by the
18246 * photocam object itself to account for photo size and photocam viewpoer
18249 * @see elm_photocam_zoom_set()
18250 * @see elm_photocam_zoom_mode_set()
18252 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18254 * @brief Set the zoom mode
18256 * @param obj The photocam object
18257 * @param mode The desired mode
18259 * This sets the zoom mode to manual or one of several automatic levels.
18260 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18261 * elm_photocam_zoom_set() and will stay at that level until changed by code
18262 * or until zoom mode is changed. This is the default mode. The Automatic
18263 * modes will allow the photocam object to automatically adjust zoom mode
18264 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18265 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18266 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18267 * pixels within the frame are left unfilled.
18269 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18271 * @brief Get the zoom mode
18273 * @param obj The photocam object
18274 * @return The current zoom mode
18276 * This gets the current zoom mode of the photocam object.
18278 * @see elm_photocam_zoom_mode_set()
18280 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18282 * @brief Get the current image pixel width and height
18284 * @param obj The photocam object
18285 * @param w A pointer to the width return
18286 * @param h A pointer to the height return
18288 * This gets the current photo pixel width and height (for the original).
18289 * The size will be returned in the integers @p w and @p h that are pointed
18292 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18294 * @brief Get the area of the image that is currently shown
18297 * @param x A pointer to the X-coordinate of region
18298 * @param y A pointer to the Y-coordinate of region
18299 * @param w A pointer to the width
18300 * @param h A pointer to the height
18302 * @see elm_photocam_image_region_show()
18303 * @see elm_photocam_image_region_bring_in()
18305 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18307 * @brief Set the viewed portion of the image
18309 * @param obj The photocam object
18310 * @param x X-coordinate of region in image original pixels
18311 * @param y Y-coordinate of region in image original pixels
18312 * @param w Width of region in image original pixels
18313 * @param h Height of region in image original pixels
18315 * This shows the region of the image without using animation.
18317 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18319 * @brief Bring in the viewed portion of the image
18321 * @param obj The photocam object
18322 * @param x X-coordinate of region in image original pixels
18323 * @param y Y-coordinate of region in image original pixels
18324 * @param w Width of region in image original pixels
18325 * @param h Height of region in image original pixels
18327 * This shows the region of the image using animation.
18329 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18331 * @brief Set the paused state for photocam
18333 * @param obj The photocam object
18334 * @param paused The pause state to set
18336 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18337 * photocam. The default is off. This will stop zooming using animation on
18338 * zoom levels changes and change instantly. This will stop any existing
18339 * animations that are running.
18341 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18343 * @brief Get the paused state for photocam
18345 * @param obj The photocam object
18346 * @return The current paused state
18348 * This gets the current paused state for the photocam object.
18350 * @see elm_photocam_paused_set()
18352 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18354 * @brief Get the internal low-res image used for photocam
18356 * @param obj The photocam object
18357 * @return The internal image object handle, or NULL if none exists
18359 * This gets the internal image object inside photocam. Do not modify it. It
18360 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18361 * deleted at any time as well.
18363 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18365 * @brief Set the photocam scrolling bouncing.
18367 * @param obj The photocam object
18368 * @param h_bounce bouncing for horizontal
18369 * @param v_bounce bouncing for vertical
18371 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18373 * @brief Get the photocam scrolling bouncing.
18375 * @param obj The photocam object
18376 * @param h_bounce bouncing for horizontal
18377 * @param v_bounce bouncing for vertical
18379 * @see elm_photocam_bounce_set()
18381 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18387 * @defgroup Map Map
18388 * @ingroup Elementary
18390 * @image html img/widget/map/preview-00.png
18391 * @image latex img/widget/map/preview-00.eps
18393 * This is a widget specifically for displaying a map. It uses basically
18394 * OpenStreetMap provider http://www.openstreetmap.org/,
18395 * but custom providers can be added.
18397 * It supports some basic but yet nice features:
18398 * @li zoom and scroll
18399 * @li markers with content to be displayed when user clicks over it
18400 * @li group of markers
18403 * Smart callbacks one can listen to:
18405 * - "clicked" - This is called when a user has clicked the map without
18407 * - "press" - This is called when a user has pressed down on the map.
18408 * - "longpressed" - This is called when a user has pressed down on the map
18409 * for a long time without dragging around.
18410 * - "clicked,double" - This is called when a user has double-clicked
18412 * - "load,detail" - Map detailed data load begins.
18413 * - "loaded,detail" - This is called when all currently visible parts of
18414 * the map are loaded.
18415 * - "zoom,start" - Zoom animation started.
18416 * - "zoom,stop" - Zoom animation stopped.
18417 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18418 * - "scroll" - the content has been scrolled (moved).
18419 * - "scroll,anim,start" - scrolling animation has started.
18420 * - "scroll,anim,stop" - scrolling animation has stopped.
18421 * - "scroll,drag,start" - dragging the contents around has started.
18422 * - "scroll,drag,stop" - dragging the contents around has stopped.
18423 * - "downloaded" - This is called when all currently required map images
18425 * - "route,load" - This is called when route request begins.
18426 * - "route,loaded" - This is called when route request ends.
18427 * - "name,load" - This is called when name request begins.
18428 * - "name,loaded- This is called when name request ends.
18430 * Available style for map widget:
18433 * Available style for markers:
18438 * Available style for marker bubble:
18441 * List of examples:
18442 * @li @ref map_example_01
18443 * @li @ref map_example_02
18444 * @li @ref map_example_03
18453 * @enum _Elm_Map_Zoom_Mode
18454 * @typedef Elm_Map_Zoom_Mode
18456 * Set map's zoom behavior. It can be set to manual or automatic.
18458 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18460 * Values <b> don't </b> work as bitmask, only one can be choosen.
18462 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18463 * than the scroller view.
18465 * @see elm_map_zoom_mode_set()
18466 * @see elm_map_zoom_mode_get()
18470 typedef enum _Elm_Map_Zoom_Mode
18472 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18473 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18474 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18475 ELM_MAP_ZOOM_MODE_LAST
18476 } Elm_Map_Zoom_Mode;
18479 * @enum _Elm_Map_Route_Sources
18480 * @typedef Elm_Map_Route_Sources
18482 * Set route service to be used. By default used source is
18483 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18485 * @see elm_map_route_source_set()
18486 * @see elm_map_route_source_get()
18490 typedef enum _Elm_Map_Route_Sources
18492 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18493 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. */
18494 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18495 ELM_MAP_ROUTE_SOURCE_LAST
18496 } Elm_Map_Route_Sources;
18498 typedef enum _Elm_Map_Name_Sources
18500 ELM_MAP_NAME_SOURCE_NOMINATIM,
18501 ELM_MAP_NAME_SOURCE_LAST
18502 } Elm_Map_Name_Sources;
18505 * @enum _Elm_Map_Route_Type
18506 * @typedef Elm_Map_Route_Type
18508 * Set type of transport used on route.
18510 * @see elm_map_route_add()
18514 typedef enum _Elm_Map_Route_Type
18516 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18517 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18518 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18519 ELM_MAP_ROUTE_TYPE_LAST
18520 } Elm_Map_Route_Type;
18523 * @enum _Elm_Map_Route_Method
18524 * @typedef Elm_Map_Route_Method
18526 * Set the routing method, what should be priorized, time or distance.
18528 * @see elm_map_route_add()
18532 typedef enum _Elm_Map_Route_Method
18534 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18535 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18536 ELM_MAP_ROUTE_METHOD_LAST
18537 } Elm_Map_Route_Method;
18539 typedef enum _Elm_Map_Name_Method
18541 ELM_MAP_NAME_METHOD_SEARCH,
18542 ELM_MAP_NAME_METHOD_REVERSE,
18543 ELM_MAP_NAME_METHOD_LAST
18544 } Elm_Map_Name_Method;
18546 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(). */
18547 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(). */
18548 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(). */
18549 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(). */
18550 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18551 typedef struct _Elm_Map_Track Elm_Map_Track;
18553 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. */
18554 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18555 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18556 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18558 typedef char *(*ElmMapModuleSourceFunc) (void);
18559 typedef int (*ElmMapModuleZoomMinFunc) (void);
18560 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18561 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18562 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18563 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18564 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18565 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18566 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18569 * Add a new map widget to the given parent Elementary (container) object.
18571 * @param parent The parent object.
18572 * @return a new map widget handle or @c NULL, on errors.
18574 * This function inserts a new map widget on the canvas.
18578 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18581 * Set the zoom level of the map.
18583 * @param obj The map object.
18584 * @param zoom The zoom level to set.
18586 * This sets the zoom level.
18588 * It will respect limits defined by elm_map_source_zoom_min_set() and
18589 * elm_map_source_zoom_max_set().
18591 * By default these values are 0 (world map) and 18 (maximum zoom).
18593 * This function should be used when zoom mode is set to
18594 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18595 * with elm_map_zoom_mode_set().
18597 * @see elm_map_zoom_mode_set().
18598 * @see elm_map_zoom_get().
18602 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18605 * Get the zoom level of the map.
18607 * @param obj The map object.
18608 * @return The current zoom level.
18610 * This returns the current zoom level of the map object.
18612 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18613 * (which is the default), the zoom level may be changed at any time by the
18614 * map object itself to account for map size and map viewport size.
18616 * @see elm_map_zoom_set() for details.
18620 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18623 * Set the zoom mode used by the map object.
18625 * @param obj The map object.
18626 * @param mode The zoom mode of the map, being it one of
18627 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18628 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18630 * This sets the zoom mode to manual or one of the automatic levels.
18631 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18632 * elm_map_zoom_set() and will stay at that level until changed by code
18633 * or until zoom mode is changed. This is the default mode.
18635 * The Automatic modes will allow the map object to automatically
18636 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18637 * adjust zoom so the map fits inside the scroll frame with no pixels
18638 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18639 * ensure no pixels within the frame are left unfilled. Do not forget that
18640 * the valid sizes are 2^zoom, consequently the map may be smaller than
18641 * the scroller view.
18643 * @see elm_map_zoom_set()
18647 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18650 * Get the zoom mode used by the map object.
18652 * @param obj The map object.
18653 * @return The zoom mode of the map, being it one of
18654 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18655 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18657 * This function returns the current zoom mode used by the map object.
18659 * @see elm_map_zoom_mode_set() for more details.
18663 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18666 * Get the current coordinates of the map.
18668 * @param obj The map object.
18669 * @param lon Pointer where to store longitude.
18670 * @param lat Pointer where to store latitude.
18672 * This gets the current center coordinates of the map object. It can be
18673 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18675 * @see elm_map_geo_region_bring_in()
18676 * @see elm_map_geo_region_show()
18680 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18683 * Animatedly bring in given coordinates to the center of the map.
18685 * @param obj The map object.
18686 * @param lon Longitude to center at.
18687 * @param lat Latitude to center at.
18689 * This causes map to jump to the given @p lat and @p lon coordinates
18690 * and show it (by scrolling) in the center of the viewport, if it is not
18691 * already centered. This will use animation to do so and take a period
18692 * of time to complete.
18694 * @see elm_map_geo_region_show() for a function to avoid animation.
18695 * @see elm_map_geo_region_get()
18699 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18702 * Show the given coordinates at the center of the map, @b immediately.
18704 * @param obj The map object.
18705 * @param lon Longitude to center at.
18706 * @param lat Latitude to center at.
18708 * This causes map to @b redraw its viewport's contents to the
18709 * region contining the given @p lat and @p lon, that will be moved to the
18710 * center of the map.
18712 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18713 * @see elm_map_geo_region_get()
18717 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18720 * Pause or unpause the map.
18722 * @param obj The map object.
18723 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18726 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18729 * The default is off.
18731 * This will stop zooming using animation, changing zoom levels will
18732 * change instantly. This will stop any existing animations that are running.
18734 * @see elm_map_paused_get()
18738 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18741 * Get a value whether map is paused or not.
18743 * @param obj The map object.
18744 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18745 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18747 * This gets the current paused state for the map object.
18749 * @see elm_map_paused_set() for details.
18753 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18756 * Set to show markers during zoom level changes or not.
18758 * @param obj The map object.
18759 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18762 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18765 * The default is off.
18767 * This will stop zooming using animation, changing zoom levels will
18768 * change instantly. This will stop any existing animations that are running.
18770 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18773 * The default is off.
18775 * Enabling it will force the map to stop displaying the markers during
18776 * zoom level changes. Set to on if you have a large number of markers.
18778 * @see elm_map_paused_markers_get()
18782 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18785 * Get a value whether markers will be displayed on zoom level changes or not
18787 * @param obj The map object.
18788 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18789 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18791 * This gets the current markers paused state for the map object.
18793 * @see elm_map_paused_markers_set() for details.
18797 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18800 * Get the information of downloading status.
18802 * @param obj The map object.
18803 * @param try_num Pointer where to store number of tiles being downloaded.
18804 * @param finish_num Pointer where to store number of tiles successfully
18807 * This gets the current downloading status for the map object, the number
18808 * of tiles being downloaded and the number of tiles already downloaded.
18812 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18815 * Convert a pixel coordinate (x,y) into a geographic coordinate
18816 * (longitude, latitude).
18818 * @param obj The map object.
18819 * @param x the coordinate.
18820 * @param y the coordinate.
18821 * @param size the size in pixels of the map.
18822 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18823 * @param lon Pointer where to store the longitude that correspond to x.
18824 * @param lat Pointer where to store the latitude that correspond to y.
18826 * @note Origin pixel point is the top left corner of the viewport.
18827 * Map zoom and size are taken on account.
18829 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18833 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);
18836 * Convert a geographic coordinate (longitude, latitude) into a pixel
18837 * coordinate (x, y).
18839 * @param obj The map object.
18840 * @param lon the longitude.
18841 * @param lat the latitude.
18842 * @param size the size in pixels of the map. The map is a square
18843 * and generally his size is : pow(2.0, zoom)*256.
18844 * @param x Pointer where to store the horizontal pixel coordinate that
18845 * correspond to the longitude.
18846 * @param y Pointer where to store the vertical pixel coordinate that
18847 * correspond to the latitude.
18849 * @note Origin pixel point is the top left corner of the viewport.
18850 * Map zoom and size are taken on account.
18852 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18856 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);
18859 * Convert a geographic coordinate (longitude, latitude) into a name
18862 * @param obj The map object.
18863 * @param lon the longitude.
18864 * @param lat the latitude.
18865 * @return name A #Elm_Map_Name handle for this coordinate.
18867 * To get the string for this address, elm_map_name_address_get()
18870 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18874 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18877 * Convert a name (address) into a geographic coordinate
18878 * (longitude, latitude).
18880 * @param obj The map object.
18881 * @param name The address.
18882 * @return name A #Elm_Map_Name handle for this address.
18884 * To get the longitude and latitude, elm_map_name_region_get()
18887 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18891 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18894 * Convert a pixel coordinate into a rotated pixel coordinate.
18896 * @param obj The map object.
18897 * @param x horizontal coordinate of the point to rotate.
18898 * @param y vertical coordinate of the point to rotate.
18899 * @param cx rotation's center horizontal position.
18900 * @param cy rotation's center vertical position.
18901 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18902 * @param xx Pointer where to store rotated x.
18903 * @param yy Pointer where to store rotated y.
18907 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);
18910 * Add a new marker to the map object.
18912 * @param obj The map object.
18913 * @param lon The longitude of the marker.
18914 * @param lat The latitude of the marker.
18915 * @param clas The class, to use when marker @b isn't grouped to others.
18916 * @param clas_group The class group, to use when marker is grouped to others
18917 * @param data The data passed to the callbacks.
18919 * @return The created marker or @c NULL upon failure.
18921 * A marker will be created and shown in a specific point of the map, defined
18922 * by @p lon and @p lat.
18924 * It will be displayed using style defined by @p class when this marker
18925 * is displayed alone (not grouped). A new class can be created with
18926 * elm_map_marker_class_new().
18928 * If the marker is grouped to other markers, it will be displayed with
18929 * style defined by @p class_group. Markers with the same group are grouped
18930 * if they are close. A new group class can be created with
18931 * elm_map_marker_group_class_new().
18933 * Markers created with this method can be deleted with
18934 * elm_map_marker_remove().
18936 * A marker can have associated content to be displayed by a bubble,
18937 * when a user click over it, as well as an icon. These objects will
18938 * be fetch using class' callback functions.
18940 * @see elm_map_marker_class_new()
18941 * @see elm_map_marker_group_class_new()
18942 * @see elm_map_marker_remove()
18946 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);
18949 * Set the maximum numbers of markers' content to be displayed in a group.
18951 * @param obj The map object.
18952 * @param max The maximum numbers of items displayed in a bubble.
18954 * A bubble will be displayed when the user clicks over the group,
18955 * and will place the content of markers that belong to this group
18958 * A group can have a long list of markers, consequently the creation
18959 * of the content of the bubble can be very slow.
18961 * In order to avoid this, a maximum number of items is displayed
18964 * By default this number is 30.
18966 * Marker with the same group class are grouped if they are close.
18968 * @see elm_map_marker_add()
18972 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18975 * Remove a marker from the map.
18977 * @param marker The marker to remove.
18979 * @see elm_map_marker_add()
18983 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18986 * Get the current coordinates of the marker.
18988 * @param marker marker.
18989 * @param lat Pointer where to store the marker's latitude.
18990 * @param lon Pointer where to store the marker's longitude.
18992 * These values are set when adding markers, with function
18993 * elm_map_marker_add().
18995 * @see elm_map_marker_add()
18999 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19002 * Animatedly bring in given marker to the center of the map.
19004 * @param marker The marker to center at.
19006 * This causes map to jump to the given @p marker's coordinates
19007 * and show it (by scrolling) in the center of the viewport, if it is not
19008 * already centered. This will use animation to do so and take a period
19009 * of time to complete.
19011 * @see elm_map_marker_show() for a function to avoid animation.
19012 * @see elm_map_marker_region_get()
19016 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19019 * Show the given marker at the center of the map, @b immediately.
19021 * @param marker The marker to center at.
19023 * This causes map to @b redraw its viewport's contents to the
19024 * region contining the given @p marker's coordinates, that will be
19025 * moved to the center of the map.
19027 * @see elm_map_marker_bring_in() for a function to move with animation.
19028 * @see elm_map_markers_list_show() if more than one marker need to be
19030 * @see elm_map_marker_region_get()
19034 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19037 * Move and zoom the map to display a list of markers.
19039 * @param markers A list of #Elm_Map_Marker handles.
19041 * The map will be centered on the center point of the markers in the list.
19042 * Then the map will be zoomed in order to fit the markers using the maximum
19043 * zoom which allows display of all the markers.
19045 * @warning All the markers should belong to the same map object.
19047 * @see elm_map_marker_show() to show a single marker.
19048 * @see elm_map_marker_bring_in()
19052 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19055 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19057 * @param marker The marker wich content should be returned.
19058 * @return Return the evas object if it exists, else @c NULL.
19060 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19061 * elm_map_marker_class_get_cb_set() should be used.
19063 * This content is what will be inside the bubble that will be displayed
19064 * when an user clicks over the marker.
19066 * This returns the actual Evas object used to be placed inside
19067 * the bubble. This may be @c NULL, as it may
19068 * not have been created or may have been deleted, at any time, by
19069 * the map. <b>Do not modify this object</b> (move, resize,
19070 * show, hide, etc.), as the map is controlling it. This
19071 * function is for querying, emitting custom signals or hooking
19072 * lower level callbacks for events on that object. Do not delete
19073 * this object under any circumstances.
19077 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19080 * Update the marker
19082 * @param marker The marker to be updated.
19084 * If a content is set to this marker, it will call function to delete it,
19085 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19086 * #ElmMapMarkerGetFunc.
19088 * These functions are set for the marker class with
19089 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19093 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19096 * Close all the bubbles opened by the user.
19098 * @param obj The map object.
19100 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19101 * when the user clicks on a marker.
19103 * This functions is set for the marker class with
19104 * elm_map_marker_class_get_cb_set().
19108 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19111 * Create a new group class.
19113 * @param obj The map object.
19114 * @return Returns the new group class.
19116 * Each marker must be associated to a group class. Markers in the same
19117 * group are grouped if they are close.
19119 * The group class defines the style of the marker when a marker is grouped
19120 * to others markers. When it is alone, another class will be used.
19122 * A group class will need to be provided when creating a marker with
19123 * elm_map_marker_add().
19125 * Some properties and functions can be set by class, as:
19126 * - style, with elm_map_group_class_style_set()
19127 * - data - to be associated to the group class. It can be set using
19128 * elm_map_group_class_data_set().
19129 * - min zoom to display markers, set with
19130 * elm_map_group_class_zoom_displayed_set().
19131 * - max zoom to group markers, set using
19132 * elm_map_group_class_zoom_grouped_set().
19133 * - visibility - set if markers will be visible or not, set with
19134 * elm_map_group_class_hide_set().
19135 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19136 * It can be set using elm_map_group_class_icon_cb_set().
19138 * @see elm_map_marker_add()
19139 * @see elm_map_group_class_style_set()
19140 * @see elm_map_group_class_data_set()
19141 * @see elm_map_group_class_zoom_displayed_set()
19142 * @see elm_map_group_class_zoom_grouped_set()
19143 * @see elm_map_group_class_hide_set()
19144 * @see elm_map_group_class_icon_cb_set()
19148 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19151 * Set the marker's style of a group class.
19153 * @param clas The group class.
19154 * @param style The style to be used by markers.
19156 * Each marker must be associated to a group class, and will use the style
19157 * defined by such class when grouped to other markers.
19159 * The following styles are provided by default theme:
19160 * @li @c radio - blue circle
19161 * @li @c radio2 - green circle
19164 * @see elm_map_group_class_new() for more details.
19165 * @see elm_map_marker_add()
19169 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19172 * Set the icon callback function of a group class.
19174 * @param clas The group class.
19175 * @param icon_get The callback function that will return the icon.
19177 * Each marker must be associated to a group class, and it can display a
19178 * custom icon. The function @p icon_get must return this icon.
19180 * @see elm_map_group_class_new() for more details.
19181 * @see elm_map_marker_add()
19185 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19188 * Set the data associated to the group class.
19190 * @param clas The group class.
19191 * @param data The new user data.
19193 * This data will be passed for callback functions, like icon get callback,
19194 * that can be set with elm_map_group_class_icon_cb_set().
19196 * If a data was previously set, the object will lose the pointer for it,
19197 * so if needs to be freed, you must do it yourself.
19199 * @see elm_map_group_class_new() for more details.
19200 * @see elm_map_group_class_icon_cb_set()
19201 * @see elm_map_marker_add()
19205 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19208 * Set the minimum zoom from where the markers are displayed.
19210 * @param clas The group class.
19211 * @param zoom The minimum zoom.
19213 * Markers only will be displayed when the map is displayed at @p zoom
19216 * @see elm_map_group_class_new() for more details.
19217 * @see elm_map_marker_add()
19221 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19224 * Set the zoom from where the markers are no more grouped.
19226 * @param clas The group class.
19227 * @param zoom The maximum zoom.
19229 * Markers only will be grouped when the map is displayed at
19230 * less than @p zoom.
19232 * @see elm_map_group_class_new() for more details.
19233 * @see elm_map_marker_add()
19237 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19240 * Set if the markers associated to the group class @clas are hidden or not.
19242 * @param clas The group class.
19243 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19246 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19251 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19254 * Create a new marker class.
19256 * @param obj The map object.
19257 * @return Returns the new group class.
19259 * Each marker must be associated to a class.
19261 * The marker class defines the style of the marker when a marker is
19262 * displayed alone, i.e., not grouped to to others markers. When grouped
19263 * it will use group class style.
19265 * A marker class will need to be provided when creating a marker with
19266 * elm_map_marker_add().
19268 * Some properties and functions can be set by class, as:
19269 * - style, with elm_map_marker_class_style_set()
19270 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19271 * It can be set using elm_map_marker_class_icon_cb_set().
19272 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19273 * Set using elm_map_marker_class_get_cb_set().
19274 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19275 * Set using elm_map_marker_class_del_cb_set().
19277 * @see elm_map_marker_add()
19278 * @see elm_map_marker_class_style_set()
19279 * @see elm_map_marker_class_icon_cb_set()
19280 * @see elm_map_marker_class_get_cb_set()
19281 * @see elm_map_marker_class_del_cb_set()
19285 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19288 * Set the marker's style of a marker class.
19290 * @param clas The marker class.
19291 * @param style The style to be used by markers.
19293 * Each marker must be associated to a marker class, and will use the style
19294 * defined by such class when alone, i.e., @b not grouped to other markers.
19296 * The following styles are provided by default theme:
19301 * @see elm_map_marker_class_new() for more details.
19302 * @see elm_map_marker_add()
19306 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19309 * Set the icon callback function of a marker class.
19311 * @param clas The marker class.
19312 * @param icon_get The callback function that will return the icon.
19314 * Each marker must be associated to a marker class, and it can display a
19315 * custom icon. The function @p icon_get must return this icon.
19317 * @see elm_map_marker_class_new() for more details.
19318 * @see elm_map_marker_add()
19322 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19325 * Set the bubble content callback function of a marker class.
19327 * @param clas The marker class.
19328 * @param get The callback function that will return the content.
19330 * Each marker must be associated to a marker class, and it can display a
19331 * a content on a bubble that opens when the user click over the marker.
19332 * The function @p get must return this content object.
19334 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19337 * @see elm_map_marker_class_new() for more details.
19338 * @see elm_map_marker_class_del_cb_set()
19339 * @see elm_map_marker_add()
19343 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19346 * Set the callback function used to delete bubble content of a marker class.
19348 * @param clas The marker class.
19349 * @param del The callback function that will delete the content.
19351 * Each marker must be associated to a marker class, and it can display a
19352 * a content on a bubble that opens when the user click over the marker.
19353 * The function to return such content can be set with
19354 * elm_map_marker_class_get_cb_set().
19356 * If this content must be freed, a callback function need to be
19357 * set for that task with this function.
19359 * If this callback is defined it will have to delete (or not) the
19360 * object inside, but if the callback is not defined the object will be
19361 * destroyed with evas_object_del().
19363 * @see elm_map_marker_class_new() for more details.
19364 * @see elm_map_marker_class_get_cb_set()
19365 * @see elm_map_marker_add()
19369 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19372 * Get the list of available sources.
19374 * @param obj The map object.
19375 * @return The source names list.
19377 * It will provide a list with all available sources, that can be set as
19378 * current source with elm_map_source_name_set(), or get with
19379 * elm_map_source_name_get().
19381 * Available sources:
19387 * @see elm_map_source_name_set() for more details.
19388 * @see elm_map_source_name_get()
19392 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19395 * Set the source of the map.
19397 * @param obj The map object.
19398 * @param source The source to be used.
19400 * Map widget retrieves images that composes the map from a web service.
19401 * This web service can be set with this method.
19403 * A different service can return a different maps with different
19404 * information and it can use different zoom values.
19406 * The @p source_name need to match one of the names provided by
19407 * elm_map_source_names_get().
19409 * The current source can be get using elm_map_source_name_get().
19411 * @see elm_map_source_names_get()
19412 * @see elm_map_source_name_get()
19417 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19420 * Get the name of currently used source.
19422 * @param obj The map object.
19423 * @return Returns the name of the source in use.
19425 * @see elm_map_source_name_set() for more details.
19429 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19432 * Set the source of the route service to be used by the map.
19434 * @param obj The map object.
19435 * @param source The route service to be used, being it one of
19436 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19437 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19439 * Each one has its own algorithm, so the route retrieved may
19440 * differ depending on the source route. Now, only the default is working.
19442 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19443 * http://www.yournavigation.org/.
19445 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19446 * assumptions. Its routing core is based on Contraction Hierarchies.
19448 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19450 * @see elm_map_route_source_get().
19454 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19457 * Get the current route source.
19459 * @param obj The map object.
19460 * @return The source of the route service used by the map.
19462 * @see elm_map_route_source_set() for details.
19466 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19469 * Set the minimum zoom of the source.
19471 * @param obj The map object.
19472 * @param zoom New minimum zoom value to be used.
19474 * By default, it's 0.
19478 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19481 * Get the minimum zoom of the source.
19483 * @param obj The map object.
19484 * @return Returns the minimum zoom of the source.
19486 * @see elm_map_source_zoom_min_set() for details.
19490 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19493 * Set the maximum zoom of the source.
19495 * @param obj The map object.
19496 * @param zoom New maximum zoom value to be used.
19498 * By default, it's 18.
19502 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19505 * Get the maximum zoom of the source.
19507 * @param obj The map object.
19508 * @return Returns the maximum zoom of the source.
19510 * @see elm_map_source_zoom_min_set() for details.
19514 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19517 * Set the user agent used by the map object to access routing services.
19519 * @param obj The map object.
19520 * @param user_agent The user agent to be used by the map.
19522 * User agent is a client application implementing a network protocol used
19523 * in communications within a client–server distributed computing system
19525 * The @p user_agent identification string will transmitted in a header
19526 * field @c User-Agent.
19528 * @see elm_map_user_agent_get()
19532 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19535 * Get the user agent used by the map object.
19537 * @param obj The map object.
19538 * @return The user agent identification string used by the map.
19540 * @see elm_map_user_agent_set() for details.
19544 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19547 * Add a new route to the map object.
19549 * @param obj The map object.
19550 * @param type The type of transport to be considered when tracing a route.
19551 * @param method The routing method, what should be priorized.
19552 * @param flon The start longitude.
19553 * @param flat The start latitude.
19554 * @param tlon The destination longitude.
19555 * @param tlat The destination latitude.
19557 * @return The created route or @c NULL upon failure.
19559 * A route will be traced by point on coordinates (@p flat, @p flon)
19560 * to point on coordinates (@p tlat, @p tlon), using the route service
19561 * set with elm_map_route_source_set().
19563 * It will take @p type on consideration to define the route,
19564 * depending if the user will be walking or driving, the route may vary.
19565 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19566 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19568 * Another parameter is what the route should priorize, the minor distance
19569 * or the less time to be spend on the route. So @p method should be one
19570 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19572 * Routes created with this method can be deleted with
19573 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19574 * and distance can be get with elm_map_route_distance_get().
19576 * @see elm_map_route_remove()
19577 * @see elm_map_route_color_set()
19578 * @see elm_map_route_distance_get()
19579 * @see elm_map_route_source_set()
19583 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);
19586 * Remove a route from the map.
19588 * @param route The route to remove.
19590 * @see elm_map_route_add()
19594 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19597 * Set the route color.
19599 * @param route The route object.
19600 * @param r Red channel value, from 0 to 255.
19601 * @param g Green channel value, from 0 to 255.
19602 * @param b Blue channel value, from 0 to 255.
19603 * @param a Alpha channel value, from 0 to 255.
19605 * It uses an additive color model, so each color channel represents
19606 * how much of each primary colors must to be used. 0 represents
19607 * ausence of this color, so if all of the three are set to 0,
19608 * the color will be black.
19610 * These component values should be integers in the range 0 to 255,
19611 * (single 8-bit byte).
19613 * This sets the color used for the route. By default, it is set to
19614 * solid red (r = 255, g = 0, b = 0, a = 255).
19616 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19618 * @see elm_map_route_color_get()
19622 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19625 * Get the route color.
19627 * @param route The route object.
19628 * @param r Pointer where to store the red channel value.
19629 * @param g Pointer where to store the green channel value.
19630 * @param b Pointer where to store the blue channel value.
19631 * @param a Pointer where to store the alpha channel value.
19633 * @see elm_map_route_color_set() for details.
19637 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19640 * Get the route distance in kilometers.
19642 * @param route The route object.
19643 * @return The distance of route (unit : km).
19647 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19650 * Get the information of route nodes.
19652 * @param route The route object.
19653 * @return Returns a string with the nodes of route.
19657 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19660 * Get the information of route waypoint.
19662 * @param route the route object.
19663 * @return Returns a string with information about waypoint of route.
19667 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19670 * Get the address of the name.
19672 * @param name The name handle.
19673 * @return Returns the address string of @p name.
19675 * This gets the coordinates of the @p name, created with one of the
19676 * conversion functions.
19678 * @see elm_map_utils_convert_name_into_coord()
19679 * @see elm_map_utils_convert_coord_into_name()
19683 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19686 * Get the current coordinates of the name.
19688 * @param name The name handle.
19689 * @param lat Pointer where to store the latitude.
19690 * @param lon Pointer where to store The longitude.
19692 * This gets the coordinates of the @p name, created with one of the
19693 * conversion functions.
19695 * @see elm_map_utils_convert_name_into_coord()
19696 * @see elm_map_utils_convert_coord_into_name()
19700 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19703 * Remove a name from the map.
19705 * @param name The name to remove.
19707 * Basically the struct handled by @p name will be freed, so convertions
19708 * between address and coordinates will be lost.
19710 * @see elm_map_utils_convert_name_into_coord()
19711 * @see elm_map_utils_convert_coord_into_name()
19715 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19720 * @param obj The map object.
19721 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19722 * @param cx Rotation's center horizontal position.
19723 * @param cy Rotation's center vertical position.
19725 * @see elm_map_rotate_get()
19729 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19732 * Get the rotate degree of the map
19734 * @param obj The map object
19735 * @param degree Pointer where to store degrees from 0.0 to 360.0
19736 * to rotate arount Z axis.
19737 * @param cx Pointer where to store rotation's center horizontal position.
19738 * @param cy Pointer where to store rotation's center vertical position.
19740 * @see elm_map_rotate_set() to set map rotation.
19744 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);
19747 * Enable or disable mouse wheel to be used to zoom in / out the map.
19749 * @param obj The map object.
19750 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19753 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19755 * It's disabled by default.
19757 * @see elm_map_wheel_disabled_get()
19761 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19764 * Get a value whether mouse wheel is enabled or not.
19766 * @param obj The map object.
19767 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19768 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19770 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19772 * @see elm_map_wheel_disabled_set() for details.
19776 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19780 * Add a track on the map
19782 * @param obj The map object.
19783 * @param emap The emap route object.
19784 * @return The route object. This is an elm object of type Route.
19786 * @see elm_route_add() for details.
19790 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19794 * Remove a track from the map
19796 * @param obj The map object.
19797 * @param route The track to remove.
19801 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19808 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19810 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19812 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19813 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19814 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19815 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19819 * @defgroup Panel Panel
19821 * @image html img/widget/panel/preview-00.png
19822 * @image latex img/widget/panel/preview-00.eps
19824 * @brief A panel is a type of animated container that contains subobjects.
19825 * It can be expanded or contracted by clicking the button on it's edge.
19827 * Orientations are as follows:
19828 * @li ELM_PANEL_ORIENT_TOP
19829 * @li ELM_PANEL_ORIENT_LEFT
19830 * @li ELM_PANEL_ORIENT_RIGHT
19832 * @ref tutorial_panel shows one way to use this widget.
19835 typedef enum _Elm_Panel_Orient
19837 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19838 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19839 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19840 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19841 } Elm_Panel_Orient;
19843 * @brief Adds a panel object
19845 * @param parent The parent object
19847 * @return The panel object, or NULL on failure
19849 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19851 * @brief Sets the orientation of the panel
19853 * @param parent The parent object
19854 * @param orient The panel orientation. Can be one of the following:
19855 * @li ELM_PANEL_ORIENT_TOP
19856 * @li ELM_PANEL_ORIENT_LEFT
19857 * @li ELM_PANEL_ORIENT_RIGHT
19859 * Sets from where the panel will (dis)appear.
19861 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19863 * @brief Get the orientation of the panel.
19865 * @param obj The panel object
19866 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19868 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19870 * @brief Set the content of the panel.
19872 * @param obj The panel object
19873 * @param content The panel content
19875 * Once the content object is set, a previously set one will be deleted.
19876 * If you want to keep that old content object, use the
19877 * elm_panel_content_unset() function.
19879 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19881 * @brief Get the content of the panel.
19883 * @param obj The panel object
19884 * @return The content that is being used
19886 * Return the content object which is set for this widget.
19888 * @see elm_panel_content_set()
19890 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19892 * @brief Unset the content of the panel.
19894 * @param obj The panel object
19895 * @return The content that was being used
19897 * Unparent and return the content object which was set for this widget.
19899 * @see elm_panel_content_set()
19901 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19903 * @brief Set the state of the panel.
19905 * @param obj The panel object
19906 * @param hidden If true, the panel will run the animation to contract
19908 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19910 * @brief Get the state of the panel.
19912 * @param obj The panel object
19913 * @param hidden If true, the panel is in the "hide" state
19915 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19917 * @brief Toggle the hidden state of the panel from code
19919 * @param obj The panel object
19921 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19927 * @defgroup Panes Panes
19928 * @ingroup Elementary
19930 * @image html img/widget/panes/preview-00.png
19931 * @image latex img/widget/panes/preview-00.eps width=\textwidth
19933 * @image html img/panes.png
19934 * @image latex img/panes.eps width=\textwidth
19936 * The panes adds a dragable bar between two contents. When dragged
19937 * this bar will resize contents size.
19939 * Panes can be displayed vertically or horizontally, and contents
19940 * size proportion can be customized (homogeneous by default).
19942 * Smart callbacks one can listen to:
19943 * - "press" - The panes has been pressed (button wasn't released yet).
19944 * - "unpressed" - The panes was released after being pressed.
19945 * - "clicked" - The panes has been clicked>
19946 * - "clicked,double" - The panes has been double clicked
19948 * Available styles for it:
19951 * Here is an example on its usage:
19952 * @li @ref panes_example
19956 * @addtogroup Panes
19961 * Add a new panes widget to the given parent Elementary
19962 * (container) object.
19964 * @param parent The parent object.
19965 * @return a new panes widget handle or @c NULL, on errors.
19967 * This function inserts a new panes widget on the canvas.
19971 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19974 * Set the left content of the panes widget.
19976 * @param obj The panes object.
19977 * @param content The new left content object.
19979 * Once the content object is set, a previously set one will be deleted.
19980 * If you want to keep that old content object, use the
19981 * elm_panes_content_left_unset() function.
19983 * If panes is displayed vertically, left content will be displayed at
19986 * @see elm_panes_content_left_get()
19987 * @see elm_panes_content_right_set() to set content on the other side.
19991 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19994 * Set the right content of the panes widget.
19996 * @param obj The panes object.
19997 * @param content The new right content object.
19999 * Once the content object is set, a previously set one will be deleted.
20000 * If you want to keep that old content object, use the
20001 * elm_panes_content_right_unset() function.
20003 * If panes is displayed vertically, left content will be displayed at
20006 * @see elm_panes_content_right_get()
20007 * @see elm_panes_content_left_set() to set content on the other side.
20011 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20014 * Get the left content of the panes.
20016 * @param obj The panes object.
20017 * @return The left content object that is being used.
20019 * Return the left content object which is set for this widget.
20021 * @see elm_panes_content_left_set() for details.
20025 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20028 * Get the right content of the panes.
20030 * @param obj The panes object
20031 * @return The right content object that is being used
20033 * Return the right content object which is set for this widget.
20035 * @see elm_panes_content_right_set() for details.
20039 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20042 * Unset the left content used for the panes.
20044 * @param obj The panes object.
20045 * @return The left content object that was being used.
20047 * Unparent and return the left content object which was set for this widget.
20049 * @see elm_panes_content_left_set() for details.
20050 * @see elm_panes_content_left_get().
20054 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20057 * Unset the right content used for the panes.
20059 * @param obj The panes object.
20060 * @return The right content object that was being used.
20062 * Unparent and return the right content object which was set for this
20065 * @see elm_panes_content_right_set() for details.
20066 * @see elm_panes_content_right_get().
20070 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20073 * Get the size proportion of panes widget's left side.
20075 * @param obj The panes object.
20076 * @return float value between 0.0 and 1.0 representing size proportion
20079 * @see elm_panes_content_left_size_set() for more details.
20083 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20086 * Set the size proportion of panes widget's left side.
20088 * @param obj The panes object.
20089 * @param size Value between 0.0 and 1.0 representing size proportion
20092 * By default it's homogeneous, i.e., both sides have the same size.
20094 * If something different is required, it can be set with this function.
20095 * For example, if the left content should be displayed over
20096 * 75% of the panes size, @p size should be passed as @c 0.75.
20097 * This way, right content will be resized to 25% of panes size.
20099 * If displayed vertically, left content is displayed at top, and
20100 * right content at bottom.
20102 * @note This proportion will change when user drags the panes bar.
20104 * @see elm_panes_content_left_size_get()
20108 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20111 * Set the orientation of a given panes widget.
20113 * @param obj The panes object.
20114 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20115 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20117 * Use this function to change how your panes is to be
20118 * disposed: vertically or horizontally.
20120 * By default it's displayed horizontally.
20122 * @see elm_panes_horizontal_get()
20126 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20129 * Retrieve the orientation of a given panes widget.
20131 * @param obj The panes object.
20132 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20133 * @c EINA_FALSE if it's @b vertical (and on errors).
20135 * @see elm_panes_horizontal_set() for more details.
20139 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20146 * @defgroup Flip Flip
20148 * @image html img/widget/flip/preview-00.png
20149 * @image latex img/widget/flip/preview-00.eps
20151 * This widget holds 2 content objects(Evas_Object): one on the front and one
20152 * on the back. It allows you to flip from front to back and vice-versa using
20153 * various animations.
20155 * If either the front or back contents are not set the flip will treat that
20156 * as transparent. So if you wore to set the front content but not the back,
20157 * and then call elm_flip_go() you would see whatever is below the flip.
20159 * For a list of supported animations see elm_flip_go().
20161 * Signals that you can add callbacks for are:
20162 * "animate,begin" - when a flip animation was started
20163 * "animate,done" - when a flip animation is finished
20165 * @ref tutorial_flip show how to use most of the API.
20169 typedef enum _Elm_Flip_Mode
20171 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20172 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20173 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20174 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20175 ELM_FLIP_CUBE_LEFT,
20176 ELM_FLIP_CUBE_RIGHT,
20178 ELM_FLIP_CUBE_DOWN,
20179 ELM_FLIP_PAGE_LEFT,
20180 ELM_FLIP_PAGE_RIGHT,
20184 typedef enum _Elm_Flip_Interaction
20186 ELM_FLIP_INTERACTION_NONE,
20187 ELM_FLIP_INTERACTION_ROTATE,
20188 ELM_FLIP_INTERACTION_CUBE,
20189 ELM_FLIP_INTERACTION_PAGE
20190 } Elm_Flip_Interaction;
20191 typedef enum _Elm_Flip_Direction
20193 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20194 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20195 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20196 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20197 } Elm_Flip_Direction;
20199 * @brief Add a new flip to the parent
20201 * @param parent The parent object
20202 * @return The new object or NULL if it cannot be created
20204 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20206 * @brief Set the front content of the flip widget.
20208 * @param obj The flip object
20209 * @param content The new front content object
20211 * Once the content object is set, a previously set one will be deleted.
20212 * If you want to keep that old content object, use the
20213 * elm_flip_content_front_unset() function.
20215 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20217 * @brief Set the back content of the flip widget.
20219 * @param obj The flip object
20220 * @param content The new back content object
20222 * Once the content object is set, a previously set one will be deleted.
20223 * If you want to keep that old content object, use the
20224 * elm_flip_content_back_unset() function.
20226 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20228 * @brief Get the front content used for the flip
20230 * @param obj The flip object
20231 * @return The front content object that is being used
20233 * Return the front content object which is set for this widget.
20235 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20237 * @brief Get the back content used for the flip
20239 * @param obj The flip object
20240 * @return The back content object that is being used
20242 * Return the back content object which is set for this widget.
20244 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20246 * @brief Unset the front content used for the flip
20248 * @param obj The flip object
20249 * @return The front content object that was being used
20251 * Unparent and return the front content object which was set for this widget.
20253 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20255 * @brief Unset the back content used for the flip
20257 * @param obj The flip object
20258 * @return The back content object that was being used
20260 * Unparent and return the back content object which was set for this widget.
20262 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20264 * @brief Get flip front visibility state
20266 * @param obj The flip objct
20267 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20270 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20272 * @brief Set flip perspective
20274 * @param obj The flip object
20275 * @param foc The coordinate to set the focus on
20276 * @param x The X coordinate
20277 * @param y The Y coordinate
20279 * @warning This function currently does nothing.
20281 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20283 * @brief Runs the flip animation
20285 * @param obj The flip object
20286 * @param mode The mode type
20288 * Flips the front and back contents using the @p mode animation. This
20289 * efectively hides the currently visible content and shows the hidden one.
20291 * There a number of possible animations to use for the flipping:
20292 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20293 * around a horizontal axis in the middle of its height, the other content
20294 * is shown as the other side of the flip.
20295 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20296 * around a vertical axis in the middle of its width, the other content is
20297 * shown as the other side of the flip.
20298 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20299 * around a diagonal axis in the middle of its width, the other content is
20300 * shown as the other side of the flip.
20301 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20302 * around a diagonal axis in the middle of its height, the other content is
20303 * shown as the other side of the flip.
20304 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20305 * as if the flip was a cube, the other content is show as the right face of
20307 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20308 * right as if the flip was a cube, the other content is show as the left
20309 * face of the cube.
20310 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20311 * flip was a cube, the other content is show as the bottom face of the cube.
20312 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20313 * the flip was a cube, the other content is show as the upper face of the
20315 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20316 * if the flip was a book, the other content is shown as the page below that.
20317 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20318 * as if the flip was a book, the other content is shown as the page below
20320 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20321 * flip was a book, the other content is shown as the page below that.
20322 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20323 * flip was a book, the other content is shown as the page below that.
20325 * @image html elm_flip.png
20326 * @image latex elm_flip.eps width=\textwidth
20328 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20330 * @brief Set the interactive flip mode
20332 * @param obj The flip object
20333 * @param mode The interactive flip mode to use
20335 * This sets if the flip should be interactive (allow user to click and
20336 * drag a side of the flip to reveal the back page and cause it to flip).
20337 * By default a flip is not interactive. You may also need to set which
20338 * sides of the flip are "active" for flipping and how much space they use
20339 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20340 * and elm_flip_interacton_direction_hitsize_set()
20342 * The four avilable mode of interaction are:
20343 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20344 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20345 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20346 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20348 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20349 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20350 * happen, those can only be acheived with elm_flip_go();
20352 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20354 * @brief Get the interactive flip mode
20356 * @param obj The flip object
20357 * @return The interactive flip mode
20359 * Returns the interactive flip mode set by elm_flip_interaction_set()
20361 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20363 * @brief Set which directions of the flip respond to interactive flip
20365 * @param obj The flip object
20366 * @param dir The direction to change
20367 * @param enabled If that direction is enabled or not
20369 * By default all directions are disabled, so you may want to enable the
20370 * desired directions for flipping if you need interactive flipping. You must
20371 * call this function once for each direction that should be enabled.
20373 * @see elm_flip_interaction_set()
20375 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20377 * @brief Get the enabled state of that flip direction
20379 * @param obj The flip object
20380 * @param dir The direction to check
20381 * @return If that direction is enabled or not
20383 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20385 * @see elm_flip_interaction_set()
20387 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20389 * @brief Set the amount of the flip that is sensitive to interactive flip
20391 * @param obj The flip object
20392 * @param dir The direction to modify
20393 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20395 * Set the amount of the flip that is sensitive to interactive flip, with 0
20396 * representing no area in the flip and 1 representing the entire flip. There
20397 * is however a consideration to be made in that the area will never be
20398 * smaller than the finger size set(as set in your Elementary configuration).
20400 * @see elm_flip_interaction_set()
20402 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20404 * @brief Get the amount of the flip that is sensitive to interactive flip
20406 * @param obj The flip object
20407 * @param dir The direction to check
20408 * @return The size set for that direction
20410 * Returns the amount os sensitive area set by
20411 * elm_flip_interacton_direction_hitsize_set().
20413 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20418 /* scrolledentry */
20419 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20420 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20421 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20422 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20423 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20424 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20425 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20426 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20427 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20428 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20429 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20430 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20431 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20432 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20433 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20434 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20435 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20436 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20437 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20438 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20439 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20440 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20441 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20442 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20443 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20444 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20445 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20446 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20447 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20448 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20449 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20450 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20451 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20452 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20453 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20454 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);
20455 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20456 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20457 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);
20458 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20459 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);
20460 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20461 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20462 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20463 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20464 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20465 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20466 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20467 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20468 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);
20469 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);
20470 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);
20471 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);
20472 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);
20473 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);
20474 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20475 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20476 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20477 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20478 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20479 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20480 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20483 * @defgroup Conformant Conformant
20484 * @ingroup Elementary
20486 * @image html img/widget/conformant/preview-00.png
20487 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20489 * @image html img/conformant.png
20490 * @image latex img/conformant.eps width=\textwidth
20492 * The aim is to provide a widget that can be used in elementary apps to
20493 * account for space taken up by the indicator, virtual keypad & softkey
20494 * windows when running the illume2 module of E17.
20496 * So conformant content will be sized and positioned considering the
20497 * space required for such stuff, and when they popup, as a keyboard
20498 * shows when an entry is selected, conformant content won't change.
20500 * Available styles for it:
20503 * See how to use this widget in this example:
20504 * @ref conformant_example
20508 * @addtogroup Conformant
20513 * Add a new conformant widget to the given parent Elementary
20514 * (container) object.
20516 * @param parent The parent object.
20517 * @return A new conformant widget handle or @c NULL, on errors.
20519 * This function inserts a new conformant widget on the canvas.
20521 * @ingroup Conformant
20523 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20526 * Set the content of the conformant widget.
20528 * @param obj The conformant object.
20529 * @param content The content to be displayed by the conformant.
20531 * Content will be sized and positioned considering the space required
20532 * to display a virtual keyboard. So it won't fill all the conformant
20533 * size. This way is possible to be sure that content won't resize
20534 * or be re-positioned after the keyboard is displayed.
20536 * Once the content object is set, a previously set one will be deleted.
20537 * If you want to keep that old content object, use the
20538 * elm_conformat_content_unset() function.
20540 * @see elm_conformant_content_unset()
20541 * @see elm_conformant_content_get()
20543 * @ingroup Conformant
20545 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20548 * Get the content of the conformant widget.
20550 * @param obj The conformant object.
20551 * @return The content that is being used.
20553 * Return the content object which is set for this widget.
20554 * It won't be unparent from conformant. For that, use
20555 * elm_conformant_content_unset().
20557 * @see elm_conformant_content_set() for more details.
20558 * @see elm_conformant_content_unset()
20560 * @ingroup Conformant
20562 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20565 * Unset the content of the conformant widget.
20567 * @param obj The conformant object.
20568 * @return The content that was being used.
20570 * Unparent and return the content object which was set for this widget.
20572 * @see elm_conformant_content_set() for more details.
20574 * @ingroup Conformant
20576 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20579 * Returns the Evas_Object that represents the content area.
20581 * @param obj The conformant object.
20582 * @return The content area of the widget.
20584 * @ingroup Conformant
20586 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20593 * @defgroup Mapbuf Mapbuf
20594 * @ingroup Elementary
20596 * @image html img/widget/mapbuf/preview-00.png
20597 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20599 * This holds one content object and uses an Evas Map of transformation
20600 * points to be later used with this content. So the content will be
20601 * moved, resized, etc as a single image. So it will improve performance
20602 * when you have a complex interafce, with a lot of elements, and will
20603 * need to resize or move it frequently (the content object and its
20606 * See how to use this widget in this example:
20607 * @ref mapbuf_example
20611 * @addtogroup Mapbuf
20616 * Add a new mapbuf widget to the given parent Elementary
20617 * (container) object.
20619 * @param parent The parent object.
20620 * @return A new mapbuf widget handle or @c NULL, on errors.
20622 * This function inserts a new mapbuf widget on the canvas.
20626 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20629 * Set the content of the mapbuf.
20631 * @param obj The mapbuf object.
20632 * @param content The content that will be filled in this mapbuf object.
20634 * Once the content object is set, a previously set one will be deleted.
20635 * If you want to keep that old content object, use the
20636 * elm_mapbuf_content_unset() function.
20638 * To enable map, elm_mapbuf_enabled_set() should be used.
20642 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20645 * Get the content of the mapbuf.
20647 * @param obj The mapbuf object.
20648 * @return The content that is being used.
20650 * Return the content object which is set for this widget.
20652 * @see elm_mapbuf_content_set() for details.
20656 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20659 * Unset the content of the mapbuf.
20661 * @param obj The mapbuf object.
20662 * @return The content that was being used.
20664 * Unparent and return the content object which was set for this widget.
20666 * @see elm_mapbuf_content_set() for details.
20670 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20673 * Enable or disable the map.
20675 * @param obj The mapbuf object.
20676 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20678 * This enables the map that is set or disables it. On enable, the object
20679 * geometry will be saved, and the new geometry will change (position and
20680 * size) to reflect the map geometry set.
20682 * Also, when enabled, alpha and smooth states will be used, so if the
20683 * content isn't solid, alpha should be enabled, for example, otherwise
20684 * a black retangle will fill the content.
20686 * When disabled, the stored map will be freed and geometry prior to
20687 * enabling the map will be restored.
20689 * It's disabled by default.
20691 * @see elm_mapbuf_alpha_set()
20692 * @see elm_mapbuf_smooth_set()
20696 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20699 * Get a value whether map is enabled or not.
20701 * @param obj The mapbuf object.
20702 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20703 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20705 * @see elm_mapbuf_enabled_set() for details.
20709 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20712 * Enable or disable smooth map rendering.
20714 * @param obj The mapbuf object.
20715 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20718 * This sets smoothing for map rendering. If the object is a type that has
20719 * its own smoothing settings, then both the smooth settings for this object
20720 * and the map must be turned off.
20722 * By default smooth maps are enabled.
20726 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20729 * Get a value whether smooth map rendering is enabled or not.
20731 * @param obj The mapbuf object.
20732 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20733 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20735 * @see elm_mapbuf_smooth_set() for details.
20739 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20742 * Set or unset alpha flag for map rendering.
20744 * @param obj The mapbuf object.
20745 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20748 * This sets alpha flag for map rendering. If the object is a type that has
20749 * its own alpha settings, then this will take precedence. Only image objects
20750 * have this currently. It stops alpha blending of the map area, and is
20751 * useful if you know the object and/or all sub-objects is 100% solid.
20753 * Alpha is enabled by default.
20757 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20760 * Get a value whether alpha blending is enabled or not.
20762 * @param obj The mapbuf object.
20763 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20764 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20766 * @see elm_mapbuf_alpha_set() for details.
20770 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20777 * @defgroup Flipselector Flip Selector
20779 * @image html img/widget/flipselector/preview-00.png
20780 * @image latex img/widget/flipselector/preview-00.eps
20782 * A flip selector is a widget to show a set of @b text items, one
20783 * at a time, with the same sheet switching style as the @ref Clock
20784 * "clock" widget, when one changes the current displaying sheet
20785 * (thus, the "flip" in the name).
20787 * User clicks to flip sheets which are @b held for some time will
20788 * make the flip selector to flip continuosly and automatically for
20789 * the user. The interval between flips will keep growing in time,
20790 * so that it helps the user to reach an item which is distant from
20791 * the current selection.
20793 * Smart callbacks one can register to:
20794 * - @c "selected" - when the widget's selected text item is changed
20795 * - @c "overflowed" - when the widget's current selection is changed
20796 * from the first item in its list to the last
20797 * - @c "underflowed" - when the widget's current selection is changed
20798 * from the last item in its list to the first
20800 * Available styles for it:
20803 * Here is an example on its usage:
20804 * @li @ref flipselector_example
20808 * @addtogroup Flipselector
20812 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20815 * Add a new flip selector widget to the given parent Elementary
20816 * (container) widget
20818 * @param parent The parent object
20819 * @return a new flip selector widget handle or @c NULL, on errors
20821 * This function inserts a new flip selector widget on the canvas.
20823 * @ingroup Flipselector
20825 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20828 * Programmatically select the next item of a flip selector widget
20830 * @param obj The flipselector object
20832 * @note The selection will be animated. Also, if it reaches the
20833 * end of its list of member items, it will continue with the first
20836 * @ingroup Flipselector
20838 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20841 * Programmatically select the previous item of a flip selector
20844 * @param obj The flipselector object
20846 * @note The selection will be animated. Also, if it reaches the
20847 * beginning of its list of member items, it will continue with the
20848 * last one backwards.
20850 * @ingroup Flipselector
20852 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20855 * Append a (text) item to a flip selector widget
20857 * @param obj The flipselector object
20858 * @param label The (text) label of the new item
20859 * @param func Convenience callback function to take place when
20861 * @param data Data passed to @p func, above
20862 * @return A handle to the item added or @c NULL, on errors
20864 * The widget's list of labels to show will be appended with the
20865 * given value. If the user wishes so, a callback function pointer
20866 * can be passed, which will get called when this same item is
20869 * @note The current selection @b won't be modified by appending an
20870 * element to the list.
20872 * @note The maximum length of the text label is going to be
20873 * determined <b>by the widget's theme</b>. Strings larger than
20874 * that value are going to be @b truncated.
20876 * @ingroup Flipselector
20878 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20881 * Prepend a (text) item to a flip selector widget
20883 * @param obj The flipselector object
20884 * @param label The (text) label of the new item
20885 * @param func Convenience callback function to take place when
20887 * @param data Data passed to @p func, above
20888 * @return A handle to the item added or @c NULL, on errors
20890 * The widget's list of labels to show will be prepended with the
20891 * given value. If the user wishes so, a callback function pointer
20892 * can be passed, which will get called when this same item is
20895 * @note The current selection @b won't be modified by prepending
20896 * an element to the list.
20898 * @note The maximum length of the text label is going to be
20899 * determined <b>by the widget's theme</b>. Strings larger than
20900 * that value are going to be @b truncated.
20902 * @ingroup Flipselector
20904 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20907 * Get the internal list of items in a given flip selector widget.
20909 * @param obj The flipselector object
20910 * @return The list of items (#Elm_Flipselector_Item as data) or
20911 * @c NULL on errors.
20913 * This list is @b not to be modified in any way and must not be
20914 * freed. Use the list members with functions like
20915 * elm_flipselector_item_label_set(),
20916 * elm_flipselector_item_label_get(),
20917 * elm_flipselector_item_del(),
20918 * elm_flipselector_item_selected_get(),
20919 * elm_flipselector_item_selected_set().
20921 * @warning This list is only valid until @p obj object's internal
20922 * items list is changed. It should be fetched again with another
20923 * call to this function when changes happen.
20925 * @ingroup Flipselector
20927 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20930 * Get the first item in the given flip selector widget's list of
20933 * @param obj The flipselector object
20934 * @return The first item or @c NULL, if it has no items (and on
20937 * @see elm_flipselector_item_append()
20938 * @see elm_flipselector_last_item_get()
20940 * @ingroup Flipselector
20942 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20945 * Get the last item in the given flip selector widget's list of
20948 * @param obj The flipselector object
20949 * @return The last item or @c NULL, if it has no items (and on
20952 * @see elm_flipselector_item_prepend()
20953 * @see elm_flipselector_first_item_get()
20955 * @ingroup Flipselector
20957 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20960 * Get the currently selected item in a flip selector widget.
20962 * @param obj The flipselector object
20963 * @return The selected item or @c NULL, if the widget has no items
20966 * @ingroup Flipselector
20968 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20971 * Set whether a given flip selector widget's item should be the
20972 * currently selected one.
20974 * @param item The flip selector item
20975 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20977 * This sets whether @p item is or not the selected (thus, under
20978 * display) one. If @p item is different than one under display,
20979 * the latter will be unselected. If the @p item is set to be
20980 * unselected, on the other hand, the @b first item in the widget's
20981 * internal members list will be the new selected one.
20983 * @see elm_flipselector_item_selected_get()
20985 * @ingroup Flipselector
20987 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20990 * Get whether a given flip selector widget's item is the currently
20993 * @param item The flip selector item
20994 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20997 * @see elm_flipselector_item_selected_set()
20999 * @ingroup Flipselector
21001 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21004 * Delete a given item from a flip selector widget.
21006 * @param item The item to delete
21008 * @ingroup Flipselector
21010 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21013 * Get the label of a given flip selector widget's item.
21015 * @param item The item to get label from
21016 * @return The text label of @p item or @c NULL, on errors
21018 * @see elm_flipselector_item_label_set()
21020 * @ingroup Flipselector
21022 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21025 * Set the label of a given flip selector widget's item.
21027 * @param item The item to set label on
21028 * @param label The text label string, in UTF-8 encoding
21030 * @see elm_flipselector_item_label_get()
21032 * @ingroup Flipselector
21034 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21037 * Gets the item before @p item in a flip selector widget's
21038 * internal list of items.
21040 * @param item The item to fetch previous from
21041 * @return The item before the @p item, in its parent's list. If
21042 * there is no previous item for @p item or there's an
21043 * error, @c NULL is returned.
21045 * @see elm_flipselector_item_next_get()
21047 * @ingroup Flipselector
21049 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21052 * Gets the item after @p item in a flip selector widget's
21053 * internal list of items.
21055 * @param item The item to fetch next from
21056 * @return The item after the @p item, in its parent's list. If
21057 * there is no next item for @p item or there's an
21058 * error, @c NULL is returned.
21060 * @see elm_flipselector_item_next_get()
21062 * @ingroup Flipselector
21064 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21067 * Set the interval on time updates for an user mouse button hold
21068 * on a flip selector widget.
21070 * @param obj The flip selector object
21071 * @param interval The (first) interval value in seconds
21073 * This interval value is @b decreased while the user holds the
21074 * mouse pointer either flipping up or flipping doww a given flip
21077 * This helps the user to get to a given item distant from the
21078 * current one easier/faster, as it will start to flip quicker and
21079 * quicker on mouse button holds.
21081 * The calculation for the next flip interval value, starting from
21082 * the one set with this call, is the previous interval divided by
21083 * 1.05, so it decreases a little bit.
21085 * The default starting interval value for automatic flips is
21088 * @see elm_flipselector_interval_get()
21090 * @ingroup Flipselector
21092 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21095 * Get the interval on time updates for an user mouse button hold
21096 * on a flip selector widget.
21098 * @param obj The flip selector object
21099 * @return The (first) interval value, in seconds, set on it
21101 * @see elm_flipselector_interval_set() for more details
21103 * @ingroup Flipselector
21105 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21112 * @addtogroup Animator Animator
21113 * @ingroup Elementary
21115 * @brief Functions to ease creation of animations.
21117 * elm_animator is designed to provide an easy way to create animations.
21118 * Creating an animation with elm_animator is as simple as setting a
21119 * duration, an operating callback and telling it to run the animation.
21120 * However that is not the full extent of elm_animator's ability, animations
21121 * can be paused and resumed, reversed and the animation need not be linear.
21123 * To run an animation you must specify at least a duration and operation
21124 * callback, not setting any other properties will create a linear animation
21125 * that runs once and is not reversed.
21127 * @ref elm_animator_example_page_01 "This" example should make all of that
21130 * @warning elm_animator is @b not a widget.
21134 * @brief Type of curve desired for animation.
21136 * The speed in which an animation happens doesn't have to be linear, some
21137 * animations will look better if they're accelerating or decelerating, so
21138 * elm_animator provides four options in this regard:
21140 * @image html elm_animator_curve_style.png
21141 * @image latex elm_animator_curve_style.eps width=\textwidth
21142 * As can be seen in the image the speed of the animation will be:
21143 * @li ELM_ANIMATOR_CURVE_LINEAR constant
21144 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21145 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21146 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21150 ELM_ANIMATOR_CURVE_LINEAR,
21151 ELM_ANIMATOR_CURVE_IN_OUT,
21152 ELM_ANIMATOR_CURVE_IN,
21153 ELM_ANIMATOR_CURVE_OUT
21154 } Elm_Animator_Curve_Style;
21155 typedef struct _Elm_Animator Elm_Animator;
21157 * Called back per loop of an elementary animators cycle
21158 * @param data user-data given to elm_animator_operation_callback_set()
21159 * @param animator the animator being run
21160 * @param double the position in the animation
21162 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21164 * Called back when an elementary animator finishes
21165 * @param data user-data given to elm_animator_completion_callback_set()
21167 typedef void (*Elm_Animator_Completion_Cb) (void *data);
21170 * @brief Create a new animator.
21172 * @param[in] parent Parent object
21174 * The @a parent argument can be set to NULL for no parent. If a parent is set
21175 * there is no need to call elm_animator_del(), when the parent is deleted it
21176 * will delete the animator.
21177 * @deprecated Use @ref Transit instead.
21179 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
21181 * Deletes the animator freeing any resources it used. If the animator was
21182 * created with a NULL parent this must be called, otherwise it will be
21183 * automatically called when the parent is deleted.
21185 * @param[in] animator Animator object
21186 * @deprecated Use @ref Transit instead.
21188 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21190 * Set the duration of the animation.
21192 * @param[in] animator Animator object
21193 * @param[in] duration Duration in second
21194 * @deprecated Use @ref Transit instead.
21196 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21198 * @brief Set the callback function for animator operation.
21200 * @param[in] animator Animator object
21201 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21202 * @param[in] data Callback function user argument
21204 * The @p func callback will be called with a frame value in range [0, 1] which
21205 * indicates how far along the animation should be. It is the job of @p func to
21206 * actually change the state of any object(or objects) that are being animated.
21207 * @deprecated Use @ref Transit instead.
21209 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21211 * Set the callback function for the when the animation ends.
21213 * @param[in] animator Animator object
21214 * @param[in] func Callback function pointe
21215 * @param[in] data Callback function user argument
21217 * @warning @a func will not be executed if elm_animator_stop() is called.
21218 * @deprecated Use @ref Transit instead.
21220 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21222 * @brief Stop animator.
21224 * @param[in] animator Animator object
21226 * If called before elm_animator_animate() it does nothing. If there is an
21227 * animation in progress the animation will be stopped(the operation callback
21228 * will not be executed again) and it can't be restarted using
21229 * elm_animator_resume().
21230 * @deprecated Use @ref Transit instead.
21232 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21234 * Set the animator repeat count.
21236 * @param[in] animator Animator object
21237 * @param[in] repeat_cnt Repeat count
21238 * @deprecated Use @ref Transit instead.
21240 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21242 * @brief Start animation.
21244 * @param[in] animator Animator object
21246 * This function starts the animation if the nescessary properties(duration
21247 * and operation callback) have been set. Once started the animation will
21248 * run until complete or elm_animator_stop() is called.
21249 * @deprecated Use @ref Transit instead.
21251 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21253 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21255 * @param[in] animator Animator object
21256 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21257 * @deprecated Use @ref Transit instead.
21259 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21261 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21263 * @param[in] animator Animator object
21264 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21265 * @deprecated Use @ref Transit instead.
21267 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21269 * @brief Sets wether the animation should be automatically reversed.
21271 * @param[in] animator Animator object
21272 * @param[in] reverse Reverse or not
21274 * This controls wether the animation will be run on reverse imediately after
21275 * running forward. When this is set together with repetition the animation
21276 * will run in reverse once for each time it ran forward.@n
21277 * Runnin an animation in reverse is accomplished by calling the operation
21278 * callback with a frame value starting at 1 and diminshing until 0.
21279 * @deprecated Use @ref Transit instead.
21281 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21283 * Gets wether the animation will automatically reversed
21285 * @param[in] animator Animator object
21286 * @deprecated Use @ref Transit instead.
21288 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21290 * Gets the status for the animator operation. The status of the animator @b
21291 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21292 * only informs if the animation was started and has not ended(either normally
21293 * or through elm_animator_stop()).
21295 * @param[in] animator Animator object
21296 * @deprecated Use @ref Transit instead.
21298 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21300 * Gets how many times the animation will be repeated
21302 * @param[in] animator Animator object
21303 * @deprecated Use @ref Transit instead.
21305 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21307 * Pause the animator.
21309 * @param[in] animator Animator object
21311 * This causes the animation to be temporarily stopped(the operation callback
21312 * will not be called). If the animation is not yet running this is a no-op.
21313 * Once an animation has been paused with this function it can be resumed
21314 * using elm_animator_resume().
21315 * @deprecated Use @ref Transit instead.
21317 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21319 * @brief Resumes the animator.
21321 * @param[in] animator Animator object
21323 * Resumes an animation that was paused using elm_animator_pause(), after
21324 * calling this function calls to the operation callback will happen
21325 * normally. If an animation is stopped by means of elm_animator_stop it
21326 * @b can't be restarted with this function.@n
21328 * @warning When an animation is resumed it doesn't start from where it was paused, it
21329 * will go to where it would have been if it had not been paused. If an
21330 * animation with a duration of 3 seconds is paused after 1 second for 1 second
21331 * it will resume as if it had ben animating for 2 seconds, the operating
21332 * callback will be called with a frame value of aproximately 2/3.
21333 * @deprecated Use @ref Transit instead.
21335 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21341 * @defgroup Calendar Calendar
21342 * @ingroup Elementary
21344 * @image html img/widget/calendar/preview-00.png
21345 * @image latex img/widget/calendar/preview-00.eps
21347 * A calendar is a widget that displays a regular calendar, one
21348 * month at a time, to the user, and can allows the user to select a date.
21350 * It has support to adding check marks (holidays and checks are supported
21351 * by default theme).
21353 * Weekday names and the function used to format month and year to
21354 * be displayed can be set, giving more flexibility to this widget.
21356 * Smart callbacks one can register to:
21357 * - "changed" - emitted when the user selects a day or changes the
21358 * displayed month, what actually changes the selected day as well.
21360 * Available styles for it:
21363 * List of examples:
21364 * @li @ref calendar_example_01
21365 * @li @ref calendar_example_02
21366 * @li @ref calendar_example_03
21367 * @li @ref calendar_example_04
21368 * @li @ref calendar_example_05
21369 * @li @ref calendar_example_06
21373 * @addtogroup Calendar
21378 * @enum _Elm_Calendar_Mark_Repeat
21379 * @typedef Elm_Calendar_Mark_Repeat
21381 * Event periodicity, used to define if a mark should be repeated
21382 * @b beyond event's day. It's set when a mark is added.
21384 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21385 * there will be marks every week after this date. Marks will be displayed
21386 * at 13th, 20th, 27th, 3rd June ...
21388 * Values don't work as bitmask, only one can be choosen.
21390 * @see elm_calendar_mark_add()
21392 * @ingroup Calendar
21394 typedef enum _Elm_Calendar_Mark_Repeat
21396 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21397 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21398 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21399 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*/
21400 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. */
21401 } Elm_Calendar_Mark_Repeat;
21403 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(). */
21406 * Add a new calendar widget to the given parent Elementary
21407 * (container) object.
21409 * @param parent The parent object.
21410 * @return a new calendar widget handle or @c NULL, on errors.
21412 * This function inserts a new calendar widget on the canvas.
21414 * @ref calendar_example_01
21416 * @ingroup Calendar
21418 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21421 * Get weekdays names displayed by the calendar.
21423 * @param obj The calendar object.
21424 * @return Array of seven strings to be used as weekday names.
21426 * By default, weekdays abbreviations get from system are displayed:
21427 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21428 * The first string is related to Sunday, the second to Monday...
21430 * @see elm_calendar_weekdays_name_set()
21432 * @ref calendar_example_05
21434 * @ingroup Calendar
21436 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21439 * Set weekdays names to be displayed by the calendar.
21441 * @param obj The calendar object.
21442 * @param weekdays Array of seven strings to be used as weekday names.
21443 * @warning It must have 7 elements, or it will access invalid memory.
21444 * @warning The strings must be NULL terminated ('@\0').
21446 * By default, weekdays abbreviations get from system are displayed:
21447 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21449 * The first string should be related to Sunday, the second to Monday...
21451 * The usage should be like this:
21453 * const char *weekdays[] =
21455 * "Sunday", "Monday", "Tuesday", "Wednesday",
21456 * "Thursday", "Friday", "Saturday"
21458 * elm_calendar_weekdays_names_set(calendar, weekdays);
21461 * @see elm_calendar_weekdays_name_get()
21463 * @ref calendar_example_02
21465 * @ingroup Calendar
21467 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21470 * Set the minimum and maximum values for the year
21472 * @param obj The calendar object
21473 * @param min The minimum year, greater than 1901;
21474 * @param max The maximum year;
21476 * Maximum must be greater than minimum, except if you don't wan't to set
21478 * Default values are 1902 and -1.
21480 * If the maximum year is a negative value, it will be limited depending
21481 * on the platform architecture (year 2037 for 32 bits);
21483 * @see elm_calendar_min_max_year_get()
21485 * @ref calendar_example_03
21487 * @ingroup Calendar
21489 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21492 * Get the minimum and maximum values for the year
21494 * @param obj The calendar object.
21495 * @param min The minimum year.
21496 * @param max The maximum year.
21498 * Default values are 1902 and -1.
21500 * @see elm_calendar_min_max_year_get() for more details.
21502 * @ref calendar_example_05
21504 * @ingroup Calendar
21506 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21509 * Enable or disable day selection
21511 * @param obj The calendar object.
21512 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21515 * Enabled by default. If disabled, the user still can select months,
21516 * but not days. Selected days are highlighted on calendar.
21517 * It should be used if you won't need such selection for the widget usage.
21519 * When a day is selected, or month is changed, smart callbacks for
21520 * signal "changed" will be called.
21522 * @see elm_calendar_day_selection_enable_get()
21524 * @ref calendar_example_04
21526 * @ingroup Calendar
21528 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21531 * Get a value whether day selection is enabled or not.
21533 * @see elm_calendar_day_selection_enable_set() for details.
21535 * @param obj The calendar object.
21536 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21537 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21539 * @ref calendar_example_05
21541 * @ingroup Calendar
21543 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21547 * Set selected date to be highlighted on calendar.
21549 * @param obj The calendar object.
21550 * @param selected_time A @b tm struct to represent the selected date.
21552 * Set the selected date, changing the displayed month if needed.
21553 * Selected date changes when the user goes to next/previous month or
21554 * select a day pressing over it on calendar.
21556 * @see elm_calendar_selected_time_get()
21558 * @ref calendar_example_04
21560 * @ingroup Calendar
21562 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21565 * Get selected date.
21567 * @param obj The calendar object
21568 * @param selected_time A @b tm struct to point to selected date
21569 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21572 * Get date selected by the user or set by function
21573 * elm_calendar_selected_time_set().
21574 * Selected date changes when the user goes to next/previous month or
21575 * select a day pressing over it on calendar.
21577 * @see elm_calendar_selected_time_get()
21579 * @ref calendar_example_05
21581 * @ingroup Calendar
21583 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21586 * Set a function to format the string that will be used to display
21589 * @param obj The calendar object
21590 * @param format_function Function to set the month-year string given
21591 * the selected date
21593 * By default it uses strftime with "%B %Y" format string.
21594 * It should allocate the memory that will be used by the string,
21595 * that will be freed by the widget after usage.
21596 * A pointer to the string and a pointer to the time struct will be provided.
21601 * _format_month_year(struct tm *selected_time)
21604 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21605 * return strdup(buf);
21608 * elm_calendar_format_function_set(calendar, _format_month_year);
21611 * @ref calendar_example_02
21613 * @ingroup Calendar
21615 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21618 * Add a new mark to the calendar
21620 * @param obj The calendar object
21621 * @param mark_type A string used to define the type of mark. It will be
21622 * emitted to the theme, that should display a related modification on these
21623 * days representation.
21624 * @param mark_time A time struct to represent the date of inclusion of the
21625 * mark. For marks that repeats it will just be displayed after the inclusion
21626 * date in the calendar.
21627 * @param repeat Repeat the event following this periodicity. Can be a unique
21628 * mark (that don't repeat), daily, weekly, monthly or annually.
21629 * @return The created mark or @p NULL upon failure.
21631 * Add a mark that will be drawn in the calendar respecting the insertion
21632 * time and periodicity. It will emit the type as signal to the widget theme.
21633 * Default theme supports "holiday" and "checked", but it can be extended.
21635 * It won't immediately update the calendar, drawing the marks.
21636 * For this, call elm_calendar_marks_draw(). However, when user selects
21637 * next or previous month calendar forces marks drawn.
21639 * Marks created with this method can be deleted with
21640 * elm_calendar_mark_del().
21644 * struct tm selected_time;
21645 * time_t current_time;
21647 * current_time = time(NULL) + 5 * 84600;
21648 * localtime_r(¤t_time, &selected_time);
21649 * elm_calendar_mark_add(cal, "holiday", selected_time,
21650 * ELM_CALENDAR_ANNUALLY);
21652 * current_time = time(NULL) + 1 * 84600;
21653 * localtime_r(¤t_time, &selected_time);
21654 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21656 * elm_calendar_marks_draw(cal);
21659 * @see elm_calendar_marks_draw()
21660 * @see elm_calendar_mark_del()
21662 * @ref calendar_example_06
21664 * @ingroup Calendar
21666 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);
21669 * Delete mark from the calendar.
21671 * @param mark The mark to be deleted.
21673 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21674 * should be used instead of getting marks list and deleting each one.
21676 * @see elm_calendar_mark_add()
21678 * @ref calendar_example_06
21680 * @ingroup Calendar
21682 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21685 * Remove all calendar's marks
21687 * @param obj The calendar object.
21689 * @see elm_calendar_mark_add()
21690 * @see elm_calendar_mark_del()
21692 * @ingroup Calendar
21694 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21698 * Get a list of all the calendar marks.
21700 * @param obj The calendar object.
21701 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21703 * @see elm_calendar_mark_add()
21704 * @see elm_calendar_mark_del()
21705 * @see elm_calendar_marks_clear()
21707 * @ingroup Calendar
21709 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21712 * Draw calendar marks.
21714 * @param obj The calendar object.
21716 * Should be used after adding, removing or clearing marks.
21717 * It will go through the entire marks list updating the calendar.
21718 * If lots of marks will be added, add all the marks and then call
21721 * When the month is changed, i.e. user selects next or previous month,
21722 * marks will be drawed.
21724 * @see elm_calendar_mark_add()
21725 * @see elm_calendar_mark_del()
21726 * @see elm_calendar_marks_clear()
21728 * @ref calendar_example_06
21730 * @ingroup Calendar
21732 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21735 * Set a day text color to the same that represents Saturdays.
21737 * @param obj The calendar object.
21738 * @param pos The text position. Position is the cell counter, from left
21739 * to right, up to down. It starts on 0 and ends on 41.
21741 * @deprecated use elm_calendar_mark_add() instead like:
21744 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21745 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21748 * @see elm_calendar_mark_add()
21750 * @ingroup Calendar
21752 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21755 * Set a day text color to the same that represents Sundays.
21757 * @param obj The calendar object.
21758 * @param pos The text position. Position is the cell counter, from left
21759 * to right, up to down. It starts on 0 and ends on 41.
21761 * @deprecated use elm_calendar_mark_add() instead like:
21764 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21765 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21768 * @see elm_calendar_mark_add()
21770 * @ingroup Calendar
21772 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21775 * Set a day text color to the same that represents Weekdays.
21777 * @param obj The calendar object
21778 * @param pos The text position. Position is the cell counter, from left
21779 * to right, up to down. It starts on 0 and ends on 41.
21781 * @deprecated use elm_calendar_mark_add() instead like:
21784 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21786 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21787 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21788 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21789 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21790 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21791 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21792 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21793 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21794 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21797 * @see elm_calendar_mark_add()
21799 * @ingroup Calendar
21801 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21804 * Set the interval on time updates for an user mouse button hold
21805 * on calendar widgets' month selection.
21807 * @param obj The calendar object
21808 * @param interval The (first) interval value in seconds
21810 * This interval value is @b decreased while the user holds the
21811 * mouse pointer either selecting next or previous month.
21813 * This helps the user to get to a given month distant from the
21814 * current one easier/faster, as it will start to change quicker and
21815 * quicker on mouse button holds.
21817 * The calculation for the next change interval value, starting from
21818 * the one set with this call, is the previous interval divided by
21819 * 1.05, so it decreases a little bit.
21821 * The default starting interval value for automatic changes is
21824 * @see elm_calendar_interval_get()
21826 * @ingroup Calendar
21828 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21831 * Get the interval on time updates for an user mouse button hold
21832 * on calendar widgets' month selection.
21834 * @param obj The calendar object
21835 * @return The (first) interval value, in seconds, set on it
21837 * @see elm_calendar_interval_set() for more details
21839 * @ingroup Calendar
21841 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21848 * @defgroup Diskselector Diskselector
21849 * @ingroup Elementary
21851 * @image html img/widget/diskselector/preview-00.png
21852 * @image latex img/widget/diskselector/preview-00.eps
21854 * A diskselector is a kind of list widget. It scrolls horizontally,
21855 * and can contain label and icon objects. Three items are displayed
21856 * with the selected one in the middle.
21858 * It can act like a circular list with round mode and labels can be
21859 * reduced for a defined length for side items.
21861 * Smart callbacks one can listen to:
21862 * - "selected" - when item is selected, i.e. scroller stops.
21864 * Available styles for it:
21867 * List of examples:
21868 * @li @ref diskselector_example_01
21869 * @li @ref diskselector_example_02
21873 * @addtogroup Diskselector
21877 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(). */
21880 * Add a new diskselector widget to the given parent Elementary
21881 * (container) object.
21883 * @param parent The parent object.
21884 * @return a new diskselector widget handle or @c NULL, on errors.
21886 * This function inserts a new diskselector widget on the canvas.
21888 * @ingroup Diskselector
21890 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21893 * Enable or disable round mode.
21895 * @param obj The diskselector object.
21896 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21899 * Disabled by default. If round mode is enabled the items list will
21900 * work like a circle list, so when the user reaches the last item,
21901 * the first one will popup.
21903 * @see elm_diskselector_round_get()
21905 * @ingroup Diskselector
21907 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21910 * Get a value whether round mode is enabled or not.
21912 * @see elm_diskselector_round_set() for details.
21914 * @param obj The diskselector object.
21915 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21916 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21918 * @ingroup Diskselector
21920 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21923 * Get the side labels max length.
21925 * @deprecated use elm_diskselector_side_label_length_get() instead:
21927 * @param obj The diskselector object.
21928 * @return The max length defined for side labels, or 0 if not a valid
21931 * @ingroup Diskselector
21933 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21936 * Set the side labels max length.
21938 * @deprecated use elm_diskselector_side_label_length_set() instead:
21940 * @param obj The diskselector object.
21941 * @param len The max length defined for side labels.
21943 * @ingroup Diskselector
21945 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21948 * Get the side labels max length.
21950 * @see elm_diskselector_side_label_length_set() for details.
21952 * @param obj The diskselector object.
21953 * @return The max length defined for side labels, or 0 if not a valid
21956 * @ingroup Diskselector
21958 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21961 * Set the side labels max length.
21963 * @param obj The diskselector object.
21964 * @param len The max length defined for side labels.
21966 * Length is the number of characters of items' label that will be
21967 * visible when it's set on side positions. It will just crop
21968 * the string after defined size. E.g.:
21970 * An item with label "January" would be displayed on side position as
21971 * "Jan" if max length is set to 3, or "Janu", if this property
21974 * When it's selected, the entire label will be displayed, except for
21975 * width restrictions. In this case label will be cropped and "..."
21976 * will be concatenated.
21978 * Default side label max length is 3.
21980 * This property will be applyed over all items, included before or
21981 * later this function call.
21983 * @ingroup Diskselector
21985 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21988 * Set the number of items to be displayed.
21990 * @param obj The diskselector object.
21991 * @param num The number of items the diskselector will display.
21993 * Default value is 3, and also it's the minimun. If @p num is less
21994 * than 3, it will be set to 3.
21996 * Also, it can be set on theme, using data item @c display_item_num
21997 * on group "elm/diskselector/item/X", where X is style set.
22000 * group { name: "elm/diskselector/item/X";
22002 * item: "display_item_num" "5";
22005 * @ingroup Diskselector
22007 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
22010 * Set bouncing behaviour when the scrolled content reaches an edge.
22012 * Tell the internal scroller object whether it should bounce or not
22013 * when it reaches the respective edges for each axis.
22015 * @param obj The diskselector object.
22016 * @param h_bounce Whether to bounce or not in the horizontal axis.
22017 * @param v_bounce Whether to bounce or not in the vertical axis.
22019 * @see elm_scroller_bounce_set()
22021 * @ingroup Diskselector
22023 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22026 * Get the bouncing behaviour of the internal scroller.
22028 * Get whether the internal scroller should bounce when the edge of each
22029 * axis is reached scrolling.
22031 * @param obj The diskselector object.
22032 * @param h_bounce Pointer where to store the bounce state of the horizontal
22034 * @param v_bounce Pointer where to store the bounce state of the vertical
22037 * @see elm_scroller_bounce_get()
22038 * @see elm_diskselector_bounce_set()
22040 * @ingroup Diskselector
22042 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22045 * Get the scrollbar policy.
22047 * @see elm_diskselector_scroller_policy_get() for details.
22049 * @param obj The diskselector object.
22050 * @param policy_h Pointer where to store horizontal scrollbar policy.
22051 * @param policy_v Pointer where to store vertical scrollbar policy.
22053 * @ingroup Diskselector
22055 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);
22058 * Set the scrollbar policy.
22060 * @param obj The diskselector object.
22061 * @param policy_h Horizontal scrollbar policy.
22062 * @param policy_v Vertical scrollbar policy.
22064 * This sets the scrollbar visibility policy for the given scroller.
22065 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22066 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22067 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22068 * This applies respectively for the horizontal and vertical scrollbars.
22070 * The both are disabled by default, i.e., are set to
22071 * #ELM_SCROLLER_POLICY_OFF.
22073 * @ingroup Diskselector
22075 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22078 * Remove all diskselector's items.
22080 * @param obj The diskselector object.
22082 * @see elm_diskselector_item_del()
22083 * @see elm_diskselector_item_append()
22085 * @ingroup Diskselector
22087 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22090 * Get a list of all the diskselector items.
22092 * @param obj The diskselector object.
22093 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22094 * or @c NULL on failure.
22096 * @see elm_diskselector_item_append()
22097 * @see elm_diskselector_item_del()
22098 * @see elm_diskselector_clear()
22100 * @ingroup Diskselector
22102 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22105 * Appends a new item to the diskselector object.
22107 * @param obj The diskselector object.
22108 * @param label The label of the diskselector item.
22109 * @param icon The icon object to use at left side of the item. An
22110 * icon can be any Evas object, but usually it is an icon created
22111 * with elm_icon_add().
22112 * @param func The function to call when the item is selected.
22113 * @param data The data to associate with the item for related callbacks.
22115 * @return The created item or @c NULL upon failure.
22117 * A new item will be created and appended to the diskselector, i.e., will
22118 * be set as last item. Also, if there is no selected item, it will
22119 * be selected. This will always happens for the first appended item.
22121 * If no icon is set, label will be centered on item position, otherwise
22122 * the icon will be placed at left of the label, that will be shifted
22125 * Items created with this method can be deleted with
22126 * elm_diskselector_item_del().
22128 * Associated @p data can be properly freed when item is deleted if a
22129 * callback function is set with elm_diskselector_item_del_cb_set().
22131 * If a function is passed as argument, it will be called everytime this item
22132 * is selected, i.e., the user stops the diskselector with this
22133 * item on center position. If such function isn't needed, just passing
22134 * @c NULL as @p func is enough. The same should be done for @p data.
22136 * Simple example (with no function callback or data associated):
22138 * disk = elm_diskselector_add(win);
22139 * ic = elm_icon_add(win);
22140 * elm_icon_file_set(ic, "path/to/image", NULL);
22141 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22142 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22145 * @see elm_diskselector_item_del()
22146 * @see elm_diskselector_item_del_cb_set()
22147 * @see elm_diskselector_clear()
22148 * @see elm_icon_add()
22150 * @ingroup Diskselector
22152 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);
22156 * Delete them item from the diskselector.
22158 * @param it The item of diskselector to be deleted.
22160 * If deleting all diskselector items is required, elm_diskselector_clear()
22161 * should be used instead of getting items list and deleting each one.
22163 * @see elm_diskselector_clear()
22164 * @see elm_diskselector_item_append()
22165 * @see elm_diskselector_item_del_cb_set()
22167 * @ingroup Diskselector
22169 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22172 * Set the function called when a diskselector item is freed.
22174 * @param it The item to set the callback on
22175 * @param func The function called
22177 * If there is a @p func, then it will be called prior item's memory release.
22178 * That will be called with the following arguments:
22180 * @li item's Evas object;
22183 * This way, a data associated to a diskselector item could be properly
22186 * @ingroup Diskselector
22188 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22191 * Get the data associated to the item.
22193 * @param it The diskselector item
22194 * @return The data associated to @p it
22196 * The return value is a pointer to data associated to @p item when it was
22197 * created, with function elm_diskselector_item_append(). If no data
22198 * was passed as argument, it will return @c NULL.
22200 * @see elm_diskselector_item_append()
22202 * @ingroup Diskselector
22204 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22207 * Set the icon associated to the item.
22209 * @param it The diskselector item
22210 * @param icon The icon object to associate with @p it
22212 * The icon object to use at left side of the item. An
22213 * icon can be any Evas object, but usually it is an icon created
22214 * with elm_icon_add().
22216 * Once the icon object is set, a previously set one will be deleted.
22217 * @warning Setting the same icon for two items will cause the icon to
22218 * dissapear from the first item.
22220 * If an icon was passed as argument on item creation, with function
22221 * elm_diskselector_item_append(), it will be already
22222 * associated to the item.
22224 * @see elm_diskselector_item_append()
22225 * @see elm_diskselector_item_icon_get()
22227 * @ingroup Diskselector
22229 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22232 * Get the icon associated to the item.
22234 * @param it The diskselector item
22235 * @return The icon associated to @p it
22237 * The return value is a pointer to the icon associated to @p item when it was
22238 * created, with function elm_diskselector_item_append(), or later
22239 * with function elm_diskselector_item_icon_set. If no icon
22240 * was passed as argument, it will return @c NULL.
22242 * @see elm_diskselector_item_append()
22243 * @see elm_diskselector_item_icon_set()
22245 * @ingroup Diskselector
22247 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22250 * Set the label of item.
22252 * @param it The item of diskselector.
22253 * @param label The label of item.
22255 * The label to be displayed by the item.
22257 * If no icon is set, label will be centered on item position, otherwise
22258 * the icon will be placed at left of the label, that will be shifted
22261 * An item with label "January" would be displayed on side position as
22262 * "Jan" if max length is set to 3 with function
22263 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22266 * When this @p item is selected, the entire label will be displayed,
22267 * except for width restrictions.
22268 * In this case label will be cropped and "..." will be concatenated,
22269 * but only for display purposes. It will keep the entire string, so
22270 * if diskselector is resized the remaining characters will be displayed.
22272 * If a label was passed as argument on item creation, with function
22273 * elm_diskselector_item_append(), it will be already
22274 * displayed by the item.
22276 * @see elm_diskselector_side_label_lenght_set()
22277 * @see elm_diskselector_item_label_get()
22278 * @see elm_diskselector_item_append()
22280 * @ingroup Diskselector
22282 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22285 * Get the label of item.
22287 * @param it The item of diskselector.
22288 * @return The label of item.
22290 * The return value is a pointer to the label associated to @p item when it was
22291 * created, with function elm_diskselector_item_append(), or later
22292 * with function elm_diskselector_item_label_set. If no label
22293 * was passed as argument, it will return @c NULL.
22295 * @see elm_diskselector_item_label_set() for more details.
22296 * @see elm_diskselector_item_append()
22298 * @ingroup Diskselector
22300 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22303 * Get the selected item.
22305 * @param obj The diskselector object.
22306 * @return The selected diskselector item.
22308 * The selected item can be unselected with function
22309 * elm_diskselector_item_selected_set(), and the first item of
22310 * diskselector will be selected.
22312 * The selected item always will be centered on diskselector, with
22313 * full label displayed, i.e., max lenght set to side labels won't
22314 * apply on the selected item. More details on
22315 * elm_diskselector_side_label_length_set().
22317 * @ingroup Diskselector
22319 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22322 * Set the selected state of an item.
22324 * @param it The diskselector item
22325 * @param selected The selected state
22327 * This sets the selected state of the given item @p it.
22328 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22330 * If a new item is selected the previosly selected will be unselected.
22331 * Previoulsy selected item can be get with function
22332 * elm_diskselector_selected_item_get().
22334 * If the item @p it is unselected, the first item of diskselector will
22337 * Selected items will be visible on center position of diskselector.
22338 * So if it was on another position before selected, or was invisible,
22339 * diskselector will animate items until the selected item reaches center
22342 * @see elm_diskselector_item_selected_get()
22343 * @see elm_diskselector_selected_item_get()
22345 * @ingroup Diskselector
22347 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22350 * Get whether the @p item is selected or not.
22352 * @param it The diskselector item.
22353 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22354 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22356 * @see elm_diskselector_selected_item_set() for details.
22357 * @see elm_diskselector_item_selected_get()
22359 * @ingroup Diskselector
22361 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22364 * Get the first item of the diskselector.
22366 * @param obj The diskselector object.
22367 * @return The first item, or @c NULL if none.
22369 * The list of items follows append order. So it will return the first
22370 * item appended to the widget that wasn't deleted.
22372 * @see elm_diskselector_item_append()
22373 * @see elm_diskselector_items_get()
22375 * @ingroup Diskselector
22377 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22380 * Get the last item of the diskselector.
22382 * @param obj The diskselector object.
22383 * @return The last item, or @c NULL if none.
22385 * The list of items follows append order. So it will return last first
22386 * item appended to the widget that wasn't deleted.
22388 * @see elm_diskselector_item_append()
22389 * @see elm_diskselector_items_get()
22391 * @ingroup Diskselector
22393 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22396 * Get the item before @p item in diskselector.
22398 * @param it The diskselector item.
22399 * @return The item before @p item, or @c NULL if none or on failure.
22401 * The list of items follows append order. So it will return item appended
22402 * just before @p item and that wasn't deleted.
22404 * If it is the first item, @c NULL will be returned.
22405 * First item can be get by elm_diskselector_first_item_get().
22407 * @see elm_diskselector_item_append()
22408 * @see elm_diskselector_items_get()
22410 * @ingroup Diskselector
22412 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22415 * Get the item after @p item in diskselector.
22417 * @param it The diskselector item.
22418 * @return The item after @p item, or @c NULL if none or on failure.
22420 * The list of items follows append order. So it will return item appended
22421 * just after @p item and that wasn't deleted.
22423 * If it is the last item, @c NULL will be returned.
22424 * Last item can be get by elm_diskselector_last_item_get().
22426 * @see elm_diskselector_item_append()
22427 * @see elm_diskselector_items_get()
22429 * @ingroup Diskselector
22431 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22434 * Set the text to be shown in the diskselector item.
22436 * @param item Target item
22437 * @param text The text to set in the content
22439 * Setup the text as tooltip to object. The item can have only one tooltip,
22440 * so any previous tooltip data is removed.
22442 * @see elm_object_tooltip_text_set() for more details.
22444 * @ingroup Diskselector
22446 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22449 * Set the content to be shown in the tooltip item.
22451 * Setup the tooltip to item. The item can have only one tooltip,
22452 * so any previous tooltip data is removed. @p func(with @p data) will
22453 * be called every time that need show the tooltip and it should
22454 * return a valid Evas_Object. This object is then managed fully by
22455 * tooltip system and is deleted when the tooltip is gone.
22457 * @param item the diskselector item being attached a tooltip.
22458 * @param func the function used to create the tooltip contents.
22459 * @param data what to provide to @a func as callback data/context.
22460 * @param del_cb called when data is not needed anymore, either when
22461 * another callback replaces @p func, the tooltip is unset with
22462 * elm_diskselector_item_tooltip_unset() or the owner @a item
22463 * dies. This callback receives as the first parameter the
22464 * given @a data, and @c event_info is the item.
22466 * @see elm_object_tooltip_content_cb_set() for more details.
22468 * @ingroup Diskselector
22470 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);
22473 * Unset tooltip from item.
22475 * @param item diskselector item to remove previously set tooltip.
22477 * Remove tooltip from item. The callback provided as del_cb to
22478 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22479 * it is not used anymore.
22481 * @see elm_object_tooltip_unset() for more details.
22482 * @see elm_diskselector_item_tooltip_content_cb_set()
22484 * @ingroup Diskselector
22486 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22490 * Sets a different style for this item tooltip.
22492 * @note before you set a style you should define a tooltip with
22493 * elm_diskselector_item_tooltip_content_cb_set() or
22494 * elm_diskselector_item_tooltip_text_set()
22496 * @param item diskselector item with tooltip already set.
22497 * @param style the theme style to use (default, transparent, ...)
22499 * @see elm_object_tooltip_style_set() for more details.
22501 * @ingroup Diskselector
22503 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22506 * Get the style for this item tooltip.
22508 * @param item diskselector item with tooltip already set.
22509 * @return style the theme style in use, defaults to "default". If the
22510 * object does not have a tooltip set, then NULL is returned.
22512 * @see elm_object_tooltip_style_get() for more details.
22513 * @see elm_diskselector_item_tooltip_style_set()
22515 * @ingroup Diskselector
22517 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22520 * Set the cursor to be shown when mouse is over the diskselector item
22522 * @param item Target item
22523 * @param cursor the cursor name to be used.
22525 * @see elm_object_cursor_set() for more details.
22527 * @ingroup Diskselector
22529 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22532 * Get the cursor to be shown when mouse is over the diskselector item
22534 * @param item diskselector item with cursor already set.
22535 * @return the cursor name.
22537 * @see elm_object_cursor_get() for more details.
22538 * @see elm_diskselector_cursor_set()
22540 * @ingroup Diskselector
22542 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22546 * Unset the cursor to be shown when mouse is over the diskselector item
22548 * @param item Target item
22550 * @see elm_object_cursor_unset() for more details.
22551 * @see elm_diskselector_cursor_set()
22553 * @ingroup Diskselector
22555 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22558 * Sets a different style for this item cursor.
22560 * @note before you set a style you should define a cursor with
22561 * elm_diskselector_item_cursor_set()
22563 * @param item diskselector item with cursor already set.
22564 * @param style the theme style to use (default, transparent, ...)
22566 * @see elm_object_cursor_style_set() for more details.
22568 * @ingroup Diskselector
22570 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22574 * Get the style for this item cursor.
22576 * @param item diskselector item with cursor already set.
22577 * @return style the theme style in use, defaults to "default". If the
22578 * object does not have a cursor set, then @c NULL is returned.
22580 * @see elm_object_cursor_style_get() for more details.
22581 * @see elm_diskselector_item_cursor_style_set()
22583 * @ingroup Diskselector
22585 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22589 * Set if the cursor set should be searched on the theme or should use
22590 * the provided by the engine, only.
22592 * @note before you set if should look on theme you should define a cursor
22593 * with elm_diskselector_item_cursor_set().
22594 * By default it will only look for cursors provided by the engine.
22596 * @param item widget item with cursor already set.
22597 * @param engine_only boolean to define if cursors set with
22598 * elm_diskselector_item_cursor_set() should be searched only
22599 * between cursors provided by the engine or searched on widget's
22602 * @see elm_object_cursor_engine_only_set() for more details.
22604 * @ingroup Diskselector
22606 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22609 * Get the cursor engine only usage for this item cursor.
22611 * @param item widget item with cursor already set.
22612 * @return engine_only boolean to define it cursors should be looked only
22613 * between the provided by the engine or searched on widget's theme as well.
22614 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22616 * @see elm_object_cursor_engine_only_get() for more details.
22617 * @see elm_diskselector_item_cursor_engine_only_set()
22619 * @ingroup Diskselector
22621 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22628 * @defgroup Colorselector Colorselector
22632 * @image html img/widget/colorselector/preview-00.png
22634 * @brief Widget for user to select a color.
22636 * Signals that you can add callbacks for are:
22637 * "changed" - When the color value changes(event_info is NULL).
22639 * See @ref tutorial_colorselector.
22642 * @brief Add a new colorselector to the parent
22644 * @param parent The parent object
22645 * @return The new object or NULL if it cannot be created
22647 * @ingroup Colorselector
22649 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22651 * Set a color for the colorselector
22653 * @param obj Colorselector object
22654 * @param r r-value of color
22655 * @param g g-value of color
22656 * @param b b-value of color
22657 * @param a a-value of color
22659 * @ingroup Colorselector
22661 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22663 * Get a color from the colorselector
22665 * @param obj Colorselector object
22666 * @param r integer pointer for r-value of color
22667 * @param g integer pointer for g-value of color
22668 * @param b integer pointer for b-value of color
22669 * @param a integer pointer for a-value of color
22671 * @ingroup Colorselector
22673 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22679 * @defgroup Ctxpopup Ctxpopup
22681 * @image html img/widget/ctxpopup/preview-00.png
22682 * @image latex img/widget/ctxpopup/preview-00.eps
22684 * @brief Context popup widet.
22686 * A ctxpopup is a widget that, when shown, pops up a list of items.
22687 * It automatically chooses an area inside its parent object's view
22688 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22689 * optimally fit into it. In the default theme, it will also point an
22690 * arrow to it's top left position at the time one shows it. Ctxpopup
22691 * items have a label and/or an icon. It is intended for a small
22692 * number of items (hence the use of list, not genlist).
22694 * @note Ctxpopup is a especialization of @ref Hover.
22696 * Signals that you can add callbacks for are:
22697 * "dismissed" - the ctxpopup was dismissed
22699 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22702 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22704 typedef enum _Elm_Ctxpopup_Direction
22706 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22708 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22709 the clicked area */
22710 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22711 the clicked area */
22712 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22714 } Elm_Ctxpopup_Direction;
22717 * @brief Add a new Ctxpopup object to the parent.
22719 * @param parent Parent object
22720 * @return New object or @c NULL, if it cannot be created
22722 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22724 * @brief Set the Ctxpopup's parent
22726 * @param obj The ctxpopup object
22727 * @param area The parent to use
22729 * Set the parent object.
22731 * @note elm_ctxpopup_add() will automatically call this function
22732 * with its @c parent argument.
22734 * @see elm_ctxpopup_add()
22735 * @see elm_hover_parent_set()
22737 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22739 * @brief Get the Ctxpopup's parent
22741 * @param obj The ctxpopup object
22743 * @see elm_ctxpopup_hover_parent_set() for more information
22745 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22747 * @brief Clear all items in the given ctxpopup object.
22749 * @param obj Ctxpopup object
22751 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22753 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22755 * @param obj Ctxpopup object
22756 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22758 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22760 * @brief Get the value of current ctxpopup object's orientation.
22762 * @param obj Ctxpopup object
22763 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22765 * @see elm_ctxpopup_horizontal_set()
22767 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22769 * @brief Add a new item to a ctxpopup object.
22771 * @param obj Ctxpopup object
22772 * @param icon Icon to be set on new item
22773 * @param label The Label of the new item
22774 * @param func Convenience function called when item selected
22775 * @param data Data passed to @p func
22776 * @return A handle to the item added or @c NULL, on errors
22778 * @warning Ctxpopup can't hold both an item list and a content at the same
22779 * time. When an item is added, any previous content will be removed.
22781 * @see elm_ctxpopup_content_set()
22783 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);
22785 * @brief Delete the given item in a ctxpopup object.
22787 * @param item Ctxpopup item to be deleted
22789 * @see elm_ctxpopup_item_append()
22791 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22793 * @brief Set the ctxpopup item's state as disabled or enabled.
22795 * @param item Ctxpopup item to be enabled/disabled
22796 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22798 * When disabled the item is greyed out to indicate it's state.
22800 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22802 * @brief Get the ctxpopup item's disabled/enabled state.
22804 * @param item Ctxpopup item to be enabled/disabled
22805 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22807 * @see elm_ctxpopup_item_disabled_set()
22809 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22811 * @brief Get the icon object for the given ctxpopup item.
22813 * @param item Ctxpopup item
22814 * @return icon object or @c NULL, if the item does not have icon or an error
22817 * @see elm_ctxpopup_item_append()
22818 * @see elm_ctxpopup_item_icon_set()
22820 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22822 * @brief Sets the side icon associated with the ctxpopup item
22824 * @param item Ctxpopup item
22825 * @param icon Icon object to be set
22827 * Once the icon object is set, a previously set one will be deleted.
22828 * @warning Setting the same icon for two items will cause the icon to
22829 * dissapear from the first item.
22831 * @see elm_ctxpopup_item_append()
22833 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22835 * @brief Get the label for the given ctxpopup item.
22837 * @param item Ctxpopup item
22838 * @return label string or @c NULL, if the item does not have label or an
22841 * @see elm_ctxpopup_item_append()
22842 * @see elm_ctxpopup_item_label_set()
22844 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22846 * @brief (Re)set the label on the given ctxpopup item.
22848 * @param item Ctxpopup item
22849 * @param label String to set as label
22851 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22853 * @brief Set an elm widget as the content of the ctxpopup.
22855 * @param obj Ctxpopup object
22856 * @param content Content to be swallowed
22858 * If the content object is already set, a previous one will bedeleted. If
22859 * you want to keep that old content object, use the
22860 * elm_ctxpopup_content_unset() function.
22862 * @deprecated use elm_object_content_set()
22864 * @warning Ctxpopup can't hold both a item list and a content at the same
22865 * time. When a content is set, any previous items will be removed.
22867 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22869 * @brief Unset the ctxpopup content
22871 * @param obj Ctxpopup object
22872 * @return The content that was being used
22874 * Unparent and return the content object which was set for this widget.
22876 * @deprecated use elm_object_content_unset()
22878 * @see elm_ctxpopup_content_set()
22880 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22882 * @brief Set the direction priority of a ctxpopup.
22884 * @param obj Ctxpopup object
22885 * @param first 1st priority of direction
22886 * @param second 2nd priority of direction
22887 * @param third 3th priority of direction
22888 * @param fourth 4th priority of direction
22890 * This functions gives a chance to user to set the priority of ctxpopup
22891 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22892 * requested direction.
22894 * @see Elm_Ctxpopup_Direction
22896 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);
22898 * @brief Get the direction priority of a ctxpopup.
22900 * @param obj Ctxpopup object
22901 * @param first 1st priority of direction to be returned
22902 * @param second 2nd priority of direction to be returned
22903 * @param third 3th priority of direction to be returned
22904 * @param fourth 4th priority of direction to be returned
22906 * @see elm_ctxpopup_direction_priority_set() for more information.
22908 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);
22916 * @defgroup Transit Transit
22917 * @ingroup Elementary
22919 * Transit is designed to apply various animated transition effects to @c
22920 * Evas_Object, such like translation, rotation, etc. For using these
22921 * effects, create an @ref Elm_Transit and add the desired transition effects.
22923 * Once the effects are added into transit, they will be automatically
22924 * managed (their callback will be called until the duration is ended, and
22925 * they will be deleted on completion).
22929 * Elm_Transit *trans = elm_transit_add();
22930 * elm_transit_object_add(trans, obj);
22931 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22932 * elm_transit_duration_set(transit, 1);
22933 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22934 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22935 * elm_transit_repeat_times_set(transit, 3);
22938 * Some transition effects are used to change the properties of objects. They
22940 * @li @ref elm_transit_effect_translation_add
22941 * @li @ref elm_transit_effect_color_add
22942 * @li @ref elm_transit_effect_rotation_add
22943 * @li @ref elm_transit_effect_wipe_add
22944 * @li @ref elm_transit_effect_zoom_add
22945 * @li @ref elm_transit_effect_resizing_add
22947 * Other transition effects are used to make one object disappear and another
22948 * object appear on its old place. These effects are:
22950 * @li @ref elm_transit_effect_flip_add
22951 * @li @ref elm_transit_effect_resizable_flip_add
22952 * @li @ref elm_transit_effect_fade_add
22953 * @li @ref elm_transit_effect_blend_add
22955 * It's also possible to make a transition chain with @ref
22956 * elm_transit_chain_transit_add.
22958 * @warning We strongly recommend to use elm_transit just when edje can not do
22959 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22960 * animations can be manipulated inside the theme.
22962 * List of examples:
22963 * @li @ref transit_example_01_explained
22964 * @li @ref transit_example_02_explained
22965 * @li @ref transit_example_03_c
22966 * @li @ref transit_example_04_c
22972 * @enum Elm_Transit_Tween_Mode
22974 * The type of acceleration used in the transition.
22978 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22979 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22980 over time, then decrease again
22982 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22984 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22986 } Elm_Transit_Tween_Mode;
22989 * @enum Elm_Transit_Effect_Flip_Axis
22991 * The axis where flip effect should be applied.
22995 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22996 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22997 } Elm_Transit_Effect_Flip_Axis;
22999 * @enum Elm_Transit_Effect_Wipe_Dir
23001 * The direction where the wipe effect should occur.
23005 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
23006 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
23007 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
23008 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
23009 } Elm_Transit_Effect_Wipe_Dir;
23010 /** @enum Elm_Transit_Effect_Wipe_Type
23012 * Whether the wipe effect should show or hide the object.
23016 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
23018 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
23020 } Elm_Transit_Effect_Wipe_Type;
23023 * @typedef Elm_Transit
23025 * The Transit created with elm_transit_add(). This type has the information
23026 * about the objects which the transition will be applied, and the
23027 * transition effects that will be used. It also contains info about
23028 * duration, number of repetitions, auto-reverse, etc.
23030 typedef struct _Elm_Transit Elm_Transit;
23031 typedef void Elm_Transit_Effect;
23033 * @typedef Elm_Transit_Effect_Transition_Cb
23035 * Transition callback called for this effect on each transition iteration.
23037 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23039 * Elm_Transit_Effect_End_Cb
23041 * Transition callback called for this effect when the transition is over.
23043 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23046 * Elm_Transit_Del_Cb
23048 * A callback called when the transit is deleted.
23050 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23055 * @note Is not necessary to delete the transit object, it will be deleted at
23056 * the end of its operation.
23057 * @note The transit will start playing when the program enter in the main loop, is not
23058 * necessary to give a start to the transit.
23060 * @return The transit object.
23064 EAPI Elm_Transit *elm_transit_add(void);
23067 * Stops the animation and delete the @p transit object.
23069 * Call this function if you wants to stop the animation before the duration
23070 * time. Make sure the @p transit object is still alive with
23071 * elm_transit_del_cb_set() function.
23072 * All added effects will be deleted, calling its repective data_free_cb
23073 * functions. The function setted by elm_transit_del_cb_set() will be called.
23075 * @see elm_transit_del_cb_set()
23077 * @param transit The transit object to be deleted.
23080 * @warning Just call this function if you are sure the transit is alive.
23082 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23085 * Add a new effect to the transit.
23087 * @note The cb function and the data are the key to the effect. If you try to
23088 * add an already added effect, nothing is done.
23089 * @note After the first addition of an effect in @p transit, if its
23090 * effect list become empty again, the @p transit will be killed by
23091 * elm_transit_del(transit) function.
23095 * Elm_Transit *transit = elm_transit_add();
23096 * elm_transit_effect_add(transit,
23097 * elm_transit_effect_blend_op,
23098 * elm_transit_effect_blend_context_new(),
23099 * elm_transit_effect_blend_context_free);
23102 * @param transit The transit object.
23103 * @param transition_cb The operation function. It is called when the
23104 * animation begins, it is the function that actually performs the animation.
23105 * It is called with the @p data, @p transit and the time progression of the
23106 * animation (a double value between 0.0 and 1.0).
23107 * @param effect The context data of the effect.
23108 * @param end_cb The function to free the context data, it will be called
23109 * at the end of the effect, it must finalize the animation and free the
23113 * @warning The transit free the context data at the and of the transition with
23114 * the data_free_cb function, do not use the context data in another transit.
23116 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);
23119 * Delete an added effect.
23121 * This function will remove the effect from the @p transit, calling the
23122 * data_free_cb to free the @p data.
23124 * @see elm_transit_effect_add()
23126 * @note If the effect is not found, nothing is done.
23127 * @note If the effect list become empty, this function will call
23128 * elm_transit_del(transit), that is, it will kill the @p transit.
23130 * @param transit The transit object.
23131 * @param transition_cb The operation function.
23132 * @param effect The context data of the effect.
23136 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);
23139 * Add new object to apply the effects.
23141 * @note After the first addition of an object in @p transit, if its
23142 * object list become empty again, the @p transit will be killed by
23143 * elm_transit_del(transit) function.
23144 * @note If the @p obj belongs to another transit, the @p obj will be
23145 * removed from it and it will only belong to the @p transit. If the old
23146 * transit stays without objects, it will die.
23147 * @note When you add an object into the @p transit, its state from
23148 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23149 * transit ends, if you change this state whith evas_object_pass_events_set()
23150 * after add the object, this state will change again when @p transit stops to
23153 * @param transit The transit object.
23154 * @param obj Object to be animated.
23157 * @warning It is not allowed to add a new object after transit begins to go.
23159 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23162 * Removes an added object from the transit.
23164 * @note If the @p obj is not in the @p transit, nothing is done.
23165 * @note If the list become empty, this function will call
23166 * elm_transit_del(transit), that is, it will kill the @p transit.
23168 * @param transit The transit object.
23169 * @param obj Object to be removed from @p transit.
23172 * @warning It is not allowed to remove objects after transit begins to go.
23174 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23177 * Get the objects of the transit.
23179 * @param transit The transit object.
23180 * @return a Eina_List with the objects from the transit.
23184 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23187 * Enable/disable keeping up the objects states.
23188 * If it is not kept, the objects states will be reset when transition ends.
23190 * @note @p transit can not be NULL.
23191 * @note One state includes geometry, color, map data.
23193 * @param transit The transit object.
23194 * @param state_keep Keeping or Non Keeping.
23198 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23201 * Get a value whether the objects states will be reset or not.
23203 * @note @p transit can not be NULL
23205 * @see elm_transit_objects_final_state_keep_set()
23207 * @param transit The transit object.
23208 * @return EINA_TRUE means the states of the objects will be reset.
23209 * If @p transit is NULL, EINA_FALSE is returned
23213 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23216 * Set the event enabled when transit is operating.
23218 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23219 * events from mouse and keyboard during the animation.
23220 * @note When you add an object with elm_transit_object_add(), its state from
23221 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23222 * transit ends, if you change this state with evas_object_pass_events_set()
23223 * after adding the object, this state will change again when @p transit stops
23226 * @param transit The transit object.
23227 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23228 * ignored otherwise.
23232 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23235 * Get the value of event enabled status.
23237 * @see elm_transit_event_enabled_set()
23239 * @param transit The Transit object
23240 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23241 * EINA_FALSE is returned
23245 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23248 * Set the user-callback function when the transit is deleted.
23250 * @note Using this function twice will overwrite the first function setted.
23251 * @note the @p transit object will be deleted after call @p cb function.
23253 * @param transit The transit object.
23254 * @param cb Callback function pointer. This function will be called before
23255 * the deletion of the transit.
23256 * @param data Callback funtion user data. It is the @p op parameter.
23260 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23263 * Set reverse effect automatically.
23265 * If auto reverse is setted, after running the effects with the progress
23266 * parameter from 0 to 1, it will call the effecs again with the progress
23267 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23268 * where the duration was setted with the function elm_transit_add and
23269 * the repeat with the function elm_transit_repeat_times_set().
23271 * @param transit The transit object.
23272 * @param reverse EINA_TRUE means the auto_reverse is on.
23276 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23279 * Get if the auto reverse is on.
23281 * @see elm_transit_auto_reverse_set()
23283 * @param transit The transit object.
23284 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23285 * EINA_FALSE is returned
23289 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23292 * Set the transit repeat count. Effect will be repeated by repeat count.
23294 * This function sets the number of repetition the transit will run after
23295 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23296 * If the @p repeat is a negative number, it will repeat infinite times.
23298 * @note If this function is called during the transit execution, the transit
23299 * will run @p repeat times, ignoring the times it already performed.
23301 * @param transit The transit object
23302 * @param repeat Repeat count
23306 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23309 * Get the transit repeat count.
23311 * @see elm_transit_repeat_times_set()
23313 * @param transit The Transit object.
23314 * @return The repeat count. If @p transit is NULL
23319 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23322 * Set the transit animation acceleration type.
23324 * This function sets the tween mode of the transit that can be:
23325 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23326 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23327 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23328 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23330 * @param transit The transit object.
23331 * @param tween_mode The tween type.
23335 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23338 * Get the transit animation acceleration type.
23340 * @note @p transit can not be NULL
23342 * @param transit The transit object.
23343 * @return The tween type. If @p transit is NULL
23344 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23348 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23351 * Set the transit animation time
23353 * @note @p transit can not be NULL
23355 * @param transit The transit object.
23356 * @param duration The animation time.
23360 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23363 * Get the transit animation time
23365 * @note @p transit can not be NULL
23367 * @param transit The transit object.
23369 * @return The transit animation time.
23373 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23376 * Starts the transition.
23377 * Once this API is called, the transit begins to measure the time.
23379 * @note @p transit can not be NULL
23381 * @param transit The transit object.
23385 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23388 * Pause/Resume the transition.
23390 * If you call elm_transit_go again, the transit will be started from the
23391 * beginning, and will be unpaused.
23393 * @note @p transit can not be NULL
23395 * @param transit The transit object.
23396 * @param paused Whether the transition should be paused or not.
23400 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23403 * Get the value of paused status.
23405 * @see elm_transit_paused_set()
23407 * @note @p transit can not be NULL
23409 * @param transit The transit object.
23410 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23411 * EINA_FALSE is returned
23415 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23418 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23420 * The value returned is a fraction (current time / total time). It
23421 * represents the progression position relative to the total.
23423 * @note @p transit can not be NULL
23425 * @param transit The transit object.
23427 * @return The time progression value. If @p transit is NULL
23432 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23435 * Makes the chain relationship between two transits.
23437 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23438 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23440 * @param transit The transit object.
23441 * @param chain_transit The chain transit object. This transit will be operated
23442 * after transit is done.
23444 * This function adds @p chain_transit transition to a chain after the @p
23445 * transit, and will be started as soon as @p transit ends. See @ref
23446 * transit_example_02_explained for a full example.
23450 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23453 * Cut off the chain relationship between two transits.
23455 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23456 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23458 * @param transit The transit object.
23459 * @param chain_transit The chain transit object.
23461 * This function remove the @p chain_transit transition from the @p transit.
23465 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23468 * Get the current chain transit list.
23470 * @note @p transit can not be NULL.
23472 * @param transit The transit object.
23473 * @return chain transit list.
23477 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23480 * Add the Resizing Effect to Elm_Transit.
23482 * @note This API is one of the facades. It creates resizing effect context
23483 * and add it's required APIs to elm_transit_effect_add.
23485 * @see elm_transit_effect_add()
23487 * @param transit Transit object.
23488 * @param from_w Object width size when effect begins.
23489 * @param from_h Object height size when effect begins.
23490 * @param to_w Object width size when effect ends.
23491 * @param to_h Object height size when effect ends.
23492 * @return Resizing effect context data.
23496 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);
23499 * Add the Translation Effect to Elm_Transit.
23501 * @note This API is one of the facades. It creates translation effect context
23502 * and add it's required APIs to elm_transit_effect_add.
23504 * @see elm_transit_effect_add()
23506 * @param transit Transit object.
23507 * @param from_dx X Position variation when effect begins.
23508 * @param from_dy Y Position variation when effect begins.
23509 * @param to_dx X Position variation when effect ends.
23510 * @param to_dy Y Position variation when effect ends.
23511 * @return Translation effect context data.
23514 * @warning It is highly recommended just create a transit with this effect when
23515 * the window that the objects of the transit belongs has already been created.
23516 * This is because this effect needs the geometry information about the objects,
23517 * and if the window was not created yet, it can get a wrong information.
23519 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);
23522 * Add the Zoom Effect to Elm_Transit.
23524 * @note This API is one of the facades. It creates zoom effect context
23525 * and add it's required APIs to elm_transit_effect_add.
23527 * @see elm_transit_effect_add()
23529 * @param transit Transit object.
23530 * @param from_rate Scale rate when effect begins (1 is current rate).
23531 * @param to_rate Scale rate when effect ends.
23532 * @return Zoom effect context data.
23535 * @warning It is highly recommended just create a transit with this effect when
23536 * the window that the objects of the transit belongs has already been created.
23537 * This is because this effect needs the geometry information about the objects,
23538 * and if the window was not created yet, it can get a wrong information.
23540 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23543 * Add the Flip Effect to Elm_Transit.
23545 * @note This API is one of the facades. It creates flip effect context
23546 * and add it's required APIs to elm_transit_effect_add.
23547 * @note This effect is applied to each pair of objects in the order they are listed
23548 * in the transit list of objects. The first object in the pair will be the
23549 * "front" object and the second will be the "back" object.
23551 * @see elm_transit_effect_add()
23553 * @param transit Transit object.
23554 * @param axis Flipping Axis(X or Y).
23555 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23556 * @return Flip effect context data.
23559 * @warning It is highly recommended just create a transit with this effect when
23560 * the window that the objects of the transit belongs has already been created.
23561 * This is because this effect needs the geometry information about the objects,
23562 * and if the window was not created yet, it can get a wrong information.
23564 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23567 * Add the Resizable Flip Effect to Elm_Transit.
23569 * @note This API is one of the facades. It creates resizable flip effect context
23570 * and add it's required APIs to elm_transit_effect_add.
23571 * @note This effect is applied to each pair of objects in the order they are listed
23572 * in the transit list of objects. The first object in the pair will be the
23573 * "front" object and the second will be the "back" object.
23575 * @see elm_transit_effect_add()
23577 * @param transit Transit object.
23578 * @param axis Flipping Axis(X or Y).
23579 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23580 * @return Resizable flip effect context data.
23583 * @warning It is highly recommended just create a transit with this effect when
23584 * the window that the objects of the transit belongs has already been created.
23585 * This is because this effect needs the geometry information about the objects,
23586 * and if the window was not created yet, it can get a wrong information.
23588 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23591 * Add the Wipe Effect to Elm_Transit.
23593 * @note This API is one of the facades. It creates wipe effect context
23594 * and add it's required APIs to elm_transit_effect_add.
23596 * @see elm_transit_effect_add()
23598 * @param transit Transit object.
23599 * @param type Wipe type. Hide or show.
23600 * @param dir Wipe Direction.
23601 * @return Wipe effect context data.
23604 * @warning It is highly recommended just create a transit with this effect when
23605 * the window that the objects of the transit belongs has already been created.
23606 * This is because this effect needs the geometry information about the objects,
23607 * and if the window was not created yet, it can get a wrong information.
23609 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23612 * Add the Color Effect to Elm_Transit.
23614 * @note This API is one of the facades. It creates color effect context
23615 * and add it's required APIs to elm_transit_effect_add.
23617 * @see elm_transit_effect_add()
23619 * @param transit Transit object.
23620 * @param from_r RGB R when effect begins.
23621 * @param from_g RGB G when effect begins.
23622 * @param from_b RGB B when effect begins.
23623 * @param from_a RGB A when effect begins.
23624 * @param to_r RGB R when effect ends.
23625 * @param to_g RGB G when effect ends.
23626 * @param to_b RGB B when effect ends.
23627 * @param to_a RGB A when effect ends.
23628 * @return Color effect context data.
23632 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);
23635 * Add the Fade Effect to Elm_Transit.
23637 * @note This API is one of the facades. It creates fade effect context
23638 * and add it's required APIs to elm_transit_effect_add.
23639 * @note This effect is applied to each pair of objects in the order they are listed
23640 * in the transit list of objects. The first object in the pair will be the
23641 * "before" object and the second will be the "after" object.
23643 * @see elm_transit_effect_add()
23645 * @param transit Transit object.
23646 * @return Fade effect context data.
23649 * @warning It is highly recommended just create a transit with this effect when
23650 * the window that the objects of the transit belongs has already been created.
23651 * This is because this effect needs the color information about the objects,
23652 * and if the window was not created yet, it can get a wrong information.
23654 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23657 * Add the Blend Effect to Elm_Transit.
23659 * @note This API is one of the facades. It creates blend effect context
23660 * and add it's required APIs to elm_transit_effect_add.
23661 * @note This effect is applied to each pair of objects in the order they are listed
23662 * in the transit list of objects. The first object in the pair will be the
23663 * "before" object and the second will be the "after" object.
23665 * @see elm_transit_effect_add()
23667 * @param transit Transit object.
23668 * @return Blend effect context data.
23671 * @warning It is highly recommended just create a transit with this effect when
23672 * the window that the objects of the transit belongs has already been created.
23673 * This is because this effect needs the color information about the objects,
23674 * and if the window was not created yet, it can get a wrong information.
23676 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23679 * Add the Rotation Effect to Elm_Transit.
23681 * @note This API is one of the facades. It creates rotation effect context
23682 * and add it's required APIs to elm_transit_effect_add.
23684 * @see elm_transit_effect_add()
23686 * @param transit Transit object.
23687 * @param from_degree Degree when effect begins.
23688 * @param to_degree Degree when effect is ends.
23689 * @return Rotation effect context data.
23692 * @warning It is highly recommended just create a transit with this effect when
23693 * the window that the objects of the transit belongs has already been created.
23694 * This is because this effect needs the geometry information about the objects,
23695 * and if the window was not created yet, it can get a wrong information.
23697 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23700 * Add the ImageAnimation Effect to Elm_Transit.
23702 * @note This API is one of the facades. It creates image animation effect context
23703 * and add it's required APIs to elm_transit_effect_add.
23704 * The @p images parameter is a list images paths. This list and
23705 * its contents will be deleted at the end of the effect by
23706 * elm_transit_effect_image_animation_context_free() function.
23710 * char buf[PATH_MAX];
23711 * Eina_List *images = NULL;
23712 * Elm_Transit *transi = elm_transit_add();
23714 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23715 * images = eina_list_append(images, eina_stringshare_add(buf));
23717 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23718 * images = eina_list_append(images, eina_stringshare_add(buf));
23719 * elm_transit_effect_image_animation_add(transi, images);
23723 * @see elm_transit_effect_add()
23725 * @param transit Transit object.
23726 * @param images Eina_List of images file paths. This list and
23727 * its contents will be deleted at the end of the effect by
23728 * elm_transit_effect_image_animation_context_free() function.
23729 * @return Image Animation effect context data.
23733 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23738 typedef struct _Elm_Store Elm_Store;
23739 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23740 typedef struct _Elm_Store_Item Elm_Store_Item;
23741 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23742 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23743 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23744 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23745 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23746 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23747 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23748 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23750 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23751 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23752 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23753 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23757 ELM_STORE_ITEM_MAPPING_NONE = 0,
23758 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23759 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23760 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23761 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23762 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23763 // can add more here as needed by common apps
23764 ELM_STORE_ITEM_MAPPING_LAST
23765 } Elm_Store_Item_Mapping_Type;
23767 struct _Elm_Store_Item_Mapping_Icon
23769 // FIXME: allow edje file icons
23771 Elm_Icon_Lookup_Order lookup_order;
23772 Eina_Bool standard_name : 1;
23773 Eina_Bool no_scale : 1;
23774 Eina_Bool smooth : 1;
23775 Eina_Bool scale_up : 1;
23776 Eina_Bool scale_down : 1;
23779 struct _Elm_Store_Item_Mapping_Empty
23784 struct _Elm_Store_Item_Mapping_Photo
23789 struct _Elm_Store_Item_Mapping_Custom
23791 Elm_Store_Item_Mapping_Cb func;
23794 struct _Elm_Store_Item_Mapping
23796 Elm_Store_Item_Mapping_Type type;
23801 Elm_Store_Item_Mapping_Empty empty;
23802 Elm_Store_Item_Mapping_Icon icon;
23803 Elm_Store_Item_Mapping_Photo photo;
23804 Elm_Store_Item_Mapping_Custom custom;
23805 // add more types here
23809 struct _Elm_Store_Item_Info
23811 Elm_Genlist_Item_Class *item_class;
23812 const Elm_Store_Item_Mapping *mapping;
23817 struct _Elm_Store_Item_Info_Filesystem
23819 Elm_Store_Item_Info base;
23823 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23824 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23826 EAPI void elm_store_free(Elm_Store *st);
23828 EAPI Elm_Store *elm_store_filesystem_new(void);
23829 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23830 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23831 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23833 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23835 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23836 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23837 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23838 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23839 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23840 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23842 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23843 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23844 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23845 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23846 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23847 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23848 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23851 * @defgroup SegmentControl SegmentControl
23852 * @ingroup Elementary
23854 * @image html img/widget/segment_control/preview-00.png
23855 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23857 * @image html img/segment_control.png
23858 * @image latex img/segment_control.eps width=\textwidth
23860 * Segment control widget is a horizontal control made of multiple segment
23861 * items, each segment item functioning similar to discrete two state button.
23862 * A segment control groups the items together and provides compact
23863 * single button with multiple equal size segments.
23865 * Segment item size is determined by base widget
23866 * size and the number of items added.
23867 * Only one segment item can be at selected state. A segment item can display
23868 * combination of Text and any Evas_Object like Images or other widget.
23870 * Smart callbacks one can listen to:
23871 * - "changed" - When the user clicks on a segment item which is not
23872 * previously selected and get selected. The event_info parameter is the
23873 * segment item index.
23875 * Available styles for it:
23878 * Here is an example on its usage:
23879 * @li @ref segment_control_example
23883 * @addtogroup SegmentControl
23887 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23890 * Add a new segment control widget to the given parent Elementary
23891 * (container) object.
23893 * @param parent The parent object.
23894 * @return a new segment control widget handle or @c NULL, on errors.
23896 * This function inserts a new segment control widget on the canvas.
23898 * @ingroup SegmentControl
23900 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23903 * Append a new item to the segment control object.
23905 * @param obj The segment control object.
23906 * @param icon The icon object to use for the left side of the item. An
23907 * icon can be any Evas object, but usually it is an icon created
23908 * with elm_icon_add().
23909 * @param label The label of the item.
23910 * Note that, NULL is different from empty string "".
23911 * @return The created item or @c NULL upon failure.
23913 * A new item will be created and appended to the segment control, i.e., will
23914 * be set as @b last item.
23916 * If it should be inserted at another position,
23917 * elm_segment_control_item_insert_at() should be used instead.
23919 * Items created with this function can be deleted with function
23920 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23922 * @note @p label set to @c NULL is different from empty string "".
23924 * only has icon, it will be displayed bigger and centered. If it has
23925 * icon and label, even that an empty string, icon will be smaller and
23926 * positioned at left.
23930 * sc = elm_segment_control_add(win);
23931 * ic = elm_icon_add(win);
23932 * elm_icon_file_set(ic, "path/to/image", NULL);
23933 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23934 * elm_segment_control_item_add(sc, ic, "label");
23935 * evas_object_show(sc);
23938 * @see elm_segment_control_item_insert_at()
23939 * @see elm_segment_control_item_del()
23941 * @ingroup SegmentControl
23943 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23946 * Insert a new item to the segment control object at specified position.
23948 * @param obj The segment control object.
23949 * @param icon The icon object to use for the left side of the item. An
23950 * icon can be any Evas object, but usually it is an icon created
23951 * with elm_icon_add().
23952 * @param label The label of the item.
23953 * @param index Item position. Value should be between 0 and items count.
23954 * @return The created item or @c NULL upon failure.
23956 * Index values must be between @c 0, when item will be prepended to
23957 * segment control, and items count, that can be get with
23958 * elm_segment_control_item_count_get(), case when item will be appended
23959 * to segment control, just like elm_segment_control_item_add().
23961 * Items created with this function can be deleted with function
23962 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23964 * @note @p label set to @c NULL is different from empty string "".
23966 * only has icon, it will be displayed bigger and centered. If it has
23967 * icon and label, even that an empty string, icon will be smaller and
23968 * positioned at left.
23970 * @see elm_segment_control_item_add()
23971 * @see elm_segment_control_count_get()
23972 * @see elm_segment_control_item_del()
23974 * @ingroup SegmentControl
23976 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);
23979 * Remove a segment control item from its parent, deleting it.
23981 * @param it The item to be removed.
23983 * Items can be added with elm_segment_control_item_add() or
23984 * elm_segment_control_item_insert_at().
23986 * @ingroup SegmentControl
23988 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23991 * Remove a segment control item at given index from its parent,
23994 * @param obj The segment control object.
23995 * @param index The position of the segment control item to be deleted.
23997 * Items can be added with elm_segment_control_item_add() or
23998 * elm_segment_control_item_insert_at().
24000 * @ingroup SegmentControl
24002 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24005 * Get the Segment items count from segment control.
24007 * @param obj The segment control object.
24008 * @return Segment items count.
24010 * It will just return the number of items added to segment control @p obj.
24012 * @ingroup SegmentControl
24014 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24017 * Get the item placed at specified index.
24019 * @param obj The segment control object.
24020 * @param index The index of the segment item.
24021 * @return The segment control item or @c NULL on failure.
24023 * Index is the position of an item in segment control widget. Its
24024 * range is from @c 0 to <tt> count - 1 </tt>.
24025 * Count is the number of items, that can be get with
24026 * elm_segment_control_item_count_get().
24028 * @ingroup SegmentControl
24030 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24033 * Get the label of item.
24035 * @param obj The segment control object.
24036 * @param index The index of the segment item.
24037 * @return The label of the item at @p index.
24039 * The return value is a pointer to the label associated to the item when
24040 * it was created, with function elm_segment_control_item_add(), or later
24041 * with function elm_segment_control_item_label_set. If no label
24042 * was passed as argument, it will return @c NULL.
24044 * @see elm_segment_control_item_label_set() for more details.
24045 * @see elm_segment_control_item_add()
24047 * @ingroup SegmentControl
24049 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24052 * Set the label of item.
24054 * @param it The item of segment control.
24055 * @param text The label of item.
24057 * The label to be displayed by the item.
24058 * Label will be at right of the icon (if set).
24060 * If a label was passed as argument on item creation, with function
24061 * elm_control_segment_item_add(), it will be already
24062 * displayed by the item.
24064 * @see elm_segment_control_item_label_get()
24065 * @see elm_segment_control_item_add()
24067 * @ingroup SegmentControl
24069 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24072 * Get the icon associated to the item.
24074 * @param obj The segment control object.
24075 * @param index The index of the segment item.
24076 * @return The left side icon associated to the item at @p index.
24078 * The return value is a pointer to the icon associated to the item when
24079 * it was created, with function elm_segment_control_item_add(), or later
24080 * with function elm_segment_control_item_icon_set(). If no icon
24081 * was passed as argument, it will return @c NULL.
24083 * @see elm_segment_control_item_add()
24084 * @see elm_segment_control_item_icon_set()
24086 * @ingroup SegmentControl
24088 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24091 * Set the icon associated to the item.
24093 * @param it The segment control item.
24094 * @param icon The icon object to associate with @p it.
24096 * The icon object to use at left side of the item. An
24097 * icon can be any Evas object, but usually it is an icon created
24098 * with elm_icon_add().
24100 * Once the icon object is set, a previously set one will be deleted.
24101 * @warning Setting the same icon for two items will cause the icon to
24102 * dissapear from the first item.
24104 * If an icon was passed as argument on item creation, with function
24105 * elm_segment_control_item_add(), it will be already
24106 * associated to the item.
24108 * @see elm_segment_control_item_add()
24109 * @see elm_segment_control_item_icon_get()
24111 * @ingroup SegmentControl
24113 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24116 * Get the index of an item.
24118 * @param it The segment control item.
24119 * @return The position of item in segment control widget.
24121 * Index is the position of an item in segment control widget. Its
24122 * range is from @c 0 to <tt> count - 1 </tt>.
24123 * Count is the number of items, that can be get with
24124 * elm_segment_control_item_count_get().
24126 * @ingroup SegmentControl
24128 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24131 * Get the base object of the item.
24133 * @param it The segment control item.
24134 * @return The base object associated with @p it.
24136 * Base object is the @c Evas_Object that represents that item.
24138 * @ingroup SegmentControl
24140 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24143 * Get the selected item.
24145 * @param obj The segment control object.
24146 * @return The selected item or @c NULL if none of segment items is
24149 * The selected item can be unselected with function
24150 * elm_segment_control_item_selected_set().
24152 * The selected item always will be highlighted on segment control.
24154 * @ingroup SegmentControl
24156 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24159 * Set the selected state of an item.
24161 * @param it The segment control item
24162 * @param select The selected state
24164 * This sets the selected state of the given item @p it.
24165 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24167 * If a new item is selected the previosly selected will be unselected.
24168 * Previoulsy selected item can be get with function
24169 * elm_segment_control_item_selected_get().
24171 * The selected item always will be highlighted on segment control.
24173 * @see elm_segment_control_item_selected_get()
24175 * @ingroup SegmentControl
24177 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24184 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24185 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24186 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24187 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24188 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24189 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24190 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24191 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24194 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24195 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24196 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24198 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24199 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24200 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24201 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24202 EAPI void elm_video_play(Evas_Object *video);
24203 EAPI void elm_video_pause(Evas_Object *video);
24204 EAPI void elm_video_stop(Evas_Object *video);
24205 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24206 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24207 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24208 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24209 EAPI double elm_video_audio_level_get(Evas_Object *video);
24210 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24211 EAPI double elm_video_play_position_get(Evas_Object *video);
24212 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24213 EAPI double elm_video_play_length_get(Evas_Object *video);
24214 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24215 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24216 EAPI const char *elm_video_title_get(Evas_Object *video);
24218 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24219 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24222 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24223 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);
24224 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24225 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24226 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24227 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24228 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24229 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24230 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24231 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24232 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24233 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24234 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24235 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24236 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);