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 latex img/widget/button/preview-00.eps
4005 * @image html img/widget/button/preview-01.png
4006 * @image latex img/widget/button/preview-01.eps
4007 * @image html img/widget/button/preview-02.png
4008 * @image latex img/widget/button/preview-02.eps
4010 * This is a push-button. Press it and run some function. It can contain
4011 * a simple label and icon object and it also has an autorepeat feature.
4013 * This widgets emits the following signals:
4014 * @li "clicked": the user clicked the button (press/release).
4015 * @li "repeated": the user pressed the button without releasing it.
4016 * @li "pressed": button was pressed.
4017 * @li "unpressed": button was released after being pressed.
4018 * In all three cases, the @c event parameter of the callback will be
4021 * Also, defined in the default theme, the button has the following styles
4023 * @li default: a normal button.
4024 * @li anchor: Like default, but the button fades away when the mouse is not
4025 * over it, leaving only the text or icon.
4026 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4027 * continuous look across its options.
4028 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4030 * Follow through a complete example @ref button_example_01 "here".
4034 * Add a new button to the parent's canvas
4036 * @param parent The parent object
4037 * @return The new object or NULL if it cannot be created
4039 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4041 * Set the label used in the button
4043 * The passed @p label can be NULL to clean any existing text in it and
4044 * leave the button as an icon only object.
4046 * @param obj The button object
4047 * @param label The text will be written on the button
4048 * @deprecated use elm_object_text_set() instead.
4050 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4052 * Get the label set for the button
4054 * The string returned is an internal pointer and should not be freed or
4055 * altered. It will also become invalid when the button is destroyed.
4056 * The string returned, if not NULL, is a stringshare, so if you need to
4057 * keep it around even after the button is destroyed, you can use
4058 * eina_stringshare_ref().
4060 * @param obj The button object
4061 * @return The text set to the label, or NULL if nothing is set
4062 * @deprecated use elm_object_text_set() instead.
4064 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4066 * Set the icon used for the button
4068 * Setting a new icon will delete any other that was previously set, making
4069 * any reference to them invalid. If you need to maintain the previous
4070 * object alive, unset it first with elm_button_icon_unset().
4072 * @param obj The button object
4073 * @param icon The icon object for the button
4075 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4077 * Get the icon used for the button
4079 * Return the icon object which is set for this widget. If the button is
4080 * destroyed or another icon is set, the returned object will be deleted
4081 * and any reference to it will be invalid.
4083 * @param obj The button object
4084 * @return The icon object that is being used
4086 * @see elm_button_icon_unset()
4088 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4090 * Remove the icon set without deleting it and return the object
4092 * This function drops the reference the button holds of the icon object
4093 * and returns this last object. It is used in case you want to remove any
4094 * icon, or set another one, without deleting the actual object. The button
4095 * will be left without an icon set.
4097 * @param obj The button object
4098 * @return The icon object that was being used
4100 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4102 * Turn on/off the autorepeat event generated when the button is kept pressed
4104 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4105 * signal when they are clicked.
4107 * When on, keeping a button pressed will continuously emit a @c repeated
4108 * signal until the button is released. The time it takes until it starts
4109 * emitting the signal is given by
4110 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4111 * new emission by elm_button_autorepeat_gap_timeout_set().
4113 * @param obj The button object
4114 * @param on A bool to turn on/off the event
4116 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4118 * Get whether the autorepeat feature is enabled
4120 * @param obj The button object
4121 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4123 * @see elm_button_autorepeat_set()
4125 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4127 * Set the initial timeout before the autorepeat event is generated
4129 * Sets the timeout, in seconds, since the button is pressed until the
4130 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4131 * won't be any delay and the even will be fired the moment the button is
4134 * @param obj The button object
4135 * @param t Timeout in seconds
4137 * @see elm_button_autorepeat_set()
4138 * @see elm_button_autorepeat_gap_timeout_set()
4140 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4142 * Get the initial timeout before the autorepeat event is generated
4144 * @param obj The button object
4145 * @return Timeout in seconds
4147 * @see elm_button_autorepeat_initial_timeout_set()
4149 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151 * Set the interval between each generated autorepeat event
4153 * After the first @c repeated event is fired, all subsequent ones will
4154 * follow after a delay of @p t seconds for each.
4156 * @param obj The button object
4157 * @param t Interval in seconds
4159 * @see elm_button_autorepeat_initial_timeout_set()
4161 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4163 * Get the interval between each generated autorepeat event
4165 * @param obj The button object
4166 * @return Interval in seconds
4168 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4174 * @defgroup File_Selector_Button File Selector Button
4176 * @image html img/widget/fileselector_button/preview-00.png
4177 * @image latex img/widget/fileselector_button/preview-00.eps
4178 * @image html img/widget/fileselector_button/preview-01.png
4179 * @image latex img/widget/fileselector_button/preview-01.eps
4180 * @image html img/widget/fileselector_button/preview-02.png
4181 * @image latex img/widget/fileselector_button/preview-02.eps
4183 * This is a button that, when clicked, creates an Elementary
4184 * window (or inner window) <b> with a @ref Fileselector "file
4185 * selector widget" within</b>. When a file is chosen, the (inner)
4186 * window is closed and the button emits a signal having the
4187 * selected file as it's @c event_info.
4189 * This widget encapsulates operations on its internal file
4190 * selector on its own API. There is less control over its file
4191 * selector than that one would have instatiating one directly.
4193 * The following styles are available for this button:
4196 * @li @c "hoversel_vertical"
4197 * @li @c "hoversel_vertical_entry"
4199 * Smart callbacks one can register to:
4200 * - @c "file,chosen" - the user has selected a path, whose string
4201 * pointer comes as the @c event_info data (a stringshared
4204 * Here is an example on its usage:
4205 * @li @ref fileselector_button_example
4207 * @see @ref File_Selector_Entry for a similar widget.
4212 * Add a new file selector button widget to the given parent
4213 * Elementary (container) object
4215 * @param parent The parent object
4216 * @return a new file selector button widget handle or @c NULL, on
4219 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4222 * Set the label for a given file selector button widget
4224 * @param obj The file selector button widget
4225 * @param label The text label to be displayed on @p obj
4227 * @deprecated use elm_object_text_set() instead.
4229 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4232 * Get the label set for a given file selector button widget
4234 * @param obj The file selector button widget
4235 * @return The button label
4237 * @deprecated use elm_object_text_set() instead.
4239 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4242 * Set the icon on a given file selector button widget
4244 * @param obj The file selector button widget
4245 * @param icon The icon object for the button
4247 * Once the icon object is set, a previously set one will be
4248 * deleted. If you want to keep the latter, use the
4249 * elm_fileselector_button_icon_unset() function.
4251 * @see elm_fileselector_button_icon_get()
4253 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4256 * Get the icon set for a given file selector button widget
4258 * @param obj The file selector button widget
4259 * @return The icon object currently set on @p obj or @c NULL, if
4262 * @see elm_fileselector_button_icon_set()
4264 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4267 * Unset the icon used in a given file selector button widget
4269 * @param obj The file selector button widget
4270 * @return The icon object that was being used on @p obj or @c
4273 * Unparent and return the icon object which was set for this
4276 * @see elm_fileselector_button_icon_set()
4278 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4281 * Set the title for a given file selector button widget's window
4283 * @param obj The file selector button widget
4284 * @param title The title string
4286 * This will change the window's title, when the file selector pops
4287 * out after a click on the button. Those windows have the default
4288 * (unlocalized) value of @c "Select a file" as titles.
4290 * @note It will only take any effect if the file selector
4291 * button widget is @b not under "inwin mode".
4293 * @see elm_fileselector_button_window_title_get()
4295 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4298 * Get the title set for a given file selector button widget's
4301 * @param obj The file selector button widget
4302 * @return Title of the file selector button's window
4304 * @see elm_fileselector_button_window_title_get() for more details
4306 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4309 * Set the size of a given file selector button widget's window,
4310 * holding the file selector itself.
4312 * @param obj The file selector button widget
4313 * @param width The window's width
4314 * @param height The window's height
4316 * @note it will only take any effect if the file selector button
4317 * widget is @b not under "inwin mode". The default size for the
4318 * window (when applicable) is 400x400 pixels.
4320 * @see elm_fileselector_button_window_size_get()
4322 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4325 * Get the size of a given file selector button widget's window,
4326 * holding the file selector itself.
4328 * @param obj The file selector button widget
4329 * @param width Pointer into which to store the width value
4330 * @param height Pointer into which to store the height value
4332 * @note Use @c NULL pointers on the size values you're not
4333 * interested in: they'll be ignored by the function.
4335 * @see elm_fileselector_button_window_size_set(), for more details
4337 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4340 * Set the initial file system path for a given file selector
4343 * @param obj The file selector button widget
4344 * @param path The path string
4346 * It must be a <b>directory</b> path, which will have the contents
4347 * displayed initially in the file selector's view, when invoked
4348 * from @p obj. The default initial path is the @c "HOME"
4349 * environment variable's value.
4351 * @see elm_fileselector_button_path_get()
4353 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4356 * Get the initial file system path set for a given file selector
4359 * @param obj The file selector button widget
4360 * @return path The path string
4362 * @see elm_fileselector_button_path_set() for more details
4364 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367 * Enable/disable a tree view in the given file selector button
4368 * widget's internal file selector
4370 * @param obj The file selector button widget
4371 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4374 * This has the same effect as elm_fileselector_expandable_set(),
4375 * but now applied to a file selector button's internal file
4378 * @note There's no way to put a file selector button's internal
4379 * file selector in "grid mode", as one may do with "pure" file
4382 * @see elm_fileselector_expandable_get()
4384 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4387 * Get whether tree view is enabled for the given file selector
4388 * button widget's internal file selector
4390 * @param obj The file selector button widget
4391 * @return @c EINA_TRUE if @p obj widget's internal file selector
4392 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4394 * @see elm_fileselector_expandable_set() for more details
4396 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4399 * Set whether a given file selector button widget's internal file
4400 * selector is to display folders only or the directory contents,
4403 * @param obj The file selector button widget
4404 * @param only @c EINA_TRUE to make @p obj widget's internal file
4405 * selector only display directories, @c EINA_FALSE to make files
4406 * to be displayed in it too
4408 * This has the same effect as elm_fileselector_folder_only_set(),
4409 * but now applied to a file selector button's internal file
4412 * @see elm_fileselector_folder_only_get()
4414 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4417 * Get whether a given file selector button widget's internal file
4418 * selector is displaying folders only or the directory contents,
4421 * @param obj The file selector button widget
4422 * @return @c EINA_TRUE if @p obj widget's internal file
4423 * selector is only displaying directories, @c EINA_FALSE if files
4424 * are being displayed in it too (and on errors)
4426 * @see elm_fileselector_button_folder_only_set() for more details
4428 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4431 * Enable/disable the file name entry box where the user can type
4432 * in a name for a file, in a given file selector button widget's
4433 * internal file selector.
4435 * @param obj The file selector button widget
4436 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4437 * file selector a "saving dialog", @c EINA_FALSE otherwise
4439 * This has the same effect as elm_fileselector_is_save_set(),
4440 * but now applied to a file selector button's internal file
4443 * @see elm_fileselector_is_save_get()
4445 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4448 * Get whether the given file selector button widget's internal
4449 * file selector is in "saving dialog" mode
4451 * @param obj The file selector button widget
4452 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4453 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4456 * @see elm_fileselector_button_is_save_set() for more details
4458 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4461 * Set whether a given file selector button widget's internal file
4462 * selector will raise an Elementary "inner window", instead of a
4463 * dedicated Elementary window. By default, it won't.
4465 * @param obj The file selector button widget
4466 * @param value @c EINA_TRUE to make it use an inner window, @c
4467 * EINA_TRUE to make it use a dedicated window
4469 * @see elm_win_inwin_add() for more information on inner windows
4470 * @see elm_fileselector_button_inwin_mode_get()
4472 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4475 * Get whether a given file selector button widget's internal file
4476 * selector will raise an Elementary "inner window", instead of a
4477 * dedicated Elementary window.
4479 * @param obj The file selector button widget
4480 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4481 * if it will use a dedicated window
4483 * @see elm_fileselector_button_inwin_mode_set() for more details
4485 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4492 * @defgroup File_Selector_Entry File Selector Entry
4494 * @image html img/widget/fileselector_entry/preview-00.png
4495 * @image latex img/widget/fileselector_entry/preview-00.eps
4497 * This is an entry made to be filled with or display a <b>file
4498 * system path string</b>. Besides the entry itself, the widget has
4499 * a @ref File_Selector_Button "file selector button" on its side,
4500 * which will raise an internal @ref Fileselector "file selector widget",
4501 * when clicked, for path selection aided by file system
4504 * This file selector may appear in an Elementary window or in an
4505 * inner window. When a file is chosen from it, the (inner) window
4506 * is closed and the selected file's path string is exposed both as
4507 * an smart event and as the new text on the entry.
4509 * This widget encapsulates operations on its internal file
4510 * selector on its own API. There is less control over its file
4511 * selector than that one would have instatiating one directly.
4513 * Smart callbacks one can register to:
4514 * - @c "changed" - The text within the entry was changed
4515 * - @c "activated" - The entry has had editing finished and
4516 * changes are to be "committed"
4517 * - @c "press" - The entry has been clicked
4518 * - @c "longpressed" - The entry has been clicked (and held) for a
4520 * - @c "clicked" - The entry has been clicked
4521 * - @c "clicked,double" - The entry has been double clicked
4522 * - @c "focused" - The entry has received focus
4523 * - @c "unfocused" - The entry has lost focus
4524 * - @c "selection,paste" - A paste action has occurred on the
4526 * - @c "selection,copy" - A copy action has occurred on the entry
4527 * - @c "selection,cut" - A cut action has occurred on the entry
4528 * - @c "unpressed" - The file selector entry's button was released
4529 * after being pressed.
4530 * - @c "file,chosen" - The user has selected a path via the file
4531 * selector entry's internal file selector, whose string pointer
4532 * comes as the @c event_info data (a stringshared string)
4534 * Here is an example on its usage:
4535 * @li @ref fileselector_entry_example
4537 * @see @ref File_Selector_Button for a similar widget.
4542 * Add a new file selector entry widget to the given parent
4543 * Elementary (container) object
4545 * @param parent The parent object
4546 * @return a new file selector entry widget handle or @c NULL, on
4549 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4552 * Set the label for a given file selector entry widget's button
4554 * @param obj The file selector entry widget
4555 * @param label The text label to be displayed on @p obj widget's
4558 * @deprecated use elm_object_text_set() instead.
4560 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4563 * Get the label set for a given file selector entry widget's button
4565 * @param obj The file selector entry widget
4566 * @return The widget button's label
4568 * @deprecated use elm_object_text_set() instead.
4570 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4573 * Set the icon on a given file selector entry widget's button
4575 * @param obj The file selector entry widget
4576 * @param icon The icon object for the entry's button
4578 * Once the icon object is set, a previously set one will be
4579 * deleted. If you want to keep the latter, use the
4580 * elm_fileselector_entry_button_icon_unset() function.
4582 * @see elm_fileselector_entry_button_icon_get()
4584 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4587 * Get the icon set for a given file selector entry widget's button
4589 * @param obj The file selector entry widget
4590 * @return The icon object currently set on @p obj widget's button
4591 * or @c NULL, if none is
4593 * @see elm_fileselector_entry_button_icon_set()
4595 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4598 * Unset the icon used in a given file selector entry widget's
4601 * @param obj The file selector entry widget
4602 * @return The icon object that was being used on @p obj widget's
4603 * button or @c NULL, on errors
4605 * Unparent and return the icon object which was set for this
4608 * @see elm_fileselector_entry_button_icon_set()
4610 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4613 * Set the title for a given file selector entry widget's window
4615 * @param obj The file selector entry widget
4616 * @param title The title string
4618 * This will change the window's title, when the file selector pops
4619 * out after a click on the entry's button. Those windows have the
4620 * default (unlocalized) value of @c "Select a file" as titles.
4622 * @note It will only take any effect if the file selector
4623 * entry widget is @b not under "inwin mode".
4625 * @see elm_fileselector_entry_window_title_get()
4627 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4630 * Get the title set for a given file selector entry widget's
4633 * @param obj The file selector entry widget
4634 * @return Title of the file selector entry's window
4636 * @see elm_fileselector_entry_window_title_get() for more details
4638 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4641 * Set the size of a given file selector entry widget's window,
4642 * holding the file selector itself.
4644 * @param obj The file selector entry widget
4645 * @param width The window's width
4646 * @param height The window's height
4648 * @note it will only take any effect if the file selector entry
4649 * widget is @b not under "inwin mode". The default size for the
4650 * window (when applicable) is 400x400 pixels.
4652 * @see elm_fileselector_entry_window_size_get()
4654 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4657 * Get the size of a given file selector entry widget's window,
4658 * holding the file selector itself.
4660 * @param obj The file selector entry widget
4661 * @param width Pointer into which to store the width value
4662 * @param height Pointer into which to store the height value
4664 * @note Use @c NULL pointers on the size values you're not
4665 * interested in: they'll be ignored by the function.
4667 * @see elm_fileselector_entry_window_size_set(), for more details
4669 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4672 * Set the initial file system path and the entry's path string for
4673 * a given file selector entry widget
4675 * @param obj The file selector entry widget
4676 * @param path The path string
4678 * It must be a <b>directory</b> path, which will have the contents
4679 * displayed initially in the file selector's view, when invoked
4680 * from @p obj. The default initial path is the @c "HOME"
4681 * environment variable's value.
4683 * @see elm_fileselector_entry_path_get()
4685 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4688 * Get the entry's path string for a given file selector entry
4691 * @param obj The file selector entry widget
4692 * @return path The path string
4694 * @see elm_fileselector_entry_path_set() for more details
4696 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4699 * Enable/disable a tree view in the given file selector entry
4700 * widget's internal file selector
4702 * @param obj The file selector entry widget
4703 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4706 * This has the same effect as elm_fileselector_expandable_set(),
4707 * but now applied to a file selector entry's internal file
4710 * @note There's no way to put a file selector entry's internal
4711 * file selector in "grid mode", as one may do with "pure" file
4714 * @see elm_fileselector_expandable_get()
4716 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4719 * Get whether tree view is enabled for the given file selector
4720 * entry widget's internal file selector
4722 * @param obj The file selector entry widget
4723 * @return @c EINA_TRUE if @p obj widget's internal file selector
4724 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4726 * @see elm_fileselector_expandable_set() for more details
4728 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4731 * Set whether a given file selector entry widget's internal file
4732 * selector is to display folders only or the directory contents,
4735 * @param obj The file selector entry widget
4736 * @param only @c EINA_TRUE to make @p obj widget's internal file
4737 * selector only display directories, @c EINA_FALSE to make files
4738 * to be displayed in it too
4740 * This has the same effect as elm_fileselector_folder_only_set(),
4741 * but now applied to a file selector entry's internal file
4744 * @see elm_fileselector_folder_only_get()
4746 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4749 * Get whether a given file selector entry widget's internal file
4750 * selector is displaying folders only or the directory contents,
4753 * @param obj The file selector entry widget
4754 * @return @c EINA_TRUE if @p obj widget's internal file
4755 * selector is only displaying directories, @c EINA_FALSE if files
4756 * are being displayed in it too (and on errors)
4758 * @see elm_fileselector_entry_folder_only_set() for more details
4760 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4763 * Enable/disable the file name entry box where the user can type
4764 * in a name for a file, in a given file selector entry widget's
4765 * internal file selector.
4767 * @param obj The file selector entry widget
4768 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4769 * file selector a "saving dialog", @c EINA_FALSE otherwise
4771 * This has the same effect as elm_fileselector_is_save_set(),
4772 * but now applied to a file selector entry's internal file
4775 * @see elm_fileselector_is_save_get()
4777 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4780 * Get whether the given file selector entry widget's internal
4781 * file selector is in "saving dialog" mode
4783 * @param obj The file selector entry widget
4784 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4785 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4788 * @see elm_fileselector_entry_is_save_set() for more details
4790 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4793 * Set whether a given file selector entry widget's internal file
4794 * selector will raise an Elementary "inner window", instead of a
4795 * dedicated Elementary window. By default, it won't.
4797 * @param obj The file selector entry widget
4798 * @param value @c EINA_TRUE to make it use an inner window, @c
4799 * EINA_TRUE to make it use a dedicated window
4801 * @see elm_win_inwin_add() for more information on inner windows
4802 * @see elm_fileselector_entry_inwin_mode_get()
4804 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4807 * Get whether a given file selector entry widget's internal file
4808 * selector will raise an Elementary "inner window", instead of a
4809 * dedicated Elementary window.
4811 * @param obj The file selector entry widget
4812 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4813 * if it will use a dedicated window
4815 * @see elm_fileselector_entry_inwin_mode_set() for more details
4817 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4820 * Set the initial file system path for a given file selector entry
4823 * @param obj The file selector entry widget
4824 * @param path The path string
4826 * It must be a <b>directory</b> path, which will have the contents
4827 * displayed initially in the file selector's view, when invoked
4828 * from @p obj. The default initial path is the @c "HOME"
4829 * environment variable's value.
4831 * @see elm_fileselector_entry_path_get()
4833 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4836 * Get the parent directory's path to the latest file selection on
4837 * a given filer selector entry widget
4839 * @param obj The file selector object
4840 * @return The (full) path of the directory of the last selection
4841 * on @p obj widget, a @b stringshared string
4843 * @see elm_fileselector_entry_path_set()
4845 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4852 * @defgroup Scroller Scroller
4854 * A scroller holds a single object and "scrolls it around". This means that
4855 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4856 * region around, allowing to move through a much larger object that is
4857 * contained in the scroller. The scroiller will always have a small minimum
4858 * size by default as it won't be limited by the contents of the scroller.
4860 * Signals that you can add callbacks for are:
4861 * @li "edge,left" - the left edge of the content has been reached
4862 * @li "edge,right" - the right edge of the content has been reached
4863 * @li "edge,top" - the top edge of the content has been reached
4864 * @li "edge,bottom" - the bottom edge of the content has been reached
4865 * @li "scroll" - the content has been scrolled (moved)
4866 * @li "scroll,anim,start" - scrolling animation has started
4867 * @li "scroll,anim,stop" - scrolling animation has stopped
4868 * @li "scroll,drag,start" - dragging the contents around has started
4869 * @li "scroll,drag,stop" - dragging the contents around has stopped
4870 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4873 * @note When Elemementary is in embedded mode the scrollbars will not be
4874 * dragable, they appear merely as indicators of how much has been scrolled.
4875 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4876 * fingerscroll) won't work.
4878 * In @ref tutorial_scroller you'll find an example of how to use most of
4883 * @brief Type that controls when scrollbars should appear.
4885 * @see elm_scroller_policy_set()
4887 typedef enum _Elm_Scroller_Policy
4889 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4890 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4891 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4892 ELM_SCROLLER_POLICY_LAST
4893 } Elm_Scroller_Policy;
4895 * @brief Add a new scroller to the parent
4897 * @param parent The parent object
4898 * @return The new object or NULL if it cannot be created
4900 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4902 * @brief Set the content of the scroller widget (the object to be scrolled around).
4904 * @param obj The scroller object
4905 * @param content The new content object
4907 * Once the content object is set, a previously set one will be deleted.
4908 * If you want to keep that old content object, use the
4909 * elm_scroller_content_unset() function.
4911 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4913 * @brief Get the content of the scroller widget
4915 * @param obj The slider object
4916 * @return The content that is being used
4918 * Return the content object which is set for this widget
4920 * @see elm_scroller_content_set()
4922 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924 * @brief Unset the content of the scroller widget
4926 * @param obj The slider object
4927 * @return The content that was being used
4929 * Unparent and return the content object which was set for this widget
4931 * @see elm_scroller_content_set()
4933 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4935 * @brief Set custom theme elements for the scroller
4937 * @param obj The scroller object
4938 * @param widget The widget name to use (default is "scroller")
4939 * @param base The base name to use (default is "base")
4941 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4943 * @brief Make the scroller minimum size limited to the minimum size of the content
4945 * @param obj The scroller object
4946 * @param w Enable limiting minimum size horizontally
4947 * @param h Enable limiting minimum size vertically
4949 * By default the scroller will be as small as its design allows,
4950 * irrespective of its content. This will make the scroller minimum size the
4951 * right size horizontally and/or vertically to perfectly fit its content in
4954 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4956 * @brief Show a specific virtual region within the scroller content object
4958 * @param obj The scroller object
4959 * @param x X coordinate of the region
4960 * @param y Y coordinate of the region
4961 * @param w Width of the region
4962 * @param h Height of the region
4964 * This will ensure all (or part if it does not fit) of the designated
4965 * region in the virtual content object (0, 0 starting at the top-left of the
4966 * virtual content object) is shown within the scroller.
4968 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);
4970 * @brief Set the scrollbar visibility policy
4972 * @param obj The scroller object
4973 * @param policy_h Horizontal scrollbar policy
4974 * @param policy_v Vertical scrollbar policy
4976 * This sets the scrollbar visibility policy for the given scroller.
4977 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4978 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4979 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4980 * respectively for the horizontal and vertical scrollbars.
4982 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4984 * @brief Gets scrollbar visibility policy
4986 * @param obj The scroller object
4987 * @param policy_h Horizontal scrollbar policy
4988 * @param policy_v Vertical scrollbar policy
4990 * @see elm_scroller_policy_set()
4992 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4994 * @brief Get the currently visible content region
4996 * @param obj The scroller object
4997 * @param x X coordinate of the region
4998 * @param y Y coordinate of the region
4999 * @param w Width of the region
5000 * @param h Height of the region
5002 * This gets the current region in the content object that is visible through
5003 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5004 * w, @p h values pointed to.
5006 * @note All coordinates are relative to the content.
5008 * @see elm_scroller_region_show()
5010 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);
5012 * @brief Get the size of the content object
5014 * @param obj The scroller object
5015 * @param w Width return
5016 * @param h Height return
5018 * This gets the size of the content object of the scroller.
5020 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5022 * @brief Set bouncing behavior
5024 * @param obj The scroller object
5025 * @param h_bounce Will the scroller bounce horizontally or not
5026 * @param v_bounce Will the scroller bounce vertically or not
5028 * When scrolling, the scroller may "bounce" when reaching an edge of the
5029 * content object. This is a visual way to indicate the end has been reached.
5030 * This is enabled by default for both axis. This will set if it is enabled
5031 * for that axis with the boolean parameters for each axis.
5033 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5035 * @brief Get the bounce mode
5037 * @param obj The Scroller object
5038 * @param h_bounce Allow bounce horizontally
5039 * @param v_bounce Allow bounce vertically
5041 * @see elm_scroller_bounce_set()
5043 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5045 * @brief Set scroll page size relative to viewport size.
5047 * @param obj The scroller object
5048 * @param h_pagerel The horizontal page relative size
5049 * @param v_pagerel The vertical page relative size
5051 * The scroller is capable of limiting scrolling by the user to "pages". That
5052 * is to jump by and only show a "whole page" at a time as if the continuous
5053 * area of the scroller content is split into page sized pieces. This sets
5054 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5055 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5056 * axis. This is mutually exclusive with page size
5057 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5058 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5059 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5062 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5064 * @brief Set scroll page size.
5066 * @param obj The scroller object
5067 * @param h_pagesize The horizontal page size
5068 * @param v_pagesize The vertical page size
5070 * This sets the page size to an absolute fixed value, with 0 turning it off
5073 * @see elm_scroller_page_relative_set()
5075 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5077 * @brief Show a specific virtual region within the scroller content object.
5079 * @param obj The scroller object
5080 * @param x X coordinate of the region
5081 * @param y Y coordinate of the region
5082 * @param w Width of the region
5083 * @param h Height of the region
5085 * This will ensure all (or part if it does not fit) of the designated
5086 * region in the virtual content object (0, 0 starting at the top-left of the
5087 * virtual content object) is shown within the scroller. Unlike
5088 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5089 * to this location (if configuration in general calls for transitions). It
5090 * may not jump immediately to the new location and make take a while and
5091 * show other content along the way.
5093 * @see elm_scroller_region_show()
5095 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);
5097 * @brief Set event propagation on a scroller
5099 * @param obj The scroller object
5100 * @param propagation If propagation is enabled or not
5102 * This enables or disabled event propagation from the scroller content to
5103 * the scroller and its parent. By default event propagation is disabled.
5105 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5107 * @brief Get event propagation for a scroller
5109 * @param obj The scroller object
5110 * @return The propagation state
5112 * This gets the event propagation for a scroller.
5114 * @see elm_scroller_propagate_events_set()
5116 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5122 * @defgroup Label Label
5124 * @image html img/widget/label/preview-00.png
5125 * @image latex img/widget/label/preview-00.eps
5127 * @brief Widget to display text, with simple html-like markup.
5129 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5130 * text doesn't fit the geometry of the label it will be ellipsized or be
5131 * cut. Elementary provides several themes for this widget:
5132 * @li default - No animation
5133 * @li marker - Centers the text in the label and make it bold by default
5134 * @li slide_long - The entire text appears from the right of the screen and
5135 * slides until it disappears in the left of the screen(reappering on the
5137 * @li slide_short - The text appears in the left of the label and slides to
5138 * the right to show the overflow. When all of the text has been shown the
5139 * position is reset.
5140 * @li slide_bounce - The text appears in the left of the label and slides to
5141 * the right to show the overflow. When all of the text has been shown the
5142 * animation reverses, moving the text to the left.
5144 * Custom themes can of course invent new markup tags and style them any way
5147 * See @ref tutorial_label for a demonstration of how to use a label widget.
5151 * @brief Add a new label to the parent
5153 * @param parent The parent object
5154 * @return The new object or NULL if it cannot be created
5156 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5158 * @brief Set the label on the label object
5160 * @param obj The label object
5161 * @param label The label will be used on the label object
5162 * @deprecated See elm_object_text_set()
5164 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 */
5166 * @brief Get the label used on the label object
5168 * @param obj The label object
5169 * @return The string inside the label
5170 * @deprecated See elm_object_text_get()
5172 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5174 * @brief Set the wrapping behavior of the label
5176 * @param obj The label object
5177 * @param wrap To wrap text or not
5179 * By default no wrapping is done. Possible values for @p wrap are:
5180 * @li ELM_WRAP_NONE - No wrapping
5181 * @li ELM_WRAP_CHAR - wrap between characters
5182 * @li ELM_WRAP_WORD - wrap between words
5183 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5185 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5187 * @brief Get the wrapping behavior of the label
5189 * @param obj The label object
5192 * @see elm_label_line_wrap_set()
5194 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5196 * @brief Set wrap width of the label
5198 * @param obj The label object
5199 * @param w The wrap width in pixels at a minimum where words need to wrap
5201 * This function sets the maximum width size hint of the label.
5203 * @warning This is only relevant if the label is inside a container.
5205 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5207 * @brief Get wrap width of the label
5209 * @param obj The label object
5210 * @return The wrap width in pixels at a minimum where words need to wrap
5212 * @see elm_label_wrap_width_set()
5214 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5216 * @brief Set wrap height of the label
5218 * @param obj The label object
5219 * @param h The wrap height in pixels at a minimum where words need to wrap
5221 * This function sets the maximum height size hint of the label.
5223 * @warning This is only relevant if the label is inside a container.
5225 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5227 * @brief get wrap width of the label
5229 * @param obj The label object
5230 * @return The wrap height in pixels at a minimum where words need to wrap
5232 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5234 * @brief Set the font size on the label object.
5236 * @param obj The label object
5237 * @param size font size
5239 * @warning NEVER use this. It is for hyper-special cases only. use styles
5240 * instead. e.g. "big", "medium", "small" - or better name them by use:
5241 * "title", "footnote", "quote" etc.
5243 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5245 * @brief Set the text color on the label object
5247 * @param obj The label object
5248 * @param r Red property background color of The label object
5249 * @param g Green property background color of The label object
5250 * @param b Blue property background color of The label object
5251 * @param a Alpha property background color of The label object
5253 * @warning NEVER use this. It is for hyper-special cases only. use styles
5254 * instead. e.g. "big", "medium", "small" - or better name them by use:
5255 * "title", "footnote", "quote" etc.
5257 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);
5259 * @brief Set the text align on the label object
5261 * @param obj The label object
5262 * @param align align mode ("left", "center", "right")
5264 * @warning NEVER use this. It is for hyper-special cases only. use styles
5265 * instead. e.g. "big", "medium", "small" - or better name them by use:
5266 * "title", "footnote", "quote" etc.
5268 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5270 * @brief Set background color of the label
5272 * @param obj The label object
5273 * @param r Red property background color of The label object
5274 * @param g Green property background color of The label object
5275 * @param b Blue property background color of The label object
5276 * @param a Alpha property background alpha of The label object
5278 * @warning NEVER use this. It is for hyper-special cases only. use styles
5279 * instead. e.g. "big", "medium", "small" - or better name them by use:
5280 * "title", "footnote", "quote" etc.
5282 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);
5284 * @brief Set the ellipsis behavior of the label
5286 * @param obj The label object
5287 * @param ellipsis To ellipsis text or not
5289 * If set to true and the text doesn't fit in the label an ellipsis("...")
5290 * will be shown at the end of the widget.
5292 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5293 * choosen wrap method was ELM_WRAP_WORD.
5295 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5297 * @brief Set the text slide of the label
5299 * @param obj The label object
5300 * @param slide To start slide or stop
5302 * If set to true the text of the label will slide throught the length of
5305 * @warning This only work with the themes "slide_short", "slide_long" and
5308 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5310 * @brief Get the text slide mode of the label
5312 * @param obj The label object
5313 * @return slide slide mode value
5315 * @see elm_label_slide_set()
5317 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5319 * @brief Set the slide duration(speed) of the label
5321 * @param obj The label object
5322 * @return The duration in seconds in moving text from slide begin position
5323 * to slide end position
5325 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5327 * @brief Get the slide duration(speed) of the label
5329 * @param obj The label object
5330 * @return The duration time in moving text from slide begin position to slide end position
5332 * @see elm_label_slide_duration_set()
5334 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5340 * @defgroup Toggle Toggle
5342 * @image html img/widget/toggle/preview-00.png
5343 * @image latex img/widget/toggle/preview-00.eps
5345 * @brief A toggle is a slider which can be used to toggle between
5346 * two values. It has two states: on and off.
5348 * Signals that you can add callbacks for are:
5349 * @li "changed" - Whenever the toggle value has been changed. Is not called
5350 * until the toggle is released by the cursor (assuming it
5351 * has been triggered by the cursor in the first place).
5353 * @ref tutorial_toggle show how to use a toggle.
5357 * @brief Add a toggle to @p parent.
5359 * @param parent The parent object
5361 * @return The toggle object
5363 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5365 * @brief Sets the label to be displayed with the toggle.
5367 * @param obj The toggle object
5368 * @param label The label to be displayed
5370 * @deprecated use elm_object_text_set() instead.
5372 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5374 * @brief Gets the label of the toggle
5376 * @param obj toggle object
5377 * @return The label of the toggle
5379 * @deprecated use elm_object_text_get() instead.
5381 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5383 * @brief Set the icon used for the toggle
5385 * @param obj The toggle object
5386 * @param icon The icon object for the button
5388 * Once the icon object is set, a previously set one will be deleted
5389 * If you want to keep that old content object, use the
5390 * elm_toggle_icon_unset() function.
5392 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5394 * @brief Get the icon used for the toggle
5396 * @param obj The toggle object
5397 * @return The icon object that is being used
5399 * Return the icon object which is set for this widget.
5401 * @see elm_toggle_icon_set()
5403 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5405 * @brief Unset the icon used for the toggle
5407 * @param obj The toggle object
5408 * @return The icon object that was being used
5410 * Unparent and return the icon object which was set for this widget.
5412 * @see elm_toggle_icon_set()
5414 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5416 * @brief Sets the labels to be associated with the on and off states of the toggle.
5418 * @param obj The toggle object
5419 * @param onlabel The label displayed when the toggle is in the "on" state
5420 * @param offlabel The label displayed when the toggle is in the "off" state
5422 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5424 * @brief Gets the labels associated with the on and off states of the toggle.
5426 * @param obj The toggle object
5427 * @param onlabel A char** to place the onlabel of @p obj into
5428 * @param offlabel A char** to place the offlabel of @p obj into
5430 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5432 * @brief Sets the state of the toggle to @p state.
5434 * @param obj The toggle object
5435 * @param state The state of @p obj
5437 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5439 * @brief Gets the state of the toggle to @p state.
5441 * @param obj The toggle object
5442 * @return The state of @p obj
5444 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5446 * @brief Sets the state pointer of the toggle to @p statep.
5448 * @param obj The toggle object
5449 * @param statep The state pointer of @p obj
5451 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5457 * @defgroup Frame Frame
5459 * @image html img/widget/frame/preview-00.png
5460 * @image latex img/widget/frame/preview-00.eps
5462 * @brief Frame is a widget that holds some content and has a title.
5464 * The default look is a frame with a title, but Frame supports multple
5472 * @li outdent_bottom
5474 * Of all this styles only default shows the title. Frame emits no signals.
5476 * For a detailed example see the @ref tutorial_frame.
5481 * @brief Add a new frame to the parent
5483 * @param parent The parent object
5484 * @return The new object or NULL if it cannot be created
5486 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5488 * @brief Set the frame label
5490 * @param obj The frame object
5491 * @param label The label of this frame object
5493 * @deprecated use elm_object_text_set() instead.
5495 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5497 * @brief Get the frame label
5499 * @param obj The frame object
5501 * @return The label of this frame objet or NULL if unable to get frame
5503 * @deprecated use elm_object_text_get() instead.
5505 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 * @brief Set the content of the frame widget
5509 * Once the content object is set, a previously set one will be deleted.
5510 * If you want to keep that old content object, use the
5511 * elm_frame_content_unset() function.
5513 * @param obj The frame object
5514 * @param content The content will be filled in this frame object
5516 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5518 * @brief Get the content of the frame widget
5520 * Return the content object which is set for this widget
5522 * @param obj The frame object
5523 * @return The content that is being used
5525 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5527 * @brief Unset the content of the frame widget
5529 * Unparent and return the content object which was set for this widget
5531 * @param obj The frame object
5532 * @return The content that was being used
5534 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5540 * @defgroup Table Table
5542 * A container widget to arrange other widgets in a table where items can
5543 * also span multiple columns or rows - even overlap (and then be raised or
5544 * lowered accordingly to adjust stacking if they do overlap).
5546 * The followin are examples of how to use a table:
5547 * @li @ref tutorial_table_01
5548 * @li @ref tutorial_table_02
5553 * @brief Add a new table to the parent
5555 * @param parent The parent object
5556 * @return The new object or NULL if it cannot be created
5558 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5560 * @brief Set the homogeneous layout in the table
5562 * @param obj The layout object
5563 * @param homogeneous A boolean to set if the layout is homogeneous in the
5564 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5566 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5568 * @brief Get the current table homogeneous mode.
5570 * @param obj The table object
5571 * @return A boolean to indicating if the layout is homogeneous in the table
5572 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5574 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5576 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5578 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5580 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5582 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584 * @brief Set padding between cells.
5586 * @param obj The layout object.
5587 * @param horizontal set the horizontal padding.
5588 * @param vertical set the vertical padding.
5590 * Default value is 0.
5592 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5594 * @brief Get padding between cells.
5596 * @param obj The layout object.
5597 * @param horizontal set the horizontal padding.
5598 * @param vertical set the vertical padding.
5600 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5602 * @brief Add a subobject on the table with the coordinates passed
5604 * @param obj The table object
5605 * @param subobj The subobject to be added to the table
5606 * @param x Row number
5607 * @param y Column number
5611 * @note All positioning inside the table is relative to rows and columns, so
5612 * a value of 0 for x and y, means the top left cell of the table, and a
5613 * value of 1 for w and h means @p subobj only takes that 1 cell.
5615 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5617 * @brief Remove child from table.
5619 * @param obj The table object
5620 * @param subobj The subobject
5622 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5624 * @brief Faster way to remove all child objects from a table object.
5626 * @param obj The table object
5627 * @param clear If true, will delete children, else just remove from table.
5629 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5631 * @brief Set the packing location of an existing child of the table
5633 * @param subobj The subobject to be modified in the table
5634 * @param x Row number
5635 * @param y Column number
5639 * Modifies the position of an object already in the table.
5641 * @note All positioning inside the table is relative to rows and columns, so
5642 * a value of 0 for x and y, means the top left cell of the table, and a
5643 * value of 1 for w and h means @p subobj only takes that 1 cell.
5645 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5647 * @brief Get the packing location of an existing child of the table
5649 * @param subobj The subobject to be modified in the table
5650 * @param x Row number
5651 * @param y Column number
5655 * @see elm_table_pack_set()
5657 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5663 * @defgroup Gengrid Gengrid (Generic grid)
5665 * This widget aims to position objects in a grid layout while
5666 * actually creating and rendering only the visible ones, using the
5667 * same idea as the @ref Genlist "genlist": the user defines a @b
5668 * class for each item, specifying functions that will be called at
5669 * object creation, deletion, etc. When those items are selected by
5670 * the user, a callback function is issued. Users may interact with
5671 * a gengrid via the mouse (by clicking on items to select them and
5672 * clicking on the grid's viewport and swiping to pan the whole
5673 * view) or via the keyboard, navigating through item with the
5676 * @section Gengrid_Layouts Gengrid layouts
5678 * Gengrids may layout its items in one of two possible layouts:
5682 * When in "horizontal mode", items will be placed in @b columns,
5683 * from top to bottom and, when the space for a column is filled,
5684 * another one is started on the right, thus expanding the grid
5685 * horizontally, making for horizontal scrolling. When in "vertical
5686 * mode" , though, items will be placed in @b rows, from left to
5687 * right and, when the space for a row is filled, another one is
5688 * started below, thus expanding the grid vertically (and making
5689 * for vertical scrolling).
5691 * @section Gengrid_Items Gengrid items
5693 * An item in a gengrid can have 0 or more text labels (they can be
5694 * regular text or textblock Evas objects - that's up to the style
5695 * to determine), 0 or more icons (which are simply objects
5696 * swallowed into the gengrid item's theming Edje object) and 0 or
5697 * more <b>boolean states</b>, which have the behavior left to the
5698 * user to define. The Edje part names for each of these properties
5699 * will be looked up, in the theme file for the gengrid, under the
5700 * Edje (string) data items named @c "labels", @c "icons" and @c
5701 * "states", respectively. For each of those properties, if more
5702 * than one part is provided, they must have names listed separated
5703 * by spaces in the data fields. For the default gengrid item
5704 * theme, we have @b one label part (@c "elm.text"), @b two icon
5705 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5708 * A gengrid item may be at one of several styles. Elementary
5709 * provides one by default - "default", but this can be extended by
5710 * system or application custom themes/overlays/extensions (see
5711 * @ref Theme "themes" for more details).
5713 * @section Gengrid_Item_Class Gengrid item classes
5715 * In order to have the ability to add and delete items on the fly,
5716 * gengrid implements a class (callback) system where the
5717 * application provides a structure with information about that
5718 * type of item (gengrid may contain multiple different items with
5719 * different classes, states and styles). Gengrid will call the
5720 * functions in this struct (methods) when an item is "realized"
5721 * (i.e., created dynamically, while the user is scrolling the
5722 * grid). All objects will simply be deleted when no longer needed
5723 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5724 * contains the following members:
5725 * - @c item_style - This is a constant string and simply defines
5726 * the name of the item style. It @b must be specified and the
5727 * default should be @c "default".
5728 * - @c func.label_get - This function is called when an item
5729 * object is actually created. The @c data parameter will point to
5730 * the same data passed to elm_gengrid_item_append() and related
5731 * item creation functions. The @c obj parameter is the gengrid
5732 * object itself, while the @c part one is the name string of one
5733 * of the existing text parts in the Edje group implementing the
5734 * item's theme. This function @b must return a strdup'()ed string,
5735 * as the caller will free() it when done. See
5736 * #GridItemLabelGetFunc.
5737 * - @c func.icon_get - This function is called when an item object
5738 * is actually created. The @c data parameter will point to the
5739 * same data passed to elm_gengrid_item_append() and related item
5740 * creation functions. The @c obj parameter is the gengrid object
5741 * itself, while the @c part one is the name string of one of the
5742 * existing (icon) swallow parts in the Edje group implementing the
5743 * item's theme. It must return @c NULL, when no icon is desired,
5744 * or a valid object handle, otherwise. The object will be deleted
5745 * by the gengrid on its deletion or when the item is "unrealized".
5746 * See #GridItemIconGetFunc.
5747 * - @c func.state_get - This function is called when an item
5748 * object is actually created. The @c data parameter will point to
5749 * the same data passed to elm_gengrid_item_append() and related
5750 * item creation functions. The @c obj parameter is the gengrid
5751 * object itself, while the @c part one is the name string of one
5752 * of the state parts in the Edje group implementing the item's
5753 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5754 * true/on. Gengrids will emit a signal to its theming Edje object
5755 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5756 * "source" arguments, respectively, when the state is true (the
5757 * default is false), where @c XXX is the name of the (state) part.
5758 * See #GridItemStateGetFunc.
5759 * - @c func.del - This is called when elm_gengrid_item_del() is
5760 * called on an item or elm_gengrid_clear() is called on the
5761 * gengrid. This is intended for use when gengrid items are
5762 * deleted, so any data attached to the item (e.g. its data
5763 * parameter on creation) can be deleted. See #GridItemDelFunc.
5765 * @section Gengrid_Usage_Hints Usage hints
5767 * If the user wants to have multiple items selected at the same
5768 * time, elm_gengrid_multi_select_set() will permit it. If the
5769 * gengrid is single-selection only (the default), then
5770 * elm_gengrid_select_item_get() will return the selected item or
5771 * @c NULL, if none is selected. If the gengrid is under
5772 * multi-selection, then elm_gengrid_selected_items_get() will
5773 * return a list (that is only valid as long as no items are
5774 * modified (added, deleted, selected or unselected) of child items
5777 * If an item changes (internal (boolean) state, label or icon
5778 * changes), then use elm_gengrid_item_update() to have gengrid
5779 * update the item with the new state. A gengrid will re-"realize"
5780 * the item, thus calling the functions in the
5781 * #Elm_Gengrid_Item_Class set for that item.
5783 * To programmatically (un)select an item, use
5784 * elm_gengrid_item_selected_set(). To get its selected state use
5785 * elm_gengrid_item_selected_get(). To make an item disabled
5786 * (unable to be selected and appear differently) use
5787 * elm_gengrid_item_disabled_set() to set this and
5788 * elm_gengrid_item_disabled_get() to get the disabled state.
5790 * Grid cells will only have their selection smart callbacks called
5791 * when firstly getting selected. Any further clicks will do
5792 * nothing, unless you enable the "always select mode", with
5793 * elm_gengrid_always_select_mode_set(), thus making every click to
5794 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5795 * turn off the ability to select items entirely in the widget and
5796 * they will neither appear selected nor call the selection smart
5799 * Remember that you can create new styles and add your own theme
5800 * augmentation per application with elm_theme_extension_add(). If
5801 * you absolutely must have a specific style that overrides any
5802 * theme the user or system sets up you can use
5803 * elm_theme_overlay_add() to add such a file.
5805 * @section Gengrid_Smart_Events Gengrid smart events
5807 * Smart events that you can add callbacks for are:
5808 * - @c "activated" - The user has double-clicked or pressed
5809 * (enter|return|spacebar) on an item. The @c event_info parameter
5810 * is the gengrid item that was activated.
5811 * - @c "clicked,double" - The user has double-clicked an item.
5812 * The @c event_info parameter is the gengrid item that was double-clicked.
5813 * - @c "selected" - The user has made an item selected. The
5814 * @c event_info parameter is the gengrid item that was selected.
5815 * - @c "unselected" - The user has made an item unselected. The
5816 * @c event_info parameter is the gengrid item that was unselected.
5817 * - @c "realized" - This is called when the item in the gengrid
5818 * has its implementing Evas object instantiated, de facto. @c
5819 * event_info is the gengrid item that was created. The object
5820 * may be deleted at any time, so it is highly advised to the
5821 * caller @b not to use the object pointer returned from
5822 * elm_gengrid_item_object_get(), because it may point to freed
5824 * - @c "unrealized" - This is called when the implementing Evas
5825 * object for this item is deleted. @c event_info is the gengrid
5826 * item that was deleted.
5827 * - @c "changed" - Called when an item is added, removed, resized
5828 * or moved and when the gengrid is resized or gets "horizontal"
5830 * - @c "drag,start,up" - Called when the item in the gengrid has
5831 * been dragged (not scrolled) up.
5832 * - @c "drag,start,down" - Called when the item in the gengrid has
5833 * been dragged (not scrolled) down.
5834 * - @c "drag,start,left" - Called when the item in the gengrid has
5835 * been dragged (not scrolled) left.
5836 * - @c "drag,start,right" - Called when the item in the gengrid has
5837 * been dragged (not scrolled) right.
5838 * - @c "drag,stop" - Called when the item in the gengrid has
5839 * stopped being dragged.
5840 * - @c "drag" - Called when the item in the gengrid is being
5842 * - @c "scroll" - called when the content has been scrolled
5844 * - @c "scroll,drag,start" - called when dragging the content has
5846 * - @c "scroll,drag,stop" - called when dragging the content has
5849 * List of gendrid examples:
5850 * @li @ref gengrid_example
5854 * @addtogroup Gengrid
5858 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5859 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5860 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5861 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5862 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5863 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5864 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5867 * @struct _Elm_Gengrid_Item_Class
5869 * Gengrid item class definition. See @ref Gengrid_Item_Class for
5872 struct _Elm_Gengrid_Item_Class
5874 const char *item_style;
5875 struct _Elm_Gengrid_Item_Class_Func
5877 GridItemLabelGetFunc label_get;
5878 GridItemIconGetFunc icon_get;
5879 GridItemStateGetFunc state_get;
5880 GridItemDelFunc del;
5882 }; /**< #Elm_Gengrid_Item_Class member definitions */
5885 * Add a new gengrid widget to the given parent Elementary
5886 * (container) object
5888 * @param parent The parent object
5889 * @return a new gengrid widget handle or @c NULL, on errors
5891 * This function inserts a new gengrid widget on the canvas.
5893 * @see elm_gengrid_item_size_set()
5894 * @see elm_gengrid_horizontal_set()
5895 * @see elm_gengrid_item_append()
5896 * @see elm_gengrid_item_del()
5897 * @see elm_gengrid_clear()
5901 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5904 * Set the size for the items of a given gengrid widget
5906 * @param obj The gengrid object.
5907 * @param w The items' width.
5908 * @param h The items' height;
5910 * A gengrid, after creation, has still no information on the size
5911 * to give to each of its cells. So, you most probably will end up
5912 * with squares one @ref Fingers "finger" wide, the default
5913 * size. Use this function to force a custom size for you items,
5914 * making them as big as you wish.
5916 * @see elm_gengrid_item_size_get()
5920 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5923 * Get the size set for the items of a given gengrid widget
5925 * @param obj The gengrid object.
5926 * @param w Pointer to a variable where to store the items' width.
5927 * @param h Pointer to a variable where to store the items' height.
5929 * @note Use @c NULL pointers on the size values you're not
5930 * interested in: they'll be ignored by the function.
5932 * @see elm_gengrid_item_size_get() for more details
5936 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5939 * Set the items grid's alignment within a given gengrid widget
5941 * @param obj The gengrid object.
5942 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5943 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5945 * This sets the alignment of the whole grid of items of a gengrid
5946 * within its given viewport. By default, those values are both
5947 * 0.5, meaning that the gengrid will have its items grid placed
5948 * exactly in the middle of its viewport.
5950 * @note If given alignment values are out of the cited ranges,
5951 * they'll be changed to the nearest boundary values on the valid
5954 * @see elm_gengrid_align_get()
5958 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5961 * Get the items grid's alignment values within a given gengrid
5964 * @param obj The gengrid object.
5965 * @param align_x Pointer to a variable where to store the
5966 * horizontal alignment.
5967 * @param align_y Pointer to a variable where to store the vertical
5970 * @note Use @c NULL pointers on the alignment values you're not
5971 * interested in: they'll be ignored by the function.
5973 * @see elm_gengrid_align_set() for more details
5977 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5980 * Set whether a given gengrid widget is or not able have items
5983 * @param obj The gengrid object
5984 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5985 * @c EINA_FALSE to turn it off
5987 * If a gengrid is set to allow reordering, a click held for more
5988 * than 0.5 over a given item will highlight it specially,
5989 * signalling the gengrid has entered the reordering state. From
5990 * that time on, the user will be able to, while still holding the
5991 * mouse button down, move the item freely in the gengrid's
5992 * viewport, replacing to said item to the locations it goes to.
5993 * The replacements will be animated and, whenever the user
5994 * releases the mouse button, the item being replaced gets a new
5995 * definitive place in the grid.
5997 * @see elm_gengrid_reorder_mode_get()
6001 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6004 * Get whether a given gengrid widget is or not able have items
6007 * @param obj The gengrid object
6008 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6011 * @see elm_gengrid_reorder_mode_set() for more details
6015 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6018 * Append a new item in a given gengrid widget.
6020 * @param obj The gengrid object.
6021 * @param gic The item class for the item.
6022 * @param data The item data.
6023 * @param func Convenience function called when the item is
6025 * @param func_data Data to be passed to @p func.
6026 * @return A handle to the item added or @c NULL, on errors.
6028 * This adds an item to the beginning of the gengrid.
6030 * @see elm_gengrid_item_prepend()
6031 * @see elm_gengrid_item_insert_before()
6032 * @see elm_gengrid_item_insert_after()
6033 * @see elm_gengrid_item_del()
6037 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);
6040 * Prepend a new item in a given gengrid widget.
6042 * @param obj The gengrid object.
6043 * @param gic The item class for the item.
6044 * @param data The item data.
6045 * @param func Convenience function called when the item is
6047 * @param func_data Data to be passed to @p func.
6048 * @return A handle to the item added or @c NULL, on errors.
6050 * This adds an item to the end of the gengrid.
6052 * @see elm_gengrid_item_append()
6053 * @see elm_gengrid_item_insert_before()
6054 * @see elm_gengrid_item_insert_after()
6055 * @see elm_gengrid_item_del()
6059 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);
6062 * Insert an item before another in a gengrid widget
6064 * @param obj The gengrid object.
6065 * @param gic The item class for the item.
6066 * @param data The item data.
6067 * @param relative The item to place this new one before.
6068 * @param func Convenience function called when the item is
6070 * @param func_data Data to be passed to @p func.
6071 * @return A handle to the item added or @c NULL, on errors.
6073 * This inserts an item before another in the gengrid.
6075 * @see elm_gengrid_item_append()
6076 * @see elm_gengrid_item_prepend()
6077 * @see elm_gengrid_item_insert_after()
6078 * @see elm_gengrid_item_del()
6082 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);
6085 * Insert an item after another in a gengrid widget
6087 * @param obj The gengrid object.
6088 * @param gic The item class for the item.
6089 * @param data The item data.
6090 * @param relative The item to place this new one after.
6091 * @param func Convenience function called when the item is
6093 * @param func_data Data to be passed to @p func.
6094 * @return A handle to the item added or @c NULL, on errors.
6096 * This inserts an item after another in the gengrid.
6098 * @see elm_gengrid_item_append()
6099 * @see elm_gengrid_item_prepend()
6100 * @see elm_gengrid_item_insert_after()
6101 * @see elm_gengrid_item_del()
6105 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);
6107 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);
6109 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);
6112 * Set whether items on a given gengrid widget are to get their
6113 * selection callbacks issued for @b every subsequent selection
6114 * click on them or just for the first click.
6116 * @param obj The gengrid object
6117 * @param always_select @c EINA_TRUE to make items "always
6118 * selected", @c EINA_FALSE, otherwise
6120 * By default, grid items will only call their selection callback
6121 * function when firstly getting selected, any subsequent further
6122 * clicks will do nothing. With this call, you make those
6123 * subsequent clicks also to issue the selection callbacks.
6125 * @note <b>Double clicks</b> will @b always be reported on items.
6127 * @see elm_gengrid_always_select_mode_get()
6131 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6134 * Get whether items on a given gengrid widget have their selection
6135 * callbacks issued for @b every subsequent selection click on them
6136 * or just for the first click.
6138 * @param obj The gengrid object.
6139 * @return @c EINA_TRUE if the gengrid items are "always selected",
6140 * @c EINA_FALSE, otherwise
6142 * @see elm_gengrid_always_select_mode_set() for more details
6146 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6149 * Set whether items on a given gengrid widget can be selected or not.
6151 * @param obj The gengrid object
6152 * @param no_select @c EINA_TRUE to make items selectable,
6153 * @c EINA_FALSE otherwise
6155 * This will make items in @p obj selectable or not. In the latter
6156 * case, any user interacion on the gendrid items will neither make
6157 * them appear selected nor them call their selection callback
6160 * @see elm_gengrid_no_select_mode_get()
6164 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6167 * Get whether items on a given gengrid widget can be selected or
6170 * @param obj The gengrid object
6171 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6174 * @see elm_gengrid_no_select_mode_set() for more details
6178 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6181 * Enable or disable multi-selection in a given gengrid widget
6183 * @param obj The gengrid object.
6184 * @param multi @c EINA_TRUE, to enable multi-selection,
6185 * @c EINA_FALSE to disable it.
6187 * Multi-selection is the ability for one to have @b more than one
6188 * item selected, on a given gengrid, simultaneously. When it is
6189 * enabled, a sequence of clicks on different items will make them
6190 * all selected, progressively. A click on an already selected item
6191 * will unselect it. If interecting via the keyboard,
6192 * multi-selection is enabled while holding the "Shift" key.
6194 * @note By default, multi-selection is @b disabled on gengrids
6196 * @see elm_gengrid_multi_select_get()
6200 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6203 * Get whether multi-selection is enabled or disabled for a given
6206 * @param obj The gengrid object.
6207 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6208 * EINA_FALSE otherwise
6210 * @see elm_gengrid_multi_select_set() for more details
6214 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6217 * Enable or disable bouncing effect for a given gengrid widget
6219 * @param obj The gengrid object
6220 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6221 * @c EINA_FALSE to disable it
6222 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6223 * @c EINA_FALSE to disable it
6225 * The bouncing effect occurs whenever one reaches the gengrid's
6226 * edge's while panning it -- it will scroll past its limits a
6227 * little bit and return to the edge again, in a animated for,
6230 * @note By default, gengrids have bouncing enabled on both axis
6232 * @see elm_gengrid_bounce_get()
6236 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6239 * Get whether bouncing effects are enabled or disabled, for a
6240 * given gengrid widget, on each axis
6242 * @param obj The gengrid object
6243 * @param h_bounce Pointer to a variable where to store the
6244 * horizontal bouncing flag.
6245 * @param v_bounce Pointer to a variable where to store the
6246 * vertical bouncing flag.
6248 * @see elm_gengrid_bounce_set() for more details
6252 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6255 * Set a given gengrid widget's scrolling page size, relative to
6256 * its viewport size.
6258 * @param obj The gengrid object
6259 * @param h_pagerel The horizontal page (relative) size
6260 * @param v_pagerel The vertical page (relative) size
6262 * The gengrid's scroller is capable of binding scrolling by the
6263 * user to "pages". It means that, while scrolling and, specially
6264 * after releasing the mouse button, the grid will @b snap to the
6265 * nearest displaying page's area. When page sizes are set, the
6266 * grid's continuous content area is split into (equal) page sized
6269 * This function sets the size of a page <b>relatively to the
6270 * viewport dimensions</b> of the gengrid, for each axis. A value
6271 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6272 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6273 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6274 * 1.0. Values beyond those will make it behave behave
6275 * inconsistently. If you only want one axis to snap to pages, use
6276 * the value @c 0.0 for the other one.
6278 * There is a function setting page size values in @b absolute
6279 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6280 * is mutually exclusive to this one.
6282 * @see elm_gengrid_page_relative_get()
6286 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6289 * Get a given gengrid widget's scrolling page size, relative to
6290 * its viewport size.
6292 * @param obj The gengrid object
6293 * @param h_pagerel Pointer to a variable where to store the
6294 * horizontal page (relative) size
6295 * @param v_pagerel Pointer to a variable where to store the
6296 * vertical page (relative) size
6298 * @see elm_gengrid_page_relative_set() for more details
6302 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6305 * Set a given gengrid widget's scrolling page size
6307 * @param obj The gengrid object
6308 * @param h_pagerel The horizontal page size, in pixels
6309 * @param v_pagerel The vertical page size, in pixels
6311 * The gengrid's scroller is capable of binding scrolling by the
6312 * user to "pages". It means that, while scrolling and, specially
6313 * after releasing the mouse button, the grid will @b snap to the
6314 * nearest displaying page's area. When page sizes are set, the
6315 * grid's continuous content area is split into (equal) page sized
6318 * This function sets the size of a page of the gengrid, in pixels,
6319 * for each axis. Sane usable values are, between @c 0 and the
6320 * dimensions of @p obj, for each axis. Values beyond those will
6321 * make it behave behave inconsistently. If you only want one axis
6322 * to snap to pages, use the value @c 0 for the other one.
6324 * There is a function setting page size values in @b relative
6325 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6326 * use is mutually exclusive to this one.
6330 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6333 * Set for what direction a given gengrid widget will expand while
6334 * placing its items.
6336 * @param obj The gengrid object.
6337 * @param setting @c EINA_TRUE to make the gengrid expand
6338 * horizontally, @c EINA_FALSE to expand vertically.
6340 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6341 * in @b columns, from top to bottom and, when the space for a
6342 * column is filled, another one is started on the right, thus
6343 * expanding the grid horizontally. When in "vertical mode"
6344 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6345 * to right and, when the space for a row is filled, another one is
6346 * started below, thus expanding the grid vertically.
6348 * @see elm_gengrid_horizontal_get()
6352 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6355 * Get for what direction a given gengrid widget will expand while
6356 * placing its items.
6358 * @param obj The gengrid object.
6359 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6360 * @c EINA_FALSE if it's set to expand vertically.
6362 * @see elm_gengrid_horizontal_set() for more detais
6366 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6369 * Get the first item in a given gengrid widget
6371 * @param obj The gengrid object
6372 * @return The first item's handle or @c NULL, if there are no
6373 * items in @p obj (and on errors)
6375 * This returns the first item in the @p obj's internal list of
6378 * @see elm_gengrid_last_item_get()
6382 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6385 * Get the last item in a given gengrid widget
6387 * @param obj The gengrid object
6388 * @return The last item's handle or @c NULL, if there are no
6389 * items in @p obj (and on errors)
6391 * This returns the last item in the @p obj's internal list of
6394 * @see elm_gengrid_first_item_get()
6398 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 * Get the @b next item in a gengrid widget's internal list of items,
6402 * given a handle to one of those items.
6404 * @param item The gengrid item to fetch next from
6405 * @return The item after @p item, or @c NULL if there's none (and
6408 * This returns the item placed after the @p item, on the container
6411 * @see elm_gengrid_item_prev_get()
6415 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6418 * Get the @b previous item in a gengrid widget's internal list of items,
6419 * given a handle to one of those items.
6421 * @param item The gengrid item to fetch previous from
6422 * @return The item before @p item, or @c NULL if there's none (and
6425 * This returns the item placed before the @p item, on the container
6428 * @see elm_gengrid_item_next_get()
6432 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6435 * Get the gengrid object's handle which contains a given gengrid
6438 * @param item The item to fetch the container from
6439 * @return The gengrid (parent) object
6441 * This returns the gengrid object itself that an item belongs to.
6445 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6448 * Remove a gengrid item from the its parent, deleting it.
6450 * @param item The item to be removed.
6451 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6453 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6458 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6461 * Update the contents of a given gengrid item
6463 * @param item The gengrid item
6465 * This updates an item by calling all the item class functions
6466 * again to get the icons, labels and states. Use this when the
6467 * original item data has changed and you want thta changes to be
6472 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6473 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6474 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6477 * Return the data associated to a given gengrid item
6479 * @param item The gengrid item.
6480 * @return the data associated to this item.
6482 * This returns the @c data value passed on the
6483 * elm_gengrid_item_append() and related item addition calls.
6485 * @see elm_gengrid_item_append()
6486 * @see elm_gengrid_item_data_set()
6490 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6493 * Set the data associated to a given gengrid item
6495 * @param item The gengrid item
6496 * @param data The new data pointer to set on it
6498 * This @b overrides the @c data value passed on the
6499 * elm_gengrid_item_append() and related item addition calls. This
6500 * function @b won't call elm_gengrid_item_update() automatically,
6501 * so you'd issue it afterwards if you want to hove the item
6502 * updated to reflect the that new data.
6504 * @see elm_gengrid_item_data_get()
6508 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6511 * Get a given gengrid item's position, relative to the whole
6512 * gengrid's grid area.
6514 * @param item The Gengrid item.
6515 * @param x Pointer to variable where to store the item's <b>row
6517 * @param y Pointer to variable where to store the item's <b>column
6520 * This returns the "logical" position of the item whithin the
6521 * gengrid. For example, @c (0, 1) would stand for first row,
6526 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6529 * Set whether a given gengrid item is selected or not
6531 * @param item The gengrid item
6532 * @param selected Use @c EINA_TRUE, to make it selected, @c
6533 * EINA_FALSE to make it unselected
6535 * This sets the selected state of an item. If multi selection is
6536 * not enabled on the containing gengrid and @p selected is @c
6537 * EINA_TRUE, any other previously selected items will get
6538 * unselected in favor of this new one.
6540 * @see elm_gengrid_item_selected_get()
6544 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6547 * Get whether a given gengrid item is selected or not
6549 * @param item The gengrid item
6550 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6552 * @see elm_gengrid_item_selected_set() for more details
6556 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6559 * Get the real Evas object created to implement the view of a
6560 * given gengrid item
6562 * @param item The gengrid item.
6563 * @return the Evas object implementing this item's view.
6565 * This returns the actual Evas object used to implement the
6566 * specified gengrid item's view. This may be @c NULL, as it may
6567 * not have been created or may have been deleted, at any time, by
6568 * the gengrid. <b>Do not modify this object</b> (move, resize,
6569 * show, hide, etc.), as the gengrid is controlling it. This
6570 * function is for querying, emitting custom signals or hooking
6571 * lower level callbacks for events on that object. Do not delete
6572 * this object under any circumstances.
6574 * @see elm_gengrid_item_data_get()
6578 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6581 * Show the portion of a gengrid's internal grid containing a given
6582 * item, @b immediately.
6584 * @param item The item to display
6586 * This causes gengrid to @b redraw its viewport's contents to the
6587 * region contining the given @p item item, if it is not fully
6590 * @see elm_gengrid_item_bring_in()
6594 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6597 * Animatedly bring in, to the visible are of a gengrid, a given
6600 * @param item The gengrid item to display
6602 * This causes gengrig to jump to the given @p item item and show
6603 * it (by scrolling), if it is not fully visible. This will use
6604 * animation to do so and take a period of time to complete.
6606 * @see elm_gengrid_item_show()
6610 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6613 * Set whether a given gengrid item is disabled or not.
6615 * @param item The gengrid item
6616 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6617 * to enable it back.
6619 * A disabled item cannot be selected or unselected. It will also
6620 * change its appearance, to signal the user it's disabled.
6622 * @see elm_gengrid_item_disabled_get()
6626 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6629 * Get whether a given gengrid item is disabled or not.
6631 * @param item The gengrid item
6632 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6635 * @see elm_gengrid_item_disabled_set() for more details
6639 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6642 * Set the text to be shown in a given gengrid item's tooltips.
6644 * @param item The gengrid item
6645 * @param text The text to set in the content
6647 * This call will setup the text to be used as tooltip to that item
6648 * (analogous to elm_object_tooltip_text_set(), but being item
6649 * tooltips with higher precedence than object tooltips). It can
6650 * have only one tooltip at a time, so any previous tooltip data
6655 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6658 * Set the content to be shown in a given gengrid item's tooltips
6660 * @param item The gengrid item.
6661 * @param func The function returning the tooltip contents.
6662 * @param data What to provide to @a func as callback data/context.
6663 * @param del_cb Called when data is not needed anymore, either when
6664 * another callback replaces @p func, the tooltip is unset with
6665 * elm_gengrid_item_tooltip_unset() or the owner @p item
6666 * dies. This callback receives as its first parameter the
6667 * given @p data, being @c event_info the item handle.
6669 * This call will setup the tooltip's contents to @p item
6670 * (analogous to elm_object_tooltip_content_cb_set(), but being
6671 * item tooltips with higher precedence than object tooltips). It
6672 * can have only one tooltip at a time, so any previous tooltip
6673 * content will get removed. @p func (with @p data) will be called
6674 * every time Elementary needs to show the tooltip and it should
6675 * return a valid Evas object, which will be fully managed by the
6676 * tooltip system, getting deleted when the tooltip is gone.
6680 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);
6683 * Unset a tooltip from a given gengrid item
6685 * @param item gengrid item to remove a previously set tooltip from.
6687 * This call removes any tooltip set on @p item. The callback
6688 * provided as @c del_cb to
6689 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6690 * notify it is not used anymore (and have resources cleaned, if
6693 * @see elm_gengrid_item_tooltip_content_cb_set()
6697 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6700 * Set a different @b style for a given gengrid item's tooltip.
6702 * @param item gengrid item with tooltip set
6703 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6704 * "default", @c "transparent", etc)
6706 * Tooltips can have <b>alternate styles</b> to be displayed on,
6707 * which are defined by the theme set on Elementary. This function
6708 * works analogously as elm_object_tooltip_style_set(), but here
6709 * applied only to gengrid item objects. The default style for
6710 * tooltips is @c "default".
6712 * @note before you set a style you should define a tooltip with
6713 * elm_gengrid_item_tooltip_content_cb_set() or
6714 * elm_gengrid_item_tooltip_text_set()
6716 * @see elm_gengrid_item_tooltip_style_get()
6720 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6723 * Get the style set a given gengrid item's tooltip.
6725 * @param item gengrid item with tooltip already set on.
6726 * @return style the theme style in use, which defaults to
6727 * "default". If the object does not have a tooltip set,
6728 * then @c NULL is returned.
6730 * @see elm_gengrid_item_tooltip_style_set() for more details
6734 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6736 * @brief Disable size restrictions on an object's tooltip
6737 * @param item The tooltip's anchor object
6738 * @param disable If EINA_TRUE, size restrictions are disabled
6739 * @return EINA_FALSE on failure, EINA_TRUE on success
6741 * This function allows a tooltip to expand beyond its parant window's canvas.
6742 * It will instead be limited only by the size of the display.
6744 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6746 * @brief Retrieve size restriction state of an object's tooltip
6747 * @param item The tooltip's anchor object
6748 * @return If EINA_TRUE, size restrictions are disabled
6750 * This function returns whether a tooltip is allowed to expand beyond
6751 * its parant window's canvas.
6752 * It will instead be limited only by the size of the display.
6754 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6756 * Set the type of mouse pointer/cursor decoration to be shown,
6757 * when the mouse pointer is over the given gengrid widget item
6759 * @param item gengrid item to customize cursor on
6760 * @param cursor the cursor type's name
6762 * This function works analogously as elm_object_cursor_set(), but
6763 * here the cursor's changing area is restricted to the item's
6764 * area, and not the whole widget's. Note that that item cursors
6765 * have precedence over widget cursors, so that a mouse over @p
6766 * item will always show cursor @p type.
6768 * If this function is called twice for an object, a previously set
6769 * cursor will be unset on the second call.
6771 * @see elm_object_cursor_set()
6772 * @see elm_gengrid_item_cursor_get()
6773 * @see elm_gengrid_item_cursor_unset()
6777 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6780 * Get the type of mouse pointer/cursor decoration set to be shown,
6781 * when the mouse pointer is over the given gengrid widget item
6783 * @param item gengrid item with custom cursor set
6784 * @return the cursor type's name or @c NULL, if no custom cursors
6785 * were set to @p item (and on errors)
6787 * @see elm_object_cursor_get()
6788 * @see elm_gengrid_item_cursor_set() for more details
6789 * @see elm_gengrid_item_cursor_unset()
6793 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6796 * Unset any custom mouse pointer/cursor decoration set to be
6797 * shown, when the mouse pointer is over the given gengrid widget
6798 * item, thus making it show the @b default cursor again.
6800 * @param item a gengrid item
6802 * Use this call to undo any custom settings on this item's cursor
6803 * decoration, bringing it back to defaults (no custom style set).
6805 * @see elm_object_cursor_unset()
6806 * @see elm_gengrid_item_cursor_set() for more details
6810 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6813 * Set a different @b style for a given custom cursor set for a
6816 * @param item gengrid item with custom cursor set
6817 * @param style the <b>theme style</b> to use (e.g. @c "default",
6818 * @c "transparent", etc)
6820 * This function only makes sense when one is using custom mouse
6821 * cursor decorations <b>defined in a theme file</b> , which can
6822 * have, given a cursor name/type, <b>alternate styles</b> on
6823 * it. It works analogously as elm_object_cursor_style_set(), but
6824 * here applied only to gengrid item objects.
6826 * @warning Before you set a cursor style you should have defined a
6827 * custom cursor previously on the item, with
6828 * elm_gengrid_item_cursor_set()
6830 * @see elm_gengrid_item_cursor_engine_only_set()
6831 * @see elm_gengrid_item_cursor_style_get()
6835 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6838 * Get the current @b style set for a given gengrid item's custom
6841 * @param item gengrid item with custom cursor set.
6842 * @return style the cursor style in use. If the object does not
6843 * have a cursor set, then @c NULL is returned.
6845 * @see elm_gengrid_item_cursor_style_set() for more details
6849 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6852 * Set if the (custom) cursor for a given gengrid item should be
6853 * searched in its theme, also, or should only rely on the
6856 * @param item item with custom (custom) cursor already set on
6857 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6858 * only on those provided by the rendering engine, @c EINA_FALSE to
6859 * have them searched on the widget's theme, as well.
6861 * @note This call is of use only if you've set a custom cursor
6862 * for gengrid items, with elm_gengrid_item_cursor_set().
6864 * @note By default, cursors will only be looked for between those
6865 * provided by the rendering engine.
6869 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6872 * Get if the (custom) cursor for a given gengrid item is being
6873 * searched in its theme, also, or is only relying on the rendering
6876 * @param item a gengrid item
6877 * @return @c EINA_TRUE, if cursors are being looked for only on
6878 * those provided by the rendering engine, @c EINA_FALSE if they
6879 * are being searched on the widget's theme, as well.
6881 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6885 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6888 * Remove all items from a given gengrid widget
6890 * @param obj The gengrid object.
6892 * This removes (and deletes) all items in @p obj, leaving it
6895 * @see elm_gengrid_item_del(), to remove just one item.
6899 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6902 * Get the selected item in a given gengrid widget
6904 * @param obj The gengrid object.
6905 * @return The selected item's handleor @c NULL, if none is
6906 * selected at the moment (and on errors)
6908 * This returns the selected item in @p obj. If multi selection is
6909 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6910 * the first item in the list is selected, which might not be very
6911 * useful. For that case, see elm_gengrid_selected_items_get().
6915 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6918 * Get <b>a list</b> of selected items in a given gengrid
6920 * @param obj The gengrid object.
6921 * @return The list of selected items or @c NULL, if none is
6922 * selected at the moment (and on errors)
6924 * This returns a list of the selected items, in the order that
6925 * they appear in the grid. This list is only valid as long as no
6926 * more items are selected or unselected (or unselected implictly
6927 * by deletion). The list contains #Elm_Gengrid_Item pointers as
6930 * @see elm_gengrid_selected_item_get()
6934 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6941 * @defgroup Clock Clock
6943 * @image html img/widget/clock/preview-00.png
6944 * @image latex img/widget/clock/preview-00.eps
6946 * This is a @b digital clock widget. In its default theme, it has a
6947 * vintage "flipping numbers clock" appearance, which will animate
6948 * sheets of individual algarisms individually as time goes by.
6950 * A newly created clock will fetch system's time (already
6951 * considering local time adjustments) to start with, and will tick
6952 * accondingly. It may or may not show seconds.
6954 * Clocks have an @b edition mode. When in it, the sheets will
6955 * display extra arrow indications on the top and bottom and the
6956 * user may click on them to raise or lower the time values. After
6957 * it's told to exit edition mode, it will keep ticking with that
6958 * new time set (it keeps the difference from local time).
6960 * Also, when under edition mode, user clicks on the cited arrows
6961 * which are @b held for some time will make the clock to flip the
6962 * sheet, thus editing the time, continuosly and automatically for
6963 * the user. The interval between sheet flips will keep growing in
6964 * time, so that it helps the user to reach a time which is distant
6967 * The time display is, by default, in military mode (24h), but an
6968 * am/pm indicator may be optionally shown, too, when it will
6971 * Smart callbacks one can register to:
6972 * - "changed" - the clock's user changed the time
6974 * Here is an example on its usage:
6975 * @li @ref clock_example
6984 * Identifiers for which clock digits should be editable, when a
6985 * clock widget is in edition mode. Values may be ORed together to
6986 * make a mask, naturally.
6988 * @see elm_clock_edit_set()
6989 * @see elm_clock_digit_edit_set()
6991 typedef enum _Elm_Clock_Digedit
6993 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6994 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6995 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
6996 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6997 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
6998 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6999 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
7000 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
7001 } Elm_Clock_Digedit;
7004 * Add a new clock widget to the given parent Elementary
7005 * (container) object
7007 * @param parent The parent object
7008 * @return a new clock widget handle or @c NULL, on errors
7010 * This function inserts a new clock widget on the canvas.
7014 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7017 * Set a clock widget's time, programmatically
7019 * @param obj The clock widget object
7020 * @param hrs The hours to set
7021 * @param min The minutes to set
7022 * @param sec The secondes to set
7024 * This function updates the time that is showed by the clock
7027 * Values @b must be set within the following ranges:
7028 * - 0 - 23, for hours
7029 * - 0 - 59, for minutes
7030 * - 0 - 59, for seconds,
7032 * even if the clock is not in "military" mode.
7034 * @warning The behavior for values set out of those ranges is @b
7039 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7042 * Get a clock widget's time values
7044 * @param obj The clock object
7045 * @param[out] hrs Pointer to the variable to get the hours value
7046 * @param[out] min Pointer to the variable to get the minutes value
7047 * @param[out] sec Pointer to the variable to get the seconds value
7049 * This function gets the time set for @p obj, returning
7050 * it on the variables passed as the arguments to function
7052 * @note Use @c NULL pointers on the time values you're not
7053 * interested in: they'll be ignored by the function.
7057 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7060 * Set whether a given clock widget is under <b>edition mode</b> or
7061 * under (default) displaying-only mode.
7063 * @param obj The clock object
7064 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7065 * put it back to "displaying only" mode
7067 * This function makes a clock's time to be editable or not <b>by
7068 * user interaction</b>. When in edition mode, clocks @b stop
7069 * ticking, until one brings them back to canonical mode. The
7070 * elm_clock_digit_edit_set() function will influence which digits
7071 * of the clock will be editable. By default, all of them will be
7072 * (#ELM_CLOCK_NONE).
7074 * @note am/pm sheets, if being shown, will @b always be editable
7075 * under edition mode.
7077 * @see elm_clock_edit_get()
7081 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7084 * Retrieve whether a given clock widget is under <b>edition
7085 * mode</b> or under (default) displaying-only mode.
7087 * @param obj The clock object
7088 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7091 * This function retrieves whether the clock's time can be edited
7092 * or not by user interaction.
7094 * @see elm_clock_edit_set() for more details
7098 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7101 * Set what digits of the given clock widget should be editable
7102 * when in edition mode.
7104 * @param obj The clock object
7105 * @param digedit Bit mask indicating the digits to be editable
7106 * (values in #Elm_Clock_Digedit).
7108 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7109 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7112 * @see elm_clock_digit_edit_get()
7116 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7119 * Retrieve what digits of the given clock widget should be
7120 * editable when in edition mode.
7122 * @param obj The clock object
7123 * @return Bit mask indicating the digits to be editable
7124 * (values in #Elm_Clock_Digedit).
7126 * @see elm_clock_digit_edit_set() for more details
7130 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7133 * Set if the given clock widget must show hours in military or
7136 * @param obj The clock object
7137 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7140 * This function sets if the clock must show hours in military or
7141 * am/pm mode. In some countries like Brazil the military mode
7142 * (00-24h-format) is used, in opposition to the USA, where the
7143 * am/pm mode is more commonly used.
7145 * @see elm_clock_show_am_pm_get()
7149 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7152 * Get if the given clock widget shows hours in military or am/pm
7155 * @param obj The clock object
7156 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7159 * This function gets if the clock shows hours in military or am/pm
7162 * @see elm_clock_show_am_pm_set() for more details
7166 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7169 * Set if the given clock widget must show time with seconds or not
7171 * @param obj The clock object
7172 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7174 * This function sets if the given clock must show or not elapsed
7175 * seconds. By default, they are @b not shown.
7177 * @see elm_clock_show_seconds_get()
7181 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7184 * Get whether the given clock widget is showing time with seconds
7187 * @param obj The clock object
7188 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7190 * This function gets whether @p obj is showing or not the elapsed
7193 * @see elm_clock_show_seconds_set()
7197 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7200 * Set the interval on time updates for an user mouse button hold
7201 * on clock widgets' time edition.
7203 * @param obj The clock object
7204 * @param interval The (first) interval value in seconds
7206 * This interval value is @b decreased while the user holds the
7207 * mouse pointer either incrementing or decrementing a given the
7208 * clock digit's value.
7210 * This helps the user to get to a given time distant from the
7211 * current one easier/faster, as it will start to flip quicker and
7212 * quicker on mouse button holds.
7214 * The calculation for the next flip interval value, starting from
7215 * the one set with this call, is the previous interval divided by
7216 * 1.05, so it decreases a little bit.
7218 * The default starting interval value for automatic flips is
7221 * @see elm_clock_interval_get()
7225 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7228 * Get the interval on time updates for an user mouse button hold
7229 * on clock widgets' time edition.
7231 * @param obj The clock object
7232 * @return The (first) interval value, in seconds, set on it
7234 * @see elm_clock_interval_set() for more details
7238 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7245 * @defgroup Layout Layout
7247 * @image html img/widget/layout/preview-00.png
7248 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7250 * @image html img/layout-predefined.png
7251 * @image latex img/layout-predefined.eps width=\textwidth
7253 * This is a container widget that takes a standard Edje design file and
7254 * wraps it very thinly in a widget.
7256 * An Edje design (theme) file has a very wide range of possibilities to
7257 * describe the behavior of elements added to the Layout. Check out the Edje
7258 * documentation and the EDC reference to get more information about what can
7259 * be done with Edje.
7261 * Just like @ref List, @ref Box, and other container widgets, any
7262 * object added to the Layout will become its child, meaning that it will be
7263 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7265 * The Layout widget can contain as many Contents, Boxes or Tables as
7266 * described in its theme file. For instance, objects can be added to
7267 * different Tables by specifying the respective Table part names. The same
7268 * is valid for Content and Box.
7270 * The objects added as child of the Layout will behave as described in the
7271 * part description where they were added. There are 3 possible types of
7272 * parts where a child can be added:
7274 * @section secContent Content (SWALLOW part)
7276 * Only one object can be added to the @c SWALLOW part (but you still can
7277 * have many @c SWALLOW parts and one object on each of them). Use the @c
7278 * elm_layout_content_* set of functions to set, retrieve and unset objects
7279 * as content of the @c SWALLOW. After being set to this part, the object
7280 * size, position, visibility, clipping and other description properties
7281 * will be totally controled by the description of the given part (inside
7282 * the Edje theme file).
7284 * One can use @c evas_object_size_hint_* functions on the child to have some
7285 * kind of control over its behavior, but the resulting behavior will still
7286 * depend heavily on the @c SWALLOW part description.
7288 * The Edje theme also can change the part description, based on signals or
7289 * scripts running inside the theme. This change can also be animated. All of
7290 * this will affect the child object set as content accordingly. The object
7291 * size will be changed if the part size is changed, it will animate move if
7292 * the part is moving, and so on.
7294 * The following picture demonstrates a Layout widget with a child object
7295 * added to its @c SWALLOW:
7297 * @image html layout_swallow.png
7298 * @image latex layout_swallow.eps width=\textwidth
7300 * @section secBox Box (BOX part)
7302 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7303 * allows one to add objects to the box and have them distributed along its
7304 * area, accordingly to the specified @a layout property (now by @a layout we
7305 * mean the chosen layouting design of the Box, not the Layout widget
7308 * A similar effect for having a box with its position, size and other things
7309 * controled by the Layout theme would be to create an Elementary @ref Box
7310 * widget and add it as a Content in the @c SWALLOW part.
7312 * The main difference of using the Layout Box is that its behavior, the box
7313 * properties like layouting format, padding, align, etc. will be all
7314 * controled by the theme. This means, for example, that a signal could be
7315 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7316 * handled the signal by changing the box padding, or align, or both. Using
7317 * the Elementary @ref Box widget is not necessarily harder or easier, it
7318 * just depends on the circunstances and requirements.
7320 * The Layout Box can be used through the @c elm_layout_box_* set of
7323 * The following picture demonstrates a Layout widget with many child objects
7324 * added to its @c BOX part:
7326 * @image html layout_box.png
7327 * @image latex layout_box.eps width=\textwidth
7329 * @section secTable Table (TABLE part)
7331 * Just like the @ref secBox, the Layout Table is very similar to the
7332 * Elementary @ref Table widget. It allows one to add objects to the Table
7333 * specifying the row and column where the object should be added, and any
7334 * column or row span if necessary.
7336 * Again, we could have this design by adding a @ref Table widget to the @c
7337 * SWALLOW part using elm_layout_content_set(). The same difference happens
7338 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7339 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7341 * The Layout Table can be used through the @c elm_layout_table_* set of
7344 * The following picture demonstrates a Layout widget with many child objects
7345 * added to its @c TABLE part:
7347 * @image html layout_table.png
7348 * @image latex layout_table.eps width=\textwidth
7350 * @section secPredef Predefined Layouts
7352 * Another interesting thing about the Layout widget is that it offers some
7353 * predefined themes that come with the default Elementary theme. These
7354 * themes can be set by the call elm_layout_theme_set(), and provide some
7355 * basic functionality depending on the theme used.
7357 * Most of them already send some signals, some already provide a toolbar or
7358 * back and next buttons.
7360 * These are available predefined theme layouts. All of them have class = @c
7361 * layout, group = @c application, and style = one of the following options:
7363 * @li @c toolbar-content - application with toolbar and main content area
7364 * @li @c toolbar-content-back - application with toolbar and main content
7365 * area with a back button and title area
7366 * @li @c toolbar-content-back-next - application with toolbar and main
7367 * content area with a back and next buttons and title area
7368 * @li @c content-back - application with a main content area with a back
7369 * button and title area
7370 * @li @c content-back-next - application with a main content area with a
7371 * back and next buttons and title area
7372 * @li @c toolbar-vbox - application with toolbar and main content area as a
7374 * @li @c toolbar-table - application with toolbar and main content area as a
7377 * @section secExamples Examples
7379 * Some examples of the Layout widget can be found here:
7380 * @li @ref layout_example_01
7381 * @li @ref layout_example_02
7382 * @li @ref layout_example_03
7383 * @li @ref layout_example_edc
7388 * Add a new layout to the parent
7390 * @param parent The parent object
7391 * @return The new object or NULL if it cannot be created
7393 * @see elm_layout_file_set()
7394 * @see elm_layout_theme_set()
7398 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7400 * Set the file that will be used as layout
7402 * @param obj The layout object
7403 * @param file The path to file (edj) that will be used as layout
7404 * @param group The group that the layout belongs in edje file
7406 * @return (1 = success, 0 = error)
7410 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7412 * Set the edje group from the elementary theme that will be used as layout
7414 * @param obj The layout object
7415 * @param clas the clas of the group
7416 * @param group the group
7417 * @param style the style to used
7419 * @return (1 = success, 0 = error)
7423 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7425 * Set the layout content.
7427 * @param obj The layout object
7428 * @param swallow The swallow part name in the edje file
7429 * @param content The child that will be added in this layout object
7431 * Once the content object is set, a previously set one will be deleted.
7432 * If you want to keep that old content object, use the
7433 * elm_layout_content_unset() function.
7435 * @note In an Edje theme, the part used as a content container is called @c
7436 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7437 * expected to be a part name just like the second parameter of
7438 * elm_layout_box_append().
7440 * @see elm_layout_box_append()
7441 * @see elm_layout_content_get()
7442 * @see elm_layout_content_unset()
7447 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7449 * Get the child object in the given content part.
7451 * @param obj The layout object
7452 * @param swallow The SWALLOW part to get its content
7454 * @return The swallowed object or NULL if none or an error occurred
7456 * @see elm_layout_content_set()
7460 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7462 * Unset the layout content.
7464 * @param obj The layout object
7465 * @param swallow The swallow part name in the edje file
7466 * @return The content that was being used
7468 * Unparent and return the content object which was set for this part.
7470 * @see elm_layout_content_set()
7474 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7476 * Set the text of the given part
7478 * @param obj The layout object
7479 * @param part The TEXT part where to set the text
7480 * @param text The text to set
7483 * @deprecated use elm_object_text_* instead.
7485 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7487 * Get the text set in the given part
7489 * @param obj The layout object
7490 * @param part The TEXT part to retrieve the text off
7492 * @return The text set in @p part
7495 * @deprecated use elm_object_text_* instead.
7497 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7499 * Append child to layout box part.
7501 * @param obj the layout object
7502 * @param part the box part to which the object will be appended.
7503 * @param child the child object to append to box.
7505 * Once the object is appended, it will become child of the layout. Its
7506 * lifetime will be bound to the layout, whenever the layout dies the child
7507 * will be deleted automatically. One should use elm_layout_box_remove() to
7508 * make this layout forget about the object.
7510 * @see elm_layout_box_prepend()
7511 * @see elm_layout_box_insert_before()
7512 * @see elm_layout_box_insert_at()
7513 * @see elm_layout_box_remove()
7517 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7519 * Prepend child to layout box part.
7521 * @param obj the layout object
7522 * @param part the box part to prepend.
7523 * @param child the child object to prepend to box.
7525 * Once the object is prepended, it will become child of the layout. Its
7526 * lifetime will be bound to the layout, whenever the layout dies the child
7527 * will be deleted automatically. One should use elm_layout_box_remove() to
7528 * make this layout forget about the object.
7530 * @see elm_layout_box_append()
7531 * @see elm_layout_box_insert_before()
7532 * @see elm_layout_box_insert_at()
7533 * @see elm_layout_box_remove()
7537 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7539 * Insert child to layout box part before a reference object.
7541 * @param obj the layout object
7542 * @param part the box part to insert.
7543 * @param child the child object to insert into box.
7544 * @param reference another reference object to insert before in box.
7546 * Once the object is inserted, it will become child of the layout. Its
7547 * lifetime will be bound to the layout, whenever the layout dies the child
7548 * will be deleted automatically. One should use elm_layout_box_remove() to
7549 * make this layout forget about the object.
7551 * @see elm_layout_box_append()
7552 * @see elm_layout_box_prepend()
7553 * @see elm_layout_box_insert_before()
7554 * @see elm_layout_box_remove()
7558 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7560 * Insert child to layout box part at a given position.
7562 * @param obj the layout object
7563 * @param part the box part to insert.
7564 * @param child the child object to insert into box.
7565 * @param pos the numeric position >=0 to insert the child.
7567 * Once the object is inserted, it will become child of the layout. Its
7568 * lifetime will be bound to the layout, whenever the layout dies the child
7569 * will be deleted automatically. One should use elm_layout_box_remove() to
7570 * make this layout forget about the object.
7572 * @see elm_layout_box_append()
7573 * @see elm_layout_box_prepend()
7574 * @see elm_layout_box_insert_before()
7575 * @see elm_layout_box_remove()
7579 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7581 * Remove a child of the given part box.
7583 * @param obj The layout object
7584 * @param part The box part name to remove child.
7585 * @param child The object to remove from box.
7586 * @return The object that was being used, or NULL if not found.
7588 * The object will be removed from the box part and its lifetime will
7589 * not be handled by the layout anymore. This is equivalent to
7590 * elm_layout_content_unset() for box.
7592 * @see elm_layout_box_append()
7593 * @see elm_layout_box_remove_all()
7597 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7599 * Remove all child of the given part box.
7601 * @param obj The layout object
7602 * @param part The box part name to remove child.
7603 * @param clear If EINA_TRUE, then all objects will be deleted as
7604 * well, otherwise they will just be removed and will be
7605 * dangling on the canvas.
7607 * The objects will be removed from the box part and their lifetime will
7608 * not be handled by the layout anymore. This is equivalent to
7609 * elm_layout_box_remove() for all box children.
7611 * @see elm_layout_box_append()
7612 * @see elm_layout_box_remove()
7616 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7618 * Insert child to layout table part.
7620 * @param obj the layout object
7621 * @param part the box part to pack child.
7622 * @param child_obj the child object to pack into table.
7623 * @param col the column to which the child should be added. (>= 0)
7624 * @param row the row to which the child should be added. (>= 0)
7625 * @param colspan how many columns should be used to store this object. (>=
7627 * @param rowspan how many rows should be used to store this object. (>= 1)
7629 * Once the object is inserted, it will become child of the table. Its
7630 * lifetime will be bound to the layout, and whenever the layout dies the
7631 * child will be deleted automatically. One should use
7632 * elm_layout_table_remove() to make this layout forget about the object.
7634 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7635 * more space than a single cell. For instance, the following code:
7637 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7640 * Would result in an object being added like the following picture:
7642 * @image html layout_colspan.png
7643 * @image latex layout_colspan.eps width=\textwidth
7645 * @see elm_layout_table_unpack()
7646 * @see elm_layout_table_clear()
7650 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);
7652 * Unpack (remove) a child of the given part table.
7654 * @param obj The layout object
7655 * @param part The table part name to remove child.
7656 * @param child_obj The object to remove from table.
7657 * @return The object that was being used, or NULL if not found.
7659 * The object will be unpacked from the table part and its lifetime
7660 * will not be handled by the layout anymore. This is equivalent to
7661 * elm_layout_content_unset() for table.
7663 * @see elm_layout_table_pack()
7664 * @see elm_layout_table_clear()
7668 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7670 * Remove all child of the given part table.
7672 * @param obj The layout object
7673 * @param part The table part name to remove child.
7674 * @param clear If EINA_TRUE, then all objects will be deleted as
7675 * well, otherwise they will just be removed and will be
7676 * dangling on the canvas.
7678 * The objects will be removed from the table part and their lifetime will
7679 * not be handled by the layout anymore. This is equivalent to
7680 * elm_layout_table_unpack() for all table children.
7682 * @see elm_layout_table_pack()
7683 * @see elm_layout_table_unpack()
7687 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7689 * Get the edje layout
7691 * @param obj The layout object
7693 * @return A Evas_Object with the edje layout settings loaded
7694 * with function elm_layout_file_set
7696 * This returns the edje object. It is not expected to be used to then
7697 * swallow objects via edje_object_part_swallow() for example. Use
7698 * elm_layout_content_set() instead so child object handling and sizing is
7701 * @note This function should only be used if you really need to call some
7702 * low level Edje function on this edje object. All the common stuff (setting
7703 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7704 * with proper elementary functions.
7706 * @see elm_object_signal_callback_add()
7707 * @see elm_object_signal_emit()
7708 * @see elm_object_text_part_set()
7709 * @see elm_layout_content_set()
7710 * @see elm_layout_box_append()
7711 * @see elm_layout_table_pack()
7712 * @see elm_layout_data_get()
7716 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7718 * Get the edje data from the given layout
7720 * @param obj The layout object
7721 * @param key The data key
7723 * @return The edje data string
7725 * This function fetches data specified inside the edje theme of this layout.
7726 * This function return NULL if data is not found.
7728 * In EDC this comes from a data block within the group block that @p
7729 * obj was loaded from. E.g.
7736 * item: "key1" "value1";
7737 * item: "key2" "value2";
7745 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7749 * @param obj The layout object
7751 * Manually forces a sizing re-evaluation. This is useful when the minimum
7752 * size required by the edje theme of this layout has changed. The change on
7753 * the minimum size required by the edje theme is not immediately reported to
7754 * the elementary layout, so one needs to call this function in order to tell
7755 * the widget (layout) that it needs to reevaluate its own size.
7757 * The minimum size of the theme is calculated based on minimum size of
7758 * parts, the size of elements inside containers like box and table, etc. All
7759 * of this can change due to state changes, and that's when this function
7762 * Also note that a standard signal of "size,eval" "elm" emitted from the
7763 * edje object will cause this to happen too.
7767 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7768 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7769 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7770 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7771 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7772 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7773 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);
7774 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7776 * @def elm_layout_icon_set
7777 * Convienience macro to set the icon object in a layout that follows the
7778 * Elementary naming convention for its parts.
7782 #define elm_layout_icon_set(_ly, _obj) \
7785 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7786 if ((_obj)) sig = "elm,state,icon,visible"; \
7787 else sig = "elm,state,icon,hidden"; \
7788 elm_object_signal_emit((_ly), sig, "elm"); \
7792 * @def elm_layout_icon_get
7793 * Convienience macro to get the icon object from a layout that follows the
7794 * Elementary naming convention for its parts.
7798 #define elm_layout_icon_get(_ly) \
7799 elm_layout_content_get((_ly), "elm.swallow.icon")
7802 * @def elm_layout_end_set
7803 * Convienience macro to set the end object in a layout that follows the
7804 * Elementary naming convention for its parts.
7808 #define elm_layout_end_set(_ly, _obj) \
7811 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7812 if ((_obj)) sig = "elm,state,end,visible"; \
7813 else sig = "elm,state,end,hidden"; \
7814 elm_object_signal_emit((_ly), sig, "elm"); \
7818 * @def elm_layout_end_get
7819 * Convienience macro to get the end object in a layout that follows the
7820 * Elementary naming convention for its parts.
7824 #define elm_layout_end_get(_ly) \
7825 elm_layout_content_get((_ly), "elm.swallow.end")
7828 * @def elm_layout_label_set
7829 * Convienience macro to set the label in a layout that follows the
7830 * Elementary naming convention for its parts.
7833 * @deprecated use elm_object_text_* instead.
7835 #define elm_layout_label_set(_ly, _txt) \
7836 elm_layout_text_set((_ly), "elm.text", (_txt))
7839 * @def elm_layout_label_get
7840 * Convienience macro to get the label in a layout that follows the
7841 * Elementary naming convention for its parts.
7844 * @deprecated use elm_object_text_* instead.
7846 #define elm_layout_label_get(_ly) \
7847 elm_layout_text_get((_ly), "elm.text")
7849 /* smart callbacks called:
7850 * "theme,changed" - when elm theme is changed.
7854 * @defgroup Notify Notify
7856 * @image html img/widget/notify/preview-00.png
7857 * @image latex img/widget/notify/preview-00.eps
7859 * Display a container in a particular region of the parent(top, bottom,
7860 * etc. A timeout can be set to automatically hide the notify. This is so
7861 * that, after an evas_object_show() on a notify object, if a timeout was set
7862 * on it, it will @b automatically get hidden after that time.
7864 * Signals that you can add callbacks for are:
7865 * @li "timeout" - when timeout happens on notify and it's hidden
7866 * @li "block,clicked" - when a click outside of the notify happens
7868 * @ref tutorial_notify show usage of the API.
7873 * @brief Possible orient values for notify.
7875 * This values should be used in conjunction to elm_notify_orient_set() to
7876 * set the position in which the notify should appear(relative to its parent)
7877 * and in conjunction with elm_notify_orient_get() to know where the notify
7880 typedef enum _Elm_Notify_Orient
7882 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7883 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7884 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7885 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7886 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7887 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7888 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7889 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7890 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7891 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7892 } Elm_Notify_Orient;
7894 * @brief Add a new notify to the parent
7896 * @param parent The parent object
7897 * @return The new object or NULL if it cannot be created
7899 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7901 * @brief Set the content of the notify widget
7903 * @param obj The notify object
7904 * @param content The content will be filled in this notify object
7906 * Once the content object is set, a previously set one will be deleted. If
7907 * you want to keep that old content object, use the
7908 * elm_notify_content_unset() function.
7910 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7912 * @brief Unset the content of the notify widget
7914 * @param obj The notify object
7915 * @return The content that was being used
7917 * Unparent and return the content object which was set for this widget
7919 * @see elm_notify_content_set()
7921 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7923 * @brief Return the content of the notify widget
7925 * @param obj The notify object
7926 * @return The content that is being used
7928 * @see elm_notify_content_set()
7930 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7932 * @brief Set the notify parent
7934 * @param obj The notify object
7935 * @param content The new parent
7937 * Once the parent object is set, a previously set one will be disconnected
7940 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7942 * @brief Get the notify parent
7944 * @param obj The notify object
7945 * @return The parent
7947 * @see elm_notify_parent_set()
7949 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7951 * @brief Set the orientation
7953 * @param obj The notify object
7954 * @param orient The new orientation
7956 * Sets the position in which the notify will appear in its parent.
7958 * @see @ref Elm_Notify_Orient for possible values.
7960 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7962 * @brief Return the orientation
7963 * @param obj The notify object
7964 * @return The orientation of the notification
7966 * @see elm_notify_orient_set()
7967 * @see Elm_Notify_Orient
7969 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7971 * @brief Set the time interval after which the notify window is going to be
7974 * @param obj The notify object
7975 * @param time The timeout in seconds
7977 * This function sets a timeout and starts the timer controlling when the
7978 * notify is hidden. Since calling evas_object_show() on a notify restarts
7979 * the timer controlling when the notify is hidden, setting this before the
7980 * notify is shown will in effect mean starting the timer when the notify is
7983 * @note Set a value <= 0.0 to disable a running timer.
7985 * @note If the value > 0.0 and the notify is previously visible, the
7986 * timer will be started with this value, canceling any running timer.
7988 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7990 * @brief Return the timeout value (in seconds)
7991 * @param obj the notify object
7993 * @see elm_notify_timeout_set()
7995 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7997 * @brief Sets whether events should be passed to by a click outside
8000 * @param obj The notify object
8001 * @param repeats EINA_TRUE Events are repeats, else no
8003 * When true if the user clicks outside the window the events will be caught
8004 * by the others widgets, else the events are blocked.
8006 * @note The default value is EINA_TRUE.
8008 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8010 * @brief Return true if events are repeat below the notify object
8011 * @param obj the notify object
8013 * @see elm_notify_repeat_events_set()
8015 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8021 * @defgroup Hover Hover
8023 * @image html img/widget/hover/preview-00.png
8024 * @image latex img/widget/hover/preview-00.eps
8026 * A Hover object will hover over its @p parent object at the @p target
8027 * location. Anything in the background will be given a darker coloring to
8028 * indicate that the hover object is on top (at the default theme). When the
8029 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8030 * clicked that @b doesn't cause the hover to be dismissed.
8032 * @note The hover object will take up the entire space of @p target
8035 * Elementary has the following styles for the hover widget:
8039 * @li hoversel_vertical
8041 * The following are the available position for content:
8053 * Signals that you can add callbacks for are:
8054 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8055 * @li "smart,changed" - a content object placed under the "smart"
8056 * policy was replaced to a new slot direction.
8058 * See @ref tutorial_hover for more information.
8062 typedef enum _Elm_Hover_Axis
8064 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8065 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8066 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8067 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8070 * @brief Adds a hover object to @p parent
8072 * @param parent The parent object
8073 * @return The hover object or NULL if one could not be created
8075 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8077 * @brief Sets the target object for the hover.
8079 * @param obj The hover object
8080 * @param target The object to center the hover onto. The hover
8082 * This function will cause the hover to be centered on the target object.
8084 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8086 * @brief Gets the target object for the hover.
8088 * @param obj The hover object
8089 * @param parent The object to locate the hover over.
8091 * @see elm_hover_target_set()
8093 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8095 * @brief Sets the parent object for the hover.
8097 * @param obj The hover object
8098 * @param parent The object to locate the hover over.
8100 * This function will cause the hover to take up the entire space that the
8101 * parent object fills.
8103 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8105 * @brief Gets the parent object for the hover.
8107 * @param obj The hover object
8108 * @return The parent object to locate the hover over.
8110 * @see elm_hover_parent_set()
8112 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8114 * @brief Sets the content of the hover object and the direction in which it
8117 * @param obj The hover object
8118 * @param swallow The direction that the object will be displayed
8119 * at. Accepted values are "left", "top-left", "top", "top-right",
8120 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8122 * @param content The content to place at @p swallow
8124 * Once the content object is set for a given direction, a previously
8125 * set one (on the same direction) will be deleted. If you want to
8126 * keep that old content object, use the elm_hover_content_unset()
8129 * All directions may have contents at the same time, except for
8130 * "smart". This is a special placement hint and its use case
8131 * independs of the calculations coming from
8132 * elm_hover_best_content_location_get(). Its use is for cases when
8133 * one desires only one hover content, but with a dinamic special
8134 * placement within the hover area. The content's geometry, whenever
8135 * it changes, will be used to decide on a best location not
8136 * extrapolating the hover's parent object view to show it in (still
8137 * being the hover's target determinant of its medium part -- move and
8138 * resize it to simulate finger sizes, for example). If one of the
8139 * directions other than "smart" are used, a previously content set
8140 * using it will be deleted, and vice-versa.
8142 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8144 * @brief Get the content of the hover object, in a given direction.
8146 * Return the content object which was set for this widget in the
8147 * @p swallow direction.
8149 * @param obj The hover object
8150 * @param swallow The direction that the object was display at.
8151 * @return The content that was being used
8153 * @see elm_hover_content_set()
8155 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8157 * @brief Unset the content of the hover object, in a given direction.
8159 * Unparent and return the content object set at @p swallow direction.
8161 * @param obj The hover object
8162 * @param swallow The direction that the object was display at.
8163 * @return The content that was being used.
8165 * @see elm_hover_content_set()
8167 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8169 * @brief Returns the best swallow location for content in the hover.
8171 * @param obj The hover object
8172 * @param pref_axis The preferred orientation axis for the hover object to use
8173 * @return The edje location to place content into the hover or @c
8176 * Best is defined here as the location at which there is the most available
8179 * @p pref_axis may be one of
8180 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8181 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8182 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8183 * - @c ELM_HOVER_AXIS_BOTH -- both
8185 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8186 * nescessarily be along the horizontal axis("left" or "right"). If
8187 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8188 * be along the vertical axis("top" or "bottom"). Chossing
8189 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8190 * returned position may be in either axis.
8192 * @see elm_hover_content_set()
8194 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8201 * @defgroup Entry Entry
8203 * @image html img/widget/entry/preview-00.png
8204 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8205 * @image html img/widget/entry/preview-01.png
8206 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8207 * @image html img/widget/entry/preview-02.png
8208 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8209 * @image html img/widget/entry/preview-03.png
8210 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8212 * An entry is a convenience widget which shows a box that the user can
8213 * enter text into. Entries by default don't scroll, so they grow to
8214 * accomodate the entire text, resizing the parent window as needed. This
8215 * can be changed with the elm_entry_scrollable_set() function.
8217 * They can also be single line or multi line (the default) and when set
8218 * to multi line mode they support text wrapping in any of the modes
8219 * indicated by #Elm_Wrap_Type.
8221 * Other features include password mode, filtering of inserted text with
8222 * elm_entry_text_filter_append() and related functions, inline "items" and
8223 * formatted markup text.
8225 * @section entry-markup Formatted text
8227 * The markup tags supported by the Entry are defined by the theme, but
8228 * even when writing new themes or extensions it's a good idea to stick to
8229 * a sane default, to maintain coherency and avoid application breakages.
8230 * Currently defined by the default theme are the following tags:
8231 * @li \<br\>: Inserts a line break.
8232 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8234 * @li \<tab\>: Inserts a tab.
8235 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8237 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8238 * @li \<link\>...\</link\>: Underlines the enclosed text.
8239 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8241 * @section entry-special Special markups
8243 * Besides those used to format text, entries support two special markup
8244 * tags used to insert clickable portions of text or items inlined within
8247 * @subsection entry-anchors Anchors
8249 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8250 * \</a\> tags and an event will be generated when this text is clicked,
8254 * This text is outside <a href=anc-01>but this one is an anchor</a>
8257 * The @c href attribute in the opening tag gives the name that will be
8258 * used to identify the anchor and it can be any valid utf8 string.
8260 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8261 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8262 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8263 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8266 * @subsection entry-items Items
8268 * Inlined in the text, any other @c Evas_Object can be inserted by using
8269 * \<item\> tags this way:
8272 * <item size=16x16 vsize=full href=emoticon/haha></item>
8275 * Just like with anchors, the @c href identifies each item, but these need,
8276 * in addition, to indicate their size, which is done using any one of
8277 * @c size, @c absize or @c relsize attributes. These attributes take their
8278 * value in the WxH format, where W is the width and H the height of the
8281 * @li absize: Absolute pixel size for the item. Whatever value is set will
8282 * be the item's size regardless of any scale value the object may have
8283 * been set to. The final line height will be adjusted to fit larger items.
8284 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8286 * @li relsize: Size is adjusted for the item to fit within the current
8289 * Besides their size, items are specificed a @c vsize value that affects
8290 * how their final size and position are calculated. The possible values
8292 * @li ascent: Item will be placed within the line's baseline and its
8293 * ascent. That is, the height between the line where all characters are
8294 * positioned and the highest point in the line. For @c size and @c absize
8295 * items, the descent value will be added to the total line height to make
8296 * them fit. @c relsize items will be adjusted to fit within this space.
8297 * @li full: Items will be placed between the descent and ascent, or the
8298 * lowest point in the line and its highest.
8300 * The next image shows different configurations of items and how they
8301 * are the previously mentioned options affect their sizes. In all cases,
8302 * the green line indicates the ascent, blue for the baseline and red for
8305 * @image html entry_item.png
8306 * @image latex entry_item.eps width=\textwidth
8308 * And another one to show how size differs from absize. In the first one,
8309 * the scale value is set to 1.0, while the second one is using one of 2.0.
8311 * @image html entry_item_scale.png
8312 * @image latex entry_item_scale.eps width=\textwidth
8314 * After the size for an item is calculated, the entry will request an
8315 * object to place in its space. For this, the functions set with
8316 * elm_entry_item_provider_append() and related functions will be called
8317 * in order until one of them returns a @c non-NULL value. If no providers
8318 * are available, or all of them return @c NULL, then the entry falls back
8319 * to one of the internal defaults, provided the name matches with one of
8322 * All of the following are currently supported:
8325 * - emoticon/angry-shout
8326 * - emoticon/crazy-laugh
8327 * - emoticon/evil-laugh
8329 * - emoticon/goggle-smile
8331 * - emoticon/grumpy-smile
8333 * - emoticon/guilty-smile
8335 * - emoticon/half-smile
8336 * - emoticon/happy-panting
8338 * - emoticon/indifferent
8340 * - emoticon/knowing-grin
8342 * - emoticon/little-bit-sorry
8343 * - emoticon/love-lots
8345 * - emoticon/minimal-smile
8346 * - emoticon/not-happy
8347 * - emoticon/not-impressed
8349 * - emoticon/opensmile
8352 * - emoticon/squint-laugh
8353 * - emoticon/surprised
8354 * - emoticon/suspicious
8355 * - emoticon/tongue-dangling
8356 * - emoticon/tongue-poke
8358 * - emoticon/unhappy
8359 * - emoticon/very-sorry
8362 * - emoticon/worried
8365 * Alternatively, an item may reference an image by its path, using
8366 * the URI form @c file:///path/to/an/image.png and the entry will then
8367 * use that image for the item.
8369 * @section entry-files Loading and saving files
8371 * Entries have convinience functions to load text from a file and save
8372 * changes back to it after a short delay. The automatic saving is enabled
8373 * by default, but can be disabled with elm_entry_autosave_set() and files
8374 * can be loaded directly as plain text or have any markup in them
8375 * recognized. See elm_entry_file_set() for more details.
8377 * @section entry-signals Emitted signals
8379 * This widget emits the following signals:
8381 * @li "changed": The text within the entry was changed.
8382 * @li "changed,user": The text within the entry was changed because of user interaction.
8383 * @li "activated": The enter key was pressed on a single line entry.
8384 * @li "press": A mouse button has been pressed on the entry.
8385 * @li "longpressed": A mouse button has been pressed and held for a couple
8387 * @li "clicked": The entry has been clicked (mouse press and release).
8388 * @li "clicked,double": The entry has been double clicked.
8389 * @li "clicked,triple": The entry has been triple clicked.
8390 * @li "focused": The entry has received focus.
8391 * @li "unfocused": The entry has lost focus.
8392 * @li "selection,paste": A paste of the clipboard contents was requested.
8393 * @li "selection,copy": A copy of the selected text into the clipboard was
8395 * @li "selection,cut": A cut of the selected text into the clipboard was
8397 * @li "selection,start": A selection has begun and no previous selection
8399 * @li "selection,changed": The current selection has changed.
8400 * @li "selection,cleared": The current selection has been cleared.
8401 * @li "cursor,changed": The cursor has changed position.
8402 * @li "anchor,clicked": An anchor has been clicked. The event_info
8403 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8404 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8405 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8406 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8407 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8408 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8409 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8410 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8411 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8412 * @li "preedit,changed": The preedit string has changed.
8414 * @section entry-examples
8416 * An overview of the Entry API can be seen in @ref entry_example_01
8421 * @typedef Elm_Entry_Anchor_Info
8423 * The info sent in the callback for the "anchor,clicked" signals emitted
8426 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8428 * @struct _Elm_Entry_Anchor_Info
8430 * The info sent in the callback for the "anchor,clicked" signals emitted
8433 struct _Elm_Entry_Anchor_Info
8435 const char *name; /**< The name of the anchor, as stated in its href */
8436 int button; /**< The mouse button used to click on it */
8437 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8438 y, /**< Anchor geometry, relative to canvas */
8439 w, /**< Anchor geometry, relative to canvas */
8440 h; /**< Anchor geometry, relative to canvas */
8443 * @typedef Elm_Entry_Filter_Cb
8444 * This callback type is used by entry filters to modify text.
8445 * @param data The data specified as the last param when adding the filter
8446 * @param entry The entry object
8447 * @param text A pointer to the location of the text being filtered. This data can be modified,
8448 * but any additional allocations must be managed by the user.
8449 * @see elm_entry_text_filter_append
8450 * @see elm_entry_text_filter_prepend
8452 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8455 * This adds an entry to @p parent object.
8457 * By default, entries are:
8461 * @li autosave is enabled
8463 * @param parent The parent object
8464 * @return The new object or NULL if it cannot be created
8466 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8468 * Sets the entry to single line mode.
8470 * In single line mode, entries don't ever wrap when the text reaches the
8471 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8472 * key will generate an @c "activate" event instead of adding a new line.
8474 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8475 * and pressing enter will break the text into a different line
8476 * without generating any events.
8478 * @param obj The entry object
8479 * @param single_line If true, the text in the entry
8480 * will be on a single line.
8482 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8484 * Gets whether the entry is set to be single line.
8486 * @param obj The entry object
8487 * @return single_line If true, the text in the entry is set to display
8490 * @see elm_entry_single_line_set()
8492 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8494 * Sets the entry to password mode.
8496 * In password mode, entries are implicitly single line and the display of
8497 * any text in them is replaced with asterisks (*).
8499 * @param obj The entry object
8500 * @param password If true, password mode is enabled.
8502 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8504 * Gets whether the entry is set to password mode.
8506 * @param obj The entry object
8507 * @return If true, the entry is set to display all characters
8510 * @see elm_entry_password_set()
8512 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8514 * This sets the text displayed within the entry to @p entry.
8516 * @param obj The entry object
8517 * @param entry The text to be displayed
8519 * @deprecated Use elm_object_text_set() instead.
8521 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8523 * This returns the text currently shown in object @p entry.
8524 * See also elm_entry_entry_set().
8526 * @param obj The entry object
8527 * @return The currently displayed text or NULL on failure
8529 * @deprecated Use elm_object_text_get() instead.
8531 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8533 * Appends @p entry to the text of the entry.
8535 * Adds the text in @p entry to the end of any text already present in the
8538 * The appended text is subject to any filters set for the widget.
8540 * @param obj The entry object
8541 * @param entry The text to be displayed
8543 * @see elm_entry_text_filter_append()
8545 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8547 * Gets whether the entry is empty.
8549 * Empty means no text at all. If there are any markup tags, like an item
8550 * tag for which no provider finds anything, and no text is displayed, this
8551 * function still returns EINA_FALSE.
8553 * @param obj The entry object
8554 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8556 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8558 * Gets any selected text within the entry.
8560 * If there's any selected text in the entry, this function returns it as
8561 * a string in markup format. NULL is returned if no selection exists or
8562 * if an error occurred.
8564 * The returned value points to an internal string and should not be freed
8565 * or modified in any way. If the @p entry object is deleted or its
8566 * contents are changed, the returned pointer should be considered invalid.
8568 * @param obj The entry object
8569 * @return The selected text within the entry or NULL on failure
8571 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8573 * Inserts the given text into the entry at the current cursor position.
8575 * This inserts text at the cursor position as if it was typed
8576 * by the user (note that this also allows markup which a user
8577 * can't just "type" as it would be converted to escaped text, so this
8578 * call can be used to insert things like emoticon items or bold push/pop
8579 * tags, other font and color change tags etc.)
8581 * If any selection exists, it will be replaced by the inserted text.
8583 * The inserted text is subject to any filters set for the widget.
8585 * @param obj The entry object
8586 * @param entry The text to insert
8588 * @see elm_entry_text_filter_append()
8590 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8592 * Set the line wrap type to use on multi-line entries.
8594 * Sets the wrap type used by the entry to any of the specified in
8595 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8596 * line (without inserting a line break or paragraph separator) when it
8597 * reaches the far edge of the widget.
8599 * Note that this only makes sense for multi-line entries. A widget set
8600 * to be single line will never wrap.
8602 * @param obj The entry object
8603 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8605 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8607 * Gets the wrap mode the entry was set to use.
8609 * @param obj The entry object
8612 * @see also elm_entry_line_wrap_set()
8614 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8616 * Sets if the entry is to be editable or not.
8618 * By default, entries are editable and when focused, any text input by the
8619 * user will be inserted at the current cursor position. But calling this
8620 * function with @p editable as EINA_FALSE will prevent the user from
8621 * inputting text into the entry.
8623 * The only way to change the text of a non-editable entry is to use
8624 * elm_object_text_set(), elm_entry_entry_insert() and other related
8627 * @param obj The entry object
8628 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8629 * if not, the entry is read-only and no user input is allowed.
8631 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8633 * Gets whether the entry is editable or not.
8635 * @param obj The entry object
8636 * @return If true, the entry is editable by the user.
8637 * If false, it is not editable by the user
8639 * @see elm_entry_editable_set()
8641 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8643 * This drops any existing text selection within the entry.
8645 * @param obj The entry object
8647 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8649 * This selects all text within the entry.
8651 * @param obj The entry object
8653 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8655 * This moves the cursor one place to the right within the entry.
8657 * @param obj The entry object
8658 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8660 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8662 * This moves the cursor one place to the left within the entry.
8664 * @param obj The entry object
8665 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8667 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8669 * This moves the cursor one line up within the entry.
8671 * @param obj The entry object
8672 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8674 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8676 * This moves the cursor one line down within the entry.
8678 * @param obj The entry object
8679 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8681 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8683 * This moves the cursor to the beginning of the entry.
8685 * @param obj The entry object
8687 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8689 * This moves the cursor to the end of the entry.
8691 * @param obj The entry object
8693 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8695 * This moves the cursor to the beginning of the current line.
8697 * @param obj The entry object
8699 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8701 * This moves the cursor to the end of the current line.
8703 * @param obj The entry object
8705 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8707 * This begins a selection within the entry as though
8708 * the user were holding down the mouse button to make a selection.
8710 * @param obj The entry object
8712 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8714 * This ends a selection within the entry as though
8715 * the user had just released the mouse button while making a selection.
8717 * @param obj The entry object
8719 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8721 * Gets whether a format node exists at the current cursor position.
8723 * A format node is anything that defines how the text is rendered. It can
8724 * be a visible format node, such as a line break or a paragraph separator,
8725 * or an invisible one, such as bold begin or end tag.
8726 * This function returns whether any format node exists at the current
8729 * @param obj The entry object
8730 * @return EINA_TRUE if the current cursor position contains a format node,
8731 * EINA_FALSE otherwise.
8733 * @see elm_entry_cursor_is_visible_format_get()
8735 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8737 * Gets if the current cursor position holds a visible format node.
8739 * @param obj The entry object
8740 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8741 * if it's an invisible one or no format exists.
8743 * @see elm_entry_cursor_is_format_get()
8745 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8747 * Gets the character pointed by the cursor at its current position.
8749 * This function returns a string with the utf8 character stored at the
8750 * current cursor position.
8751 * Only the text is returned, any format that may exist will not be part
8752 * of the return value.
8754 * @param obj The entry object
8755 * @return The text pointed by the cursors.
8757 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8759 * This function returns the geometry of the cursor.
8761 * It's useful if you want to draw something on the cursor (or where it is),
8762 * or for example in the case of scrolled entry where you want to show the
8765 * @param obj The entry object
8766 * @param x returned geometry
8767 * @param y returned geometry
8768 * @param w returned geometry
8769 * @param h returned geometry
8770 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8772 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);
8774 * Sets the cursor position in the entry to the given value
8776 * The value in @p pos is the index of the character position within the
8777 * contents of the string as returned by elm_entry_cursor_pos_get().
8779 * @param obj The entry object
8780 * @param pos The position of the cursor
8782 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8784 * Retrieves the current position of the cursor in the entry
8786 * @param obj The entry object
8787 * @return The cursor position
8789 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8791 * This executes a "cut" action on the selected text in the entry.
8793 * @param obj The entry object
8795 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8797 * This executes a "copy" action on the selected text in the entry.
8799 * @param obj The entry object
8801 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8803 * This executes a "paste" action in the entry.
8805 * @param obj The entry object
8807 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8809 * This clears and frees the items in a entry's contextual (longpress)
8812 * @param obj The entry object
8814 * @see elm_entry_context_menu_item_add()
8816 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8818 * This adds an item to the entry's contextual menu.
8820 * A longpress on an entry will make the contextual menu show up, if this
8821 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8822 * By default, this menu provides a few options like enabling selection mode,
8823 * which is useful on embedded devices that need to be explicit about it,
8824 * and when a selection exists it also shows the copy and cut actions.
8826 * With this function, developers can add other options to this menu to
8827 * perform any action they deem necessary.
8829 * @param obj The entry object
8830 * @param label The item's text label
8831 * @param icon_file The item's icon file
8832 * @param icon_type The item's icon type
8833 * @param func The callback to execute when the item is clicked
8834 * @param data The data to associate with the item for related functions
8836 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);
8838 * This disables the entry's contextual (longpress) menu.
8840 * @param obj The entry object
8841 * @param disabled If true, the menu is disabled
8843 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8845 * This returns whether the entry's contextual (longpress) menu is
8848 * @param obj The entry object
8849 * @return If true, the menu is disabled
8851 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8853 * This appends a custom item provider to the list for that entry
8855 * This appends the given callback. The list is walked from beginning to end
8856 * with each function called given the item href string in the text. If the
8857 * function returns an object handle other than NULL (it should create an
8858 * object to do this), then this object is used to replace that item. If
8859 * not the next provider is called until one provides an item object, or the
8860 * default provider in entry does.
8862 * @param obj The entry object
8863 * @param func The function called to provide the item object
8864 * @param data The data passed to @p func
8866 * @see @ref entry-items
8868 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);
8870 * This prepends a custom item provider to the list for that entry
8872 * This prepends the given callback. See elm_entry_item_provider_append() for
8875 * @param obj The entry object
8876 * @param func The function called to provide the item object
8877 * @param data The data passed to @p func
8879 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);
8881 * This removes a custom item provider to the list for that entry
8883 * This removes the given callback. See elm_entry_item_provider_append() for
8886 * @param obj The entry object
8887 * @param func The function called to provide the item object
8888 * @param data The data passed to @p func
8890 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);
8892 * Append a filter function for text inserted in the entry
8894 * Append the given callback to the list. This functions will be called
8895 * whenever any text is inserted into the entry, with the text to be inserted
8896 * as a parameter. The callback function is free to alter the text in any way
8897 * it wants, but it must remember to free the given pointer and update it.
8898 * If the new text is to be discarded, the function can free it and set its
8899 * text parameter to NULL. This will also prevent any following filters from
8902 * @param obj The entry object
8903 * @param func The function to use as text filter
8904 * @param data User data to pass to @p func
8906 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8908 * Prepend a filter function for text insdrted in the entry
8910 * Prepend the given callback to the list. See elm_entry_text_filter_append()
8911 * for more information
8913 * @param obj The entry object
8914 * @param func The function to use as text filter
8915 * @param data User data to pass to @p func
8917 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8919 * Remove a filter from the list
8921 * Removes the given callback from the filter list. See
8922 * elm_entry_text_filter_append() for more information.
8924 * @param obj The entry object
8925 * @param func The filter function to remove
8926 * @param data The user data passed when adding the function
8928 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8930 * This converts a markup (HTML-like) string into UTF-8.
8932 * The returned string is a malloc'ed buffer and it should be freed when
8933 * not needed anymore.
8935 * @param s The string (in markup) to be converted
8936 * @return The converted string (in UTF-8). It should be freed.
8938 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8940 * This converts a UTF-8 string into markup (HTML-like).
8942 * The returned string is a malloc'ed buffer and it should be freed when
8943 * not needed anymore.
8945 * @param s The string (in UTF-8) to be converted
8946 * @return The converted string (in markup). It should be freed.
8948 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8950 * This sets the file (and implicitly loads it) for the text to display and
8951 * then edit. All changes are written back to the file after a short delay if
8952 * the entry object is set to autosave (which is the default).
8954 * If the entry had any other file set previously, any changes made to it
8955 * will be saved if the autosave feature is enabled, otherwise, the file
8956 * will be silently discarded and any non-saved changes will be lost.
8958 * @param obj The entry object
8959 * @param file The path to the file to load and save
8960 * @param format The file format
8962 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8964 * Gets the file being edited by the entry.
8966 * This function can be used to retrieve any file set on the entry for
8967 * edition, along with the format used to load and save it.
8969 * @param obj The entry object
8970 * @param file The path to the file to load and save
8971 * @param format The file format
8973 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8975 * This function writes any changes made to the file set with
8976 * elm_entry_file_set()
8978 * @param obj The entry object
8980 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8982 * This sets the entry object to 'autosave' the loaded text file or not.
8984 * @param obj The entry object
8985 * @param autosave Autosave the loaded file or not
8987 * @see elm_entry_file_set()
8989 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8991 * This gets the entry object's 'autosave' status.
8993 * @param obj The entry object
8994 * @return Autosave the loaded file or not
8996 * @see elm_entry_file_set()
8998 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9000 * Control pasting of text and images for the widget.
9002 * Normally the entry allows both text and images to be pasted. By setting
9003 * textonly to be true, this prevents images from being pasted.
9005 * Note this only changes the behaviour of text.
9007 * @param obj The entry object
9008 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9011 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9013 * Getting elm_entry text paste/drop mode.
9015 * In textonly mode, only text may be pasted or dropped into the widget.
9017 * @param obj The entry object
9018 * @return If the widget only accepts text from pastes.
9020 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9022 * Enable or disable scrolling in entry
9024 * Normally the entry is not scrollable unless you enable it with this call.
9026 * @param obj The entry object
9027 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9029 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9031 * Get the scrollable state of the entry
9033 * Normally the entry is not scrollable. This gets the scrollable state
9034 * of the entry. See elm_entry_scrollable_set() for more information.
9036 * @param obj The entry object
9037 * @return The scrollable state
9039 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9041 * This sets a widget to be displayed to the left of a scrolled entry.
9043 * @param obj The scrolled entry object
9044 * @param icon The widget to display on the left side of the scrolled
9047 * @note A previously set widget will be destroyed.
9048 * @note If the object being set does not have minimum size hints set,
9049 * it won't get properly displayed.
9051 * @see elm_entry_end_set()
9053 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9055 * Gets the leftmost widget of the scrolled entry. This object is
9056 * owned by the scrolled entry and should not be modified.
9058 * @param obj The scrolled entry object
9059 * @return the left widget inside the scroller
9061 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9063 * Unset the leftmost widget of the scrolled entry, unparenting and
9066 * @param obj The scrolled entry object
9067 * @return the previously set icon sub-object of this entry, on
9070 * @see elm_entry_icon_set()
9072 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9074 * Sets the visibility of the left-side widget of the scrolled entry,
9075 * set by elm_entry_icon_set().
9077 * @param obj The scrolled entry object
9078 * @param setting EINA_TRUE if the object should be displayed,
9079 * EINA_FALSE if not.
9081 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9083 * This sets a widget to be displayed to the end of a scrolled entry.
9085 * @param obj The scrolled entry object
9086 * @param end The widget to display on the right side of the scrolled
9089 * @note A previously set widget will be destroyed.
9090 * @note If the object being set does not have minimum size hints set,
9091 * it won't get properly displayed.
9093 * @see elm_entry_icon_set
9095 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9097 * Gets the endmost widget of the scrolled entry. This object is owned
9098 * by the scrolled entry and should not be modified.
9100 * @param obj The scrolled entry object
9101 * @return the right widget inside the scroller
9103 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9105 * Unset the endmost widget of the scrolled entry, unparenting and
9108 * @param obj The scrolled entry object
9109 * @return the previously set icon sub-object of this entry, on
9112 * @see elm_entry_icon_set()
9114 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9116 * Sets the visibility of the end widget of the scrolled entry, set by
9117 * elm_entry_end_set().
9119 * @param obj The scrolled entry object
9120 * @param setting EINA_TRUE if the object should be displayed,
9121 * EINA_FALSE if not.
9123 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9125 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9128 * Setting an entry to single-line mode with elm_entry_single_line_set()
9129 * will automatically disable the display of scrollbars when the entry
9130 * moves inside its scroller.
9132 * @param obj The scrolled entry object
9133 * @param h The horizontal scrollbar policy to apply
9134 * @param v The vertical scrollbar policy to apply
9136 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9138 * This enables/disables bouncing within the entry.
9140 * This function sets whether the entry will bounce when scrolling reaches
9141 * the end of the contained entry.
9143 * @param obj The scrolled entry object
9144 * @param h The horizontal bounce state
9145 * @param v The vertical bounce state
9147 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9149 * Get the bounce mode
9151 * @param obj The Entry object
9152 * @param h_bounce Allow bounce horizontally
9153 * @param v_bounce Allow bounce vertically
9155 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9157 /* pre-made filters for entries */
9159 * @typedef Elm_Entry_Filter_Limit_Size
9161 * Data for the elm_entry_filter_limit_size() entry filter.
9163 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9165 * @struct _Elm_Entry_Filter_Limit_Size
9167 * Data for the elm_entry_filter_limit_size() entry filter.
9169 struct _Elm_Entry_Filter_Limit_Size
9171 int max_char_count; /**< The maximum number of characters allowed. */
9172 int max_byte_count; /**< The maximum number of bytes allowed*/
9175 * Filter inserted text based on user defined character and byte limits
9177 * Add this filter to an entry to limit the characters that it will accept
9178 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9179 * The funtion works on the UTF-8 representation of the string, converting
9180 * it from the set markup, thus not accounting for any format in it.
9182 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9183 * it as data when setting the filter. In it, it's possible to set limits
9184 * by character count or bytes (any of them is disabled if 0), and both can
9185 * be set at the same time. In that case, it first checks for characters,
9188 * The function will cut the inserted text in order to allow only the first
9189 * number of characters that are still allowed. The cut is made in
9190 * characters, even when limiting by bytes, in order to always contain
9191 * valid ones and avoid half unicode characters making it in.
9193 * This filter, like any others, does not apply when setting the entry text
9194 * directly with elm_object_text_set() (or the deprecated
9195 * elm_entry_entry_set()).
9197 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9199 * @typedef Elm_Entry_Filter_Accept_Set
9201 * Data for the elm_entry_filter_accept_set() entry filter.
9203 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9205 * @struct _Elm_Entry_Filter_Accept_Set
9207 * Data for the elm_entry_filter_accept_set() entry filter.
9209 struct _Elm_Entry_Filter_Accept_Set
9211 const char *accepted; /**< Set of characters accepted in the entry. */
9212 const char *rejected; /**< Set of characters rejected from the entry. */
9215 * Filter inserted text based on accepted or rejected sets of characters
9217 * Add this filter to an entry to restrict the set of accepted characters
9218 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9219 * This structure contains both accepted and rejected sets, but they are
9220 * mutually exclusive.
9222 * The @c accepted set takes preference, so if it is set, the filter will
9223 * only work based on the accepted characters, ignoring anything in the
9224 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9226 * In both cases, the function filters by matching utf8 characters to the
9227 * raw markup text, so it can be used to remove formatting tags.
9229 * This filter, like any others, does not apply when setting the entry text
9230 * directly with elm_object_text_set() (or the deprecated
9231 * elm_entry_entry_set()).
9233 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9238 /* composite widgets - these basically put together basic widgets above
9239 * in convenient packages that do more than basic stuff */
9243 * @defgroup Anchorview Anchorview
9245 * @image html img/widget/anchorview/preview-00.png
9246 * @image latex img/widget/anchorview/preview-00.eps
9248 * Anchorview is for displaying text that contains markup with anchors
9249 * like <c>\<a href=1234\>something\</\></c> in it.
9251 * Besides being styled differently, the anchorview widget provides the
9252 * necessary functionality so that clicking on these anchors brings up a
9253 * popup with user defined content such as "call", "add to contacts" or
9254 * "open web page". This popup is provided using the @ref Hover widget.
9256 * This widget is very similar to @ref Anchorblock, so refer to that
9257 * widget for an example. The only difference Anchorview has is that the
9258 * widget is already provided with scrolling functionality, so if the
9259 * text set to it is too large to fit in the given space, it will scroll,
9260 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9261 * text can be displayed.
9263 * This widget emits the following signals:
9264 * @li "anchor,clicked": will be called when an anchor is clicked. The
9265 * @p event_info parameter on the callback will be a pointer of type
9266 * ::Elm_Entry_Anchorview_Info.
9268 * See @ref Anchorblock for an example on how to use both of them.
9277 * @typedef Elm_Entry_Anchorview_Info
9279 * The info sent in the callback for "anchor,clicked" signals emitted by
9280 * the Anchorview widget.
9282 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9284 * @struct _Elm_Entry_Anchorview_Info
9286 * The info sent in the callback for "anchor,clicked" signals emitted by
9287 * the Anchorview widget.
9289 struct _Elm_Entry_Anchorview_Info
9291 const char *name; /**< Name of the anchor, as indicated in its href
9293 int button; /**< The mouse button used to click on it */
9294 Evas_Object *hover; /**< The hover object to use for the popup */
9296 Evas_Coord x, y, w, h;
9297 } anchor, /**< Geometry selection of text used as anchor */
9298 hover_parent; /**< Geometry of the object used as parent by the
9300 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9301 for content on the left side of
9302 the hover. Before calling the
9303 callback, the widget will make the
9304 necessary calculations to check
9305 which sides are fit to be set with
9306 content, based on the position the
9307 hover is activated and its distance
9308 to the edges of its parent object
9310 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9311 the right side of the hover.
9312 See @ref hover_left */
9313 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9314 of the hover. See @ref hover_left */
9315 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9316 below the hover. See @ref
9320 * Add a new Anchorview object
9322 * @param parent The parent object
9323 * @return The new object or NULL if it cannot be created
9325 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9327 * Set the text to show in the anchorview
9329 * Sets the text of the anchorview to @p text. This text can include markup
9330 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9331 * text that will be specially styled and react to click events, ended with
9332 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9333 * "anchor,clicked" signal that you can attach a callback to with
9334 * evas_object_smart_callback_add(). The name of the anchor given in the
9335 * event info struct will be the one set in the href attribute, in this
9338 * Other markup can be used to style the text in different ways, but it's
9339 * up to the style defined in the theme which tags do what.
9340 * @deprecated use elm_object_text_set() instead.
9342 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9344 * Get the markup text set for the anchorview
9346 * Retrieves the text set on the anchorview, with markup tags included.
9348 * @param obj The anchorview object
9349 * @return The markup text set or @c NULL if nothing was set or an error
9351 * @deprecated use elm_object_text_set() instead.
9353 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9355 * Set the parent of the hover popup
9357 * Sets the parent object to use by the hover created by the anchorview
9358 * when an anchor is clicked. See @ref Hover for more details on this.
9359 * If no parent is set, the same anchorview object will be used.
9361 * @param obj The anchorview object
9362 * @param parent The object to use as parent for the hover
9364 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9366 * Get the parent of the hover popup
9368 * Get the object used as parent for the hover created by the anchorview
9369 * widget. See @ref Hover for more details on this.
9371 * @param obj The anchorview object
9372 * @return The object used as parent for the hover, NULL if none is set.
9374 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9376 * Set the style that the hover should use
9378 * When creating the popup hover, anchorview will request that it's
9379 * themed according to @p style.
9381 * @param obj The anchorview object
9382 * @param style The style to use for the underlying hover
9384 * @see elm_object_style_set()
9386 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9388 * Get the style that the hover should use
9390 * Get the style the hover created by anchorview will use.
9392 * @param obj The anchorview object
9393 * @return The style to use by the hover. NULL means the default is used.
9395 * @see elm_object_style_set()
9397 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9399 * Ends the hover popup in the anchorview
9401 * When an anchor is clicked, the anchorview widget will create a hover
9402 * object to use as a popup with user provided content. This function
9403 * terminates this popup, returning the anchorview to its normal state.
9405 * @param obj The anchorview object
9407 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9409 * Set bouncing behaviour when the scrolled content reaches an edge
9411 * Tell the internal scroller object whether it should bounce or not
9412 * when it reaches the respective edges for each axis.
9414 * @param obj The anchorview object
9415 * @param h_bounce Whether to bounce or not in the horizontal axis
9416 * @param v_bounce Whether to bounce or not in the vertical axis
9418 * @see elm_scroller_bounce_set()
9420 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9422 * Get the set bouncing behaviour of the internal scroller
9424 * Get whether the internal scroller should bounce when the edge of each
9425 * axis is reached scrolling.
9427 * @param obj The anchorview object
9428 * @param h_bounce Pointer where to store the bounce state of the horizontal
9430 * @param v_bounce Pointer where to store the bounce state of the vertical
9433 * @see elm_scroller_bounce_get()
9435 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9437 * Appends a custom item provider to the given anchorview
9439 * Appends the given function to the list of items providers. This list is
9440 * called, one function at a time, with the given @p data pointer, the
9441 * anchorview object and, in the @p item parameter, the item name as
9442 * referenced in its href string. Following functions in the list will be
9443 * called in order until one of them returns something different to NULL,
9444 * which should be an Evas_Object which will be used in place of the item
9447 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9448 * href=item/name\>\</item\>
9450 * @param obj The anchorview object
9451 * @param func The function to add to the list of providers
9452 * @param data User data that will be passed to the callback function
9454 * @see elm_entry_item_provider_append()
9456 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);
9458 * Prepend a custom item provider to the given anchorview
9460 * Like elm_anchorview_item_provider_append(), but it adds the function
9461 * @p func to the beginning of the list, instead of the end.
9463 * @param obj The anchorview object
9464 * @param func The function to add to the list of providers
9465 * @param data User data that will be passed to the callback function
9467 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);
9469 * Remove a custom item provider from the list of the given anchorview
9471 * Removes the function and data pairing that matches @p func and @p data.
9472 * That is, unless the same function and same user data are given, the
9473 * function will not be removed from the list. This allows us to add the
9474 * same callback several times, with different @p data pointers and be
9475 * able to remove them later without conflicts.
9477 * @param obj The anchorview object
9478 * @param func The function to remove from the list
9479 * @param data The data matching the function to remove from the list
9481 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);
9488 * @defgroup Anchorblock Anchorblock
9490 * @image html img/widget/anchorblock/preview-00.png
9491 * @image latex img/widget/anchorblock/preview-00.eps
9493 * Anchorblock is for displaying text that contains markup with anchors
9494 * like <c>\<a href=1234\>something\</\></c> in it.
9496 * Besides being styled differently, the anchorblock widget provides the
9497 * necessary functionality so that clicking on these anchors brings up a
9498 * popup with user defined content such as "call", "add to contacts" or
9499 * "open web page". This popup is provided using the @ref Hover widget.
9501 * This widget emits the following signals:
9502 * @li "anchor,clicked": will be called when an anchor is clicked. The
9503 * @p event_info parameter on the callback will be a pointer of type
9504 * ::Elm_Entry_Anchorblock_Info.
9510 * Since examples are usually better than plain words, we might as well
9511 * try @ref tutorial_anchorblock_example "one".
9514 * @addtogroup Anchorblock
9518 * @typedef Elm_Entry_Anchorblock_Info
9520 * The info sent in the callback for "anchor,clicked" signals emitted by
9521 * the Anchorblock widget.
9523 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9525 * @struct _Elm_Entry_Anchorblock_Info
9527 * The info sent in the callback for "anchor,clicked" signals emitted by
9528 * the Anchorblock widget.
9530 struct _Elm_Entry_Anchorblock_Info
9532 const char *name; /**< Name of the anchor, as indicated in its href
9534 int button; /**< The mouse button used to click on it */
9535 Evas_Object *hover; /**< The hover object to use for the popup */
9537 Evas_Coord x, y, w, h;
9538 } anchor, /**< Geometry selection of text used as anchor */
9539 hover_parent; /**< Geometry of the object used as parent by the
9541 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9542 for content on the left side of
9543 the hover. Before calling the
9544 callback, the widget will make the
9545 necessary calculations to check
9546 which sides are fit to be set with
9547 content, based on the position the
9548 hover is activated and its distance
9549 to the edges of its parent object
9551 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9552 the right side of the hover.
9553 See @ref hover_left */
9554 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9555 of the hover. See @ref hover_left */
9556 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9557 below the hover. See @ref
9561 * Add a new Anchorblock object
9563 * @param parent The parent object
9564 * @return The new object or NULL if it cannot be created
9566 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9568 * Set the text to show in the anchorblock
9570 * Sets the text of the anchorblock to @p text. This text can include markup
9571 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9572 * of text that will be specially styled and react to click events, ended
9573 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9574 * "anchor,clicked" signal that you can attach a callback to with
9575 * evas_object_smart_callback_add(). The name of the anchor given in the
9576 * event info struct will be the one set in the href attribute, in this
9579 * Other markup can be used to style the text in different ways, but it's
9580 * up to the style defined in the theme which tags do what.
9581 * @deprecated use elm_object_text_set() instead.
9583 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9585 * Get the markup text set for the anchorblock
9587 * Retrieves the text set on the anchorblock, with markup tags included.
9589 * @param obj The anchorblock object
9590 * @return The markup text set or @c NULL if nothing was set or an error
9592 * @deprecated use elm_object_text_set() instead.
9594 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9596 * Set the parent of the hover popup
9598 * Sets the parent object to use by the hover created by the anchorblock
9599 * when an anchor is clicked. See @ref Hover for more details on this.
9601 * @param obj The anchorblock object
9602 * @param parent The object to use as parent for the hover
9604 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9606 * Get the parent of the hover popup
9608 * Get the object used as parent for the hover created by the anchorblock
9609 * widget. See @ref Hover for more details on this.
9610 * If no parent is set, the same anchorblock object will be used.
9612 * @param obj The anchorblock object
9613 * @return The object used as parent for the hover, NULL if none is set.
9615 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9617 * Set the style that the hover should use
9619 * When creating the popup hover, anchorblock will request that it's
9620 * themed according to @p style.
9622 * @param obj The anchorblock object
9623 * @param style The style to use for the underlying hover
9625 * @see elm_object_style_set()
9627 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9629 * Get the style that the hover should use
9631 * Get the style the hover created by anchorblock will use.
9633 * @param obj The anchorblock object
9634 * @return The style to use by the hover. NULL means the default is used.
9636 * @see elm_object_style_set()
9638 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9640 * Ends the hover popup in the anchorblock
9642 * When an anchor is clicked, the anchorblock widget will create a hover
9643 * object to use as a popup with user provided content. This function
9644 * terminates this popup, returning the anchorblock to its normal state.
9646 * @param obj The anchorblock object
9648 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9650 * Appends a custom item provider to the given anchorblock
9652 * Appends the given function to the list of items providers. This list is
9653 * called, one function at a time, with the given @p data pointer, the
9654 * anchorblock object and, in the @p item parameter, the item name as
9655 * referenced in its href string. Following functions in the list will be
9656 * called in order until one of them returns something different to NULL,
9657 * which should be an Evas_Object which will be used in place of the item
9660 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9661 * href=item/name\>\</item\>
9663 * @param obj The anchorblock object
9664 * @param func The function to add to the list of providers
9665 * @param data User data that will be passed to the callback function
9667 * @see elm_entry_item_provider_append()
9669 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);
9671 * Prepend a custom item provider to the given anchorblock
9673 * Like elm_anchorblock_item_provider_append(), but it adds the function
9674 * @p func to the beginning of the list, instead of the end.
9676 * @param obj The anchorblock object
9677 * @param func The function to add to the list of providers
9678 * @param data User data that will be passed to the callback function
9680 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);
9682 * Remove a custom item provider from the list of the given anchorblock
9684 * Removes the function and data pairing that matches @p func and @p data.
9685 * That is, unless the same function and same user data are given, the
9686 * function will not be removed from the list. This allows us to add the
9687 * same callback several times, with different @p data pointers and be
9688 * able to remove them later without conflicts.
9690 * @param obj The anchorblock object
9691 * @param func The function to remove from the list
9692 * @param data The data matching the function to remove from the list
9694 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);
9700 * @defgroup Bubble Bubble
9702 * @image html img/widget/bubble/preview-00.png
9703 * @image latex img/widget/bubble/preview-00.eps
9704 * @image html img/widget/bubble/preview-01.png
9705 * @image latex img/widget/bubble/preview-01.eps
9706 * @image html img/widget/bubble/preview-02.png
9707 * @image latex img/widget/bubble/preview-02.eps
9709 * @brief The Bubble is a widget to show text similarly to how speech is
9710 * represented in comics.
9712 * The bubble widget contains 5 important visual elements:
9713 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9714 * @li The @p icon is an image to which the frame's arrow points to.
9715 * @li The @p label is a text which appears to the right of the icon if the
9716 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9718 * @li The @p info is a text which appears to the right of the label. Info's
9719 * font is of a ligther color than label.
9720 * @li The @p content is an evas object that is shown inside the frame.
9722 * The position of the arrow, icon, label and info depends on which corner is
9723 * selected. The four available corners are:
9724 * @li "top_left" - Default
9727 * @li "bottom_right"
9729 * Signals that you can add callbacks for are:
9730 * @li "clicked" - This is called when a user has clicked the bubble.
9732 * For an example of using a buble see @ref bubble_01_example_page "this".
9737 * Add a new bubble to the parent
9739 * @param parent The parent object
9740 * @return The new object or NULL if it cannot be created
9742 * This function adds a text bubble to the given parent evas object.
9744 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9746 * Set the label of the bubble
9748 * @param obj The bubble object
9749 * @param label The string to set in the label
9751 * This function sets the title of the bubble. Where this appears depends on
9752 * the selected corner.
9753 * @deprecated use elm_object_text_set() instead.
9755 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9757 * Get the label of the bubble
9759 * @param obj The bubble object
9760 * @return The string of set in the label
9762 * This function gets the title of the bubble.
9763 * @deprecated use elm_object_text_set() instead.
9765 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9767 * Set the info of the bubble
9769 * @param obj The bubble object
9770 * @param info The given info about the bubble
9772 * This function sets the info of the bubble. Where this appears depends on
9773 * the selected corner.
9774 * @deprecated use elm_object_text_set() instead.
9776 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9778 * Get the info of the bubble
9780 * @param obj The bubble object
9782 * @return The "info" string of the bubble
9784 * This function gets the info text.
9785 * @deprecated use elm_object_text_set() instead.
9787 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9789 * Set the content to be shown in the bubble
9791 * Once the content object is set, a previously set one will be deleted.
9792 * If you want to keep the old content object, use the
9793 * elm_bubble_content_unset() function.
9795 * @param obj The bubble object
9796 * @param content The given content of the bubble
9798 * This function sets the content shown on the middle of the bubble.
9800 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9802 * Get the content shown in the bubble
9804 * Return the content object which is set for this widget.
9806 * @param obj The bubble object
9807 * @return The content that is being used
9809 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9811 * Unset the content shown in the bubble
9813 * Unparent and return the content object which was set for this widget.
9815 * @param obj The bubble object
9816 * @return The content that was being used
9818 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9820 * Set the icon of the bubble
9822 * Once the icon object is set, a previously set one will be deleted.
9823 * If you want to keep the old content object, use the
9824 * elm_icon_content_unset() function.
9826 * @param obj The bubble object
9827 * @param icon The given icon for the bubble
9829 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9831 * Get the icon of the bubble
9833 * @param obj The bubble object
9834 * @return The icon for the bubble
9836 * This function gets the icon shown on the top left of bubble.
9838 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9840 * Unset the icon of the bubble
9842 * Unparent and return the icon object which was set for this widget.
9844 * @param obj The bubble object
9845 * @return The icon that was being used
9847 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9849 * Set the corner of the bubble
9851 * @param obj The bubble object.
9852 * @param corner The given corner for the bubble.
9854 * This function sets the corner of the bubble. The corner will be used to
9855 * determine where the arrow in the frame points to and where label, icon and
9858 * Possible values for corner are:
9859 * @li "top_left" - Default
9862 * @li "bottom_right"
9864 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9866 * Get the corner of the bubble
9868 * @param obj The bubble object.
9869 * @return The given corner for the bubble.
9871 * This function gets the selected corner of the bubble.
9873 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9879 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9880 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9881 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9882 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9883 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9884 /* smart callbacks called:
9885 * "clicked" - the user clicked the icon
9886 * "drag,start" - Someone started dragging the image out of the object
9887 * "drag,end" - Dragged item was dropped (somewhere)
9892 * @defgroup Elm_Gesture_Layer Gesture Layer
9893 * Gesture Layer Usage:
9895 * Use Gesture Layer to detect gestures.
9896 * The advantage is that you don't have to implement
9897 * gesture detection, just set callbacks of gesture state.
9898 * By using gesture layer we make standard interface.
9900 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9901 * with a parent object parameter.
9902 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9903 * call. Usually with same object as target (2nd parameter).
9905 * Now you need to tell gesture layer what gestures you follow.
9906 * This is done with @ref elm_gesture_layer_cb_set call.
9907 * By setting the callback you actually saying to gesture layer:
9908 * I would like to know when the gesture @ref Elm_Gesture_Types
9909 * switches to state @ref Elm_Gesture_State.
9911 * Next, you need to implement the actual action that follows the input
9914 * Note that if you like to stop being reported about a gesture, just set
9915 * all callbacks referring this gesture to NULL.
9916 * (again with @ref elm_gesture_layer_cb_set)
9918 * The information reported by gesture layer to your callback is depending
9919 * on @ref Elm_Gesture_Types:
9920 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9921 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9922 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9924 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9925 * @ref ELM_GESTURE_MOMENTUM.
9927 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9928 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9929 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9930 * Note that we consider a flick as a line-gesture that should be completed
9931 * in flick-time-limit as defined in @ref Config.
9933 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9935 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9939 * @enum _Elm_Gesture_Types
9940 * Enum of supported gesture types.
9941 * @ingroup Elm_Gesture_Layer
9943 enum _Elm_Gesture_Types
9945 ELM_GESTURE_FIRST = 0,
9947 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9948 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9949 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9950 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9952 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9954 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9955 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9957 ELM_GESTURE_ZOOM, /**< Zoom */
9958 ELM_GESTURE_ROTATE, /**< Rotate */
9964 * @typedef Elm_Gesture_Types
9965 * gesture types enum
9966 * @ingroup Elm_Gesture_Layer
9968 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9971 * @enum _Elm_Gesture_State
9972 * Enum of gesture states.
9973 * @ingroup Elm_Gesture_Layer
9975 enum _Elm_Gesture_State
9977 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9978 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
9979 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
9980 ELM_GESTURE_STATE_END, /**< Gesture completed */
9981 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
9985 * @typedef Elm_Gesture_State
9986 * gesture states enum
9987 * @ingroup Elm_Gesture_Layer
9989 typedef enum _Elm_Gesture_State Elm_Gesture_State;
9992 * @struct _Elm_Gesture_Taps_Info
9993 * Struct holds taps info for user
9994 * @ingroup Elm_Gesture_Layer
9996 struct _Elm_Gesture_Taps_Info
9998 Evas_Coord x, y; /**< Holds center point between fingers */
9999 unsigned int n; /**< Number of fingers tapped */
10000 unsigned int timestamp; /**< event timestamp */
10004 * @typedef Elm_Gesture_Taps_Info
10005 * holds taps info for user
10006 * @ingroup Elm_Gesture_Layer
10008 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10011 * @struct _Elm_Gesture_Momentum_Info
10012 * Struct holds momentum info for user
10013 * x1 and y1 are not necessarily in sync
10014 * x1 holds x value of x direction starting point
10015 * and same holds for y1.
10016 * This is noticeable when doing V-shape movement
10017 * @ingroup Elm_Gesture_Layer
10019 struct _Elm_Gesture_Momentum_Info
10020 { /* Report line ends, timestamps, and momentum computed */
10021 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10022 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10023 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10024 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10026 unsigned int tx; /**< Timestamp of start of final x-swipe */
10027 unsigned int ty; /**< Timestamp of start of final y-swipe */
10029 Evas_Coord mx; /**< Momentum on X */
10030 Evas_Coord my; /**< Momentum on Y */
10034 * @typedef Elm_Gesture_Momentum_Info
10035 * holds momentum info for user
10036 * @ingroup Elm_Gesture_Layer
10038 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10041 * @struct _Elm_Gesture_Line_Info
10042 * Struct holds line info for user
10043 * @ingroup Elm_Gesture_Layer
10045 struct _Elm_Gesture_Line_Info
10046 { /* Report line ends, timestamps, and momentum computed */
10047 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10048 unsigned int n; /**< Number of fingers (lines) */
10049 /* FIXME should be radians, bot degrees */
10050 double angle; /**< Angle (direction) of lines */
10054 * @typedef Elm_Gesture_Line_Info
10055 * Holds line info for user
10056 * @ingroup Elm_Gesture_Layer
10058 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10061 * @struct _Elm_Gesture_Zoom_Info
10062 * Struct holds zoom info for user
10063 * @ingroup Elm_Gesture_Layer
10065 struct _Elm_Gesture_Zoom_Info
10067 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10068 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10069 double zoom; /**< Zoom value: 1.0 means no zoom */
10070 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10074 * @typedef Elm_Gesture_Zoom_Info
10075 * Holds zoom info for user
10076 * @ingroup Elm_Gesture_Layer
10078 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10081 * @struct _Elm_Gesture_Rotate_Info
10082 * Struct holds rotation info for user
10083 * @ingroup Elm_Gesture_Layer
10085 struct _Elm_Gesture_Rotate_Info
10087 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10088 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10089 double base_angle; /**< Holds start-angle */
10090 double angle; /**< Rotation value: 0.0 means no rotation */
10091 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10095 * @typedef Elm_Gesture_Rotate_Info
10096 * Holds rotation info for user
10097 * @ingroup Elm_Gesture_Layer
10099 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10102 * @typedef Elm_Gesture_Event_Cb
10103 * User callback used to stream gesture info from gesture layer
10104 * @param data user data
10105 * @param event_info gesture report info
10106 * Returns a flag field to be applied on the causing event.
10107 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10108 * upon the event, in an irreversible way.
10110 * @ingroup Elm_Gesture_Layer
10112 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10115 * Use function to set callbacks to be notified about
10116 * change of state of gesture.
10117 * When a user registers a callback with this function
10118 * this means this gesture has to be tested.
10120 * When ALL callbacks for a gesture are set to NULL
10121 * it means user isn't interested in gesture-state
10122 * and it will not be tested.
10124 * @param obj Pointer to gesture-layer.
10125 * @param idx The gesture you would like to track its state.
10126 * @param cb callback function pointer.
10127 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10128 * @param data user info to be sent to callback (usually, Smart Data)
10130 * @ingroup Elm_Gesture_Layer
10132 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);
10135 * Call this function to get repeat-events settings.
10137 * @param obj Pointer to gesture-layer.
10139 * @return repeat events settings.
10140 * @see elm_gesture_layer_hold_events_set()
10141 * @ingroup Elm_Gesture_Layer
10143 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10146 * This function called in order to make gesture-layer repeat events.
10147 * Set this of you like to get the raw events only if gestures were not detected.
10148 * Clear this if you like gesture layer to fwd events as testing gestures.
10150 * @param obj Pointer to gesture-layer.
10151 * @param r Repeat: TRUE/FALSE
10153 * @ingroup Elm_Gesture_Layer
10155 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10158 * This function sets step-value for zoom action.
10159 * Set step to any positive value.
10160 * Cancel step setting by setting to 0.0
10162 * @param obj Pointer to gesture-layer.
10163 * @param s new zoom step value.
10165 * @ingroup Elm_Gesture_Layer
10167 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10170 * This function sets step-value for rotate action.
10171 * Set step to any positive value.
10172 * Cancel step setting by setting to 0.0
10174 * @param obj Pointer to gesture-layer.
10175 * @param s new roatate step value.
10177 * @ingroup Elm_Gesture_Layer
10179 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10182 * This function called to attach gesture-layer to an Evas_Object.
10183 * @param obj Pointer to gesture-layer.
10184 * @param t Pointer to underlying object (AKA Target)
10186 * @return TRUE, FALSE on success, failure.
10188 * @ingroup Elm_Gesture_Layer
10190 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10193 * Call this function to construct a new gesture-layer object.
10194 * This does not activate the gesture layer. You have to
10195 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10197 * @param parent the parent object.
10199 * @return Pointer to new gesture-layer object.
10201 * @ingroup Elm_Gesture_Layer
10203 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10206 * @defgroup Thumb Thumb
10208 * @image html img/widget/thumb/preview-00.png
10209 * @image latex img/widget/thumb/preview-00.eps
10211 * A thumb object is used for displaying the thumbnail of an image or video.
10212 * You must have compiled Elementary with Ethumb_Client support and the DBus
10213 * service must be present and auto-activated in order to have thumbnails to
10216 * Once the thumbnail object becomes visible, it will check if there is a
10217 * previously generated thumbnail image for the file set on it. If not, it
10218 * will start generating this thumbnail.
10220 * Different config settings will cause different thumbnails to be generated
10221 * even on the same file.
10223 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10224 * Ethumb documentation to change this path, and to see other configuration
10227 * Signals that you can add callbacks for are:
10229 * - "clicked" - This is called when a user has clicked the thumb without dragging
10231 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10232 * - "press" - This is called when a user has pressed down the thumb.
10233 * - "generate,start" - The thumbnail generation started.
10234 * - "generate,stop" - The generation process stopped.
10235 * - "generate,error" - The generation failed.
10236 * - "load,error" - The thumbnail image loading failed.
10238 * available styles:
10242 * An example of use of thumbnail:
10244 * - @ref thumb_example_01
10248 * @addtogroup Thumb
10253 * @enum _Elm_Thumb_Animation_Setting
10254 * @typedef Elm_Thumb_Animation_Setting
10256 * Used to set if a video thumbnail is animating or not.
10260 typedef enum _Elm_Thumb_Animation_Setting
10262 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10263 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10264 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10265 ELM_THUMB_ANIMATION_LAST
10266 } Elm_Thumb_Animation_Setting;
10269 * Add a new thumb object to the parent.
10271 * @param parent The parent object.
10272 * @return The new object or NULL if it cannot be created.
10274 * @see elm_thumb_file_set()
10275 * @see elm_thumb_ethumb_client_get()
10279 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10281 * Reload thumbnail if it was generated before.
10283 * @param obj The thumb object to reload
10285 * This is useful if the ethumb client configuration changed, like its
10286 * size, aspect or any other property one set in the handle returned
10287 * by elm_thumb_ethumb_client_get().
10289 * If the options didn't change, the thumbnail won't be generated again, but
10290 * the old one will still be used.
10292 * @see elm_thumb_file_set()
10296 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10298 * Set the file that will be used as thumbnail.
10300 * @param obj The thumb object.
10301 * @param file The path to file that will be used as thumb.
10302 * @param key The key used in case of an EET file.
10304 * The file can be an image or a video (in that case, acceptable extensions are:
10305 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10306 * function elm_thumb_animate().
10308 * @see elm_thumb_file_get()
10309 * @see elm_thumb_reload()
10310 * @see elm_thumb_animate()
10314 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10316 * Get the image or video path and key used to generate the thumbnail.
10318 * @param obj The thumb object.
10319 * @param file Pointer to filename.
10320 * @param key Pointer to key.
10322 * @see elm_thumb_file_set()
10323 * @see elm_thumb_path_get()
10327 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10329 * Get the path and key to the image or video generated by ethumb.
10331 * One just need to make sure that the thumbnail was generated before getting
10332 * its path; otherwise, the path will be NULL. One way to do that is by asking
10333 * for the path when/after the "generate,stop" smart callback is called.
10335 * @param obj The thumb object.
10336 * @param file Pointer to thumb path.
10337 * @param key Pointer to thumb key.
10339 * @see elm_thumb_file_get()
10343 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10345 * Set the animation state for the thumb object. If its content is an animated
10346 * video, you may start/stop the animation or tell it to play continuously and
10349 * @param obj The thumb object.
10350 * @param setting The animation setting.
10352 * @see elm_thumb_file_set()
10356 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10358 * Get the animation state for the thumb object.
10360 * @param obj The thumb object.
10361 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10364 * @see elm_thumb_animate_set()
10368 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10370 * Get the ethumb_client handle so custom configuration can be made.
10372 * @return Ethumb_Client instance or NULL.
10374 * This must be called before the objects are created to be sure no object is
10375 * visible and no generation started.
10377 * Example of usage:
10380 * #include <Elementary.h>
10381 * #ifndef ELM_LIB_QUICKLAUNCH
10383 * elm_main(int argc, char **argv)
10385 * Ethumb_Client *client;
10387 * elm_need_ethumb();
10391 * client = elm_thumb_ethumb_client_get();
10394 * ERR("could not get ethumb_client");
10397 * ethumb_client_size_set(client, 100, 100);
10398 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10401 * // Create elm_thumb objects here
10411 * @note There's only one client handle for Ethumb, so once a configuration
10412 * change is done to it, any other request for thumbnails (for any thumbnail
10413 * object) will use that configuration. Thus, this configuration is global.
10417 EAPI void *elm_thumb_ethumb_client_get(void);
10419 * Get the ethumb_client connection state.
10421 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10424 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10426 * Make the thumbnail 'editable'.
10428 * @param obj Thumb object.
10429 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10431 * This means the thumbnail is a valid drag target for drag and drop, and can be
10432 * cut or pasted too.
10434 * @see elm_thumb_editable_get()
10438 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10440 * Make the thumbnail 'editable'.
10442 * @param obj Thumb object.
10443 * @return Editability.
10445 * This means the thumbnail is a valid drag target for drag and drop, and can be
10446 * cut or pasted too.
10448 * @see elm_thumb_editable_set()
10452 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10459 * @defgroup Hoversel Hoversel
10461 * @image html img/widget/hoversel/preview-00.png
10462 * @image latex img/widget/hoversel/preview-00.eps
10464 * A hoversel is a button that pops up a list of items (automatically
10465 * choosing the direction to display) that have a label and, optionally, an
10466 * icon to select from. It is a convenience widget to avoid the need to do
10467 * all the piecing together yourself. It is intended for a small number of
10468 * items in the hoversel menu (no more than 8), though is capable of many
10471 * Signals that you can add callbacks for are:
10472 * "clicked" - the user clicked the hoversel button and popped up the sel
10473 * "selected" - an item in the hoversel list is selected. event_info is the item
10474 * "dismissed" - the hover is dismissed
10476 * See @ref tutorial_hoversel for an example.
10479 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10481 * @brief Add a new Hoversel object
10483 * @param parent The parent object
10484 * @return The new object or NULL if it cannot be created
10486 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10488 * @brief This sets the hoversel to expand horizontally.
10490 * @param obj The hoversel object
10491 * @param horizontal If true, the hover will expand horizontally to the
10494 * @note The initial button will display horizontally regardless of this
10497 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10499 * @brief This returns whether the hoversel is set to expand horizontally.
10501 * @param obj The hoversel object
10502 * @return If true, the hover will expand horizontally to the right.
10504 * @see elm_hoversel_horizontal_set()
10506 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10508 * @brief Set the Hover parent
10510 * @param obj The hoversel object
10511 * @param parent The parent to use
10513 * Sets the hover parent object, the area that will be darkened when the
10514 * hoversel is clicked. Should probably be the window that the hoversel is
10515 * in. See @ref Hover objects for more information.
10517 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10519 * @brief Get the Hover parent
10521 * @param obj The hoversel object
10522 * @return The used parent
10524 * Gets the hover parent object.
10526 * @see elm_hoversel_hover_parent_set()
10528 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10530 * @brief Set the hoversel button label
10532 * @param obj The hoversel object
10533 * @param label The label text.
10535 * This sets the label of the button that is always visible (before it is
10536 * clicked and expanded).
10538 * @deprecated elm_object_text_set()
10540 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10542 * @brief Get the hoversel button label
10544 * @param obj The hoversel object
10545 * @return The label text.
10547 * @deprecated elm_object_text_get()
10549 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10551 * @brief Set the icon of the hoversel button
10553 * @param obj The hoversel object
10554 * @param icon The icon object
10556 * Sets the icon of the button that is always visible (before it is clicked
10557 * and expanded). Once the icon object is set, a previously set one will be
10558 * deleted, if you want to keep that old content object, use the
10559 * elm_hoversel_icon_unset() function.
10561 * @see elm_button_icon_set()
10563 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10565 * @brief Get the icon of the hoversel button
10567 * @param obj The hoversel object
10568 * @return The icon object
10570 * Get the icon of the button that is always visible (before it is clicked
10571 * and expanded). Also see elm_button_icon_get().
10573 * @see elm_hoversel_icon_set()
10575 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10577 * @brief Get and unparent the icon of the hoversel button
10579 * @param obj The hoversel object
10580 * @return The icon object that was being used
10582 * Unparent and return the icon of the button that is always visible
10583 * (before it is clicked and expanded).
10585 * @see elm_hoversel_icon_set()
10586 * @see elm_button_icon_unset()
10588 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10590 * @brief This triggers the hoversel popup from code, the same as if the user
10591 * had clicked the button.
10593 * @param obj The hoversel object
10595 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10597 * @brief This dismisses the hoversel popup as if the user had clicked
10598 * outside the hover.
10600 * @param obj The hoversel object
10602 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10604 * @brief Returns whether the hoversel is expanded.
10606 * @param obj The hoversel object
10607 * @return This will return EINA_TRUE if the hoversel is expanded or
10608 * EINA_FALSE if it is not expanded.
10610 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10612 * @brief This will remove all the children items from the hoversel.
10614 * @param obj The hoversel object
10616 * @warning Should @b not be called while the hoversel is active; use
10617 * elm_hoversel_expanded_get() to check first.
10619 * @see elm_hoversel_item_del_cb_set()
10620 * @see elm_hoversel_item_del()
10622 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10624 * @brief Get the list of items within the given hoversel.
10626 * @param obj The hoversel object
10627 * @return Returns a list of Elm_Hoversel_Item*
10629 * @see elm_hoversel_item_add()
10631 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10633 * @brief Add an item to the hoversel button
10635 * @param obj The hoversel object
10636 * @param label The text label to use for the item (NULL if not desired)
10637 * @param icon_file An image file path on disk to use for the icon or standard
10638 * icon name (NULL if not desired)
10639 * @param icon_type The icon type if relevant
10640 * @param func Convenience function to call when this item is selected
10641 * @param data Data to pass to item-related functions
10642 * @return A handle to the item added.
10644 * This adds an item to the hoversel to show when it is clicked. Note: if you
10645 * need to use an icon from an edje file then use
10646 * elm_hoversel_item_icon_set() right after the this function, and set
10647 * icon_file to NULL here.
10649 * For more information on what @p icon_file and @p icon_type are see the
10650 * @ref Icon "icon documentation".
10652 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);
10654 * @brief Delete an item from the hoversel
10656 * @param item The item to delete
10658 * This deletes the item from the hoversel (should not be called while the
10659 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10661 * @see elm_hoversel_item_add()
10662 * @see elm_hoversel_item_del_cb_set()
10664 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10666 * @brief Set the function to be called when an item from the hoversel is
10669 * @param item The item to set the callback on
10670 * @param func The function called
10672 * That function will receive these parameters:
10673 * @li void *item_data
10674 * @li Evas_Object *the_item_object
10675 * @li Elm_Hoversel_Item *the_object_struct
10677 * @see elm_hoversel_item_add()
10679 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10681 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10682 * that will be passed to associated function callbacks.
10684 * @param item The item to get the data from
10685 * @return The data pointer set with elm_hoversel_item_add()
10687 * @see elm_hoversel_item_add()
10689 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10691 * @brief This returns the label text of the given hoversel item.
10693 * @param item The item to get the label
10694 * @return The label text of the hoversel item
10696 * @see elm_hoversel_item_add()
10698 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10700 * @brief This sets the icon for the given hoversel item.
10702 * @param item The item to set the icon
10703 * @param icon_file An image file path on disk to use for the icon or standard
10705 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10706 * to NULL if the icon is not an edje file
10707 * @param icon_type The icon type
10709 * The icon can be loaded from the standard set, from an image file, or from
10712 * @see elm_hoversel_item_add()
10714 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);
10716 * @brief Get the icon object of the hoversel item
10718 * @param item The item to get the icon from
10719 * @param icon_file The image file path on disk used for the icon or standard
10721 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10722 * if the icon is not an edje file
10723 * @param icon_type The icon type
10725 * @see elm_hoversel_item_icon_set()
10726 * @see elm_hoversel_item_add()
10728 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);
10734 * @defgroup Toolbar Toolbar
10735 * @ingroup Elementary
10737 * @image html img/widget/toolbar/preview-00.png
10738 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10740 * @image html img/toolbar.png
10741 * @image latex img/toolbar.eps width=\textwidth
10743 * A toolbar is a widget that displays a list of items inside
10744 * a box. It can be scrollable, show a menu with items that don't fit
10745 * to toolbar size or even crop them.
10747 * Only one item can be selected at a time.
10749 * Items can have multiple states, or show menus when selected by the user.
10751 * Smart callbacks one can listen to:
10752 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10754 * Available styles for it:
10756 * - @c "transparent" - no background or shadow, just show the content
10758 * List of examples:
10759 * @li @ref toolbar_example_01
10760 * @li @ref toolbar_example_02
10761 * @li @ref toolbar_example_03
10765 * @addtogroup Toolbar
10770 * @enum _Elm_Toolbar_Shrink_Mode
10771 * @typedef Elm_Toolbar_Shrink_Mode
10773 * Set toolbar's items display behavior, it can be scrollabel,
10774 * show a menu with exceeding items, or simply hide them.
10776 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10779 * Values <b> don't </b> work as bitmask, only one can be choosen.
10781 * @see elm_toolbar_mode_shrink_set()
10782 * @see elm_toolbar_mode_shrink_get()
10786 typedef enum _Elm_Toolbar_Shrink_Mode
10788 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10789 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10790 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10791 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10792 } Elm_Toolbar_Shrink_Mode;
10794 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(). */
10796 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(). */
10799 * Add a new toolbar widget to the given parent Elementary
10800 * (container) object.
10802 * @param parent The parent object.
10803 * @return a new toolbar widget handle or @c NULL, on errors.
10805 * This function inserts a new toolbar widget on the canvas.
10809 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10812 * Set the icon size, in pixels, to be used by toolbar items.
10814 * @param obj The toolbar object
10815 * @param icon_size The icon size in pixels
10817 * @note Default value is @c 32. It reads value from elm config.
10819 * @see elm_toolbar_icon_size_get()
10823 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10826 * Get the icon size, in pixels, to be used by toolbar items.
10828 * @param obj The toolbar object.
10829 * @return The icon size in pixels.
10831 * @see elm_toolbar_icon_size_set() for details.
10835 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10838 * Sets icon lookup order, for toolbar items' icons.
10840 * @param obj The toolbar object.
10841 * @param order The icon lookup order.
10843 * Icons added before calling this function will not be affected.
10844 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10846 * @see elm_toolbar_icon_order_lookup_get()
10850 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10853 * Gets the icon lookup order.
10855 * @param obj The toolbar object.
10856 * @return The icon lookup order.
10858 * @see elm_toolbar_icon_order_lookup_set() for details.
10862 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10865 * Set whether the toolbar items' should be selected by the user or not.
10867 * @param obj The toolbar object.
10868 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10871 * This will turn off the ability to select items entirely and they will
10872 * neither appear selected nor emit selected signals. The clicked
10873 * callback function will still be called.
10875 * Selection is enabled by default.
10877 * @see elm_toolbar_no_select_mode_get().
10881 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10884 * Set whether the toolbar items' should be selected by the user or not.
10886 * @param obj The toolbar object.
10887 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10888 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10890 * @see elm_toolbar_no_select_mode_set() for details.
10894 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10897 * Append item to the toolbar.
10899 * @param obj The toolbar object.
10900 * @param icon A string with icon name or the absolute path of an image file.
10901 * @param label The label of the item.
10902 * @param func The function to call when the item is clicked.
10903 * @param data The data to associate with the item for related callbacks.
10904 * @return The created item or @c NULL upon failure.
10906 * A new item will be created and appended to the toolbar, i.e., will
10907 * be set as @b last item.
10909 * Items created with this method can be deleted with
10910 * elm_toolbar_item_del().
10912 * Associated @p data can be properly freed when item is deleted if a
10913 * callback function is set with elm_toolbar_item_del_cb_set().
10915 * If a function is passed as argument, it will be called everytime this item
10916 * is selected, i.e., the user clicks over an unselected item.
10917 * If such function isn't needed, just passing
10918 * @c NULL as @p func is enough. The same should be done for @p data.
10920 * Toolbar will load icon image from fdo or current theme.
10921 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10922 * If an absolute path is provided it will load it direct from a file.
10924 * @see elm_toolbar_item_icon_set()
10925 * @see elm_toolbar_item_del()
10926 * @see elm_toolbar_item_del_cb_set()
10930 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);
10933 * Prepend item to the toolbar.
10935 * @param obj The toolbar object.
10936 * @param icon A string with icon name or the absolute path of an image file.
10937 * @param label The label of the item.
10938 * @param func The function to call when the item is clicked.
10939 * @param data The data to associate with the item for related callbacks.
10940 * @return The created item or @c NULL upon failure.
10942 * A new item will be created and prepended to the toolbar, i.e., will
10943 * be set as @b first item.
10945 * Items created with this method can be deleted with
10946 * elm_toolbar_item_del().
10948 * Associated @p data can be properly freed when item is deleted if a
10949 * callback function is set with elm_toolbar_item_del_cb_set().
10951 * If a function is passed as argument, it will be called everytime this item
10952 * is selected, i.e., the user clicks over an unselected item.
10953 * If such function isn't needed, just passing
10954 * @c NULL as @p func is enough. The same should be done for @p data.
10956 * Toolbar will load icon image from fdo or current theme.
10957 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10958 * If an absolute path is provided it will load it direct from a file.
10960 * @see elm_toolbar_item_icon_set()
10961 * @see elm_toolbar_item_del()
10962 * @see elm_toolbar_item_del_cb_set()
10966 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);
10969 * Insert a new item into the toolbar object before item @p before.
10971 * @param obj The toolbar object.
10972 * @param before The toolbar item to insert before.
10973 * @param icon A string with icon name or the absolute path of an image file.
10974 * @param label The label of the item.
10975 * @param func The function to call when the item is clicked.
10976 * @param data The data to associate with the item for related callbacks.
10977 * @return The created item or @c NULL upon failure.
10979 * A new item will be created and added to the toolbar. Its position in
10980 * this toolbar will be just before item @p before.
10982 * Items created with this method can be deleted with
10983 * elm_toolbar_item_del().
10985 * Associated @p data can be properly freed when item is deleted if a
10986 * callback function is set with elm_toolbar_item_del_cb_set().
10988 * If a function is passed as argument, it will be called everytime this item
10989 * is selected, i.e., the user clicks over an unselected item.
10990 * If such function isn't needed, just passing
10991 * @c NULL as @p func is enough. The same should be done for @p data.
10993 * Toolbar will load icon image from fdo or current theme.
10994 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10995 * If an absolute path is provided it will load it direct from a file.
10997 * @see elm_toolbar_item_icon_set()
10998 * @see elm_toolbar_item_del()
10999 * @see elm_toolbar_item_del_cb_set()
11003 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);
11006 * Insert a new item into the toolbar object after item @p after.
11008 * @param obj The toolbar object.
11009 * @param before The toolbar item to insert before.
11010 * @param icon A string with icon name or the absolute path of an image file.
11011 * @param label The label of the item.
11012 * @param func The function to call when the item is clicked.
11013 * @param data The data to associate with the item for related callbacks.
11014 * @return The created item or @c NULL upon failure.
11016 * A new item will be created and added to the toolbar. Its position in
11017 * this toolbar will be just after item @p after.
11019 * Items created with this method can be deleted with
11020 * elm_toolbar_item_del().
11022 * Associated @p data can be properly freed when item is deleted if a
11023 * callback function is set with elm_toolbar_item_del_cb_set().
11025 * If a function is passed as argument, it will be called everytime this item
11026 * is selected, i.e., the user clicks over an unselected item.
11027 * If such function isn't needed, just passing
11028 * @c NULL as @p func is enough. The same should be done for @p data.
11030 * Toolbar will load icon image from fdo or current theme.
11031 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11032 * If an absolute path is provided it will load it direct from a file.
11034 * @see elm_toolbar_item_icon_set()
11035 * @see elm_toolbar_item_del()
11036 * @see elm_toolbar_item_del_cb_set()
11040 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);
11043 * Get the first item in the given toolbar widget's list of
11046 * @param obj The toolbar object
11047 * @return The first item or @c NULL, if it has no items (and on
11050 * @see elm_toolbar_item_append()
11051 * @see elm_toolbar_last_item_get()
11055 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11058 * Get the last item in the given toolbar widget's list of
11061 * @param obj The toolbar object
11062 * @return The last item or @c NULL, if it has no items (and on
11065 * @see elm_toolbar_item_prepend()
11066 * @see elm_toolbar_first_item_get()
11070 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11073 * Get the item after @p item in toolbar.
11075 * @param item The toolbar item.
11076 * @return The item after @p item, or @c NULL if none or on failure.
11078 * @note If it is the last item, @c NULL will be returned.
11080 * @see elm_toolbar_item_append()
11084 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11087 * Get the item before @p item in toolbar.
11089 * @param item The toolbar item.
11090 * @return The item before @p item, or @c NULL if none or on failure.
11092 * @note If it is the first item, @c NULL will be returned.
11094 * @see elm_toolbar_item_prepend()
11098 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11101 * Get the toolbar object from an item.
11103 * @param item The item.
11104 * @return The toolbar object.
11106 * This returns the toolbar object itself that an item belongs to.
11110 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11113 * Set the priority of a toolbar item.
11115 * @param item The toolbar item.
11116 * @param priority The item priority. The default is zero.
11118 * This is used only when the toolbar shrink mode is set to
11119 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11120 * When space is less than required, items with low priority
11121 * will be removed from the toolbar and added to a dynamically-created menu,
11122 * while items with higher priority will remain on the toolbar,
11123 * with the same order they were added.
11125 * @see elm_toolbar_item_priority_get()
11129 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11132 * Get the priority of a toolbar item.
11134 * @param item The toolbar item.
11135 * @return The @p item priority, or @c 0 on failure.
11137 * @see elm_toolbar_item_priority_set() for details.
11141 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11144 * Get the label of item.
11146 * @param item The item of toolbar.
11147 * @return The label of item.
11149 * The return value is a pointer to the label associated to @p item when
11150 * it was created, with function elm_toolbar_item_append() or similar,
11152 * with function elm_toolbar_item_label_set. If no label
11153 * was passed as argument, it will return @c NULL.
11155 * @see elm_toolbar_item_label_set() for more details.
11156 * @see elm_toolbar_item_append()
11160 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11163 * Set the label of item.
11165 * @param item The item of toolbar.
11166 * @param text The label of item.
11168 * The label to be displayed by the item.
11169 * Label will be placed at icons bottom (if set).
11171 * If a label was passed as argument on item creation, with function
11172 * elm_toolbar_item_append() or similar, it will be already
11173 * displayed by the item.
11175 * @see elm_toolbar_item_label_get()
11176 * @see elm_toolbar_item_append()
11180 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11183 * Return the data associated with a given toolbar widget item.
11185 * @param item The toolbar widget item handle.
11186 * @return The data associated with @p item.
11188 * @see elm_toolbar_item_data_set()
11192 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11195 * Set the data associated with a given toolbar widget item.
11197 * @param item The toolbar widget item handle.
11198 * @param data The new data pointer to set to @p item.
11200 * This sets new item data on @p item.
11202 * @warning The old data pointer won't be touched by this function, so
11203 * the user had better to free that old data himself/herself.
11207 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11210 * Returns a pointer to a toolbar item by its label.
11212 * @param obj The toolbar object.
11213 * @param label The label of the item to find.
11215 * @return The pointer to the toolbar item matching @p label or @c NULL
11220 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11223 * Get whether the @p item is selected or not.
11225 * @param item The toolbar item.
11226 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11227 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11229 * @see elm_toolbar_selected_item_set() for details.
11230 * @see elm_toolbar_item_selected_get()
11234 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11237 * Set the selected state of an item.
11239 * @param item The toolbar item
11240 * @param selected The selected state
11242 * This sets the selected state of the given item @p it.
11243 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11245 * If a new item is selected the previosly selected will be unselected.
11246 * Previoulsy selected item can be get with function
11247 * elm_toolbar_selected_item_get().
11249 * Selected items will be highlighted.
11251 * @see elm_toolbar_item_selected_get()
11252 * @see elm_toolbar_selected_item_get()
11256 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11259 * Get the selected item.
11261 * @param obj The toolbar object.
11262 * @return The selected toolbar item.
11264 * The selected item can be unselected with function
11265 * elm_toolbar_item_selected_set().
11267 * The selected item always will be highlighted on toolbar.
11269 * @see elm_toolbar_selected_items_get()
11273 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11276 * Set the icon associated with @p item.
11278 * @param obj The parent of this item.
11279 * @param item The toolbar item.
11280 * @param icon A string with icon name or the absolute path of an image file.
11282 * Toolbar will load icon image from fdo or current theme.
11283 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11284 * If an absolute path is provided it will load it direct from a file.
11286 * @see elm_toolbar_icon_order_lookup_set()
11287 * @see elm_toolbar_icon_order_lookup_get()
11291 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11294 * Get the string used to set the icon of @p item.
11296 * @param item The toolbar item.
11297 * @return The string associated with the icon object.
11299 * @see elm_toolbar_item_icon_set() for details.
11303 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11306 * Delete them item from the toolbar.
11308 * @param item The item of toolbar to be deleted.
11310 * @see elm_toolbar_item_append()
11311 * @see elm_toolbar_item_del_cb_set()
11315 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11318 * Set the function called when a toolbar item is freed.
11320 * @param item The item to set the callback on.
11321 * @param func The function called.
11323 * If there is a @p func, then it will be called prior item's memory release.
11324 * That will be called with the following arguments:
11326 * @li item's Evas object;
11329 * This way, a data associated to a toolbar item could be properly freed.
11333 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11336 * Get a value whether toolbar item is disabled or not.
11338 * @param item The item.
11339 * @return The disabled state.
11341 * @see elm_toolbar_item_disabled_set() for more details.
11345 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11348 * Sets the disabled/enabled state of a toolbar item.
11350 * @param item The item.
11351 * @param disabled The disabled state.
11353 * A disabled item cannot be selected or unselected. It will also
11354 * change its appearance (generally greyed out). This sets the
11355 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11360 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11363 * Set or unset item as a separator.
11365 * @param item The toolbar item.
11366 * @param setting @c EINA_TRUE to set item @p item as separator or
11367 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11369 * Items aren't set as separator by default.
11371 * If set as separator it will display separator theme, so won't display
11374 * @see elm_toolbar_item_separator_get()
11378 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11381 * Get a value whether item is a separator or not.
11383 * @param item The toolbar item.
11384 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11385 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11387 * @see elm_toolbar_item_separator_set() for details.
11391 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11394 * Set the shrink state of toolbar @p obj.
11396 * @param obj The toolbar object.
11397 * @param shrink_mode Toolbar's items display behavior.
11399 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11400 * but will enforce a minimun size so all the items will fit, won't scroll
11401 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11402 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11403 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11407 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11410 * Get the shrink mode of toolbar @p obj.
11412 * @param obj The toolbar object.
11413 * @return Toolbar's items display behavior.
11415 * @see elm_toolbar_mode_shrink_set() for details.
11419 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11422 * Enable/disable homogenous mode.
11424 * @param obj The toolbar object
11425 * @param homogeneous Assume the items within the toolbar are of the
11426 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11428 * This will enable the homogeneous mode where items are of the same size.
11429 * @see elm_toolbar_homogeneous_get()
11433 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11436 * Get whether the homogenous mode is enabled.
11438 * @param obj The toolbar object.
11439 * @return Assume the items within the toolbar are of the same height
11440 * and width (EINA_TRUE = on, EINA_FALSE = off).
11442 * @see elm_toolbar_homogeneous_set()
11446 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11449 * Enable/disable homogenous mode.
11451 * @param obj The toolbar object
11452 * @param homogeneous Assume the items within the toolbar are of the
11453 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11455 * This will enable the homogeneous mode where items are of the same size.
11456 * @see elm_toolbar_homogeneous_get()
11458 * @deprecated use elm_toolbar_homogeneous_set() instead.
11462 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11465 * Get whether the homogenous mode is enabled.
11467 * @param obj The toolbar object.
11468 * @return Assume the items within the toolbar are of the same height
11469 * and width (EINA_TRUE = on, EINA_FALSE = off).
11471 * @see elm_toolbar_homogeneous_set()
11472 * @deprecated use elm_toolbar_homogeneous_get() instead.
11476 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11479 * Set the parent object of the toolbar items' menus.
11481 * @param obj The toolbar object.
11482 * @param parent The parent of the menu objects.
11484 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11486 * For more details about setting the parent for toolbar menus, see
11487 * elm_menu_parent_set().
11489 * @see elm_menu_parent_set() for details.
11490 * @see elm_toolbar_item_menu_set() for details.
11494 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11497 * Get the parent object of the toolbar items' menus.
11499 * @param obj The toolbar object.
11500 * @return The parent of the menu objects.
11502 * @see elm_toolbar_menu_parent_set() for details.
11506 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11509 * Set the alignment of the items.
11511 * @param obj The toolbar object.
11512 * @param align The new alignment, a float between <tt> 0.0 </tt>
11513 * and <tt> 1.0 </tt>.
11515 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11516 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11519 * Centered items by default.
11521 * @see elm_toolbar_align_get()
11525 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11528 * Get the alignment of the items.
11530 * @param obj The toolbar object.
11531 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11534 * @see elm_toolbar_align_set() for details.
11538 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11541 * Set whether the toolbar item opens a menu.
11543 * @param item The toolbar item.
11544 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11546 * A toolbar item can be set to be a menu, using this function.
11548 * Once it is set to be a menu, it can be manipulated through the
11549 * menu-like function elm_toolbar_menu_parent_set() and the other
11550 * elm_menu functions, using the Evas_Object @c menu returned by
11551 * elm_toolbar_item_menu_get().
11553 * So, items to be displayed in this item's menu should be added with
11554 * elm_menu_item_add().
11556 * The following code exemplifies the most basic usage:
11558 * tb = elm_toolbar_add(win)
11559 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11560 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11561 * elm_toolbar_menu_parent_set(tb, win);
11562 * menu = elm_toolbar_item_menu_get(item);
11563 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11564 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11568 * @see elm_toolbar_item_menu_get()
11572 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11575 * Get toolbar item's menu.
11577 * @param item The toolbar item.
11578 * @return Item's menu object or @c NULL on failure.
11580 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11581 * this function will set it.
11583 * @see elm_toolbar_item_menu_set() for details.
11587 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11590 * Add a new state to @p item.
11592 * @param item The item.
11593 * @param icon A string with icon name or the absolute path of an image file.
11594 * @param label The label of the new state.
11595 * @param func The function to call when the item is clicked when this
11596 * state is selected.
11597 * @param data The data to associate with the state.
11598 * @return The toolbar item state, or @c NULL upon failure.
11600 * Toolbar will load icon image from fdo or current theme.
11601 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11602 * If an absolute path is provided it will load it direct from a file.
11604 * States created with this function can be removed with
11605 * elm_toolbar_item_state_del().
11607 * @see elm_toolbar_item_state_del()
11608 * @see elm_toolbar_item_state_sel()
11609 * @see elm_toolbar_item_state_get()
11613 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);
11616 * Delete a previoulsy added state to @p item.
11618 * @param item The toolbar item.
11619 * @param state The state to be deleted.
11620 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11622 * @see elm_toolbar_item_state_add()
11624 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11627 * Set @p state as the current state of @p it.
11629 * @param it The item.
11630 * @param state The state to use.
11631 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11633 * If @p state is @c NULL, it won't select any state and the default item's
11634 * icon and label will be used. It's the same behaviour than
11635 * elm_toolbar_item_state_unser().
11637 * @see elm_toolbar_item_state_unset()
11641 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11644 * Unset the state of @p it.
11646 * @param it The item.
11648 * The default icon and label from this item will be displayed.
11650 * @see elm_toolbar_item_state_set() for more details.
11654 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11657 * Get the current state of @p it.
11659 * @param item The item.
11660 * @return The selected state or @c NULL if none is selected or on failure.
11662 * @see elm_toolbar_item_state_set() for details.
11663 * @see elm_toolbar_item_state_unset()
11664 * @see elm_toolbar_item_state_add()
11668 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11671 * Get the state after selected state in toolbar's @p item.
11673 * @param it The toolbar item to change state.
11674 * @return The state after current state, or @c NULL on failure.
11676 * If last state is selected, this function will return first state.
11678 * @see elm_toolbar_item_state_set()
11679 * @see elm_toolbar_item_state_add()
11683 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11686 * Get the state before selected state in toolbar's @p item.
11688 * @param it The toolbar item to change state.
11689 * @return The state before current state, or @c NULL on failure.
11691 * If first state is selected, this function will return last state.
11693 * @see elm_toolbar_item_state_set()
11694 * @see elm_toolbar_item_state_add()
11698 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11701 * Set the text to be shown in a given toolbar item's tooltips.
11703 * @param item Target item.
11704 * @param text The text to set in the content.
11706 * Setup the text as tooltip to object. The item can have only one tooltip,
11707 * so any previous tooltip data - set with this function or
11708 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11710 * @see elm_object_tooltip_text_set() for more details.
11714 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11717 * Set the content to be shown in the tooltip item.
11719 * Setup the tooltip to item. The item can have only one tooltip,
11720 * so any previous tooltip data is removed. @p func(with @p data) will
11721 * be called every time that need show the tooltip and it should
11722 * return a valid Evas_Object. This object is then managed fully by
11723 * tooltip system and is deleted when the tooltip is gone.
11725 * @param item the toolbar item being attached a tooltip.
11726 * @param func the function used to create the tooltip contents.
11727 * @param data what to provide to @a func as callback data/context.
11728 * @param del_cb called when data is not needed anymore, either when
11729 * another callback replaces @a func, the tooltip is unset with
11730 * elm_toolbar_item_tooltip_unset() or the owner @a item
11731 * dies. This callback receives as the first parameter the
11732 * given @a data, and @c event_info is the item.
11734 * @see elm_object_tooltip_content_cb_set() for more details.
11738 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);
11741 * Unset tooltip from item.
11743 * @param item toolbar item to remove previously set tooltip.
11745 * Remove tooltip from item. The callback provided as del_cb to
11746 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11747 * it is not used anymore.
11749 * @see elm_object_tooltip_unset() for more details.
11750 * @see elm_toolbar_item_tooltip_content_cb_set()
11754 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11757 * Sets a different style for this item tooltip.
11759 * @note before you set a style you should define a tooltip with
11760 * elm_toolbar_item_tooltip_content_cb_set() or
11761 * elm_toolbar_item_tooltip_text_set()
11763 * @param item toolbar item with tooltip already set.
11764 * @param style the theme style to use (default, transparent, ...)
11766 * @see elm_object_tooltip_style_set() for more details.
11770 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11773 * Get the style for this item tooltip.
11775 * @param item toolbar item with tooltip already set.
11776 * @return style the theme style in use, defaults to "default". If the
11777 * object does not have a tooltip set, then NULL is returned.
11779 * @see elm_object_tooltip_style_get() for more details.
11780 * @see elm_toolbar_item_tooltip_style_set()
11784 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11787 * Set the type of mouse pointer/cursor decoration to be shown,
11788 * when the mouse pointer is over the given toolbar widget item
11790 * @param item toolbar item to customize cursor on
11791 * @param cursor the cursor type's name
11793 * This function works analogously as elm_object_cursor_set(), but
11794 * here the cursor's changing area is restricted to the item's
11795 * area, and not the whole widget's. Note that that item cursors
11796 * have precedence over widget cursors, so that a mouse over an
11797 * item with custom cursor set will always show @b that cursor.
11799 * If this function is called twice for an object, a previously set
11800 * cursor will be unset on the second call.
11802 * @see elm_object_cursor_set()
11803 * @see elm_toolbar_item_cursor_get()
11804 * @see elm_toolbar_item_cursor_unset()
11808 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11811 * Get the type of mouse pointer/cursor decoration set to be shown,
11812 * when the mouse pointer is over the given toolbar widget item
11814 * @param item toolbar item with custom cursor set
11815 * @return the cursor type's name or @c NULL, if no custom cursors
11816 * were set to @p item (and on errors)
11818 * @see elm_object_cursor_get()
11819 * @see elm_toolbar_item_cursor_set()
11820 * @see elm_toolbar_item_cursor_unset()
11824 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11827 * Unset any custom mouse pointer/cursor decoration set to be
11828 * shown, when the mouse pointer is over the given toolbar widget
11829 * item, thus making it show the @b default cursor again.
11831 * @param item a toolbar item
11833 * Use this call to undo any custom settings on this item's cursor
11834 * decoration, bringing it back to defaults (no custom style set).
11836 * @see elm_object_cursor_unset()
11837 * @see elm_toolbar_item_cursor_set()
11841 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11844 * Set a different @b style for a given custom cursor set for a
11847 * @param item toolbar item with custom cursor set
11848 * @param style the <b>theme style</b> to use (e.g. @c "default",
11849 * @c "transparent", etc)
11851 * This function only makes sense when one is using custom mouse
11852 * cursor decorations <b>defined in a theme file</b>, which can have,
11853 * given a cursor name/type, <b>alternate styles</b> on it. It
11854 * works analogously as elm_object_cursor_style_set(), but here
11855 * applyed only to toolbar item objects.
11857 * @warning Before you set a cursor style you should have definen a
11858 * custom cursor previously on the item, with
11859 * elm_toolbar_item_cursor_set()
11861 * @see elm_toolbar_item_cursor_engine_only_set()
11862 * @see elm_toolbar_item_cursor_style_get()
11866 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11869 * Get the current @b style set for a given toolbar item's custom
11872 * @param item toolbar item with custom cursor set.
11873 * @return style the cursor style in use. If the object does not
11874 * have a cursor set, then @c NULL is returned.
11876 * @see elm_toolbar_item_cursor_style_set() for more details
11880 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11883 * Set if the (custom)cursor for a given toolbar item should be
11884 * searched in its theme, also, or should only rely on the
11885 * rendering engine.
11887 * @param item item with custom (custom) cursor already set on
11888 * @param engine_only Use @c EINA_TRUE to have cursors looked for
11889 * only on those provided by the rendering engine, @c EINA_FALSE to
11890 * have them searched on the widget's theme, as well.
11892 * @note This call is of use only if you've set a custom cursor
11893 * for toolbar items, with elm_toolbar_item_cursor_set().
11895 * @note By default, cursors will only be looked for between those
11896 * provided by the rendering engine.
11900 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11903 * Get if the (custom) cursor for a given toolbar item is being
11904 * searched in its theme, also, or is only relying on the rendering
11907 * @param item a toolbar item
11908 * @return @c EINA_TRUE, if cursors are being looked for only on
11909 * those provided by the rendering engine, @c EINA_FALSE if they
11910 * are being searched on the widget's theme, as well.
11912 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11916 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11923 EAPI double elm_tooltip_delay_get(void);
11924 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
11925 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11926 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11927 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11928 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);
11929 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11930 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11931 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11932 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11933 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11934 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11935 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11936 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11937 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11938 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11939 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11940 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11943 EAPI int elm_cursor_engine_only_get(void);
11944 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
11947 * @defgroup Menu Menu
11949 * @image html img/widget/menu/preview-00.png
11950 * @image latex img/widget/menu/preview-00.eps
11952 * A menu is a list of items displayed above its parent. When the menu is
11953 * showing its parent is darkened. Each item can have a sub-menu. The menu
11954 * object can be used to display a menu on a right click event, in a toolbar,
11957 * Signals that you can add callbacks for are:
11958 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11959 * event_info is NULL.
11961 * @see @ref tutorial_menu
11964 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11966 * @brief Add a new menu to the parent
11968 * @param parent The parent object.
11969 * @return The new object or NULL if it cannot be created.
11971 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11973 * @brief Set the parent for the given menu widget
11975 * @param obj The menu object.
11976 * @param parent The new parent.
11978 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11980 * @brief Get the parent for the given menu widget
11982 * @param obj The menu object.
11983 * @return The parent.
11985 * @see elm_menu_parent_set()
11987 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11989 * @brief Move the menu to a new position
11991 * @param obj The menu object.
11992 * @param x The new position.
11993 * @param y The new position.
11995 * Sets the top-left position of the menu to (@p x,@p y).
11997 * @note @p x and @p y coordinates are relative to parent.
11999 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12001 * @brief Close a opened menu
12003 * @param obj the menu object
12006 * Hides the menu and all it's sub-menus.
12008 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12010 * @brief Returns a list of @p item's items.
12012 * @param obj The menu object
12013 * @return An Eina_List* of @p item's items
12015 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12017 * @brief Get the Evas_Object of an Elm_Menu_Item
12019 * @param item The menu item object.
12020 * @return The edje object containing the swallowed content
12022 * @warning Don't manipulate this object!
12024 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12026 * @brief Add an item at the end of the given menu widget
12028 * @param obj The menu object.
12029 * @param parent The parent menu item (optional)
12030 * @param icon A icon display on the item. The icon will be destryed by the menu.
12031 * @param label The label of the item.
12032 * @param func Function called when the user select the item.
12033 * @param data Data sent by the callback.
12034 * @return Returns the new item.
12036 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);
12038 * @brief Add an object swallowed in an item at the end of the given menu
12041 * @param obj The menu object.
12042 * @param parent The parent menu item (optional)
12043 * @param subobj The object to swallow
12044 * @param func Function called when the user select the item.
12045 * @param data Data sent by the callback.
12046 * @return Returns the new item.
12048 * Add an evas object as an item to the menu.
12050 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);
12052 * @brief Set the label of a menu item
12054 * @param item The menu item object.
12055 * @param label The label to set for @p item
12057 * @warning Don't use this funcion on items created with
12058 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12060 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12062 * @brief Get the label of a menu item
12064 * @param item The menu item object.
12065 * @return The label of @p item
12067 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12069 * @brief Set the icon of a menu item to the standard icon with name @p icon
12071 * @param item The menu item object.
12072 * @param icon The icon object to set for the content of @p item
12074 * Once this icon is set, any previously set icon will be deleted.
12076 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12078 * @brief Get the string representation from the icon of a menu item
12080 * @param item The menu item object.
12081 * @return The string representation of @p item's icon or NULL
12083 * @see elm_menu_item_object_icon_name_set()
12085 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12087 * @brief Set the content object of a menu item
12089 * @param item The menu item object
12090 * @param The content object or NULL
12091 * @return EINA_TRUE on success, else EINA_FALSE
12093 * Use this function to change the object swallowed by a menu item, deleting
12094 * any previously swallowed object.
12096 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12098 * @brief Get the content object of a menu item
12100 * @param item The menu item object
12101 * @return The content object or NULL
12102 * @note If @p item was added with elm_menu_item_add_object, this
12103 * function will return the object passed, else it will return the
12106 * @see elm_menu_item_object_content_set()
12108 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12110 * @brief Set the selected state of @p item.
12112 * @param item The menu item object.
12113 * @param selected The selected/unselected state of the item
12115 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12117 * @brief Get the selected state of @p item.
12119 * @param item The menu item object.
12120 * @return The selected/unselected state of the item
12122 * @see elm_menu_item_selected_set()
12124 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12126 * @brief Set the disabled state of @p item.
12128 * @param item The menu item object.
12129 * @param disabled The enabled/disabled state of the item
12131 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12133 * @brief Get the disabled state of @p item.
12135 * @param item The menu item object.
12136 * @return The enabled/disabled state of the item
12138 * @see elm_menu_item_disabled_set()
12140 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12142 * @brief Add a separator item to menu @p obj under @p parent.
12144 * @param obj The menu object
12145 * @param parent The item to add the separator under
12146 * @return The created item or NULL on failure
12148 * This is item is a @ref Separator.
12150 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12152 * @brief Returns whether @p item is a separator.
12154 * @param item The item to check
12155 * @return If true, @p item is a separator
12157 * @see elm_menu_item_separator_add()
12159 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12161 * @brief Deletes an item from the menu.
12163 * @param item The item to delete.
12165 * @see elm_menu_item_add()
12167 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12169 * @brief Set the function called when a menu item is deleted.
12171 * @param item The item to set the callback on
12172 * @param func The function called
12174 * @see elm_menu_item_add()
12175 * @see elm_menu_item_del()
12177 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12179 * @brief Returns the data associated with menu item @p item.
12181 * @param item The item
12182 * @return The data associated with @p item or NULL if none was set.
12184 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12186 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12188 * @brief Sets the data to be associated with menu item @p item.
12190 * @param item The item
12191 * @param data The data to be associated with @p item
12193 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12195 * @brief Returns a list of @p item's subitems.
12197 * @param item The item
12198 * @return An Eina_List* of @p item's subitems
12200 * @see elm_menu_add()
12202 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12204 * @brief Get the position of a menu item
12206 * @param item The menu item
12207 * @return The item's index
12209 * This function returns the index position of a menu item in a menu.
12210 * For a sub-menu, this number is relative to the first item in the sub-menu.
12212 * @note Index values begin with 0
12214 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12216 * @brief @brief Return a menu item's owner menu
12218 * @param item The menu item
12219 * @return The menu object owning @p item, or NULL on failure
12221 * Use this function to get the menu object owning an item.
12223 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12225 * @brief Get the selected item in the menu
12227 * @param obj The menu object
12228 * @return The selected item, or NULL if none
12230 * @see elm_menu_item_selected_get()
12231 * @see elm_menu_item_selected_set()
12233 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12235 * @brief Get the last item in the menu
12237 * @param obj The menu object
12238 * @return The last item, or NULL if none
12240 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12242 * @brief Get the first item in the menu
12244 * @param obj The menu object
12245 * @return The first item, or NULL if none
12247 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12249 * @brief Get the next item in the menu.
12251 * @param item The menu item object.
12252 * @return The item after it, or NULL if none
12254 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12256 * @brief Get the previous item in the menu.
12258 * @param item The menu item object.
12259 * @return The item before it, or NULL if none
12261 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12267 * @defgroup List List
12268 * @ingroup Elementary
12270 * @image html img/widget/list/preview-00.png
12271 * @image latex img/widget/list/preview-00.eps width=\textwidth
12273 * @image html img/list.png
12274 * @image latex img/list.eps width=\textwidth
12276 * A list widget is a container whose children are displayed vertically or
12277 * horizontally, in order, and can be selected.
12278 * The list can accept only one or multiple items selection. Also has many
12279 * modes of items displaying.
12281 * A list is a very simple type of list widget. For more robust
12282 * lists, @ref Genlist should probably be used.
12284 * Smart callbacks one can listen to:
12285 * - @c "activated" - The user has double-clicked or pressed
12286 * (enter|return|spacebar) on an item. The @c event_info parameter
12287 * is the item that was activated.
12288 * - @c "clicked,double" - The user has double-clicked an item.
12289 * The @c event_info parameter is the item that was double-clicked.
12290 * - "selected" - when the user selected an item
12291 * - "unselected" - when the user unselected an item
12292 * - "longpressed" - an item in the list is long-pressed
12293 * - "scroll,edge,top" - the list is scrolled until the top edge
12294 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12295 * - "scroll,edge,left" - the list is scrolled until the left edge
12296 * - "scroll,edge,right" - the list is scrolled until the right edge
12298 * Available styles for it:
12301 * List of examples:
12302 * @li @ref list_example_01
12303 * @li @ref list_example_02
12304 * @li @ref list_example_03
12313 * @enum _Elm_List_Mode
12314 * @typedef Elm_List_Mode
12316 * Set list's resize behavior, transverse axis scroll and
12317 * items cropping. See each mode's description for more details.
12319 * @note Default value is #ELM_LIST_SCROLL.
12321 * Values <b> don't </b> work as bitmask, only one can be choosen.
12323 * @see elm_list_mode_set()
12324 * @see elm_list_mode_get()
12328 typedef enum _Elm_List_Mode
12330 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. */
12331 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). */
12332 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. */
12333 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. */
12334 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12337 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(). */
12340 * Add a new list widget to the given parent Elementary
12341 * (container) object.
12343 * @param parent The parent object.
12344 * @return a new list widget handle or @c NULL, on errors.
12346 * This function inserts a new list widget on the canvas.
12350 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12355 * @param obj The list object
12357 * @note Call before running show() on the list object.
12358 * @warning If not called, it won't display the list properly.
12361 * li = elm_list_add(win);
12362 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12363 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12365 * evas_object_show(li);
12370 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12373 * Enable or disable multiple items selection on the list object.
12375 * @param obj The list object
12376 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12379 * Disabled by default. If disabled, the user can select a single item of
12380 * the list each time. Selected items are highlighted on list.
12381 * If enabled, many items can be selected.
12383 * If a selected item is selected again, it will be unselected.
12385 * @see elm_list_multi_select_get()
12389 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12392 * Get a value whether multiple items selection is enabled or not.
12394 * @see elm_list_multi_select_set() for details.
12396 * @param obj The list object.
12397 * @return @c EINA_TRUE means multiple items selection is enabled.
12398 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12399 * @c EINA_FALSE is returned.
12403 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12406 * Set which mode to use for the list object.
12408 * @param obj The list object
12409 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12410 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12412 * Set list's resize behavior, transverse axis scroll and
12413 * items cropping. See each mode's description for more details.
12415 * @note Default value is #ELM_LIST_SCROLL.
12417 * Only one can be set, if a previous one was set, it will be changed
12418 * by the new mode set. Bitmask won't work as well.
12420 * @see elm_list_mode_get()
12424 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12427 * Get the mode the list is at.
12429 * @param obj The list object
12430 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12431 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12433 * @note see elm_list_mode_set() for more information.
12437 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12440 * Enable or disable horizontal mode on the list object.
12442 * @param obj The list object.
12443 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12444 * disable it, i.e., to enable vertical mode.
12446 * @note Vertical mode is set by default.
12448 * On horizontal mode items are displayed on list from left to right,
12449 * instead of from top to bottom. Also, the list will scroll horizontally.
12450 * Each item will presents left icon on top and right icon, or end, at
12453 * @see elm_list_horizontal_get()
12457 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12460 * Get a value whether horizontal mode is enabled or not.
12462 * @param obj The list object.
12463 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12464 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12465 * @c EINA_FALSE is returned.
12467 * @see elm_list_horizontal_set() for details.
12471 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12474 * Enable or disable always select mode on the list object.
12476 * @param obj The list object
12477 * @param always_select @c EINA_TRUE to enable always select mode or
12478 * @c EINA_FALSE to disable it.
12480 * @note Always select mode is disabled by default.
12482 * Default behavior of list items is to only call its callback function
12483 * the first time it's pressed, i.e., when it is selected. If a selected
12484 * item is pressed again, and multi-select is disabled, it won't call
12485 * this function (if multi-select is enabled it will unselect the item).
12487 * If always select is enabled, it will call the callback function
12488 * everytime a item is pressed, so it will call when the item is selected,
12489 * and again when a selected item is pressed.
12491 * @see elm_list_always_select_mode_get()
12492 * @see elm_list_multi_select_set()
12496 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12499 * Get a value whether always select mode is enabled or not, meaning that
12500 * an item will always call its callback function, even if already selected.
12502 * @param obj The list object
12503 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12504 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12505 * @c EINA_FALSE is returned.
12507 * @see elm_list_always_select_mode_set() for details.
12511 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12514 * Set bouncing behaviour when the scrolled content reaches an edge.
12516 * Tell the internal scroller object whether it should bounce or not
12517 * when it reaches the respective edges for each axis.
12519 * @param obj The list object
12520 * @param h_bounce Whether to bounce or not in the horizontal axis.
12521 * @param v_bounce Whether to bounce or not in the vertical axis.
12523 * @see elm_scroller_bounce_set()
12527 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12530 * Get the bouncing behaviour of the internal scroller.
12532 * Get whether the internal scroller should bounce when the edge of each
12533 * axis is reached scrolling.
12535 * @param obj The list object.
12536 * @param h_bounce Pointer where to store the bounce state of the horizontal
12538 * @param v_bounce Pointer where to store the bounce state of the vertical
12541 * @see elm_scroller_bounce_get()
12542 * @see elm_list_bounce_set()
12546 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12549 * Set the scrollbar policy.
12551 * @param obj The list object
12552 * @param policy_h Horizontal scrollbar policy.
12553 * @param policy_v Vertical scrollbar policy.
12555 * This sets the scrollbar visibility policy for the given scroller.
12556 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12557 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12558 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12559 * This applies respectively for the horizontal and vertical scrollbars.
12561 * The both are disabled by default, i.e., are set to
12562 * #ELM_SCROLLER_POLICY_OFF.
12566 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12569 * Get the scrollbar policy.
12571 * @see elm_list_scroller_policy_get() for details.
12573 * @param obj The list object.
12574 * @param policy_h Pointer where to store horizontal scrollbar policy.
12575 * @param policy_v Pointer where to store vertical scrollbar policy.
12579 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);
12582 * Append a new item to the list object.
12584 * @param obj The list object.
12585 * @param label The label of the list item.
12586 * @param icon The icon object to use for the left side of the item. An
12587 * icon can be any Evas object, but usually it is an icon created
12588 * with elm_icon_add().
12589 * @param end The icon object to use for the right side of the item. An
12590 * icon can be any Evas object.
12591 * @param func The function to call when the item is clicked.
12592 * @param data The data to associate with the item for related callbacks.
12594 * @return The created item or @c NULL upon failure.
12596 * A new item will be created and appended to the list, i.e., will
12597 * be set as @b last item.
12599 * Items created with this method can be deleted with
12600 * elm_list_item_del().
12602 * Associated @p data can be properly freed when item is deleted if a
12603 * callback function is set with elm_list_item_del_cb_set().
12605 * If a function is passed as argument, it will be called everytime this item
12606 * is selected, i.e., the user clicks over an unselected item.
12607 * If always select is enabled it will call this function every time
12608 * user clicks over an item (already selected or not).
12609 * If such function isn't needed, just passing
12610 * @c NULL as @p func is enough. The same should be done for @p data.
12612 * Simple example (with no function callback or data associated):
12614 * li = elm_list_add(win);
12615 * ic = elm_icon_add(win);
12616 * elm_icon_file_set(ic, "path/to/image", NULL);
12617 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12618 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12620 * evas_object_show(li);
12623 * @see elm_list_always_select_mode_set()
12624 * @see elm_list_item_del()
12625 * @see elm_list_item_del_cb_set()
12626 * @see elm_list_clear()
12627 * @see elm_icon_add()
12631 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);
12634 * Prepend a new item to the list object.
12636 * @param obj The list object.
12637 * @param label The label of the list item.
12638 * @param icon The icon object to use for the left side of the item. An
12639 * icon can be any Evas object, but usually it is an icon created
12640 * with elm_icon_add().
12641 * @param end The icon object to use for the right side of the item. An
12642 * icon can be any Evas object.
12643 * @param func The function to call when the item is clicked.
12644 * @param data The data to associate with the item for related callbacks.
12646 * @return The created item or @c NULL upon failure.
12648 * A new item will be created and prepended to the list, i.e., will
12649 * be set as @b first item.
12651 * Items created with this method can be deleted with
12652 * elm_list_item_del().
12654 * Associated @p data can be properly freed when item is deleted if a
12655 * callback function is set with elm_list_item_del_cb_set().
12657 * If a function is passed as argument, it will be called everytime this item
12658 * is selected, i.e., the user clicks over an unselected item.
12659 * If always select is enabled it will call this function every time
12660 * user clicks over an item (already selected or not).
12661 * If such function isn't needed, just passing
12662 * @c NULL as @p func is enough. The same should be done for @p data.
12664 * @see elm_list_item_append() for a simple code example.
12665 * @see elm_list_always_select_mode_set()
12666 * @see elm_list_item_del()
12667 * @see elm_list_item_del_cb_set()
12668 * @see elm_list_clear()
12669 * @see elm_icon_add()
12673 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);
12676 * Insert a new item into the list object before item @p before.
12678 * @param obj The list object.
12679 * @param before The list item to insert before.
12680 * @param label The label of the list item.
12681 * @param icon The icon object to use for the left side of the item. An
12682 * icon can be any Evas object, but usually it is an icon created
12683 * with elm_icon_add().
12684 * @param end The icon object to use for the right side of the item. An
12685 * icon can be any Evas object.
12686 * @param func The function to call when the item is clicked.
12687 * @param data The data to associate with the item for related callbacks.
12689 * @return The created item or @c NULL upon failure.
12691 * A new item will be created and added to the list. Its position in
12692 * this list will be just before item @p before.
12694 * Items created with this method can be deleted with
12695 * elm_list_item_del().
12697 * Associated @p data can be properly freed when item is deleted if a
12698 * callback function is set with elm_list_item_del_cb_set().
12700 * If a function is passed as argument, it will be called everytime this item
12701 * is selected, i.e., the user clicks over an unselected item.
12702 * If always select is enabled it will call this function every time
12703 * user clicks over an item (already selected or not).
12704 * If such function isn't needed, just passing
12705 * @c NULL as @p func is enough. The same should be done for @p data.
12707 * @see elm_list_item_append() for a simple code example.
12708 * @see elm_list_always_select_mode_set()
12709 * @see elm_list_item_del()
12710 * @see elm_list_item_del_cb_set()
12711 * @see elm_list_clear()
12712 * @see elm_icon_add()
12716 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);
12719 * Insert a new item into the list object after item @p after.
12721 * @param obj The list object.
12722 * @param after The list item to insert after.
12723 * @param label The label of the list item.
12724 * @param icon The icon object to use for the left side of the item. An
12725 * icon can be any Evas object, but usually it is an icon created
12726 * with elm_icon_add().
12727 * @param end The icon object to use for the right side of the item. An
12728 * icon can be any Evas object.
12729 * @param func The function to call when the item is clicked.
12730 * @param data The data to associate with the item for related callbacks.
12732 * @return The created item or @c NULL upon failure.
12734 * A new item will be created and added to the list. Its position in
12735 * this list will be just after item @p after.
12737 * Items created with this method can be deleted with
12738 * elm_list_item_del().
12740 * Associated @p data can be properly freed when item is deleted if a
12741 * callback function is set with elm_list_item_del_cb_set().
12743 * If a function is passed as argument, it will be called everytime this item
12744 * is selected, i.e., the user clicks over an unselected item.
12745 * If always select is enabled it will call this function every time
12746 * user clicks over an item (already selected or not).
12747 * If such function isn't needed, just passing
12748 * @c NULL as @p func is enough. The same should be done for @p data.
12750 * @see elm_list_item_append() for a simple code example.
12751 * @see elm_list_always_select_mode_set()
12752 * @see elm_list_item_del()
12753 * @see elm_list_item_del_cb_set()
12754 * @see elm_list_clear()
12755 * @see elm_icon_add()
12759 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);
12762 * Insert a new item into the sorted list object.
12764 * @param obj The list object.
12765 * @param label The label of the list item.
12766 * @param icon The icon object to use for the left side of the item. An
12767 * icon can be any Evas object, but usually it is an icon created
12768 * with elm_icon_add().
12769 * @param end The icon object to use for the right side of the item. An
12770 * icon can be any Evas object.
12771 * @param func The function to call when the item is clicked.
12772 * @param data The data to associate with the item for related callbacks.
12773 * @param cmp_func The comparing function to be used to sort list
12774 * items <b>by #Elm_List_Item item handles</b>. This function will
12775 * receive two items and compare them, returning a non-negative integer
12776 * if the second item should be place after the first, or negative value
12777 * if should be placed before.
12779 * @return The created item or @c NULL upon failure.
12781 * @note This function inserts values into a list object assuming it was
12782 * sorted and the result will be sorted.
12784 * A new item will be created and added to the list. Its position in
12785 * this list will be found comparing the new item with previously inserted
12786 * items using function @p cmp_func.
12788 * Items created with this method can be deleted with
12789 * elm_list_item_del().
12791 * Associated @p data can be properly freed when item is deleted if a
12792 * callback function is set with elm_list_item_del_cb_set().
12794 * If a function is passed as argument, it will be called everytime this item
12795 * is selected, i.e., the user clicks over an unselected item.
12796 * If always select is enabled it will call this function every time
12797 * user clicks over an item (already selected or not).
12798 * If such function isn't needed, just passing
12799 * @c NULL as @p func is enough. The same should be done for @p data.
12801 * @see elm_list_item_append() for a simple code example.
12802 * @see elm_list_always_select_mode_set()
12803 * @see elm_list_item_del()
12804 * @see elm_list_item_del_cb_set()
12805 * @see elm_list_clear()
12806 * @see elm_icon_add()
12810 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);
12813 * Remove all list's items.
12815 * @param obj The list object
12817 * @see elm_list_item_del()
12818 * @see elm_list_item_append()
12822 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12825 * Get a list of all the list items.
12827 * @param obj The list object
12828 * @return An @c Eina_List of list items, #Elm_List_Item,
12829 * or @c NULL on failure.
12831 * @see elm_list_item_append()
12832 * @see elm_list_item_del()
12833 * @see elm_list_clear()
12837 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12840 * Get the selected item.
12842 * @param obj The list object.
12843 * @return The selected list item.
12845 * The selected item can be unselected with function
12846 * elm_list_item_selected_set().
12848 * The selected item always will be highlighted on list.
12850 * @see elm_list_selected_items_get()
12854 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12857 * Return a list of the currently selected list items.
12859 * @param obj The list object.
12860 * @return An @c Eina_List of list items, #Elm_List_Item,
12861 * or @c NULL on failure.
12863 * Multiple items can be selected if multi select is enabled. It can be
12864 * done with elm_list_multi_select_set().
12866 * @see elm_list_selected_item_get()
12867 * @see elm_list_multi_select_set()
12871 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12874 * Set the selected state of an item.
12876 * @param item The list item
12877 * @param selected The selected state
12879 * This sets the selected state of the given item @p it.
12880 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12882 * If a new item is selected the previosly selected will be unselected,
12883 * unless multiple selection is enabled with elm_list_multi_select_set().
12884 * Previoulsy selected item can be get with function
12885 * elm_list_selected_item_get().
12887 * Selected items will be highlighted.
12889 * @see elm_list_item_selected_get()
12890 * @see elm_list_selected_item_get()
12891 * @see elm_list_multi_select_set()
12895 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12898 * Get whether the @p item is selected or not.
12900 * @param item The list item.
12901 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12902 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12904 * @see elm_list_selected_item_set() for details.
12905 * @see elm_list_item_selected_get()
12909 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12912 * Set or unset item as a separator.
12914 * @param it The list item.
12915 * @param setting @c EINA_TRUE to set item @p it as separator or
12916 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12918 * Items aren't set as separator by default.
12920 * If set as separator it will display separator theme, so won't display
12923 * @see elm_list_item_separator_get()
12927 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12930 * Get a value whether item is a separator or not.
12932 * @see elm_list_item_separator_set() for details.
12934 * @param it The list item.
12935 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12936 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12940 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12943 * Show @p item in the list view.
12945 * @param item The list item to be shown.
12947 * It won't animate list until item is visible. If such behavior is wanted,
12948 * use elm_list_bring_in() intead.
12952 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12955 * Bring in the given item to list view.
12957 * @param item The item.
12959 * This causes list to jump to the given item @p item and show it
12960 * (by scrolling), if it is not fully visible.
12962 * This may use animation to do so and take a period of time.
12964 * If animation isn't wanted, elm_list_item_show() can be used.
12968 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12971 * Delete them item from the list.
12973 * @param item The item of list to be deleted.
12975 * If deleting all list items is required, elm_list_clear()
12976 * should be used instead of getting items list and deleting each one.
12978 * @see elm_list_clear()
12979 * @see elm_list_item_append()
12980 * @see elm_list_item_del_cb_set()
12984 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12987 * Set the function called when a list item is freed.
12989 * @param item The item to set the callback on
12990 * @param func The function called
12992 * If there is a @p func, then it will be called prior item's memory release.
12993 * That will be called with the following arguments:
12995 * @li item's Evas object;
12998 * This way, a data associated to a list item could be properly freed.
13002 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13005 * Get the data associated to the item.
13007 * @param item The list item
13008 * @return The data associated to @p item
13010 * The return value is a pointer to data associated to @p item when it was
13011 * created, with function elm_list_item_append() or similar. If no data
13012 * was passed as argument, it will return @c NULL.
13014 * @see elm_list_item_append()
13018 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13021 * Get the left side icon associated to the item.
13023 * @param item The list item
13024 * @return The left side icon associated to @p item
13026 * The return value is a pointer to the icon associated to @p item when
13028 * created, with function elm_list_item_append() or similar, or later
13029 * with function elm_list_item_icon_set(). If no icon
13030 * was passed as argument, it will return @c NULL.
13032 * @see elm_list_item_append()
13033 * @see elm_list_item_icon_set()
13037 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13040 * Set the left side icon associated to the item.
13042 * @param item The list item
13043 * @param icon The left side icon object to associate with @p item
13045 * The icon object to use at left side of the item. An
13046 * icon can be any Evas object, but usually it is an icon created
13047 * with elm_icon_add().
13049 * Once the icon object is set, a previously set one will be deleted.
13050 * @warning Setting the same icon for two items will cause the icon to
13051 * dissapear from the first item.
13053 * If an icon was passed as argument on item creation, with function
13054 * elm_list_item_append() or similar, it will be already
13055 * associated to the item.
13057 * @see elm_list_item_append()
13058 * @see elm_list_item_icon_get()
13062 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13065 * Get the right side icon associated to the item.
13067 * @param item The list item
13068 * @return The right side icon associated to @p item
13070 * The return value is a pointer to the icon associated to @p item when
13072 * created, with function elm_list_item_append() or similar, or later
13073 * with function elm_list_item_icon_set(). If no icon
13074 * was passed as argument, it will return @c NULL.
13076 * @see elm_list_item_append()
13077 * @see elm_list_item_icon_set()
13081 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13084 * Set the right side icon associated to the item.
13086 * @param item The list item
13087 * @param end The right side icon object to associate with @p item
13089 * The icon object to use at right side of the item. An
13090 * icon can be any Evas object, but usually it is an icon created
13091 * with elm_icon_add().
13093 * Once the icon object is set, a previously set one will be deleted.
13094 * @warning Setting the same icon for two items will cause the icon to
13095 * dissapear from the first item.
13097 * If an icon was passed as argument on item creation, with function
13098 * elm_list_item_append() or similar, it will be already
13099 * associated to the item.
13101 * @see elm_list_item_append()
13102 * @see elm_list_item_end_get()
13106 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13109 * Gets the base object of the item.
13111 * @param item The list item
13112 * @return The base object associated with @p item
13114 * Base object is the @c Evas_Object that represents that item.
13118 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13121 * Get the label of item.
13123 * @param item The item of list.
13124 * @return The label of item.
13126 * The return value is a pointer to the label associated to @p item when
13127 * it was created, with function elm_list_item_append(), or later
13128 * with function elm_list_item_label_set. If no label
13129 * was passed as argument, it will return @c NULL.
13131 * @see elm_list_item_label_set() for more details.
13132 * @see elm_list_item_append()
13136 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13139 * Set the label of item.
13141 * @param item The item of list.
13142 * @param text The label of item.
13144 * The label to be displayed by the item.
13145 * Label will be placed between left and right side icons (if set).
13147 * If a label was passed as argument on item creation, with function
13148 * elm_list_item_append() or similar, it will be already
13149 * displayed by the item.
13151 * @see elm_list_item_label_get()
13152 * @see elm_list_item_append()
13156 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13160 * Get the item before @p it in list.
13162 * @param it The list item.
13163 * @return The item before @p it, or @c NULL if none or on failure.
13165 * @note If it is the first item, @c NULL will be returned.
13167 * @see elm_list_item_append()
13168 * @see elm_list_items_get()
13172 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13175 * Get the item after @p it in list.
13177 * @param it The list item.
13178 * @return The item after @p it, or @c NULL if none or on failure.
13180 * @note If it is the last item, @c NULL will be returned.
13182 * @see elm_list_item_append()
13183 * @see elm_list_items_get()
13187 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13190 * Sets the disabled/enabled state of a list item.
13192 * @param it The item.
13193 * @param disabled The disabled state.
13195 * A disabled item cannot be selected or unselected. It will also
13196 * change its appearance (generally greyed out). This sets the
13197 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13202 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13205 * Get a value whether list item is disabled or not.
13207 * @param it The item.
13208 * @return The disabled state.
13210 * @see elm_list_item_disabled_set() for more details.
13214 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13217 * Set the text to be shown in a given list item's tooltips.
13219 * @param item Target item.
13220 * @param text The text to set in the content.
13222 * Setup the text as tooltip to object. The item can have only one tooltip,
13223 * so any previous tooltip data - set with this function or
13224 * elm_list_item_tooltip_content_cb_set() - is removed.
13226 * @see elm_object_tooltip_text_set() for more details.
13230 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13234 * @brief Disable size restrictions on an object's tooltip
13235 * @param item The tooltip's anchor object
13236 * @param disable If EINA_TRUE, size restrictions are disabled
13237 * @return EINA_FALSE on failure, EINA_TRUE on success
13239 * This function allows a tooltip to expand beyond its parant window's canvas.
13240 * It will instead be limited only by the size of the display.
13242 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13244 * @brief Retrieve size restriction state of an object's tooltip
13245 * @param obj The tooltip's anchor object
13246 * @return If EINA_TRUE, size restrictions are disabled
13248 * This function returns whether a tooltip is allowed to expand beyond
13249 * its parant window's canvas.
13250 * It will instead be limited only by the size of the display.
13252 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13255 * Set the content to be shown in the tooltip item.
13257 * Setup the tooltip to item. The item can have only one tooltip,
13258 * so any previous tooltip data is removed. @p func(with @p data) will
13259 * be called every time that need show the tooltip and it should
13260 * return a valid Evas_Object. This object is then managed fully by
13261 * tooltip system and is deleted when the tooltip is gone.
13263 * @param item the list item being attached a tooltip.
13264 * @param func the function used to create the tooltip contents.
13265 * @param data what to provide to @a func as callback data/context.
13266 * @param del_cb called when data is not needed anymore, either when
13267 * another callback replaces @a func, the tooltip is unset with
13268 * elm_list_item_tooltip_unset() or the owner @a item
13269 * dies. This callback receives as the first parameter the
13270 * given @a data, and @c event_info is the item.
13272 * @see elm_object_tooltip_content_cb_set() for more details.
13276 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);
13279 * Unset tooltip from item.
13281 * @param item list item to remove previously set tooltip.
13283 * Remove tooltip from item. The callback provided as del_cb to
13284 * elm_list_item_tooltip_content_cb_set() will be called to notify
13285 * it is not used anymore.
13287 * @see elm_object_tooltip_unset() for more details.
13288 * @see elm_list_item_tooltip_content_cb_set()
13292 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13295 * Sets a different style for this item tooltip.
13297 * @note before you set a style you should define a tooltip with
13298 * elm_list_item_tooltip_content_cb_set() or
13299 * elm_list_item_tooltip_text_set()
13301 * @param item list item with tooltip already set.
13302 * @param style the theme style to use (default, transparent, ...)
13304 * @see elm_object_tooltip_style_set() for more details.
13308 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13311 * Get the style for this item tooltip.
13313 * @param item list item with tooltip already set.
13314 * @return style the theme style in use, defaults to "default". If the
13315 * object does not have a tooltip set, then NULL is returned.
13317 * @see elm_object_tooltip_style_get() for more details.
13318 * @see elm_list_item_tooltip_style_set()
13322 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13325 * Set the type of mouse pointer/cursor decoration to be shown,
13326 * when the mouse pointer is over the given list widget item
13328 * @param item list item to customize cursor on
13329 * @param cursor the cursor type's name
13331 * This function works analogously as elm_object_cursor_set(), but
13332 * here the cursor's changing area is restricted to the item's
13333 * area, and not the whole widget's. Note that that item cursors
13334 * have precedence over widget cursors, so that a mouse over an
13335 * item with custom cursor set will always show @b that cursor.
13337 * If this function is called twice for an object, a previously set
13338 * cursor will be unset on the second call.
13340 * @see elm_object_cursor_set()
13341 * @see elm_list_item_cursor_get()
13342 * @see elm_list_item_cursor_unset()
13346 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13349 * Get the type of mouse pointer/cursor decoration set to be shown,
13350 * when the mouse pointer is over the given list widget item
13352 * @param item list item with custom cursor set
13353 * @return the cursor type's name or @c NULL, if no custom cursors
13354 * were set to @p item (and on errors)
13356 * @see elm_object_cursor_get()
13357 * @see elm_list_item_cursor_set()
13358 * @see elm_list_item_cursor_unset()
13362 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13365 * Unset any custom mouse pointer/cursor decoration set to be
13366 * shown, when the mouse pointer is over the given list widget
13367 * item, thus making it show the @b default cursor again.
13369 * @param item a list item
13371 * Use this call to undo any custom settings on this item's cursor
13372 * decoration, bringing it back to defaults (no custom style set).
13374 * @see elm_object_cursor_unset()
13375 * @see elm_list_item_cursor_set()
13379 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13382 * Set a different @b style for a given custom cursor set for a
13385 * @param item list item with custom cursor set
13386 * @param style the <b>theme style</b> to use (e.g. @c "default",
13387 * @c "transparent", etc)
13389 * This function only makes sense when one is using custom mouse
13390 * cursor decorations <b>defined in a theme file</b>, which can have,
13391 * given a cursor name/type, <b>alternate styles</b> on it. It
13392 * works analogously as elm_object_cursor_style_set(), but here
13393 * applyed only to list item objects.
13395 * @warning Before you set a cursor style you should have definen a
13396 * custom cursor previously on the item, with
13397 * elm_list_item_cursor_set()
13399 * @see elm_list_item_cursor_engine_only_set()
13400 * @see elm_list_item_cursor_style_get()
13404 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13407 * Get the current @b style set for a given list item's custom
13410 * @param item list item with custom cursor set.
13411 * @return style the cursor style in use. If the object does not
13412 * have a cursor set, then @c NULL is returned.
13414 * @see elm_list_item_cursor_style_set() for more details
13418 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13421 * Set if the (custom)cursor for a given list item should be
13422 * searched in its theme, also, or should only rely on the
13423 * rendering engine.
13425 * @param item item with custom (custom) cursor already set on
13426 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13427 * only on those provided by the rendering engine, @c EINA_FALSE to
13428 * have them searched on the widget's theme, as well.
13430 * @note This call is of use only if you've set a custom cursor
13431 * for list items, with elm_list_item_cursor_set().
13433 * @note By default, cursors will only be looked for between those
13434 * provided by the rendering engine.
13438 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13441 * Get if the (custom) cursor for a given list item is being
13442 * searched in its theme, also, or is only relying on the rendering
13445 * @param item a list item
13446 * @return @c EINA_TRUE, if cursors are being looked for only on
13447 * those provided by the rendering engine, @c EINA_FALSE if they
13448 * are being searched on the widget's theme, as well.
13450 * @see elm_list_item_cursor_engine_only_set(), for more details
13454 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13461 * @defgroup Slider Slider
13462 * @ingroup Elementary
13464 * @image html img/widget/slider/preview-00.png
13465 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13467 * The slider adds a dragable “slider” widget for selecting the value of
13468 * something within a range.
13470 * A slider can be horizontal or vertical. It can contain an Icon and has a
13471 * primary label as well as a units label (that is formatted with floating
13472 * point values and thus accepts a printf-style format string, like
13473 * “%1.2f units”. There is also an indicator string that may be somewhere
13474 * else (like on the slider itself) that also accepts a format string like
13475 * units. Label, Icon Unit and Indicator strings/objects are optional.
13477 * A slider may be inverted which means values invert, with high vales being
13478 * on the left or top and low values on the right or bottom (as opposed to
13479 * normally being low on the left or top and high on the bottom and right).
13481 * The slider should have its minimum and maximum values set by the
13482 * application with elm_slider_min_max_set() and value should also be set by
13483 * the application before use with elm_slider_value_set(). The span of the
13484 * slider is its length (horizontally or vertically). This will be scaled by
13485 * the object or applications scaling factor. At any point code can query the
13486 * slider for its value with elm_slider_value_get().
13488 * Smart callbacks one can listen to:
13489 * - "changed" - Whenever the slider value is changed by the user.
13490 * - "slider,drag,start" - dragging the slider indicator around has started.
13491 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13492 * - "delay,changed" - A short time after the value is changed by the user.
13493 * This will be called only when the user stops dragging for
13494 * a very short period or when they release their
13495 * finger/mouse, so it avoids possibly expensive reactions to
13496 * the value change.
13498 * Available styles for it:
13501 * Here is an example on its usage:
13502 * @li @ref slider_example
13506 * @addtogroup Slider
13511 * Add a new slider widget to the given parent Elementary
13512 * (container) object.
13514 * @param parent The parent object.
13515 * @return a new slider widget handle or @c NULL, on errors.
13517 * This function inserts a new slider widget on the canvas.
13521 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13524 * Set the label of a given slider widget
13526 * @param obj The progress bar object
13527 * @param label The text label string, in UTF-8
13530 * @deprecated use elm_object_text_set() instead.
13532 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13535 * Get the label of a given slider widget
13537 * @param obj The progressbar object
13538 * @return The text label string, in UTF-8
13541 * @deprecated use elm_object_text_get() instead.
13543 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13546 * Set the icon object of the slider object.
13548 * @param obj The slider object.
13549 * @param icon The icon object.
13551 * On horizontal mode, icon is placed at left, and on vertical mode,
13554 * @note Once the icon object is set, a previously set one will be deleted.
13555 * If you want to keep that old content object, use the
13556 * elm_slider_icon_unset() function.
13558 * @warning If the object being set does not have minimum size hints set,
13559 * it won't get properly displayed.
13563 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13566 * Unset an icon set on a given slider widget.
13568 * @param obj The slider object.
13569 * @return The icon object that was being used, if any was set, or
13570 * @c NULL, otherwise (and on errors).
13572 * On horizontal mode, icon is placed at left, and on vertical mode,
13575 * This call will unparent and return the icon object which was set
13576 * for this widget, previously, on success.
13578 * @see elm_slider_icon_set() for more details
13579 * @see elm_slider_icon_get()
13583 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13586 * Retrieve the icon object set for a given slider widget.
13588 * @param obj The slider object.
13589 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13590 * otherwise (and on errors).
13592 * On horizontal mode, icon is placed at left, and on vertical mode,
13595 * @see elm_slider_icon_set() for more details
13596 * @see elm_slider_icon_unset()
13600 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13603 * Set the end object of the slider object.
13605 * @param obj The slider object.
13606 * @param end The end object.
13608 * On horizontal mode, end is placed at left, and on vertical mode,
13609 * placed at bottom.
13611 * @note Once the icon object is set, a previously set one will be deleted.
13612 * If you want to keep that old content object, use the
13613 * elm_slider_end_unset() function.
13615 * @warning If the object being set does not have minimum size hints set,
13616 * it won't get properly displayed.
13620 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13623 * Unset an end object set on a given slider widget.
13625 * @param obj The slider object.
13626 * @return The end object that was being used, if any was set, or
13627 * @c NULL, otherwise (and on errors).
13629 * On horizontal mode, end is placed at left, and on vertical mode,
13630 * placed at bottom.
13632 * This call will unparent and return the icon object which was set
13633 * for this widget, previously, on success.
13635 * @see elm_slider_end_set() for more details.
13636 * @see elm_slider_end_get()
13640 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13643 * Retrieve the end object set for a given slider widget.
13645 * @param obj The slider object.
13646 * @return The end object's handle, if @p obj had one set, or @c NULL,
13647 * otherwise (and on errors).
13649 * On horizontal mode, icon is placed at right, and on vertical mode,
13650 * placed at bottom.
13652 * @see elm_slider_end_set() for more details.
13653 * @see elm_slider_end_unset()
13657 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13660 * Set the (exact) length of the bar region of a given slider widget.
13662 * @param obj The slider object.
13663 * @param size The length of the slider's bar region.
13665 * This sets the minimum width (when in horizontal mode) or height
13666 * (when in vertical mode) of the actual bar area of the slider
13667 * @p obj. This in turn affects the object's minimum size. Use
13668 * this when you're not setting other size hints expanding on the
13669 * given direction (like weight and alignment hints) and you would
13670 * like it to have a specific size.
13672 * @note Icon, end, label, indicator and unit text around @p obj
13673 * will require their
13674 * own space, which will make @p obj to require more the @p size,
13677 * @see elm_slider_span_size_get()
13681 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13684 * Get the length set for the bar region of a given slider widget
13686 * @param obj The slider object.
13687 * @return The length of the slider's bar region.
13689 * If that size was not set previously, with
13690 * elm_slider_span_size_set(), this call will return @c 0.
13694 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13697 * Set the format string for the unit label.
13699 * @param obj The slider object.
13700 * @param format The format string for the unit display.
13702 * Unit label is displayed all the time, if set, after slider's bar.
13703 * In horizontal mode, at right and in vertical mode, at bottom.
13705 * If @c NULL, unit label won't be visible. If not it sets the format
13706 * string for the label text. To the label text is provided a floating point
13707 * value, so the label text can display up to 1 floating point value.
13708 * Note that this is optional.
13710 * Use a format string such as "%1.2f meters" for example, and it will
13711 * display values like: "3.14 meters" for a value equal to 3.14159.
13713 * Default is unit label disabled.
13715 * @see elm_slider_indicator_format_get()
13719 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13722 * Get the unit label format of the slider.
13724 * @param obj The slider object.
13725 * @return The unit label format string in UTF-8.
13727 * Unit label is displayed all the time, if set, after slider's bar.
13728 * In horizontal mode, at right and in vertical mode, at bottom.
13730 * @see elm_slider_unit_format_set() for more
13731 * information on how this works.
13735 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13738 * Set the format string for the indicator label.
13740 * @param obj The slider object.
13741 * @param indicator The format string for the indicator display.
13743 * The slider may display its value somewhere else then unit label,
13744 * for example, above the slider knob that is dragged around. This function
13745 * sets the format string used for this.
13747 * If @c NULL, indicator label won't be visible. If not it sets the format
13748 * string for the label text. To the label text is provided a floating point
13749 * value, so the label text can display up to 1 floating point value.
13750 * Note that this is optional.
13752 * Use a format string such as "%1.2f meters" for example, and it will
13753 * display values like: "3.14 meters" for a value equal to 3.14159.
13755 * Default is indicator label disabled.
13757 * @see elm_slider_indicator_format_get()
13761 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13764 * Get the indicator label format of the slider.
13766 * @param obj The slider object.
13767 * @return The indicator label format string in UTF-8.
13769 * The slider may display its value somewhere else then unit label,
13770 * for example, above the slider knob that is dragged around. This function
13771 * gets the format string used for this.
13773 * @see elm_slider_indicator_format_set() for more
13774 * information on how this works.
13778 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13781 * Set the format function pointer for the indicator label
13783 * @param obj The slider object.
13784 * @param func The indicator format function.
13785 * @param free_func The freeing function for the format string.
13787 * Set the callback function to format the indicator string.
13789 * @see elm_slider_indicator_format_set() for more info on how this works.
13793 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);
13796 * Set the format function pointer for the units label
13798 * @param obj The slider object.
13799 * @param func The units format function.
13800 * @param free_func The freeing function for the format string.
13802 * Set the callback function to format the indicator string.
13804 * @see elm_slider_units_format_set() for more info on how this works.
13808 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);
13811 * Set the orientation of a given slider widget.
13813 * @param obj The slider object.
13814 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13815 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13817 * Use this function to change how your slider is to be
13818 * disposed: vertically or horizontally.
13820 * By default it's displayed horizontally.
13822 * @see elm_slider_horizontal_get()
13826 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13829 * Retrieve the orientation of a given slider widget
13831 * @param obj The slider object.
13832 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13833 * @c EINA_FALSE if it's @b vertical (and on errors).
13835 * @see elm_slider_horizontal_set() for more details.
13839 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13842 * Set the minimum and maximum values for the slider.
13844 * @param obj The slider object.
13845 * @param min The minimum value.
13846 * @param max The maximum value.
13848 * Define the allowed range of values to be selected by the user.
13850 * If actual value is less than @p min, it will be updated to @p min. If it
13851 * is bigger then @p max, will be updated to @p max. Actual value can be
13852 * get with elm_slider_value_get().
13854 * By default, min is equal to 0.0, and max is equal to 1.0.
13856 * @warning Maximum must be greater than minimum, otherwise behavior
13859 * @see elm_slider_min_max_get()
13863 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13866 * Get the minimum and maximum values of the slider.
13868 * @param obj The slider object.
13869 * @param min Pointer where to store the minimum value.
13870 * @param max Pointer where to store the maximum value.
13872 * @note If only one value is needed, the other pointer can be passed
13875 * @see elm_slider_min_max_set() for details.
13879 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13882 * Set the value the slider displays.
13884 * @param obj The slider object.
13885 * @param val The value to be displayed.
13887 * Value will be presented on the unit label following format specified with
13888 * elm_slider_unit_format_set() and on indicator with
13889 * elm_slider_indicator_format_set().
13891 * @warning The value must to be between min and max values. This values
13892 * are set by elm_slider_min_max_set().
13894 * @see elm_slider_value_get()
13895 * @see elm_slider_unit_format_set()
13896 * @see elm_slider_indicator_format_set()
13897 * @see elm_slider_min_max_set()
13901 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13904 * Get the value displayed by the spinner.
13906 * @param obj The spinner object.
13907 * @return The value displayed.
13909 * @see elm_spinner_value_set() for details.
13913 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13916 * Invert a given slider widget's displaying values order
13918 * @param obj The slider object.
13919 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13920 * @c EINA_FALSE to bring it back to default, non-inverted values.
13922 * A slider may be @b inverted, in which state it gets its
13923 * values inverted, with high vales being on the left or top and
13924 * low values on the right or bottom, as opposed to normally have
13925 * the low values on the former and high values on the latter,
13926 * respectively, for horizontal and vertical modes.
13928 * @see elm_slider_inverted_get()
13932 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13935 * Get whether a given slider widget's displaying values are
13938 * @param obj The slider object.
13939 * @return @c EINA_TRUE, if @p obj has inverted values,
13940 * @c EINA_FALSE otherwise (and on errors).
13942 * @see elm_slider_inverted_set() for more details.
13946 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13949 * Set whether to enlarge slider indicator (augmented knob) or not.
13951 * @param obj The slider object.
13952 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13953 * let the knob always at default size.
13955 * By default, indicator will be bigger while dragged by the user.
13957 * @warning It won't display values set with
13958 * elm_slider_indicator_format_set() if you disable indicator.
13962 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13965 * Get whether a given slider widget's enlarging indicator or not.
13967 * @param obj The slider object.
13968 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13969 * @c EINA_FALSE otherwise (and on errors).
13971 * @see elm_slider_indicator_show_set() for details.
13975 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13982 * @addtogroup Actionslider Actionslider
13984 * @image html img/widget/actionslider/preview-00.png
13985 * @image latex img/widget/actionslider/preview-00.eps
13987 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13988 * properties. The indicator is the element the user drags to choose a label.
13989 * When the position is set with magnet, when released the indicator will be
13990 * moved to it if it's nearest the magnetized position.
13992 * @note By default all positions are set as enabled.
13994 * Signals that you can add callbacks for are:
13996 * "selected" - when user selects an enabled position (the label is passed
13999 * "pos_changed" - when the indicator reaches any of the positions("left",
14000 * "right" or "center").
14002 * See an example of actionslider usage @ref actionslider_example_page "here"
14005 typedef enum _Elm_Actionslider_Pos
14007 ELM_ACTIONSLIDER_NONE = 0,
14008 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14009 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14010 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14011 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14012 } Elm_Actionslider_Pos;
14015 * Add a new actionslider to the parent.
14017 * @param parent The parent object
14018 * @return The new actionslider object or NULL if it cannot be created
14020 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14022 * Set actionslider labels.
14024 * @param obj The actionslider object
14025 * @param left_label The label to be set on the left.
14026 * @param center_label The label to be set on the center.
14027 * @param right_label The label to be set on the right.
14028 * @deprecated use elm_object_text_set() instead.
14030 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);
14032 * Get actionslider labels.
14034 * @param obj The actionslider object
14035 * @param left_label A char** to place the left_label of @p obj into.
14036 * @param center_label A char** to place the center_label of @p obj into.
14037 * @param right_label A char** to place the right_label of @p obj into.
14038 * @deprecated use elm_object_text_set() instead.
14040 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);
14042 * Get actionslider selected label.
14044 * @param obj The actionslider object
14045 * @return The selected label
14047 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14049 * Set actionslider indicator position.
14051 * @param obj The actionslider object.
14052 * @param pos The position of the indicator.
14054 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14056 * Get actionslider indicator position.
14058 * @param obj The actionslider object.
14059 * @return The position of the indicator.
14061 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14063 * Set actionslider magnet position. To make multiple positions magnets @c or
14064 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14066 * @param obj The actionslider object.
14067 * @param pos Bit mask indicating the magnet positions.
14069 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14071 * Get actionslider magnet position.
14073 * @param obj The actionslider object.
14074 * @return The positions with magnet property.
14076 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14078 * Set actionslider enabled position. To set multiple positions as enabled @c or
14079 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14081 * @note All the positions are enabled by default.
14083 * @param obj The actionslider object.
14084 * @param pos Bit mask indicating the enabled positions.
14086 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14088 * Get actionslider enabled position.
14090 * @param obj The actionslider object.
14091 * @return The enabled positions.
14093 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14095 * Set the label used on the indicator.
14097 * @param obj The actionslider object
14098 * @param label The label to be set on the indicator.
14099 * @deprecated use elm_object_text_set() instead.
14101 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14103 * Get the label used on the indicator object.
14105 * @param obj The actionslider object
14106 * @return The indicator label
14107 * @deprecated use elm_object_text_get() instead.
14109 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14115 * @defgroup Genlist Genlist
14117 * @image html img/widget/genlist/preview-00.png
14118 * @image latex img/widget/genlist/preview-00.eps
14119 * @image html img/genlist.png
14120 * @image latex img/genlist.eps
14122 * This widget aims to have more expansive list than the simple list in
14123 * Elementary that could have more flexible items and allow many more entries
14124 * while still being fast and low on memory usage. At the same time it was
14125 * also made to be able to do tree structures. But the price to pay is more
14126 * complexity when it comes to usage. If all you want is a simple list with
14127 * icons and a single label, use the normal @ref List object.
14129 * Genlist has a fairly large API, mostly because it's relatively complex,
14130 * trying to be both expansive, powerful and efficient. First we will begin
14131 * an overview on the theory behind genlist.
14133 * @section Genlist_Item_Class Genlist item classes - creating items
14135 * In order to have the ability to add and delete items on the fly, genlist
14136 * implements a class (callback) system where the application provides a
14137 * structure with information about that type of item (genlist may contain
14138 * multiple different items with different classes, states and styles).
14139 * Genlist will call the functions in this struct (methods) when an item is
14140 * "realized" (i.e., created dynamically, while the user is scrolling the
14141 * grid). All objects will simply be deleted when no longer needed with
14142 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14143 * following members:
14144 * - @c item_style - This is a constant string and simply defines the name
14145 * of the item style. It @b must be specified and the default should be @c
14147 * - @c mode_item_style - This is a constant string and simply defines the
14148 * name of the style that will be used for mode animations. It can be left
14149 * as @c NULL if you don't plan to use Genlist mode. See
14150 * elm_genlist_item_mode_set() for more info.
14152 * - @c func - A struct with pointers to functions that will be called when
14153 * an item is going to be actually created. All of them receive a @c data
14154 * parameter that will point to the same data passed to
14155 * elm_genlist_item_append() and related item creation functions, and a @c
14156 * obj parameter that points to the genlist object itself.
14158 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14159 * state_get and @c del. The 3 first functions also receive a @c part
14160 * parameter described below. A brief description of these functions follows:
14162 * - @c label_get - The @c part parameter is the name string of one of the
14163 * existing text parts in the Edje group implementing the item's theme.
14164 * This function @b must return a strdup'()ed string, as the caller will
14165 * free() it when done. See #GenlistItemLabelGetFunc.
14166 * - @c icon_get - The @c part parameter is the name string of one of the
14167 * existing (icon) swallow parts in the Edje group implementing the item's
14168 * theme. It must return @c NULL, when no icon is desired, or a valid
14169 * object handle, otherwise. The object will be deleted by the genlist on
14170 * its deletion or when the item is "unrealized". See
14171 * #GenlistItemIconGetFunc.
14172 * - @c func.state_get - The @c part parameter is the name string of one of
14173 * the state parts in the Edje group implementing the item's theme. Return
14174 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14175 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14176 * and @c "elm" as "emission" and "source" arguments, respectively, when
14177 * the state is true (the default is false), where @c XXX is the name of
14178 * the (state) part. See #GenlistItemStateGetFunc.
14179 * - @c func.del - This is intended for use when genlist items are deleted,
14180 * so any data attached to the item (e.g. its data parameter on creation)
14181 * can be deleted. See #GenlistItemDelFunc.
14183 * available item styles:
14185 * - default_style - The text part is a textblock
14187 * @image html img/widget/genlist/preview-04.png
14188 * @image latex img/widget/genlist/preview-04.eps
14192 * @image html img/widget/genlist/preview-01.png
14193 * @image latex img/widget/genlist/preview-01.eps
14195 * - icon_top_text_bottom
14197 * @image html img/widget/genlist/preview-02.png
14198 * @image latex img/widget/genlist/preview-02.eps
14202 * @image html img/widget/genlist/preview-03.png
14203 * @image latex img/widget/genlist/preview-03.eps
14205 * @section Genlist_Items Structure of items
14207 * An item in a genlist can have 0 or more text labels (they can be regular
14208 * text or textblock Evas objects - that's up to the style to determine), 0
14209 * or more icons (which are simply objects swallowed into the genlist item's
14210 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14211 * behavior left to the user to define. The Edje part names for each of
14212 * these properties will be looked up, in the theme file for the genlist,
14213 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14214 * "states", respectively. For each of those properties, if more than one
14215 * part is provided, they must have names listed separated by spaces in the
14216 * data fields. For the default genlist item theme, we have @b one label
14217 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14218 * "elm.swallow.end") and @b no state parts.
14220 * A genlist item may be at one of several styles. Elementary provides one
14221 * by default - "default", but this can be extended by system or application
14222 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14225 * @section Genlist_Manipulation Editing and Navigating
14227 * Items can be added by several calls. All of them return a @ref
14228 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14229 * They all take a data parameter that is meant to be used for a handle to
14230 * the applications internal data (eg the struct with the original item
14231 * data). The parent parameter is the parent genlist item this belongs to if
14232 * it is a tree or an indexed group, and NULL if there is no parent. The
14233 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14234 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14235 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14236 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14237 * is set then this item is group index item that is displayed at the top
14238 * until the next group comes. The func parameter is a convenience callback
14239 * that is called when the item is selected and the data parameter will be
14240 * the func_data parameter, obj be the genlist object and event_info will be
14241 * the genlist item.
14243 * elm_genlist_item_append() adds an item to the end of the list, or if
14244 * there is a parent, to the end of all the child items of the parent.
14245 * elm_genlist_item_prepend() is the same but adds to the beginning of
14246 * the list or children list. elm_genlist_item_insert_before() inserts at
14247 * item before another item and elm_genlist_item_insert_after() inserts after
14248 * the indicated item.
14250 * The application can clear the list with elm_genlist_clear() which deletes
14251 * all the items in the list and elm_genlist_item_del() will delete a specific
14252 * item. elm_genlist_item_subitems_clear() will clear all items that are
14253 * children of the indicated parent item.
14255 * To help inspect list items you can jump to the item at the top of the list
14256 * with elm_genlist_first_item_get() which will return the item pointer, and
14257 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14258 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14259 * and previous items respectively relative to the indicated item. Using
14260 * these calls you can walk the entire item list/tree. Note that as a tree
14261 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14262 * let you know which item is the parent (and thus know how to skip them if
14265 * @section Genlist_Muti_Selection Multi-selection
14267 * If the application wants multiple items to be able to be selected,
14268 * elm_genlist_multi_select_set() can enable this. If the list is
14269 * single-selection only (the default), then elm_genlist_selected_item_get()
14270 * will return the selected item, if any, or NULL I none is selected. If the
14271 * list is multi-select then elm_genlist_selected_items_get() will return a
14272 * list (that is only valid as long as no items are modified (added, deleted,
14273 * selected or unselected)).
14275 * @section Genlist_Usage_Hints Usage hints
14277 * There are also convenience functions. elm_genlist_item_genlist_get() will
14278 * return the genlist object the item belongs to. elm_genlist_item_show()
14279 * will make the scroller scroll to show that specific item so its visible.
14280 * elm_genlist_item_data_get() returns the data pointer set by the item
14281 * creation functions.
14283 * If an item changes (state of boolean changes, label or icons change),
14284 * then use elm_genlist_item_update() to have genlist update the item with
14285 * the new state. Genlist will re-realize the item thus call the functions
14286 * in the _Elm_Genlist_Item_Class for that item.
14288 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14289 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14290 * to expand/contract an item and get its expanded state, use
14291 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14292 * again to make an item disabled (unable to be selected and appear
14293 * differently) use elm_genlist_item_disabled_set() to set this and
14294 * elm_genlist_item_disabled_get() to get the disabled state.
14296 * In general to indicate how the genlist should expand items horizontally to
14297 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14298 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14299 * mode means that if items are too wide to fit, the scroller will scroll
14300 * horizontally. Otherwise items are expanded to fill the width of the
14301 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14302 * to the viewport width and limited to that size. This can be combined with
14303 * a different style that uses edjes' ellipsis feature (cutting text off like
14306 * Items will only call their selection func and callback when first becoming
14307 * selected. Any further clicks will do nothing, unless you enable always
14308 * select with elm_genlist_always_select_mode_set(). This means even if
14309 * selected, every click will make the selected callbacks be called.
14310 * elm_genlist_no_select_mode_set() will turn off the ability to select
14311 * items entirely and they will neither appear selected nor call selected
14312 * callback functions.
14314 * Remember that you can create new styles and add your own theme augmentation
14315 * per application with elm_theme_extension_add(). If you absolutely must
14316 * have a specific style that overrides any theme the user or system sets up
14317 * you can use elm_theme_overlay_add() to add such a file.
14319 * @section Genlist_Implementation Implementation
14321 * Evas tracks every object you create. Every time it processes an event
14322 * (mouse move, down, up etc.) it needs to walk through objects and find out
14323 * what event that affects. Even worse every time it renders display updates,
14324 * in order to just calculate what to re-draw, it needs to walk through many
14325 * many many objects. Thus, the more objects you keep active, the more
14326 * overhead Evas has in just doing its work. It is advisable to keep your
14327 * active objects to the minimum working set you need. Also remember that
14328 * object creation and deletion carries an overhead, so there is a
14329 * middle-ground, which is not easily determined. But don't keep massive lists
14330 * of objects you can't see or use. Genlist does this with list objects. It
14331 * creates and destroys them dynamically as you scroll around. It groups them
14332 * into blocks so it can determine the visibility etc. of a whole block at
14333 * once as opposed to having to walk the whole list. This 2-level list allows
14334 * for very large numbers of items to be in the list (tests have used up to
14335 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14336 * may be different sizes, every item added needs to be calculated as to its
14337 * size and thus this presents a lot of overhead on populating the list, this
14338 * genlist employs a queue. Any item added is queued and spooled off over
14339 * time, actually appearing some time later, so if your list has many members
14340 * you may find it takes a while for them to all appear, with your process
14341 * consuming a lot of CPU while it is busy spooling.
14343 * Genlist also implements a tree structure, but it does so with callbacks to
14344 * the application, with the application filling in tree structures when
14345 * requested (allowing for efficient building of a very deep tree that could
14346 * even be used for file-management). See the above smart signal callbacks for
14349 * @section Genlist_Smart_Events Genlist smart events
14351 * Signals that you can add callbacks for are:
14352 * - @c "activated" - The user has double-clicked or pressed
14353 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14354 * item that was activated.
14355 * - @c "clicked,double" - The user has double-clicked an item. The @c
14356 * event_info parameter is the item that was double-clicked.
14357 * - @c "selected" - This is called when a user has made an item selected.
14358 * The event_info parameter is the genlist item that was selected.
14359 * - @c "unselected" - This is called when a user has made an item
14360 * unselected. The event_info parameter is the genlist item that was
14362 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14363 * called and the item is now meant to be expanded. The event_info
14364 * parameter is the genlist item that was indicated to expand. It is the
14365 * job of this callback to then fill in the child items.
14366 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14367 * called and the item is now meant to be contracted. The event_info
14368 * parameter is the genlist item that was indicated to contract. It is the
14369 * job of this callback to then delete the child items.
14370 * - @c "expand,request" - This is called when a user has indicated they want
14371 * to expand a tree branch item. The callback should decide if the item can
14372 * expand (has any children) and then call elm_genlist_item_expanded_set()
14373 * appropriately to set the state. The event_info parameter is the genlist
14374 * item that was indicated to expand.
14375 * - @c "contract,request" - This is called when a user has indicated they
14376 * want to contract a tree branch item. The callback should decide if the
14377 * item can contract (has any children) and then call
14378 * elm_genlist_item_expanded_set() appropriately to set the state. The
14379 * event_info parameter is the genlist item that was indicated to contract.
14380 * - @c "realized" - This is called when the item in the list is created as a
14381 * real evas object. event_info parameter is the genlist item that was
14382 * created. The object may be deleted at any time, so it is up to the
14383 * caller to not use the object pointer from elm_genlist_item_object_get()
14384 * in a way where it may point to freed objects.
14385 * - @c "unrealized" - This is called just before an item is unrealized.
14386 * After this call icon objects provided will be deleted and the item
14387 * object itself delete or be put into a floating cache.
14388 * - @c "drag,start,up" - This is called when the item in the list has been
14389 * dragged (not scrolled) up.
14390 * - @c "drag,start,down" - This is called when the item in the list has been
14391 * dragged (not scrolled) down.
14392 * - @c "drag,start,left" - This is called when the item in the list has been
14393 * dragged (not scrolled) left.
14394 * - @c "drag,start,right" - This is called when the item in the list has
14395 * been dragged (not scrolled) right.
14396 * - @c "drag,stop" - This is called when the item in the list has stopped
14398 * - @c "drag" - This is called when the item in the list is being dragged.
14399 * - @c "longpressed" - This is called when the item is pressed for a certain
14400 * amount of time. By default it's 1 second.
14401 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14403 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14404 * until the bottom edge.
14405 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14406 * until the left edge.
14407 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14408 * until the right edge.
14409 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14411 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14413 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14415 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14417 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14418 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14419 * multi-touch pinched in.
14420 * - @c "swipe" - This is called when the genlist is swiped.
14422 * @section Genlist_Examples Examples
14424 * Here is a list of examples that use the genlist, trying to show some of
14425 * its capabilities:
14426 * - @ref genlist_example_01
14427 * - @ref genlist_example_02
14428 * - @ref genlist_example_03
14429 * - @ref genlist_example_04
14430 * - @ref genlist_example_05
14434 * @addtogroup Genlist
14439 * @enum _Elm_Genlist_Item_Flags
14440 * @typedef Elm_Genlist_Item_Flags
14442 * Defines if the item is of any special type (has subitems or it's the
14443 * index of a group), or is just a simple item.
14447 typedef enum _Elm_Genlist_Item_Flags
14449 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14450 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14451 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14452 } Elm_Genlist_Item_Flags;
14453 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14454 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14455 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14456 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14457 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14458 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14459 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14460 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14463 * @struct _Elm_Genlist_Item_Class
14465 * Genlist item class definition structs.
14467 * This struct contains the style and fetching functions that will define the
14468 * contents of each item.
14470 * @see @ref Genlist_Item_Class
14472 struct _Elm_Genlist_Item_Class
14474 const char *item_style; /**< style of this class. */
14477 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14478 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14479 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14480 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14481 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14483 const char *mode_item_style;
14487 * Add a new genlist widget to the given parent Elementary
14488 * (container) object
14490 * @param parent The parent object
14491 * @return a new genlist widget handle or @c NULL, on errors
14493 * This function inserts a new genlist widget on the canvas.
14495 * @see elm_genlist_item_append()
14496 * @see elm_genlist_item_del()
14497 * @see elm_genlist_clear()
14501 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14503 * Remove all items from a given genlist widget.
14505 * @param obj The genlist object
14507 * This removes (and deletes) all items in @p obj, leaving it empty.
14509 * @see elm_genlist_item_del(), to remove just one item.
14513 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14515 * Enable or disable multi-selection in the genlist
14517 * @param obj The genlist object
14518 * @param multi Multi-select enable/disable. Default is disabled.
14520 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14521 * the list. This allows more than 1 item to be selected. To retrieve the list
14522 * of selected items, use elm_genlist_selected_items_get().
14524 * @see elm_genlist_selected_items_get()
14525 * @see elm_genlist_multi_select_get()
14529 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14531 * Gets if multi-selection in genlist is enabled or disabled.
14533 * @param obj The genlist object
14534 * @return Multi-select enabled/disabled
14535 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14537 * @see elm_genlist_multi_select_set()
14541 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14543 * This sets the horizontal stretching mode.
14545 * @param obj The genlist object
14546 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14548 * This sets the mode used for sizing items horizontally. Valid modes
14549 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14550 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14551 * the scroller will scroll horizontally. Otherwise items are expanded
14552 * to fill the width of the viewport of the scroller. If it is
14553 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14554 * limited to that size.
14556 * @see elm_genlist_horizontal_get()
14560 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14561 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14563 * Gets the horizontal stretching mode.
14565 * @param obj The genlist object
14566 * @return The mode to use
14567 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14569 * @see elm_genlist_horizontal_set()
14573 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14574 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14576 * Set the always select mode.
14578 * @param obj The genlist object
14579 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14580 * EINA_FALSE = off). Default is @c EINA_FALSE.
14582 * Items will only call their selection func and callback when first
14583 * becoming selected. Any further clicks will do nothing, unless you
14584 * enable always select with elm_genlist_always_select_mode_set().
14585 * This means that, even if selected, every click will make the selected
14586 * callbacks be called.
14588 * @see elm_genlist_always_select_mode_get()
14592 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14594 * Get the always select mode.
14596 * @param obj The genlist object
14597 * @return The always select mode
14598 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14600 * @see elm_genlist_always_select_mode_set()
14604 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14606 * Enable/disable the no select mode.
14608 * @param obj The genlist object
14609 * @param no_select The no select mode
14610 * (EINA_TRUE = on, EINA_FALSE = off)
14612 * This will turn off the ability to select items entirely and they
14613 * will neither appear selected nor call selected callback functions.
14615 * @see elm_genlist_no_select_mode_get()
14619 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14621 * Gets whether the no select mode is enabled.
14623 * @param obj The genlist object
14624 * @return The no select mode
14625 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14627 * @see elm_genlist_no_select_mode_set()
14631 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14633 * Enable/disable compress mode.
14635 * @param obj The genlist object
14636 * @param compress The compress mode
14637 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14639 * This will enable the compress mode where items are "compressed"
14640 * horizontally to fit the genlist scrollable viewport width. This is
14641 * special for genlist. Do not rely on
14642 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14643 * work as genlist needs to handle it specially.
14645 * @see elm_genlist_compress_mode_get()
14649 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14651 * Get whether the compress mode is enabled.
14653 * @param obj The genlist object
14654 * @return The compress mode
14655 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14657 * @see elm_genlist_compress_mode_set()
14661 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14663 * Enable/disable height-for-width mode.
14665 * @param obj The genlist object
14666 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14667 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14669 * With height-for-width mode the item width will be fixed (restricted
14670 * to a minimum of) to the list width when calculating its size in
14671 * order to allow the height to be calculated based on it. This allows,
14672 * for instance, text block to wrap lines if the Edje part is
14673 * configured with "text.min: 0 1".
14675 * @note This mode will make list resize slower as it will have to
14676 * recalculate every item height again whenever the list width
14679 * @note When height-for-width mode is enabled, it also enables
14680 * compress mode (see elm_genlist_compress_mode_set()) and
14681 * disables homogeneous (see elm_genlist_homogeneous_set()).
14685 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14687 * Get whether the height-for-width mode is enabled.
14689 * @param obj The genlist object
14690 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14695 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14697 * Enable/disable horizontal and vertical bouncing effect.
14699 * @param obj The genlist object
14700 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14701 * EINA_FALSE = off). Default is @c EINA_FALSE.
14702 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14703 * EINA_FALSE = off). Default is @c EINA_TRUE.
14705 * This will enable or disable the scroller bouncing effect for the
14706 * genlist. See elm_scroller_bounce_set() for details.
14708 * @see elm_scroller_bounce_set()
14709 * @see elm_genlist_bounce_get()
14713 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14715 * Get whether the horizontal and vertical bouncing effect is enabled.
14717 * @param obj The genlist object
14718 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14720 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14723 * @see elm_genlist_bounce_set()
14727 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14729 * Enable/disable homogenous mode.
14731 * @param obj The genlist object
14732 * @param homogeneous Assume the items within the genlist are of the
14733 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14736 * This will enable the homogeneous mode where items are of the same
14737 * height and width so that genlist may do the lazy-loading at its
14738 * maximum (which increases the performance for scrolling the list). This
14739 * implies 'compressed' mode.
14741 * @see elm_genlist_compress_mode_set()
14742 * @see elm_genlist_homogeneous_get()
14746 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14748 * Get whether the homogenous mode is enabled.
14750 * @param obj The genlist object
14751 * @return Assume the items within the genlist are of the same height
14752 * and width (EINA_TRUE = on, EINA_FALSE = off)
14754 * @see elm_genlist_homogeneous_set()
14758 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14760 * Set the maximum number of items within an item block
14762 * @param obj The genlist object
14763 * @param n Maximum number of items within an item block. Default is 32.
14765 * This will configure the block count to tune to the target with
14766 * particular performance matrix.
14768 * A block of objects will be used to reduce the number of operations due to
14769 * many objects in the screen. It can determine the visibility, or if the
14770 * object has changed, it theme needs to be updated, etc. doing this kind of
14771 * calculation to the entire block, instead of per object.
14773 * The default value for the block count is enough for most lists, so unless
14774 * you know you will have a lot of objects visible in the screen at the same
14775 * time, don't try to change this.
14777 * @see elm_genlist_block_count_get()
14778 * @see @ref Genlist_Implementation
14782 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14784 * Get the maximum number of items within an item block
14786 * @param obj The genlist object
14787 * @return Maximum number of items within an item block
14789 * @see elm_genlist_block_count_set()
14793 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14795 * Set the timeout in seconds for the longpress event.
14797 * @param obj The genlist object
14798 * @param timeout timeout in seconds. Default is 1.
14800 * This option will change how long it takes to send an event "longpressed"
14801 * after the mouse down signal is sent to the list. If this event occurs, no
14802 * "clicked" event will be sent.
14804 * @see elm_genlist_longpress_timeout_set()
14808 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14810 * Get the timeout in seconds for the longpress event.
14812 * @param obj The genlist object
14813 * @return timeout in seconds
14815 * @see elm_genlist_longpress_timeout_get()
14819 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14821 * Append a new item in a given genlist widget.
14823 * @param obj The genlist object
14824 * @param itc The item class for the item
14825 * @param data The item data
14826 * @param parent The parent item, or NULL if none
14827 * @param flags Item flags
14828 * @param func Convenience function called when the item is selected
14829 * @param func_data Data passed to @p func above.
14830 * @return A handle to the item added or @c NULL if not possible
14832 * This adds the given item to the end of the list or the end of
14833 * the children list if the @p parent is given.
14835 * @see elm_genlist_item_prepend()
14836 * @see elm_genlist_item_insert_before()
14837 * @see elm_genlist_item_insert_after()
14838 * @see elm_genlist_item_del()
14842 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);
14844 * Prepend a new item in a given genlist widget.
14846 * @param obj The genlist object
14847 * @param itc The item class for the item
14848 * @param data The item data
14849 * @param parent The parent item, or NULL if none
14850 * @param flags Item flags
14851 * @param func Convenience function called when the item is selected
14852 * @param func_data Data passed to @p func above.
14853 * @return A handle to the item added or NULL if not possible
14855 * This adds an item to the beginning of the list or beginning of the
14856 * children of the parent if given.
14858 * @see elm_genlist_item_append()
14859 * @see elm_genlist_item_insert_before()
14860 * @see elm_genlist_item_insert_after()
14861 * @see elm_genlist_item_del()
14865 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);
14867 * Insert an item before another in a genlist widget
14869 * @param obj The genlist object
14870 * @param itc The item class for the item
14871 * @param data The item data
14872 * @param before The item to place this new one before.
14873 * @param flags Item flags
14874 * @param func Convenience function called when the item is selected
14875 * @param func_data Data passed to @p func above.
14876 * @return A handle to the item added or @c NULL if not possible
14878 * This inserts an item before another in the list. It will be in the
14879 * same tree level or group as the item it is inserted before.
14881 * @see elm_genlist_item_append()
14882 * @see elm_genlist_item_prepend()
14883 * @see elm_genlist_item_insert_after()
14884 * @see elm_genlist_item_del()
14888 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);
14890 * Insert an item after another in a genlist widget
14892 * @param obj The genlist object
14893 * @param itc The item class for the item
14894 * @param data The item data
14895 * @param after The item to place this new one after.
14896 * @param flags Item flags
14897 * @param func Convenience function called when the item is selected
14898 * @param func_data Data passed to @p func above.
14899 * @return A handle to the item added or @c NULL if not possible
14901 * This inserts an item after another in the list. It will be in the
14902 * same tree level or group as the item it is inserted after.
14904 * @see elm_genlist_item_append()
14905 * @see elm_genlist_item_prepend()
14906 * @see elm_genlist_item_insert_before()
14907 * @see elm_genlist_item_del()
14911 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);
14913 * Insert a new item into the sorted genlist object
14915 * @param obj The genlist object
14916 * @param itc The item class for the item
14917 * @param data The item data
14918 * @param parent The parent item, or NULL if none
14919 * @param flags Item flags
14920 * @param comp The function called for the sort
14921 * @param func Convenience function called when item selected
14922 * @param func_data Data passed to @p func above.
14923 * @return A handle to the item added or NULL if not possible
14927 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);
14928 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);
14929 /* operations to retrieve existing items */
14931 * Get the selectd item in the genlist.
14933 * @param obj The genlist object
14934 * @return The selected item, or NULL if none is selected.
14936 * This gets the selected item in the list (if multi-selection is enabled, only
14937 * the item that was first selected in the list is returned - which is not very
14938 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14941 * If no item is selected, NULL is returned.
14943 * @see elm_genlist_selected_items_get()
14947 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14949 * Get a list of selected items in the genlist.
14951 * @param obj The genlist object
14952 * @return The list of selected items, or NULL if none are selected.
14954 * It returns a list of the selected items. This list pointer is only valid so
14955 * long as the selection doesn't change (no items are selected or unselected, or
14956 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14957 * pointers. The order of the items in this list is the order which they were
14958 * selected, i.e. the first item in this list is the first item that was
14959 * selected, and so on.
14961 * @note If not in multi-select mode, consider using function
14962 * elm_genlist_selected_item_get() instead.
14964 * @see elm_genlist_multi_select_set()
14965 * @see elm_genlist_selected_item_get()
14969 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14971 * Get a list of realized items in genlist
14973 * @param obj The genlist object
14974 * @return The list of realized items, nor NULL if none are realized.
14976 * This returns a list of the realized items in the genlist. The list
14977 * contains Elm_Genlist_Item pointers. The list must be freed by the
14978 * caller when done with eina_list_free(). The item pointers in the
14979 * list are only valid so long as those items are not deleted or the
14980 * genlist is not deleted.
14982 * @see elm_genlist_realized_items_update()
14986 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14988 * Get the item that is at the x, y canvas coords.
14990 * @param obj The gelinst object.
14991 * @param x The input x coordinate
14992 * @param y The input y coordinate
14993 * @param posret The position relative to the item returned here
14994 * @return The item at the coordinates or NULL if none
14996 * This returns the item at the given coordinates (which are canvas
14997 * relative, not object-relative). If an item is at that coordinate,
14998 * that item handle is returned, and if @p posret is not NULL, the
14999 * integer pointed to is set to a value of -1, 0 or 1, depending if
15000 * the coordinate is on the upper portion of that item (-1), on the
15001 * middle section (0) or on the lower part (1). If NULL is returned as
15002 * an item (no item found there), then posret may indicate -1 or 1
15003 * based if the coordinate is above or below all items respectively in
15008 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);
15010 * Get the first item in the genlist
15012 * This returns the first item in the list.
15014 * @param obj The genlist object
15015 * @return The first item, or NULL if none
15019 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15021 * Get the last item in the genlist
15023 * This returns the last item in the list.
15025 * @return The last item, or NULL if none
15029 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15031 * Set the scrollbar policy
15033 * @param obj The genlist object
15034 * @param policy_h Horizontal scrollbar policy.
15035 * @param policy_v Vertical scrollbar policy.
15037 * This sets the scrollbar visibility policy for the given genlist
15038 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15039 * made visible if it is needed, and otherwise kept hidden.
15040 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15041 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15042 * respectively for the horizontal and vertical scrollbars. Default is
15043 * #ELM_SMART_SCROLLER_POLICY_AUTO
15045 * @see elm_genlist_scroller_policy_get()
15049 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15051 * Get the scrollbar policy
15053 * @param obj The genlist object
15054 * @param policy_h Pointer to store the horizontal scrollbar policy.
15055 * @param policy_v Pointer to store the vertical scrollbar policy.
15057 * @see elm_genlist_scroller_policy_set()
15061 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);
15063 * Get the @b next item in a genlist widget's internal list of items,
15064 * given a handle to one of those items.
15066 * @param item The genlist item to fetch next from
15067 * @return The item after @p item, or @c NULL if there's none (and
15070 * This returns the item placed after the @p item, on the container
15073 * @see elm_genlist_item_prev_get()
15077 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15079 * Get the @b previous item in a genlist widget's internal list of items,
15080 * given a handle to one of those items.
15082 * @param item The genlist item to fetch previous from
15083 * @return The item before @p item, or @c NULL if there's none (and
15086 * This returns the item placed before the @p item, on the container
15089 * @see elm_genlist_item_next_get()
15093 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15095 * Get the genlist object's handle which contains a given genlist
15098 * @param item The item to fetch the container from
15099 * @return The genlist (parent) object
15101 * This returns the genlist object itself that an item belongs to.
15105 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15107 * Get the parent item of the given item
15109 * @param it The item
15110 * @return The parent of the item or @c NULL if it has no parent.
15112 * This returns the item that was specified as parent of the item @p it on
15113 * elm_genlist_item_append() and insertion related functions.
15117 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15119 * Remove all sub-items (children) of the given item
15121 * @param it The item
15123 * This removes all items that are children (and their descendants) of the
15124 * given item @p it.
15126 * @see elm_genlist_clear()
15127 * @see elm_genlist_item_del()
15131 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15133 * Set whether a given genlist item is selected or not
15135 * @param it The item
15136 * @param selected Use @c EINA_TRUE, to make it selected, @c
15137 * EINA_FALSE to make it unselected
15139 * This sets the selected state of an item. If multi selection is
15140 * not enabled on the containing genlist and @p selected is @c
15141 * EINA_TRUE, any other previously selected items will get
15142 * unselected in favor of this new one.
15144 * @see elm_genlist_item_selected_get()
15148 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15150 * Get whether a given genlist item is selected or not
15152 * @param it The item
15153 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15155 * @see elm_genlist_item_selected_set() for more details
15159 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15161 * Sets the expanded state of an item.
15163 * @param it The item
15164 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15166 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15169 * The theme will respond to this change visually, and a signal "expanded" or
15170 * "contracted" will be sent from the genlist with a pointer to the item that
15171 * has been expanded/contracted.
15173 * Calling this function won't show or hide any child of this item (if it is
15174 * a parent). You must manually delete and create them on the callbacks fo
15175 * the "expanded" or "contracted" signals.
15177 * @see elm_genlist_item_expanded_get()
15181 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15183 * Get the expanded state of an item
15185 * @param it The item
15186 * @return The expanded state
15188 * This gets the expanded state of an item.
15190 * @see elm_genlist_item_expanded_set()
15194 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15196 * Get the depth of expanded item
15198 * @param it The genlist item object
15199 * @return The depth of expanded item
15203 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15205 * Set whether a given genlist item is disabled or not.
15207 * @param it The item
15208 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15209 * to enable it back.
15211 * A disabled item cannot be selected or unselected. It will also
15212 * change its appearance, to signal the user it's disabled.
15214 * @see elm_genlist_item_disabled_get()
15218 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15220 * Get whether a given genlist item is disabled or not.
15222 * @param it The item
15223 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15226 * @see elm_genlist_item_disabled_set() for more details
15230 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15232 * Sets the display only state of an item.
15234 * @param it The item
15235 * @param display_only @c EINA_TRUE if the item is display only, @c
15236 * EINA_FALSE otherwise.
15238 * A display only item cannot be selected or unselected. It is for
15239 * display only and not selecting or otherwise clicking, dragging
15240 * etc. by the user, thus finger size rules will not be applied to
15243 * It's good to set group index items to display only state.
15245 * @see elm_genlist_item_display_only_get()
15249 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15251 * Get the display only state of an item
15253 * @param it The item
15254 * @return @c EINA_TRUE if the item is display only, @c
15255 * EINA_FALSE otherwise.
15257 * @see elm_genlist_item_display_only_set()
15261 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15263 * Show the portion of a genlist's internal list containing a given
15264 * item, immediately.
15266 * @param it The item to display
15268 * This causes genlist to jump to the given item @p it and show it (by
15269 * immediately scrolling to that position), if it is not fully visible.
15271 * @see elm_genlist_item_bring_in()
15272 * @see elm_genlist_item_top_show()
15273 * @see elm_genlist_item_middle_show()
15277 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15279 * Animatedly bring in, to the visible are of a genlist, a given
15282 * @param it The item to display
15284 * This causes genlist to jump to the given item @p it and show it (by
15285 * animatedly scrolling), if it is not fully visible. This may use animation
15286 * to do so and take a period of time
15288 * @see elm_genlist_item_show()
15289 * @see elm_genlist_item_top_bring_in()
15290 * @see elm_genlist_item_middle_bring_in()
15294 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15296 * Show the portion of a genlist's internal list containing a given
15297 * item, immediately.
15299 * @param it The item to display
15301 * This causes genlist to jump to the given item @p it and show it (by
15302 * immediately scrolling to that position), if it is not fully visible.
15304 * The item will be positioned at the top of the genlist viewport.
15306 * @see elm_genlist_item_show()
15307 * @see elm_genlist_item_top_bring_in()
15311 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15313 * Animatedly bring in, to the visible are of a genlist, a given
15316 * @param it The item
15318 * This causes genlist to jump to the given item @p it and show it (by
15319 * animatedly scrolling), if it is not fully visible. This may use animation
15320 * to do so and take a period of time
15322 * The item will be positioned at the top of the genlist viewport.
15324 * @see elm_genlist_item_bring_in()
15325 * @see elm_genlist_item_top_show()
15329 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15331 * Show the portion of a genlist's internal list containing a given
15332 * item, immediately.
15334 * @param it The item to display
15336 * This causes genlist to jump to the given item @p it and show it (by
15337 * immediately scrolling to that position), if it is not fully visible.
15339 * The item will be positioned at the middle of the genlist viewport.
15341 * @see elm_genlist_item_show()
15342 * @see elm_genlist_item_middle_bring_in()
15346 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15348 * Animatedly bring in, to the visible are of a genlist, a given
15351 * @param it The item
15353 * This causes genlist to jump to the given item @p it and show it (by
15354 * animatedly scrolling), if it is not fully visible. This may use animation
15355 * to do so and take a period of time
15357 * The item will be positioned at the middle of the genlist viewport.
15359 * @see elm_genlist_item_bring_in()
15360 * @see elm_genlist_item_middle_show()
15364 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15366 * Remove a genlist item from the its parent, deleting it.
15368 * @param item The item to be removed.
15369 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15371 * @see elm_genlist_clear(), to remove all items in a genlist at
15376 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15378 * Return the data associated to a given genlist item
15380 * @param item The genlist item.
15381 * @return the data associated to this item.
15383 * This returns the @c data value passed on the
15384 * elm_genlist_item_append() and related item addition calls.
15386 * @see elm_genlist_item_append()
15387 * @see elm_genlist_item_data_set()
15391 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15393 * Set the data associated to a given genlist item
15395 * @param item The genlist item
15396 * @param data The new data pointer to set on it
15398 * This @b overrides the @c data value passed on the
15399 * elm_genlist_item_append() and related item addition calls. This
15400 * function @b won't call elm_genlist_item_update() automatically,
15401 * so you'd issue it afterwards if you want to hove the item
15402 * updated to reflect the that new data.
15404 * @see elm_genlist_item_data_get()
15408 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15410 * Tells genlist to "orphan" icons fetchs by the item class
15412 * @param it The item
15414 * This instructs genlist to release references to icons in the item,
15415 * meaning that they will no longer be managed by genlist and are
15416 * floating "orphans" that can be re-used elsewhere if the user wants
15421 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15423 * Get the real Evas object created to implement the view of a
15424 * given genlist item
15426 * @param item The genlist item.
15427 * @return the Evas object implementing this item's view.
15429 * This returns the actual Evas object used to implement the
15430 * specified genlist item's view. This may be @c NULL, as it may
15431 * not have been created or may have been deleted, at any time, by
15432 * the genlist. <b>Do not modify this object</b> (move, resize,
15433 * show, hide, etc.), as the genlist is controlling it. This
15434 * function is for querying, emitting custom signals or hooking
15435 * lower level callbacks for events on that object. Do not delete
15436 * this object under any circumstances.
15438 * @see elm_genlist_item_data_get()
15442 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15444 * Update the contents of an item
15446 * @param it The item
15448 * This updates an item by calling all the item class functions again
15449 * to get the icons, labels and states. Use this when the original
15450 * item data has changed and the changes are desired to be reflected.
15452 * Use elm_genlist_realized_items_update() to update all already realized
15455 * @see elm_genlist_realized_items_update()
15459 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15461 * Update the item class of an item
15463 * @param it The item
15464 * @param itc The item class for the item
15466 * This sets another class fo the item, changing the way that it is
15467 * displayed. After changing the item class, elm_genlist_item_update() is
15468 * called on the item @p it.
15472 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15473 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15475 * Set the text to be shown in a given genlist item's tooltips.
15477 * @param item The genlist item
15478 * @param text The text to set in the content
15480 * This call will setup the text to be used as tooltip to that item
15481 * (analogous to elm_object_tooltip_text_set(), but being item
15482 * tooltips with higher precedence than object tooltips). It can
15483 * have only one tooltip at a time, so any previous tooltip data
15484 * will get removed.
15486 * In order to set an icon or something else as a tooltip, look at
15487 * elm_genlist_item_tooltip_content_cb_set().
15491 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15493 * Set the content to be shown in a given genlist item's tooltips
15495 * @param item The genlist item.
15496 * @param func The function returning the tooltip contents.
15497 * @param data What to provide to @a func as callback data/context.
15498 * @param del_cb Called when data is not needed anymore, either when
15499 * another callback replaces @p func, the tooltip is unset with
15500 * elm_genlist_item_tooltip_unset() or the owner @p item
15501 * dies. This callback receives as its first parameter the
15502 * given @p data, being @c event_info the item handle.
15504 * This call will setup the tooltip's contents to @p item
15505 * (analogous to elm_object_tooltip_content_cb_set(), but being
15506 * item tooltips with higher precedence than object tooltips). It
15507 * can have only one tooltip at a time, so any previous tooltip
15508 * content will get removed. @p func (with @p data) will be called
15509 * every time Elementary needs to show the tooltip and it should
15510 * return a valid Evas object, which will be fully managed by the
15511 * tooltip system, getting deleted when the tooltip is gone.
15513 * In order to set just a text as a tooltip, look at
15514 * elm_genlist_item_tooltip_text_set().
15518 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);
15520 * Unset a tooltip from a given genlist item
15522 * @param item genlist item to remove a previously set tooltip from.
15524 * This call removes any tooltip set on @p item. The callback
15525 * provided as @c del_cb to
15526 * elm_genlist_item_tooltip_content_cb_set() will be called to
15527 * notify it is not used anymore (and have resources cleaned, if
15530 * @see elm_genlist_item_tooltip_content_cb_set()
15534 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15536 * Set a different @b style for a given genlist item's tooltip.
15538 * @param item genlist item with tooltip set
15539 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15540 * "default", @c "transparent", etc)
15542 * Tooltips can have <b>alternate styles</b> to be displayed on,
15543 * which are defined by the theme set on Elementary. This function
15544 * works analogously as elm_object_tooltip_style_set(), but here
15545 * applied only to genlist item objects. The default style for
15546 * tooltips is @c "default".
15548 * @note before you set a style you should define a tooltip with
15549 * elm_genlist_item_tooltip_content_cb_set() or
15550 * elm_genlist_item_tooltip_text_set()
15552 * @see elm_genlist_item_tooltip_style_get()
15556 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15558 * Get the style set a given genlist item's tooltip.
15560 * @param item genlist item with tooltip already set on.
15561 * @return style the theme style in use, which defaults to
15562 * "default". If the object does not have a tooltip set,
15563 * then @c NULL is returned.
15565 * @see elm_genlist_item_tooltip_style_set() for more details
15569 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15571 * @brief Disable size restrictions on an object's tooltip
15572 * @param item The tooltip's anchor object
15573 * @param disable If EINA_TRUE, size restrictions are disabled
15574 * @return EINA_FALSE on failure, EINA_TRUE on success
15576 * This function allows a tooltip to expand beyond its parant window's canvas.
15577 * It will instead be limited only by the size of the display.
15579 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15581 * @brief Retrieve size restriction state of an object's tooltip
15582 * @param item The tooltip's anchor object
15583 * @return If EINA_TRUE, size restrictions are disabled
15585 * This function returns whether a tooltip is allowed to expand beyond
15586 * its parant window's canvas.
15587 * It will instead be limited only by the size of the display.
15589 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15591 * Set the type of mouse pointer/cursor decoration to be shown,
15592 * when the mouse pointer is over the given genlist widget item
15594 * @param item genlist item to customize cursor on
15595 * @param cursor the cursor type's name
15597 * This function works analogously as elm_object_cursor_set(), but
15598 * here the cursor's changing area is restricted to the item's
15599 * area, and not the whole widget's. Note that that item cursors
15600 * have precedence over widget cursors, so that a mouse over @p
15601 * item will always show cursor @p type.
15603 * If this function is called twice for an object, a previously set
15604 * cursor will be unset on the second call.
15606 * @see elm_object_cursor_set()
15607 * @see elm_genlist_item_cursor_get()
15608 * @see elm_genlist_item_cursor_unset()
15612 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15614 * Get the type of mouse pointer/cursor decoration set to be shown,
15615 * when the mouse pointer is over the given genlist widget item
15617 * @param item genlist item with custom cursor set
15618 * @return the cursor type's name or @c NULL, if no custom cursors
15619 * were set to @p item (and on errors)
15621 * @see elm_object_cursor_get()
15622 * @see elm_genlist_item_cursor_set() for more details
15623 * @see elm_genlist_item_cursor_unset()
15627 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15629 * Unset any custom mouse pointer/cursor decoration set to be
15630 * shown, when the mouse pointer is over the given genlist widget
15631 * item, thus making it show the @b default cursor again.
15633 * @param item a genlist item
15635 * Use this call to undo any custom settings on this item's cursor
15636 * decoration, bringing it back to defaults (no custom style set).
15638 * @see elm_object_cursor_unset()
15639 * @see elm_genlist_item_cursor_set() for more details
15643 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15645 * Set a different @b style for a given custom cursor set for a
15648 * @param item genlist item with custom cursor set
15649 * @param style the <b>theme style</b> to use (e.g. @c "default",
15650 * @c "transparent", etc)
15652 * This function only makes sense when one is using custom mouse
15653 * cursor decorations <b>defined in a theme file</b> , which can
15654 * have, given a cursor name/type, <b>alternate styles</b> on
15655 * it. It works analogously as elm_object_cursor_style_set(), but
15656 * here applied only to genlist item objects.
15658 * @warning Before you set a cursor style you should have defined a
15659 * custom cursor previously on the item, with
15660 * elm_genlist_item_cursor_set()
15662 * @see elm_genlist_item_cursor_engine_only_set()
15663 * @see elm_genlist_item_cursor_style_get()
15667 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15669 * Get the current @b style set for a given genlist item's custom
15672 * @param item genlist item with custom cursor set.
15673 * @return style the cursor style in use. If the object does not
15674 * have a cursor set, then @c NULL is returned.
15676 * @see elm_genlist_item_cursor_style_set() for more details
15680 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15682 * Set if the (custom) cursor for a given genlist item should be
15683 * searched in its theme, also, or should only rely on the
15684 * rendering engine.
15686 * @param item item with custom (custom) cursor already set on
15687 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15688 * only on those provided by the rendering engine, @c EINA_FALSE to
15689 * have them searched on the widget's theme, as well.
15691 * @note This call is of use only if you've set a custom cursor
15692 * for genlist items, with elm_genlist_item_cursor_set().
15694 * @note By default, cursors will only be looked for between those
15695 * provided by the rendering engine.
15699 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15701 * Get if the (custom) cursor for a given genlist item is being
15702 * searched in its theme, also, or is only relying on the rendering
15705 * @param item a genlist item
15706 * @return @c EINA_TRUE, if cursors are being looked for only on
15707 * those provided by the rendering engine, @c EINA_FALSE if they
15708 * are being searched on the widget's theme, as well.
15710 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15714 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15716 * Update the contents of all realized items.
15718 * @param obj The genlist object.
15720 * This updates all realized items by calling all the item class functions again
15721 * to get the icons, labels and states. Use this when the original
15722 * item data has changed and the changes are desired to be reflected.
15724 * To update just one item, use elm_genlist_item_update().
15726 * @see elm_genlist_realized_items_get()
15727 * @see elm_genlist_item_update()
15731 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15733 * Activate a genlist mode on an item
15735 * @param item The genlist item
15736 * @param mode Mode name
15737 * @param mode_set Boolean to define set or unset mode.
15739 * A genlist mode is a different way of selecting an item. Once a mode is
15740 * activated on an item, any other selected item is immediately unselected.
15741 * This feature provides an easy way of implementing a new kind of animation
15742 * for selecting an item, without having to entirely rewrite the item style
15743 * theme. However, the elm_genlist_selected_* API can't be used to get what
15744 * item is activate for a mode.
15746 * The current item style will still be used, but applying a genlist mode to
15747 * an item will select it using a different kind of animation.
15749 * The current active item for a mode can be found by
15750 * elm_genlist_mode_item_get().
15752 * The characteristics of genlist mode are:
15753 * - Only one mode can be active at any time, and for only one item.
15754 * - Genlist handles deactivating other items when one item is activated.
15755 * - A mode is defined in the genlist theme (edc), and more modes can easily
15757 * - A mode style and the genlist item style are different things. They
15758 * can be combined to provide a default style to the item, with some kind
15759 * of animation for that item when the mode is activated.
15761 * When a mode is activated on an item, a new view for that item is created.
15762 * The theme of this mode defines the animation that will be used to transit
15763 * the item from the old view to the new view. This second (new) view will be
15764 * active for that item while the mode is active on the item, and will be
15765 * destroyed after the mode is totally deactivated from that item.
15767 * @see elm_genlist_mode_get()
15768 * @see elm_genlist_mode_item_get()
15772 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15774 * Get the last (or current) genlist mode used.
15776 * @param obj The genlist object
15778 * This function just returns the name of the last used genlist mode. It will
15779 * be the current mode if it's still active.
15781 * @see elm_genlist_item_mode_set()
15782 * @see elm_genlist_mode_item_get()
15786 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15788 * Get active genlist mode item
15790 * @param obj The genlist object
15791 * @return The active item for that current mode. Or @c NULL if no item is
15792 * activated with any mode.
15794 * This function returns the item that was activated with a mode, by the
15795 * function elm_genlist_item_mode_set().
15797 * @see elm_genlist_item_mode_set()
15798 * @see elm_genlist_mode_get()
15802 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15803 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15804 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15811 * @defgroup Check Check
15813 * @image html img/widget/check/preview-00.png
15814 * @image latex img/widget/check/preview-00.eps
15815 * @image html img/widget/check/preview-01.png
15816 * @image latex img/widget/check/preview-01.eps
15817 * @image html img/widget/check/preview-02.png
15818 * @image latex img/widget/check/preview-02.eps
15820 * @brief The check widget allows for toggling a value between true and
15823 * Check objects are a lot like radio objects in layout and functionality
15824 * except they do not work as a group, but independently and only toggle the
15825 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15826 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15827 * returns the current state. For convenience, like the radio objects, you
15828 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15829 * for it to modify.
15831 * Signals that you can add callbacks for are:
15832 * "changed" - This is called whenever the user changes the state of one of
15833 * the check object(event_info is NULL).
15835 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15839 * @brief Add a new Check object
15841 * @param parent The parent object
15842 * @return The new object or NULL if it cannot be created
15844 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15846 * @brief Set the text label of the check object
15848 * @param obj The check object
15849 * @param label The text label string in UTF-8
15851 * @deprecated use elm_object_text_set() instead.
15853 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15855 * @brief Get the text label of the check object
15857 * @param obj The check object
15858 * @return The text label string in UTF-8
15860 * @deprecated use elm_object_text_get() instead.
15862 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15864 * @brief Set the icon object of the check object
15866 * @param obj The check object
15867 * @param icon The icon object
15869 * Once the icon object is set, a previously set one will be deleted.
15870 * If you want to keep that old content object, use the
15871 * elm_check_icon_unset() function.
15873 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15875 * @brief Get the icon object of the check object
15877 * @param obj The check object
15878 * @return The icon object
15880 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15882 * @brief Unset the icon used for the check object
15884 * @param obj The check object
15885 * @return The icon object that was being used
15887 * Unparent and return the icon object which was set for this widget.
15889 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15891 * @brief Set the on/off state of the check object
15893 * @param obj The check object
15894 * @param state The state to use (1 == on, 0 == off)
15896 * This sets the state of the check. If set
15897 * with elm_check_state_pointer_set() the state of that variable is also
15898 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15900 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15902 * @brief Get the state of the check object
15904 * @param obj The check object
15905 * @return The boolean state
15907 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15909 * @brief Set a convenience pointer to a boolean to change
15911 * @param obj The check object
15912 * @param statep Pointer to the boolean to modify
15914 * This sets a pointer to a boolean, that, in addition to the check objects
15915 * state will also be modified directly. To stop setting the object pointed
15916 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15917 * then when this is called, the check objects state will also be modified to
15918 * reflect the value of the boolean @p statep points to, just like calling
15919 * elm_check_state_set().
15921 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15927 * @defgroup Radio Radio
15929 * @image html img/widget/radio/preview-00.png
15930 * @image latex img/widget/radio/preview-00.eps
15932 * @brief Radio is a widget that allows for 1 or more options to be displayed
15933 * and have the user choose only 1 of them.
15935 * A radio object contains an indicator, an optional Label and an optional
15936 * icon object. While it's possible to have a group of only one radio they,
15937 * are normally used in groups of 2 or more. To add a radio to a group use
15938 * elm_radio_group_add(). The radio object(s) will select from one of a set
15939 * of integer values, so any value they are configuring needs to be mapped to
15940 * a set of integers. To configure what value that radio object represents,
15941 * use elm_radio_state_value_set() to set the integer it represents. To set
15942 * the value the whole group(which one is currently selected) is to indicate
15943 * use elm_radio_value_set() on any group member, and to get the groups value
15944 * use elm_radio_value_get(). For convenience the radio objects are also able
15945 * to directly set an integer(int) to the value that is selected. To specify
15946 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15947 * The radio objects will modify this directly. That implies the pointer must
15948 * point to valid memory for as long as the radio objects exist.
15950 * Signals that you can add callbacks for are:
15951 * @li changed - This is called whenever the user changes the state of one of
15952 * the radio objects within the group of radio objects that work together.
15954 * @ref tutorial_radio show most of this API in action.
15958 * @brief Add a new radio to the parent
15960 * @param parent The parent object
15961 * @return The new object or NULL if it cannot be created
15963 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15965 * @brief Set the text label of the radio object
15967 * @param obj The radio object
15968 * @param label The text label string in UTF-8
15970 * @deprecated use elm_object_text_set() instead.
15972 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15974 * @brief Get the text label of the radio object
15976 * @param obj The radio object
15977 * @return The text label string in UTF-8
15979 * @deprecated use elm_object_text_set() instead.
15981 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15983 * @brief Set the icon object of the radio object
15985 * @param obj The radio object
15986 * @param icon The icon object
15988 * Once the icon object is set, a previously set one will be deleted. If you
15989 * want to keep that old content object, use the elm_radio_icon_unset()
15992 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15994 * @brief Get the icon object of the radio object
15996 * @param obj The radio object
15997 * @return The icon object
15999 * @see elm_radio_icon_set()
16001 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16003 * @brief Unset the icon used for the radio object
16005 * @param obj The radio object
16006 * @return The icon object that was being used
16008 * Unparent and return the icon object which was set for this widget.
16010 * @see elm_radio_icon_set()
16012 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16014 * @brief Add this radio to a group of other radio objects
16016 * @param obj The radio object
16017 * @param group Any object whose group the @p obj is to join.
16019 * Radio objects work in groups. Each member should have a different integer
16020 * value assigned. In order to have them work as a group, they need to know
16021 * about each other. This adds the given radio object to the group of which
16022 * the group object indicated is a member.
16024 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16026 * @brief Set the integer value that this radio object represents
16028 * @param obj The radio object
16029 * @param value The value to use if this radio object is selected
16031 * This sets the value of the radio.
16033 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16035 * @brief Get the integer value that this radio object represents
16037 * @param obj The radio object
16038 * @return The value used if this radio object is selected
16040 * This gets the value of the radio.
16042 * @see elm_radio_value_set()
16044 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16046 * @brief Set the value of the radio.
16048 * @param obj The radio object
16049 * @param value The value to use for the group
16051 * This sets the value of the radio group and will also set the value if
16052 * pointed to, to the value supplied, but will not call any callbacks.
16054 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16056 * @brief Get the state of the radio object
16058 * @param obj The radio object
16059 * @return The integer state
16061 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16063 * @brief Set a convenience pointer to a integer to change
16065 * @param obj The radio object
16066 * @param valuep Pointer to the integer to modify
16068 * This sets a pointer to a integer, that, in addition to the radio objects
16069 * state will also be modified directly. To stop setting the object pointed
16070 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16071 * when this is called, the radio objects state will also be modified to
16072 * reflect the value of the integer valuep points to, just like calling
16073 * elm_radio_value_set().
16075 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16081 * @defgroup Pager Pager
16083 * @image html img/widget/pager/preview-00.png
16084 * @image latex img/widget/pager/preview-00.eps
16086 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16088 * The flipping between “pages” of objects is animated. All content in pager
16089 * is kept in a stack, the last content to be added will be on the top of the
16090 * stack(be visible).
16092 * Objects can be pushed or popped from the stack or deleted as normal.
16093 * Pushes and pops will animate (and a pop will delete the object once the
16094 * animation is finished). Any object already in the pager can be promoted to
16095 * the top(from its current stacking position) through the use of
16096 * elm_pager_content_promote(). Objects are pushed to the top with
16097 * elm_pager_content_push() and when the top item is no longer wanted, simply
16098 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16099 * object is no longer needed and is not the top item, just delete it as
16100 * normal. You can query which objects are the top and bottom with
16101 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16103 * Signals that you can add callbacks for are:
16104 * "hide,finished" - when the previous page is hided
16106 * This widget has the following styles available:
16109 * @li fade_translucide
16110 * @li fade_invisible
16111 * @note This styles affect only the flipping animations, the appearance when
16112 * not animating is unaffected by styles.
16114 * @ref tutorial_pager gives a good overview of the usage of the API.
16118 * Add a new pager to the parent
16120 * @param parent The parent object
16121 * @return The new object or NULL if it cannot be created
16125 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16127 * @brief Push an object to the top of the pager stack (and show it).
16129 * @param obj The pager object
16130 * @param content The object to push
16132 * The object pushed becomes a child of the pager, it will be controlled and
16133 * deleted when the pager is deleted.
16135 * @note If the content is already in the stack use
16136 * elm_pager_content_promote().
16137 * @warning Using this function on @p content already in the stack results in
16138 * undefined behavior.
16140 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16142 * @brief Pop the object that is on top of the stack
16144 * @param obj The pager object
16146 * This pops the object that is on the top(visible) of the pager, makes it
16147 * disappear, then deletes the object. The object that was underneath it on
16148 * the stack will become visible.
16150 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16152 * @brief Moves an object already in the pager stack to the top of the stack.
16154 * @param obj The pager object
16155 * @param content The object to promote
16157 * This will take the @p content and move it to the top of the stack as
16158 * if it had been pushed there.
16160 * @note If the content isn't already in the stack use
16161 * elm_pager_content_push().
16162 * @warning Using this function on @p content not already in the stack
16163 * results in undefined behavior.
16165 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16167 * @brief Return the object at the bottom of the pager stack
16169 * @param obj The pager object
16170 * @return The bottom object or NULL if none
16172 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16174 * @brief Return the object at the top of the pager stack
16176 * @param obj The pager object
16177 * @return The top object or NULL if none
16179 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16185 * @defgroup Slideshow Slideshow
16187 * @image html img/widget/slideshow/preview-00.png
16188 * @image latex img/widget/slideshow/preview-00.eps
16190 * This widget, as the name indicates, is a pre-made image
16191 * slideshow panel, with API functions acting on (child) image
16192 * items presentation. Between those actions, are:
16193 * - advance to next/previous image
16194 * - select the style of image transition animation
16195 * - set the exhibition time for each image
16196 * - start/stop the slideshow
16198 * The transition animations are defined in the widget's theme,
16199 * consequently new animations can be added without having to
16200 * update the widget's code.
16202 * @section Slideshow_Items Slideshow items
16204 * For slideshow items, just like for @ref Genlist "genlist" ones,
16205 * the user defines a @b classes, specifying functions that will be
16206 * called on the item's creation and deletion times.
16208 * The #Elm_Slideshow_Item_Class structure contains the following
16211 * - @c func.get - When an item is displayed, this function is
16212 * called, and it's where one should create the item object, de
16213 * facto. For example, the object can be a pure Evas image object
16214 * or an Elementary @ref Photocam "photocam" widget. See
16215 * #SlideshowItemGetFunc.
16216 * - @c func.del - When an item is no more displayed, this function
16217 * is called, where the user must delete any data associated to
16218 * the item. See #SlideshowItemDelFunc.
16220 * @section Slideshow_Caching Slideshow caching
16222 * The slideshow provides facilities to have items adjacent to the
16223 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16224 * you, so that the system does not have to decode image data
16225 * anymore at the time it has to actually switch images on its
16226 * viewport. The user is able to set the numbers of items to be
16227 * cached @b before and @b after the current item, in the widget's
16230 * Smart events one can add callbacks for are:
16232 * - @c "changed" - when the slideshow switches its view to a new
16235 * List of examples for the slideshow widget:
16236 * @li @ref slideshow_example
16240 * @addtogroup Slideshow
16244 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16245 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16246 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16247 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16248 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16251 * @struct _Elm_Slideshow_Item_Class
16253 * Slideshow item class definition. See @ref Slideshow_Items for
16256 struct _Elm_Slideshow_Item_Class
16258 struct _Elm_Slideshow_Item_Class_Func
16260 SlideshowItemGetFunc get;
16261 SlideshowItemDelFunc del;
16263 }; /**< #Elm_Slideshow_Item_Class member definitions */
16266 * Add a new slideshow widget to the given parent Elementary
16267 * (container) object
16269 * @param parent The parent object
16270 * @return A new slideshow widget handle or @c NULL, on errors
16272 * This function inserts a new slideshow widget on the canvas.
16274 * @ingroup Slideshow
16276 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16279 * Add (append) a new item in a given slideshow widget.
16281 * @param obj The slideshow object
16282 * @param itc The item class for the item
16283 * @param data The item's data
16284 * @return A handle to the item added or @c NULL, on errors
16286 * Add a new item to @p obj's internal list of items, appending it.
16287 * The item's class must contain the function really fetching the
16288 * image object to show for this item, which could be an Evas image
16289 * object or an Elementary photo, for example. The @p data
16290 * parameter is going to be passed to both class functions of the
16293 * @see #Elm_Slideshow_Item_Class
16294 * @see elm_slideshow_item_sorted_insert()
16296 * @ingroup Slideshow
16298 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16301 * Insert a new item into the given slideshow widget, using the @p func
16302 * function to sort items (by item handles).
16304 * @param obj The slideshow object
16305 * @param itc The item class for the item
16306 * @param data The item's data
16307 * @param func The comparing function to be used to sort slideshow
16308 * items <b>by #Elm_Slideshow_Item item handles</b>
16309 * @return Returns The slideshow item handle, on success, or
16310 * @c NULL, on errors
16312 * Add a new item to @p obj's internal list of items, in a position
16313 * determined by the @p func comparing function. The item's class
16314 * must contain the function really fetching the image object to
16315 * show for this item, which could be an Evas image object or an
16316 * Elementary photo, for example. The @p data parameter is going to
16317 * be passed to both class functions of the item.
16319 * @see #Elm_Slideshow_Item_Class
16320 * @see elm_slideshow_item_add()
16322 * @ingroup Slideshow
16324 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);
16327 * Display a given slideshow widget's item, programmatically.
16329 * @param obj The slideshow object
16330 * @param item The item to display on @p obj's viewport
16332 * The change between the current item and @p item will use the
16333 * transition @p obj is set to use (@see
16334 * elm_slideshow_transition_set()).
16336 * @ingroup Slideshow
16338 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16341 * Slide to the @b next item, in a given slideshow widget
16343 * @param obj The slideshow object
16345 * The sliding animation @p obj is set to use will be the
16346 * transition effect used, after this call is issued.
16348 * @note If the end of the slideshow's internal list of items is
16349 * reached, it'll wrap around to the list's beginning, again.
16351 * @ingroup Slideshow
16353 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16356 * Slide to the @b previous item, in a given slideshow widget
16358 * @param obj The slideshow object
16360 * The sliding animation @p obj is set to use will be the
16361 * transition effect used, after this call is issued.
16363 * @note If the beginning of the slideshow's internal list of items
16364 * is reached, it'll wrap around to the list's end, again.
16366 * @ingroup Slideshow
16368 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16371 * Returns the list of sliding transition/effect names available, for a
16372 * given slideshow widget.
16374 * @param obj The slideshow object
16375 * @return The list of transitions (list of @b stringshared strings
16378 * The transitions, which come from @p obj's theme, must be an EDC
16379 * data item named @c "transitions" on the theme file, with (prefix)
16380 * names of EDC programs actually implementing them.
16382 * The available transitions for slideshows on the default theme are:
16383 * - @c "fade" - the current item fades out, while the new one
16384 * fades in to the slideshow's viewport.
16385 * - @c "black_fade" - the current item fades to black, and just
16386 * then, the new item will fade in.
16387 * - @c "horizontal" - the current item slides horizontally, until
16388 * it gets out of the slideshow's viewport, while the new item
16389 * comes from the left to take its place.
16390 * - @c "vertical" - the current item slides vertically, until it
16391 * gets out of the slideshow's viewport, while the new item comes
16392 * from the bottom to take its place.
16393 * - @c "square" - the new item starts to appear from the middle of
16394 * the current one, but with a tiny size, growing until its
16395 * target (full) size and covering the old one.
16397 * @warning The stringshared strings get no new references
16398 * exclusive to the user grabbing the list, here, so if you'd like
16399 * to use them out of this call's context, you'd better @c
16400 * eina_stringshare_ref() them.
16402 * @see elm_slideshow_transition_set()
16404 * @ingroup Slideshow
16406 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16409 * Set the current slide transition/effect in use for a given
16412 * @param obj The slideshow object
16413 * @param transition The new transition's name string
16415 * If @p transition is implemented in @p obj's theme (i.e., is
16416 * contained in the list returned by
16417 * elm_slideshow_transitions_get()), this new sliding effect will
16418 * be used on the widget.
16420 * @see elm_slideshow_transitions_get() for more details
16422 * @ingroup Slideshow
16424 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16427 * Get the current slide transition/effect in use for a given
16430 * @param obj The slideshow object
16431 * @return The current transition's name
16433 * @see elm_slideshow_transition_set() for more details
16435 * @ingroup Slideshow
16437 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16440 * Set the interval between each image transition on a given
16441 * slideshow widget, <b>and start the slideshow, itself</b>
16443 * @param obj The slideshow object
16444 * @param timeout The new displaying timeout for images
16446 * After this call, the slideshow widget will start cycling its
16447 * view, sequentially and automatically, with the images of the
16448 * items it has. The time between each new image displayed is going
16449 * to be @p timeout, in @b seconds. If a different timeout was set
16450 * previously and an slideshow was in progress, it will continue
16451 * with the new time between transitions, after this call.
16453 * @note A value less than or equal to 0 on @p timeout will disable
16454 * the widget's internal timer, thus halting any slideshow which
16455 * could be happening on @p obj.
16457 * @see elm_slideshow_timeout_get()
16459 * @ingroup Slideshow
16461 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16464 * Get the interval set for image transitions on a given slideshow
16467 * @param obj The slideshow object
16468 * @return Returns the timeout set on it
16470 * @see elm_slideshow_timeout_set() for more details
16472 * @ingroup Slideshow
16474 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16477 * Set if, after a slideshow is started, for a given slideshow
16478 * widget, its items should be displayed cyclically or not.
16480 * @param obj The slideshow object
16481 * @param loop Use @c EINA_TRUE to make it cycle through items or
16482 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16485 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16486 * ignore what is set by this functions, i.e., they'll @b always
16487 * cycle through items. This affects only the "automatic"
16488 * slideshow, as set by elm_slideshow_timeout_set().
16490 * @see elm_slideshow_loop_get()
16492 * @ingroup Slideshow
16494 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16497 * Get if, after a slideshow is started, for a given slideshow
16498 * widget, its items are to be displayed cyclically or not.
16500 * @param obj The slideshow object
16501 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16502 * through or @c EINA_FALSE, otherwise
16504 * @see elm_slideshow_loop_set() for more details
16506 * @ingroup Slideshow
16508 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16511 * Remove all items from a given slideshow widget
16513 * @param obj The slideshow object
16515 * This removes (and deletes) all items in @p obj, leaving it
16518 * @see elm_slideshow_item_del(), to remove just one item.
16520 * @ingroup Slideshow
16522 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16525 * Get the internal list of items in a given slideshow widget.
16527 * @param obj The slideshow object
16528 * @return The list of items (#Elm_Slideshow_Item as data) or
16529 * @c NULL on errors.
16531 * This list is @b not to be modified in any way and must not be
16532 * freed. Use the list members with functions like
16533 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16535 * @warning This list is only valid until @p obj object's internal
16536 * items list is changed. It should be fetched again with another
16537 * call to this function when changes happen.
16539 * @ingroup Slideshow
16541 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16544 * Delete a given item from a slideshow widget.
16546 * @param item The slideshow item
16548 * @ingroup Slideshow
16550 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16553 * Return the data associated with a given slideshow item
16555 * @param item The slideshow item
16556 * @return Returns the data associated to this item
16558 * @ingroup Slideshow
16560 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16563 * Returns the currently displayed item, in a given slideshow widget
16565 * @param obj The slideshow object
16566 * @return A handle to the item being displayed in @p obj or
16567 * @c NULL, if none is (and on errors)
16569 * @ingroup Slideshow
16571 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16574 * Get the real Evas object created to implement the view of a
16575 * given slideshow item
16577 * @param item The slideshow item.
16578 * @return the Evas object implementing this item's view.
16580 * This returns the actual Evas object used to implement the
16581 * specified slideshow item's view. This may be @c NULL, as it may
16582 * not have been created or may have been deleted, at any time, by
16583 * the slideshow. <b>Do not modify this object</b> (move, resize,
16584 * show, hide, etc.), as the slideshow is controlling it. This
16585 * function is for querying, emitting custom signals or hooking
16586 * lower level callbacks for events on that object. Do not delete
16587 * this object under any circumstances.
16589 * @see elm_slideshow_item_data_get()
16591 * @ingroup Slideshow
16593 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16596 * Get the the item, in a given slideshow widget, placed at
16597 * position @p nth, in its internal items list
16599 * @param obj The slideshow object
16600 * @param nth The number of the item to grab a handle to (0 being
16602 * @return The item stored in @p obj at position @p nth or @c NULL,
16603 * if there's no item with that index (and on errors)
16605 * @ingroup Slideshow
16607 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16610 * Set the current slide layout in use for a given slideshow widget
16612 * @param obj The slideshow object
16613 * @param layout The new layout's name string
16615 * If @p layout is implemented in @p obj's theme (i.e., is contained
16616 * in the list returned by elm_slideshow_layouts_get()), this new
16617 * images layout will be used on the widget.
16619 * @see elm_slideshow_layouts_get() for more details
16621 * @ingroup Slideshow
16623 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16626 * Get the current slide layout in use for a given slideshow widget
16628 * @param obj The slideshow object
16629 * @return The current layout's name
16631 * @see elm_slideshow_layout_set() for more details
16633 * @ingroup Slideshow
16635 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16638 * Returns the list of @b layout names available, for a given
16639 * slideshow widget.
16641 * @param obj The slideshow object
16642 * @return The list of layouts (list of @b stringshared strings
16645 * Slideshow layouts will change how the widget is to dispose each
16646 * image item in its viewport, with regard to cropping, scaling,
16649 * The layouts, which come from @p obj's theme, must be an EDC
16650 * data item name @c "layouts" on the theme file, with (prefix)
16651 * names of EDC programs actually implementing them.
16653 * The available layouts for slideshows on the default theme are:
16654 * - @c "fullscreen" - item images with original aspect, scaled to
16655 * touch top and down slideshow borders or, if the image's heigh
16656 * is not enough, left and right slideshow borders.
16657 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16658 * one, but always leaving 10% of the slideshow's dimensions of
16659 * distance between the item image's borders and the slideshow
16660 * borders, for each axis.
16662 * @warning The stringshared strings get no new references
16663 * exclusive to the user grabbing the list, here, so if you'd like
16664 * to use them out of this call's context, you'd better @c
16665 * eina_stringshare_ref() them.
16667 * @see elm_slideshow_layout_set()
16669 * @ingroup Slideshow
16671 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16674 * Set the number of items to cache, on a given slideshow widget,
16675 * <b>before the current item</b>
16677 * @param obj The slideshow object
16678 * @param count Number of items to cache before the current one
16680 * The default value for this property is @c 2. See
16681 * @ref Slideshow_Caching "slideshow caching" for more details.
16683 * @see elm_slideshow_cache_before_get()
16685 * @ingroup Slideshow
16687 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16690 * Retrieve the number of items to cache, on a given slideshow widget,
16691 * <b>before the current item</b>
16693 * @param obj The slideshow object
16694 * @return The number of items set to be cached before the current one
16696 * @see elm_slideshow_cache_before_set() for more details
16698 * @ingroup Slideshow
16700 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16703 * Set the number of items to cache, on a given slideshow widget,
16704 * <b>after the current item</b>
16706 * @param obj The slideshow object
16707 * @param count Number of items to cache after the current one
16709 * The default value for this property is @c 2. See
16710 * @ref Slideshow_Caching "slideshow caching" for more details.
16712 * @see elm_slideshow_cache_after_get()
16714 * @ingroup Slideshow
16716 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16719 * Retrieve the number of items to cache, on a given slideshow widget,
16720 * <b>after the current item</b>
16722 * @param obj The slideshow object
16723 * @return The number of items set to be cached after the current one
16725 * @see elm_slideshow_cache_after_set() for more details
16727 * @ingroup Slideshow
16729 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16732 * Get the number of items stored in a given slideshow widget
16734 * @param obj The slideshow object
16735 * @return The number of items on @p obj, at the moment of this call
16737 * @ingroup Slideshow
16739 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16746 * @defgroup Fileselector File Selector
16748 * @image html img/widget/fileselector/preview-00.png
16749 * @image latex img/widget/fileselector/preview-00.eps
16751 * A file selector is a widget that allows a user to navigate
16752 * through a file system, reporting file selections back via its
16755 * It contains shortcut buttons for home directory (@c ~) and to
16756 * jump one directory upwards (..), as well as cancel/ok buttons to
16757 * confirm/cancel a given selection. After either one of those two
16758 * former actions, the file selector will issue its @c "done" smart
16761 * There's a text entry on it, too, showing the name of the current
16762 * selection. There's the possibility of making it editable, so it
16763 * is useful on file saving dialogs on applications, where one
16764 * gives a file name to save contents to, in a given directory in
16765 * the system. This custom file name will be reported on the @c
16766 * "done" smart callback (explained in sequence).
16768 * Finally, it has a view to display file system items into in two
16773 * If Elementary is built with support of the Ethumb thumbnailing
16774 * library, the second form of view will display preview thumbnails
16775 * of files which it supports.
16777 * Smart callbacks one can register to:
16779 * - @c "selected" - the user has clicked on a file (when not in
16780 * folders-only mode) or directory (when in folders-only mode)
16781 * - @c "directory,open" - the list has been populated with new
16782 * content (@c event_info is a pointer to the directory's
16783 * path, a @b stringshared string)
16784 * - @c "done" - the user has clicked on the "ok" or "cancel"
16785 * buttons (@c event_info is a pointer to the selection's
16786 * path, a @b stringshared string)
16788 * Here is an example on its usage:
16789 * @li @ref fileselector_example
16793 * @addtogroup Fileselector
16798 * Defines how a file selector widget is to layout its contents
16799 * (file system entries).
16801 typedef enum _Elm_Fileselector_Mode
16803 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16804 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16805 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16806 } Elm_Fileselector_Mode;
16809 * Add a new file selector widget to the given parent Elementary
16810 * (container) object
16812 * @param parent The parent object
16813 * @return a new file selector widget handle or @c NULL, on errors
16815 * This function inserts a new file selector widget on the canvas.
16817 * @ingroup Fileselector
16819 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16822 * Enable/disable the file name entry box where the user can type
16823 * in a name for a file, in a given file selector widget
16825 * @param obj The file selector object
16826 * @param is_save @c EINA_TRUE to make the file selector a "saving
16827 * dialog", @c EINA_FALSE otherwise
16829 * Having the entry editable is useful on file saving dialogs on
16830 * applications, where one gives a file name to save contents to,
16831 * in a given directory in the system. This custom file name will
16832 * be reported on the @c "done" smart callback.
16834 * @see elm_fileselector_is_save_get()
16836 * @ingroup Fileselector
16838 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16841 * Get whether the given file selector is in "saving dialog" mode
16843 * @param obj The file selector object
16844 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16845 * mode, @c EINA_FALSE otherwise (and on errors)
16847 * @see elm_fileselector_is_save_set() for more details
16849 * @ingroup Fileselector
16851 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16854 * Enable/disable folder-only view for a given file selector widget
16856 * @param obj The file selector object
16857 * @param only @c EINA_TRUE to make @p obj only display
16858 * directories, @c EINA_FALSE to make files to be displayed in it
16861 * If enabled, the widget's view will only display folder items,
16864 * @see elm_fileselector_folder_only_get()
16866 * @ingroup Fileselector
16868 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16871 * Get whether folder-only view is set for a given file selector
16874 * @param obj The file selector object
16875 * @return only @c EINA_TRUE if @p obj is only displaying
16876 * directories, @c EINA_FALSE if files are being displayed in it
16877 * too (and on errors)
16879 * @see elm_fileselector_folder_only_get()
16881 * @ingroup Fileselector
16883 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16886 * Enable/disable the "ok" and "cancel" buttons on a given file
16889 * @param obj The file selector object
16890 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16892 * @note A file selector without those buttons will never emit the
16893 * @c "done" smart event, and is only usable if one is just hooking
16894 * to the other two events.
16896 * @see elm_fileselector_buttons_ok_cancel_get()
16898 * @ingroup Fileselector
16900 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16903 * Get whether the "ok" and "cancel" buttons on a given file
16904 * selector widget are being shown.
16906 * @param obj The file selector object
16907 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16908 * otherwise (and on errors)
16910 * @see elm_fileselector_buttons_ok_cancel_set() for more details
16912 * @ingroup Fileselector
16914 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16917 * Enable/disable a tree view in the given file selector widget,
16918 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16920 * @param obj The file selector object
16921 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16924 * In a tree view, arrows are created on the sides of directories,
16925 * allowing them to expand in place.
16927 * @note If it's in other mode, the changes made by this function
16928 * will only be visible when one switches back to "list" mode.
16930 * @see elm_fileselector_expandable_get()
16932 * @ingroup Fileselector
16934 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16937 * Get whether tree view is enabled for the given file selector
16940 * @param obj The file selector object
16941 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16942 * otherwise (and or errors)
16944 * @see elm_fileselector_expandable_set() for more details
16946 * @ingroup Fileselector
16948 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16951 * Set, programmatically, the @b directory that a given file
16952 * selector widget will display contents from
16954 * @param obj The file selector object
16955 * @param path The path to display in @p obj
16957 * This will change the @b directory that @p obj is displaying. It
16958 * will also clear the text entry area on the @p obj object, which
16959 * displays select files' names.
16961 * @see elm_fileselector_path_get()
16963 * @ingroup Fileselector
16965 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16968 * Get the parent directory's path that a given file selector
16969 * widget is displaying
16971 * @param obj The file selector object
16972 * @return The (full) path of the directory the file selector is
16973 * displaying, a @b stringshared string
16975 * @see elm_fileselector_path_set()
16977 * @ingroup Fileselector
16979 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16982 * Set, programmatically, the currently selected file/directory in
16983 * the given file selector widget
16985 * @param obj The file selector object
16986 * @param path The (full) path to a file or directory
16987 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16988 * latter case occurs if the directory or file pointed to do not
16991 * @see elm_fileselector_selected_get()
16993 * @ingroup Fileselector
16995 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16998 * Get the currently selected item's (full) path, in the given file
17001 * @param obj The file selector object
17002 * @return The absolute path of the selected item, a @b
17003 * stringshared string
17005 * @note Custom editions on @p obj object's text entry, if made,
17006 * will appear on the return string of this function, naturally.
17008 * @see elm_fileselector_selected_set() for more details
17010 * @ingroup Fileselector
17012 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17015 * Set the mode in which a given file selector widget will display
17016 * (layout) file system entries in its view
17018 * @param obj The file selector object
17019 * @param mode The mode of the fileselector, being it one of
17020 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17021 * first one, naturally, will display the files in a list. The
17022 * latter will make the widget to display its entries in a grid
17025 * @note By using elm_fileselector_expandable_set(), the user may
17026 * trigger a tree view for that list.
17028 * @note If Elementary is built with support of the Ethumb
17029 * thumbnailing library, the second form of view will display
17030 * preview thumbnails of files which it supports. You must have
17031 * elm_need_ethumb() called in your Elementary for thumbnailing to
17034 * @see elm_fileselector_expandable_set().
17035 * @see elm_fileselector_mode_get().
17037 * @ingroup Fileselector
17039 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17042 * Get the mode in which a given file selector widget is displaying
17043 * (layouting) file system entries in its view
17045 * @param obj The fileselector object
17046 * @return The mode in which the fileselector is at
17048 * @see elm_fileselector_mode_set() for more details
17050 * @ingroup Fileselector
17052 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17059 * @defgroup Progressbar Progress bar
17061 * The progress bar is a widget for visually representing the
17062 * progress status of a given job/task.
17064 * A progress bar may be horizontal or vertical. It may display an
17065 * icon besides it, as well as primary and @b units labels. The
17066 * former is meant to label the widget as a whole, while the
17067 * latter, which is formatted with floating point values (and thus
17068 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17069 * units"</c>), is meant to label the widget's <b>progress
17070 * value</b>. Label, icon and unit strings/objects are @b optional
17071 * for progress bars.
17073 * A progress bar may be @b inverted, in which state it gets its
17074 * values inverted, with high values being on the left or top and
17075 * low values on the right or bottom, as opposed to normally have
17076 * the low values on the former and high values on the latter,
17077 * respectively, for horizontal and vertical modes.
17079 * The @b span of the progress, as set by
17080 * elm_progressbar_span_size_set(), is its length (horizontally or
17081 * vertically), unless one puts size hints on the widget to expand
17082 * on desired directions, by any container. That length will be
17083 * scaled by the object or applications scaling factor. At any
17084 * point code can query the progress bar for its value with
17085 * elm_progressbar_value_get().
17087 * Available widget styles for progress bars:
17089 * - @c "wheel" (simple style, no text, no progression, only
17090 * "pulse" effect is available)
17092 * Here is an example on its usage:
17093 * @li @ref progressbar_example
17097 * Add a new progress bar widget to the given parent Elementary
17098 * (container) object
17100 * @param parent The parent object
17101 * @return a new progress bar widget handle or @c NULL, on errors
17103 * This function inserts a new progress bar widget on the canvas.
17105 * @ingroup Progressbar
17107 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17110 * Set whether a given progress bar widget is at "pulsing mode" or
17113 * @param obj The progress bar object
17114 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17115 * @c EINA_FALSE to put it back to its default one
17117 * By default, progress bars will display values from the low to
17118 * high value boundaries. There are, though, contexts in which the
17119 * state of progression of a given task is @b unknown. For those,
17120 * one can set a progress bar widget to a "pulsing state", to give
17121 * the user an idea that some computation is being held, but
17122 * without exact progress values. In the default theme it will
17123 * animate its bar with the contents filling in constantly and back
17124 * to non-filled, in a loop. To start and stop this pulsing
17125 * animation, one has to explicitly call elm_progressbar_pulse().
17127 * @see elm_progressbar_pulse_get()
17128 * @see elm_progressbar_pulse()
17130 * @ingroup Progressbar
17132 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17135 * Get whether a given progress bar widget is at "pulsing mode" or
17138 * @param obj The progress bar object
17139 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17140 * if it's in the default one (and on errors)
17142 * @ingroup Progressbar
17144 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17147 * Start/stop a given progress bar "pulsing" animation, if its
17150 * @param obj The progress bar object
17151 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17152 * @c EINA_FALSE to @b stop it
17154 * @note This call won't do anything if @p obj is not under "pulsing mode".
17156 * @see elm_progressbar_pulse_set() for more details.
17158 * @ingroup Progressbar
17160 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17163 * Set the progress value (in percentage) on a given progress bar
17166 * @param obj The progress bar object
17167 * @param val The progress value (@b must be between @c 0.0 and @c
17170 * Use this call to set progress bar levels.
17172 * @note If you passes a value out of the specified range for @p
17173 * val, it will be interpreted as the @b closest of the @b boundary
17174 * values in the range.
17176 * @ingroup Progressbar
17178 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17181 * Get the progress value (in percentage) on a given progress bar
17184 * @param obj The progress bar object
17185 * @return The value of the progressbar
17187 * @see elm_progressbar_value_set() for more details
17189 * @ingroup Progressbar
17191 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17194 * Set the label of a given progress bar widget
17196 * @param obj The progress bar object
17197 * @param label The text label string, in UTF-8
17199 * @ingroup Progressbar
17200 * @deprecated use elm_object_text_set() instead.
17202 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17205 * Get the label of a given progress bar widget
17207 * @param obj The progressbar object
17208 * @return The text label string, in UTF-8
17210 * @ingroup Progressbar
17211 * @deprecated use elm_object_text_set() instead.
17213 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17216 * Set the icon object of a given progress bar widget
17218 * @param obj The progress bar object
17219 * @param icon The icon object
17221 * Use this call to decorate @p obj with an icon next to it.
17223 * @note Once the icon object is set, a previously set one will be
17224 * deleted. If you want to keep that old content object, use the
17225 * elm_progressbar_icon_unset() function.
17227 * @see elm_progressbar_icon_get()
17229 * @ingroup Progressbar
17231 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17234 * Retrieve the icon object set for a given progress bar widget
17236 * @param obj The progress bar object
17237 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17238 * otherwise (and on errors)
17240 * @see elm_progressbar_icon_set() for more details
17242 * @ingroup Progressbar
17244 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17247 * Unset an icon set on a given progress bar widget
17249 * @param obj The progress bar object
17250 * @return The icon object that was being used, if any was set, or
17251 * @c NULL, otherwise (and on errors)
17253 * This call will unparent and return the icon object which was set
17254 * for this widget, previously, on success.
17256 * @see elm_progressbar_icon_set() for more details
17258 * @ingroup Progressbar
17260 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17263 * Set the (exact) length of the bar region of a given progress bar
17266 * @param obj The progress bar object
17267 * @param size The length of the progress bar's bar region
17269 * This sets the minimum width (when in horizontal mode) or height
17270 * (when in vertical mode) of the actual bar area of the progress
17271 * bar @p obj. This in turn affects the object's minimum size. Use
17272 * this when you're not setting other size hints expanding on the
17273 * given direction (like weight and alignment hints) and you would
17274 * like it to have a specific size.
17276 * @note Icon, label and unit text around @p obj will require their
17277 * own space, which will make @p obj to require more the @p size,
17280 * @see elm_progressbar_span_size_get()
17282 * @ingroup Progressbar
17284 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17287 * Get the length set for the bar region of a given progress bar
17290 * @param obj The progress bar object
17291 * @return The length of the progress bar's bar region
17293 * If that size was not set previously, with
17294 * elm_progressbar_span_size_set(), this call will return @c 0.
17296 * @ingroup Progressbar
17298 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17301 * Set the format string for a given progress bar widget's units
17304 * @param obj The progress bar object
17305 * @param format The format string for @p obj's units label
17307 * If @c NULL is passed on @p format, it will make @p obj's units
17308 * area to be hidden completely. If not, it'll set the <b>format
17309 * string</b> for the units label's @b text. The units label is
17310 * provided a floating point value, so the units text is up display
17311 * at most one floating point falue. Note that the units label is
17312 * optional. Use a format string such as "%1.2f meters" for
17315 * @note The default format string for a progress bar is an integer
17316 * percentage, as in @c "%.0f %%".
17318 * @see elm_progressbar_unit_format_get()
17320 * @ingroup Progressbar
17322 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17325 * Retrieve the format string set for a given progress bar widget's
17328 * @param obj The progress bar object
17329 * @return The format set string for @p obj's units label or
17330 * @c NULL, if none was set (and on errors)
17332 * @see elm_progressbar_unit_format_set() for more details
17334 * @ingroup Progressbar
17336 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17339 * Set the orientation of a given progress bar widget
17341 * @param obj The progress bar object
17342 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17343 * @b horizontal, @c EINA_FALSE to make it @b vertical
17345 * Use this function to change how your progress bar is to be
17346 * disposed: vertically or horizontally.
17348 * @see elm_progressbar_horizontal_get()
17350 * @ingroup Progressbar
17352 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17355 * Retrieve the orientation of a given progress bar widget
17357 * @param obj The progress bar object
17358 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17359 * @c EINA_FALSE if it's @b vertical (and on errors)
17361 * @see elm_progressbar_horizontal_set() for more details
17363 * @ingroup Progressbar
17365 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17368 * Invert a given progress bar widget's displaying values order
17370 * @param obj The progress bar object
17371 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17372 * @c EINA_FALSE to bring it back to default, non-inverted values.
17374 * A progress bar may be @b inverted, in which state it gets its
17375 * values inverted, with high values being on the left or top and
17376 * low values on the right or bottom, as opposed to normally have
17377 * the low values on the former and high values on the latter,
17378 * respectively, for horizontal and vertical modes.
17380 * @see elm_progressbar_inverted_get()
17382 * @ingroup Progressbar
17384 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17387 * Get whether a given progress bar widget's displaying values are
17390 * @param obj The progress bar object
17391 * @return @c EINA_TRUE, if @p obj has inverted values,
17392 * @c EINA_FALSE otherwise (and on errors)
17394 * @see elm_progressbar_inverted_set() for more details
17396 * @ingroup Progressbar
17398 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17401 * @defgroup Separator Separator
17403 * @brief Separator is a very thin object used to separate other objects.
17405 * A separator can be vertical or horizontal.
17407 * @ref tutorial_separator is a good example of how to use a separator.
17411 * @brief Add a separator object to @p parent
17413 * @param parent The parent object
17415 * @return The separator object, or NULL upon failure
17417 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17419 * @brief Set the horizontal mode of a separator object
17421 * @param obj The separator object
17422 * @param horizontal If true, the separator is horizontal
17424 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17426 * @brief Get the horizontal mode of a separator object
17428 * @param obj The separator object
17429 * @return If true, the separator is horizontal
17431 * @see elm_separator_horizontal_set()
17433 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17439 * @defgroup Spinner Spinner
17440 * @ingroup Elementary
17442 * @image html img/widget/spinner/preview-00.png
17443 * @image latex img/widget/spinner/preview-00.eps
17445 * A spinner is a widget which allows the user to increase or decrease
17446 * numeric values using arrow buttons, or edit values directly, clicking
17447 * over it and typing the new value.
17449 * By default the spinner will not wrap and has a label
17450 * of "%.0f" (just showing the integer value of the double).
17452 * A spinner has a label that is formatted with floating
17453 * point values and thus accepts a printf-style format string, like
17456 * It also allows specific values to be replaced by pre-defined labels.
17458 * Smart callbacks one can register to:
17460 * - "changed" - Whenever the spinner value is changed.
17461 * - "delay,changed" - A short time after the value is changed by the user.
17462 * This will be called only when the user stops dragging for a very short
17463 * period or when they release their finger/mouse, so it avoids possibly
17464 * expensive reactions to the value change.
17466 * Available styles for it:
17468 * - @c "vertical": up/down buttons at the right side and text left aligned.
17470 * Here is an example on its usage:
17471 * @ref spinner_example
17475 * @addtogroup Spinner
17480 * Add a new spinner widget to the given parent Elementary
17481 * (container) object.
17483 * @param parent The parent object.
17484 * @return a new spinner widget handle or @c NULL, on errors.
17486 * This function inserts a new spinner widget on the canvas.
17491 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17494 * Set the format string of the displayed label.
17496 * @param obj The spinner object.
17497 * @param fmt The format string for the label display.
17499 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17500 * string for the label text. The label text is provided a floating point
17501 * value, so the label text can display up to 1 floating point value.
17502 * Note that this is optional.
17504 * Use a format string such as "%1.2f meters" for example, and it will
17505 * display values like: "3.14 meters" for a value equal to 3.14159.
17507 * Default is "%0.f".
17509 * @see elm_spinner_label_format_get()
17513 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17516 * Get the label format of the spinner.
17518 * @param obj The spinner object.
17519 * @return The text label format string in UTF-8.
17521 * @see elm_spinner_label_format_set() for details.
17525 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17528 * Set the minimum and maximum values for the spinner.
17530 * @param obj The spinner object.
17531 * @param min The minimum value.
17532 * @param max The maximum value.
17534 * Define the allowed range of values to be selected by the user.
17536 * If actual value is less than @p min, it will be updated to @p min. If it
17537 * is bigger then @p max, will be updated to @p max. Actual value can be
17538 * get with elm_spinner_value_get().
17540 * By default, min is equal to 0, and max is equal to 100.
17542 * @warning Maximum must be greater than minimum.
17544 * @see elm_spinner_min_max_get()
17548 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17551 * Get the minimum and maximum values of the spinner.
17553 * @param obj The spinner object.
17554 * @param min Pointer where to store the minimum value.
17555 * @param max Pointer where to store the maximum value.
17557 * @note If only one value is needed, the other pointer can be passed
17560 * @see elm_spinner_min_max_set() for details.
17564 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17567 * Set the step used to increment or decrement the spinner value.
17569 * @param obj The spinner object.
17570 * @param step The step value.
17572 * This value will be incremented or decremented to the displayed value.
17573 * It will be incremented while the user keep right or top arrow pressed,
17574 * and will be decremented while the user keep left or bottom arrow pressed.
17576 * The interval to increment / decrement can be set with
17577 * elm_spinner_interval_set().
17579 * By default step value is equal to 1.
17581 * @see elm_spinner_step_get()
17585 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17588 * Get the step used to increment or decrement the spinner value.
17590 * @param obj The spinner object.
17591 * @return The step value.
17593 * @see elm_spinner_step_get() for more details.
17597 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17600 * Set the value the spinner displays.
17602 * @param obj The spinner object.
17603 * @param val The value to be displayed.
17605 * Value will be presented on the label following format specified with
17606 * elm_spinner_format_set().
17608 * @warning The value must to be between min and max values. This values
17609 * are set by elm_spinner_min_max_set().
17611 * @see elm_spinner_value_get().
17612 * @see elm_spinner_format_set().
17613 * @see elm_spinner_min_max_set().
17617 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17620 * Get the value displayed by the spinner.
17622 * @param obj The spinner object.
17623 * @return The value displayed.
17625 * @see elm_spinner_value_set() for details.
17629 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17632 * Set whether the spinner should wrap when it reaches its
17633 * minimum or maximum value.
17635 * @param obj The spinner object.
17636 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17639 * Disabled by default. If disabled, when the user tries to increment the
17641 * but displayed value plus step value is bigger than maximum value,
17643 * won't allow it. The same happens when the user tries to decrement it,
17644 * but the value less step is less than minimum value.
17646 * When wrap is enabled, in such situations it will allow these changes,
17647 * but will get the value that would be less than minimum and subtracts
17648 * from maximum. Or add the value that would be more than maximum to
17652 * @li min value = 10
17653 * @li max value = 50
17654 * @li step value = 20
17655 * @li displayed value = 20
17657 * When the user decrement value (using left or bottom arrow), it will
17658 * displays @c 40, because max - (min - (displayed - step)) is
17659 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17661 * @see elm_spinner_wrap_get().
17665 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17668 * Get whether the spinner should wrap when it reaches its
17669 * minimum or maximum value.
17671 * @param obj The spinner object
17672 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17673 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17675 * @see elm_spinner_wrap_set() for details.
17679 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17682 * Set whether the spinner can be directly edited by the user or not.
17684 * @param obj The spinner object.
17685 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17686 * don't allow users to edit it directly.
17688 * Spinner objects can have edition @b disabled, in which state they will
17689 * be changed only by arrows.
17690 * Useful for contexts
17691 * where you don't want your users to interact with it writting the value.
17693 * when using special values, the user can see real value instead
17694 * of special label on edition.
17696 * It's enabled by default.
17698 * @see elm_spinner_editable_get()
17702 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17705 * Get whether the spinner can be directly edited by the user or not.
17707 * @param obj The spinner object.
17708 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17709 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17711 * @see elm_spinner_editable_set() for details.
17715 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17718 * Set a special string to display in the place of the numerical value.
17720 * @param obj The spinner object.
17721 * @param value The value to be replaced.
17722 * @param label The label to be used.
17724 * It's useful for cases when a user should select an item that is
17725 * better indicated by a label than a value. For example, weekdays or months.
17729 * sp = elm_spinner_add(win);
17730 * elm_spinner_min_max_set(sp, 1, 3);
17731 * elm_spinner_special_value_add(sp, 1, "January");
17732 * elm_spinner_special_value_add(sp, 2, "February");
17733 * elm_spinner_special_value_add(sp, 3, "March");
17734 * evas_object_show(sp);
17739 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17742 * Set the interval on time updates for an user mouse button hold
17743 * on spinner widgets' arrows.
17745 * @param obj The spinner object.
17746 * @param interval The (first) interval value in seconds.
17748 * This interval value is @b decreased while the user holds the
17749 * mouse pointer either incrementing or decrementing spinner's value.
17751 * This helps the user to get to a given value distant from the
17752 * current one easier/faster, as it will start to change quicker and
17753 * quicker on mouse button holds.
17755 * The calculation for the next change interval value, starting from
17756 * the one set with this call, is the previous interval divided by
17757 * @c 1.05, so it decreases a little bit.
17759 * The default starting interval value for automatic changes is
17762 * @see elm_spinner_interval_get()
17766 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17769 * Get the interval on time updates for an user mouse button hold
17770 * on spinner widgets' arrows.
17772 * @param obj The spinner object.
17773 * @return The (first) interval value, in seconds, set on it.
17775 * @see elm_spinner_interval_set() for more details.
17779 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17786 * @defgroup Index Index
17788 * @image html img/widget/index/preview-00.png
17789 * @image latex img/widget/index/preview-00.eps
17791 * An index widget gives you an index for fast access to whichever
17792 * group of other UI items one might have. It's a list of text
17793 * items (usually letters, for alphabetically ordered access).
17795 * Index widgets are by default hidden and just appear when the
17796 * user clicks over it's reserved area in the canvas. In its
17797 * default theme, it's an area one @ref Fingers "finger" wide on
17798 * the right side of the index widget's container.
17800 * When items on the index are selected, smart callbacks get
17801 * called, so that its user can make other container objects to
17802 * show a given area or child object depending on the index item
17803 * selected. You'd probably be using an index together with @ref
17804 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17807 * Smart events one can add callbacks for are:
17808 * - @c "changed" - When the selected index item changes. @c
17809 * event_info is the selected item's data pointer.
17810 * - @c "delay,changed" - When the selected index item changes, but
17811 * after a small idling period. @c event_info is the selected
17812 * item's data pointer.
17813 * - @c "selected" - When the user releases a mouse button and
17814 * selects an item. @c event_info is the selected item's data
17816 * - @c "level,up" - when the user moves a finger from the first
17817 * level to the second level
17818 * - @c "level,down" - when the user moves a finger from the second
17819 * level to the first level
17821 * The @c "delay,changed" event is so that it'll wait a small time
17822 * before actually reporting those events and, moreover, just the
17823 * last event happening on those time frames will actually be
17826 * Here are some examples on its usage:
17827 * @li @ref index_example_01
17828 * @li @ref index_example_02
17832 * @addtogroup Index
17836 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17839 * Add a new index widget to the given parent Elementary
17840 * (container) object
17842 * @param parent The parent object
17843 * @return a new index widget handle or @c NULL, on errors
17845 * This function inserts a new index widget on the canvas.
17849 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17852 * Set whether a given index widget is or not visible,
17855 * @param obj The index object
17856 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17858 * Not to be confused with visible as in @c evas_object_show() --
17859 * visible with regard to the widget's auto hiding feature.
17861 * @see elm_index_active_get()
17865 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17868 * Get whether a given index widget is currently visible or not.
17870 * @param obj The index object
17871 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17873 * @see elm_index_active_set() for more details
17877 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17880 * Set the items level for a given index widget.
17882 * @param obj The index object.
17883 * @param level @c 0 or @c 1, the currently implemented levels.
17885 * @see elm_index_item_level_get()
17889 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17892 * Get the items level set for a given index widget.
17894 * @param obj The index object.
17895 * @return @c 0 or @c 1, which are the levels @p obj might be at.
17897 * @see elm_index_item_level_set() for more information
17901 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17904 * Returns the last selected item's data, for a given index widget.
17906 * @param obj The index object.
17907 * @return The item @b data associated to the last selected item on
17908 * @p obj (or @c NULL, on errors).
17910 * @warning The returned value is @b not an #Elm_Index_Item item
17911 * handle, but the data associated to it (see the @c item parameter
17912 * in elm_index_item_append(), as an example).
17916 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17919 * Append a new item on a given index widget.
17921 * @param obj The index object.
17922 * @param letter Letter under which the item should be indexed
17923 * @param item The item data to set for the index's item
17925 * Despite the most common usage of the @p letter argument is for
17926 * single char strings, one could use arbitrary strings as index
17929 * @c item will be the pointer returned back on @c "changed", @c
17930 * "delay,changed" and @c "selected" smart events.
17934 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17937 * Prepend a new item on a given index widget.
17939 * @param obj The index object.
17940 * @param letter Letter under which the item should be indexed
17941 * @param item The item data to set for the index's item
17943 * Despite the most common usage of the @p letter argument is for
17944 * single char strings, one could use arbitrary strings as index
17947 * @c item will be the pointer returned back on @c "changed", @c
17948 * "delay,changed" and @c "selected" smart events.
17952 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17955 * Append a new item, on a given index widget, <b>after the item
17956 * having @p relative as data</b>.
17958 * @param obj The index object.
17959 * @param letter Letter under which the item should be indexed
17960 * @param item The item data to set for the index's item
17961 * @param relative The item data of the index item to be the
17962 * predecessor of this new one
17964 * Despite the most common usage of the @p letter argument is for
17965 * single char strings, one could use arbitrary strings as index
17968 * @c item will be the pointer returned back on @c "changed", @c
17969 * "delay,changed" and @c "selected" smart events.
17971 * @note If @p relative is @c NULL or if it's not found to be data
17972 * set on any previous item on @p obj, this function will behave as
17973 * elm_index_item_append().
17977 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17980 * Prepend a new item, on a given index widget, <b>after the item
17981 * having @p relative as data</b>.
17983 * @param obj The index object.
17984 * @param letter Letter under which the item should be indexed
17985 * @param item The item data to set for the index's item
17986 * @param relative The item data of the index item to be the
17987 * successor of this new one
17989 * Despite the most common usage of the @p letter argument is for
17990 * single char strings, one could use arbitrary strings as index
17993 * @c item will be the pointer returned back on @c "changed", @c
17994 * "delay,changed" and @c "selected" smart events.
17996 * @note If @p relative is @c NULL or if it's not found to be data
17997 * set on any previous item on @p obj, this function will behave as
17998 * elm_index_item_prepend().
18002 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18005 * Insert a new item into the given index widget, using @p cmp_func
18006 * function to sort items (by item handles).
18008 * @param obj The index object.
18009 * @param letter Letter under which the item should be indexed
18010 * @param item The item data to set for the index's item
18011 * @param cmp_func The comparing function to be used to sort index
18012 * items <b>by #Elm_Index_Item item handles</b>
18013 * @param cmp_data_func A @b fallback function to be called for the
18014 * sorting of index items <b>by item data</b>). It will be used
18015 * when @p cmp_func returns @c 0 (equality), which means an index
18016 * item with provided item data already exists. To decide which
18017 * data item should be pointed to by the index item in question, @p
18018 * cmp_data_func will be used. If @p cmp_data_func returns a
18019 * non-negative value, the previous index item data will be
18020 * replaced by the given @p item pointer. If the previous data need
18021 * to be freed, it should be done by the @p cmp_data_func function,
18022 * because all references to it will be lost. If this function is
18023 * not provided (@c NULL is given), index items will be @b
18024 * duplicated, if @p cmp_func returns @c 0.
18026 * Despite the most common usage of the @p letter argument is for
18027 * single char strings, one could use arbitrary strings as index
18030 * @c item will be the pointer returned back on @c "changed", @c
18031 * "delay,changed" and @c "selected" smart events.
18035 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);
18038 * Remove an item from a given index widget, <b>to be referenced by
18039 * it's data value</b>.
18041 * @param obj The index object
18042 * @param item The item's data pointer for the item to be removed
18045 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18046 * that callback function will be called by this one.
18048 * @warning The item to be removed from @p obj will be found via
18049 * its item data pointer, and not by an #Elm_Index_Item handle.
18053 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18056 * Find a given index widget's item, <b>using item data</b>.
18058 * @param obj The index object
18059 * @param item The item data pointed to by the desired index item
18060 * @return The index item handle, if found, or @c NULL otherwise
18064 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18067 * Removes @b all items from a given index widget.
18069 * @param obj The index object.
18071 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18072 * that callback function will be called for each item in @p obj.
18076 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18079 * Go to a given items level on a index widget
18081 * @param obj The index object
18082 * @param level The index level (one of @c 0 or @c 1)
18086 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18089 * Return the data associated with a given index widget item
18091 * @param it The index widget item handle
18092 * @return The data associated with @p it
18094 * @see elm_index_item_data_set()
18098 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18101 * Set the data associated with a given index widget item
18103 * @param it The index widget item handle
18104 * @param data The new data pointer to set to @p it
18106 * This sets new item data on @p it.
18108 * @warning The old data pointer won't be touched by this function, so
18109 * the user had better to free that old data himself/herself.
18113 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18116 * Set the function to be called when a given index widget item is freed.
18118 * @param it The item to set the callback on
18119 * @param func The function to call on the item's deletion
18121 * When called, @p func will have both @c data and @c event_info
18122 * arguments with the @p it item's data value and, naturally, the
18123 * @c obj argument with a handle to the parent index widget.
18127 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18130 * Get the letter (string) set on a given index widget item.
18132 * @param it The index item handle
18133 * @return The letter string set on @p it
18137 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18144 * @defgroup Photocam Photocam
18146 * @image html img/widget/photocam/preview-00.png
18147 * @image latex img/widget/photocam/preview-00.eps
18149 * This is a widget specifically for displaying high-resolution digital
18150 * camera photos giving speedy feedback (fast load), low memory footprint
18151 * and zooming and panning as well as fitting logic. It is entirely focused
18152 * on jpeg images, and takes advantage of properties of the jpeg format (via
18153 * evas loader features in the jpeg loader).
18155 * Signals that you can add callbacks for are:
18156 * @li "clicked" - This is called when a user has clicked the photo without
18158 * @li "press" - This is called when a user has pressed down on the photo.
18159 * @li "longpressed" - This is called when a user has pressed down on the
18160 * photo for a long time without dragging around.
18161 * @li "clicked,double" - This is called when a user has double-clicked the
18163 * @li "load" - Photo load begins.
18164 * @li "loaded" - This is called when the image file load is complete for the
18165 * first view (low resolution blurry version).
18166 * @li "load,detail" - Photo detailed data load begins.
18167 * @li "loaded,detail" - This is called when the image file load is complete
18168 * for the detailed image data (full resolution needed).
18169 * @li "zoom,start" - Zoom animation started.
18170 * @li "zoom,stop" - Zoom animation stopped.
18171 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18172 * @li "scroll" - the content has been scrolled (moved)
18173 * @li "scroll,anim,start" - scrolling animation has started
18174 * @li "scroll,anim,stop" - scrolling animation has stopped
18175 * @li "scroll,drag,start" - dragging the contents around has started
18176 * @li "scroll,drag,stop" - dragging the contents around has stopped
18178 * @ref tutorial_photocam shows the API in action.
18182 * @brief Types of zoom available.
18184 typedef enum _Elm_Photocam_Zoom_Mode
18186 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18187 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18188 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18189 ELM_PHOTOCAM_ZOOM_MODE_LAST
18190 } Elm_Photocam_Zoom_Mode;
18192 * @brief Add a new Photocam object
18194 * @param parent The parent object
18195 * @return The new object or NULL if it cannot be created
18197 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18199 * @brief Set the photo file to be shown
18201 * @param obj The photocam object
18202 * @param file The photo file
18203 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18205 * This sets (and shows) the specified file (with a relative or absolute
18206 * path) and will return a load error (same error that
18207 * evas_object_image_load_error_get() will return). The image will change and
18208 * adjust its size at this point and begin a background load process for this
18209 * photo that at some time in the future will be displayed at the full
18212 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18214 * @brief Returns the path of the current image file
18216 * @param obj The photocam object
18217 * @return Returns the path
18219 * @see elm_photocam_file_set()
18221 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18223 * @brief Set the zoom level of the photo
18225 * @param obj The photocam object
18226 * @param zoom The zoom level to set
18228 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18229 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18230 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18231 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18234 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18236 * @brief Get the zoom level of the photo
18238 * @param obj The photocam object
18239 * @return The current zoom level
18241 * This returns the current zoom level of the photocam object. Note that if
18242 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18243 * (which is the default), the zoom level may be changed at any time by the
18244 * photocam object itself to account for photo size and photocam viewpoer
18247 * @see elm_photocam_zoom_set()
18248 * @see elm_photocam_zoom_mode_set()
18250 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18252 * @brief Set the zoom mode
18254 * @param obj The photocam object
18255 * @param mode The desired mode
18257 * This sets the zoom mode to manual or one of several automatic levels.
18258 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18259 * elm_photocam_zoom_set() and will stay at that level until changed by code
18260 * or until zoom mode is changed. This is the default mode. The Automatic
18261 * modes will allow the photocam object to automatically adjust zoom mode
18262 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18263 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18264 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18265 * pixels within the frame are left unfilled.
18267 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18269 * @brief Get the zoom mode
18271 * @param obj The photocam object
18272 * @return The current zoom mode
18274 * This gets the current zoom mode of the photocam object.
18276 * @see elm_photocam_zoom_mode_set()
18278 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18280 * @brief Get the current image pixel width and height
18282 * @param obj The photocam object
18283 * @param w A pointer to the width return
18284 * @param h A pointer to the height return
18286 * This gets the current photo pixel width and height (for the original).
18287 * The size will be returned in the integers @p w and @p h that are pointed
18290 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18292 * @brief Get the area of the image that is currently shown
18295 * @param x A pointer to the X-coordinate of region
18296 * @param y A pointer to the Y-coordinate of region
18297 * @param w A pointer to the width
18298 * @param h A pointer to the height
18300 * @see elm_photocam_image_region_show()
18301 * @see elm_photocam_image_region_bring_in()
18303 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18305 * @brief Set the viewed portion of the image
18307 * @param obj The photocam object
18308 * @param x X-coordinate of region in image original pixels
18309 * @param y Y-coordinate of region in image original pixels
18310 * @param w Width of region in image original pixels
18311 * @param h Height of region in image original pixels
18313 * This shows the region of the image without using animation.
18315 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18317 * @brief Bring in the viewed portion of the image
18319 * @param obj The photocam object
18320 * @param x X-coordinate of region in image original pixels
18321 * @param y Y-coordinate of region in image original pixels
18322 * @param w Width of region in image original pixels
18323 * @param h Height of region in image original pixels
18325 * This shows the region of the image using animation.
18327 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18329 * @brief Set the paused state for photocam
18331 * @param obj The photocam object
18332 * @param paused The pause state to set
18334 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18335 * photocam. The default is off. This will stop zooming using animation on
18336 * zoom levels changes and change instantly. This will stop any existing
18337 * animations that are running.
18339 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18341 * @brief Get the paused state for photocam
18343 * @param obj The photocam object
18344 * @return The current paused state
18346 * This gets the current paused state for the photocam object.
18348 * @see elm_photocam_paused_set()
18350 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18352 * @brief Get the internal low-res image used for photocam
18354 * @param obj The photocam object
18355 * @return The internal image object handle, or NULL if none exists
18357 * This gets the internal image object inside photocam. Do not modify it. It
18358 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18359 * deleted at any time as well.
18361 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18363 * @brief Set the photocam scrolling bouncing.
18365 * @param obj The photocam object
18366 * @param h_bounce bouncing for horizontal
18367 * @param v_bounce bouncing for vertical
18369 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18371 * @brief Get the photocam scrolling bouncing.
18373 * @param obj The photocam object
18374 * @param h_bounce bouncing for horizontal
18375 * @param v_bounce bouncing for vertical
18377 * @see elm_photocam_bounce_set()
18379 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18385 * @defgroup Map Map
18386 * @ingroup Elementary
18388 * @image html img/widget/map/preview-00.png
18389 * @image latex img/widget/map/preview-00.eps
18391 * This is a widget specifically for displaying a map. It uses basically
18392 * OpenStreetMap provider http://www.openstreetmap.org/,
18393 * but custom providers can be added.
18395 * It supports some basic but yet nice features:
18396 * @li zoom and scroll
18397 * @li markers with content to be displayed when user clicks over it
18398 * @li group of markers
18401 * Smart callbacks one can listen to:
18403 * - "clicked" - This is called when a user has clicked the map without
18405 * - "press" - This is called when a user has pressed down on the map.
18406 * - "longpressed" - This is called when a user has pressed down on the map
18407 * for a long time without dragging around.
18408 * - "clicked,double" - This is called when a user has double-clicked
18410 * - "load,detail" - Map detailed data load begins.
18411 * - "loaded,detail" - This is called when all currently visible parts of
18412 * the map are loaded.
18413 * - "zoom,start" - Zoom animation started.
18414 * - "zoom,stop" - Zoom animation stopped.
18415 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18416 * - "scroll" - the content has been scrolled (moved).
18417 * - "scroll,anim,start" - scrolling animation has started.
18418 * - "scroll,anim,stop" - scrolling animation has stopped.
18419 * - "scroll,drag,start" - dragging the contents around has started.
18420 * - "scroll,drag,stop" - dragging the contents around has stopped.
18421 * - "downloaded" - This is called when all currently required map images
18423 * - "route,load" - This is called when route request begins.
18424 * - "route,loaded" - This is called when route request ends.
18425 * - "name,load" - This is called when name request begins.
18426 * - "name,loaded- This is called when name request ends.
18428 * Available style for map widget:
18431 * Available style for markers:
18436 * Available style for marker bubble:
18439 * List of examples:
18440 * @li @ref map_example_01
18441 * @li @ref map_example_02
18442 * @li @ref map_example_03
18451 * @enum _Elm_Map_Zoom_Mode
18452 * @typedef Elm_Map_Zoom_Mode
18454 * Set map's zoom behavior. It can be set to manual or automatic.
18456 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18458 * Values <b> don't </b> work as bitmask, only one can be choosen.
18460 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18461 * than the scroller view.
18463 * @see elm_map_zoom_mode_set()
18464 * @see elm_map_zoom_mode_get()
18468 typedef enum _Elm_Map_Zoom_Mode
18470 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18471 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18472 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18473 ELM_MAP_ZOOM_MODE_LAST
18474 } Elm_Map_Zoom_Mode;
18477 * @enum _Elm_Map_Route_Sources
18478 * @typedef Elm_Map_Route_Sources
18480 * Set route service to be used. By default used source is
18481 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18483 * @see elm_map_route_source_set()
18484 * @see elm_map_route_source_get()
18488 typedef enum _Elm_Map_Route_Sources
18490 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18491 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. */
18492 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18493 ELM_MAP_ROUTE_SOURCE_LAST
18494 } Elm_Map_Route_Sources;
18496 typedef enum _Elm_Map_Name_Sources
18498 ELM_MAP_NAME_SOURCE_NOMINATIM,
18499 ELM_MAP_NAME_SOURCE_LAST
18500 } Elm_Map_Name_Sources;
18503 * @enum _Elm_Map_Route_Type
18504 * @typedef Elm_Map_Route_Type
18506 * Set type of transport used on route.
18508 * @see elm_map_route_add()
18512 typedef enum _Elm_Map_Route_Type
18514 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18515 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18516 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18517 ELM_MAP_ROUTE_TYPE_LAST
18518 } Elm_Map_Route_Type;
18521 * @enum _Elm_Map_Route_Method
18522 * @typedef Elm_Map_Route_Method
18524 * Set the routing method, what should be priorized, time or distance.
18526 * @see elm_map_route_add()
18530 typedef enum _Elm_Map_Route_Method
18532 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18533 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18534 ELM_MAP_ROUTE_METHOD_LAST
18535 } Elm_Map_Route_Method;
18537 typedef enum _Elm_Map_Name_Method
18539 ELM_MAP_NAME_METHOD_SEARCH,
18540 ELM_MAP_NAME_METHOD_REVERSE,
18541 ELM_MAP_NAME_METHOD_LAST
18542 } Elm_Map_Name_Method;
18544 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(). */
18545 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(). */
18546 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(). */
18547 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(). */
18548 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18549 typedef struct _Elm_Map_Track Elm_Map_Track;
18551 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. */
18552 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18553 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18554 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18556 typedef char *(*ElmMapModuleSourceFunc) (void);
18557 typedef int (*ElmMapModuleZoomMinFunc) (void);
18558 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18559 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18560 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18561 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18562 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18563 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18564 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18567 * Add a new map widget to the given parent Elementary (container) object.
18569 * @param parent The parent object.
18570 * @return a new map widget handle or @c NULL, on errors.
18572 * This function inserts a new map widget on the canvas.
18576 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18579 * Set the zoom level of the map.
18581 * @param obj The map object.
18582 * @param zoom The zoom level to set.
18584 * This sets the zoom level.
18586 * It will respect limits defined by elm_map_source_zoom_min_set() and
18587 * elm_map_source_zoom_max_set().
18589 * By default these values are 0 (world map) and 18 (maximum zoom).
18591 * This function should be used when zoom mode is set to
18592 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18593 * with elm_map_zoom_mode_set().
18595 * @see elm_map_zoom_mode_set().
18596 * @see elm_map_zoom_get().
18600 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18603 * Get the zoom level of the map.
18605 * @param obj The map object.
18606 * @return The current zoom level.
18608 * This returns the current zoom level of the map object.
18610 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18611 * (which is the default), the zoom level may be changed at any time by the
18612 * map object itself to account for map size and map viewport size.
18614 * @see elm_map_zoom_set() for details.
18618 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18621 * Set the zoom mode used by the map object.
18623 * @param obj The map object.
18624 * @param mode The zoom mode of the map, being it one of
18625 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18626 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18628 * This sets the zoom mode to manual or one of the automatic levels.
18629 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18630 * elm_map_zoom_set() and will stay at that level until changed by code
18631 * or until zoom mode is changed. This is the default mode.
18633 * The Automatic modes will allow the map object to automatically
18634 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18635 * adjust zoom so the map fits inside the scroll frame with no pixels
18636 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18637 * ensure no pixels within the frame are left unfilled. Do not forget that
18638 * the valid sizes are 2^zoom, consequently the map may be smaller than
18639 * the scroller view.
18641 * @see elm_map_zoom_set()
18645 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18648 * Get the zoom mode used by the map object.
18650 * @param obj The map object.
18651 * @return The zoom mode of the map, being it one of
18652 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18653 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18655 * This function returns the current zoom mode used by the map object.
18657 * @see elm_map_zoom_mode_set() for more details.
18661 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18664 * Get the current coordinates of the map.
18666 * @param obj The map object.
18667 * @param lon Pointer where to store longitude.
18668 * @param lat Pointer where to store latitude.
18670 * This gets the current center coordinates of the map object. It can be
18671 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18673 * @see elm_map_geo_region_bring_in()
18674 * @see elm_map_geo_region_show()
18678 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18681 * Animatedly bring in given coordinates to the center of the map.
18683 * @param obj The map object.
18684 * @param lon Longitude to center at.
18685 * @param lat Latitude to center at.
18687 * This causes map to jump to the given @p lat and @p lon coordinates
18688 * and show it (by scrolling) in the center of the viewport, if it is not
18689 * already centered. This will use animation to do so and take a period
18690 * of time to complete.
18692 * @see elm_map_geo_region_show() for a function to avoid animation.
18693 * @see elm_map_geo_region_get()
18697 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18700 * Show the given coordinates at the center of the map, @b immediately.
18702 * @param obj The map object.
18703 * @param lon Longitude to center at.
18704 * @param lat Latitude to center at.
18706 * This causes map to @b redraw its viewport's contents to the
18707 * region contining the given @p lat and @p lon, that will be moved to the
18708 * center of the map.
18710 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18711 * @see elm_map_geo_region_get()
18715 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18718 * Pause or unpause the map.
18720 * @param obj The map object.
18721 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18724 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18727 * The default is off.
18729 * This will stop zooming using animation, changing zoom levels will
18730 * change instantly. This will stop any existing animations that are running.
18732 * @see elm_map_paused_get()
18736 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18739 * Get a value whether map is paused or not.
18741 * @param obj The map object.
18742 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18743 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18745 * This gets the current paused state for the map object.
18747 * @see elm_map_paused_set() for details.
18751 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18754 * Set to show markers during zoom level changes or not.
18756 * @param obj The map object.
18757 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18760 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18763 * The default is off.
18765 * This will stop zooming using animation, changing zoom levels will
18766 * change instantly. This will stop any existing animations that are running.
18768 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18771 * The default is off.
18773 * Enabling it will force the map to stop displaying the markers during
18774 * zoom level changes. Set to on if you have a large number of markers.
18776 * @see elm_map_paused_markers_get()
18780 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18783 * Get a value whether markers will be displayed on zoom level changes or not
18785 * @param obj The map object.
18786 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18787 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18789 * This gets the current markers paused state for the map object.
18791 * @see elm_map_paused_markers_set() for details.
18795 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18798 * Get the information of downloading status.
18800 * @param obj The map object.
18801 * @param try_num Pointer where to store number of tiles being downloaded.
18802 * @param finish_num Pointer where to store number of tiles successfully
18805 * This gets the current downloading status for the map object, the number
18806 * of tiles being downloaded and the number of tiles already downloaded.
18810 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18813 * Convert a pixel coordinate (x,y) into a geographic coordinate
18814 * (longitude, latitude).
18816 * @param obj The map object.
18817 * @param x the coordinate.
18818 * @param y the coordinate.
18819 * @param size the size in pixels of the map.
18820 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18821 * @param lon Pointer where to store the longitude that correspond to x.
18822 * @param lat Pointer where to store the latitude that correspond to y.
18824 * @note Origin pixel point is the top left corner of the viewport.
18825 * Map zoom and size are taken on account.
18827 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18831 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);
18834 * Convert a geographic coordinate (longitude, latitude) into a pixel
18835 * coordinate (x, y).
18837 * @param obj The map object.
18838 * @param lon the longitude.
18839 * @param lat the latitude.
18840 * @param size the size in pixels of the map. The map is a square
18841 * and generally his size is : pow(2.0, zoom)*256.
18842 * @param x Pointer where to store the horizontal pixel coordinate that
18843 * correspond to the longitude.
18844 * @param y Pointer where to store the vertical pixel coordinate that
18845 * correspond to the latitude.
18847 * @note Origin pixel point is the top left corner of the viewport.
18848 * Map zoom and size are taken on account.
18850 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18854 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);
18857 * Convert a geographic coordinate (longitude, latitude) into a name
18860 * @param obj The map object.
18861 * @param lon the longitude.
18862 * @param lat the latitude.
18863 * @return name A #Elm_Map_Name handle for this coordinate.
18865 * To get the string for this address, elm_map_name_address_get()
18868 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18872 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18875 * Convert a name (address) into a geographic coordinate
18876 * (longitude, latitude).
18878 * @param obj The map object.
18879 * @param name The address.
18880 * @return name A #Elm_Map_Name handle for this address.
18882 * To get the longitude and latitude, elm_map_name_region_get()
18885 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18889 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18892 * Convert a pixel coordinate into a rotated pixel coordinate.
18894 * @param obj The map object.
18895 * @param x horizontal coordinate of the point to rotate.
18896 * @param y vertical coordinate of the point to rotate.
18897 * @param cx rotation's center horizontal position.
18898 * @param cy rotation's center vertical position.
18899 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18900 * @param xx Pointer where to store rotated x.
18901 * @param yy Pointer where to store rotated y.
18905 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);
18908 * Add a new marker to the map object.
18910 * @param obj The map object.
18911 * @param lon The longitude of the marker.
18912 * @param lat The latitude of the marker.
18913 * @param clas The class, to use when marker @b isn't grouped to others.
18914 * @param clas_group The class group, to use when marker is grouped to others
18915 * @param data The data passed to the callbacks.
18917 * @return The created marker or @c NULL upon failure.
18919 * A marker will be created and shown in a specific point of the map, defined
18920 * by @p lon and @p lat.
18922 * It will be displayed using style defined by @p class when this marker
18923 * is displayed alone (not grouped). A new class can be created with
18924 * elm_map_marker_class_new().
18926 * If the marker is grouped to other markers, it will be displayed with
18927 * style defined by @p class_group. Markers with the same group are grouped
18928 * if they are close. A new group class can be created with
18929 * elm_map_marker_group_class_new().
18931 * Markers created with this method can be deleted with
18932 * elm_map_marker_remove().
18934 * A marker can have associated content to be displayed by a bubble,
18935 * when a user click over it, as well as an icon. These objects will
18936 * be fetch using class' callback functions.
18938 * @see elm_map_marker_class_new()
18939 * @see elm_map_marker_group_class_new()
18940 * @see elm_map_marker_remove()
18944 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);
18947 * Set the maximum numbers of markers' content to be displayed in a group.
18949 * @param obj The map object.
18950 * @param max The maximum numbers of items displayed in a bubble.
18952 * A bubble will be displayed when the user clicks over the group,
18953 * and will place the content of markers that belong to this group
18956 * A group can have a long list of markers, consequently the creation
18957 * of the content of the bubble can be very slow.
18959 * In order to avoid this, a maximum number of items is displayed
18962 * By default this number is 30.
18964 * Marker with the same group class are grouped if they are close.
18966 * @see elm_map_marker_add()
18970 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18973 * Remove a marker from the map.
18975 * @param marker The marker to remove.
18977 * @see elm_map_marker_add()
18981 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18984 * Get the current coordinates of the marker.
18986 * @param marker marker.
18987 * @param lat Pointer where to store the marker's latitude.
18988 * @param lon Pointer where to store the marker's longitude.
18990 * These values are set when adding markers, with function
18991 * elm_map_marker_add().
18993 * @see elm_map_marker_add()
18997 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19000 * Animatedly bring in given marker to the center of the map.
19002 * @param marker The marker to center at.
19004 * This causes map to jump to the given @p marker's coordinates
19005 * and show it (by scrolling) in the center of the viewport, if it is not
19006 * already centered. This will use animation to do so and take a period
19007 * of time to complete.
19009 * @see elm_map_marker_show() for a function to avoid animation.
19010 * @see elm_map_marker_region_get()
19014 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19017 * Show the given marker at the center of the map, @b immediately.
19019 * @param marker The marker to center at.
19021 * This causes map to @b redraw its viewport's contents to the
19022 * region contining the given @p marker's coordinates, that will be
19023 * moved to the center of the map.
19025 * @see elm_map_marker_bring_in() for a function to move with animation.
19026 * @see elm_map_markers_list_show() if more than one marker need to be
19028 * @see elm_map_marker_region_get()
19032 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19035 * Move and zoom the map to display a list of markers.
19037 * @param markers A list of #Elm_Map_Marker handles.
19039 * The map will be centered on the center point of the markers in the list.
19040 * Then the map will be zoomed in order to fit the markers using the maximum
19041 * zoom which allows display of all the markers.
19043 * @warning All the markers should belong to the same map object.
19045 * @see elm_map_marker_show() to show a single marker.
19046 * @see elm_map_marker_bring_in()
19050 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19053 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19055 * @param marker The marker wich content should be returned.
19056 * @return Return the evas object if it exists, else @c NULL.
19058 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19059 * elm_map_marker_class_get_cb_set() should be used.
19061 * This content is what will be inside the bubble that will be displayed
19062 * when an user clicks over the marker.
19064 * This returns the actual Evas object used to be placed inside
19065 * the bubble. This may be @c NULL, as it may
19066 * not have been created or may have been deleted, at any time, by
19067 * the map. <b>Do not modify this object</b> (move, resize,
19068 * show, hide, etc.), as the map is controlling it. This
19069 * function is for querying, emitting custom signals or hooking
19070 * lower level callbacks for events on that object. Do not delete
19071 * this object under any circumstances.
19075 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19078 * Update the marker
19080 * @param marker The marker to be updated.
19082 * If a content is set to this marker, it will call function to delete it,
19083 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19084 * #ElmMapMarkerGetFunc.
19086 * These functions are set for the marker class with
19087 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19091 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19094 * Close all the bubbles opened by the user.
19096 * @param obj The map object.
19098 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19099 * when the user clicks on a marker.
19101 * This functions is set for the marker class with
19102 * elm_map_marker_class_get_cb_set().
19106 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19109 * Create a new group class.
19111 * @param obj The map object.
19112 * @return Returns the new group class.
19114 * Each marker must be associated to a group class. Markers in the same
19115 * group are grouped if they are close.
19117 * The group class defines the style of the marker when a marker is grouped
19118 * to others markers. When it is alone, another class will be used.
19120 * A group class will need to be provided when creating a marker with
19121 * elm_map_marker_add().
19123 * Some properties and functions can be set by class, as:
19124 * - style, with elm_map_group_class_style_set()
19125 * - data - to be associated to the group class. It can be set using
19126 * elm_map_group_class_data_set().
19127 * - min zoom to display markers, set with
19128 * elm_map_group_class_zoom_displayed_set().
19129 * - max zoom to group markers, set using
19130 * elm_map_group_class_zoom_grouped_set().
19131 * - visibility - set if markers will be visible or not, set with
19132 * elm_map_group_class_hide_set().
19133 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19134 * It can be set using elm_map_group_class_icon_cb_set().
19136 * @see elm_map_marker_add()
19137 * @see elm_map_group_class_style_set()
19138 * @see elm_map_group_class_data_set()
19139 * @see elm_map_group_class_zoom_displayed_set()
19140 * @see elm_map_group_class_zoom_grouped_set()
19141 * @see elm_map_group_class_hide_set()
19142 * @see elm_map_group_class_icon_cb_set()
19146 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19149 * Set the marker's style of a group class.
19151 * @param clas The group class.
19152 * @param style The style to be used by markers.
19154 * Each marker must be associated to a group class, and will use the style
19155 * defined by such class when grouped to other markers.
19157 * The following styles are provided by default theme:
19158 * @li @c radio - blue circle
19159 * @li @c radio2 - green circle
19162 * @see elm_map_group_class_new() for more details.
19163 * @see elm_map_marker_add()
19167 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19170 * Set the icon callback function of a group class.
19172 * @param clas The group class.
19173 * @param icon_get The callback function that will return the icon.
19175 * Each marker must be associated to a group class, and it can display a
19176 * custom icon. The function @p icon_get must return this icon.
19178 * @see elm_map_group_class_new() for more details.
19179 * @see elm_map_marker_add()
19183 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19186 * Set the data associated to the group class.
19188 * @param clas The group class.
19189 * @param data The new user data.
19191 * This data will be passed for callback functions, like icon get callback,
19192 * that can be set with elm_map_group_class_icon_cb_set().
19194 * If a data was previously set, the object will lose the pointer for it,
19195 * so if needs to be freed, you must do it yourself.
19197 * @see elm_map_group_class_new() for more details.
19198 * @see elm_map_group_class_icon_cb_set()
19199 * @see elm_map_marker_add()
19203 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19206 * Set the minimum zoom from where the markers are displayed.
19208 * @param clas The group class.
19209 * @param zoom The minimum zoom.
19211 * Markers only will be displayed when the map is displayed at @p zoom
19214 * @see elm_map_group_class_new() for more details.
19215 * @see elm_map_marker_add()
19219 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19222 * Set the zoom from where the markers are no more grouped.
19224 * @param clas The group class.
19225 * @param zoom The maximum zoom.
19227 * Markers only will be grouped when the map is displayed at
19228 * less than @p zoom.
19230 * @see elm_map_group_class_new() for more details.
19231 * @see elm_map_marker_add()
19235 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19238 * Set if the markers associated to the group class @clas are hidden or not.
19240 * @param clas The group class.
19241 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19244 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19249 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19252 * Create a new marker class.
19254 * @param obj The map object.
19255 * @return Returns the new group class.
19257 * Each marker must be associated to a class.
19259 * The marker class defines the style of the marker when a marker is
19260 * displayed alone, i.e., not grouped to to others markers. When grouped
19261 * it will use group class style.
19263 * A marker class will need to be provided when creating a marker with
19264 * elm_map_marker_add().
19266 * Some properties and functions can be set by class, as:
19267 * - style, with elm_map_marker_class_style_set()
19268 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19269 * It can be set using elm_map_marker_class_icon_cb_set().
19270 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19271 * Set using elm_map_marker_class_get_cb_set().
19272 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19273 * Set using elm_map_marker_class_del_cb_set().
19275 * @see elm_map_marker_add()
19276 * @see elm_map_marker_class_style_set()
19277 * @see elm_map_marker_class_icon_cb_set()
19278 * @see elm_map_marker_class_get_cb_set()
19279 * @see elm_map_marker_class_del_cb_set()
19283 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19286 * Set the marker's style of a marker class.
19288 * @param clas The marker class.
19289 * @param style The style to be used by markers.
19291 * Each marker must be associated to a marker class, and will use the style
19292 * defined by such class when alone, i.e., @b not grouped to other markers.
19294 * The following styles are provided by default theme:
19299 * @see elm_map_marker_class_new() for more details.
19300 * @see elm_map_marker_add()
19304 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19307 * Set the icon callback function of a marker class.
19309 * @param clas The marker class.
19310 * @param icon_get The callback function that will return the icon.
19312 * Each marker must be associated to a marker class, and it can display a
19313 * custom icon. The function @p icon_get must return this icon.
19315 * @see elm_map_marker_class_new() for more details.
19316 * @see elm_map_marker_add()
19320 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19323 * Set the bubble content callback function of a marker class.
19325 * @param clas The marker class.
19326 * @param get The callback function that will return the content.
19328 * Each marker must be associated to a marker class, and it can display a
19329 * a content on a bubble that opens when the user click over the marker.
19330 * The function @p get must return this content object.
19332 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19335 * @see elm_map_marker_class_new() for more details.
19336 * @see elm_map_marker_class_del_cb_set()
19337 * @see elm_map_marker_add()
19341 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19344 * Set the callback function used to delete bubble content of a marker class.
19346 * @param clas The marker class.
19347 * @param del The callback function that will delete the content.
19349 * Each marker must be associated to a marker class, and it can display a
19350 * a content on a bubble that opens when the user click over the marker.
19351 * The function to return such content can be set with
19352 * elm_map_marker_class_get_cb_set().
19354 * If this content must be freed, a callback function need to be
19355 * set for that task with this function.
19357 * If this callback is defined it will have to delete (or not) the
19358 * object inside, but if the callback is not defined the object will be
19359 * destroyed with evas_object_del().
19361 * @see elm_map_marker_class_new() for more details.
19362 * @see elm_map_marker_class_get_cb_set()
19363 * @see elm_map_marker_add()
19367 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19370 * Get the list of available sources.
19372 * @param obj The map object.
19373 * @return The source names list.
19375 * It will provide a list with all available sources, that can be set as
19376 * current source with elm_map_source_name_set(), or get with
19377 * elm_map_source_name_get().
19379 * Available sources:
19385 * @see elm_map_source_name_set() for more details.
19386 * @see elm_map_source_name_get()
19390 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19393 * Set the source of the map.
19395 * @param obj The map object.
19396 * @param source The source to be used.
19398 * Map widget retrieves images that composes the map from a web service.
19399 * This web service can be set with this method.
19401 * A different service can return a different maps with different
19402 * information and it can use different zoom values.
19404 * The @p source_name need to match one of the names provided by
19405 * elm_map_source_names_get().
19407 * The current source can be get using elm_map_source_name_get().
19409 * @see elm_map_source_names_get()
19410 * @see elm_map_source_name_get()
19415 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19418 * Get the name of currently used source.
19420 * @param obj The map object.
19421 * @return Returns the name of the source in use.
19423 * @see elm_map_source_name_set() for more details.
19427 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19430 * Set the source of the route service to be used by the map.
19432 * @param obj The map object.
19433 * @param source The route service to be used, being it one of
19434 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19435 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19437 * Each one has its own algorithm, so the route retrieved may
19438 * differ depending on the source route. Now, only the default is working.
19440 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19441 * http://www.yournavigation.org/.
19443 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19444 * assumptions. Its routing core is based on Contraction Hierarchies.
19446 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19448 * @see elm_map_route_source_get().
19452 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19455 * Get the current route source.
19457 * @param obj The map object.
19458 * @return The source of the route service used by the map.
19460 * @see elm_map_route_source_set() for details.
19464 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19467 * Set the minimum zoom of the source.
19469 * @param obj The map object.
19470 * @param zoom New minimum zoom value to be used.
19472 * By default, it's 0.
19476 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19479 * Get the minimum zoom of the source.
19481 * @param obj The map object.
19482 * @return Returns the minimum zoom of the source.
19484 * @see elm_map_source_zoom_min_set() for details.
19488 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19491 * Set the maximum zoom of the source.
19493 * @param obj The map object.
19494 * @param zoom New maximum zoom value to be used.
19496 * By default, it's 18.
19500 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19503 * Get the maximum zoom of the source.
19505 * @param obj The map object.
19506 * @return Returns the maximum zoom of the source.
19508 * @see elm_map_source_zoom_min_set() for details.
19512 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19515 * Set the user agent used by the map object to access routing services.
19517 * @param obj The map object.
19518 * @param user_agent The user agent to be used by the map.
19520 * User agent is a client application implementing a network protocol used
19521 * in communications within a client–server distributed computing system
19523 * The @p user_agent identification string will transmitted in a header
19524 * field @c User-Agent.
19526 * @see elm_map_user_agent_get()
19530 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19533 * Get the user agent used by the map object.
19535 * @param obj The map object.
19536 * @return The user agent identification string used by the map.
19538 * @see elm_map_user_agent_set() for details.
19542 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19545 * Add a new route to the map object.
19547 * @param obj The map object.
19548 * @param type The type of transport to be considered when tracing a route.
19549 * @param method The routing method, what should be priorized.
19550 * @param flon The start longitude.
19551 * @param flat The start latitude.
19552 * @param tlon The destination longitude.
19553 * @param tlat The destination latitude.
19555 * @return The created route or @c NULL upon failure.
19557 * A route will be traced by point on coordinates (@p flat, @p flon)
19558 * to point on coordinates (@p tlat, @p tlon), using the route service
19559 * set with elm_map_route_source_set().
19561 * It will take @p type on consideration to define the route,
19562 * depending if the user will be walking or driving, the route may vary.
19563 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19564 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19566 * Another parameter is what the route should priorize, the minor distance
19567 * or the less time to be spend on the route. So @p method should be one
19568 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19570 * Routes created with this method can be deleted with
19571 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19572 * and distance can be get with elm_map_route_distance_get().
19574 * @see elm_map_route_remove()
19575 * @see elm_map_route_color_set()
19576 * @see elm_map_route_distance_get()
19577 * @see elm_map_route_source_set()
19581 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);
19584 * Remove a route from the map.
19586 * @param route The route to remove.
19588 * @see elm_map_route_add()
19592 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19595 * Set the route color.
19597 * @param route The route object.
19598 * @param r Red channel value, from 0 to 255.
19599 * @param g Green channel value, from 0 to 255.
19600 * @param b Blue channel value, from 0 to 255.
19601 * @param a Alpha channel value, from 0 to 255.
19603 * It uses an additive color model, so each color channel represents
19604 * how much of each primary colors must to be used. 0 represents
19605 * ausence of this color, so if all of the three are set to 0,
19606 * the color will be black.
19608 * These component values should be integers in the range 0 to 255,
19609 * (single 8-bit byte).
19611 * This sets the color used for the route. By default, it is set to
19612 * solid red (r = 255, g = 0, b = 0, a = 255).
19614 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19616 * @see elm_map_route_color_get()
19620 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19623 * Get the route color.
19625 * @param route The route object.
19626 * @param r Pointer where to store the red channel value.
19627 * @param g Pointer where to store the green channel value.
19628 * @param b Pointer where to store the blue channel value.
19629 * @param a Pointer where to store the alpha channel value.
19631 * @see elm_map_route_color_set() for details.
19635 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19638 * Get the route distance in kilometers.
19640 * @param route The route object.
19641 * @return The distance of route (unit : km).
19645 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19648 * Get the information of route nodes.
19650 * @param route The route object.
19651 * @return Returns a string with the nodes of route.
19655 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19658 * Get the information of route waypoint.
19660 * @param route the route object.
19661 * @return Returns a string with information about waypoint of route.
19665 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19668 * Get the address of the name.
19670 * @param name The name handle.
19671 * @return Returns the address string of @p name.
19673 * This gets the coordinates of the @p name, created with one of the
19674 * conversion functions.
19676 * @see elm_map_utils_convert_name_into_coord()
19677 * @see elm_map_utils_convert_coord_into_name()
19681 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19684 * Get the current coordinates of the name.
19686 * @param name The name handle.
19687 * @param lat Pointer where to store the latitude.
19688 * @param lon Pointer where to store The longitude.
19690 * This gets the coordinates of the @p name, created with one of the
19691 * conversion functions.
19693 * @see elm_map_utils_convert_name_into_coord()
19694 * @see elm_map_utils_convert_coord_into_name()
19698 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19701 * Remove a name from the map.
19703 * @param name The name to remove.
19705 * Basically the struct handled by @p name will be freed, so convertions
19706 * between address and coordinates will be lost.
19708 * @see elm_map_utils_convert_name_into_coord()
19709 * @see elm_map_utils_convert_coord_into_name()
19713 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19718 * @param obj The map object.
19719 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19720 * @param cx Rotation's center horizontal position.
19721 * @param cy Rotation's center vertical position.
19723 * @see elm_map_rotate_get()
19727 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19730 * Get the rotate degree of the map
19732 * @param obj The map object
19733 * @param degree Pointer where to store degrees from 0.0 to 360.0
19734 * to rotate arount Z axis.
19735 * @param cx Pointer where to store rotation's center horizontal position.
19736 * @param cy Pointer where to store rotation's center vertical position.
19738 * @see elm_map_rotate_set() to set map rotation.
19742 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);
19745 * Enable or disable mouse wheel to be used to zoom in / out the map.
19747 * @param obj The map object.
19748 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19751 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19753 * It's disabled by default.
19755 * @see elm_map_wheel_disabled_get()
19759 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19762 * Get a value whether mouse wheel is enabled or not.
19764 * @param obj The map object.
19765 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19766 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19768 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19770 * @see elm_map_wheel_disabled_set() for details.
19774 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19778 * Add a track on the map
19780 * @param obj The map object.
19781 * @param emap The emap route object.
19782 * @return The route object. This is an elm object of type Route.
19784 * @see elm_route_add() for details.
19788 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19792 * Remove a track from the map
19794 * @param obj The map object.
19795 * @param route The track to remove.
19799 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19806 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19808 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19810 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19811 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19812 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19813 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19817 * @defgroup Panel Panel
19819 * @image html img/widget/panel/preview-00.png
19820 * @image latex img/widget/panel/preview-00.eps
19822 * @brief A panel is a type of animated container that contains subobjects.
19823 * It can be expanded or contracted by clicking the button on it's edge.
19825 * Orientations are as follows:
19826 * @li ELM_PANEL_ORIENT_TOP
19827 * @li ELM_PANEL_ORIENT_LEFT
19828 * @li ELM_PANEL_ORIENT_RIGHT
19830 * @ref tutorial_panel shows one way to use this widget.
19833 typedef enum _Elm_Panel_Orient
19835 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19836 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19837 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19838 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19839 } Elm_Panel_Orient;
19841 * @brief Adds a panel object
19843 * @param parent The parent object
19845 * @return The panel object, or NULL on failure
19847 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19849 * @brief Sets the orientation of the panel
19851 * @param parent The parent object
19852 * @param orient The panel orientation. Can be one of the following:
19853 * @li ELM_PANEL_ORIENT_TOP
19854 * @li ELM_PANEL_ORIENT_LEFT
19855 * @li ELM_PANEL_ORIENT_RIGHT
19857 * Sets from where the panel will (dis)appear.
19859 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19861 * @brief Get the orientation of the panel.
19863 * @param obj The panel object
19864 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19866 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19868 * @brief Set the content of the panel.
19870 * @param obj The panel object
19871 * @param content The panel content
19873 * Once the content object is set, a previously set one will be deleted.
19874 * If you want to keep that old content object, use the
19875 * elm_panel_content_unset() function.
19877 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19879 * @brief Get the content of the panel.
19881 * @param obj The panel object
19882 * @return The content that is being used
19884 * Return the content object which is set for this widget.
19886 * @see elm_panel_content_set()
19888 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19890 * @brief Unset the content of the panel.
19892 * @param obj The panel object
19893 * @return The content that was being used
19895 * Unparent and return the content object which was set for this widget.
19897 * @see elm_panel_content_set()
19899 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19901 * @brief Set the state of the panel.
19903 * @param obj The panel object
19904 * @param hidden If true, the panel will run the animation to contract
19906 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19908 * @brief Get the state of the panel.
19910 * @param obj The panel object
19911 * @param hidden If true, the panel is in the "hide" state
19913 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19915 * @brief Toggle the hidden state of the panel from code
19917 * @param obj The panel object
19919 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19925 * @defgroup Panes Panes
19926 * @ingroup Elementary
19928 * @image html img/widget/panes/preview-00.png
19929 * @image latex img/widget/panes/preview-00.eps width=\textwidth
19931 * @image html img/panes.png
19932 * @image latex img/panes.eps width=\textwidth
19934 * The panes adds a dragable bar between two contents. When dragged
19935 * this bar will resize contents size.
19937 * Panes can be displayed vertically or horizontally, and contents
19938 * size proportion can be customized (homogeneous by default).
19940 * Smart callbacks one can listen to:
19941 * - "press" - The panes has been pressed (button wasn't released yet).
19942 * - "unpressed" - The panes was released after being pressed.
19943 * - "clicked" - The panes has been clicked>
19944 * - "clicked,double" - The panes has been double clicked
19946 * Available styles for it:
19949 * Here is an example on its usage:
19950 * @li @ref panes_example
19954 * @addtogroup Panes
19959 * Add a new panes widget to the given parent Elementary
19960 * (container) object.
19962 * @param parent The parent object.
19963 * @return a new panes widget handle or @c NULL, on errors.
19965 * This function inserts a new panes widget on the canvas.
19969 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19972 * Set the left content of the panes widget.
19974 * @param obj The panes object.
19975 * @param content The new left content object.
19977 * Once the content object is set, a previously set one will be deleted.
19978 * If you want to keep that old content object, use the
19979 * elm_panes_content_left_unset() function.
19981 * If panes is displayed vertically, left content will be displayed at
19984 * @see elm_panes_content_left_get()
19985 * @see elm_panes_content_right_set() to set content on the other side.
19989 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19992 * Set the right content of the panes widget.
19994 * @param obj The panes object.
19995 * @param content The new right content object.
19997 * Once the content object is set, a previously set one will be deleted.
19998 * If you want to keep that old content object, use the
19999 * elm_panes_content_right_unset() function.
20001 * If panes is displayed vertically, left content will be displayed at
20004 * @see elm_panes_content_right_get()
20005 * @see elm_panes_content_left_set() to set content on the other side.
20009 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20012 * Get the left content of the panes.
20014 * @param obj The panes object.
20015 * @return The left content object that is being used.
20017 * Return the left content object which is set for this widget.
20019 * @see elm_panes_content_left_set() for details.
20023 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20026 * Get the right content of the panes.
20028 * @param obj The panes object
20029 * @return The right content object that is being used
20031 * Return the right content object which is set for this widget.
20033 * @see elm_panes_content_right_set() for details.
20037 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20040 * Unset the left content used for the panes.
20042 * @param obj The panes object.
20043 * @return The left content object that was being used.
20045 * Unparent and return the left content object which was set for this widget.
20047 * @see elm_panes_content_left_set() for details.
20048 * @see elm_panes_content_left_get().
20052 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20055 * Unset the right content used for the panes.
20057 * @param obj The panes object.
20058 * @return The right content object that was being used.
20060 * Unparent and return the right content object which was set for this
20063 * @see elm_panes_content_right_set() for details.
20064 * @see elm_panes_content_right_get().
20068 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20071 * Get the size proportion of panes widget's left side.
20073 * @param obj The panes object.
20074 * @return float value between 0.0 and 1.0 representing size proportion
20077 * @see elm_panes_content_left_size_set() for more details.
20081 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20084 * Set the size proportion of panes widget's left side.
20086 * @param obj The panes object.
20087 * @param size Value between 0.0 and 1.0 representing size proportion
20090 * By default it's homogeneous, i.e., both sides have the same size.
20092 * If something different is required, it can be set with this function.
20093 * For example, if the left content should be displayed over
20094 * 75% of the panes size, @p size should be passed as @c 0.75.
20095 * This way, right content will be resized to 25% of panes size.
20097 * If displayed vertically, left content is displayed at top, and
20098 * right content at bottom.
20100 * @note This proportion will change when user drags the panes bar.
20102 * @see elm_panes_content_left_size_get()
20106 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20109 * Set the orientation of a given panes widget.
20111 * @param obj The panes object.
20112 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20113 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20115 * Use this function to change how your panes is to be
20116 * disposed: vertically or horizontally.
20118 * By default it's displayed horizontally.
20120 * @see elm_panes_horizontal_get()
20124 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20127 * Retrieve the orientation of a given panes widget.
20129 * @param obj The panes object.
20130 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20131 * @c EINA_FALSE if it's @b vertical (and on errors).
20133 * @see elm_panes_horizontal_set() for more details.
20137 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20144 * @defgroup Flip Flip
20146 * @image html img/widget/flip/preview-00.png
20147 * @image latex img/widget/flip/preview-00.eps
20149 * This widget holds 2 content objects(Evas_Object): one on the front and one
20150 * on the back. It allows you to flip from front to back and vice-versa using
20151 * various animations.
20153 * If either the front or back contents are not set the flip will treat that
20154 * as transparent. So if you wore to set the front content but not the back,
20155 * and then call elm_flip_go() you would see whatever is below the flip.
20157 * For a list of supported animations see elm_flip_go().
20159 * Signals that you can add callbacks for are:
20160 * "animate,begin" - when a flip animation was started
20161 * "animate,done" - when a flip animation is finished
20163 * @ref tutorial_flip show how to use most of the API.
20167 typedef enum _Elm_Flip_Mode
20169 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20170 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20171 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20172 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20173 ELM_FLIP_CUBE_LEFT,
20174 ELM_FLIP_CUBE_RIGHT,
20176 ELM_FLIP_CUBE_DOWN,
20177 ELM_FLIP_PAGE_LEFT,
20178 ELM_FLIP_PAGE_RIGHT,
20182 typedef enum _Elm_Flip_Interaction
20184 ELM_FLIP_INTERACTION_NONE,
20185 ELM_FLIP_INTERACTION_ROTATE,
20186 ELM_FLIP_INTERACTION_CUBE,
20187 ELM_FLIP_INTERACTION_PAGE
20188 } Elm_Flip_Interaction;
20189 typedef enum _Elm_Flip_Direction
20191 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20192 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20193 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20194 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20195 } Elm_Flip_Direction;
20197 * @brief Add a new flip to the parent
20199 * @param parent The parent object
20200 * @return The new object or NULL if it cannot be created
20202 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20204 * @brief Set the front content of the flip widget.
20206 * @param obj The flip object
20207 * @param content The new front content object
20209 * Once the content object is set, a previously set one will be deleted.
20210 * If you want to keep that old content object, use the
20211 * elm_flip_content_front_unset() function.
20213 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20215 * @brief Set the back content of the flip widget.
20217 * @param obj The flip object
20218 * @param content The new back content object
20220 * Once the content object is set, a previously set one will be deleted.
20221 * If you want to keep that old content object, use the
20222 * elm_flip_content_back_unset() function.
20224 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20226 * @brief Get the front content used for the flip
20228 * @param obj The flip object
20229 * @return The front content object that is being used
20231 * Return the front content object which is set for this widget.
20233 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20235 * @brief Get the back content used for the flip
20237 * @param obj The flip object
20238 * @return The back content object that is being used
20240 * Return the back content object which is set for this widget.
20242 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20244 * @brief Unset the front content used for the flip
20246 * @param obj The flip object
20247 * @return The front content object that was being used
20249 * Unparent and return the front content object which was set for this widget.
20251 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20253 * @brief Unset the back content used for the flip
20255 * @param obj The flip object
20256 * @return The back content object that was being used
20258 * Unparent and return the back content object which was set for this widget.
20260 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20262 * @brief Get flip front visibility state
20264 * @param obj The flip objct
20265 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20268 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20270 * @brief Set flip perspective
20272 * @param obj The flip object
20273 * @param foc The coordinate to set the focus on
20274 * @param x The X coordinate
20275 * @param y The Y coordinate
20277 * @warning This function currently does nothing.
20279 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20281 * @brief Runs the flip animation
20283 * @param obj The flip object
20284 * @param mode The mode type
20286 * Flips the front and back contents using the @p mode animation. This
20287 * efectively hides the currently visible content and shows the hidden one.
20289 * There a number of possible animations to use for the flipping:
20290 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20291 * around a horizontal axis in the middle of its height, the other content
20292 * is shown as the other side of the flip.
20293 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20294 * around a vertical axis in the middle of its width, the other content is
20295 * shown as the other side of the flip.
20296 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20297 * around a diagonal axis in the middle of its width, the other content is
20298 * shown as the other side of the flip.
20299 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20300 * around a diagonal axis in the middle of its height, the other content is
20301 * shown as the other side of the flip.
20302 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20303 * as if the flip was a cube, the other content is show as the right face of
20305 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20306 * right as if the flip was a cube, the other content is show as the left
20307 * face of the cube.
20308 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20309 * flip was a cube, the other content is show as the bottom face of the cube.
20310 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20311 * the flip was a cube, the other content is show as the upper face of the
20313 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20314 * if the flip was a book, the other content is shown as the page below that.
20315 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20316 * as if the flip was a book, the other content is shown as the page below
20318 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20319 * flip was a book, the other content is shown as the page below that.
20320 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20321 * flip was a book, the other content is shown as the page below that.
20323 * @image html elm_flip.png
20324 * @image latex elm_flip.eps width=\textwidth
20326 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20328 * @brief Set the interactive flip mode
20330 * @param obj The flip object
20331 * @param mode The interactive flip mode to use
20333 * This sets if the flip should be interactive (allow user to click and
20334 * drag a side of the flip to reveal the back page and cause it to flip).
20335 * By default a flip is not interactive. You may also need to set which
20336 * sides of the flip are "active" for flipping and how much space they use
20337 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20338 * and elm_flip_interacton_direction_hitsize_set()
20340 * The four avilable mode of interaction are:
20341 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20342 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20343 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20344 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20346 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20347 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20348 * happen, those can only be acheived with elm_flip_go();
20350 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20352 * @brief Get the interactive flip mode
20354 * @param obj The flip object
20355 * @return The interactive flip mode
20357 * Returns the interactive flip mode set by elm_flip_interaction_set()
20359 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20361 * @brief Set which directions of the flip respond to interactive flip
20363 * @param obj The flip object
20364 * @param dir The direction to change
20365 * @param enabled If that direction is enabled or not
20367 * By default all directions are disabled, so you may want to enable the
20368 * desired directions for flipping if you need interactive flipping. You must
20369 * call this function once for each direction that should be enabled.
20371 * @see elm_flip_interaction_set()
20373 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20375 * @brief Get the enabled state of that flip direction
20377 * @param obj The flip object
20378 * @param dir The direction to check
20379 * @return If that direction is enabled or not
20381 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20383 * @see elm_flip_interaction_set()
20385 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20387 * @brief Set the amount of the flip that is sensitive to interactive flip
20389 * @param obj The flip object
20390 * @param dir The direction to modify
20391 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20393 * Set the amount of the flip that is sensitive to interactive flip, with 0
20394 * representing no area in the flip and 1 representing the entire flip. There
20395 * is however a consideration to be made in that the area will never be
20396 * smaller than the finger size set(as set in your Elementary configuration).
20398 * @see elm_flip_interaction_set()
20400 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20402 * @brief Get the amount of the flip that is sensitive to interactive flip
20404 * @param obj The flip object
20405 * @param dir The direction to check
20406 * @return The size set for that direction
20408 * Returns the amount os sensitive area set by
20409 * elm_flip_interacton_direction_hitsize_set().
20411 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20416 /* scrolledentry */
20417 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20418 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20419 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20420 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20421 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20422 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20423 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20424 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20425 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20426 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20427 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20428 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20429 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20430 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20431 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20432 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20433 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20434 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20435 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20436 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20437 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20438 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20439 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20440 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20441 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20442 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20443 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20444 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20445 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20446 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20447 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20448 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20449 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20450 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20451 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20452 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);
20453 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20454 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20455 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);
20456 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20457 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);
20458 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20459 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20460 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20461 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20462 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20463 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20464 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20465 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20466 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);
20467 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);
20468 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);
20469 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);
20470 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);
20471 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);
20472 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20473 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20474 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20476 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20477 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20478 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20481 * @defgroup Conformant Conformant
20482 * @ingroup Elementary
20484 * @image html img/widget/conformant/preview-00.png
20485 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20487 * @image html img/conformant.png
20488 * @image latex img/conformant.eps width=\textwidth
20490 * The aim is to provide a widget that can be used in elementary apps to
20491 * account for space taken up by the indicator, virtual keypad & softkey
20492 * windows when running the illume2 module of E17.
20494 * So conformant content will be sized and positioned considering the
20495 * space required for such stuff, and when they popup, as a keyboard
20496 * shows when an entry is selected, conformant content won't change.
20498 * Available styles for it:
20501 * See how to use this widget in this example:
20502 * @ref conformant_example
20506 * @addtogroup Conformant
20511 * Add a new conformant widget to the given parent Elementary
20512 * (container) object.
20514 * @param parent The parent object.
20515 * @return A new conformant widget handle or @c NULL, on errors.
20517 * This function inserts a new conformant widget on the canvas.
20519 * @ingroup Conformant
20521 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20524 * Set the content of the conformant widget.
20526 * @param obj The conformant object.
20527 * @param content The content to be displayed by the conformant.
20529 * Content will be sized and positioned considering the space required
20530 * to display a virtual keyboard. So it won't fill all the conformant
20531 * size. This way is possible to be sure that content won't resize
20532 * or be re-positioned after the keyboard is displayed.
20534 * Once the content object is set, a previously set one will be deleted.
20535 * If you want to keep that old content object, use the
20536 * elm_conformat_content_unset() function.
20538 * @see elm_conformant_content_unset()
20539 * @see elm_conformant_content_get()
20541 * @ingroup Conformant
20543 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20546 * Get the content of the conformant widget.
20548 * @param obj The conformant object.
20549 * @return The content that is being used.
20551 * Return the content object which is set for this widget.
20552 * It won't be unparent from conformant. For that, use
20553 * elm_conformant_content_unset().
20555 * @see elm_conformant_content_set() for more details.
20556 * @see elm_conformant_content_unset()
20558 * @ingroup Conformant
20560 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20563 * Unset the content of the conformant widget.
20565 * @param obj The conformant object.
20566 * @return The content that was being used.
20568 * Unparent and return the content object which was set for this widget.
20570 * @see elm_conformant_content_set() for more details.
20572 * @ingroup Conformant
20574 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20577 * Returns the Evas_Object that represents the content area.
20579 * @param obj The conformant object.
20580 * @return The content area of the widget.
20582 * @ingroup Conformant
20584 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20591 * @defgroup Mapbuf Mapbuf
20592 * @ingroup Elementary
20594 * @image html img/widget/mapbuf/preview-00.png
20595 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20597 * This holds one content object and uses an Evas Map of transformation
20598 * points to be later used with this content. So the content will be
20599 * moved, resized, etc as a single image. So it will improve performance
20600 * when you have a complex interafce, with a lot of elements, and will
20601 * need to resize or move it frequently (the content object and its
20604 * See how to use this widget in this example:
20605 * @ref mapbuf_example
20609 * @addtogroup Mapbuf
20614 * Add a new mapbuf widget to the given parent Elementary
20615 * (container) object.
20617 * @param parent The parent object.
20618 * @return A new mapbuf widget handle or @c NULL, on errors.
20620 * This function inserts a new mapbuf widget on the canvas.
20624 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20627 * Set the content of the mapbuf.
20629 * @param obj The mapbuf object.
20630 * @param content The content that will be filled in this mapbuf object.
20632 * Once the content object is set, a previously set one will be deleted.
20633 * If you want to keep that old content object, use the
20634 * elm_mapbuf_content_unset() function.
20636 * To enable map, elm_mapbuf_enabled_set() should be used.
20640 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20643 * Get the content of the mapbuf.
20645 * @param obj The mapbuf object.
20646 * @return The content that is being used.
20648 * Return the content object which is set for this widget.
20650 * @see elm_mapbuf_content_set() for details.
20654 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657 * Unset the content of the mapbuf.
20659 * @param obj The mapbuf object.
20660 * @return The content that was being used.
20662 * Unparent and return the content object which was set for this widget.
20664 * @see elm_mapbuf_content_set() for details.
20668 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20671 * Enable or disable the map.
20673 * @param obj The mapbuf object.
20674 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20676 * This enables the map that is set or disables it. On enable, the object
20677 * geometry will be saved, and the new geometry will change (position and
20678 * size) to reflect the map geometry set.
20680 * Also, when enabled, alpha and smooth states will be used, so if the
20681 * content isn't solid, alpha should be enabled, for example, otherwise
20682 * a black retangle will fill the content.
20684 * When disabled, the stored map will be freed and geometry prior to
20685 * enabling the map will be restored.
20687 * It's disabled by default.
20689 * @see elm_mapbuf_alpha_set()
20690 * @see elm_mapbuf_smooth_set()
20694 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20697 * Get a value whether map is enabled or not.
20699 * @param obj The mapbuf object.
20700 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20701 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20703 * @see elm_mapbuf_enabled_set() for details.
20707 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20710 * Enable or disable smooth map rendering.
20712 * @param obj The mapbuf object.
20713 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20716 * This sets smoothing for map rendering. If the object is a type that has
20717 * its own smoothing settings, then both the smooth settings for this object
20718 * and the map must be turned off.
20720 * By default smooth maps are enabled.
20724 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20727 * Get a value whether smooth map rendering is enabled or not.
20729 * @param obj The mapbuf object.
20730 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20731 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20733 * @see elm_mapbuf_smooth_set() for details.
20737 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20740 * Set or unset alpha flag for map rendering.
20742 * @param obj The mapbuf object.
20743 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20746 * This sets alpha flag for map rendering. If the object is a type that has
20747 * its own alpha settings, then this will take precedence. Only image objects
20748 * have this currently. It stops alpha blending of the map area, and is
20749 * useful if you know the object and/or all sub-objects is 100% solid.
20751 * Alpha is enabled by default.
20755 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20758 * Get a value whether alpha blending is enabled or not.
20760 * @param obj The mapbuf object.
20761 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20762 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20764 * @see elm_mapbuf_alpha_set() for details.
20768 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20775 * @defgroup Flipselector Flip Selector
20777 * @image html img/widget/flipselector/preview-00.png
20778 * @image latex img/widget/flipselector/preview-00.eps
20780 * A flip selector is a widget to show a set of @b text items, one
20781 * at a time, with the same sheet switching style as the @ref Clock
20782 * "clock" widget, when one changes the current displaying sheet
20783 * (thus, the "flip" in the name).
20785 * User clicks to flip sheets which are @b held for some time will
20786 * make the flip selector to flip continuosly and automatically for
20787 * the user. The interval between flips will keep growing in time,
20788 * so that it helps the user to reach an item which is distant from
20789 * the current selection.
20791 * Smart callbacks one can register to:
20792 * - @c "selected" - when the widget's selected text item is changed
20793 * - @c "overflowed" - when the widget's current selection is changed
20794 * from the first item in its list to the last
20795 * - @c "underflowed" - when the widget's current selection is changed
20796 * from the last item in its list to the first
20798 * Available styles for it:
20801 * Here is an example on its usage:
20802 * @li @ref flipselector_example
20806 * @addtogroup Flipselector
20810 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20813 * Add a new flip selector widget to the given parent Elementary
20814 * (container) widget
20816 * @param parent The parent object
20817 * @return a new flip selector widget handle or @c NULL, on errors
20819 * This function inserts a new flip selector widget on the canvas.
20821 * @ingroup Flipselector
20823 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20826 * Programmatically select the next item of a flip selector widget
20828 * @param obj The flipselector object
20830 * @note The selection will be animated. Also, if it reaches the
20831 * end of its list of member items, it will continue with the first
20834 * @ingroup Flipselector
20836 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20839 * Programmatically select the previous item of a flip selector
20842 * @param obj The flipselector object
20844 * @note The selection will be animated. Also, if it reaches the
20845 * beginning of its list of member items, it will continue with the
20846 * last one backwards.
20848 * @ingroup Flipselector
20850 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20853 * Append a (text) item to a flip selector widget
20855 * @param obj The flipselector object
20856 * @param label The (text) label of the new item
20857 * @param func Convenience callback function to take place when
20859 * @param data Data passed to @p func, above
20860 * @return A handle to the item added or @c NULL, on errors
20862 * The widget's list of labels to show will be appended with the
20863 * given value. If the user wishes so, a callback function pointer
20864 * can be passed, which will get called when this same item is
20867 * @note The current selection @b won't be modified by appending an
20868 * element to the list.
20870 * @note The maximum length of the text label is going to be
20871 * determined <b>by the widget's theme</b>. Strings larger than
20872 * that value are going to be @b truncated.
20874 * @ingroup Flipselector
20876 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20879 * Prepend a (text) item to a flip selector widget
20881 * @param obj The flipselector object
20882 * @param label The (text) label of the new item
20883 * @param func Convenience callback function to take place when
20885 * @param data Data passed to @p func, above
20886 * @return A handle to the item added or @c NULL, on errors
20888 * The widget's list of labels to show will be prepended with the
20889 * given value. If the user wishes so, a callback function pointer
20890 * can be passed, which will get called when this same item is
20893 * @note The current selection @b won't be modified by prepending
20894 * an element to the list.
20896 * @note The maximum length of the text label is going to be
20897 * determined <b>by the widget's theme</b>. Strings larger than
20898 * that value are going to be @b truncated.
20900 * @ingroup Flipselector
20902 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20905 * Get the internal list of items in a given flip selector widget.
20907 * @param obj The flipselector object
20908 * @return The list of items (#Elm_Flipselector_Item as data) or
20909 * @c NULL on errors.
20911 * This list is @b not to be modified in any way and must not be
20912 * freed. Use the list members with functions like
20913 * elm_flipselector_item_label_set(),
20914 * elm_flipselector_item_label_get(),
20915 * elm_flipselector_item_del(),
20916 * elm_flipselector_item_selected_get(),
20917 * elm_flipselector_item_selected_set().
20919 * @warning This list is only valid until @p obj object's internal
20920 * items list is changed. It should be fetched again with another
20921 * call to this function when changes happen.
20923 * @ingroup Flipselector
20925 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20928 * Get the first item in the given flip selector widget's list of
20931 * @param obj The flipselector object
20932 * @return The first item or @c NULL, if it has no items (and on
20935 * @see elm_flipselector_item_append()
20936 * @see elm_flipselector_last_item_get()
20938 * @ingroup Flipselector
20940 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20943 * Get the last item in the given flip selector widget's list of
20946 * @param obj The flipselector object
20947 * @return The last item or @c NULL, if it has no items (and on
20950 * @see elm_flipselector_item_prepend()
20951 * @see elm_flipselector_first_item_get()
20953 * @ingroup Flipselector
20955 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20958 * Get the currently selected item in a flip selector widget.
20960 * @param obj The flipselector object
20961 * @return The selected item or @c NULL, if the widget has no items
20964 * @ingroup Flipselector
20966 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20969 * Set whether a given flip selector widget's item should be the
20970 * currently selected one.
20972 * @param item The flip selector item
20973 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20975 * This sets whether @p item is or not the selected (thus, under
20976 * display) one. If @p item is different than one under display,
20977 * the latter will be unselected. If the @p item is set to be
20978 * unselected, on the other hand, the @b first item in the widget's
20979 * internal members list will be the new selected one.
20981 * @see elm_flipselector_item_selected_get()
20983 * @ingroup Flipselector
20985 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20988 * Get whether a given flip selector widget's item is the currently
20991 * @param item The flip selector item
20992 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20995 * @see elm_flipselector_item_selected_set()
20997 * @ingroup Flipselector
20999 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21002 * Delete a given item from a flip selector widget.
21004 * @param item The item to delete
21006 * @ingroup Flipselector
21008 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21011 * Get the label of a given flip selector widget's item.
21013 * @param item The item to get label from
21014 * @return The text label of @p item or @c NULL, on errors
21016 * @see elm_flipselector_item_label_set()
21018 * @ingroup Flipselector
21020 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21023 * Set the label of a given flip selector widget's item.
21025 * @param item The item to set label on
21026 * @param label The text label string, in UTF-8 encoding
21028 * @see elm_flipselector_item_label_get()
21030 * @ingroup Flipselector
21032 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21035 * Gets the item before @p item in a flip selector widget's
21036 * internal list of items.
21038 * @param item The item to fetch previous from
21039 * @return The item before the @p item, in its parent's list. If
21040 * there is no previous item for @p item or there's an
21041 * error, @c NULL is returned.
21043 * @see elm_flipselector_item_next_get()
21045 * @ingroup Flipselector
21047 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21050 * Gets the item after @p item in a flip selector widget's
21051 * internal list of items.
21053 * @param item The item to fetch next from
21054 * @return The item after the @p item, in its parent's list. If
21055 * there is no next item for @p item or there's an
21056 * error, @c NULL is returned.
21058 * @see elm_flipselector_item_next_get()
21060 * @ingroup Flipselector
21062 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21065 * Set the interval on time updates for an user mouse button hold
21066 * on a flip selector widget.
21068 * @param obj The flip selector object
21069 * @param interval The (first) interval value in seconds
21071 * This interval value is @b decreased while the user holds the
21072 * mouse pointer either flipping up or flipping doww a given flip
21075 * This helps the user to get to a given item distant from the
21076 * current one easier/faster, as it will start to flip quicker and
21077 * quicker on mouse button holds.
21079 * The calculation for the next flip interval value, starting from
21080 * the one set with this call, is the previous interval divided by
21081 * 1.05, so it decreases a little bit.
21083 * The default starting interval value for automatic flips is
21086 * @see elm_flipselector_interval_get()
21088 * @ingroup Flipselector
21090 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21093 * Get the interval on time updates for an user mouse button hold
21094 * on a flip selector widget.
21096 * @param obj The flip selector object
21097 * @return The (first) interval value, in seconds, set on it
21099 * @see elm_flipselector_interval_set() for more details
21101 * @ingroup Flipselector
21103 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21110 * @addtogroup Animator Animator
21111 * @ingroup Elementary
21113 * @brief Functions to ease creation of animations.
21115 * elm_animator is designed to provide an easy way to create animations.
21116 * Creating an animation with elm_animator is as simple as setting a
21117 * duration, an operating callback and telling it to run the animation.
21118 * However that is not the full extent of elm_animator's ability, animations
21119 * can be paused and resumed, reversed and the animation need not be linear.
21121 * To run an animation you must specify at least a duration and operation
21122 * callback, not setting any other properties will create a linear animation
21123 * that runs once and is not reversed.
21125 * @ref elm_animator_example_page_01 "This" example should make all of that
21128 * @warning elm_animator is @b not a widget.
21132 * @brief Type of curve desired for animation.
21134 * The speed in which an animation happens doesn't have to be linear, some
21135 * animations will look better if they're accelerating or decelerating, so
21136 * elm_animator provides four options in this regard:
21138 * @image html elm_animator_curve_style.png
21139 * @image latex elm_animator_curve_style.eps width=\textwidth
21140 * As can be seen in the image the speed of the animation will be:
21141 * @li ELM_ANIMATOR_CURVE_LINEAR constant
21142 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21143 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21144 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21148 ELM_ANIMATOR_CURVE_LINEAR,
21149 ELM_ANIMATOR_CURVE_IN_OUT,
21150 ELM_ANIMATOR_CURVE_IN,
21151 ELM_ANIMATOR_CURVE_OUT
21152 } Elm_Animator_Curve_Style;
21153 typedef struct _Elm_Animator Elm_Animator;
21155 * Called back per loop of an elementary animators cycle
21156 * @param data user-data given to elm_animator_operation_callback_set()
21157 * @param animator the animator being run
21158 * @param double the position in the animation
21160 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21162 * Called back when an elementary animator finishes
21163 * @param data user-data given to elm_animator_completion_callback_set()
21165 typedef void (*Elm_Animator_Completion_Cb) (void *data);
21168 * @brief Create a new animator.
21170 * @param[in] parent Parent object
21172 * The @a parent argument can be set to NULL for no parent. If a parent is set
21173 * there is no need to call elm_animator_del(), when the parent is deleted it
21174 * will delete the animator.
21175 * @deprecated Use @ref Transit instead.
21177 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
21179 * Deletes the animator freeing any resources it used. If the animator was
21180 * created with a NULL parent this must be called, otherwise it will be
21181 * automatically called when the parent is deleted.
21183 * @param[in] animator Animator object
21184 * @deprecated Use @ref Transit instead.
21186 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21188 * Set the duration of the animation.
21190 * @param[in] animator Animator object
21191 * @param[in] duration Duration in second
21192 * @deprecated Use @ref Transit instead.
21194 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21196 * @brief Set the callback function for animator operation.
21198 * @param[in] animator Animator object
21199 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21200 * @param[in] data Callback function user argument
21202 * The @p func callback will be called with a frame value in range [0, 1] which
21203 * indicates how far along the animation should be. It is the job of @p func to
21204 * actually change the state of any object(or objects) that are being animated.
21205 * @deprecated Use @ref Transit instead.
21207 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21209 * Set the callback function for the when the animation ends.
21211 * @param[in] animator Animator object
21212 * @param[in] func Callback function pointe
21213 * @param[in] data Callback function user argument
21215 * @warning @a func will not be executed if elm_animator_stop() is called.
21216 * @deprecated Use @ref Transit instead.
21218 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21220 * @brief Stop animator.
21222 * @param[in] animator Animator object
21224 * If called before elm_animator_animate() it does nothing. If there is an
21225 * animation in progress the animation will be stopped(the operation callback
21226 * will not be executed again) and it can't be restarted using
21227 * elm_animator_resume().
21228 * @deprecated Use @ref Transit instead.
21230 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21232 * Set the animator repeat count.
21234 * @param[in] animator Animator object
21235 * @param[in] repeat_cnt Repeat count
21236 * @deprecated Use @ref Transit instead.
21238 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21240 * @brief Start animation.
21242 * @param[in] animator Animator object
21244 * This function starts the animation if the nescessary properties(duration
21245 * and operation callback) have been set. Once started the animation will
21246 * run until complete or elm_animator_stop() is called.
21247 * @deprecated Use @ref Transit instead.
21249 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21251 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21253 * @param[in] animator Animator object
21254 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21255 * @deprecated Use @ref Transit instead.
21257 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21259 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21261 * @param[in] animator Animator object
21262 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21263 * @deprecated Use @ref Transit instead.
21265 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21267 * @brief Sets wether the animation should be automatically reversed.
21269 * @param[in] animator Animator object
21270 * @param[in] reverse Reverse or not
21272 * This controls wether the animation will be run on reverse imediately after
21273 * running forward. When this is set together with repetition the animation
21274 * will run in reverse once for each time it ran forward.@n
21275 * Runnin an animation in reverse is accomplished by calling the operation
21276 * callback with a frame value starting at 1 and diminshing until 0.
21277 * @deprecated Use @ref Transit instead.
21279 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21281 * Gets wether the animation will automatically reversed
21283 * @param[in] animator Animator object
21284 * @deprecated Use @ref Transit instead.
21286 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21288 * Gets the status for the animator operation. The status of the animator @b
21289 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21290 * only informs if the animation was started and has not ended(either normally
21291 * or through elm_animator_stop()).
21293 * @param[in] animator Animator object
21294 * @deprecated Use @ref Transit instead.
21296 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21298 * Gets how many times the animation will be repeated
21300 * @param[in] animator Animator object
21301 * @deprecated Use @ref Transit instead.
21303 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21305 * Pause the animator.
21307 * @param[in] animator Animator object
21309 * This causes the animation to be temporarily stopped(the operation callback
21310 * will not be called). If the animation is not yet running this is a no-op.
21311 * Once an animation has been paused with this function it can be resumed
21312 * using elm_animator_resume().
21313 * @deprecated Use @ref Transit instead.
21315 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21317 * @brief Resumes the animator.
21319 * @param[in] animator Animator object
21321 * Resumes an animation that was paused using elm_animator_pause(), after
21322 * calling this function calls to the operation callback will happen
21323 * normally. If an animation is stopped by means of elm_animator_stop it
21324 * @b can't be restarted with this function.@n
21326 * @warning When an animation is resumed it doesn't start from where it was paused, it
21327 * will go to where it would have been if it had not been paused. If an
21328 * animation with a duration of 3 seconds is paused after 1 second for 1 second
21329 * it will resume as if it had ben animating for 2 seconds, the operating
21330 * callback will be called with a frame value of aproximately 2/3.
21331 * @deprecated Use @ref Transit instead.
21333 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21339 * @defgroup Calendar Calendar
21340 * @ingroup Elementary
21342 * @image html img/widget/calendar/preview-00.png
21343 * @image latex img/widget/calendar/preview-00.eps
21345 * A calendar is a widget that displays a regular calendar, one
21346 * month at a time, to the user, and can allows the user to select a date.
21348 * It has support to adding check marks (holidays and checks are supported
21349 * by default theme).
21351 * Weekday names and the function used to format month and year to
21352 * be displayed can be set, giving more flexibility to this widget.
21354 * Smart callbacks one can register to:
21355 * - "changed" - emitted when the user selects a day or changes the
21356 * displayed month, what actually changes the selected day as well.
21358 * Available styles for it:
21361 * List of examples:
21362 * @li @ref calendar_example_01
21363 * @li @ref calendar_example_02
21364 * @li @ref calendar_example_03
21365 * @li @ref calendar_example_04
21366 * @li @ref calendar_example_05
21367 * @li @ref calendar_example_06
21371 * @addtogroup Calendar
21376 * @enum _Elm_Calendar_Mark_Repeat
21377 * @typedef Elm_Calendar_Mark_Repeat
21379 * Event periodicity, used to define if a mark should be repeated
21380 * @b beyond event's day. It's set when a mark is added.
21382 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21383 * there will be marks every week after this date. Marks will be displayed
21384 * at 13th, 20th, 27th, 3rd June ...
21386 * Values don't work as bitmask, only one can be choosen.
21388 * @see elm_calendar_mark_add()
21390 * @ingroup Calendar
21392 typedef enum _Elm_Calendar_Mark_Repeat
21394 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21395 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21396 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21397 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*/
21398 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. */
21399 } Elm_Calendar_Mark_Repeat;
21401 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(). */
21404 * Add a new calendar widget to the given parent Elementary
21405 * (container) object.
21407 * @param parent The parent object.
21408 * @return a new calendar widget handle or @c NULL, on errors.
21410 * This function inserts a new calendar widget on the canvas.
21412 * @ref calendar_example_01
21414 * @ingroup Calendar
21416 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21419 * Get weekdays names displayed by the calendar.
21421 * @param obj The calendar object.
21422 * @return Array of seven strings to be used as weekday names.
21424 * By default, weekdays abbreviations get from system are displayed:
21425 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21426 * The first string is related to Sunday, the second to Monday...
21428 * @see elm_calendar_weekdays_name_set()
21430 * @ref calendar_example_05
21432 * @ingroup Calendar
21434 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21437 * Set weekdays names to be displayed by the calendar.
21439 * @param obj The calendar object.
21440 * @param weekdays Array of seven strings to be used as weekday names.
21441 * @warning It must have 7 elements, or it will access invalid memory.
21442 * @warning The strings must be NULL terminated ('@\0').
21444 * By default, weekdays abbreviations get from system are displayed:
21445 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21447 * The first string should be related to Sunday, the second to Monday...
21449 * The usage should be like this:
21451 * const char *weekdays[] =
21453 * "Sunday", "Monday", "Tuesday", "Wednesday",
21454 * "Thursday", "Friday", "Saturday"
21456 * elm_calendar_weekdays_names_set(calendar, weekdays);
21459 * @see elm_calendar_weekdays_name_get()
21461 * @ref calendar_example_02
21463 * @ingroup Calendar
21465 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21468 * Set the minimum and maximum values for the year
21470 * @param obj The calendar object
21471 * @param min The minimum year, greater than 1901;
21472 * @param max The maximum year;
21474 * Maximum must be greater than minimum, except if you don't wan't to set
21476 * Default values are 1902 and -1.
21478 * If the maximum year is a negative value, it will be limited depending
21479 * on the platform architecture (year 2037 for 32 bits);
21481 * @see elm_calendar_min_max_year_get()
21483 * @ref calendar_example_03
21485 * @ingroup Calendar
21487 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21490 * Get the minimum and maximum values for the year
21492 * @param obj The calendar object.
21493 * @param min The minimum year.
21494 * @param max The maximum year.
21496 * Default values are 1902 and -1.
21498 * @see elm_calendar_min_max_year_get() for more details.
21500 * @ref calendar_example_05
21502 * @ingroup Calendar
21504 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21507 * Enable or disable day selection
21509 * @param obj The calendar object.
21510 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21513 * Enabled by default. If disabled, the user still can select months,
21514 * but not days. Selected days are highlighted on calendar.
21515 * It should be used if you won't need such selection for the widget usage.
21517 * When a day is selected, or month is changed, smart callbacks for
21518 * signal "changed" will be called.
21520 * @see elm_calendar_day_selection_enable_get()
21522 * @ref calendar_example_04
21524 * @ingroup Calendar
21526 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21529 * Get a value whether day selection is enabled or not.
21531 * @see elm_calendar_day_selection_enable_set() for details.
21533 * @param obj The calendar object.
21534 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21535 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21537 * @ref calendar_example_05
21539 * @ingroup Calendar
21541 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21545 * Set selected date to be highlighted on calendar.
21547 * @param obj The calendar object.
21548 * @param selected_time A @b tm struct to represent the selected date.
21550 * Set the selected date, changing the displayed month if needed.
21551 * Selected date changes when the user goes to next/previous month or
21552 * select a day pressing over it on calendar.
21554 * @see elm_calendar_selected_time_get()
21556 * @ref calendar_example_04
21558 * @ingroup Calendar
21560 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21563 * Get selected date.
21565 * @param obj The calendar object
21566 * @param selected_time A @b tm struct to point to selected date
21567 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21570 * Get date selected by the user or set by function
21571 * elm_calendar_selected_time_set().
21572 * Selected date changes when the user goes to next/previous month or
21573 * select a day pressing over it on calendar.
21575 * @see elm_calendar_selected_time_get()
21577 * @ref calendar_example_05
21579 * @ingroup Calendar
21581 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21584 * Set a function to format the string that will be used to display
21587 * @param obj The calendar object
21588 * @param format_function Function to set the month-year string given
21589 * the selected date
21591 * By default it uses strftime with "%B %Y" format string.
21592 * It should allocate the memory that will be used by the string,
21593 * that will be freed by the widget after usage.
21594 * A pointer to the string and a pointer to the time struct will be provided.
21599 * _format_month_year(struct tm *selected_time)
21602 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21603 * return strdup(buf);
21606 * elm_calendar_format_function_set(calendar, _format_month_year);
21609 * @ref calendar_example_02
21611 * @ingroup Calendar
21613 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21616 * Add a new mark to the calendar
21618 * @param obj The calendar object
21619 * @param mark_type A string used to define the type of mark. It will be
21620 * emitted to the theme, that should display a related modification on these
21621 * days representation.
21622 * @param mark_time A time struct to represent the date of inclusion of the
21623 * mark. For marks that repeats it will just be displayed after the inclusion
21624 * date in the calendar.
21625 * @param repeat Repeat the event following this periodicity. Can be a unique
21626 * mark (that don't repeat), daily, weekly, monthly or annually.
21627 * @return The created mark or @p NULL upon failure.
21629 * Add a mark that will be drawn in the calendar respecting the insertion
21630 * time and periodicity. It will emit the type as signal to the widget theme.
21631 * Default theme supports "holiday" and "checked", but it can be extended.
21633 * It won't immediately update the calendar, drawing the marks.
21634 * For this, call elm_calendar_marks_draw(). However, when user selects
21635 * next or previous month calendar forces marks drawn.
21637 * Marks created with this method can be deleted with
21638 * elm_calendar_mark_del().
21642 * struct tm selected_time;
21643 * time_t current_time;
21645 * current_time = time(NULL) + 5 * 84600;
21646 * localtime_r(¤t_time, &selected_time);
21647 * elm_calendar_mark_add(cal, "holiday", selected_time,
21648 * ELM_CALENDAR_ANNUALLY);
21650 * current_time = time(NULL) + 1 * 84600;
21651 * localtime_r(¤t_time, &selected_time);
21652 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21654 * elm_calendar_marks_draw(cal);
21657 * @see elm_calendar_marks_draw()
21658 * @see elm_calendar_mark_del()
21660 * @ref calendar_example_06
21662 * @ingroup Calendar
21664 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);
21667 * Delete mark from the calendar.
21669 * @param mark The mark to be deleted.
21671 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21672 * should be used instead of getting marks list and deleting each one.
21674 * @see elm_calendar_mark_add()
21676 * @ref calendar_example_06
21678 * @ingroup Calendar
21680 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21683 * Remove all calendar's marks
21685 * @param obj The calendar object.
21687 * @see elm_calendar_mark_add()
21688 * @see elm_calendar_mark_del()
21690 * @ingroup Calendar
21692 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21696 * Get a list of all the calendar marks.
21698 * @param obj The calendar object.
21699 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21701 * @see elm_calendar_mark_add()
21702 * @see elm_calendar_mark_del()
21703 * @see elm_calendar_marks_clear()
21705 * @ingroup Calendar
21707 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21710 * Draw calendar marks.
21712 * @param obj The calendar object.
21714 * Should be used after adding, removing or clearing marks.
21715 * It will go through the entire marks list updating the calendar.
21716 * If lots of marks will be added, add all the marks and then call
21719 * When the month is changed, i.e. user selects next or previous month,
21720 * marks will be drawed.
21722 * @see elm_calendar_mark_add()
21723 * @see elm_calendar_mark_del()
21724 * @see elm_calendar_marks_clear()
21726 * @ref calendar_example_06
21728 * @ingroup Calendar
21730 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21733 * Set a day text color to the same that represents Saturdays.
21735 * @param obj The calendar object.
21736 * @param pos The text position. Position is the cell counter, from left
21737 * to right, up to down. It starts on 0 and ends on 41.
21739 * @deprecated use elm_calendar_mark_add() instead like:
21742 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21743 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21746 * @see elm_calendar_mark_add()
21748 * @ingroup Calendar
21750 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21753 * Set a day text color to the same that represents Sundays.
21755 * @param obj The calendar object.
21756 * @param pos The text position. Position is the cell counter, from left
21757 * to right, up to down. It starts on 0 and ends on 41.
21759 * @deprecated use elm_calendar_mark_add() instead like:
21762 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21763 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21766 * @see elm_calendar_mark_add()
21768 * @ingroup Calendar
21770 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21773 * Set a day text color to the same that represents Weekdays.
21775 * @param obj The calendar object
21776 * @param pos The text position. Position is the cell counter, from left
21777 * to right, up to down. It starts on 0 and ends on 41.
21779 * @deprecated use elm_calendar_mark_add() instead like:
21782 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21784 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21785 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21786 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21787 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21788 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21789 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21790 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21791 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21792 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21795 * @see elm_calendar_mark_add()
21797 * @ingroup Calendar
21799 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21802 * Set the interval on time updates for an user mouse button hold
21803 * on calendar widgets' month selection.
21805 * @param obj The calendar object
21806 * @param interval The (first) interval value in seconds
21808 * This interval value is @b decreased while the user holds the
21809 * mouse pointer either selecting next or previous month.
21811 * This helps the user to get to a given month distant from the
21812 * current one easier/faster, as it will start to change quicker and
21813 * quicker on mouse button holds.
21815 * The calculation for the next change interval value, starting from
21816 * the one set with this call, is the previous interval divided by
21817 * 1.05, so it decreases a little bit.
21819 * The default starting interval value for automatic changes is
21822 * @see elm_calendar_interval_get()
21824 * @ingroup Calendar
21826 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21829 * Get the interval on time updates for an user mouse button hold
21830 * on calendar widgets' month selection.
21832 * @param obj The calendar object
21833 * @return The (first) interval value, in seconds, set on it
21835 * @see elm_calendar_interval_set() for more details
21837 * @ingroup Calendar
21839 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21846 * @defgroup Diskselector Diskselector
21847 * @ingroup Elementary
21849 * @image html img/widget/diskselector/preview-00.png
21850 * @image latex img/widget/diskselector/preview-00.eps
21852 * A diskselector is a kind of list widget. It scrolls horizontally,
21853 * and can contain label and icon objects. Three items are displayed
21854 * with the selected one in the middle.
21856 * It can act like a circular list with round mode and labels can be
21857 * reduced for a defined length for side items.
21859 * Smart callbacks one can listen to:
21860 * - "selected" - when item is selected, i.e. scroller stops.
21862 * Available styles for it:
21865 * List of examples:
21866 * @li @ref diskselector_example_01
21867 * @li @ref diskselector_example_02
21871 * @addtogroup Diskselector
21875 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(). */
21878 * Add a new diskselector widget to the given parent Elementary
21879 * (container) object.
21881 * @param parent The parent object.
21882 * @return a new diskselector widget handle or @c NULL, on errors.
21884 * This function inserts a new diskselector widget on the canvas.
21886 * @ingroup Diskselector
21888 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21891 * Enable or disable round mode.
21893 * @param obj The diskselector object.
21894 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21897 * Disabled by default. If round mode is enabled the items list will
21898 * work like a circle list, so when the user reaches the last item,
21899 * the first one will popup.
21901 * @see elm_diskselector_round_get()
21903 * @ingroup Diskselector
21905 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21908 * Get a value whether round mode is enabled or not.
21910 * @see elm_diskselector_round_set() for details.
21912 * @param obj The diskselector object.
21913 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21914 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21916 * @ingroup Diskselector
21918 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21921 * Get the side labels max length.
21923 * @deprecated use elm_diskselector_side_label_length_get() instead:
21925 * @param obj The diskselector object.
21926 * @return The max length defined for side labels, or 0 if not a valid
21929 * @ingroup Diskselector
21931 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21934 * Set the side labels max length.
21936 * @deprecated use elm_diskselector_side_label_length_set() instead:
21938 * @param obj The diskselector object.
21939 * @param len The max length defined for side labels.
21941 * @ingroup Diskselector
21943 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21946 * Get the side labels max length.
21948 * @see elm_diskselector_side_label_length_set() for details.
21950 * @param obj The diskselector object.
21951 * @return The max length defined for side labels, or 0 if not a valid
21954 * @ingroup Diskselector
21956 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21959 * Set the side labels max length.
21961 * @param obj The diskselector object.
21962 * @param len The max length defined for side labels.
21964 * Length is the number of characters of items' label that will be
21965 * visible when it's set on side positions. It will just crop
21966 * the string after defined size. E.g.:
21968 * An item with label "January" would be displayed on side position as
21969 * "Jan" if max length is set to 3, or "Janu", if this property
21972 * When it's selected, the entire label will be displayed, except for
21973 * width restrictions. In this case label will be cropped and "..."
21974 * will be concatenated.
21976 * Default side label max length is 3.
21978 * This property will be applyed over all items, included before or
21979 * later this function call.
21981 * @ingroup Diskselector
21983 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21986 * Set the number of items to be displayed.
21988 * @param obj The diskselector object.
21989 * @param num The number of items the diskselector will display.
21991 * Default value is 3, and also it's the minimun. If @p num is less
21992 * than 3, it will be set to 3.
21994 * Also, it can be set on theme, using data item @c display_item_num
21995 * on group "elm/diskselector/item/X", where X is style set.
21998 * group { name: "elm/diskselector/item/X";
22000 * item: "display_item_num" "5";
22003 * @ingroup Diskselector
22005 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
22008 * Set bouncing behaviour when the scrolled content reaches an edge.
22010 * Tell the internal scroller object whether it should bounce or not
22011 * when it reaches the respective edges for each axis.
22013 * @param obj The diskselector object.
22014 * @param h_bounce Whether to bounce or not in the horizontal axis.
22015 * @param v_bounce Whether to bounce or not in the vertical axis.
22017 * @see elm_scroller_bounce_set()
22019 * @ingroup Diskselector
22021 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22024 * Get the bouncing behaviour of the internal scroller.
22026 * Get whether the internal scroller should bounce when the edge of each
22027 * axis is reached scrolling.
22029 * @param obj The diskselector object.
22030 * @param h_bounce Pointer where to store the bounce state of the horizontal
22032 * @param v_bounce Pointer where to store the bounce state of the vertical
22035 * @see elm_scroller_bounce_get()
22036 * @see elm_diskselector_bounce_set()
22038 * @ingroup Diskselector
22040 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22043 * Get the scrollbar policy.
22045 * @see elm_diskselector_scroller_policy_get() for details.
22047 * @param obj The diskselector object.
22048 * @param policy_h Pointer where to store horizontal scrollbar policy.
22049 * @param policy_v Pointer where to store vertical scrollbar policy.
22051 * @ingroup Diskselector
22053 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);
22056 * Set the scrollbar policy.
22058 * @param obj The diskselector object.
22059 * @param policy_h Horizontal scrollbar policy.
22060 * @param policy_v Vertical scrollbar policy.
22062 * This sets the scrollbar visibility policy for the given scroller.
22063 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22064 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22065 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22066 * This applies respectively for the horizontal and vertical scrollbars.
22068 * The both are disabled by default, i.e., are set to
22069 * #ELM_SCROLLER_POLICY_OFF.
22071 * @ingroup Diskselector
22073 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22076 * Remove all diskselector's items.
22078 * @param obj The diskselector object.
22080 * @see elm_diskselector_item_del()
22081 * @see elm_diskselector_item_append()
22083 * @ingroup Diskselector
22085 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22088 * Get a list of all the diskselector items.
22090 * @param obj The diskselector object.
22091 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22092 * or @c NULL on failure.
22094 * @see elm_diskselector_item_append()
22095 * @see elm_diskselector_item_del()
22096 * @see elm_diskselector_clear()
22098 * @ingroup Diskselector
22100 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22103 * Appends a new item to the diskselector object.
22105 * @param obj The diskselector object.
22106 * @param label The label of the diskselector item.
22107 * @param icon The icon object to use at left side of the item. An
22108 * icon can be any Evas object, but usually it is an icon created
22109 * with elm_icon_add().
22110 * @param func The function to call when the item is selected.
22111 * @param data The data to associate with the item for related callbacks.
22113 * @return The created item or @c NULL upon failure.
22115 * A new item will be created and appended to the diskselector, i.e., will
22116 * be set as last item. Also, if there is no selected item, it will
22117 * be selected. This will always happens for the first appended item.
22119 * If no icon is set, label will be centered on item position, otherwise
22120 * the icon will be placed at left of the label, that will be shifted
22123 * Items created with this method can be deleted with
22124 * elm_diskselector_item_del().
22126 * Associated @p data can be properly freed when item is deleted if a
22127 * callback function is set with elm_diskselector_item_del_cb_set().
22129 * If a function is passed as argument, it will be called everytime this item
22130 * is selected, i.e., the user stops the diskselector with this
22131 * item on center position. If such function isn't needed, just passing
22132 * @c NULL as @p func is enough. The same should be done for @p data.
22134 * Simple example (with no function callback or data associated):
22136 * disk = elm_diskselector_add(win);
22137 * ic = elm_icon_add(win);
22138 * elm_icon_file_set(ic, "path/to/image", NULL);
22139 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22140 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22143 * @see elm_diskselector_item_del()
22144 * @see elm_diskselector_item_del_cb_set()
22145 * @see elm_diskselector_clear()
22146 * @see elm_icon_add()
22148 * @ingroup Diskselector
22150 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);
22154 * Delete them item from the diskselector.
22156 * @param it The item of diskselector to be deleted.
22158 * If deleting all diskselector items is required, elm_diskselector_clear()
22159 * should be used instead of getting items list and deleting each one.
22161 * @see elm_diskselector_clear()
22162 * @see elm_diskselector_item_append()
22163 * @see elm_diskselector_item_del_cb_set()
22165 * @ingroup Diskselector
22167 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22170 * Set the function called when a diskselector item is freed.
22172 * @param it The item to set the callback on
22173 * @param func The function called
22175 * If there is a @p func, then it will be called prior item's memory release.
22176 * That will be called with the following arguments:
22178 * @li item's Evas object;
22181 * This way, a data associated to a diskselector item could be properly
22184 * @ingroup Diskselector
22186 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22189 * Get the data associated to the item.
22191 * @param it The diskselector item
22192 * @return The data associated to @p it
22194 * The return value is a pointer to data associated to @p item when it was
22195 * created, with function elm_diskselector_item_append(). If no data
22196 * was passed as argument, it will return @c NULL.
22198 * @see elm_diskselector_item_append()
22200 * @ingroup Diskselector
22202 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22205 * Set the icon associated to the item.
22207 * @param it The diskselector item
22208 * @param icon The icon object to associate with @p it
22210 * The icon object to use at left side of the item. An
22211 * icon can be any Evas object, but usually it is an icon created
22212 * with elm_icon_add().
22214 * Once the icon object is set, a previously set one will be deleted.
22215 * @warning Setting the same icon for two items will cause the icon to
22216 * dissapear from the first item.
22218 * If an icon was passed as argument on item creation, with function
22219 * elm_diskselector_item_append(), it will be already
22220 * associated to the item.
22222 * @see elm_diskselector_item_append()
22223 * @see elm_diskselector_item_icon_get()
22225 * @ingroup Diskselector
22227 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22230 * Get the icon associated to the item.
22232 * @param it The diskselector item
22233 * @return The icon associated to @p it
22235 * The return value is a pointer to the icon associated to @p item when it was
22236 * created, with function elm_diskselector_item_append(), or later
22237 * with function elm_diskselector_item_icon_set. If no icon
22238 * was passed as argument, it will return @c NULL.
22240 * @see elm_diskselector_item_append()
22241 * @see elm_diskselector_item_icon_set()
22243 * @ingroup Diskselector
22245 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22248 * Set the label of item.
22250 * @param it The item of diskselector.
22251 * @param label The label of item.
22253 * The label to be displayed by the item.
22255 * If no icon is set, label will be centered on item position, otherwise
22256 * the icon will be placed at left of the label, that will be shifted
22259 * An item with label "January" would be displayed on side position as
22260 * "Jan" if max length is set to 3 with function
22261 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22264 * When this @p item is selected, the entire label will be displayed,
22265 * except for width restrictions.
22266 * In this case label will be cropped and "..." will be concatenated,
22267 * but only for display purposes. It will keep the entire string, so
22268 * if diskselector is resized the remaining characters will be displayed.
22270 * If a label was passed as argument on item creation, with function
22271 * elm_diskselector_item_append(), it will be already
22272 * displayed by the item.
22274 * @see elm_diskselector_side_label_lenght_set()
22275 * @see elm_diskselector_item_label_get()
22276 * @see elm_diskselector_item_append()
22278 * @ingroup Diskselector
22280 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22283 * Get the label of item.
22285 * @param it The item of diskselector.
22286 * @return The label of item.
22288 * The return value is a pointer to the label associated to @p item when it was
22289 * created, with function elm_diskselector_item_append(), or later
22290 * with function elm_diskselector_item_label_set. If no label
22291 * was passed as argument, it will return @c NULL.
22293 * @see elm_diskselector_item_label_set() for more details.
22294 * @see elm_diskselector_item_append()
22296 * @ingroup Diskselector
22298 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22301 * Get the selected item.
22303 * @param obj The diskselector object.
22304 * @return The selected diskselector item.
22306 * The selected item can be unselected with function
22307 * elm_diskselector_item_selected_set(), and the first item of
22308 * diskselector will be selected.
22310 * The selected item always will be centered on diskselector, with
22311 * full label displayed, i.e., max lenght set to side labels won't
22312 * apply on the selected item. More details on
22313 * elm_diskselector_side_label_length_set().
22315 * @ingroup Diskselector
22317 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22320 * Set the selected state of an item.
22322 * @param it The diskselector item
22323 * @param selected The selected state
22325 * This sets the selected state of the given item @p it.
22326 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22328 * If a new item is selected the previosly selected will be unselected.
22329 * Previoulsy selected item can be get with function
22330 * elm_diskselector_selected_item_get().
22332 * If the item @p it is unselected, the first item of diskselector will
22335 * Selected items will be visible on center position of diskselector.
22336 * So if it was on another position before selected, or was invisible,
22337 * diskselector will animate items until the selected item reaches center
22340 * @see elm_diskselector_item_selected_get()
22341 * @see elm_diskselector_selected_item_get()
22343 * @ingroup Diskselector
22345 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22348 * Get whether the @p item is selected or not.
22350 * @param it The diskselector item.
22351 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22352 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22354 * @see elm_diskselector_selected_item_set() for details.
22355 * @see elm_diskselector_item_selected_get()
22357 * @ingroup Diskselector
22359 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22362 * Get the first item of the diskselector.
22364 * @param obj The diskselector object.
22365 * @return The first item, or @c NULL if none.
22367 * The list of items follows append order. So it will return the first
22368 * item appended to the widget that wasn't deleted.
22370 * @see elm_diskselector_item_append()
22371 * @see elm_diskselector_items_get()
22373 * @ingroup Diskselector
22375 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22378 * Get the last item of the diskselector.
22380 * @param obj The diskselector object.
22381 * @return The last item, or @c NULL if none.
22383 * The list of items follows append order. So it will return last first
22384 * item appended to the widget that wasn't deleted.
22386 * @see elm_diskselector_item_append()
22387 * @see elm_diskselector_items_get()
22389 * @ingroup Diskselector
22391 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22394 * Get the item before @p item in diskselector.
22396 * @param it The diskselector item.
22397 * @return The item before @p item, or @c NULL if none or on failure.
22399 * The list of items follows append order. So it will return item appended
22400 * just before @p item and that wasn't deleted.
22402 * If it is the first item, @c NULL will be returned.
22403 * First item can be get by elm_diskselector_first_item_get().
22405 * @see elm_diskselector_item_append()
22406 * @see elm_diskselector_items_get()
22408 * @ingroup Diskselector
22410 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22413 * Get the item after @p item in diskselector.
22415 * @param it The diskselector item.
22416 * @return The item after @p item, or @c NULL if none or on failure.
22418 * The list of items follows append order. So it will return item appended
22419 * just after @p item and that wasn't deleted.
22421 * If it is the last item, @c NULL will be returned.
22422 * Last item can be get by elm_diskselector_last_item_get().
22424 * @see elm_diskselector_item_append()
22425 * @see elm_diskselector_items_get()
22427 * @ingroup Diskselector
22429 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22432 * Set the text to be shown in the diskselector item.
22434 * @param item Target item
22435 * @param text The text to set in the content
22437 * Setup the text as tooltip to object. The item can have only one tooltip,
22438 * so any previous tooltip data is removed.
22440 * @see elm_object_tooltip_text_set() for more details.
22442 * @ingroup Diskselector
22444 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22447 * Set the content to be shown in the tooltip item.
22449 * Setup the tooltip to item. The item can have only one tooltip,
22450 * so any previous tooltip data is removed. @p func(with @p data) will
22451 * be called every time that need show the tooltip and it should
22452 * return a valid Evas_Object. This object is then managed fully by
22453 * tooltip system and is deleted when the tooltip is gone.
22455 * @param item the diskselector item being attached a tooltip.
22456 * @param func the function used to create the tooltip contents.
22457 * @param data what to provide to @a func as callback data/context.
22458 * @param del_cb called when data is not needed anymore, either when
22459 * another callback replaces @p func, the tooltip is unset with
22460 * elm_diskselector_item_tooltip_unset() or the owner @a item
22461 * dies. This callback receives as the first parameter the
22462 * given @a data, and @c event_info is the item.
22464 * @see elm_object_tooltip_content_cb_set() for more details.
22466 * @ingroup Diskselector
22468 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);
22471 * Unset tooltip from item.
22473 * @param item diskselector item to remove previously set tooltip.
22475 * Remove tooltip from item. The callback provided as del_cb to
22476 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22477 * it is not used anymore.
22479 * @see elm_object_tooltip_unset() for more details.
22480 * @see elm_diskselector_item_tooltip_content_cb_set()
22482 * @ingroup Diskselector
22484 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22488 * Sets a different style for this item tooltip.
22490 * @note before you set a style you should define a tooltip with
22491 * elm_diskselector_item_tooltip_content_cb_set() or
22492 * elm_diskselector_item_tooltip_text_set()
22494 * @param item diskselector item with tooltip already set.
22495 * @param style the theme style to use (default, transparent, ...)
22497 * @see elm_object_tooltip_style_set() for more details.
22499 * @ingroup Diskselector
22501 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22504 * Get the style for this item tooltip.
22506 * @param item diskselector item with tooltip already set.
22507 * @return style the theme style in use, defaults to "default". If the
22508 * object does not have a tooltip set, then NULL is returned.
22510 * @see elm_object_tooltip_style_get() for more details.
22511 * @see elm_diskselector_item_tooltip_style_set()
22513 * @ingroup Diskselector
22515 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22518 * Set the cursor to be shown when mouse is over the diskselector item
22520 * @param item Target item
22521 * @param cursor the cursor name to be used.
22523 * @see elm_object_cursor_set() for more details.
22525 * @ingroup Diskselector
22527 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22530 * Get the cursor to be shown when mouse is over the diskselector item
22532 * @param item diskselector item with cursor already set.
22533 * @return the cursor name.
22535 * @see elm_object_cursor_get() for more details.
22536 * @see elm_diskselector_cursor_set()
22538 * @ingroup Diskselector
22540 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22544 * Unset the cursor to be shown when mouse is over the diskselector item
22546 * @param item Target item
22548 * @see elm_object_cursor_unset() for more details.
22549 * @see elm_diskselector_cursor_set()
22551 * @ingroup Diskselector
22553 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22556 * Sets a different style for this item cursor.
22558 * @note before you set a style you should define a cursor with
22559 * elm_diskselector_item_cursor_set()
22561 * @param item diskselector item with cursor already set.
22562 * @param style the theme style to use (default, transparent, ...)
22564 * @see elm_object_cursor_style_set() for more details.
22566 * @ingroup Diskselector
22568 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22572 * Get the style for this item cursor.
22574 * @param item diskselector item with cursor already set.
22575 * @return style the theme style in use, defaults to "default". If the
22576 * object does not have a cursor set, then @c NULL is returned.
22578 * @see elm_object_cursor_style_get() for more details.
22579 * @see elm_diskselector_item_cursor_style_set()
22581 * @ingroup Diskselector
22583 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22587 * Set if the cursor set should be searched on the theme or should use
22588 * the provided by the engine, only.
22590 * @note before you set if should look on theme you should define a cursor
22591 * with elm_diskselector_item_cursor_set().
22592 * By default it will only look for cursors provided by the engine.
22594 * @param item widget item with cursor already set.
22595 * @param engine_only boolean to define if cursors set with
22596 * elm_diskselector_item_cursor_set() should be searched only
22597 * between cursors provided by the engine or searched on widget's
22600 * @see elm_object_cursor_engine_only_set() for more details.
22602 * @ingroup Diskselector
22604 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22607 * Get the cursor engine only usage for this item cursor.
22609 * @param item widget item with cursor already set.
22610 * @return engine_only boolean to define it cursors should be looked only
22611 * between the provided by the engine or searched on widget's theme as well.
22612 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22614 * @see elm_object_cursor_engine_only_get() for more details.
22615 * @see elm_diskselector_item_cursor_engine_only_set()
22617 * @ingroup Diskselector
22619 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22626 * @defgroup Colorselector Colorselector
22630 * @image html img/widget/colorselector/preview-00.png
22631 * @image latex img/widget/colorselector/preview-00.eps
22633 * @brief Widget for user to select a color.
22635 * Signals that you can add callbacks for are:
22636 * "changed" - When the color value changes(event_info is NULL).
22638 * See @ref tutorial_colorselector.
22641 * @brief Add a new colorselector to the parent
22643 * @param parent The parent object
22644 * @return The new object or NULL if it cannot be created
22646 * @ingroup Colorselector
22648 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22650 * Set a color for the colorselector
22652 * @param obj Colorselector object
22653 * @param r r-value of color
22654 * @param g g-value of color
22655 * @param b b-value of color
22656 * @param a a-value of color
22658 * @ingroup Colorselector
22660 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22662 * Get a color from the colorselector
22664 * @param obj Colorselector object
22665 * @param r integer pointer for r-value of color
22666 * @param g integer pointer for g-value of color
22667 * @param b integer pointer for b-value of color
22668 * @param a integer pointer for a-value of color
22670 * @ingroup Colorselector
22672 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22678 * @defgroup Ctxpopup Ctxpopup
22680 * @image html img/widget/ctxpopup/preview-00.png
22681 * @image latex img/widget/ctxpopup/preview-00.eps
22683 * @brief Context popup widet.
22685 * A ctxpopup is a widget that, when shown, pops up a list of items.
22686 * It automatically chooses an area inside its parent object's view
22687 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22688 * optimally fit into it. In the default theme, it will also point an
22689 * arrow to it's top left position at the time one shows it. Ctxpopup
22690 * items have a label and/or an icon. It is intended for a small
22691 * number of items (hence the use of list, not genlist).
22693 * @note Ctxpopup is a especialization of @ref Hover.
22695 * Signals that you can add callbacks for are:
22696 * "dismissed" - the ctxpopup was dismissed
22698 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22701 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22703 typedef enum _Elm_Ctxpopup_Direction
22705 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22707 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22708 the clicked area */
22709 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22710 the clicked area */
22711 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22713 } Elm_Ctxpopup_Direction;
22716 * @brief Add a new Ctxpopup object to the parent.
22718 * @param parent Parent object
22719 * @return New object or @c NULL, if it cannot be created
22721 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22723 * @brief Set the Ctxpopup's parent
22725 * @param obj The ctxpopup object
22726 * @param area The parent to use
22728 * Set the parent object.
22730 * @note elm_ctxpopup_add() will automatically call this function
22731 * with its @c parent argument.
22733 * @see elm_ctxpopup_add()
22734 * @see elm_hover_parent_set()
22736 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22738 * @brief Get the Ctxpopup's parent
22740 * @param obj The ctxpopup object
22742 * @see elm_ctxpopup_hover_parent_set() for more information
22744 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22746 * @brief Clear all items in the given ctxpopup object.
22748 * @param obj Ctxpopup object
22750 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22752 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22754 * @param obj Ctxpopup object
22755 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22757 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22759 * @brief Get the value of current ctxpopup object's orientation.
22761 * @param obj Ctxpopup object
22762 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22764 * @see elm_ctxpopup_horizontal_set()
22766 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22768 * @brief Add a new item to a ctxpopup object.
22770 * @param obj Ctxpopup object
22771 * @param icon Icon to be set on new item
22772 * @param label The Label of the new item
22773 * @param func Convenience function called when item selected
22774 * @param data Data passed to @p func
22775 * @return A handle to the item added or @c NULL, on errors
22777 * @warning Ctxpopup can't hold both an item list and a content at the same
22778 * time. When an item is added, any previous content will be removed.
22780 * @see elm_ctxpopup_content_set()
22782 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);
22784 * @brief Delete the given item in a ctxpopup object.
22786 * @param item Ctxpopup item to be deleted
22788 * @see elm_ctxpopup_item_append()
22790 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22792 * @brief Set the ctxpopup item's state as disabled or enabled.
22794 * @param item Ctxpopup item to be enabled/disabled
22795 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22797 * When disabled the item is greyed out to indicate it's state.
22799 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22801 * @brief Get the ctxpopup item's disabled/enabled state.
22803 * @param item Ctxpopup item to be enabled/disabled
22804 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22806 * @see elm_ctxpopup_item_disabled_set()
22808 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22810 * @brief Get the icon object for the given ctxpopup item.
22812 * @param item Ctxpopup item
22813 * @return icon object or @c NULL, if the item does not have icon or an error
22816 * @see elm_ctxpopup_item_append()
22817 * @see elm_ctxpopup_item_icon_set()
22819 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22821 * @brief Sets the side icon associated with the ctxpopup item
22823 * @param item Ctxpopup item
22824 * @param icon Icon object to be set
22826 * Once the icon object is set, a previously set one will be deleted.
22827 * @warning Setting the same icon for two items will cause the icon to
22828 * dissapear from the first item.
22830 * @see elm_ctxpopup_item_append()
22832 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22834 * @brief Get the label for the given ctxpopup item.
22836 * @param item Ctxpopup item
22837 * @return label string or @c NULL, if the item does not have label or an
22840 * @see elm_ctxpopup_item_append()
22841 * @see elm_ctxpopup_item_label_set()
22843 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22845 * @brief (Re)set the label on the given ctxpopup item.
22847 * @param item Ctxpopup item
22848 * @param label String to set as label
22850 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22852 * @brief Set an elm widget as the content of the ctxpopup.
22854 * @param obj Ctxpopup object
22855 * @param content Content to be swallowed
22857 * If the content object is already set, a previous one will bedeleted. If
22858 * you want to keep that old content object, use the
22859 * elm_ctxpopup_content_unset() function.
22861 * @deprecated use elm_object_content_set()
22863 * @warning Ctxpopup can't hold both a item list and a content at the same
22864 * time. When a content is set, any previous items will be removed.
22866 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22868 * @brief Unset the ctxpopup content
22870 * @param obj Ctxpopup object
22871 * @return The content that was being used
22873 * Unparent and return the content object which was set for this widget.
22875 * @deprecated use elm_object_content_unset()
22877 * @see elm_ctxpopup_content_set()
22879 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22881 * @brief Set the direction priority of a ctxpopup.
22883 * @param obj Ctxpopup object
22884 * @param first 1st priority of direction
22885 * @param second 2nd priority of direction
22886 * @param third 3th priority of direction
22887 * @param fourth 4th priority of direction
22889 * This functions gives a chance to user to set the priority of ctxpopup
22890 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22891 * requested direction.
22893 * @see Elm_Ctxpopup_Direction
22895 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);
22897 * @brief Get the direction priority of a ctxpopup.
22899 * @param obj Ctxpopup object
22900 * @param first 1st priority of direction to be returned
22901 * @param second 2nd priority of direction to be returned
22902 * @param third 3th priority of direction to be returned
22903 * @param fourth 4th priority of direction to be returned
22905 * @see elm_ctxpopup_direction_priority_set() for more information.
22907 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);
22915 * @defgroup Transit Transit
22916 * @ingroup Elementary
22918 * Transit is designed to apply various animated transition effects to @c
22919 * Evas_Object, such like translation, rotation, etc. For using these
22920 * effects, create an @ref Elm_Transit and add the desired transition effects.
22922 * Once the effects are added into transit, they will be automatically
22923 * managed (their callback will be called until the duration is ended, and
22924 * they will be deleted on completion).
22928 * Elm_Transit *trans = elm_transit_add();
22929 * elm_transit_object_add(trans, obj);
22930 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22931 * elm_transit_duration_set(transit, 1);
22932 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22933 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22934 * elm_transit_repeat_times_set(transit, 3);
22937 * Some transition effects are used to change the properties of objects. They
22939 * @li @ref elm_transit_effect_translation_add
22940 * @li @ref elm_transit_effect_color_add
22941 * @li @ref elm_transit_effect_rotation_add
22942 * @li @ref elm_transit_effect_wipe_add
22943 * @li @ref elm_transit_effect_zoom_add
22944 * @li @ref elm_transit_effect_resizing_add
22946 * Other transition effects are used to make one object disappear and another
22947 * object appear on its old place. These effects are:
22949 * @li @ref elm_transit_effect_flip_add
22950 * @li @ref elm_transit_effect_resizable_flip_add
22951 * @li @ref elm_transit_effect_fade_add
22952 * @li @ref elm_transit_effect_blend_add
22954 * It's also possible to make a transition chain with @ref
22955 * elm_transit_chain_transit_add.
22957 * @warning We strongly recommend to use elm_transit just when edje can not do
22958 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22959 * animations can be manipulated inside the theme.
22961 * List of examples:
22962 * @li @ref transit_example_01_explained
22963 * @li @ref transit_example_02_explained
22964 * @li @ref transit_example_03_c
22965 * @li @ref transit_example_04_c
22971 * @enum Elm_Transit_Tween_Mode
22973 * The type of acceleration used in the transition.
22977 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22978 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22979 over time, then decrease again
22981 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22983 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22985 } Elm_Transit_Tween_Mode;
22988 * @enum Elm_Transit_Effect_Flip_Axis
22990 * The axis where flip effect should be applied.
22994 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22995 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22996 } Elm_Transit_Effect_Flip_Axis;
22998 * @enum Elm_Transit_Effect_Wipe_Dir
23000 * The direction where the wipe effect should occur.
23004 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
23005 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
23006 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
23007 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
23008 } Elm_Transit_Effect_Wipe_Dir;
23009 /** @enum Elm_Transit_Effect_Wipe_Type
23011 * Whether the wipe effect should show or hide the object.
23015 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
23017 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
23019 } Elm_Transit_Effect_Wipe_Type;
23022 * @typedef Elm_Transit
23024 * The Transit created with elm_transit_add(). This type has the information
23025 * about the objects which the transition will be applied, and the
23026 * transition effects that will be used. It also contains info about
23027 * duration, number of repetitions, auto-reverse, etc.
23029 typedef struct _Elm_Transit Elm_Transit;
23030 typedef void Elm_Transit_Effect;
23032 * @typedef Elm_Transit_Effect_Transition_Cb
23034 * Transition callback called for this effect on each transition iteration.
23036 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23038 * Elm_Transit_Effect_End_Cb
23040 * Transition callback called for this effect when the transition is over.
23042 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23045 * Elm_Transit_Del_Cb
23047 * A callback called when the transit is deleted.
23049 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23054 * @note Is not necessary to delete the transit object, it will be deleted at
23055 * the end of its operation.
23056 * @note The transit will start playing when the program enter in the main loop, is not
23057 * necessary to give a start to the transit.
23059 * @return The transit object.
23063 EAPI Elm_Transit *elm_transit_add(void);
23066 * Stops the animation and delete the @p transit object.
23068 * Call this function if you wants to stop the animation before the duration
23069 * time. Make sure the @p transit object is still alive with
23070 * elm_transit_del_cb_set() function.
23071 * All added effects will be deleted, calling its repective data_free_cb
23072 * functions. The function setted by elm_transit_del_cb_set() will be called.
23074 * @see elm_transit_del_cb_set()
23076 * @param transit The transit object to be deleted.
23079 * @warning Just call this function if you are sure the transit is alive.
23081 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23084 * Add a new effect to the transit.
23086 * @note The cb function and the data are the key to the effect. If you try to
23087 * add an already added effect, nothing is done.
23088 * @note After the first addition of an effect in @p transit, if its
23089 * effect list become empty again, the @p transit will be killed by
23090 * elm_transit_del(transit) function.
23094 * Elm_Transit *transit = elm_transit_add();
23095 * elm_transit_effect_add(transit,
23096 * elm_transit_effect_blend_op,
23097 * elm_transit_effect_blend_context_new(),
23098 * elm_transit_effect_blend_context_free);
23101 * @param transit The transit object.
23102 * @param transition_cb The operation function. It is called when the
23103 * animation begins, it is the function that actually performs the animation.
23104 * It is called with the @p data, @p transit and the time progression of the
23105 * animation (a double value between 0.0 and 1.0).
23106 * @param effect The context data of the effect.
23107 * @param end_cb The function to free the context data, it will be called
23108 * at the end of the effect, it must finalize the animation and free the
23112 * @warning The transit free the context data at the and of the transition with
23113 * the data_free_cb function, do not use the context data in another transit.
23115 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);
23118 * Delete an added effect.
23120 * This function will remove the effect from the @p transit, calling the
23121 * data_free_cb to free the @p data.
23123 * @see elm_transit_effect_add()
23125 * @note If the effect is not found, nothing is done.
23126 * @note If the effect list become empty, this function will call
23127 * elm_transit_del(transit), that is, it will kill the @p transit.
23129 * @param transit The transit object.
23130 * @param transition_cb The operation function.
23131 * @param effect The context data of the effect.
23135 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);
23138 * Add new object to apply the effects.
23140 * @note After the first addition of an object in @p transit, if its
23141 * object list become empty again, the @p transit will be killed by
23142 * elm_transit_del(transit) function.
23143 * @note If the @p obj belongs to another transit, the @p obj will be
23144 * removed from it and it will only belong to the @p transit. If the old
23145 * transit stays without objects, it will die.
23146 * @note When you add an object into the @p transit, its state from
23147 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23148 * transit ends, if you change this state whith evas_object_pass_events_set()
23149 * after add the object, this state will change again when @p transit stops to
23152 * @param transit The transit object.
23153 * @param obj Object to be animated.
23156 * @warning It is not allowed to add a new object after transit begins to go.
23158 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23161 * Removes an added object from the transit.
23163 * @note If the @p obj is not in the @p transit, nothing is done.
23164 * @note If the list become empty, this function will call
23165 * elm_transit_del(transit), that is, it will kill the @p transit.
23167 * @param transit The transit object.
23168 * @param obj Object to be removed from @p transit.
23171 * @warning It is not allowed to remove objects after transit begins to go.
23173 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23176 * Get the objects of the transit.
23178 * @param transit The transit object.
23179 * @return a Eina_List with the objects from the transit.
23183 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23186 * Enable/disable keeping up the objects states.
23187 * If it is not kept, the objects states will be reset when transition ends.
23189 * @note @p transit can not be NULL.
23190 * @note One state includes geometry, color, map data.
23192 * @param transit The transit object.
23193 * @param state_keep Keeping or Non Keeping.
23197 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23200 * Get a value whether the objects states will be reset or not.
23202 * @note @p transit can not be NULL
23204 * @see elm_transit_objects_final_state_keep_set()
23206 * @param transit The transit object.
23207 * @return EINA_TRUE means the states of the objects will be reset.
23208 * If @p transit is NULL, EINA_FALSE is returned
23212 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23215 * Set the event enabled when transit is operating.
23217 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23218 * events from mouse and keyboard during the animation.
23219 * @note When you add an object with elm_transit_object_add(), its state from
23220 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23221 * transit ends, if you change this state with evas_object_pass_events_set()
23222 * after adding the object, this state will change again when @p transit stops
23225 * @param transit The transit object.
23226 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23227 * ignored otherwise.
23231 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23234 * Get the value of event enabled status.
23236 * @see elm_transit_event_enabled_set()
23238 * @param transit The Transit object
23239 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23240 * EINA_FALSE is returned
23244 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23247 * Set the user-callback function when the transit is deleted.
23249 * @note Using this function twice will overwrite the first function setted.
23250 * @note the @p transit object will be deleted after call @p cb function.
23252 * @param transit The transit object.
23253 * @param cb Callback function pointer. This function will be called before
23254 * the deletion of the transit.
23255 * @param data Callback funtion user data. It is the @p op parameter.
23259 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23262 * Set reverse effect automatically.
23264 * If auto reverse is setted, after running the effects with the progress
23265 * parameter from 0 to 1, it will call the effecs again with the progress
23266 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23267 * where the duration was setted with the function elm_transit_add and
23268 * the repeat with the function elm_transit_repeat_times_set().
23270 * @param transit The transit object.
23271 * @param reverse EINA_TRUE means the auto_reverse is on.
23275 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23278 * Get if the auto reverse is on.
23280 * @see elm_transit_auto_reverse_set()
23282 * @param transit The transit object.
23283 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23284 * EINA_FALSE is returned
23288 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23291 * Set the transit repeat count. Effect will be repeated by repeat count.
23293 * This function sets the number of repetition the transit will run after
23294 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23295 * If the @p repeat is a negative number, it will repeat infinite times.
23297 * @note If this function is called during the transit execution, the transit
23298 * will run @p repeat times, ignoring the times it already performed.
23300 * @param transit The transit object
23301 * @param repeat Repeat count
23305 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23308 * Get the transit repeat count.
23310 * @see elm_transit_repeat_times_set()
23312 * @param transit The Transit object.
23313 * @return The repeat count. If @p transit is NULL
23318 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23321 * Set the transit animation acceleration type.
23323 * This function sets the tween mode of the transit that can be:
23324 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23325 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23326 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23327 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23329 * @param transit The transit object.
23330 * @param tween_mode The tween type.
23334 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23337 * Get the transit animation acceleration type.
23339 * @note @p transit can not be NULL
23341 * @param transit The transit object.
23342 * @return The tween type. If @p transit is NULL
23343 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23347 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23350 * Set the transit animation time
23352 * @note @p transit can not be NULL
23354 * @param transit The transit object.
23355 * @param duration The animation time.
23359 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23362 * Get the transit animation time
23364 * @note @p transit can not be NULL
23366 * @param transit The transit object.
23368 * @return The transit animation time.
23372 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23375 * Starts the transition.
23376 * Once this API is called, the transit begins to measure the time.
23378 * @note @p transit can not be NULL
23380 * @param transit The transit object.
23384 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23387 * Pause/Resume the transition.
23389 * If you call elm_transit_go again, the transit will be started from the
23390 * beginning, and will be unpaused.
23392 * @note @p transit can not be NULL
23394 * @param transit The transit object.
23395 * @param paused Whether the transition should be paused or not.
23399 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23402 * Get the value of paused status.
23404 * @see elm_transit_paused_set()
23406 * @note @p transit can not be NULL
23408 * @param transit The transit object.
23409 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23410 * EINA_FALSE is returned
23414 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23417 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23419 * The value returned is a fraction (current time / total time). It
23420 * represents the progression position relative to the total.
23422 * @note @p transit can not be NULL
23424 * @param transit The transit object.
23426 * @return The time progression value. If @p transit is NULL
23431 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23434 * Makes the chain relationship between two transits.
23436 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23437 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23439 * @param transit The transit object.
23440 * @param chain_transit The chain transit object. This transit will be operated
23441 * after transit is done.
23443 * This function adds @p chain_transit transition to a chain after the @p
23444 * transit, and will be started as soon as @p transit ends. See @ref
23445 * transit_example_02_explained for a full example.
23449 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23452 * Cut off the chain relationship between two transits.
23454 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23455 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23457 * @param transit The transit object.
23458 * @param chain_transit The chain transit object.
23460 * This function remove the @p chain_transit transition from the @p transit.
23464 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23467 * Get the current chain transit list.
23469 * @note @p transit can not be NULL.
23471 * @param transit The transit object.
23472 * @return chain transit list.
23476 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23479 * Add the Resizing Effect to Elm_Transit.
23481 * @note This API is one of the facades. It creates resizing effect context
23482 * and add it's required APIs to elm_transit_effect_add.
23484 * @see elm_transit_effect_add()
23486 * @param transit Transit object.
23487 * @param from_w Object width size when effect begins.
23488 * @param from_h Object height size when effect begins.
23489 * @param to_w Object width size when effect ends.
23490 * @param to_h Object height size when effect ends.
23491 * @return Resizing effect context data.
23495 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);
23498 * Add the Translation Effect to Elm_Transit.
23500 * @note This API is one of the facades. It creates translation effect context
23501 * and add it's required APIs to elm_transit_effect_add.
23503 * @see elm_transit_effect_add()
23505 * @param transit Transit object.
23506 * @param from_dx X Position variation when effect begins.
23507 * @param from_dy Y Position variation when effect begins.
23508 * @param to_dx X Position variation when effect ends.
23509 * @param to_dy Y Position variation when effect ends.
23510 * @return Translation effect context data.
23513 * @warning It is highly recommended just create a transit with this effect when
23514 * the window that the objects of the transit belongs has already been created.
23515 * This is because this effect needs the geometry information about the objects,
23516 * and if the window was not created yet, it can get a wrong information.
23518 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);
23521 * Add the Zoom Effect to Elm_Transit.
23523 * @note This API is one of the facades. It creates zoom effect context
23524 * and add it's required APIs to elm_transit_effect_add.
23526 * @see elm_transit_effect_add()
23528 * @param transit Transit object.
23529 * @param from_rate Scale rate when effect begins (1 is current rate).
23530 * @param to_rate Scale rate when effect ends.
23531 * @return Zoom effect context data.
23534 * @warning It is highly recommended just create a transit with this effect when
23535 * the window that the objects of the transit belongs has already been created.
23536 * This is because this effect needs the geometry information about the objects,
23537 * and if the window was not created yet, it can get a wrong information.
23539 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23542 * Add the Flip Effect to Elm_Transit.
23544 * @note This API is one of the facades. It creates flip effect context
23545 * and add it's required APIs to elm_transit_effect_add.
23546 * @note This effect is applied to each pair of objects in the order they are listed
23547 * in the transit list of objects. The first object in the pair will be the
23548 * "front" object and the second will be the "back" object.
23550 * @see elm_transit_effect_add()
23552 * @param transit Transit object.
23553 * @param axis Flipping Axis(X or Y).
23554 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23555 * @return Flip effect context data.
23558 * @warning It is highly recommended just create a transit with this effect when
23559 * the window that the objects of the transit belongs has already been created.
23560 * This is because this effect needs the geometry information about the objects,
23561 * and if the window was not created yet, it can get a wrong information.
23563 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23566 * Add the Resizable Flip Effect to Elm_Transit.
23568 * @note This API is one of the facades. It creates resizable flip effect context
23569 * and add it's required APIs to elm_transit_effect_add.
23570 * @note This effect is applied to each pair of objects in the order they are listed
23571 * in the transit list of objects. The first object in the pair will be the
23572 * "front" object and the second will be the "back" object.
23574 * @see elm_transit_effect_add()
23576 * @param transit Transit object.
23577 * @param axis Flipping Axis(X or Y).
23578 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23579 * @return Resizable flip effect context data.
23582 * @warning It is highly recommended just create a transit with this effect when
23583 * the window that the objects of the transit belongs has already been created.
23584 * This is because this effect needs the geometry information about the objects,
23585 * and if the window was not created yet, it can get a wrong information.
23587 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23590 * Add the Wipe Effect to Elm_Transit.
23592 * @note This API is one of the facades. It creates wipe effect context
23593 * and add it's required APIs to elm_transit_effect_add.
23595 * @see elm_transit_effect_add()
23597 * @param transit Transit object.
23598 * @param type Wipe type. Hide or show.
23599 * @param dir Wipe Direction.
23600 * @return Wipe effect context data.
23603 * @warning It is highly recommended just create a transit with this effect when
23604 * the window that the objects of the transit belongs has already been created.
23605 * This is because this effect needs the geometry information about the objects,
23606 * and if the window was not created yet, it can get a wrong information.
23608 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23611 * Add the Color Effect to Elm_Transit.
23613 * @note This API is one of the facades. It creates color effect context
23614 * and add it's required APIs to elm_transit_effect_add.
23616 * @see elm_transit_effect_add()
23618 * @param transit Transit object.
23619 * @param from_r RGB R when effect begins.
23620 * @param from_g RGB G when effect begins.
23621 * @param from_b RGB B when effect begins.
23622 * @param from_a RGB A when effect begins.
23623 * @param to_r RGB R when effect ends.
23624 * @param to_g RGB G when effect ends.
23625 * @param to_b RGB B when effect ends.
23626 * @param to_a RGB A when effect ends.
23627 * @return Color effect context data.
23631 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);
23634 * Add the Fade Effect to Elm_Transit.
23636 * @note This API is one of the facades. It creates fade effect context
23637 * and add it's required APIs to elm_transit_effect_add.
23638 * @note This effect is applied to each pair of objects in the order they are listed
23639 * in the transit list of objects. The first object in the pair will be the
23640 * "before" object and the second will be the "after" object.
23642 * @see elm_transit_effect_add()
23644 * @param transit Transit object.
23645 * @return Fade effect context data.
23648 * @warning It is highly recommended just create a transit with this effect when
23649 * the window that the objects of the transit belongs has already been created.
23650 * This is because this effect needs the color information about the objects,
23651 * and if the window was not created yet, it can get a wrong information.
23653 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23656 * Add the Blend Effect to Elm_Transit.
23658 * @note This API is one of the facades. It creates blend effect context
23659 * and add it's required APIs to elm_transit_effect_add.
23660 * @note This effect is applied to each pair of objects in the order they are listed
23661 * in the transit list of objects. The first object in the pair will be the
23662 * "before" object and the second will be the "after" object.
23664 * @see elm_transit_effect_add()
23666 * @param transit Transit object.
23667 * @return Blend effect context data.
23670 * @warning It is highly recommended just create a transit with this effect when
23671 * the window that the objects of the transit belongs has already been created.
23672 * This is because this effect needs the color information about the objects,
23673 * and if the window was not created yet, it can get a wrong information.
23675 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23678 * Add the Rotation Effect to Elm_Transit.
23680 * @note This API is one of the facades. It creates rotation effect context
23681 * and add it's required APIs to elm_transit_effect_add.
23683 * @see elm_transit_effect_add()
23685 * @param transit Transit object.
23686 * @param from_degree Degree when effect begins.
23687 * @param to_degree Degree when effect is ends.
23688 * @return Rotation effect context data.
23691 * @warning It is highly recommended just create a transit with this effect when
23692 * the window that the objects of the transit belongs has already been created.
23693 * This is because this effect needs the geometry information about the objects,
23694 * and if the window was not created yet, it can get a wrong information.
23696 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23699 * Add the ImageAnimation Effect to Elm_Transit.
23701 * @note This API is one of the facades. It creates image animation effect context
23702 * and add it's required APIs to elm_transit_effect_add.
23703 * The @p images parameter is a list images paths. This list and
23704 * its contents will be deleted at the end of the effect by
23705 * elm_transit_effect_image_animation_context_free() function.
23709 * char buf[PATH_MAX];
23710 * Eina_List *images = NULL;
23711 * Elm_Transit *transi = elm_transit_add();
23713 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23714 * images = eina_list_append(images, eina_stringshare_add(buf));
23716 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23717 * images = eina_list_append(images, eina_stringshare_add(buf));
23718 * elm_transit_effect_image_animation_add(transi, images);
23722 * @see elm_transit_effect_add()
23724 * @param transit Transit object.
23725 * @param images Eina_List of images file paths. This list and
23726 * its contents will be deleted at the end of the effect by
23727 * elm_transit_effect_image_animation_context_free() function.
23728 * @return Image Animation effect context data.
23732 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23737 typedef struct _Elm_Store Elm_Store;
23738 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23739 typedef struct _Elm_Store_Item Elm_Store_Item;
23740 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23741 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23742 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23743 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23744 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23745 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23746 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23747 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23749 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23750 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23751 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23752 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23756 ELM_STORE_ITEM_MAPPING_NONE = 0,
23757 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23758 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23759 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23760 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23761 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23762 // can add more here as needed by common apps
23763 ELM_STORE_ITEM_MAPPING_LAST
23764 } Elm_Store_Item_Mapping_Type;
23766 struct _Elm_Store_Item_Mapping_Icon
23768 // FIXME: allow edje file icons
23770 Elm_Icon_Lookup_Order lookup_order;
23771 Eina_Bool standard_name : 1;
23772 Eina_Bool no_scale : 1;
23773 Eina_Bool smooth : 1;
23774 Eina_Bool scale_up : 1;
23775 Eina_Bool scale_down : 1;
23778 struct _Elm_Store_Item_Mapping_Empty
23783 struct _Elm_Store_Item_Mapping_Photo
23788 struct _Elm_Store_Item_Mapping_Custom
23790 Elm_Store_Item_Mapping_Cb func;
23793 struct _Elm_Store_Item_Mapping
23795 Elm_Store_Item_Mapping_Type type;
23800 Elm_Store_Item_Mapping_Empty empty;
23801 Elm_Store_Item_Mapping_Icon icon;
23802 Elm_Store_Item_Mapping_Photo photo;
23803 Elm_Store_Item_Mapping_Custom custom;
23804 // add more types here
23808 struct _Elm_Store_Item_Info
23810 Elm_Genlist_Item_Class *item_class;
23811 const Elm_Store_Item_Mapping *mapping;
23816 struct _Elm_Store_Item_Info_Filesystem
23818 Elm_Store_Item_Info base;
23822 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23823 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23825 EAPI void elm_store_free(Elm_Store *st);
23827 EAPI Elm_Store *elm_store_filesystem_new(void);
23828 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23829 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23830 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23832 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23834 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23835 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23836 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23837 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23838 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23839 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23841 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23842 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23843 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23844 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23845 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23846 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23847 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23850 * @defgroup SegmentControl SegmentControl
23851 * @ingroup Elementary
23853 * @image html img/widget/segment_control/preview-00.png
23854 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23856 * @image html img/segment_control.png
23857 * @image latex img/segment_control.eps width=\textwidth
23859 * Segment control widget is a horizontal control made of multiple segment
23860 * items, each segment item functioning similar to discrete two state button.
23861 * A segment control groups the items together and provides compact
23862 * single button with multiple equal size segments.
23864 * Segment item size is determined by base widget
23865 * size and the number of items added.
23866 * Only one segment item can be at selected state. A segment item can display
23867 * combination of Text and any Evas_Object like Images or other widget.
23869 * Smart callbacks one can listen to:
23870 * - "changed" - When the user clicks on a segment item which is not
23871 * previously selected and get selected. The event_info parameter is the
23872 * segment item index.
23874 * Available styles for it:
23877 * Here is an example on its usage:
23878 * @li @ref segment_control_example
23882 * @addtogroup SegmentControl
23886 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23889 * Add a new segment control widget to the given parent Elementary
23890 * (container) object.
23892 * @param parent The parent object.
23893 * @return a new segment control widget handle or @c NULL, on errors.
23895 * This function inserts a new segment control widget on the canvas.
23897 * @ingroup SegmentControl
23899 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23902 * Append a new item to the segment control object.
23904 * @param obj The segment control object.
23905 * @param icon The icon object to use for the left side of the item. An
23906 * icon can be any Evas object, but usually it is an icon created
23907 * with elm_icon_add().
23908 * @param label The label of the item.
23909 * Note that, NULL is different from empty string "".
23910 * @return The created item or @c NULL upon failure.
23912 * A new item will be created and appended to the segment control, i.e., will
23913 * be set as @b last item.
23915 * If it should be inserted at another position,
23916 * elm_segment_control_item_insert_at() should be used instead.
23918 * Items created with this function can be deleted with function
23919 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23921 * @note @p label set to @c NULL is different from empty string "".
23923 * only has icon, it will be displayed bigger and centered. If it has
23924 * icon and label, even that an empty string, icon will be smaller and
23925 * positioned at left.
23929 * sc = elm_segment_control_add(win);
23930 * ic = elm_icon_add(win);
23931 * elm_icon_file_set(ic, "path/to/image", NULL);
23932 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23933 * elm_segment_control_item_add(sc, ic, "label");
23934 * evas_object_show(sc);
23937 * @see elm_segment_control_item_insert_at()
23938 * @see elm_segment_control_item_del()
23940 * @ingroup SegmentControl
23942 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23945 * Insert a new item to the segment control object at specified position.
23947 * @param obj The segment control object.
23948 * @param icon The icon object to use for the left side of the item. An
23949 * icon can be any Evas object, but usually it is an icon created
23950 * with elm_icon_add().
23951 * @param label The label of the item.
23952 * @param index Item position. Value should be between 0 and items count.
23953 * @return The created item or @c NULL upon failure.
23955 * Index values must be between @c 0, when item will be prepended to
23956 * segment control, and items count, that can be get with
23957 * elm_segment_control_item_count_get(), case when item will be appended
23958 * to segment control, just like elm_segment_control_item_add().
23960 * Items created with this function can be deleted with function
23961 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23963 * @note @p label set to @c NULL is different from empty string "".
23965 * only has icon, it will be displayed bigger and centered. If it has
23966 * icon and label, even that an empty string, icon will be smaller and
23967 * positioned at left.
23969 * @see elm_segment_control_item_add()
23970 * @see elm_segment_control_count_get()
23971 * @see elm_segment_control_item_del()
23973 * @ingroup SegmentControl
23975 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);
23978 * Remove a segment control item from its parent, deleting it.
23980 * @param it The item to be removed.
23982 * Items can be added with elm_segment_control_item_add() or
23983 * elm_segment_control_item_insert_at().
23985 * @ingroup SegmentControl
23987 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23990 * Remove a segment control item at given index from its parent,
23993 * @param obj The segment control object.
23994 * @param index The position of the segment control item to be deleted.
23996 * Items can be added with elm_segment_control_item_add() or
23997 * elm_segment_control_item_insert_at().
23999 * @ingroup SegmentControl
24001 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24004 * Get the Segment items count from segment control.
24006 * @param obj The segment control object.
24007 * @return Segment items count.
24009 * It will just return the number of items added to segment control @p obj.
24011 * @ingroup SegmentControl
24013 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24016 * Get the item placed at specified index.
24018 * @param obj The segment control object.
24019 * @param index The index of the segment item.
24020 * @return The segment control item or @c NULL on failure.
24022 * Index is the position of an item in segment control widget. Its
24023 * range is from @c 0 to <tt> count - 1 </tt>.
24024 * Count is the number of items, that can be get with
24025 * elm_segment_control_item_count_get().
24027 * @ingroup SegmentControl
24029 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24032 * Get the label of item.
24034 * @param obj The segment control object.
24035 * @param index The index of the segment item.
24036 * @return The label of the item at @p index.
24038 * The return value is a pointer to the label associated to the item when
24039 * it was created, with function elm_segment_control_item_add(), or later
24040 * with function elm_segment_control_item_label_set. If no label
24041 * was passed as argument, it will return @c NULL.
24043 * @see elm_segment_control_item_label_set() for more details.
24044 * @see elm_segment_control_item_add()
24046 * @ingroup SegmentControl
24048 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24051 * Set the label of item.
24053 * @param it The item of segment control.
24054 * @param text The label of item.
24056 * The label to be displayed by the item.
24057 * Label will be at right of the icon (if set).
24059 * If a label was passed as argument on item creation, with function
24060 * elm_control_segment_item_add(), it will be already
24061 * displayed by the item.
24063 * @see elm_segment_control_item_label_get()
24064 * @see elm_segment_control_item_add()
24066 * @ingroup SegmentControl
24068 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24071 * Get the icon associated to the item.
24073 * @param obj The segment control object.
24074 * @param index The index of the segment item.
24075 * @return The left side icon associated to the item at @p index.
24077 * The return value is a pointer to the icon associated to the item when
24078 * it was created, with function elm_segment_control_item_add(), or later
24079 * with function elm_segment_control_item_icon_set(). If no icon
24080 * was passed as argument, it will return @c NULL.
24082 * @see elm_segment_control_item_add()
24083 * @see elm_segment_control_item_icon_set()
24085 * @ingroup SegmentControl
24087 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24090 * Set the icon associated to the item.
24092 * @param it The segment control item.
24093 * @param icon The icon object to associate with @p it.
24095 * The icon object to use at left side of the item. An
24096 * icon can be any Evas object, but usually it is an icon created
24097 * with elm_icon_add().
24099 * Once the icon object is set, a previously set one will be deleted.
24100 * @warning Setting the same icon for two items will cause the icon to
24101 * dissapear from the first item.
24103 * If an icon was passed as argument on item creation, with function
24104 * elm_segment_control_item_add(), it will be already
24105 * associated to the item.
24107 * @see elm_segment_control_item_add()
24108 * @see elm_segment_control_item_icon_get()
24110 * @ingroup SegmentControl
24112 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24115 * Get the index of an item.
24117 * @param it The segment control item.
24118 * @return The position of item in segment control widget.
24120 * Index is the position of an item in segment control widget. Its
24121 * range is from @c 0 to <tt> count - 1 </tt>.
24122 * Count is the number of items, that can be get with
24123 * elm_segment_control_item_count_get().
24125 * @ingroup SegmentControl
24127 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24130 * Get the base object of the item.
24132 * @param it The segment control item.
24133 * @return The base object associated with @p it.
24135 * Base object is the @c Evas_Object that represents that item.
24137 * @ingroup SegmentControl
24139 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24142 * Get the selected item.
24144 * @param obj The segment control object.
24145 * @return The selected item or @c NULL if none of segment items is
24148 * The selected item can be unselected with function
24149 * elm_segment_control_item_selected_set().
24151 * The selected item always will be highlighted on segment control.
24153 * @ingroup SegmentControl
24155 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24158 * Set the selected state of an item.
24160 * @param it The segment control item
24161 * @param select The selected state
24163 * This sets the selected state of the given item @p it.
24164 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24166 * If a new item is selected the previosly selected will be unselected.
24167 * Previoulsy selected item can be get with function
24168 * elm_segment_control_item_selected_get().
24170 * The selected item always will be highlighted on segment control.
24172 * @see elm_segment_control_item_selected_get()
24174 * @ingroup SegmentControl
24176 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24183 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24184 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24185 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24186 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24187 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24188 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24189 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24190 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24193 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24194 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24195 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24197 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24198 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24199 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24200 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24201 EAPI void elm_video_play(Evas_Object *video);
24202 EAPI void elm_video_pause(Evas_Object *video);
24203 EAPI void elm_video_stop(Evas_Object *video);
24204 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24205 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24206 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24207 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24208 EAPI double elm_video_audio_level_get(Evas_Object *video);
24209 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24210 EAPI double elm_video_play_position_get(Evas_Object *video);
24211 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24212 EAPI double elm_video_play_length_get(Evas_Object *video);
24213 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24214 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24215 EAPI const char *elm_video_title_get(Evas_Object *video);
24217 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24218 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24221 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24222 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);
24223 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24224 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24225 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24226 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24227 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24228 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24229 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24230 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24231 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24232 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24233 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24234 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24235 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);